Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyfrin/ctf
A minimal repo to create EVM/solidity capture the flags
https://github.com/cyfrin/ctf
ethereum solidity
Last synced: 7 days ago
JSON representation
A minimal repo to create EVM/solidity capture the flags
- Host: GitHub
- URL: https://github.com/cyfrin/ctf
- Owner: Cyfrin
- License: mit
- Created: 2023-11-25T04:31:54.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:07:47.000Z (6 months ago)
- Last Synced: 2024-05-22T17:30:02.778Z (6 months ago)
- Topics: ethereum, solidity
- Language: Solidity
- Homepage:
- Size: 32.2 KB
- Stars: 23
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> :exclamation: **IMPORTANT:** This codebase has not been audited, use at your own risk.
# CTF
A minimal repo to help create capture the flag (CTF) challenges.
# Getting Started
## Requirements
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- You'll know you've done it right if you can run `git --version`
- [Foundry / Foundryup](https://github.com/gakonst/foundry)
- This will install `forge`, `cast`, and `anvil`
- You can test you've installed them right by running `forge --version` and get an output like: `forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)`
- To get the latest of each, just run `foundryup`
## Quickstart
1. Install the package into your project.
```
forge install cyfrin/ctf --no-commit
```
or for Hardhat
```
npm install https://github.com/Cyfrin/ctf
```
2. Create a registration CTF contract
This will be the NFT contract, and the place you'll add challenge contracts to.
*Note: If using hardhat, you'll need to import from `node_modules` instead of `lib`*
```javascript
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.18;
import {CTFRegistry} from "lib/ctf/src/protocol/CTFRegistry.sol";
contract SimpleCTFRegistry is CTFRegistry {
constructor() CTFRegistry("Our CTF", "CTF") {}
}
```
3. Create a challenge contract
You'll need to pass the following to the Challenge constructor:
- `attribute()` - This is the attribute that will be shown on the NFT.
- `description()` - This is the description that will be shown on the NFT.
- `imageUri()` - This is the image that will be shown on the NFT.
Then, finally, you'll have to add this function:
- `solveChallenge()` - This is the *optional* function that will be called when a user solves the challenge. The more important part, is that you need something to call `_updateAndRewardSolver()` which will update the user's NFT with the challenge they solved.
```javascript
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.18;
import {Challenge} from "lib/ctf/src/protocol/Challenge.sol";
contract SimpleCTFChallenge is Challenge {
string constant ATTRIBUTE = "Getting learned!";
string constant DESCRIPTION = "This is a simple CTF challenge.";
string constant IMAGE_URI = "ipfs://QmZg79jdDNBTi3fxwnjXTvbM9Gtd1C84Axo55Ht2kYCeDH";
constructor(address registry) Challenge(registry, ATTRIBUTE, DESCRIPTION, IMAGE_URI) {}
function solveChallenge(string memory twitterHandle) external {
_updateAndRewardSolver(twitterHandle);
}
}
```
4. Deploy, and add the contract to the registry
```javascript
// SPDX-License-Identifier: MIT
pragma solidity 0.8.20;
import {Script} from "forge-std/Script.sol";
import {SimpleCTFChallenge} from "../test/mocks/SimpleCTFChallenge.sol";
import {SimpleCTFRegistry} from "../test/mocks/SimpleCTFRegistry.sol";
contract MockDeploy is Script {
function run() external {
SimpleCTFRegistry registry = new SimpleCTFRegistry();
SimpleCTFChallenge challenge = new SimpleCTFChallenge(address(registry));
registry.addChallenge(address(challenge));
}
}
```