{"id":26276912,"url":"https://github.com/kumacrypto/circom_boilerplate","last_synced_at":"2025-03-14T11:27:11.838Z","repository":{"id":199861067,"uuid":"701226167","full_name":"KumaCrypto/circom_boilerplate","owner":"KumaCrypto","description":"Simple circom boilerplate","archived":false,"fork":false,"pushed_at":"2023-10-12T08:40:24.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-10-13T01:52:05.653Z","etag":null,"topics":["boilerplate","circom","circom-boilerplate","zero-knowledge","zk-snarks"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/KumaCrypto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-06T07:38:49.000Z","updated_at":"2023-10-13T01:53:07.379Z","dependencies_parsed_at":null,"dependency_job_id":"14d43e5a-f108-4122-89be-a4305643d1b9","html_url":"https://github.com/KumaCrypto/circom_boilerplate","commit_stats":null,"previous_names":["kumacrypto/circom_boilerplate"],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaCrypto%2Fcircom_boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaCrypto%2Fcircom_boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaCrypto%2Fcircom_boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaCrypto%2Fcircom_boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KumaCrypto","download_url":"https://codeload.github.com/KumaCrypto/circom_boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243567833,"owners_count":20312124,"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":["boilerplate","circom","circom-boilerplate","zero-knowledge","zk-snarks"],"created_at":"2025-03-14T11:27:11.313Z","updated_at":"2025-03-14T11:27:11.814Z","avatar_url":"https://github.com/KumaCrypto.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Circom Boilerplate\n\nWelcome to **Circom Boilerplate**, your go-to toolkit for simplifying the development process with Circom. This boilerplate comes loaded with scripts, ensuring a hassle-free experience in setting up your environment, installing dependencies, and automating the entire development workflow.\n\n## Prerequisites\n\n- **Node.js:** Installed (Version 10 or higher)\n\n\u003e **Tip:**\n\u003e Don't have Node.js installed? No worries! You can easily try out this boilerplate using GitHub Codespaces. Simply click the green `\u003c\u003e Code` button on the repository page, select `Codespaces`, and hit the `+` button. Voilà! You'll have an online development environment tailored to this project.\n\n## Installation\n\n1. **Clone the Repository:**\n\n```bash\ngit clone https://github.com/KumaCrypto/circom_boilerplate.git\n```\n\nor via SSH\n\n```bash\ngit clone git@github.com:KumaCrypto/circom_boilerplate.git\n```\n\n2. **Navigate to the Project Directory:**\n\n```bash\ncd circom_boilerplate\n```\n\n3. **Install Dependencies:**\n\nIf you haven't installed `Rust` yet:\n\n```bash\nnpm run install_rust\n```\n\n\u003e **Note:**\n\u003e During the process you will be asked to select an installation method, select option 1 (unless you require a different one).\n\u003e After the installation, close the current terminal and open a new one to continue.\n\nInstall Circom and SnarkJS:\n\n```bash\nnpm run setup\n```\n\n\u003e **Tip:**\n\u003e For comfortable writing of circuits you can install the Circom code [highlighting extension](https://marketplace.visualstudio.com/items?itemName=iden3.circom). (More visually appealing than black and white text).\n\n## Usage\n\nThis boilerplate offers the following scripts:\n\n### Test Your Circuit\n\n\u003e Depending on your circuit, fill in the input.json file.\n\nThis script handles everything – from compiling your circuit to verifying it with a generated witness. Important: This contributes to PowersOfTau (POT) and prepares for the second phase (this might take a while).\n\n**Conditions:**\n\n- The circuit must be in the `circuits` folder.\n- The file containing arguments for the circuit must be named `input.json` and placed at the root of the repository.\n\n```bash\nnpm run test \u003ccircuit name\u003e # Default input: input.json (change it in package.json if needed)\n```\n\nThe output will be generated in the `build` directory.\n\n### Test Circuit without POTs\n\nSimilar to the previous command, but skips the contribution to POT and second stage preparation. Faster. Use it for quick circuit tests or if you understand what you're doing.\n\nCan be used if you already have POTs.\n\n```bash\nnpm run test_no_pots \u003ccircuit name\u003e # Default input: input.json (change it in package.json if needed)\n```\n\n### Generate Solidity contract\n\nThis command creates a `Solidity` contract to verify your circuit on-chain. Make sure to run one of the previous commands to generate the proving key (located at `build/circuit_name.zkey`).\n\n```bash\nnpm run solidityVerifier \u003ccircuit name\u003e\n```\n\nThe verifying contract will be generated in the `src` directory.\n\n## Acknowledgement ⭐️\n\nIf you find this boilerplate helpful, show your support by starring it on GitHub. It costs nothing for you but means the world to us.\nHappy coding! ✨\n\n## Contribute\n\n- **Report Bugs:** If you encounter a bug, please open a detailed issue on GitHub, explaining how to replicate the problem.\n- **Suggest Enhancements:** Have ideas to enhance this project? Feel free to propose new features or improvements by opening an issue. Your input is invaluable!\n\n## License\n\nThis project is licensed under the MIT License - check out the [LICENSE](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumacrypto%2Fcircom_boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkumacrypto%2Fcircom_boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumacrypto%2Fcircom_boilerplate/lists"}