{"id":18369894,"url":"https://github.com/cawfree/zk-starter","last_synced_at":"2025-04-06T18:32:38.810Z","repository":{"id":62724511,"uuid":"561098011","full_name":"cawfree/zk-starter","owner":"cawfree","description":"zero knowledge for those with zero knowledge","archived":false,"fork":false,"pushed_at":"2023-03-05T23:41:34.000Z","size":625,"stargazers_count":103,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-22T04:31:52.953Z","etag":null,"topics":["computation","cryptography","decentralized","ethereum","evm","privacy","snark","stark","verifiable","zk"],"latest_commit_sha":null,"homepage":"https://twitter.com/cawfree","language":"Solidity","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/cawfree.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE/BattleZips","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}},"created_at":"2022-11-03T00:06:01.000Z","updated_at":"2024-09-07T17:45:16.000Z","dependencies_parsed_at":"2024-11-05T23:45:11.458Z","dependency_job_id":null,"html_url":"https://github.com/cawfree/zk-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cawfree%2Fzk-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cawfree%2Fzk-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cawfree%2Fzk-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cawfree%2Fzk-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cawfree","download_url":"https://codeload.github.com/cawfree/zk-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247531363,"owners_count":20953939,"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":["computation","cryptography","decentralized","ethereum","evm","privacy","snark","stark","verifiable","zk"],"created_at":"2024-11-05T23:33:01.232Z","updated_at":"2025-04-06T18:32:36.972Z","avatar_url":"https://github.com/cawfree.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `zk-starter`\n\nThe easiest way to integrate succinct verifiable on-chain computation using hidden information in custom applications that execute on a credibly-neutral immutable public ledger.\n\nEssentially, it's [__zero knowledge__](https://en.wikipedia.org/wiki/Zero-knowledge_proof) for those with zero knowledge.\n\n### 🚀 Getting Started\n\n1. Clone the repository using `git clone https://github.com/cawfree/zk-starter`.\n2. Make sure you've installed [__Rust__](https://www.rust-lang.org/) and [__Foundry__](https://github.com/foundry-rs/foundry):\n\n```shell\ncurl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh # install rust\ncurl -L https://foundry.paradigm.xyz | bash # install foundry\n```\n3. Run `yarn`, which will install [`circom`](https://docs.circom.io/) and automate a new [__Powers of Tau__](https://zkproof.org/2021/06/30/setup-ceremonies/#:~:text=The%20first%20phase%20referred%20to,NP%2Drelation%2Dspecific%20CRS.) ceremony, then finally compile your arithmetic circuits. When you make changes to your circuits, you can also use `yarn` to recompile them alongside their dependent smart contracts.\n \n\u003e 💡 All the build artifacts are cached, so you'll only be required to do this once-per-installation.\n\n\u003e ⚠️ By default, `zk-starter` is configured not to track the results of ceremonies. You can delete the ignore flag of the `build/` directory within the [`.gitignore`](.gitignore) to avoid data loss. \n\n4. Finally, run `yarn dev` to execute the entire stack on [`http://localhost:3000`](http://localhost:3000). This will redeploy the auto-generated [__verifier logic__](https://docs.circom.io/getting-started/proving-circuits/) made available to your [__smart contracts__](https://ethereum.org/en/developers/docs/smart-contracts/) on the [`anvil`](https://github.com/foundry-rs/foundry) local chain and inject the relevant configuration properties into your frontend.\n\n### ♻️ Adding New Circuits\n\n`zk-starter`'s build life cycle ensures that for each new arithmetic circuit you build, a corresponding [__Solidity__](https://docs.soliditylang.org/en/v0.8.17/) smart contract which inherits a compatible verifier will also be initialized for you to extend.\n\nLikewise, for each circuit you create, a matching utility library is provided to the applicaton frontend at compile time. This yields namespaced high-level functions for generating and verifying proofs, and abstracting away the complexity of smart contract invocation for on-chain verification.\n\n### 🙏 Attribution\n\nThis monorepo was inspired by [__BattleZips 🏴‍☠️__](https://twitter.com/Battlezips) ([__Git__](https://github.com/BattleZips/BattleZips)). Thank you for helping increase accessibility to the state-of-the-art in modern cryptography.\n\n### ✌️ License\n[__MIT__](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcawfree%2Fzk-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcawfree%2Fzk-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcawfree%2Fzk-starter/lists"}