@maci-protocol/website 0.0.0-ci.1e276ed

package/versioned_docs/version-v1.2/solidity-docs/crypto/Pairing.md

@@ -0,0 +1,85 @@
+# Pairing
+
+A library implementing the alt_bn128 elliptic curve operations.
+
+### PRIME_Q
+
+```solidity
+uint256 PRIME_Q
+```
+
+### G1Point
+
+```solidity
+struct G1Point {
+  uint256 x;
+  uint256 y;
+}
+```
+
+### G2Point
+
+```solidity
+struct G2Point {
+  uint256[2] x;
+  uint256[2] y;
+}
+```
+
+### PairingAddFailed
+
+```solidity
+error PairingAddFailed()
+```
+
+custom errors
+
+### PairingMulFailed
+
+```solidity
+error PairingMulFailed()
+```
+
+### PairingOpcodeFailed
+
+```solidity
+error PairingOpcodeFailed()
+```
+
+### negate
+
+```solidity
+function negate(struct Pairing.G1Point p) internal pure returns (struct Pairing.G1Point)
+```
+
+The negation of p, i.e. p.plus(p.negate()) should be zero.
+
+### plus
+
+```solidity
+function plus(struct Pairing.G1Point p1, struct Pairing.G1Point p2) internal view returns (struct Pairing.G1Point r)
+```
+
+r Returns the sum of two points of G1.
+
+### scalarMul
+
+```solidity
+function scalarMul(struct Pairing.G1Point p, uint256 s) internal view returns (struct Pairing.G1Point r)
+```
+
+r Return the product of a point on G1 and a scalar, i.e.
+p == p.scalarMul(1) and p.plus(p) == p.scalarMul(2) for all
+points p.
+
+### pairing
+
+```solidity
+function pairing(struct Pairing.G1Point a1, struct Pairing.G2Point a2, struct Pairing.G1Point b1, struct Pairing.G2Point b2, struct Pairing.G1Point c1, struct Pairing.G2Point c2, struct Pairing.G1Point d1, struct Pairing.G2Point d2) internal view returns (bool isValid)
+```
+
+#### Return Values
+
+| Name    | Type | Description                                                                                                                                                           |
+| ------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isValid | bool | The result of computing the pairing check e(p1[0], p2[0]) _ .... _ e(p1[n], p2[n]) == 1 For example, pairing([P1(), P1().negate()], [P2(), P2()]) should return true. |

package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT3.md

@@ -0,0 +1,9 @@
+# PoseidonT3
+
+A library which provides functions for computing Pedersen hashes.
+
+### poseidon
+
+```solidity
+function poseidon(uint256[2] input) public pure returns (uint256)
+```

package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT4.md

@@ -0,0 +1,9 @@
+# PoseidonT4
+
+A library which provides functions for computing Pedersen hashes.
+
+### poseidon
+
+```solidity
+function poseidon(uint256[3] input) public pure returns (uint256)
+```

package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT5.md

@@ -0,0 +1,9 @@
+# PoseidonT5
+
+A library which provides functions for computing Pedersen hashes.
+
+### poseidon
+
+```solidity
+function poseidon(uint256[4] input) public pure returns (uint256)
+```

package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT6.md

@@ -0,0 +1,9 @@
+# PoseidonT6
+
+A library which provides functions for computing Pedersen hashes.
+
+### poseidon
+
+```solidity
+function poseidon(uint256[5] input) public pure returns (uint256)
+```

package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkCommon.md

@@ -0,0 +1,16 @@
+# SnarkCommon
+
+a Contract which holds a struct
+representing a Groth16 verifying key
+
+### VerifyingKey
+
+```solidity
+struct VerifyingKey {
+  struct Pairing.G1Point alpha1;
+  struct Pairing.G2Point beta2;
+  struct Pairing.G2Point gamma2;
+  struct Pairing.G2Point delta2;
+  struct Pairing.G1Point[] ic;
+}
+```

package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkConstants.md

