@maci-protocol/website 0.0.0-ci.26f28d6

package/versioned_docs/version-v2.x/core-concepts/state-leaf.md

@@ -0,0 +1,42 @@
+---
+title: StateLeaf
+description: A short introduction of the main primitives used by MACI
+sidebar_label: StateLeaf
+sidebar_position: 6
+---
+
+A state leaf represents a user's participation declared through an identity (their public key) and information relevant to their ability or right to cast votes in a poll (their voice credit balance and the block timestamp at which they signed up).
+
+We define a state leaf $sl$ as the $poseidon_4$ hash of the following:
+
+| Symbol     | Name                      | Comments                                    |
+| ---------- | ------------------------- | ------------------------------------------- |
+| $sl_{P_x}$ | Public key's x-coordinate |                                             |
+| $sl_{P_y}$ | Public key's y-coordinate |                                             |
+| $sl_{v}$   | Voice credit balance      |                                             |
+| $sl_{t}$   | Block timestamp           | In Unix time (seconds since Jan 1 1970 UTC) |
+
+The hash $sl$ is computed as such:
+
+$sl = poseidon_4([sl_{A_x}, sl_{A_y}, sl_{v}, sl_{t}])$
+
+## Blank state leaf
+
+A blank state leaf $sl_B$ has the following value:
+
+$6769006970205099520508948723718471724660867171122235270773600567925038008762$
+
+This value is computed as such:
+
+$A_{b_x} = 10457101036533406547632367118273992217979173478358440826365724437999023779287$
+$A_{b_y} = 19824078218392094440610104313265183977899662750282163392862422243483260492317$
+$sl_B = poseidon_4([A_{b0}, A_{b1}, 0, 0])$
+
+The code to derive $A_{b_x}$ and $A_{b_y}$ is [here](https://github.com/iden3/circomlib/blob/d5ed1c3ce4ca137a6b3ca48bec4ac12c1b38957a/src/pedersen_printbases.js). The function call required is `pedersenHash.getBasePoint('blake', 0)`
+
+1. Hash the string `PedersenGenerator_00000000000000000000000000000000_00000000000000000000000000000000` with $blake_{256}$. In big-endian hexadecimal format, the hash should be `1b3ef77ef2cd620fd2358e69dd564f35556aad552fdd7f06b777bd3a1d697160`.
+2. Set the 255th bit to 0. The result should be `1b3ef77ef2cd620fd2358e69dd564f35556aad552fdd7f06b777bd3a1d697120`.
+3. Use the method to convert a buffer to a point on the BabyJub curve described in [2.3.2].
+4. Multiply the point by 8. The result is the point with x-value $A_{b_x}$ and y-value $A_{b_y}$
+
+Given the [elliptic curve discrete logarithm problem](https://wstein.org/edu/2007/spring/ent/ent-html/node89.html), we assume that no one knows the private key $s \in {F}_p$ and by using the public key generation procedure in [1.4], we can derive $A_{b_x}$ and $A_{b_y}$. Furthermore, the string above (`PedersenGenerator...`) acts as a nothing-up-my-sleeve value.

package/versioned_docs/version-v2.x/core-concepts/workflow.md

@@ -0,0 +1,142 @@
+---
+title: MACI Workflow
+description: Overview of the MACI workflow
+sidebar_label: Workflow
+sidebar_position: 1
+---
+
+<!-- TODO: create flowcharts, similar to Kyle's (but make light/dark mode compatible) -->
+
+# MACI Workflow
+
+This article covers the high-level MACI workflow, which borrows heavily from our [Technical Introduction to MACI](/blog/maci-1-0-technical-introduction#system-overview).
+
+## Roles
+
+There are two key roles that participate in MACI:
+
+1. Users, who vote on polls
+2. A trusted coordinator, who configures and launches polls, tallies up votes, and publishes the final results
+
+### User (voter)
+
+A "User" is any voter in a MACI poll.
+
+In order to participate in a MACI poll, a user will perform at least 2 on-chain transactions:
+
+1. Sign up with MACI
+2. Vote on a poll
+
+<!-- TODO: add flowchart that demonstrates this (but show happy path, not key switching) -->
+<!-- https://miro.medium.com/v2/resize:fit:1400/format:webp/0*whHfC8-xxAwSyaaO -->
+
+### Coordinator
+
+The "Coordinator" helps set up and execute MACI polls. They are responsible for deploying the MACI smart contracts, initiating polls, tallying the final results of a vote, and finalizing polls by publishing the final results on-chain.
+
+:::info
+Note: it's possible for the contract deployer and the coordinator to be two separate accounts/entities, but for simplicity we'll start by assuming these functions are the same role.
+:::
+
+Once a voting poll has completed (i.e. the voting deadline has elapsed), the coordinator has the sole ability to decrypt all user votes and tally up the total results. The coordinator then publishes commitments and proofs of these results on chain to finalize a poll. The coordinators must use zk-SNARKs proofs to guarantee that their final tally result is valid, and this is accomplished without releasing the vote of every individual.
+
+<!-- In order to execute a MACI poll, a coordinator will perform at least 3 types of on-chain transactions:
+
+1. deploy contracts
+2. -->
+
+#### Trust assumptions
+
+We say the coordinator is a "trusted" coordinator, because there are areas where a corrupt (or inept) coordinator could disrupt the "happy path" of the MACI workflow.
+
+For instance, a coordinator can:
+
+- Decrypt votes (in order to publish them, or to bribe individual voters)
+- Halt a round (by never tallying results or never submitting the final proofs)
+
+A coordinator cannot:
+
+- Publish incorrect results (either by censoring valid votes or creating fraudulent votes)
+- Change the parameters of a poll (e.g. by extending its voting deadline once it's been deployed)
+
+Therefore, even if a coordinator is corrupt, they are unable to change a user’s vote or add extra votes themselves. A corrupt coordinator can stop a vote by never publishing the results, but they can’t publish false results.
+
+## Contracts
+
+To explain the MACI workflow, let's give a quick overview of the key smart contracts.
+
+See our [smart contract docs](/docs/category/smart-contracts) or our [contract source code](https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts) for a more in-depth explanation of all smart contracts.
+
+### MACI.sol
+
+The MACI contract is responsible for registering user signups by recording the initial public key for each user (via the [`signUp` function](/docs/technical-references/smart-contracts/solidity-docs/MACI#signup-1)). To conduct a voting round, the coordinator can deploy a Poll via MACI (with the [`deployPoll` function](/docs/technical-references/smart-contracts/solidity-docs/MACI#deploypoll)).
+
+### Poll.sol
+
+The Poll contract is where users submit their votes (via the [`publishMessage` function](/docs/technical-references/smart-contracts/solidity-docs/Poll#publishmessage)). One MACI contract can be used for multiple Poll contracts. In other words, a user that signed up to the MACI contract can vote on multiple issues, with each issue represented by a distinct Poll contract.
+
+### MessageProcessor.sol and Tally.sol
+
+The MessageProcessor and Tally contracts are used by the coordinator to process all user votes and to prove on-chain that they correctly tallied each vote.
+
+## Poll lifecycle
+
+As described above, a core contract of MACI is a Poll. Coordinators can deploy polls and add vote options to polls, which users can then vote on. Although each instance of MACI can deploy multiple Polls, only one Poll can be active at a time.
+
+In essence, each MACI Poll is a state machine which has 3 stages:
+
+1. Open
+2. Closed
+3. Finalized
+
+### 1) Open
+
+When a Poll is deployed, its voting period starts immediately. As part of its deployment, the `duration` of the Poll is set, which determines how long the Poll is open for voting. A Poll is "open" until the duration of the Poll has elapsed.
+
+During this stage, users can sign up and vote.
+
+#### Sign up
+
+Before a user can cast a vote, they must sign up by generating a MACI keypair and then sending the public key they wish to use to cast their vote to the MACI smart contract. This MACI public key (distinct from their Ethereum account public key) acts as their identity when voting. Users can vote from any Ethereum address, but their message must contain a signature from that MACI public key.
+
+This registration process is necessary to fortify MACI against Sybil attacks. The particular criteria used to allow user signups is customizable, and can be configured using any [SignUpGatekeeper contract](https://github.com/privacy-scaling-explorations/maci/blob/v2.5.0/packages/contracts/contracts/gatekeepers/SignUpGatekeeper.sol). This contract dictates the criteria a user must pass in order to participate in a poll. For example, a user might need to prove ownership of a certain NFT, or that they've received some attestation on EAS, or prove that they have passed some sort of proof-of-personhood verification. Note that MACI presumes an identity system where each legitimate member
+controls a unique private key - MACI does not specifically solve for this, but allows for customization on how this is configured.
+
+#### Vote
+
+Once a user has signed up with MACI, they are eligible to vote on open polls.
+
+To cast a vote, a user will bundle a few variables — including a public key, their vote option, their vote amount, and a few others — into what is called a "command". Then, the user signs the command with the private key they originally used to sign up. After that, the user encrypts the signature and command together so that it is now considered a "message". If the command is properly signed by the user’s MACI public key, then the message is considered valid will be counted in the final tally. Therefore, the MACI public key can be thought of as the user’s voting username, and the signature is the voting password. If they provide the correct signature, they can submit a vote.
+
+Before sending their vote on-chain, users encrypt their vote using a shared key that only the user and coordinator can know. This key scheme is designed so that every individual user shares a distinct key with the coordinator. This prevents any bribers from simply reading the transaction data to see which option a user voted for. It also allows the coordinator to decrypt user votes (so that they can tally the results).
+
+### 2) Closed
+
+A Poll is "closed", when the voting period ends. At this point, no users may submit any more votes. The Poll remains closed until the coordinator tallies the final results.
+
+At this point, the coordinator must process all the messages, tally the results, and publish the proofs on-chain.
+
+#### Process Messages
+
+Once the voting period has completed for a specific poll, the coordinator will use the `MessageProcessor` contract to first prove that they have correctly decrypted each message and applied them to correctly create an updated state tree. This state tree keeps an account of all the valid votes that should be counted. So, when processing the messages, the coordinator will not keep messages that are later overridden by a newer message inside the state tree. For example, if a user votes for option A, but then later sends a new message to vote for option B, the coordinator will only count the vote for option B.
+
+The coordinator must process messages in batches so that proving on chain does not exceed the data limit. The coordinator then creates a zk-SNARK proving their state tree correctly contains only the valid messages. Once the proof is ready, the coordinator calls [`MessageProcessor.processMessages()`](/docs/technical-references/smart-contracts/solidity-docs/MessageProcessor#processmessages), providing a hash of the state tree and the zk-SNARK proof as an input parameters.
+
+The `MessageProcessor` contract will send the proof to a separate verifier contract. The verifier contract is specifically built to read MACI zk-SNARK proofs and tell if they are valid or not. So, if the verifier contract returns true, then everyone can see on-chain that the coordinator correctly processed that batch of messages. The coordinator repeats this process until all messages have been processed.
+
+#### Tally Results
+
+Finally, once all messages have been processed, the coordinator tallies the votes of the valid messages (off-chain). The coordinator creates a zk-SNARK proving that the valid messages in the state tree (proved in Process Messages step) contain votes that sum to the given tally result. Then, they call [`Tally.tallyVotes()`](/docs/technical-references/smart-contracts/solidity-docs/Tally#tallyvotes) with a hash of the correct tally results and the zk-SNARK proof. Similarly to the processMessages function, the `tallyVotes` function will send the proof to a verifier contract to ensure that it is valid.
+
+<!-- "hash of the correct tally results" - so are the final results actually put on chain? or just a hash?? -->
+
+The `tallyVotes` function is only successful if the verifier contract returns that the proof is valid. Therefore, once the `tallyVotes` function succeeds, users can trust that the coordinator has correctly tallied all of the valid votes. After this step, anyone can see the final tally results and the proof that these results are a correct result of the messages sent to the Poll contract. The users won’t be able to see how any individual voted, but will be able to trust that these votes were properly processed and counted.
+
+<!-- "After this step, anyone can see the final tally results" - how if only hash of results are published? -->
+<!-- https://miro.medium.com/v2/resize:fit:1400/format:webp/0*7Le2odbX7e2etpxR -->
+
+### 3) Finalized
+
+A poll is "finalized" after the coordinator processes all the messages, tallies the results, and publishes the on-chain proofs.
+
+At this point, the final results of a poll can be announced, and anyone can verify that the results have been processed and calculated correctly by the coordinator.

package/versioned_docs/version-v2.x/getting-started.md

@@ -0,0 +1,313 @@
+---
+title: Getting Started
+description: Getting with MACI
+sidebar_label: Getting Started
+sidebar_position: 2
+---
+
+# Getting Started
+
+## Requirements
+
+You need the following to use MACI:
+
+- Node.js: use a JS toolchain manager like [`nvm`](https://github.com/nvm-sh/nvm) or [`volta`](https://volta.sh/) to install Node.js. We recommend using Node 20 or above.
+- [pnpm](https://pnpm.io/installation): Fast, disk space efficient package manager.
+
+## Installation
+
+To install MACI you need to run the following commands:
+
+```bash
+git clone https://github.com/privacy-scaling-explorations/maci.git && \
+cd maci && \
+git checkout v2.5.0 && \
+pnpm i && \
+pnpm run build
+```
+
+:::note
+We suggest you use the latest released version. You can check all the releases [here](https://github.com/privacy-scaling-explorations/maci/releases).
+:::
+
+#### Decide whether you need to compile new circuits or use the test ones
+
+If you are going to be making any changes to the circom circuits, then you can follow the [compile circuits guide](./guides/compile-circuits.md) and skip the next section.
+
+### Download the zero knowledge artifacts
+
+MACI has two main zk-SNARK circuits, and each of them is parameterized. There should be one
+`.zkey` file for each circuit and set of parameters.
+
+Unless you wish to generate a fresh set of `.zkey` files, you should obtain
+them from someone who has performed a multi-party trusted setup for said
+circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/security/trusted-setup) page.
+
+:::important
+Note the locations of the `.zkey` files cause you will need it when deploying contracts.
+:::
+
+#### Download test artifacts
+
+For all but production use cases, we suggest using the test artifacts, with the latest dev updates you can do it by running:
+
+```bash
+pnpm download-zkeys:test
+```
+
+#### Download ceremony artifacts
+
+For production you need to use the ceremony artifacts which have undergone a trusted setup, you can download them with the command:
+
+```bash
+pnpm download-zkeys:ceremony
+```
+
+:::info
+Currently, the ceremony artifacts work with MACI version up to 2.x
+:::
+
+## Deploy Contracts
+
+### Set the .env
+
+Head to the `packages/contracts` folder and copy the `.env.example` file.
+
+```bash
+cd packages/contracts && \
+cp .env.example .env
+```
+
+Make sure to include a mnemonic and RPC url (make sure to replace NETWORK with the network you want to use).
+
+```js
+MNEMONIC = "your_ethereum_secret_key";
+NETWORK_RPC_URL = "the_eth_provider_url";
+NETWORK_ETHERSCAN_API_KEY = "etherscan api key";
+```
+
+### Generate Coordinator Keys
+
+In order to run MACI polls, a coordinator is required to publish their MACI public key. You will need to generate a MACI keypair, and treat the private key just as your ethereum private keys. Please store them in a safe place as you won't be able to finish a round if you lose access, or if compromised a bad actor could decrypt the vote and publish them online. You can generate a new key pair using maci-cli by running the following commands:
+
+```bash
+cd packages/cli && \
+node build/ts/index.js genMaciKeyPair
+```
+
+### Set the configuration file
+
+Head back to the contracts folder and copy the config example and update the fields as necessary:
+
+```bash
+cd ../contracts && \
+cp deploy-config-example.json deploy-config.json
+
+```
+
+#### ConstantInitialVoiceCreditProxy
+
+Specifies the number of credits allocated to each voter.
+
+| Property   | Description                                              |
+| ---------- | -------------------------------------------------------- |
+| **deploy** | Defines if the contract needs to be deployed.            |
+| **amount** | Defines how many vote credits each participant will get. |
+
+#### Gatekeeper
+
+MACI uses a "gatekeeper" contract to configure and enforce the eligibility criteria of voters who can participate in MACI polls. In other words, it is a way to allowlist signups to the system to protect against sybil attacks. Please refer to the [gatekeeper page in the documentation](/docs/technical-references/smart-contracts/Gatekeepers) for more information on the supported Gatekeepers.
+
+| Property   | Description                                      |
+| ---------- | ------------------------------------------------ |
+| **deploy** | Defines if the contract is going to be deployed. |
+
+:::important
+For testing we suggest using the **FreeForAllGatekeeper** as it allows anyone to signup on MACI.
+:::
+
+#### MACI
+
+| Property           | Description                                 |
+| ------------------ | ------------------------------------------- |
+| **stateTreeDepth** | Defines how many users the system supports. |
+| **gatekeeper**     | Defines which gatekeeper to use.            |
+
+#### VkRegistry
+
+The VkRegistry hold the verifying keys used to verify the proofs, on the zkeys field we define the path to the zero knowledge artifacts we downloaded in the previous steps.
+
+| Property                | Description                                                                    |
+| ----------------------- | ------------------------------------------------------------------------------ |
+| **stateTreeDepth**      | Defines how many users the system supports.                                    |
+| **intStateTreeDepth**   | Defines how many ballots can be processed per batch when tallying the results. |
+| **messageTreeDepth**    | Defines how many messages (votes) the system supports.                         |
+| **voteOptionTreeDepth** | Defines how many vote options the system supports.                             |
+| **messageBatchDepth**   | Defines how many messages in a batch can the circuit process.                  |
+| **zkeys**               | Defines the path to the zkey files for QV and Non QV keys.                     |
+
+:::important
+The recommended values for test keys are: **10-1-2-2-1**. For ceremony keys: **14-5-9-3-2**.
+:::
+
+#### Poll
+
+| Property               | Description                                          |
+| ---------------------- | ---------------------------------------------------- |
+| **pollDuration**       | Defines how long is going to be the poll in seconds. |
+| **coordinatorPubkey**  | Defines the coordinator public MACI key.             |
+| **useQuadraticVoting** | Defines if the poll uses quadratic voting or not.    |
+
+### Deploy MACI Contracts
+
+To deploy the MACI contracts to a specific network you can append `:network` to the deployment commands, e.g. `pnpm deploy:sepolia` - please refer to the available networks on the package.json scripts section.
+
+```bash
+pnpm deploy:NETWORK
+```
+
+There are already some deployed contracts that could be reused, copy the `default-deployed-contracts.json` file if you need them to avoid deploying redundant contracts and save your gas fee.
+
+```bash
+cp default-deployed-contracts.json deployed-contracts.json
+```
+
+Delete any contract you want to redeploy and then run the following command to save gas:
+
+```bash
+pnpm deploy:NETWORK --incremental
+```
+
+### Deploy Poll
+
+Before deploying a Poll, make sure you have set the coordinator MACI public key to which you own the private key. To deploy your first Poll you can run the following command:
+
+```sh
+pnpm deploy-poll:NETWORK
+```
+
+:::important
+Starting another poll doesn't require deploying MACI contracts again, you can run `pnpm deploy-poll:NETWORK` command and then use the new poll-id.
+:::
+
+## Poll Finalization
+
+As a coordinator, first you need to merge signups and messages (votes). Messages are stored in a queue so when the poll is over, the coordinator needs to create the merkle tree from the queue ([AccQueue](/docs/v2.x/core-concepts/merkle-trees#accumulator-queue)). This optimization is needed to reduce gas cost for voters. Then the coordinator generates proofs for the message processing, and tally calculations. This allows to publish the poll results on-chain and then everyone can verify the results when the poll is over. You run a merge with:
+
+```bash
+pnpm merge:[network] --poll [poll-id]
+```
+
+Then you need to generate the proofs for the message processing, and tally calculations. This allows to publish the poll results on-chain and then everyone can verify the results:
+
+```bash
+pnpm run prove:[network] --poll [poll-id] \
+    --coordinator-private-key [coordinator-maci-private-key] \
+    --tally-file ../results/tally.json \
+    --output-dir ../results/proofs/ \
+    --start-block [block-number]
+    --blocks-per-batch [number-of-blocks]
+```
+
+:::important
+You can reduce the time of the proving by including more blocks per batch, you can try with 500.
+:::
+
+#### Submit On-chain
+
+Now it's time to submit the poll results on-chain so that everyone can verify the results:
+
+```bash
+pnpm submitOnChain:[network] --poll [poll-id] \
+    --output-dir proofs/ \
+    --tally-file proofs/tally.json
+```
+
+### Tally
+
+Once the proofs are generated, and results tallied, the results (Tally) are written to a file. Let's take a look at one:
+
+```json
+{
+  "maci": "0xd54b47F8e6A1b97F3A84f63c867286272b273b7C",
+  "pollId": "0",
+  "network": "localhost",
+  "chainId": "31337",
+  "isQuadratic": true,
+  "tallyAddress": "0xD4fbAF1dFe100d07f8Ef73d8c92e93d0Bcf7b45D",
+  "newTallyCommitment": "0x2f55cc85f7f141098ba791a9f6a646f8773b9bb4f5852ccc33b5a28e7b0756e5",
+  "results": {
+    "tally": [
+      "9",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0"
+    ],
+    "salt": "0x2e9cd240b86cf456fa4deced8e7420c45e3c16941d2dcec308f8b6d48264dda3",
+    "commitment": "0x296eac2a7289974f23497bebd39e86599d0b7032796fb84dcc1f6bbda38262ca"
+  },
+  "totalSpentVoiceCredits": {
+    "spent": "81",
+    "salt": "0x24f57b75c227987727c13d1e83409d70478b42bdc12a4a4df8129c72fbaf5aaf",
+    "commitment": "0xb4ebe68b0da828c0b978ddee86ba934b8e215499ac766491f236ad85fd606de"
+  },
+  "perVOSpentVoiceCredits": {
+    "tally": [
+      "81",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0",
+      "0"
+    ],
+    "salt": "0x2590434ea2d600f7bd2396ba7fa454ad4c975c29424ee481561d9786538a5e48",
+    "commitment": "0x54ec996599886da21c4b07c25d1de544292a8b7c38b79726995c869c9e95db"
+  }
+}
+```
+
+We observe an array named results, which holds the aggregated votes for each option. Each option corresponds to an index in the array. In the example above, the first option (index 0) received a total of 9 votes, while all other options received no votes
+
+The `totalSpentVoiceCredits` object contains the total amount of voice credits spent in the poll. This is the sum of all voice credits spent by all voters, and in quadratic voting, is the sum of the squares of all votes.
+
+The `perVOSpentVoiceCredits` will contain the amount of voice credits spent per vote option. In this case, the first option received 81 voice credits, and every other option received 0 voice credits. This is because there was only one valid vote casted, with a weight of 9. Given the quadratic voting formula, the total amount of voice credits spent is 81.

package/versioned_docs/version-v2.x/guides/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Guides",
+  "position": 4
+}

package/versioned_docs/version-v2.x/guides/compile-circuits.md

@@ -0,0 +1,163 @@
+---
+title: Compile Circuits
+description: Compile new circuits
+sidebar_label: Compile Circuits
+sidebar_position: 4
+---
+
+# Compile Circuits
+
+:::note
+This guide is only useful if you need an specific configurations for number of users, votes, etc. If you plant to use the new circuits in production, make sure they go through a trusted ceremony.
+:::
+
+## Installation
+
+### Requirements
+
+You need the following to generate new circuits:
+
+- The [`rapidsnark`](https://github.com/iden3/rapidsnark) tool if running on an intel chip (this allows for faster proof generation vs snarkjs).
+
+:::note
+MACI works on Linux and MacOS. It has not been tested on Windows, however it should work on Windows Subsystem for Linux (WSL). Keep in mind that when using MACI e2e on a non intel chip, tests will run using snarkjs with WASM. This will result in slower proof generation.
+:::
+
+### Install `rapidsnark` (if on an intel chip)
+
+First, install dependencies:
+
+```bash
+sudo apt-get install build-essential cmake libgmp-dev libsodium-dev nasm curl m4
+```
+
+If you're running on **MacOS with an intel chip**, install dependencies by running the following command:
+
+```bash
+brew install cmake gmp libsodium nasm
+```
+
+Next, clone `rapidsnark` and build it:
+
+```bash
+git clone https://github.com/iden3/rapidsnark.git && \
+cd rapidsnark
+
+pnpm install && \
+git submodule init && \
+git submodule update && \
+./build_gmp.sh host && \
+mkdir build_prover && cd build_prover && \
+cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package && \
+make -j4 && make install
+```
+
+Note the location of the `rapidsnark` binary (e.g.
+`/home/user/rapidsnark/build/prover`).
+
+For more information, please check rapidsnark [github repo](https://github.com/iden3/rapidsnark)
+
+### Install circom v2:
+
+https://docs.circom.io/
+
+Note the location of the `circom` binary (e.g. `$HOME/.cargo/bin/circom`), as you will need it later.
+
+#### On Intel chips (no ARM64)
+
+Install dependencies:
+
+```bash
+sudo apt-get install libgmp-dev nlohmann-json3-dev nasm g++
+```
+
+:::info
+Remember that if on a ARM64 chip, you will not be able to compile the c++ witness generator and thus use rapidsnark. Please follow instructions for WASM artifacts, in case you decide to recompile artifacts.
+:::
+
+### Configure circomkit
+
+Edit `circuits/circom/circuits` to include the circuits you would like to compile. This comes already configured with the three main circuits and with testing parameters:
+
+```json
+{
+  "ProcessMessages_10-2-1-2_test": {
+    "file": "processMessages",
+    "template": "ProcessMessages",
+    "params": [10, 2, 1, 2],
+    "pubs": [
+      "numSignUps",
+      "index",
+      "batchEndIndex",
+      "msgRoot",
+      "currentSbCommitment",
+      "newSbCommitment",
+      "pollEndTimestamp",
+      "actualStateTreeDepth",
+      "coordinatorPublicKeyHash"
+    ]
+  },
+  "ProcessMessagesNonQv_10-2-1-2_test": {
+    "file": "processMessagesNonQv",
+    "template": "ProcessMessagesNonQv",
+    "params": [10, 2, 1, 2],
+    "pubs": [
+      "numSignUps",
+      "index",
+      "batchEndIndex",
+      "msgRoot",
+      "currentSbCommitment",
+      "newSbCommitment",
+      "pollEndTimestamp",
+      "actualStateTreeDepth",
+      "coordinatorPublicKeyHash"
+    ]
+  },
+  "TallyVotes_10-1-2_test": {
+    "file": "tallyVotes",
+    "template": "TallyVotes",
+    "params": [10, 1, 2],
+    "pubs": ["index", "numSignUps", "sbCommitment", "currentTallyCommitment", "newTallyCommitment"]
+  },
+  "TallyVotesNonQv_10-1-2_test": {
+    "file": "tallyVotesNonQv",
+    "template": "TallyVotesNonQv",
+    "params": [10, 1, 2],
+    "pubs": ["index", "numSignUps", "sbCommitment", "currentTallyCommitment", "newTallyCommitment"]
+  }
+}
+```
+
+### Generate `.zkey` files
+
+If you wish to generate `.zkey` files from scratch, first navigate to `circuits/circom`
+and edit `circuits.json`. Set the parameters you need.
+
+Next, run the following to compile the circuits with parameters you specified:
+
+**for the c++ witness generator**
+
+```bash
+pnpm test:circuits-c -- --outPath ../cli/zkeys
+```
+
+**for the wasm witness generator**
+
+```bash
+pnpm build:circuits-wasm -- --outPath ../cli/zkeys
+```
+
+Finally, generate the `.zkey` files. This may require a lot of memory and time.
+
+```bash
+pnpm setup:zkeys -- --outPath ../cli/zkeys
+```
+
+> If on a ARM64 chip, the above will work with the wasm witness only. The errors you will get for the c++ witness are:
+>
+> ```bash
+> main.cpp:9:10: fatal error: 'nlohmann/json.hpp' file not found
+> #include <nlohmann/json.hpp>
+>        ^~~~~~~~~~~~~~~~~~~
+> 1 error generated.
+> ```