@maci-protocol/website 0.0.0-ci.2653bc0

package/versioned_docs/version-v3.x/core-concepts/maci-keys.md

@@ -0,0 +1,84 @@
+---
+title: MACI Keys
+description: A short introduction of MACI's keys
+sidebar_label: Maci Keys
+sidebar_position: 2
+---
+
+## Elliptic Curves
+
+MACI uses the Baby Jubjub Elliptic [Curve](https://iden3-docs.readthedocs.io/en/latest/_downloads/33717d75ab84e11313cc0d8a090b636f/Baby-Jubjub.pdf). The `p` scalar field of choosing is:
+
+$p=21888242871839275222246405745257275088548364400416034343698204186575808495617$
+
+with generator:
+
+$995203441582195749578291179787384436505546430278305826713579947235728471134$
+$5472060717959818805561601436314318772137091100104008585924551046643952123905$
+
+and within the finite field with modulo $p$.
+
+## Key Pairs
+
+MACI uses Node.js's `crypto.randomBytes(32)` function to generate a cryptographically strong pseudorandom 32-byte value. This value is the seed used to generate a maci public key. A public key is a point on the Baby Jubjub [curve](https://iden3-docs.readthedocs.io/en/latest/_downloads/33717d75ab84e11313cc0d8a090b636f/Baby-Jubjub.pdf), which is deterministically derived from a private key `s`.
+
+A public key is generated with the following function from [zk-kit](https://github.com/privacy-scaling-explorations/zk-kit/blob/main/packages/eddsa-poseidon/src/eddsa-poseidon.ts#L75):
+
+```ts
+export function derivePublicKey(privateKey: Buffer | Uint8Array | string): Point<bigint> {
+  const s = deriveSecretScalar(privateKey);
+
+  return mulPointEscalar(Base8, s);
+}
+```
+
+In more details, the function does the following:
+
+1. Derive a scalar value from the seed (private key).
+
+```ts
+export function deriveSecretScalar(privateKey: Buffer | Uint8Array | string): bigint {
+  // Convert the private key to buffer.
+  privateKey = checkPrivateKey(privateKey);
+
+  let hash = blake(privateKey);
+
+  hash = hash.slice(0, 32);
+  hash = pruneBuffer(hash);
+
+  return scalar.shiftRight(leBufferToBigInt(hash), BigInt(3)) % subOrder;
+}
+```
+
+2. Perform a scalar multiplication of the base point `Base8` with the scalar value `s`.
+
+Now we have a public key, which is a point on the Baby Jubjub curve. In TypeScript, this is an array of two bigint values, representing the x and y coordinates of the point.
+
+## Serialization
+
+In order to easily store and transmit maci keys, these are serialized to a string.
+
+A public key if first packed, then converted to a hex string. This string is then prefixed with `macipk.`.
+
+For private keys (well the seed really), the value is converted to a hex string, padded to be of 64 characters, and prefixed with `macisk.`.
+
+For instance, given a seed of `27514007781052885036162808648019893362811628316940391612960868886926452498447`, we have a public key of:
+
+```json
+{
+  "x": 7849177681360672621257726786949079749092629607596162839195961972852243798387,
+  "y": 6476520406570543146511284735472598280851241629796745672331248892171436291770
+}
+```
+
+Serialized, these will look like **macipk.0e5194a54562ea4d440ac6a0049a41d4b600e3eb0bf54486e7a5f7e27521f6ba** and **macisk.3cd46064ea59936f82efb384059dd4f5b6b8e5c7546614caf7c1c3be0daea00f**.
+
+## Generate MACI Keys
+
+After successfully [installing](/docs/quick-start#installation) MACI, you can easily generate your MACI key pair by running:
+
+```bash
+pnpm run genMaciKeyPair
+```
+
+This command will create the necessary public and private keys required for running various MACI operations.

package/versioned_docs/version-v3.x/core-concepts/maci-messages.md

@@ -0,0 +1,44 @@
+---
+title: Commands and Messages
+description: A short introduction of MACI's commands and messages
+sidebar_label: Commands and Messages
+sidebar_position: 3
+---
+
+## Command
+
+A command represents an action that a user may take, such as casting a vote in a poll or changing their public key if bribed. It is made up of the following parameters:
+
+| Symbol       | Name                    | Size | Description                                                                                         |
+| ------------ | ----------------------- | ---- | --------------------------------------------------------------------------------------------------- |
+| $cm_i$       | State index             | 50   | State leaf index where the signing key is located                                                   |
+| $cm_{p_{x}}$ | Public key x-coordinate | 253  | If no change is necessary this parameter should reflect the current public key's x-coordinate       |
+| $cm_{p_{y}}$ | Public key y-coordinate | 253  | If no change is necessary this parameter should reflect the current public key's y-coordinate       |
+| $cm_{i_{v}}$ | Vote option index       | 50   | Option state leaf index of preference to assign the vote for                                        |
+| $cm_w$       | Voting weight           | 50   | Voice credit balance allocation, this is an arbitrary value dependent on a user's available credits |
+| $cm_n$       | Nonce                   | 50   | State leaf's index of actions committed plus one                                                    |
+| $cm_{id}$    | Poll id                 | 50   | The poll's identifier to cast in regard to                                                          |
+| $cm_s$       | Salt                    | 253  | An entropy value to inhibit brute force attacks                                                     |
+
+## Message
+
+A message is an encrypted command using the shared key $k_s$ between the voter and the coordinator. The plaintext $t$ is computed as such:
+
+$t = [p, cm_{p_{x}}, cm_{p_{y}}, cm_s, R8[0], R8[1], S]$
+
+While the message can be computed with the formula below:
+
+$M$ = ${poseidonEncrypt}(k_s[0], k_s[1], cm_n, 7, t)$
+
+### Decrypting a message
+
+To decrypt a message using $k_s$ we have the following:
+
+$[p, R8[0], R8[1], cm_s]$ = ${poseidonDecrypt}(M, k_s[0], k_s[1], cm_n, 7)$
+
+To unpack $p$ to its original five parameters, it must be separated into 50 bit values from the parent 250 bit value. To extract 50 bits at byte $n$, we:
+
+1. initialise 50 bits
+2. shift left by $n$ bits
+3. bitwise AND with $p$
+4. shift right by $n$ bits

package/versioned_docs/version-v3.x/core-concepts/merkle-trees.md

@@ -0,0 +1,16 @@
+---
+title: Merkle Trees
+description: A short introduction of the main primitives used by MACI
+sidebar_label: Merkle Trees
+sidebar_position: 5
+---
+
+MACI uses different types of merkle trees to store and manage data. LeanIMT to store MACI public keys in the MACI contract and [LazyIMT](https://github.com/privacy-scaling-explorations/zk-kit.solidity/tree/main/packages/lazy-imt) is used to store user's state leaves for each poll.
+
+## LazyIMT
+
+The LazyIMT is a Merkle tree that is updated lazily. It is used to [store the state leaves](/docs/technical-references/smart-contracts/MACI#signup) of the users. The "lazy" tree performs the minimum number of hashes necessary to insert elements in a tree. This means if there is only a left element the parent hash is not calculated until a corresponding right element exists, to avoid having an intermediate hash that will change in the future. This tree is designed for roots that are infrequently accessed onchain.
+
+## LeanIMT
+
+The LeanIMT is an optimized binary version of the IMT into binary-focused model, eliminating the need for zero values and allowing dynamic depth adjustment. For more details, please refer to the [LeanIMT paper](https://github.com/privacy-scaling-explorations/zk-kit/tree/main/papers/leanimt)

package/versioned_docs/version-v3.x/core-concepts/offchain-voting.md

@@ -0,0 +1,14 @@
+---
+title: Offchain Voting
+description: The Offchain Voting is a service that allows users to vote on MACI polls free of charge.
+sidebar_label: Offchain Voting
+sidebar_position: 11
+---
+
+# Coordinator Service
+
+MACI’s offchain voting service is a backend service that allows users to vote on MACI polls free of charge. This originated from [Vitalik's post](https://ethresear.ch/t/maci-with-mostly-off-chain-happy-path/19527).
+
+In order to improve inclusivity of MACI polls, a coordinator can spin up the offchain relayer service to allow voters to submit their choices off-chain, saving on gas costs. Voters can check whether their vote has been submitted successfully by using relayer SDK, and if they believe they have been censored, can directly submit their vote on chain, using MACI in its normal form.
+
+For more details on how to use and integrate the offchain relayer service into your application, please refer to this [guide](/docs/technical-references/offchain-relayer).

package/versioned_docs/version-v3.x/core-concepts/poll-types.md

@@ -0,0 +1,58 @@
+---
+title: Poll Types
+description: Which type of polls you can run on MACI
+sidebar_label: Poll types
+sidebar_position: 9
+---
+
+MACI allows to conduct polls in both a quadratic voting and non quadratic voting fashion. One should be aware that the only distinction between the two happens when messages are processed and votes tallied. On top of that, the Tally smart contract has been split into two different ones, with the non quadratic voting version one being slightly smaller, due to the need of one less function.
+
+This document will explain how to use each of these options. Hardhat tasks are the currently recommended way to deploy contracts and run polls but you can also use the MACI cli.
+
+## Quadratic Voting
+
+MACI has always worked with quadratic voting. Users signing up to MACI are assigned a number of voice credits based on certain conditions (enforced by the [initial voice credit proxy contract](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/initialVoiceCreditProxy/InitialVoiceCreditProxy.sol)), and after each vote, the number of voice credits is reduced by the square of the weight of the vote casted. For instance, if the vote weight is 5, a user must have at least 25 voice credits to cast the vote.
+
+To run a poll with quadratic voting, the coordinator must deploy the Poll with the mode set to quadratic voting.
+
+### Using Hardhat tasks
+
+In the deploy-config.json file set the `useQuadraticVoting` value to **true**.
+
+```json
+"Poll": {
+    "pollDuration": 604800,
+    "coordinatorPubkey": "macipk",
+    "useQuadraticVoting": true
+}
+```
+
+Then run the task to create a poll:
+
+```bash
+pnpm deploy-poll:NETWORK
+```
+
+## Non Quadratic Voting
+
+The non quadratic voting option is a new feature that has been added to MACI with the v1.2 release. It allows to conduct polls without the quadratic voting mechanism. This means that the number of voice credits is not reduced by the square of the weight of the vote casted. This option is useful for polls where the quadratic voting mechanism is not necessary, and it is also slightly cheaper for coordinators to tally votes, as there are less checks required in the Tally smart contract.
+
+To run a poll with non quadratic voting, the coordinator must set the `useQuadraticVoting` parameter to `false` when creating the MACI instance. This will make the MACI instance use the `TallyNonQv` smart contract, which is a smaller version of the `Tally` smart contract, as it does not require the checks for the quadratic voting mechanism.
+
+### Using Hardhat tasks
+
+In the deploy-config.json file set the `useQuadraticVoting` value to **false**.
+
+```json
+"Poll": {
+    "pollDuration": 604800,
+    "coordinatorPubkey": "macipk",
+    "useQuadraticVoting": false
+}
+```
+
+Then run the task to create a poll:
+
+```bash
+pnpm deploy-poll:NETWORK
+```

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

@@ -0,0 +1,81 @@
+---
+title: MACI Polls
+description: Which type of polls you can run on MACI
+sidebar_label: Polls
+sidebar_position: 9
+---
+
+MACI allows to create several concurrent on chain polls, each with their own set of options, duration, and voting mechanism. To start with, each poll needs to be created on chain, and configured with the desired parameters. The user state is not shared between polls, thus spending voting power on one, will not affect the voting power on another.
+
+Currently, you can configure the following parameters for a poll:
+
+- Poll duration, in the form of a unix timestamp for start and end times. This allows polls to be scheduled to start at a certain time, and run for a certain amount of time.
+- Vote option - how many vote options are allowed for a poll.
+- Vote mode - quadratic or non quadratic voting. One should be aware that the only distinction between the two happens when messages are processed and votes tallied.
+- Policy - the Excubiae policy that will be used to gate access to the poll.
+- Initial voice credit proxy - the initial voice credit proxy that will be used to assign voice credits to voters.
+- Relayer - the list of addresses that will be able to relay messages on behalf of other users (for now this is recommended to be the coordinator only)
+- Coordinator pubkey - the public key of the coordinator of this Poll.
+
+The full configuration for a poll looks like this:
+
+```json
+"Poll": {
+    "pollStartDate": 3600,
+    "pollEndDate": 3600,
+    "coordinatorPubkey": "macipk.9a59264310d95cfd8eb7083aebeba221b5c26e77427f12b7c0f50bc1cc35e621",
+    "useQuadraticVoting": false,
+    "policy": "FreeForAllPolicy",
+    "relayers": "0x0000000000000000000000000000000000000000",
+    "initialVoiceCreditProxy": "ConstantInitialVoiceCreditProxy",
+    "voteOptions": 2
+}
+```
+
+## Quadratic Voting
+
+MACI has always worked with quadratic voting. Users joining a Poll are assigned a number of voice credits based on certain conditions (enforced by the [initial voice credit proxy contract](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/initialVoiceCreditProxy/InitialVoiceCreditProxy.sol)), and after each vote, the number of voice credits is reduced by the square of the weight of the vote casted. For instance, if the vote weight is 5, a user must have at least 25 voice credits to cast the vote.
+
+To run a poll with quadratic voting, the coordinator must deploy the Poll with the mode set to quadratic voting.
+
+### Using Hardhat tasks
+
+In the deploy-config.json file set the `useQuadraticVoting` value to **true**.
+
+```json
+"Poll": {
+    [...]
+    "coordinatorPubkey": "macipk",
+    "useQuadraticVoting": true
+}
+```
+
+Then run the task to create a poll:
+
+```bash
+pnpm deploy-poll:NETWORK
+```
+
+## Non Quadratic Voting
+
+The non quadratic voting option is a new feature that has been added to MACI with the v1.2 release. It allows to conduct polls without the quadratic voting mechanism. This means that the number of voice credits is not reduced by the square of the weight of the vote casted. This option is useful for polls where the quadratic voting mechanism is not necessary, and it is also slightly cheaper for coordinators to tally votes, as there are less checks required in the Tally smart contract.
+
+To run a poll with non quadratic voting, the coordinator must set the `useQuadraticVoting` parameter to `false` when creating the MACI instance.
+
+### Using Hardhat tasks
+
+In the deploy-config.json file set the `useQuadraticVoting` value to **false**.
+
+```json
+"Poll": {
+    [...]
+    "coordinatorPubkey": "macipk",
+    "useQuadraticVoting": false
+}
+```
+
+Then run the task to create a poll:
+
+```bash
+pnpm deploy-poll:NETWORK
+```