@@ -0,0 +1,40 @@
+# SnarkConstants
+
+This contract contains constants related to the SNARK
+components of MACI.
+
+### SNARK_SCALAR_FIELD
+
+```solidity
+uint256 SNARK_SCALAR_FIELD
+```
+
+The scalar field
+
+### PAD_PUBKEY_X
+
+```solidity
+uint256 PAD_PUBKEY_X
+```
+
+The public key here is the first Pedersen base
+point from iden3's circomlib implementation of the Pedersen hash.
+Since it is generated using a hash-to-curve function, we are
+confident that no-one knows the private key associated with this
+public key. See:
+https://github.com/iden3/circomlib/blob/d5ed1c3ce4ca137a6b3ca48bec4ac12c1b38957a/src/pedersen_printbases.js
+Its hash should equal 6769006970205099520508948723718471724660867171122235270773600567925038008762.
+
+### PAD_PUBKEY_Y
+
+```solidity
+uint256 PAD_PUBKEY_Y
+```
+
+### NOTHING_UP_MY_SLEEVE
+
+```solidity
+uint256 NOTHING_UP_MY_SLEEVE
+```
+
+The Keccack256 hash of 'Maci'

package/versioned_docs/version-v1.2/solidity-docs/crypto/Verifier.md

@@ -0,0 +1,61 @@
+# Verifier
+
+a Groth16 verifier contract
+
+### Proof
+
+```solidity
+struct Proof {
+  struct Pairing.G1Point a;
+  struct Pairing.G2Point b;
+  struct Pairing.G1Point c;
+}
+```
+
+### PRIME_Q
+
+```solidity
+uint256 PRIME_Q
+```
+
+### InvalidProofQ
+
+```solidity
+error InvalidProofQ()
+```
+
+custom errors
+
+### InvalidInputVal
+
+```solidity
+error InvalidInputVal()
+```
+
+### verify
+
+```solidity
+function verify(uint256[8] _proof, struct SnarkCommon.VerifyingKey vk, uint256 input) public view returns (bool isValid)
+```
+
+Verify a zk-SNARK proof
+
+#### Parameters
+
+| Name    | Type                            | Description                      |
+| ------- | ------------------------------- | -------------------------------- |
+| \_proof | uint256[8]                      | The proof                        |
+| vk      | struct SnarkCommon.VerifyingKey | The verifying key                |
+| input   | uint256                         | The public inputs to the circuit |
+
+#### Return Values
+
+| Name    | Type | Description                                                                                                                                                                                                          |
+| ------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isValid | bool | Whether the proof is valid given the verifying key and public input. Note that this function only supports one public input. Refer to the Semaphore source code for a verifier that supports multiple public inputs. |
+
+### checkPoint
+
+```solidity
+function checkPoint(uint256 point) internal pure
+```

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/EASGatekeeper.md

@@ -0,0 +1,121 @@
+# EASGatekeeper
+
+A gatekeeper contract which allows users to sign up to MACI
+only if they've received an attestation of a specific schema from a trusted attester
+
+### schema
+
+```solidity
+bytes32 schema
+```
+
+### attester
+
+```solidity
+address attester
+```
+
+### maci
+
+```solidity
+address maci
+```
+
+the reference to the MACI contract
+
+### registeredAttestations
+
+```solidity
+mapping(bytes32 => bool) registeredAttestations
+```
+
+### AttestationRevoked
+
+```solidity
+error AttestationRevoked()
+```
+
+custom errors
+
+### AlreadyRegistered
+
+```solidity
+error AlreadyRegistered()
+```
+
+### AttesterNotTrusted
+
+```solidity
+error AttesterNotTrusted()
+```
+
+### NotYourAttestation
+
+```solidity
+error NotYourAttestation()
+```
+
+### InvalidSchema
+
+```solidity
+error InvalidSchema()
+```
+
+### OnlyMACI
+
+```solidity
+error OnlyMACI()
+```
+
+### ZeroAddress
+
+```solidity
+error ZeroAddress()
+```
+
+### constructor
+
+```solidity
+constructor(address _eas, address _attester, bytes32 _schema) public payable
+```
+
+Deploy an instance of EASGatekeeper
+
+#### Parameters
+
+| Name       | Type    | Description          |
+| ---------- | ------- | -------------------- |
+| \_eas      | address | The EAS contract     |
+| \_attester | address | The trusted attester |
+| \_schema   | bytes32 | The schema UID       |
+
+### setMaciInstance
+
+```solidity
+function setMaciInstance(address _maci) public
+```
+
+Adds an uninitialised MACI instance to allow for token signups
+
+#### Parameters
+
+| Name   | Type    | Description                              |
+| ------ | ------- | ---------------------------------------- |
+| \_maci | address | The MACI contract interface to be stored |
+
+### register
+
+```solidity
+function register(address _user, bytes _data) public
+```
+
+Register an user based on their attestation
+
+_Throw if the attestation is not valid or just complete silently_
+
+#### Parameters
+
+| Name   | Type    | Description                            |
+| ------ | ------- | -------------------------------------- |
+| \_user | address | The user's Ethereum address.           |
+| \_data | bytes   | The ABI-encoded schemaId as a uint256. |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/FreeForAllSignUpGatekeeper.md

