@maci-protocol/website 0.0.0-ci.5c85652 → 0.0.0-ci.5d489df

package/versioned_docs/version-v3.x/guides/testing/testing-in-detail.md

@@ -154,7 +154,7 @@ Within the circuits folder, there are a number of tests that are used to verify
 
 These tests often use mock data from the `core` package. For instance, when testing the `processMessages` circuit, we are required to generate the parameters from the `core` packing, using the `Poll:processMessages` function. The same applies to vote tallying, where we need the `Poll:tally` function to be run first with mock users and vote messages.
 
-All of the tests run using test parameters, usually `10, 20, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](/docs/security/trusted-setup).
+All of the tests run using test parameters, usually `10, 20, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](/docs/security/trusted-setup).
 
 ### Core
 
@@ -162,7 +162,7 @@ The core package contains a number of tests that are used to verify that the cor
 
 These tests interact with the crypto and dombinobjs packages, where mock data comes from. Their main goal is to ensure that the core functions work as expected, and that the state is as expected after a series of operations.
 
-Currently, there is a blend of e2e and unit tests, where e2e tests are used to verify that the entire MACI local processing works as expected (users signup, publish votes, messages are processed and finally these votes are tallied). Unit tests on the other hand are used to verify that the core functions work as expected, such as `MessageProcessor` and `VoteTally`. You will find them in separate files, with e2e being [here](https://github.com/privacy-scaling-explorations/maci/blob/dev/core/ts/__tests__/e2e.test.ts) and unit tests in the other files.
+Currently, there is a blend of e2e and unit tests, where e2e tests are used to verify that the entire MACI local processing works as expected (users signup, publish votes, messages are processed and finally these votes are tallied). Unit tests on the other hand are used to verify that the core functions work as expected, such as `MessageProcessor` and `VoteTally`. You will find them in separate files, with e2e being [here](https://github.com/privacy-scaling-explorations/maci/blob/main/core/ts/__tests__/e2e.test.ts) and unit tests in the other files.
 
 ### Domainobjs/Crypto tests
 
@@ -170,7 +170,7 @@ These tests are used to verify that MACI's primitives such as private keys work
 
 ## "Manual" Testing
 
-To ensure that the MACI stack works as expected, without having to run the entire test suite (or even just the e2e tests), there is a [bash script](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/testScriptLocalhost.sh) inside the contracts folder which can be used.
+To ensure that the MACI stack works as expected, without having to run the entire test suite (or even just the e2e tests), there is a [bash script](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/testScriptLocalhost.sh) inside the contracts folder which can be used.
 
 This script contains a number of actions which touch all of the parts of MACI, and resemble exactly what other e2e tests do.
 

package/versioned_docs/version-v3.x/guides/testing/testing-introduction.md

@@ -53,6 +53,32 @@ To run Contracts only tests, run:
 pnpm run test
 ```
 
+To run e2e tests for hardhat tasks for `contracts` using the in-memory hardhat network:
+
+```bash
+pnpm run test:hardhat
+```
+
+You can update the `deploy-config.json` file to change policies or other deployment settings used by the test.
+
+You can enhance test reporting and gas cost estimation by adding the following variables to your `.env` file:
+
+```bash
+# CoinMarkerCap api key for prices (gas reporter)
+COINMARKETCAP_API_KEY=
+# Gas price for gas reporter
+# Allows you to manually specify the gas price (e.g. 3 gwei)
+GAS_REPORTER_PRICE=
+```
+
+These variables are used by `hardhat-gas-reporter` to show cost estimates for gas usage in the test reports.
+
+If you would like to run these E2E tests against a different [supported networks](/docs/supported-networks/), you can override the network like this:
+
+```bash
+pnpm exec hardhat test --network {NETWORK} ./tests/e2e/hardhatTasks.test.ts
+```
+
 ### Circuits
 
 To test the circuits, from the main `maci/` directory, run:
@@ -86,7 +112,7 @@ circuits.
 
 Note the locations of the `.zkey` files as the smart contract tasks require them as part of the JSON configuration file.
 
-For testing purposes you can download the required artifacts using the [`download-zkeys:test`](https://github.com/privacy-scaling-explorations/maci/blob/dev/package.json#L15). The script will place all required artifacts inside the `cli/zkeys` folder.
+For testing purposes you can download the required artifacts using the [`download-zkeys:test`](https://github.com/privacy-scaling-explorations/maci/blob/main/package.json#L15). The script will place all required artifacts inside the `cli/zkeys` folder.
 
 You can run the script directly with bash or use pnpm: `pnpm run download:test-zkeys` from the monorepo root.
 
@@ -97,19 +123,19 @@ From the root folder, run:
 **for c++ witness generator**
 
 ```bash
-pnpm build:circuits-c -- --outPath ../testing/zkeys
+pnpm build:circuits-c -- --outPath ../../zkeys
 ```
 
 **for wasm witness generator**
 
 ```bash
-pnpm build:circuits-wasm -- --outPath ../testing/zkeys
+pnpm build:circuits-wasm -- --outPath ../../zkeys
 ```
 
 **generate zkeys**
 
 ```bash
-pnpm setup:zkeys --outPath ../testing/zkeys
+pnpm setup:zkeys --outPath ../../zkeys
 ```
 
 ### Check the Rapidsnark binary

package/versioned_docs/version-v3.x/guides/troubleshooting.md

@@ -71,7 +71,7 @@ Error: commitment mismatch
 
 This is because commitments are generated using random salts, thus will differ at each `generateProofs` run.
 
-In [core/Poll.ts](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/core/ts/Poll.ts):
+In [core/Poll.ts](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/core/ts/Poll.ts):
 
 ```
 let newSbSalt = genRandomSalt();
@@ -140,7 +140,7 @@ event MergeMessageAqSubRoots(uint256 indexed _numSrQueueOps);
 event MergeMessageAq(uint256 indexed _messageRoot);
 ```
 
-Please remember to pull the latest MACI repo updates(`git fetch origin && git pull origin dev`) and run `pnpm build` in the root of this monorepo.
+Please remember to pull the latest MACI repo updates(`git fetch origin && git pull origin main`) and run `pnpm build` in the root of this monorepo.
 
 ### Verifier contract found the proof invalid
 

package/versioned_docs/version-v3.x/processes/versioning.md

@@ -19,7 +19,7 @@ MACI follows the [Semantic Versioning Specification (SemVer)](https://semver.org
 
 All MACI packages are organized in our monorepo and follow a global release approach, meaning that all packages have the same version.
 
-Currently, MACI core team manually decides when to release and what the version should be. Packages are released [automatically via CI](https://github.com/privacy-scaling-explorations/maci/blob/dev/.github/workflows/release.yml) when a new tag is created in GitHub. [You can view our releases and tags in GitHub](https://github.com/privacy-scaling-explorations/maci/releases).
+Currently, MACI core team manually decides when to release and what the version should be. Packages are released [automatically via CI](https://github.com/privacy-scaling-explorations/maci/blob/main/.github/workflows/release.yml) when a new tag is created in GitHub. [You can view our releases and tags in GitHub](https://github.com/privacy-scaling-explorations/maci/releases).
 
 ## MACI Release Process
 
@@ -37,10 +37,10 @@ Version number '1.2.3' is used here as an example. You should replace the versio
 git clone https://github.com/privacy-scaling-explorations/maci
 ```
 
-3. Switch to the `dev` branch:
+3. Switch to the `main` branch:
 
 ```
-git checkout dev
+git checkout main
 ```
 
 4. Install required dependencies:

package/versioned_docs/version-v3.x/security/trusted-setup.md

@@ -17,7 +17,7 @@ to manage a large amount of value, and if their users accept that the risk of
 coordinator misbehaviour is insufficient to justify doing the work of a
 trusted setup. After all, MACI's security model presumes a trusted coordinator.
 
-The [PSE team](https://pse.dev/) is making available a trusted set of zKeys for MACI's circuits,
+The [PSE team](https://pse.main/) is making available a trusted set of zKeys for MACI's circuits,
 which are available and accessible on
 [p0tion's website](https://ceremony.pse.dev/).
 For more info on trusted setup ceremonies please refer to p0tion's [docs](https://p0tion.super.site/).

package/versioned_docs/version-v3.x/supported-networks/costs.md

@@ -417,3 +417,309 @@ Below are the estimated costs for various MACI operations and deployments, assum
 | ZupassPolicyFactory                      | -       | -       | 785744  | 2.6 %            | 0.0788    |
 
 </details>
+
+## Costs on Ethereum Mainnet
+
+Below are the estimated costs for various MACI operations and deployments, assuming:
+
+- **Gas price**: 7 gwei
+- **ETH price**: $2526
+
+<details>
+<summary>Contract calls cost</summary>
+
+| Contract                                 | Method                     | Min     | Max     | Avg     | USD (avg) |
+| ---------------------------------------- | -------------------------- | ------- | ------- | ------- | --------- |
+| AnonAadhaarCheckerFactory                | deploy                     | -       | -       | 125971  | 2.23      |
+| AnonAadhaarPolicy                        | enforce                    | -       | -       | 38141   | 0.67      |
+| AnonAadhaarPolicy                        | setTarget                  | 50133   | 50167   | 50149   | 0.89      |
+| AnonAadhaarPolicyFactory                 | deploy                     | -       | -       | 129387  | 2.29      |
+| ConstantInitialVoiceCreditProxyFactory   | deploy                     | -       | -       | 118665  | 2.10      |
+| EASCheckerFactory                        | deploy                     | -       | -       | 155556  | 2.75      |
+| EASPolicyFactory                         | deploy                     | -       | -       | 129387  | 2.29      |
+| ERC20CheckerFactory                      | deploy                     | -       | -       | 125959  | 2.23      |
+| ERC20PolicyFactory                       | deploy                     | -       | -       | 129365  | 2.29      |
+| ERC20VotesCheckerFactory                 | deploy                     | -       | -       | 154673  | 2.74      |
+| ERC20VotesInitialVoiceCreditProxyFactory | deploy                     | -       | -       | 176590  | 3.12      |
+| ERC20VotesPolicyFactory                  | deploy                     | -       | -       | 129365  | 2.29      |
+| FreeForAllCheckerFactory                 | deploy                     | -       | -       | 89376   | 1.58      |
+| FreeForAllPolicyFactory                  | deploy                     | 129375  | 129387  | 129386  | 2.29      |
+| GitcoinPassportCheckerFactory            | deploy                     | -       | -       | 125937  | 2.23      |
+| GitcoinPassportPolicyFactory             | deploy                     | -       | -       | 129365  | 2.29      |
+| HatsCheckerFactory                       | deploy                     | -       | -       | 169023  | 2.99      |
+| HatsPolicyFactory                        | deploy                     | -       | -       | 129387  | 2.29      |
+| MACI                                     | deployPoll                 | 1580777 | 1583817 | 1581631 | 27.98     |
+| MACI                                     | signUp                     | 197667  | 730504  | 315320  | 5.58      |
+| MerkleProofCheckerFactory                | deploy                     | -       | -       | 119047  | 2.11      |
+| MerkleProofPolicyFactory                 | deploy                     | -       | -       | 129387  | 2.29      |
+| MessageProcessor                         | processMessages            | 252065  | 252976  | 252375  | 4.46      |
+| Poll                                     | joinPoll                   | 282314  | 503970  | 334836  | 5.92      |
+| Poll                                     | mergeState                 | 176483  | 331802  | 232886  | 4.12      |
+| Poll                                     | padLastBatch               | -       | -       | 81884   | 1.45      |
+| Poll                                     | publishMessage             | -       | -       | 358677  | 6.34      |
+| Poll                                     | publishMessageBatch        | -       | -       | 671442  | 11.88     |
+| Poll                                     | relayMessagesBatch         | -       | -       | 155223  | 2.75      |
+| PollFactory                              | deploy                     | -       | -       | 1099100 | 19.44     |
+| SemaphoreCheckerFactory                  | deploy                     | -       | -       | 106047  | 1.88      |
+| SemaphorePolicyFactory                   | deploy                     | -       | -       | 129387  | 2.29      |
+| Tally                                    | addTallyResults            | 7312489 | 7844939 | 7578714 | 134.05    |
+| Tally                                    | tallyVotes                 | 147320  | 204580  | 161641  | 2.86      |
+| TokenCheckerFactory                      | deploy                     | -       | -       | 97197   | 1.72      |
+| TokenPolicyFactory                       | deploy                     | -       | -       | 129387  | 2.29      |
+| VerifyingKeysRegistry                    | setPollJoinedVerifyingKey  | -       | -       | 453033  | 8.01      |
+| VerifyingKeysRegistry                    | setPollJoiningVerifyingKey | -       | -       | 453011  | 8.01      |
+| VerifyingKeysRegistry                    | setVerifyingKeys           | 885514  | 885526  | 885517  | 15.66     |
+| VerifyingKeysRegistry                    | setVerifyingKeysBatch      | -       | -       | 1787720 | 31.62     |
+| ZupassCheckerFactory                     | deploy                     | -       | -       | 206318  | 3.65      |
+| ZupassPolicyFactory                      | deploy                     | -       | -       | 129365  | 2.29      |
+
+</details>
+
+<details>
+<summary>Deployment cost</summary>
+
+| Deployments                              | Min Gas | Max Gas | Avg Gas | % of Block Limit | USD (avg) |
+| ---------------------------------------- | ------- | ------- | ------- | ---------------- | --------- |
+| AnonAadhaarCheckerFactory                | -       | -       | 567621  | 1.9 %            | 10.04     |
+| AnonAadhaarPolicyFactory                 | -       | -       | 759390  | 2.5 %            | 13.43     |
+| ConstantInitialVoiceCreditProxyFactory   | -       | -       | 379812  | 1.3 %            | 6.72      |
+| EASCheckerFactory                        | -       | -       | 623304  | 2.1 %            | 11.02     |
+| EASPolicyFactory                         | -       | -       | 690560  | 2.3 %            | 12.21     |
+| ERC20CheckerFactory                      | -       | -       | 446429  | 1.5 %            | 7.90      |
+| ERC20PolicyFactory                       | -       | -       | 684892  | 2.3 %            | 12.11     |
+| ERC20VotesCheckerFactory                 | -       | -       | 464123  | 1.5 %            | 8.21      |
+| ERC20VotesInitialVoiceCreditProxyFactory | -       | -       | 482127  | 1.6 %            | 8.53      |
+| ERC20VotesPolicyFactory                  | -       | -       | 685960  | 2.3 %            | 12.13     |
+| FreeForAllCheckerFactory                 | -       | -       | 329927  | 1.1 %            | 5.84      |
+| FreeForAllPolicyFactory                  | -       | -       | 653501  | 2.2 %            | 11.56     |
+| GitcoinPassportCheckerFactory            | -       | -       | 463912  | 1.5 %            | 8.21      |
+| GitcoinPassportPolicyFactory             | -       | -       | 687052  | 2.3 %            | 12.15     |
+| Hasher                                   | -       | -       | 426472  | 1.4 %            | 7.54      |
+| HatsCheckerFactory                       | -       | -       | 572538  | 1.9 %            | 10.13     |
+| HatsPolicyFactory                        | -       | -       | 684664  | 2.3 %            | 12.11     |
+| MACI                                     | 1803354 | 1803438 | 1803408 | 6 %              | 31.90     |
+| MerkleProofCheckerFactory                | -       | -       | 491985  | 1.6 %            | 8.70      |
+| MerkleProofPolicyFactory                 | -       | -       | 686188  | 2.3 %            | 12.14     |
+| MessageProcessorFactory                  | 1818377 | 1818401 | 1818398 | 6.1 %            | 32.16     |
+| PollFactory                              | 3725815 | 3725863 | 3725858 | 12.4 %           | 65.90     |
+| PoseidonT3                               | -       | -       | 2157126 | 7.2 %            | 38.15     |
+| PoseidonT4                               | -       | -       | 2745274 | 9.2 %            | 48.56     |
+| PoseidonT5                               | -       | -       | 3569887 | 11.9 %           | 63.14     |
+| PoseidonT6                               | -       | -       | 4261625 | 14.2 %           | 75.38     |
+| SemaphoreCheckerFactory                  | -       | -       | 557606  | 1.9 %            | 9.86      |
+| SemaphorePolicyFactory                   | -       | -       | 749517  | 2.5 %            | 13.26     |
+| TallyFactory                             | 2207358 | 2207382 | 2207379 | 7.4 %            | 39.04     |
+| TokenCheckerFactory                      | -       | -       | 435769  | 1.5 %            | 7.71      |
+| TokenPolicyFactory                       | -       | -       | 690920  | 2.3 %            | 12.22     |
+| Utilities                                | -       | -       | 664356  | 2.2 %            | 11.75     |
+| Verifier                                 | -       | -       | 775226  | 2.6 %            | 13.71     |
+| VerifyingKeysRegistry                    | -       | -       | 1755862 | 5.9 %            | 31.06     |
+| ZupassCheckerFactory                     | -       | -       | 640425  | 2.1 %            | 11.33     |
+| ZupassGroth16Verifier                    | -       | -       | 1108706 | 3.7 %            | 19.61     |
+| ZupassPolicyFactory                      | -       | -       | 785744  | 2.6 %            | 13.90     |
+
+</details>
+
+## Costs on Arbitrum
+
+Below are the estimated costs for various MACI operations and deployments, assuming:
+
+- **Gas price**: 0.012 gwei
+- **ETH price**: $2595
+
+<details>
+<summary>Contract calls cost</summary>
+
+| Contract                                 | Method                     | Min     | Max     | Avg     | USD (avg) |
+| ---------------------------------------- | -------------------------- | ------- | ------- | ------- | --------- |
+| AnonAadhaarCheckerFactory                | deploy                     | -       | -       | 125971  | 0.00402   |
+| AnonAadhaarPolicy                        | enforce                    | -       | -       | 38141   | 0.00122   |
+| AnonAadhaarPolicy                        | setTarget                  | 50133   | 50167   | 50149   | 0.0016    |
+| AnonAadhaarPolicyFactory                 | deploy                     | -       | -       | 129387  | 0.00413   |
+| ConstantInitialVoiceCreditProxyFactory   | deploy                     | -       | -       | 118665  | 0.00379   |
+| EASCheckerFactory                        | deploy                     | -       | -       | 155556  | 0.00497   |
+| EASPolicyFactory                         | deploy                     | -       | -       | 129387  | 0.00413   |
+| ERC20CheckerFactory                      | deploy                     | -       | -       | 125959  | 0.00402   |
+| ERC20PolicyFactory                       | deploy                     | -       | -       | 129365  | 0.00413   |
+| ERC20VotesCheckerFactory                 | deploy                     | -       | -       | 154673  | 0.00494   |
+| ERC20VotesInitialVoiceCreditProxyFactory | deploy                     | -       | -       | 176590  | 0.00564   |
+| ERC20VotesPolicyFactory                  | deploy                     | -       | -       | 129365  | 0.00413   |
+| FreeForAllCheckerFactory                 | deploy                     | -       | -       | 89376   | 0.00286   |
+| FreeForAllPolicyFactory                  | deploy                     | 129375  | 129387  | 129386  | 0.00413   |
+| GitcoinPassportCheckerFactory            | deploy                     | -       | -       | 125937  | 0.00402   |
+| GitcoinPassportPolicyFactory             | deploy                     | -       | -       | 129365  | 0.00413   |
+| HatsCheckerFactory                       | deploy                     | -       | -       | 169023  | 0.0054    |
+| HatsPolicyFactory                        | deploy                     | -       | -       | 129387  | 0.00413   |
+| MACI                                     | deployPoll                 | 1580765 | 1583829 | 1581626 | 0.05052   |
+| MACI                                     | signUp                     | 197667  | 730480  | 315320  | 0.01007   |
+| MerkleProofCheckerFactory                | deploy                     | -       | -       | 119047  | 0.0038    |
+| MerkleProofPolicyFactory                 | deploy                     | -       | -       | 129387  | 0.00413   |
+| MessageProcessor                         | processMessages            | 252019  | 252918  | 252319  | 0.00806   |
+| Poll                                     | joinPoll                   | 282314  | 503970  | 334837  | 0.0107    |
+| Poll                                     | mergeState                 | 198686  | 354005  | 255089  | 0.00815   |
+| Poll                                     | padLastBatch               | -       | -       | 81884   | 0.00262   |
+| Poll                                     | publishMessage             | -       | -       | 358725  | 0.01146   |
+| Poll                                     | publishMessageBatch        | -       | -       | 671490  | 0.02145   |
+| Poll                                     | relayMessagesBatch         | -       | -       | 155235  | 0.00496   |
+| PollFactory                              | deploy                     | -       | -       | 1099100 | 0.03511   |
+| SemaphoreCheckerFactory                  | deploy                     | -       | -       | 106047  | 0.00339   |
+| SemaphorePolicyFactory                   | deploy                     | -       | -       | 129387  | 0.00413   |
+| Tally                                    | addTallyResults            | 7311562 | 7844012 | 7577787 | 0.24207   |
+| Tally                                    | tallyVotes                 | 147262  | 204522  | 161585  | 0.00516   |
+| TokenCheckerFactory                      | deploy                     | -       | -       | 97197   | 0.0031    |
+| TokenPolicyFactory                       | deploy                     | -       | -       | 129387  | 0.00413   |
+| VerifyingKeysRegistry                    | setPollJoinedVerifyingKey  | -       | -       | 453033  | 0.01447   |
+| VerifyingKeysRegistry                    | setPollJoiningVerifyingKey | -       | -       | 453011  | 0.01447   |
+| VerifyingKeysRegistry                    | setVerifyingKeys           | 885514  | 885526  | 885517  | 0.02829   |
+| VerifyingKeysRegistry                    | setVerifyingKeysBatch      | -       | -       | 1787720 | 0.05711   |
+| ZupassCheckerFactory                     | deploy                     | -       | -       | 206318  | 0.00659   |
+| ZupassPolicyFactory                      | deploy                     | -       | -       | 129365  | 0.00413   |
+
+</details>
+
+<details>
+<summary>Deployment cost</summary>
+
+| Deployments                              | Min Gas | Max Gas | Avg Gas | % of Limit | USD (avg) |
+| ---------------------------------------- | ------- | ------- | ------- | ---------- | --------- |
+| AnonAadhaarCheckerFactory                | -       | -       | 567621  | 1.9%       | 0.01813   |
+| AnonAadhaarPolicyFactory                 | -       | -       | 759390  | 2.5%       | 0.02426   |
+| ConstantInitialVoiceCreditProxyFactory   | -       | -       | 379812  | 1.3%       | 0.01213   |
+| EASCheckerFactory                        | -       | -       | 623304  | 2.1%       | 0.01991   |
+| EASPolicyFactory                         | -       | -       | 690560  | 2.3%       | 0.02206   |
+| ERC20CheckerFactory                      | -       | -       | 446429  | 1.5%       | 0.01426   |
+| ERC20PolicyFactory                       | -       | -       | 684892  | 2.3%       | 0.02188   |
+| ERC20VotesCheckerFactory                 | -       | -       | 464123  | 1.5%       | 0.01483   |
+| ERC20VotesInitialVoiceCreditProxyFactory | -       | -       | 482127  | 1.6%       | 0.01540   |
+| ERC20VotesPolicyFactory                  | -       | -       | 685960  | 2.3%       | 0.02191   |
+| FreeForAllCheckerFactory                 | -       | -       | 329927  | 1.1%       | 0.01054   |
+| FreeForAllPolicyFactory                  | -       | -       | 653501  | 2.2%       | 0.02088   |
+| GitcoinPassportCheckerFactory            | -       | -       | 463912  | 1.5%       | 0.01482   |
+| GitcoinPassportPolicyFactory             | -       | -       | 687052  | 2.3%       | 0.02195   |
+| Hasher                                   | -       | -       | 426472  | 1.4%       | 0.01362   |
+| HatsCheckerFactory                       | -       | -       | 572538  | 1.9%       | 0.01829   |
+| HatsPolicyFactory                        | -       | -       | 684664  | 2.3%       | 0.02187   |
+| MACI                                     | 1803354 | 1803438 | 1803408 | 6.0%       | 0.05761   |
+| MerkleProofCheckerFactory                | -       | -       | 491985  | 1.6%       | 0.01572   |
+| MerkleProofPolicyFactory                 | -       | -       | 686188  | 2.3%       | 0.02192   |
+| MessageProcessorFactory                  | 1818377 | 1818401 | 1818398 | 6.1%       | 0.05809   |
+| PollFactory                              | 3720635 | 3720683 | 3720678 | 12.4%      | 0.11885   |
+| PoseidonT3                               | -       | -       | 2157126 | 7.2%       | 0.06891   |
+| PoseidonT4                               | -       | -       | 2745274 | 9.2%       | 0.0877    |
+| PoseidonT5                               | -       | -       | 3569887 | 11.9%      | 0.11404   |
+| PoseidonT6                               | -       | -       | 4261625 | 14.2%      | 0.13613   |
+| SemaphoreCheckerFactory                  | -       | -       | 557606  | 1.9%       | 0.01781   |
+| SemaphorePolicyFactory                   | -       | -       | 749517  | 2.5%       | 0.02394   |
+| TallyFactory                             | 2176647 | 2176671 | 2176668 | 7.3%       | 0.06953   |
+| TokenCheckerFactory                      | -       | -       | 435769  | 1.5%       | 0.01392   |
+| TokenPolicyFactory                       | -       | -       | 690920  | 2.3%       | 0.02207   |
+| Utilities                                | -       | -       | 664356  | 2.2%       | 0.02122   |
+| Verifier                                 | -       | -       | 775226  | 2.6%       | 0.02476   |
+| VerifyingKeysRegistry                    | -       | -       | 1755862 | 5.9%       | 0.05609   |
+| ZupassCheckerFactory                     | -       | -       | 640425  | 2.1%       | 0.02046   |
+| ZupassGroth16Verifier                    | -       | -       | 1108706 | 3.7%       | 0.03542   |
+| ZupassPolicyFactory                      | -       | -       | 785744  | 2.6%       | 0.0251    |
+
+</details>
+
+## Costs on Optimism
+
+Below are the estimated costs for various MACI operations and deployments, assuming:
+
+- **Gas price**: 0.016 gwei
+- **ETH price**: $2493
+
+<details>
+<summary>Contract calls cost</summary>
+
+| Contract                                 | Method                     | Min     | Max     | Avg     | USD (avg) |
+| ---------------------------------------- | -------------------------- | ------- | ------- | ------- | --------- |
+| AnonAadhaarCheckerFactory                | deploy                     | -       | -       | 125971  | 0.00496   |
+| AnonAadhaarPolicy                        | enforce                    | -       | -       | 38141   | 0.0016    |
+| AnonAadhaarPolicy                        | setTarget                  | 50133   | 50167   | 50149   | 0.00208   |
+| AnonAadhaarPolicyFactory                 | deploy                     | -       | -       | 129387  | 0.00512   |
+| ConstantInitialVoiceCreditProxyFactory   | deploy                     | -       | -       | 118665  | 0.0048    |
+| EASCheckerFactory                        | deploy                     | -       | -       | 155556  | 0.00624   |
+| EASPolicyFactory                         | deploy                     | -       | -       | 129387  | 0.00512   |
+| ERC20CheckerFactory                      | deploy                     | -       | -       | 125959  | 0.00496   |
+| ERC20PolicyFactory                       | deploy                     | -       | -       | 129365  | 0.00512   |
+| ERC20VotesCheckerFactory                 | deploy                     | -       | -       | 154673  | 0.00624   |
+| ERC20VotesInitialVoiceCreditProxyFactory | deploy                     | -       | -       | 176590  | 0.00704   |
+| ERC20VotesPolicyFactory                  | deploy                     | -       | -       | 129365  | 0.00512   |
+| FreeForAllCheckerFactory                 | deploy                     | -       | -       | 89376   | 0.00352   |
+| FreeForAllPolicyFactory                  | deploy                     | 129375  | 129387  | 129386  | 0.00512   |
+| GitcoinPassportCheckerFactory            | deploy                     | -       | -       | 125937  | 0.00496   |
+| GitcoinPassportPolicyFactory             | deploy                     | -       | -       | 129365  | 0.00512   |
+| HatsCheckerFactory                       | deploy                     | -       | -       | 169023  | 0.00672   |
+| HatsPolicyFactory                        | deploy                     | -       | -       | 129387  | 0.00512   |
+| MACI                                     | deployPoll                 | 1580765 | 1583829 | 1581630 | 0.06304   |
+| MACI                                     | signUp                     | 197667  | 730492  | 315320  | 0.01264   |
+| MerkleProofCheckerFactory                | deploy                     | -       | -       | 119047  | 0.0048    |
+| MerkleProofPolicyFactory                 | deploy                     | -       | -       | 129387  | 0.00512   |
+| MessageProcessor                         | processMessages            | 252007  | 252918  | 252317  | 0.01008   |
+| Poll                                     | joinPoll                   | 282314  | 503970  | 334835  | 0.01328   |
+| Poll                                     | mergeState                 | 198686  | 354005  | 255089  | 0.01024   |
+| Poll                                     | padLastBatch               | -       | -       | 81884   | 0.0032    |
+| Poll                                     | publishMessage             | -       | -       | 358725  | 0.01424   |
+| Poll                                     | publishMessageBatch        | -       | -       | 671502  | 0.02672   |
+| Poll                                     | relayMessagesBatch         | -       | -       | 155235  | 0.00624   |
+| PollFactory                              | deploy                     | -       | -       | 1099088 | 0.04384   |
+| SemaphoreCheckerFactory                  | deploy                     | -       | -       | 106047  | 0.00416   |
+| SemaphorePolicyFactory                   | deploy                     | -       | -       | 129387  | 0.00512   |
+| Tally                                    | addTallyResults            | 7311562 | 7844012 | 7577787 | 0.30224   |
+| Tally                                    | tallyVotes                 | 147262  | 204522  | 161585  | 0.0064    |
+| TokenCheckerFactory                      | deploy                     | -       | -       | 97197   | 0.00384   |
+| TokenPolicyFactory                       | deploy                     | -       | -       | 129387  | 0.00512   |
+| VerifyingKeysRegistry                    | setPollJoinedVerifyingKey  | -       | -       | 453033  | 0.01808   |
+| VerifyingKeysRegistry                    | setPollJoiningVerifyingKey | -       | -       | 453011  | 0.01808   |
+| VerifyingKeysRegistry                    | setVerifyingKeys           | 885514  | 885526  | 885517  | 0.03536   |
+| VerifyingKeysRegistry                    | setVerifyingKeysBatch      | -       | -       | 1787720 | 0.07136   |
+| ZupassCheckerFactory                     | deploy                     | -       | -       | 206318  | 0.00816   |
+| ZupassPolicyFactory                      | deploy                     | -       | -       | 129365  | 0.00512   |
+
+</details>
+
+<details>
+<summary>Deployment cost</summary>
+
+| Deployments                              | Min Gas | Max Gas | Avg Gas | % of Block Limit | USD (avg) |
+| ---------------------------------------- | ------- | ------- | ------- | ---------------- | --------- |
+| AnonAadhaarCheckerFactory                | -       | -       | 567621  | 1.9 %            | 0.02272   |
+| AnonAadhaarPolicyFactory                 | -       | -       | 759390  | 2.5 %            | 0.03024   |
+| ConstantInitialVoiceCreditProxyFactory   | -       | -       | 379812  | 1.3 %            | 0.0152    |
+| EASCheckerFactory                        | -       | -       | 623304  | 2.1 %            | 0.0248    |
+| EASPolicyFactory                         | -       | -       | 690560  | 2.3 %            | 0.02752   |
+| ERC20CheckerFactory                      | -       | -       | 446429  | 1.5 %            | 0.01776   |
+| ERC20PolicyFactory                       | -       | -       | 684892  | 2.3 %            | 0.02736   |
+| ERC20VotesCheckerFactory                 | -       | -       | 464123  | 1.5 %            | 0.01856   |
+| ERC20VotesInitialVoiceCreditProxyFactory | -       | -       | 482127  | 1.6 %            | 0.0192    |
+| ERC20VotesPolicyFactory                  | -       | -       | 685960  | 2.3 %            | 0.02736   |
+| FreeForAllCheckerFactory                 | -       | -       | 329927  | 1.1 %            | 0.01312   |
+| FreeForAllPolicyFactory                  | -       | -       | 653501  | 2.2 %            | 0.02608   |
+| GitcoinPassportCheckerFactory            | -       | -       | 463912  | 1.5 %            | 0.01856   |
+| GitcoinPassportPolicyFactory             | -       | -       | 687052  | 2.3 %            | 0.02736   |
+| Hasher                                   | -       | -       | 426472  | 1.4 %            | 0.01696   |
+| HatsCheckerFactory                       | -       | -       | 572538  | 1.9 %            | 0.02288   |
+| HatsPolicyFactory                        | -       | -       | 684664  | 2.3 %            | 0.02736   |
+| MACI                                     | 1803354 | 1803438 | 1803408 | 6.0 %            | 0.072     |
+| MerkleProofCheckerFactory                | -       | -       | 491985  | 1.6 %            | 0.01968   |
+| MerkleProofPolicyFactory                 | -       | -       | 686188  | 2.3 %            | 0.02736   |
+| MessageProcessorFactory                  | 1818377 | 1818401 | 1818398 | 6.1 %            | 0.07248   |
+| PollFactory                              | 3720635 | 3720683 | 3720678 | 12.4 %           | 0.14848   |
+| PoseidonT3                               | -       | -       | 2157126 | 7.2 %            | 0.08608   |
+| PoseidonT4                               | -       | -       | 2745274 | 9.2 %            | 0.1096    |
+| PoseidonT5                               | -       | -       | 3569887 | 11.9 %           | 0.1424    |
+| PoseidonT6                               | -       | -       | 4261625 | 14.2 %           | 0.17008   |
+| SemaphoreCheckerFactory                  | -       | -       | 557606  | 1.9 %            | 0.02224   |
+| SemaphorePolicyFactory                   | -       | -       | 749517  | 2.5 %            | 0.02992   |
+| TallyFactory                             | 2176647 | 2176671 | 2176668 | 7.3 %            | 0.08688   |
+| TokenCheckerFactory                      | -       | -       | 435769  | 1.5 %            | 0.01744   |
+| TokenPolicyFactory                       | -       | -       | 690920  | 2.3 %            | 0.02752   |
+| Utilities                                | -       | -       | 664356  | 2.2 %            | 0.02656   |
+| Verifier                                 | -       | -       | 775226  | 2.6 %            | 0.03088   |
+| VerifyingKeysRegistry                    | -       | -       | 1755862 | 5.9 %            | 0.07008   |
+| ZupassCheckerFactory                     | -       | -       | 640425  | 2.1 %            | 0.0256    |
+| ZupassGroth16Verifier                    | -       | -       | 1108706 | 3.7 %            | 0.04416   |
+| ZupassPolicyFactory                      | -       | -       | 785744  | 2.6 %            | 0.03136   |
+
+</details>

package/versioned_docs/version-v3.x/supported-networks/deployed-contracts.md

@@ -7,14 +7,14 @@ sidebar_position: 2
 
 There are a number of MACI's smart contracts which can be re-used by different deployments. These are the following:
 
-- [VerifyingKeysRegistry](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/VerifyingKeysRegistry.sol)
-- [PoseidonHashers](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/crypto/Hasher.sol)
-- [PollFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/PollFactory.sol)
-- [MessageProcessorFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/MessageProcessorFactory.sol)
-- [TallyFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/TallyFactory.sol)
-- [Verifier](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/crypto/Verifier.sol)
+- [VerifyingKeysRegistry](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/VerifyingKeysRegistry.sol)
+- [PoseidonHashers](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/crypto/Hasher.sol)
+- [PollFactory](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/PollFactory.sol)
+- [MessageProcessorFactory](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/MessageProcessorFactory.sol)
+- [TallyFactory](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/TallyFactory.sol)
+- [Verifier](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/crypto/Verifier.sol)
 - [FreeForAllPolicy](https://github.com/privacy-scaling-explorations/excubiae/tree/main/packages/contracts/contracts/extensions/freeForAll)
-- [ConstantInitialVoiceCreditProxy](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/contracts/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.sol) - if you are happy to work with a fixed amount of credits
+- [ConstantInitialVoiceCreditProxy](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.sol) - if you are happy to work with a fixed amount of credits
 
 VkRegistries can be re-used by different protocols to share the same set of verifying keys. Please be advised that you should be verifying that those verifying keys are the ones that have undergone a trusted setup ceremony.
 

package/versioned_docs/version-v3.x/technical-references/coordinator-service/index.md

@@ -7,4 +7,18 @@ sidebar_position: 1
 
 # Coordinator Service
 
-Welcome to the Coordinator Service technical reference. Here you will find the technical details of the Coordinator Service, including the API endpoints and code examples.
+Welcome to the Coordinator Service technical reference. This guide describes how the Coordinator Service works, its workflow, and how to interact with it. For more technical code documentation regarding API endpoints and data transfer objects, please refer to the [API documentation](https://coordinator.maci.vote/api).
+
+## Responsibilities
+
+A MACI coordinator is responsible for running voting processes. In quadratic funding rounds or authority election rounds, the coordinator is the entity that defines who can vote, which projects or candidates are eligible for funding, and the duration of the voting round.
+
+First of all, the coordinator needs to deploy the MACI smart contracts with the desired configuration: gatekeeper policy, which defines who can sign up as a voter; the state Merkle tree depth which defines the maximum number of voters; and the voting mode which defines how votes will be counted (more info in [Poll types](https://maci.pse.dev/docs/core-concepts/poll-types#quadratic-voting)).
+
+After deploying the MACI contracts, the coordinator can deploy a poll (which represents a voting process). To deploy the poll, the coordinator needs to specify: the gatekeeper policy, which defines who can join the poll as a voter; the start and end dates of the poll; the number of options to vote for; the maximum number of votes per voter; and the voting mode.
+
+The coordinator will then wait until the poll ends, after which they will need to finalize the poll. This involves processing all published messages, extracting the votes, tallying them, and submitting the results on-chain.
+
+## Conclusion
+
+In the following documents, we will go through the details of setting up the Coordinator Service and how to interact with it to perform the tasks described above.

package/versioned_docs/version-v3.x/technical-references/coordinator-service/installation.md

@@ -5,39 +5,11 @@ sidebar_label: Installation
 sidebar_position: 2
 ---
 
-1. Add `.env` file (see `.env.example`).
-2. Generate RSA key pair with `pnpm run generate-keypair`.
-3. Download zkey files using `pnpm run download-zkeys:{type}` (only test type is available for now).
-4. Make sure you copied RSA public key to your application. This will be needed for encrypting `Authorization` header and coordinator private key for proof generation. Also it can be accessed through API method `GET v1/proof/publicKey`.
-5. Run `pnpm run start` to run the service.
-6. All API calls must be called with `Authorization` header, where the value is encrypted with RSA public key you generated before. Header value contains message signature and message digest created by `COORDINATOR_ADDRESSES`. The format is `publicEncrypt({signature}:{digest})`.
-   Make sure you set `COORDINATOR_ADDRESSES` env variable and sign any message with the addresses from your application (see [AccountSignatureGuard](./ts/auth/AccountSignatureGuard.service.ts)).
-7. Proofs can be generated with `POST v1/proof/generate` API method or with Websockets (see [dto spec](./ts/proof/dto.ts), [controller](./ts/app.controller.ts) and [wsgateway](./ts/events/events.gateway.ts)).
-
-## Subgraph deployment
-
-It is possible to deploy subgraph using coordinator service.
-
-First, you need to setup subgraph and create a project. [Subgraph dashboard](https://thegraph.com/studio/).
-
-Then, set env variables:
+There are two ways to run the coordinator service: building it from source or using Docker. Both methods require you to clone the MACI repository and move to the project root directory.
 
+```bash
+git clone https://github.com/privacy-scaling-explorations/maci
+cd maci
 ```
-# Subgraph name
-SUBGRAPH_NAME="maci-subgraph"
-
-# Subgraph provider url
-SUBGRAPH_PROVIDER_URL=https://api.studio.thegraph.com/deploy/
-
-# Subgraph deploy key
-SUBGRAPH_DEPLOY_KEY=*******
 
-# Subgraph project folder
-SUBGRAPH_FOLDER=../subgraph
-```
-
-After deployment, subgraph url will be available in studio dashboard and you can use this type of url to get latest deployed version in your application:
-
-```
-https://api.studio.thegraph.com/.../{SUBGRAPH_NAME}/version/latest
-```
+You need to check the latest [README.md](https://github.com/privacy-ethereum/maci/tree/main/apps/coordinator) instructions in the coordinator service app for detailed information about requirements and steps to install, build, and run the service.

package/versioned_docs/version-v3.x/technical-references/coordinator-service/usage.md

@@ -0,0 +1,64 @@
+---
+title: Usage
+description: Learn how to interact with a running MACI coordinator service instance.
+sidebar_label: Usage
+sidebar_position: 3
+---
+
+After setting up and running the MACI coordinator service, you can interact with it through its RESTful API. The service provides various endpoints for deployment and finalization of polls. Please refer to the API documentation at [https://coordinator.maci.vote/api](https://coordinator.maci.vote/api) for the exact request format and required parameters for all endpoint calls described below.
+
+# Authentication
+
+The coordinator service uses a custom signature authentication mechanism to guard the deploy endpoints. To interact with these endpoints, you need to:
+
+1. Make sure you have run the command to set up and generate the RSA keypair, as described in the instructions section.
+
+2. Ensure that your Ethereum public key is set in the `.env` file under the `COORDINATOR_ADDRESSES` variable.
+
+3. Get the RSA public key from the coordinator service with [https://coordinator.maci.vote/v1/proof/publicKey](https://coordinator.maci.vote/v1/proof/publicKey).
+
+4. Sign a message such as "authenticate-me" using the coordinator's Ethereum private key.
+
+5. Encrypt both the message (also called digest) and its signature using the RSA public key. For example, you can use RSA public-key encryption in the format:
+
+```javascript
+const payload: string = "signature:digest";
+```
+
+Then encrypt this payload using the coordinator’s RSA public key.
+
+# Deploy MACI
+
+To deploy the set of MACI smart contracts, you need to call the endpoint [https://coordinator.maci.vote/v1/deploy/maci](https://coordinator.maci.vote/v1/deploy/maci) with a POST request. The request body should include the necessary parameters for the deployment, such as the gatekeeper policy, state tree depth, and voting mode.
+
+# Deploy Poll
+
+To deploy a new poll to an existing MACI instance, you need to call the endpoint [https://coordinator.maci.vote/v1/deploy/poll](https://coordinator.maci.vote/v1/deploy/poll) with a POST request. The request body should include the necessary parameters for the poll deployment, such as the gatekeeper policy, start and end dates, number of options, and voting mode.
+
+# Deploy Subgraph
+
+To deploy a subgraph for a MACI instance and its corresponding polls, you need to call the endpoint [https://coordinator.maci.vote/v1/subgraph/deploy](https://coordinator.maci.vote/v1/subgraph/deploy) with a POST request. The request body should include the necessary parameters for the subgraph deployment, such as the MACI contract address and the subgraph name.
+
+# Finalize Poll
+
+To finalize a poll, you need to follow a series of steps that involve processing messages, merging state trees, generating proofs, and submitting the final tally on-chain. The Coordinator Service provides endpoints for each of these steps.
+
+## Merge
+
+To merge the published messages and create the required state tree, you need to call the endpoint [https://coordinator.maci.vote/v1/proof/merge](https://coordinator.maci.vote/v1/proof/merge) with a POST request. The request body should include the necessary parameters for the merge operation, such as the MACI contract address and the poll ID.
+
+## Generate
+
+Once the Merkle trees are ready, you can generate the zk-SNARK proof for the final tally by calling the endpoint [https://coordinator.maci.vote/v1/proof/generate](https://coordinator.maci.vote/v1/proof/generate) with a POST request. The request body should include the necessary parameters for the proof generation, such as the MACI contract address and the poll ID.
+
+## Submit
+
+After generating the proof, you can submit the final tally on-chain by calling the endpoint [https://coordinator.maci.vote/v1/proof/submit](https://coordinator.maci.vote/v1/proof/submit) with a POST request. The request body should include the necessary parameters for the submission, such as the MACI contract address, poll ID, and the generated proof.
+
+# Schedule Poll
+
+After deploying a poll, you can schedule it to be finalized automatically after it ends. Make sure to set the MACI coordinator private key in the `.env` file. To do so, you need to call the endpoint [https://coordinator.maci.vote/v1/schedule/poll](https://coordinator.maci.vote/v1/schedule/poll) with a POST request. The request body should include the necessary parameters for scheduling the poll, such as the MACI contract address and the poll ID.
+
+# Health
+
+To check that the env variables are set correctly and the service is running, you can call the health endpoint [https://coordinator.maci.vote/v1/health](https://coordinator.maci.vote/v1/health) with a GET request. This endpoint will return a status message indicating the rapidsnark access, redis database connection, zkeys access, and the MACI coordinator address with its funds in each MACI-compatible network.