Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-azra3l/zk-circuit-implementation
Using the circom programming language to implement a circuit and deploy a verifier on-chain to verify proofs generated from this circuit.
https://github.com/m-azra3l/zk-circuit-implementation
Last synced: 25 days ago
JSON representation
Using the circom programming language to implement a circuit and deploy a verifier on-chain to verify proofs generated from this circuit.
- Host: GitHub
- URL: https://github.com/m-azra3l/zk-circuit-implementation
- Owner: m-azra3l
- Created: 2023-06-20T06:52:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-12T14:51:30.000Z (over 1 year ago)
- Last Synced: 2024-11-08T23:33:01.643Z (3 months ago)
- Language: Solidity
- Size: 4.54 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# zardkat 🐱
A [hardhat-circom](https://github.com/projectsophon/hardhat-circom) template to generate zero-knowledge circuits, proofs, and solidity verifiers
## Quick Start
Compile the Multiplier2() circuit and verify it against a smart contract verifier
```
pragma circom 2.0.0;
/*This circuit template checks that c is the multiplication of a and b.*/
template Multiplier2 () {
// Declaration of signals.
signal input a;
signal input b;
signal output c;
// Constraints.
c <== a * b;
}
component main = Multiplier2();
```
### Install
`npm i`
### Compile
`npx hardhat compile`
This will generate the **out** file with circuit intermediaries and geneate the **MultiplierVerifier.sol** contract
### Prove and Deploy
`npx hardhat run scripts/deploy.ts`
This script does 4 things
1. Deploys the MultiplierVerifier.sol contract
2. Generates a proof from circuit intermediaries with `generateProof()`
3. Generates calldata with `generateCallData()`
4. Calls `verifyProof()` on the verifier contract with calldata
With two commands you can compile a ZKP, generate a proof, deploy a verifier, and verify the proof 🎉
## Configuration
### Directory Structure
**circuits**
```
├── multiplier
│ ├── circuit.circom
│ ├── input.json
│ └── out
│ ├── circuit.wasm
│ ├── multiplier.r1cs
│ ├── multiplier.vkey
│ └── multiplier.zkey
├── new-circuit
└── powersOfTau28_hez_final_12.ptau
```
Each new circuit lives in it's own directory. At the top level of each circuit directory lives the circom circuit and input to the circuit.
The **out** directory will be autogenerated and store the compiled outputs, keys, and proofs. The Powers of Tau file comes from the Polygon Hermez ceremony, which saves time by not needing a new ceremony.
**contracts**
```
contracts
└── MultiplierVerifier.sol
```
Verifier contracts are autogenerated and prefixed by the circuit name, in this example **Multiplier**
## hardhat.config.ts
```
circom: {
// (optional) Base path for input files, defaults to `./circuits/`
inputBasePath: "./circuits",
// (required) The final ptau file, relative to inputBasePath, from a Phase 1 ceremony
ptau: "powersOfTau28_hez_final_12.ptau",
// (required) Each object in this array refers to a separate circuit
circuits: JSON.parse(JSON.stringify(circuits))
},
```
### circuits.config.json
circuits configuation is separated from hardhat.config.ts for **autogenerated** purposes (see next section)
```
[
{
"name": "multiplier",
"protocol": "groth16",
"circuit": "multiplier/circuit.circom",
"input": "multiplier/input.json",
"wasm": "multiplier/out/circuit.wasm",
"zkey": "multiplier/out/multiplier.zkey",
"vkey": "multiplier/out/multiplier.vkey",
"r1cs": "multiplier/out/multiplier.r1cs",
"beacon": "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
}
]
```
**adding circuits**
To add a new circuit, you can run the `newcircuit` hardhat task to autogenerate configuration and directories i.e
```
npx hardhat newcircuit --name newcircuit
```
**determinism**
> When you recompile the same circuit using the groth16 protocol, even with no changes, this plugin will apply a new final beacon, changing all the zkey output files. This also causes your Verifier contracts to be updated.
> For development builds of groth16 circuits, we provide the --deterministic flag in order to use a NON-RANDOM and UNSECURE hardcoded entropy (0x000000 by default) which will allow you to more easily inspect and catch changes in your circuits. You can adjust this default beacon by setting the beacon property on a circuit's config in your hardhat.config.js file.