@@ -0,0 +1,40 @@
+# FreeForAllGatekeeper
+
+A SignUpGatekeeper which allows anyone to sign up.
+
+### constructor
+
+```solidity
+constructor() public payable
+```
+
+Create a new instance of FreeForAllGatekeeper
+
+### setMaciInstance
+
+```solidity
+function setMaciInstance(address _maci) public
+```
+
+setMaciInstance does nothing in this gatekeeper
+
+#### Parameters
+
+| Name   | Type    | Description       |
+| ------ | ------- | ----------------- |
+| \_maci | address | The MACI contract |
+
+### register
+
+```solidity
+function register(address _address, bytes _data) public
+```
+
+Registers the user without any restrictions.
+
+#### Parameters
+
+| Name      | Type    | Description             |
+| --------- | ------- | ----------------------- |
+| \_address | address | The address of the user |
+| \_data    | bytes   | memory additional data  |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpGatekeeper.md

@@ -0,0 +1,26 @@
+# SignUpGatekeeper
+
+A gatekeeper contract which allows users to sign up for a poll.
+
+### setMaciInstance
+
+```solidity
+function setMaciInstance(address _maci) public virtual
+```
+
+Allows to set the MACI contract
+
+### register
+
+```solidity
+function register(address _user, bytes _data) public virtual
+```
+
+Registers the user
+
+#### Parameters
+
+| Name   | Type    | Description             |
+| ------ | ------- | ----------------------- |
+| \_user | address | The address of the user |
+| \_data | bytes   | additional data         |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpTokenGatekeeper.md

@@ -0,0 +1,93 @@
+# SignUpTokenGatekeeper
+
+This contract allows to gatekeep MACI signups
+by requiring new voters to own a certain ERC721 token
+
+### token
+
+```solidity
+contract SignUpToken token
+```
+
+the reference to the SignUpToken contract
+
+### maci
+
+```solidity
+address maci
+```
+
+the reference to the MACI contract
+
+### registeredTokenIds
+
+```solidity
+mapping(uint256 => bool) registeredTokenIds
+```
+
+a mapping of tokenIds to whether they have been used to sign up
+
+### AlreadyRegistered
+
+```solidity
+error AlreadyRegistered()
+```
+
+custom errors
+
+### NotTokenOwner
+
+```solidity
+error NotTokenOwner()
+```
+
+### OnlyMACI
+
+```solidity
+error OnlyMACI()
+```
+
+### constructor
+
+```solidity
+constructor(contract SignUpToken _token) public payable
+```
+
+creates a new SignUpTokenGatekeeper
+
+#### Parameters
+
+| Name    | Type                 | Description                             |
+| ------- | -------------------- | --------------------------------------- |
+| \_token | contract SignUpToken | the address of the SignUpToken contract |
+
+### setMaciInstance
+
+```solidity
+function setMaciInstance(address _maci) public
+```
+
+Adds an uninitialised MACI instance to allow for token signups
+
+#### Parameters
+
+| Name   | Type    | Description                              |
+| ------ | ------- | ---------------------------------------- |
+| \_maci | address | The MACI contract interface to be stored |
+
+### register
+
+```solidity
+function register(address _user, bytes _data) public
+```
+
+Registers the user if they own the token with the token ID encoded in
+\_data. Throws if the user does not own the token or if the token has
+already been used to sign up.
+
+#### Parameters
+
+| Name   | Type    | Description                           |
+| ------ | ------- | ------------------------------------- |
+| \_user | address | The user's Ethereum address.          |
+| \_data | bytes   | The ABI-encoded tokenId as a uint256. |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperBase.md

