https://github.com/0xPARC/circom-starter

basic circom project using hardhat-circom (upgrade to circom2 is WIP)
https://github.com/0xPARC/circom-starter

Last synced: 3 months ago
JSON representation

basic circom project using hardhat-circom (upgrade to circom2 is WIP)

• Host: GitHub
• URL: https://github.com/0xPARC/circom-starter
• Owner: 0xPARC
• Created: 2021-01-05T00:27:27.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-16T23:14:56.000Z (over 1 year ago)
• Last Synced: 2024-08-01T18:24:31.195Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 35.6 MB
• Stars: 123
• Watchers: 3
• Forks: 43
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-circom - Circom Starter

README

        
# circom-starter

A basic circom project using [Hardhat](https://github.com/nomiclabs/hardhat) and [hardhat-circom](https://github.com/projectsophon/hardhat-circom). This combines the multiple steps of the [Circom](https://github.com/iden3/circom) and [SnarkJS](https://github.com/iden3/snarkjs) workflow into your [Hardhat](https://hardhat.org) workflow.

By providing configuration containing your Phase 1 Powers of Tau and circuits, this plugin will:

1. Compile the circuits

2. Apply the final beacon

3. Output your `wasm` and `zkey` files

4. Generate and output a `Verifier.sol`

## Documentation

See the source projects for full documentation and configuration

## Install

`yarn` to install dependencies

## Development builds

`yarn circom:dev` to build deterministic development circuits.

Further, for debugging purposes, you may wish to inspect the intermediate files. This is possible with the `--debug` flag which the `circom:dev` task enables by default. You'll find them (by default) in `artifacts/circom/`

To build a single circuit during development, you can use the `--circuit` CLI parameter. For example, if you make a change to `hash.circom` and you want to _only_ rebuild that, you can run `yarn circom:dev --circuit hash`.

## Production builds

`yarn circom:prod` for production builds (using `Date.now()` as entropy)