Skip to content

Commit

Permalink
Merge pull request #1300 from privacy-scaling-explorations/docs/contr…
Browse files Browse the repository at this point in the history
…acts

docs(contracts): update documentation to reflect the latest changes
  • Loading branch information
ctrlc03 authored Mar 19, 2024
2 parents 798b2b4 + 4bdce00 commit 413ac50
Show file tree
Hide file tree
Showing 4 changed files with 366 additions and 165 deletions.
16 changes: 12 additions & 4 deletions website/versioned_docs/version-v1.x/circuits.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,14 +436,22 @@ Before building the project, make sure you have the following dependencies insta

### Building MACI circuits

To build the two main circuits of MACI, run the following commands:
To build the main circuits of MACI, run the following command (`-c` postfix for c++ witness gen, and `-wasm` postfix for WASM witness gen only):

```
circom --r1cs --sym --wasm --output ./build circom/test/processMessages_10-2-1-2_test.circom
circom --r1cs --sym --wasm --output ./build circom/test/tallyVotes_10-1-2_test.circom
pnpm build-test-circuits-c
pnpm build-test-circuits-wasm
```

Please note that the circuit is configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, refer to [this page](/docs/circuits/#compile-circuits).
Please note that the circuits are configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, please refer to the individual circuit documentation within this page. Also, within the [configure-circomkit](https://maci.pse.dev/docs/installation#configure-circomkit) section of the `installation` page, you'll see how you can update the config file with new params.

To compile a single circuit, you can run:

```
pnpm circom:build $CIRCUIT_NAME
```

> Please note that the name should match one of the circuit names inside the `circom.json` file.
### Generating zKeys

Expand Down
Loading

0 comments on commit 413ac50

Please sign in to comment.