@@ -0,0 +1,79 @@
+# HatsGatekeeperBase
+
+Abstract contract containing the base elements of a Hats Gatekeeper contract
+
+### OnlyMACI
+
+```solidity
+error OnlyMACI()
+```
+
+### NotWearingCriterionHat
+
+```solidity
+error NotWearingCriterionHat()
+```
+
+### AlreadyRegistered
+
+```solidity
+error AlreadyRegistered()
+```
+
+### ZeroAddress
+
+```solidity
+error ZeroAddress()
+```
+
+### hats
+
+```solidity
+contract IHats hats
+```
+
+The Hats Protocol contract address
+
+### maci
+
+```solidity
+address maci
+```
+
+the reference to the MACI contract
+
+### registered
+
+```solidity
+mapping(address => bool) registered
+```
+
+Tracks registered users
+
+### constructor
+
+```solidity
+constructor(address _hats) internal payable
+```
+
+Deploy an instance of HatsGatekeeper
+
+#### Parameters
+
+| Name   | Type    | Description                |
+| ------ | ------- | -------------------------- |
+| \_hats | address | The Hats Protocol contract |
+
+### setMaciInstance
+
+```solidity
+function setMaciInstance(address _maci) public
+```
+
+Allows to set the MACI contract
+
+#### Parameters
+
+| Name   | Type    | Description                              |
+| ------ | ------- | ---------------------------------------- |
+| \_maci | address | The MACI contract interface to be stored |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperMultiple.md

@@ -0,0 +1,48 @@
+# HatsGatekeeperMultiple
+
+A gatekeeper contract which allows users to sign up to MACI
+only if they are wearing one of the specified hats
+
+### NotCriterionHat
+
+```solidity
+error NotCriterionHat()
+```
+
+### criterionHat
+
+```solidity
+mapping(uint256 => bool) criterionHat
+```
+
+Tracks hats that users must wear to be eligible to register
+
+### constructor
+
+```solidity
+constructor(address _hats, uint256[] _criterionHats) public payable
+```
+
+Deploy an instance of HatsGatekeeperMultiple
+
+#### Parameters
+
+| Name            | Type      | Description                      |
+| --------------- | --------- | -------------------------------- |
+| \_hats          | address   | The Hats Protocol contract       |
+| \_criterionHats | uint256[] | Array of accepted criterion hats |
+
+### register
+
+```solidity
+function register(address _user, bytes _data) public
+```
+
+Registers the user
+
+#### Parameters
+
+| Name   | Type    | Description             |
+| ------ | ------- | ----------------------- |
+| \_user | address | The address of the user |
+| \_data | bytes   | additional data         |

package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperSingle.md

@@ -0,0 +1,42 @@
+# HatsGatekeeperSingle
+
+A gatekeeper contract which allows users to sign up to MACI
+only if they are wearing a specified hat
+
+### criterionHat
+
+```solidity
+uint256 criterionHat
+```
+
+The hat that users must wear to be eligible to register
+
+### constructor
+
+```solidity
+constructor(address _hats, uint256 _criterionHat) public payable
+```
+
+Deploy an instance of HatsGatekeeperSingle
+
+#### Parameters
+
+| Name           | Type    | Description                |
+| -------------- | ------- | -------------------------- |
+| \_hats         | address | The Hats Protocol contract |
+| \_criterionHat | uint256 | The required hat           |
+
+### register
+
+```solidity
+function register(address _user, bytes) public
+```
+
+Registers the user
+
+#### Parameters
+
+| Name   | Type    | Description             |
+| ------ | ------- | ----------------------- |
+| \_user | address | The address of the user |
+|        | bytes   |                         |

package/versioned_docs/version-v1.2/solidity-docs/index.md

@@ -0,0 +1,4 @@
+---
+title: Solidity Docs
+sidebar_label: Solidity Docs
+---