Skip to content

README.md

Latest commit

 

History

History
49 lines (35 loc) · 1.58 KB

README.md

File metadata and controls

49 lines (35 loc) · 1.58 KB
Raw

Circuits

This directory is the canonical home for Noir circuits used by the verifier, example contracts, and integration tests.

Layout

circuits/
  simple_circuit/  Nargo.toml, Prover.toml, src/main.nr, target/
  fib_chain/       Nargo.toml, Prover.toml, src/main.nr, target/
  tornado/         Nargo.toml, Prover.toml, src/main.nr, target/
  scripts/         build_all.sh

Each circuit directory must contain a Nargo.toml. The build scripts discover those directories automatically and skip anything without a Noir manifest.

Rebuild Artifacts

Build every circuit, one circuit, or a selected list:

./circuits/scripts/build_all.sh
./circuits/scripts/build_all.sh simple_circuit
./circuits/scripts/build_all.sh simple_circuit fib_chain

The scripts use Noir 1.0.0-beta.9 and Barretenberg 0.87.0, installing them when missing from PATH.

Target Files

After a successful build, circuits/<name>/target/ contains:

  • <project>.json and <project>.gz from nargo compile / nargo execute
  • proof and proof_fields.json
  • vk and vk_fields.json
  • public_inputs and public_inputs_fields.json

Add A Circuit

  1. Create circuits/<name>/src/main.nr.
  2. Add circuits/<name>/Nargo.toml.
  3. Add or generate circuits/<name>/Prover.toml.
  4. Run ./circuits/scripts/build_all.sh <name>.
  5. Point tests or example contracts at circuits/<name>/target/.

For tornado, the build script regenerates Prover.toml through contracts/tornado_classic/contracts/examples/populate_publics.rs by default. Set GENERATE_PROVER=0 to keep existing prover inputs.