@maci-protocol/website 0.0.0-ci.a8b537a → 0.0.0-ci.aad6000

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:
 
-- [VkRegistry](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/VkRegistry.sol)
-- [PoseidonHashers](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/crypto/Hasher.sol)
-- [PollFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/PollFactory.sol)
-- [MessageProcessorFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/MessageProcessorFactory.sol)
-- [TallyFactory](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/TallyFactory.sol)
-- [Verifier](https://github.com/privacy-scaling-explorations/maci/blob/dev/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/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.
 
@@ -25,11 +25,11 @@ In order to verify you will need the following:
 - run checkVerifyingKeys with the cli (see below)
 
 ```bash
-cd cli && node build/ts/index.js checkVerifyingKeys -q false -vk 0x74569d524a193daC0D3Df17B9E207C916174745b -s 6 -i 2 -m 9 -v 3 -b 2 -p ./zkeys/ProcessMessages_6-9-2-3/processMessages_6-9-2-3.zkey -t ./zkeys/TallyVotes_6-2-3/tallyVotes_6-2-3.zkey
+cd cli && node build/ts/index.js checkVerifyingKeys -q false -vk 0x74569d524a193daC0D3Df17B9E207C916174745b -s 6 -i 2 -m 9 -v 3 -b 2 -p ./zkeys/MessageProcessorQv_6-9-2-3/MessageProcessorQv_6-9-2-3.zkey -t ./zkeys/VoteTallyQv_6-2-3/tallyVotes_6-2-3.zkey
 ```
 
 :::info
-You should change the -vk parameter to the VkRegistry address for the chain you are deploying to. Also you might need to modify the parameters based on the circuit configuration. Please refer to the [circuits page](/docs/technical-references/zk-snark-circuits/setup) for more information. Also you can add `-uq false` if you want to check non quadratic voting keys.
+You should change the -vk parameter to the VerifyingKeysRegistry address for the chain you are deploying to. Also you might need to modify the parameters based on the circuit configuration. Please refer to the [circuits page](/docs/technical-references/zk-snark-circuits/setup) for more information. Also you can add `-uq false` if you want to check non quadratic voting keys.
 :::
 
 ## Contract Addresses

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

@@ -23,6 +23,14 @@ MACI has been tested on the following EVM networks:
 - Gnosis Chiado
 - Polygon
 - Polygon Amoy
+- Scroll
+- Scroll Sepolia
+- Linea
+- Linea Sepolia
+- Zksync Era
+- Zksync Sepolia
+- Polygon Zkevm
+- Polygon Cardona Zkevm
 
 We recommend using either Optimism, Arbitrum or Base. Please open an issue/PR if you intend to use other EVM networks and would like to contribute to this record of deployed and verified contracts as well as benchmarks, that would be greatly appreciated.
 
@@ -42,6 +50,14 @@ For better UX, MACI clients should be sending votes (messages) in batches. Depen
 | Gnosis Chiado    | 50             | 15921753 | 0.0000188313 ETH ($0.05)                        |
 | Polygon          | 85             | 26915773 | 0.0002193417259598 ETH ($0.54)                  |
 | Polygon Amoy     | 89             | 28192368 | 0.00017069180975304 ETH ($0.43)                 |
+| Scroll           | 62             | 19447318 | 0.000233368 ETH ($0.61)                         |
+| Scroll Sepolia   | 62             | 19447318 | 0.000233368 ETH ($0.61)                         |
+| Linea            | 14             | 4438205  | 0.00005325846 ETH ($0.1382)                     |
+| Linea Sepolia    | 14             | 4438205  | 0.00005325846 ETH ($0.1382)                     |
+| Zksync Era       | 2              | 24000690 | 0.00028801 ETH ($0.75)                          |
+| Zksync Sepolia   | 2              | 24000690 | 0.00028801 ETH ($0.75)                          |
+| Polygon Zkevm    | 6              | 1917872  | 0.00006904 ETH ($0.18)                          |
+| Polygon Cardona  | 6              | 1917872  | 0.00006904 ETH ($0.18)                          |
 
 ## Test yourself
 

package/versioned_docs/version-v3.x/technical-references/coordinator-service/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Coordinator Service",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "The Coordinator Service is a backend service that aims to automate MACI-related operations, such as contracts deployment, proof generation and poll finalisation."
+  }
+}

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

