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

package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinaryMaci.md

@@ -0,0 +1,34 @@
+# AccQueueBinaryMaci
+
+This contract extends AccQueueBinary and MerkleBinaryMaci
+
+_This contract is used for creating a
+Merkle tree with binary (2 leaves per node) structure_
+
+### constructor
+
+```solidity
+constructor(uint256 _subDepth) public
+```
+
+Constructor for creating AccQueueBinaryMaci contract
+
+#### Parameters
+
+| Name       | Type    | Description               |
+| ---------- | ------- | ------------------------- |
+| \_subDepth | uint256 | The depth of each subtree |
+
+### getZero
+
+```solidity
+function getZero(uint256 _level) internal view returns (uint256 zero)
+```
+
+Returns the zero leaf at a specified level
+
+#### Parameters
+
+| Name    | Type    | Description                                |
+| ------- | ------- | ------------------------------------------ |
+| \_level | uint256 | The level at which to return the zero leaf |

package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary.md

@@ -0,0 +1,75 @@
+# AccQueueQuinary
+
+This contract defines a Merkle tree where each leaf insertion only updates a
+subtree. To obtain the main tree root, the contract owner must merge the
+subtrees together. Merging subtrees requires at least 2 operations:
+mergeSubRoots(), and merge(). To get around the gas limit,
+the mergeSubRoots() can be performed in multiple transactions.
+
+_This contract is for a quinary tree (5 leaves per node)_
+
+### constructor
+
+```solidity
+constructor(uint256 _subDepth) internal
+```
+
+Create a new AccQueueQuinary instance
+
+### hashLevel
+
+```solidity
+function hashLevel(uint256 _level, uint256 _leaf) internal returns (uint256 hashed)
+```
+
+Hash the contents of the specified level and the specified leaf.
+
+_it also frees up storage slots to refund gas._
+
+#### Parameters
+
+| Name    | Type    | Description                      |
+| ------- | ------- | -------------------------------- |
+| \_level | uint256 | The level to hash.               |
+| \_leaf  | uint256 | The leaf include with the level. |
+
+#### Return Values
+
+| Name   | Type    | Description                     |
+| ------ | ------- | ------------------------------- |
+| hashed | uint256 | The hash of the level and leaf. |
+
+### hashLevelLeaf
+
+```solidity
+function hashLevelLeaf(uint256 _level, uint256 _leaf) public view returns (uint256 hashed)
+```
+
+Hash the contents of the specified level and the specified leaf.
+
+#### Parameters
+
+| Name    | Type    | Description                      |
+| ------- | ------- | -------------------------------- |
+| \_level | uint256 | The level to hash.               |
+| \_leaf  | uint256 | The leaf include with the level. |
+
+#### Return Values
+
+| Name   | Type    | Description                     |
+| ------ | ------- | ------------------------------- |
+| hashed | uint256 | The hash of the level and leaf. |
+
+### \_fill
+
+```solidity
+function _fill(uint256 _level) internal
+```
+
+An internal function which fills a subtree
+
+#### Parameters
+
+| Name    | Type    | Description                            |
+| ------- | ------- | -------------------------------------- |
+| \_level | uint256 | The level at which to fill the subtree |

package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary0.md

@@ -0,0 +1,40 @@
+# AccQueueQuinary0
+
+This contract extends AccQueueQuinary and MerkleQuinary0
+
+_This contract is used for creating a
+Merkle tree with quinary (5 leaves per node) structure_
+
+### constructor
+
+```solidity
+constructor(uint256 _subDepth) public
+```
+
+Constructor for creating AccQueueQuinary0 contract
+
+#### Parameters
+
+| Name       | Type    | Description               |
+| ---------- | ------- | ------------------------- |
+| \_subDepth | uint256 | The depth of each subtree |
+
+### getZero
+
+```solidity
+function getZero(uint256 _level) internal view returns (uint256 zero)
+```
+
+Returns the zero leaf at a specified level
+
+#### Parameters
+
+| Name    | Type    | Description                                |
+| ------- | ------- | ------------------------------------------ |
+| \_level | uint256 | The level at which to return the zero leaf |
+
+#### Return Values
+
+| Name | Type    | Description                          |
+| ---- | ------- | ------------------------------------ |
+| zero | uint256 | The zero leaf at the specified level |

