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

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

@@ -0,0 +1,61 @@
+# TopupCredit
+
+A contract representing a token used to topup a MACI's voter
+credits
+
+### DECIMALS
+
+```solidity
+uint8 DECIMALS
+```
+
+### MAXIMUM_AIRDROP_AMOUNT
+
+```solidity
+uint256 MAXIMUM_AIRDROP_AMOUNT
+```
+
+### ExceedLimit
+
+```solidity
+error ExceedLimit()
+```
+
+custom errors
+
+### constructor
+
+```solidity
+constructor() public payable
+```
+
+create a new TopupCredit token
+
+### airdropTo
+
+```solidity
+function airdropTo(address account, uint256 amount) public
+```
+
+mint tokens to an account
+
+#### Parameters
+
+| Name    | Type    | Description                   |
+| ------- | ------- | ----------------------------- |
+| account | address | the account to mint tokens to |
+| amount  | uint256 | the amount of tokens to mint  |
+
+### airdrop
+
+```solidity
+function airdrop(uint256 amount) public
+```
+
+mint tokens to the contract owner
+
+#### Parameters
+
+| Name   | Type    | Description                  |
+| ------ | ------- | ---------------------------- |
+| amount | uint256 | the amount of tokens to mint |

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

@@ -0,0 +1,457 @@
+# VkRegistry
+
+Stores verifying keys for the circuits.
+Each circuit has a signature which is its compile-time constants represented
+as a uint256.
+
+### processVks
+
+```solidity
+mapping(uint256 => struct SnarkCommon.VerifyingKey) processVks
+```
+
+### processVkSet
+
+```solidity
+mapping(uint256 => bool) processVkSet
+```
+
+### tallyVks
+
+```solidity
+mapping(uint256 => struct SnarkCommon.VerifyingKey) tallyVks
+```
+
+### tallyVkSet
+
+```solidity
+mapping(uint256 => bool) tallyVkSet
+```
+
+### subsidyVks
+
+```solidity
+mapping(uint256 => struct SnarkCommon.VerifyingKey) subsidyVks
+```
+
+### subsidyVkSet
+
+```solidity
+mapping(uint256 => bool) subsidyVkSet
+```
+
+### ProcessVkSet
+
+```solidity
+event ProcessVkSet(uint256 _sig)
+```
+
+### TallyVkSet
+
+```solidity
+event TallyVkSet(uint256 _sig)
+```
+
+### SubsidyVkSet
+
+```solidity
+event SubsidyVkSet(uint256 _sig)
+```
+
+### ProcessVkAlreadySet
+
+```solidity
+error ProcessVkAlreadySet()
+```
+
+### TallyVkAlreadySet
+
+```solidity
+error TallyVkAlreadySet()
+```
+
+### SubsidyVkAlreadySet
+
+```solidity
+error SubsidyVkAlreadySet()
+```
+
+### ProcessVkNotSet
+
+```solidity
+error ProcessVkNotSet()
+```
+
+### TallyVkNotSet
+
+```solidity
+error TallyVkNotSet()
+```
+
+### SubsidyVkNotSet
+
+```solidity
+error SubsidyVkNotSet()
+```
+
+### constructor
+
+```solidity
+constructor() public payable
+```
+
+Create a new instance of the VkRegistry contract
+
+### isProcessVkSet
+
+```solidity
+function isProcessVkSet(uint256 _sig) public view returns (bool isSet)
+```
+
+Check if the process verifying key is set
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### isTallyVkSet
+
+```solidity
+function isTallyVkSet(uint256 _sig) public view returns (bool isSet)
+```
+
+Check if the tally verifying key is set
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### isSubsidyVkSet
+
+```solidity
+function isSubsidyVkSet(uint256 _sig) public view returns (bool isSet)
+```
+
+Check if the subsidy verifying key is set
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### genProcessVkSig
+
+```solidity
+function genProcessVkSig(uint256 _stateTreeDepth, uint256 _messageTreeDepth, uint256 _voteOptionTreeDepth, uint256 _messageBatchSize) public pure returns (uint256 sig)
+```
+
+generate the signature for the process verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                |
+| --------------------- | ------- | -------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth       |
+| \_messageTreeDepth    | uint256 | The message tree depth     |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth |
+| \_messageBatchSize    | uint256 | The message batch size     |
+
+### genTallyVkSig
+
+```solidity
+function genTallyVkSig(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public pure returns (uint256 sig)
+```
+
+generate the signature for the tally verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name | Type    | Description   |
+| ---- | ------- | ------------- |
+| sig  | uint256 | The signature |
+
+### genSubsidyVkSig
+
+```solidity
+function genSubsidyVkSig(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public pure returns (uint256 sig)
+```
+
+generate the signature for the subsidy verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name | Type    | Description   |
+| ---- | ------- | ------------- |
+| sig  | uint256 | The signature |
+
+### setVerifyingKeys
+
+```solidity
+function setVerifyingKeys(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _messageTreeDepth, uint256 _voteOptionTreeDepth, uint256 _messageBatchSize, struct SnarkCommon.VerifyingKey _processVk, struct SnarkCommon.VerifyingKey _tallyVk) public
+```
+
+Set the process and tally verifying keys for a certain combination
+of parameters
+
+#### Parameters
+
+| Name                  | Type                            | Description                       |
+| --------------------- | ------------------------------- | --------------------------------- |
+| \_stateTreeDepth      | uint256                         | The state tree depth              |
+| \_intStateTreeDepth   | uint256                         | The intermediate state tree depth |
+| \_messageTreeDepth    | uint256                         | The message tree depth            |
+| \_voteOptionTreeDepth | uint256                         | The vote option tree depth        |
+| \_messageBatchSize    | uint256                         | The message batch size            |
+| \_processVk           | struct SnarkCommon.VerifyingKey | The process verifying key         |
+| \_tallyVk             | struct SnarkCommon.VerifyingKey | The tally verifying key           |
+
+### setSubsidyKeys
+
+```solidity
+function setSubsidyKeys(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth, struct SnarkCommon.VerifyingKey _subsidyVk) public
+```
+
+Set the process verifying key for a certain combination
+of parameters
+
+#### Parameters
+
+| Name                  | Type                            | Description                       |
+| --------------------- | ------------------------------- | --------------------------------- |
+| \_stateTreeDepth      | uint256                         | The state tree depth              |
+| \_intStateTreeDepth   | uint256                         | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256                         | The vote option tree depth        |
+| \_subsidyVk           | struct SnarkCommon.VerifyingKey | The verifying key                 |
+
+### hasProcessVk
+
+```solidity
+function hasProcessVk(uint256 _stateTreeDepth, uint256 _messageTreeDepth, uint256 _voteOptionTreeDepth, uint256 _messageBatchSize) public view returns (bool isSet)
+```
+
+Check if the process verifying key is set
+
+#### Parameters
+
+| Name                  | Type    | Description                |
+| --------------------- | ------- | -------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth       |
+| \_messageTreeDepth    | uint256 | The message tree depth     |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth |
+| \_messageBatchSize    | uint256 | The message batch size     |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### getProcessVkBySig
+
+```solidity
+function getProcessVkBySig(uint256 _sig) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the process verifying key by signature
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### getProcessVk
+
+```solidity
+function getProcessVk(uint256 _stateTreeDepth, uint256 _messageTreeDepth, uint256 _voteOptionTreeDepth, uint256 _messageBatchSize) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the process verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                |
+| --------------------- | ------- | -------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth       |
+| \_messageTreeDepth    | uint256 | The message tree depth     |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth |
+| \_messageBatchSize    | uint256 | The message batch size     |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### hasTallyVk
+
+```solidity
+function hasTallyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public view returns (bool isSet)
+```
+
+Check if the tally verifying key is set
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### getTallyVkBySig
+
+```solidity
+function getTallyVkBySig(uint256 _sig) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the tally verifying key by signature
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### getTallyVk
+
+```solidity
+function getTallyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the tally verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### hasSubsidyVk
+
+```solidity
+function hasSubsidyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public view returns (bool isSet)
+```
+
+Check if the subsidy verifying key is set
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name  | Type | Description                      |
+| ----- | ---- | -------------------------------- |
+| isSet | bool | whether the verifying key is set |
+
+### getSubsidyVkBySig
+
+```solidity
+function getSubsidyVkBySig(uint256 _sig) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the subsidy verifying key by signature
+
+#### Parameters
+
+| Name  | Type    | Description   |
+| ----- | ------- | ------------- |
+| \_sig | uint256 | The signature |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### getSubsidyVk
+
+```solidity
+function getSubsidyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) public view returns (struct SnarkCommon.VerifyingKey vk)
+```
+
+Get the subsidy verifying key
+
+#### Parameters
+
+| Name                  | Type    | Description                       |
+| --------------------- | ------- | --------------------------------- |
+| \_stateTreeDepth      | uint256 | The state tree depth              |
+| \_intStateTreeDepth   | uint256 | The intermediate state tree depth |
+| \_voteOptionTreeDepth | uint256 | The vote option tree depth        |
+
+#### Return Values
+
+| Name | Type                            | Description       |
+| ---- | ------------------------------- | ----------------- |
+| vk   | struct SnarkCommon.VerifyingKey | The verifying key |

package/versioned_docs/version-v1.2/solidity-docs/benchmarks/HasherBenchmarks.md

@@ -0,0 +1,44 @@
+# HasherBenchmarks
+
+A contract used to benchmark the poseidon hash function
+
+### hash5Benchmark
+
+```solidity
+function hash5Benchmark(uint256[5] array) public pure returns (uint256 result)
+```
+
+Benchmark the poseidon hash function with 5 inputs
+
+#### Parameters
+
+| Name  | Type       | Description                 |
+| ----- | ---------- | --------------------------- |
+| array | uint256[5] | The array of inputs to hash |
+
+#### Return Values
+
+| Name   | Type    | Description            |
+| ------ | ------- | ---------------------- |
+| result | uint256 | The hash of the inputs |
+
+### hashLeftRightBenchmark
+
+```solidity
+function hashLeftRightBenchmark(uint256 _left, uint256 _right) public pure returns (uint256 result)
+```
+
+Benchmark the poseidon hash function with 2 inputs
+
+#### Parameters
+
+| Name    | Type    | Description             |
+| ------- | ------- | ----------------------- |
+| \_left  | uint256 | The left input to hash  |
+| \_right | uint256 | The right input to hash |
+
+#### Return Values
+
+| Name   | Type    | Description                |
+| ------ | ------- | -------------------------- |
+| result | uint256 | The hash of the two inputs |

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

@@ -0,0 +1,125 @@
+# Hasher
+
+A SHA256 hash function for any number of input elements, and Poseidon hash
+functions for 2, 3, 4, 5, and 12 input elements.
+
+### sha256Hash
+
+```solidity
+function sha256Hash(uint256[] array) public pure returns (uint256 result)
+```
+
+Computes the SHA256 hash of an array of uint256 elements.
+
+#### Parameters
+
+| Name  | Type      | Description                    |
+| ----- | --------- | ------------------------------ |
+| array | uint256[] | The array of uint256 elements. |
+
+#### Return Values
+
+| Name   | Type    | Description                   |
+| ------ | ------- | ----------------------------- |
+| result | uint256 | The SHA256 hash of the array. |
+
+### hash2
+
+```solidity
+function hash2(uint256[2] array) public pure returns (uint256 result)
+```
+
+Computes the Poseidon hash of two uint256 elements.
+
+#### Parameters
+
+| Name  | Type       | Description                       |
+| ----- | ---------- | --------------------------------- |
+| array | uint256[2] | An array of two uint256 elements. |
+
+#### Return Values
+
+| Name   | Type    | Description                            |
+| ------ | ------- | -------------------------------------- |
+| result | uint256 | The Poseidon hash of the two elements. |
+
+### hash3
+
+```solidity
+function hash3(uint256[3] array) public pure returns (uint256 result)
+```
+
+Computes the Poseidon hash of three uint256 elements.
+
+#### Parameters
+
+| Name  | Type       | Description                         |
+| ----- | ---------- | ----------------------------------- |
+| array | uint256[3] | An array of three uint256 elements. |
+
+#### Return Values
+
+| Name   | Type    | Description                              |
+| ------ | ------- | ---------------------------------------- |
+| result | uint256 | The Poseidon hash of the three elements. |
+
+### hash4
+
+```solidity
+function hash4(uint256[4] array) public pure returns (uint256 result)
+```
+
+Computes the Poseidon hash of four uint256 elements.
+
+#### Parameters
+
+| Name  | Type       | Description                        |
+| ----- | ---------- | ---------------------------------- |
+| array | uint256[4] | An array of four uint256 elements. |
+
+#### Return Values
+
+| Name   | Type    | Description                             |
+| ------ | ------- | --------------------------------------- |
+| result | uint256 | The Poseidon hash of the four elements. |
+
+### hash5
+
+```solidity
+function hash5(uint256[5] array) public pure returns (uint256 result)
+```
+
+Computes the Poseidon hash of five uint256 elements.
+
+#### Parameters
+
+| Name  | Type       | Description                        |
+| ----- | ---------- | ---------------------------------- |
+| array | uint256[5] | An array of five uint256 elements. |
+
+#### Return Values
+
+| Name   | Type    | Description                             |
+| ------ | ------- | --------------------------------------- |
+| result | uint256 | The Poseidon hash of the five elements. |
+
+### hashLeftRight
+
+```solidity
+function hashLeftRight(uint256 left, uint256 right) public pure returns (uint256 result)
+```
+
+Computes the Poseidon hash of two uint256 elements.
+
+#### Parameters
+
+| Name  | Type    | Description                 |
+| ----- | ------- | --------------------------- |
+| left  | uint256 | the first element to hash.  |
+| right | uint256 | the second element to hash. |
+
+#### Return Values
+
+| Name   | Type    | Description                            |
+| ------ | ------- | -------------------------------------- |
+| result | uint256 | The Poseidon hash of the two elements. |

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

@@ -0,0 +1,11 @@
+# IVerifier
+
+an interface for a Groth16 verifier contract
+
+### verify
+
+```solidity
+function verify(uint256[8], struct SnarkCommon.VerifyingKey, uint256) public view virtual returns (bool)
+```
+
+Verify a zk-SNARK proof

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

@@ -0,0 +1,17 @@
+# MockVerifier
+
+a MockVerifier to be used for testing
+
+### verify
+
+```solidity
+function verify(uint256[8], struct SnarkCommon.VerifyingKey, uint256) public pure returns (bool result)
+```
+
+Verify a zk-SNARK proof (test only return always true)
+
+#### Return Values
+
+| Name   | Type | Description                                                   |
+| ------ | ---- | ------------------------------------------------------------- |
+| result | bool | Whether the proof is valid given the verifying key and public |