@@ -0,0 +1,10 @@
+---
+title: Introduction
+description: The Coordinator Service is a service that allows to automate MACI coordinator tasks.
+sidebar_label: Introduction
+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.

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

@@ -0,0 +1,43 @@
+---
+title: Installation and setup
+description: Learn how to install and setup the Coordinator Service.
+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:
+
+```
+# 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
+```

package/versioned_docs/version-v3.x/technical-references/offchain-relayer/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Offchain Relayer",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "The Offchain Relayer is a service that allows users to vote on MACI polls free of charge."
+  }
+}

package/versioned_docs/version-v3.x/technical-references/offchain-relayer/index.md

@@ -0,0 +1,51 @@
+---
+title: Introduction
+description: The Offchain Relayer is a service that allows users to vote on MACI polls free of charge.
+sidebar_label: Introduction
+sidebar_position: 1
+---
+
+# Coordinator Service
+
+Welcome to the Offchain Relayer technical reference. Here you will find the technical details of the Offchain Relayer: how to set it up and and how to use it.
+
+## Flow Diagram
+
+Below is a high-level diagram illustrating the flow of the Relayer Service:
+
+![MACI Relayer Flow](/img/relayer-diagram.png)
+
+## High-Level Overview of the Relayer:
+
+### Functionality
+
+The Relayer serves as an intermediary between users and the MACI system. It performs the following tasks:
+
+- Allows users to send messages without having to pay gas fees by processing these messages off-chain.
+- Receives user messages.
+- Prepare messages batches and upload it to IPFS
+- Submits the message hashes to the Poll contract with IPFS hash of the batch.
+
+This process ensures that user actions are recorded on-chain without compromising their privacy.
+
+### Privacy Preservation
+
+By verifying the zero-knowledge proofs, the Relayer ensures that only authorized users can send messages.
+Users must know the pre-image to a state leaf in the poll state tree.
+
+### Decentralization and Trust
+
+It's recommended that the coordinator only runs this service for now. That is because if the service malfunctions and batch hashes are pushed on chain without the messages actually being stored on ipfs, then polls can't be finalized.
+
+### Integration with MACI Components
+
+The Relayer interacts with other components of the MACI system, such as the **Coordinator** and the on-chain smart contracts:
+
+- The **Coordinator** fetches all the messages stored in IPFS and uses them as regular on-chain messages.
+- This ensures that user messages are properly processed and recorded, contributing to the overall functionality and security of the voting protocol.
+
+### Additional Information
+
+For more details, you can read the following post on EthResearch:
+
+[MACI with Mostly Off-Chain Happy Path](https://ethresear.ch/t/maci-with-mostly-off-chain-happy-path/19527)

package/versioned_docs/version-v3.x/technical-references/offchain-relayer/installation.md

@@ -0,0 +1,109 @@
+---
+title: Installation and setup
+description: Learn how to install and setup the Offchain Relayer service.
+sidebar_label: Setup
+sidebar_position: 2
+---
+
+## Prerequisites
+
+Make sure you have the following tools installed on your system:
+
+- **Docker**: [Install Docker](https://www.docker.com/products/docker-desktop)
+- **Docker Compose**: [Install Docker Compose](https://docs.docker.com/compose/install/)
+
+## Getting Started
+
+Follow these steps to run the MACI Relayer service using Docker.
+
+### 1. Clone the Repository
+
+First, clone the repository to your local machine.
+
+```bash
+git clone https://github.com/privacy-scaling-explorations/maci
+cd maci
+```
+
+## 2. Configure Environment Variables
+
+The `.env` file contains sensitive configuration values that will be injected into the Docker containers at runtime. To set them up:
+
+1. Copy the `.env.example` file to `.env`.
+
+```bash
+cp .env.example .env
+```
+
+2. Edit the `.env` file and configure the variables.
+
+## 3. Build and Run the Docker Containers
+
+Now that your environment is set up, it's time to build and run the Docker containers.
+
+Run the following command from the root directory of your project:
+
+```bash
+docker-compose up --build
+```
+
+This command does the following:
+
+- Builds the Docker images based on the Dockerfile and `docker-compose.yml` files.
+- Starts the service container (the MACI relayer application) and the mongodb container.
+
+The MACI Relayer service will be available on port 3000 by default (you can modify this in the `.env` file).
+
+## 4. Access the Service
+
+Once the containers are up and running, you can access the relayer service at:
+
+```
+http://localhost:3000
+```
+
+Additionally, the Swagger UI documentation for the Relayer service API can be accessed at:
+
+```
+http://localhost:3000/api
+```
+
+You can interact with the API through the Swagger interface, which provides a convenient way to test endpoints and view the API methods.
+
+## 5. Check Logs
+
+To view the logs from the containers and troubleshoot any issues, run:
+
+```bash
+docker-compose logs
+```
+
+This will display logs from both the service (relayer) and mongodb containers.
+
+## 6. Stop the Services
+
+To stop the containers and remove the containers (but keep the volumes), use the following command:
+
+```bash
+docker-compose down
+```
+
+This will stop and remove the containers but retain the volumes (like MongoDB data). To also remove the volumes, run:
+
+```bash
+docker-compose down --volumes
+```
+
+## 7. MongoDB Persistence
+
+MongoDB data is persisted using Docker volumes (`mongodb-data`). Even if you remove and recreate the MongoDB container, the data will persist.
+
+This ensures that any data stored in the MongoDB database is not lost even if the container is restarted or removed.
+
+If you'd like to remove the persisted data as well, you can remove the volume by running:
+
+```bash
+docker volume rm your-repo_mongodb-data
+```
+
+This will delete the volume, along with all the data stored in MongoDB.

package/versioned_docs/version-v3.x/technical-references/smart-contracts/MACI.md

@@ -6,7 +6,7 @@ sidebar_position: 1
 ---
 
 :::info
-Code location: [MACI.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/MACI.sol)
+Code location: [MACI.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/MACI.sol)
 :::
 
 `MACI.sol` is the core contract of the project, as it provides the base layer for user signups and Polls to be created.
@@ -62,12 +62,12 @@ This function does the following:
 - hashes the public key and inserts it into the state tree.
 
 ```ts
-function signUp(PubKey memory _pubKey, bytes memory _signUpPolicyData) public virtual {
+function signUp(PublicKey memory _publicKey, bytes memory _signUpPolicyData) public virtual {
   // ensure we do not have more signups than what the circuits support
   if (leanIMTData.size >= maxSignups) revert TooManySignups();
 
   // ensure that the public key is on the baby jubjub curve
-  if (!CurveBabyJubJub.isOnCurve(_pubKey.x, _pubKey.y)) {
+  if (!CurveBabyJubJub.isOnCurve(_publicKey.x, _publicKey.y)) {
     revert InvalidPubKey();
   }
 
@@ -76,13 +76,13 @@ function signUp(PubKey memory _pubKey, bytes memory _signUpPolicyData) public vi
   signUpPolicy.register(msg.sender, _signUpPolicyData);
 
   // Hash the public key and insert it into the tree.
-  uint256 pubKeyHash = hashLeftRight(_pubKey.x, _pubKey.y);
+  uint256 pubKeyHash = hashLeftRight(_publicKey.x, _publicKey.y);
   uint256 stateRoot = InternalLeanIMT._insert(leanIMTData, pubKeyHash);
 
   // Store the current state tree root in the array
   stateRootsOnSignUp.push(stateRoot);
 
-  emit SignUp(leanIMTData.size - 1, block.timestamp, _pubKey.x, _pubKey.y);
+  emit SignUp(leanIMTData.size - 1, block.timestamp, _publicKey.x, _publicKey.y);
 }
 ```
 
@@ -149,12 +149,12 @@ Polls require the following information:
 - `coordinatorPubKey`: the public key of the poll's coordinator
 - `verifier`: the address of the zk-SNARK verifier contract
 - `vkRegistry`: the address of the vk registry contract
-- `mode`: the mode of the poll, to set whether it supports quadratic voting or non quadratic voting
+- `mode`: the mode of the poll, to set whether it supports quadratic voting, non quadratic voting, full credits voting
 - `signUpPolicy`: the address of the sign up policy contract
 - `initialVoiceCreditProxy`: the address of the initial voice credit proxy contract
 - `relayers`: the addresses of the relayers for the poll (if offchain voting is enabled)
 - `voteOptions`: the number of vote options for the poll
 
 :::info
-Please be advised that the number of signups in the MACI contract (number of leaves in the merkle tree holding MACI's state) considers the initial zero leaf as one signup. For this reason, when accounting for the real users signed up to MACI, you should subtract one from the value returned from the `numSignUps` function.
+Please be advised that the number of signups in the MACI contract (number of leaves in the merkle tree holding MACI's state) considers the initial zero leaf as one signup. For this reason, when accounting for the real users signed up to MACI, you should subtract one from the value returned from the `totalSignups` function.
 :::

package/versioned_docs/version-v3.x/technical-references/smart-contracts/MessageProcessor.md

@@ -6,7 +6,7 @@ sidebar_position: 4
 ---
 
 :::info
-Code location: [MessageProcessor.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/MessageProcessor.sol)
+Code location: [MessageProcessor.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/MessageProcessor.sol)
 :::
 
 This contract is used to prepare parameters for the zk-SNARK circuits as well as for verifying proofs. It should be deployed alongside a `Poll`.

package/versioned_docs/version-v3.x/technical-references/smart-contracts/Params.md

@@ -6,7 +6,7 @@ sidebar_position: 9
 ---
 
 :::info
-Code location: [Params.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/utils/Params.sol)
+Code location: [Params.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/utilities/Params.sol)
 :::
 
 A contract holding three structs:
@@ -14,7 +14,7 @@ A contract holding three structs:
 ```ts
 /// @notice A struct holding the depths of the merkle trees
 struct TreeDepths {
-  uint8 intStateTreeDepth;
+  uint8 tallyProcessingStateTreeDepth;
   uint8 voteOptionTreeDepth;
 }
 

package/versioned_docs/version-v3.x/technical-references/smart-contracts/Policies.md

@@ -21,7 +21,7 @@ The MACI repository comes with several out-of-the-box options:
 - `HatsPolicy` - This allows gatekeeping signups to only users who have a specific [Hat](https://www.hatsprotocol.xyz/).
 - `GitcoinPassportPolicy` - This allows gatekeeping signups to only users who have a specific [Gitcoin Passport](https://passport.gitcoin.co/) score.
 - `ZupassPolicy` - This allows gatekeeping signups only to users who have a valid [Zupass PCD ticket](https://github.com/proofcarryingdata/zupass).
-- `SemaphorePolicy` - This allows gatekeeping signups only to users who can prove they are part of a [Semaphore](https://semaphore.pse.dev/) group.
+- `SemaphorePolicy` - This allows gatekeeping signups only to users who can prove they are part of a [Semaphore](https://semaphore.pse.main/) group.
 
 You can find all of the latest policy contracts here:
 https://github.com/privacy-scaling-explorations/excubiae/tree/main/packages/contracts/contracts/extensions

package/versioned_docs/version-v3.x/technical-references/smart-contracts/Poll.md

@@ -6,7 +6,7 @@ sidebar_position: 2
 ---
 
 :::info
-Code location: [Poll.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/Poll.sol)
+Code location: [Poll.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/Poll.sol)
 :::
 
 This contract allows users to submit their votes.
@@ -26,7 +26,7 @@ The `joinPoll` function looks as follows:
   /// @inheritdoc IPoll
   function joinPoll(
     uint256 _nullifier,
-    PubKey calldata _pubKey,
+    PublicKey calldata _publicKey,
     uint256 _stateRootIndex,
     uint256[8] calldata _proof,
     bytes memory _signUpPolicyData,
@@ -41,7 +41,7 @@ The `joinPoll` function looks as follows:
     pollNullifiers[_nullifier] = true;
 
     // Verify user's proof
-    if (!verifyJoiningPollProof(_nullifier, _stateRootIndex, _pubKey, _proof)) {
+    if (!verifyJoiningPollProof(_nullifier, _stateRootIndex, _publicKey, _proof)) {
       revert InvalidPollProof();
     }
 
@@ -55,7 +55,7 @@ The `joinPoll` function looks as follows:
     );
 
     // Store user in the pollStateTree
-    uint256 stateLeaf = hashStateLeaf(StateLeaf(_pubKey, voiceCreditBalance, block.timestamp));
+    uint256 stateLeaf = hashStateLeaf(StateLeaf(_publicKey, voiceCreditBalance, block.timestamp));
 
     uint256 stateRoot = InternalLazyIMT._insert(pollStateTree, stateLeaf);
 
@@ -63,7 +63,7 @@ The `joinPoll` function looks as follows:
     pollStateRootsOnJoin.push(stateRoot);
 
     uint256 pollStateIndex = pollStateTree.numberOfLeaves - 1;
-    emit PollJoined(_pubKey.x, _pubKey.y, voiceCreditBalance, block.timestamp, _nullifier, pollStateIndex);
+    emit PollJoined(_publicKey.x, _publicKey.y, voiceCreditBalance, block.timestamp, _nullifier, pollStateIndex);
   }
 ```
 
@@ -72,7 +72,7 @@ The `joinPoll` function looks as follows:
 The `publishMessage` function looks as follows:
 
 ```ts
-function publishMessage(Message calldata _message, PubKey calldata _encPubKey) public virtual isOpenForVoting {
+function publishMessage(Message calldata _message, PublicKey calldata _encPubKey) public virtual isOpenForVoting {
   // check if the public key is on the curve
   if (!CurveBabyJubJub.isOnCurve(_encPubKey.x, _encPubKey.y)) {
     revert InvalidPubKey();
@@ -84,7 +84,7 @@ function publishMessage(Message calldata _message, PubKey calldata _encPubKey) p
   }
 
   // compute current message hash
-  uint256 messageHash = hashMessageAndEncPubKey(_message, _encPubKey);
+  uint256 messageHash = hashMessageAndPublicKey(_message, _encPubKey);
 
   // update current message chain hash
   updateChainHash(messageHash);
@@ -96,7 +96,7 @@ function publishMessage(Message calldata _message, PubKey calldata _encPubKey) p
 The `publishMessageBatch` function looks as follows:
 
 ```ts
-function publishMessageBatch(Message[] calldata _messages, PubKey[] calldata _encPubKeys) public virtual {
+function publishMessageBatch(Message[] calldata _messages, PublicKey[] calldata _encPubKeys) public virtual {
   if (_messages.length != _encPubKeys.length) {
     revert InvalidBatchLength();
   }

package/versioned_docs/version-v3.x/technical-references/smart-contracts/PollFactory.md

@@ -6,7 +6,7 @@ sidebar_position: 3
 ---
 
 :::info
-Code location: [PollFactory.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/PollFactory.sol)
+Code location: [PollFactory.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/PollFactory.sol)
 :::
 
 `PollFactory` is a smart contract that is used to deploy new Polls. This is used by MACI inside the `deployPoll` function.

package/versioned_docs/version-v3.x/technical-references/smart-contracts/Tally.md

@@ -6,7 +6,7 @@ sidebar_position: 5
 ---
 
 :::info
-Code location: [Tally.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/Tally.sol)
+Code location: [Tally.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/Tally.sol)
 :::
 
 The `Tally` contract is used by the coordinator to submit commitments to the tally results via the `tallyVotes` function. This is done in batches and the final commitment can be used by the users to verify the validity of the results.
@@ -16,14 +16,14 @@ This contract should be deployed alongside a `Poll`, with the the constructor ac
 ```ts
   constructor(
     address _verifier,
-    address _vkRegistry,
+    address _verifyingKeysRegistry,
     address _poll,
     address _mp,
     address _tallyOwner,
     Mode _mode
   ) payable {
     verifier = IVerifier(_verifier);
-    vkRegistry = IVkRegistry(_vkRegistry);
+    vkRegistry = IVkRegistry(_verifyingKeysRegistry);
     poll = IPoll(_poll);
     messageProcessor = IMessageProcessor(_mp);
     mode = _mode;
@@ -34,7 +34,7 @@ This contract should be deployed alongside a `Poll`, with the the constructor ac
 - `vkRegistry` - The address of the vkRegistry contract
 - `poll` - The address of the poll contract
 - `messageProcessor` - The address of the messageProcessor contract
-- `mode` - The mode of the tally contract - depending on this, the commitments will be processed differently, and it must equal the Poll mode (quadratic vs non quadratic voting)
+- `mode` - The mode of the tally contract - depending on this, the commitments will be processed differently, and it must equal the Poll mode (quadratic vs non quadratic vs full credits voting)
 
 Users can use the verification functions to verify the Tally results. These are as follows:
 

package/versioned_docs/version-v3.x/technical-references/smart-contracts/VkRegistry.md

@@ -1,24 +1,24 @@
 ---
-title: VkRegistry Smart Contract
-description: VkRegistry smart contract
-sidebar_label: VkRegistry
+title: VerifyingKeysRegistry Smart Contract
+description: VerifyingKeysRegistry smart contract
+sidebar_label: VerifyingKeysRegistry
 sidebar_position: 8
 ---
 
 :::info
-Code location: [VkRegistry.sol](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/VkRegistry.sol)
+Code location: [VerifyingKeysRegistry.sol](https://github.com/privacy-scaling-explorations/maci/blob/main/packages/contracts/contracts/VerifyingKeysRegistry.sol)
 :::
 
-The VkRegistry is a contract that holds the verifying keys for the zk-SNARK circuits. It holds four different sets of keys:
+The VerifyingKeysRegistry is a contract that holds the verifying keys for the zk-SNARK circuits. It holds four different sets of keys:
 
-- `processVks` - The keys for the processMessages circuit
-- `tallyVks` - The keys for the tallyVotes circuit
+- `processVks` - The keys for the MessageProcessor circuit
+- `tallyVks` - The keys for the VoteTally circuit
 - `pollJoiningVk` - The key for the poll joining circuit
 - `pollJoinedVk` - The key for the poll joined circuit
 
 Each circuit will have a signature which is its compile-time constants represented as a uint256.
 
-Please note that each Verifying Key should be set with the corresponding mode. Available modes are quadratic voting and non quadratic voting.
+Please note that each Verifying Key should be set with the corresponding mode. Available modes are quadratic, non quadratic and full credits voting.
 
 The contract owner can set them using the `setVerifyingKeysBatch` function:
 

package/versioned_docs/version-v3.x/technical-references/smart-contracts/VoiceCreditProxy.md

@@ -6,7 +6,7 @@ sidebar_position: 7
 ---
 
 :::info
-Code location: [InitialVoiceCreditProxy](https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts/initialVoiceCreditProxy)
+Code location: [InitialVoiceCreditProxy](https://github.com/privacy-scaling-explorations/maci/tree/main/contracts/contracts/initialVoiceCreditProxy)
 :::
 
 The VoiceCreditProxy contract is used to assign voice credits to users. Whichever implementation should the MACI deployers use, this must implement a view function that returns the balance for a user, such as the one below:

package/versioned_docs/version-v3.x/technical-references/technical-references.md

@@ -19,7 +19,7 @@ The MACI smart contracts handle the on-chain aspects - both the functionality an
 
 The MACI smart contracts are written in [Solidity](https://soliditylang.org/).
 
-Contracts are released through the [`@maci-contracts`](https://www.npmjs.com/package/maci-contracts) NPM package.
+Contracts are released through the [`@maci-protocol/contracts`](https://www.npmjs.com/package/@maci-protocol/contracts) NPM package.
 
 [Learn more about MACI contracts](/docs/technical-references/smart-contracts/)
 
@@ -29,12 +29,12 @@ The TypeScript libraries manage the business logic between the smart contracts a
 
 The MACI [TypeScript](https://www.typescriptlang.org/) libraries are released through the following NPM packages:
 
-- [`@maci-cli`](https://www.npmjs.com/package/maci-cli)
-- [`@maci-core`](https://www.npmjs.com/package/maci-core)
-- [`@maci-crypto`](https://www.npmjs.com/package/maci-crypto)
-- [`@maci-domainobjs`](https://www.npmjs.com/package/maci-domainobjs)
-- [`@maci-integrationtests`](https://www.npmjs.com/package/maci-integrationtests)
-- [`@maci-sdk`](https://www.npmjs.com/package/maci-sdk)
+- [`@maci-protocol/cli`](https://www.npmjs.com/package/@maci-protocol/cli)
+- [`@maci-protocol/core`](https://www.npmjs.com/package/@maci-protocol/core)
+- [`@maci-protocol/crypto`](https://www.npmjs.com/package/@maci-protocol/crypto)
+- [`@maci-protocol/domainobjs`](https://www.npmjs.com/package/@maci-protocol/domainobjs)
+- [`@maci-protocol/integrationtests`](https://www.npmjs.com/package/@maci-protocol/integrationtests)
+- [`@maci-protocol/sdk`](https://www.npmjs.com/package/@maci-protocol/sdk)
 
 ## Circuits
 
@@ -43,6 +43,6 @@ MACI has multiple circuits that ensure all off-chain computation is completed co
 The circuits for these zero-knowledge proofs are written
 in [Circom](https://iden3.io/circom).
 
-The MACI circuits are released through the [`@maci-circuits`](https://www.npmjs.com/package/maci-circuits) NPM package.
+The MACI circuits are released through the [`@maci-protocol/circuits`](https://www.npmjs.com/package/@maci-protocol/circuits) NPM package.
 
 [Learn more about MACI circuits](/docs/technical-references/zk-snark-circuits/)

package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/joinPoll.md

@@ -5,7 +5,7 @@ sidebar_label: Join Poll Circuit
 sidebar_position: 6
 ---
 
-[**Repo link**](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/circom/voter)
+[**Repo link**](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/voter)
 
 ## PollJoining
 
@@ -21,8 +21,8 @@ Users need to provide a valid proof to the Poll smart contract to join a poll, a
 
 | Input signal           | Description                                                                                                                                                                        |
 | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `privKey`              | The user's private key                                                                                                                                                             |
-| `pollPubKey`           | The poll's public key                                                                                                                                                              |
+| `privateKey`           | The user's private key                                                                                                                                                             |
+| `pollPublicKey`        | The poll's public key                                                                                                                                                              |
 | `siblings`             | The siblings for the merkle tree inclusion proof                                                                                                                                   |
 | `indices`              | The indices for the merkle tree inclusion proof                                                                                                                                    |
 | `nullifier`            | The nullifier                                                                                                                                                                      |
@@ -44,9 +44,8 @@ Users will use this circuit to anonymously prove that they joined a poll. This c
 
 | Input signal           | Description                                                                                                                                                                        |
 | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `privKey`              | The user's private key                                                                                                                                                             |
+| `privateKey`           | The user's private key                                                                                                                                                             |
 | `voiceCreditsBalance`  | The user's initial voice credits balance                                                                                                                                           |
-| `joinTimestamp`        | The timestamp of when the user joined the poll                                                                                                                                     |
 | `pathElements`         | The path elements for the merkle tree inclusion proof                                                                                                                              |
 | `pathIndices`          | The path indices for the merkle tree inclusion proof                                                                                                                               |
 | `stateRoot`            | The MACI state tree root                                                                                                                                                           |