{"id":13577705,"url":"https://github.com/chainflag/solidctf","last_synced_at":"2025-04-05T12:31:10.888Z","repository":{"id":43292089,"uuid":"377740528","full_name":"chainflag/solidctf","owner":"chainflag","description":"SolidCTF is an infrastructure solution that simplifies the build of Solidity CTF challenges.","archived":false,"fork":false,"pushed_at":"2023-09-17T16:02:38.000Z","size":620,"stargazers_count":132,"open_issues_count":0,"forks_count":19,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-05T14:47:03.653Z","etag":null,"topics":["blockchain","ctf","solidity-ctf"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chainflag.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":"https://gitcoin.co/grants/6541/chainflag"}},"created_at":"2021-06-17T07:19:27.000Z","updated_at":"2024-10-24T15:05:45.000Z","dependencies_parsed_at":"2024-11-05T15:15:31.757Z","dependency_job_id":null,"html_url":"https://github.com/chainflag/solidctf","commit_stats":null,"previous_names":["chainflag/solidctf"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chainflag%2Fsolidctf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chainflag%2Fsolidctf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chainflag%2Fsolidctf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chainflag%2Fsolidctf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chainflag","download_url":"https://codeload.github.com/chainflag/solidctf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247338681,"owners_count":20922994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","ctf","solidity-ctf"],"created_at":"2024-08-01T15:01:23.725Z","updated_at":"2025-04-05T12:31:05.868Z","avatar_url":"https://github.com/chainflag.png","language":"Python","funding_links":["https://gitcoin.co/grants/6541/chainflag"],"categories":["Python"],"sub_categories":[],"readme":"# SolidCTF\n\n![Docker CI](https://img.shields.io/github/actions/workflow/status/chainflag/solidctf/docker-image.yml?branch=main)\n![Docker size](https://badgen.net/docker/size/chainflag/solidctf/latest?color=cyan)\n![Latest tag](https://badgen.net/github/tag/chainflag/solidctf)\n![License: MIT](https://badgen.net/github/license/chainflag/solidctf?color=yellow)\n\nSolidCTF is an infrastructure solution that simplifies the build of Solidity Capture the Flag (CTF) challenges. It provides the ability to CTF organizers to rapidly set up a playable Solidity CTF environment, freeing them up to concentrate on designing smart contracts for puzzles.\n\n## Getting Started\n\n### Quick Demo\n\nUse the following command to run a quick demo:\n\n```bash\ndocker run -it -p 20000:20000 -e WEB3_PROVIDER_URI=https://rpc.sepolia.org chainflag/solidctf:1.0\nnc 127.0.0.1 20000\n```\n\n### Usage\n\n1. Clone the [solidity-ctf-template](https://github.com/chainflag/solidity-ctf-template) using `git clone git@github.com:chainflag/solidity-ctf-template.git` command to create a new challenge project.\n2. Open the contract directory and code your challenge contract that contains the [isSolved()](https://github.com/chainflag/solidity-ctf-template/blob/main/contracts/Example.sol#L19) to replace the example contract. For the multi-contract challenges, you can deploy them in a setup contract's constructor.\n3. Edit the [challenge.yml](https://github.com/chainflag/solidity-ctf-template/blob/main/challenge.yml) to configure your challenge. See to the comments in this file for more details on how to configure it.\n4. Place your flag in the file [flag.txt](https://github.com/chainflag/solidity-ctf-template/blob/main/flag.txt) file and change the alloc address private key in the [.env](https://github.com/chainflag/solidity-ctf-template/blob/main/.env) to your own.\n5. Run the `docker-compose pull \u0026\u0026 docker-compose up -d` command to start serving your challenge.\n\n## Development\n\n### Prerequisites\n\nBefore you start, make sure you have the following installed:\n\n* Docker\n* Python3\n* Required packages (`pip install -r requirements.txt`)\n\n### Run in development mode\n1. Clone the repository\n\n```bash\ngit clone git@github.com:chainflag/solidctf.git\ngit submodule update --init --recursive\n```\n\n2. Generate protobuf code and run server\n\n```bash\nmake protoc\nexport WEB3_PROVIDER_URI=\"your web3 provider\"\nmake dev\n```\n\n### Format python source\n\nTo format the Python source code, you will need to install additional packages (`pip install -r requirements-dev.txt`) and run the following command:\n\n```bash\nmake format\n```\n\n## Acknowledgements\nMany thanks to [JetBrains](https://jb.gg/OpenSourceSupport) for providing their excellent tools and an open source license to support the development of this project.\n\n## License\n\nDistributed under the MIT License. See LICENSE for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainflag%2Fsolidctf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchainflag%2Fsolidctf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainflag%2Fsolidctf/lists"}