@maci-protocol/website 0.0.0-ci.e998765 → 0.0.0-ci.eb56e07

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
 
@@ -159,3 +159,48 @@ Error: The verifier contract found the proof invalid.
 ### The on-chain verification of total spent voice credits failed
 
 If you ran the `verify` command and got this error, please ensure consistency in your use of quadratic voting throughout interactions with MACI, including poll deployment, proof generation, and verification.
+
+### Proof generation process is killed
+
+If your terminal output ends like this:
+
+```
+[i] Starting to fetch logs from block 8386826
+[i] Generating proofs of message processing...
+[i] Progress: 1 / 1
+[i] Wait until proof generation is finished
+Killed
+ELIFECYCLE  Command failed with exit code 137.
+```
+
+This typically indicates the proof generation process was terminated due to exceeding the system's available memory limit (exit code `137` = SIGKILL by the OS, often due to OOM).
+
+Increase Node.js' memory allocation by setting the `NODE_OPTIONS` environment variable before running the command:
+
+```bash
+export NODE_OPTIONS="--max-old-space-size=4096"
+# You can increase the value further (e.g., 8192 for 8GB) if your system has enough RAM:
+export NODE_OPTIONS="--max-old-space-size=8192"
+```
+
+### Error: Not enough or too many values for input signals
+
+If you see errors like:
+
+```
+Error: Not enough values for input signal currentVoteWeightsPathElements
+at /home/maci/node_modules/.pnpm/circom_runtime@0.1.28/node_modules/circom_runtime/build/main.cjs:513:27
+...
+```
+
+```
+Error: Too many values for input signal ballots
+at /home/maci/node_modules/.pnpm/circom_runtime@0.1.28/node_modules/circom_runtime/build/main.cjs:513:27
+...
+```
+
+This usually happens when the Merkle tree depth configured in your MACI deployment does not match the depth expected by the zkey files used during proof generation.
+To solve this:
+
+- Download the correct zkey files from a trusted source.
+- Verify that the `stateTreeDepth`, `messageTreeDepth`, and `voteOptionTreeDepth` used in your CLI or config match the values used to generate those zkey files.

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/quick-start.md

@@ -73,7 +73,7 @@ Currently, the ceremony artifacts work with MACI version up to 2.x
 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 command in the root of the project:
 
 ```bash
-pnpm run generateMaciKeyPair
+pnpm run generate-maci-keypair
 ```
 
 ### Set the .env
@@ -219,7 +219,7 @@ pnpm run prove:[network] --poll [poll-id] \
 ```
 
 :::info
-The `--coordinator-private-key` is the one you generated earlier with `pnpm run generateMaciKeyPair`.
+The `--coordinator-private-key` is the one you generated earlier with `pnpm run generate-maci-keypair`.
 
 `--start-block` is the block number from which to start looking for events from. You can use the block that you deployed the contracts in.
 

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/).