package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryBlankSl.md

@@ -0,0 +1,40 @@
+# AccQueueQuinaryBlankSl
+
+This contract extends AccQueueQuinary and MerkleQuinaryBlankSl
+
+_This contract is used for creating a
+Merkle tree with quinary (5 leaves per node) structure_
+
+### constructor
+
+```solidity
+constructor(uint256 _subDepth) public
+```
+
+Constructor for creating AccQueueQuinaryBlankSl contract
+
+#### Parameters
+
+| Name       | Type    | Description               |
+| ---------- | ------- | ------------------------- |
+| \_subDepth | uint256 | The depth of each subtree |
+
+### getZero
+
+```solidity
+function getZero(uint256 _level) internal view returns (uint256 zero)
+```
+
+Returns the zero leaf at a specified level
+
+#### Parameters
+
+| Name    | Type    | Description                                |
+| ------- | ------- | ------------------------------------------ |
+| \_level | uint256 | The level at which to return the zero leaf |
+
+#### Return Values
+
+| Name | Type    | Description                          |
+| ---- | ------- | ------------------------------------ |
+| zero | uint256 | The zero leaf at the specified level |

package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryMaci.md

@@ -0,0 +1,40 @@
+# AccQueueQuinaryMaci
+
+This contract extends AccQueueQuinary and MerkleQuinaryMaci
+
+_This contract is used for creating a
+Merkle tree with quinary (5 leaves per node) structure_
+
+### constructor
+
+```solidity
+constructor(uint256 _subDepth) public
+```
+
+Constructor for creating AccQueueQuinaryMaci contract
+
+#### Parameters
+
+| Name       | Type    | Description               |
+| ---------- | ------- | ------------------------- |
+| \_subDepth | uint256 | The depth of each subtree |
+
+### getZero
+
+```solidity
+function getZero(uint256 _level) internal view returns (uint256 zero)
+```
+
+Returns the zero leaf at a specified level
+
+#### Parameters
+
+| Name    | Type    | Description                                |
+| ------- | ------- | ------------------------------------------ |
+| \_level | uint256 | The level at which to return the zero leaf |
+
+#### Return Values
+
+| Name | Type    | Description                          |
+| ---- | ------- | ------------------------------------ |
+| zero | uint256 | The zero leaf at the specified level |

package/versioned_docs/version-v1.2/solidity-docs/trees/EmptyBallotRoots.md

@@ -0,0 +1,13 @@
+# EmptyBallotRoots
+
+### emptyBallotRoots
+
+```solidity
+uint256[5] emptyBallotRoots
+```
+
+### constructor
+
+```solidity
+constructor() internal
+```

package/versioned_docs/version-v1.2/solidity-docs/utilities/CommonUtilities.md

@@ -0,0 +1,25 @@
+# CommonUtilities
+
+A contract that holds common utilities
+which are to be used by multiple contracts
+namely Subsidy, Tally and MessageProcessor
+
+### VotingPeriodNotPassed
+
+```solidity
+error VotingPeriodNotPassed()
+```
+
+### \_votingPeriodOver
+
+```solidity
+function _votingPeriodOver(contract IPoll _poll) internal view
+```
+
+common function for MessageProcessor, Tally and Subsidy
+
+#### Parameters
+
+| Name   | Type           | Description            |
+| ------ | -------------- | ---------------------- |
+| \_poll | contract IPoll | the poll to be checked |

package/versioned_docs/version-v1.2/solidity-docs/utilities/DomainObjs.md

