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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,137 @@
+---
+title: Integrating MACI
+description: How to integrate MACI into your application
+sidebar_label: Integrating
+sidebar_position: 5
+---
+
+MACI can be used in any protocol that requires collusion resistance, for instance it has been proven to be quite efficient when integrated in quadratic funding applications such as [clr.fund](https://github.com/clrfund/monorepo), [qfi](https://github.com/quadratic-gardens/qfi/tree/main), [MACI Platform](https://github.com/privacy-scaling-explorations/maci-platform), and the [Gitcoin Allo Stack](https://github.com/gitcoinco/MACI_QF).
+
+Here we will be looking at how the smart contracts can be integrated.
+
+## MACI Contract
+
+The MACI contract is the core of the protocol. Contracts can inherit from MACI and thus expose the `signUp` and `deployPoll` functions. As with standalone MACI, one would need to deploy a [sign up policy](/docs/technical-references/smart-contracts/Policies).
+
+As an example, a [contract](https://github.com/ctrlc03/minimalQF/blob/main/contracts/MinimalQf.sol#L113) could inherit from MACI and allows sign up via a custom signup function.
+
+```javascript
+/// @inheritdoc IMACI
+function signUp(PubKey memory _pubKey, 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)) {
+    revert InvalidPubKey();
+  }
+
+  // Register the user via the sign-up policy. This function should
+  // throw if the user has already registered or if ineligible to do so.
+  signUpPolicy.enforce(msg.sender, _signUpPolicyData);
+
+  // Hash the public key and insert it into the tree.
+  uint256 pubKeyHash = hashLeftRight(_pubKey.x, _pubKey.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);
+}
+```
+
+## InitialVoiceCreditProxy
+
+If you'd like to extend the functionality of how votes are distributed among users, you need to extend [InitialVoiceCreditProxy](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/initialVoiceCreditProxy/InitialVoiceCreditProxy.sol) contract. You can see our [basic example](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.sol) how it's implemented for constant distribution.
+
+```ts
+contract ConstantInitialVoiceCreditProxy is InitialVoiceCreditProxy {
+  /// @notice the balance to be returned by getVoiceCredits
+  uint256 internal balance;
+
+  /// @notice creates a new ConstantInitialVoiceCreditProxy
+  /// @param _balance the balance to be returned by getVoiceCredits
+  constructor(uint256 _balance) payable {
+    balance = _balance;
+  }
+
+  /// @notice Returns the constant balance for any new MACI's voter
+  /// @return balance
+  function getVoiceCredits(address, bytes memory) public view override returns (uint256) {
+    return balance;
+  }
+}
+```
+
+## Poll Contract
+
+On the other hand, the Poll contract can be inherited to expand functionality such as publishing of messages/commands, or the logic that allows users to register for the poll (AKA poll joining).
+
+```javascript
+function joinPoll(
+  uint256 _nullifier,
+  PubKey calldata _pubKey,
+  uint256 _stateRootIndex,
+  uint256[8] calldata _proof,
+  bytes memory _signUpPolicyData,
+  bytes memory _initialVoiceCreditProxyData
+) external virtual isWithinVotingDeadline {
+  // Whether the user has already joined
+  if (pollNullifiers[_nullifier]) {
+    revert UserAlreadyJoined();
+  }
+
+  // Set nullifier for user's private key
+  pollNullifiers[_nullifier] = true;
+
+  // Verify user's proof
+  if (!verifyJoiningPollProof(_nullifier, _stateRootIndex, _pubKey, _proof)) {
+    revert InvalidPollProof();
+  }
+
+  // Check if the user is eligible to join the poll
+  extContracts.policy.enforce(msg.sender, _signUpPolicyData);
+
+  // Get the user's voice credit balance.
+  uint256 voiceCreditBalance = extContracts.initialVoiceCreditProxy.getVoiceCredits(
+    msg.sender,
+    _initialVoiceCreditProxyData
+  );
+
+  // Store user in the pollStateTree
+  uint256 stateLeaf = hashStateLeaf(StateLeaf(_pubKey, voiceCreditBalance, block.timestamp));
+
+  uint256 stateRoot = InternalLazyIMT._insert(pollStateTree, stateLeaf);
+
+  // Store the current state tree root in the array
+  pollStateRootsOnJoin.push(stateRoot);
+
+  uint256 pollStateIndex = pollStateTree.numberOfLeaves - 1;
+  emit PollJoined(_pubKey.x, _pubKey.y, voiceCreditBalance, block.timestamp, _nullifier, pollStateIndex);
+}
+```
+
+## Tally Contract
+
+Given the verification functions being exposed by the Tally contract, quadratic funding protocols might require to extend the Tally contract to add distribution logic. Looking at this [example](https://github.com/ctrlc03/minimalQF/blob/main/contracts/MinimalQFTally.sol#L114) the `claimFunds` function is added to a contract inheriting from `Tally`, and uses functions such as `verifyPerVOSpentVoiceCredits` to distribute funds to projects part of a quadratic funding round.
+
+## SDK
+
+Another important component of MACI is the [SDK](https://github.com/privacy-scaling-explorations/maci/tree/dev/packages/sdk). This is a TypeScript library that allows you to interact with MACI.
+
+You can find the following subdirectories, where functions are organised as follows:
+
+- `deploy` - For deployment related code
+- `keys` - For utilities related to MACI keys
+- `maci` - For functions that allow to interact with the MACI contract, such as user signup
+- `poll` - For functions that allow to interact with the Poll contract, such as poll joining
+- `proof` - For functions related to proof generation, and submission on chain
+- `relayer` - For functions that allow to interact with the relayer service
+- `tally` - For functions that allow to interact with the Tally contract
+- `trees` - Utility functions to interact with MACI's merkle trees structures
+- `user` - Function related to user activities such as sign up and poll joining
+- `utils` - Various utility functions that are used across the SDK and more
+- `vote` - Functions that allow to create MACI encrypted votes and submit them on chain
+
+You should find all you need to integrate MACI into your application inside this package. If anything is missing, feel free to open an issue on our repo.

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

@@ -0,0 +1,79 @@
+---
+title: Subgraph Deployment
+description: How to deploy a MACI Subgraph
+sidebar_label: Subgraph Deployment
+sidebar_position: 1
+---
+
+# Subgraph Deployment
+
+In some instances like a frontend you might need to deploy a subgraph, in the MACI repository you can find the configuration to deploy a subgraph on The Graph Network or Alchemy Subgraphs.
+
+:::important
+While the free plan of The Graph and Alchemy can work well, it's recommended to use a paid plan for production.
+:::
+
+## Configuration
+
+Head to the subgraph folder in the app folder.
+
+```bash
+cd apps/subgraph
+```
+
+Edit the `network.json` file in the `config` folder. Adding the network it was deployed, the MACI contract and the block where it was deployed.
+
+```json
+{
+  "network": "optimism-sepolia",
+  "maciContractAddress": "0xD18Ca45b6cC1f409380731C40551BD66932046c3",
+  "maciContractStartBlock": 11052407
+}
+```
+
+:::note
+See the supported networks of The Graph **[here](https://thegraph.com/docs/en/developing/supported-networks/)**.
+:::
+
+Create a subgraph in [the graph studio](https://thegraph.com/studio/) and name it `maci-subgraph`.
+
+## The Graph Deployment
+
+The first thing you need to do is to copy the `key` in subgraph studio dashboard and run the following command to authenticate:
+
+```bash
+graph auth --studio {key}
+```
+
+Then run the following commands to build and deploy the subgraph:
+
+```bash
+pnpm run build && \
+pnpm run deploy
+```
+
+:::important
+The `pnpm run deploy` command uses `maci-subgraph` as the subgraph name by default, but if you named your subgraph differently (e.g. maci-graph, my-graph, etc.), please change the command to `graph deploy --node https://api.studio.thegraph.com/deploy/ your_subgraph_name`
+:::
+
+## Alchemy Deployment
+
+Deploying to the Alchemy subgraph service requires some changes to the `subgraph.template.yaml` file located in the `templates` folder. You need to remove the following keys:
+
+```yaml
+indexerHints:
+  prune: auto
+```
+
+Now you can run the deploy command with some minor changes:
+
+```bash
+graph deploy SUBGRAPH_NAME \
+  --version-label VERSION \
+  --node https://subgraphs.alchemy.com/api/subgraphs/deploy \
+  --deploy-key API_KEY
+```
+
+:::note
+In order to get a subgraph deploy key for alchemy, head to the subgraph dashboard section and select `add subgraph` and pick `Deploy a New Subgraph` here you will see the deploy key.
+:::

package/versioned_docs/version-v3.x/guides/testing/_category_.json

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