https://github.com/vplasencia/circom-snarkjs-scripts
Generic scripts to create zero knowledge applications using circom and snarkjs
https://github.com/vplasencia/circom-snarkjs-scripts
circom circuits scripts snarkjs
Last synced: about 2 months ago
JSON representation
Generic scripts to create zero knowledge applications using circom and snarkjs
- Host: GitHub
- URL: https://github.com/vplasencia/circom-snarkjs-scripts
- Owner: vplasencia
- License: mit
- Created: 2022-09-21T04:28:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T20:02:54.000Z (over 2 years ago)
- Last Synced: 2025-03-24T12:11:32.025Z (2 months ago)
- Topics: circom, circuits, scripts, snarkjs
- Language: Shell
- Homepage:
- Size: 13.7 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Generic scripts using circom and snarkjs
To learn more about `circom`:
To learn more about `snarkjs`:
The `circom compiler` version used is: `2.0.3`.
The `snarkjs` version used is: `0.6.1`.
**Note:** All the scripts are inside the `scripts` folder.
To organize all the scripts you can create a `scripts` folder next to the circuit and input file you want to work with, and add all the scripts like this:
```text
├── scripts
│ ├── compile.sh
│ ├── executeFflonk.sh
│ ├── executeGroth16.sh
│ ├── executePlonk.sh
│ ├── generateWitness.sh
│ ├── removeBuildFolder.sh
├── circuit.circom
├── input.json
```
When you wan to run a script, for each script:
Run the first time:
```bash
chmod u+x ./scripts/.sh
```
And after that, you can always run:
```bash
./scripts/.sh
```
When you run one of the `circom` or `circom-snarkjs` scripts, a build folder will be created with all the generated files inside. You can delete the build folder by running the `removeBuildFolder.sh` file.
```bash
./scripts/removeBuildFolder.sh
```
**Note:** It is not necessary to run the `removeBuildFolder.sh` script every time you want to run a new script, because every time you run a script, the build folder is automatically removed if it exists.
## circom scripts
- `compile.sh`
To compile circom circuits, you can run the `compile.sh` file.
```bash
./scripts/compile.sh
```
- `generateWitness.sh`
To generate the witness, you can run `generateWitness.sh`
```bash
./scripts/generateWitness.sh
```
When you run a `circom` script you will see something like this:
```text
├── build
│ ├── ...
├── scripts
│ ├── ...
├── circuit.circom
├── input.json
```
## circom-snarkjs scripts
- `executeGroth16.sh`
To generate all the necessary files for a zero knowledge application using Groth16 run `executeGroth16.sh`.
```bash
./scripts/executeGroth16.sh
```
- `executePlonk.sh`
To generate all the necessary files for a zero knowledge application using Plonk run `executePlonk.sh`.
```bash
./scripts/executePlonk.sh
```
- `executeFflonk.sh`
To generate all the necessary files for a zero knowledge application using Fflonk run `executeFflonk.sh`.
```bash
./scripts/executeFflonk.sh
```
When you run a `circom-snarkjs` script, you will see something like this:
```text
├── build
│ ├── ...
├── ptau
│ ├── ...
├── scripts
│ ├── ...
├── circuit.circom
├── input.json
```
**Note:** The `ptau` folder is generated with the necessary ptau file, but you can have this folder with the ptau that you will use, and it will not be generated again.
You can see different ptau files in the [snarkjs documentation](https://github.com/iden3/snarkjs#7-prepare-phase-2).