@@ -0,0 +1,40 @@
+# DomainObjs
+
+An utility contract that holds
+a number of domain objects and functions
+
+### MESSAGE_DATA_LENGTH
+
+```solidity
+uint8 MESSAGE_DATA_LENGTH
+```
+
+the length of a MACI message
+
+### Message
+
+```solidity
+struct Message {
+  uint256 msgType;
+  uint256[10] data;
+}
+```
+
+### PubKey
+
+```solidity
+struct PubKey {
+  uint256 x;
+  uint256 y;
+}
+```
+
+### StateLeaf
+
+```solidity
+struct StateLeaf {
+  struct DomainObjs.PubKey pubKey;
+  uint256 voiceCreditBalance;
+  uint256 timestamp;
+}
+```

package/versioned_docs/version-v1.2/solidity-docs/utilities/Params.md

@@ -0,0 +1,36 @@
+# Params
+
+This contracts contains a number of structures
+which are to be passed as parameters to Poll contracts.
+This way we can reduce the number of parameters
+and avoid a stack too deep error during compilation.
+
+### TreeDepths
+
+```solidity
+struct TreeDepths {
+  uint8 intStateTreeDepth;
+  uint8 messageTreeSubDepth;
+  uint8 messageTreeDepth;
+  uint8 voteOptionTreeDepth;
+}
+```
+
+### MaxValues
+
+```solidity
+struct MaxValues {
+  uint256 maxMessages;
+  uint256 maxVoteOptions;
+}
+```
+
+### ExtContracts
+
+```solidity
+struct ExtContracts {
+  contract IMACI maci;
+  contract AccQueue messageAq;
+  contract TopupCredit topupCredit;
+}
+```

package/versioned_docs/version-v1.2/solidity-docs/utilities/Utilities.md

@@ -0,0 +1,79 @@
+# Utilities
+
+An utility contract that can be used to:
+
+- hash a state leaf
+- pad and hash a MACI message
+- hash a MACI message and an encryption public key
+
+### InvalidMessage
+
+```solidity
+error InvalidMessage()
+```
+
+custom errors
+
+### hashStateLeaf
+
+```solidity
+function hashStateLeaf(struct DomainObjs.StateLeaf _stateLeaf) public pure returns (uint256 ciphertext)
+```
+
+An utility function used to hash a state leaf
+
+#### Parameters
+
+| Name        | Type                        | Description                 |
+| ----------- | --------------------------- | --------------------------- |
+| \_stateLeaf | struct DomainObjs.StateLeaf | the state leaf to be hashed |
+
+#### Return Values
+
+| Name       | Type    | Description                |
+| ---------- | ------- | -------------------------- |
+| ciphertext | uint256 | The hash of the state leaf |
+
+### padAndHashMessage
+
+```solidity
+function padAndHashMessage(uint256[2] dataToPad, uint256 msgType) public pure returns (struct DomainObjs.Message message, struct DomainObjs.PubKey padKey, uint256 msgHash)
+```
+
+An utility function used to pad and hash a MACI message
+
+#### Parameters
+
+| Name      | Type       | Description             |
+| --------- | ---------- | ----------------------- |
+| dataToPad | uint256[2] | the data to be padded   |
+| msgType   | uint256    | the type of the message |
+
+#### Return Values
+
+| Name    | Type                      | Description                                       |
+| ------- | ------------------------- | ------------------------------------------------- |
+| message | struct DomainObjs.Message | The padded message                                |
+| padKey  | struct DomainObjs.PubKey  | The padding public key                            |
+| msgHash | uint256                   | The hash of the padded message and encryption key |
+
+### hashMessageAndEncPubKey
+
+```solidity
+function hashMessageAndEncPubKey(struct DomainObjs.Message _message, struct DomainObjs.PubKey _encPubKey) public pure returns (uint256 msgHash)
+```
+
+An utility function used to hash a MACI message and an encryption public key
+
+#### Parameters
+
+| Name        | Type                      | Description                            |
+| ----------- | ------------------------- | -------------------------------------- |
+| \_message   | struct DomainObjs.Message | the message to be hashed               |
+| \_encPubKey | struct DomainObjs.PubKey  | the encryption public key to be hashed |
+
+#### Return Values
+
+| Name    | Type    | Description                                           |
+| ------- | ------- | ----------------------------------------------------- |
+| msgHash | uint256 | The hash of the message and the encryption public key |