Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contracts): update documentation to reflect the latest changes #1300

Merged
merged 2 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading