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

package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.md

@@ -0,0 +1,40 @@
+# ConstantInitialVoiceCreditProxy
+
+This contract allows to set a constant initial voice credit balance
+for MACI's voters.
+
+### balance
+
+```solidity
+uint256 balance
+```
+
+the balance to be returned by getVoiceCredits
+
+### constructor
+
+```solidity
+constructor(uint256 _balance) public payable
+```
+
+creates a new ConstantInitialVoiceCreditProxy
+
+#### Parameters
+
+| Name      | Type    | Description                                   |
+| --------- | ------- | --------------------------------------------- |
+| \_balance | uint256 | the balance to be returned by getVoiceCredits |
+
+### getVoiceCredits
+
+```solidity
+function getVoiceCredits(address, bytes) public view returns (uint256)
+```
+
+Returns the constant balance for any new MACI's voter
+
+#### Return Values
+
+| Name | Type    | Description |
+| ---- | ------- | ----------- |
+| [0]  | uint256 | balance     |

package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/InitialVoiceCreditProxy.md

@@ -0,0 +1,26 @@
+# InitialVoiceCreditProxy
+
+This contract is the base contract for
+InitialVoiceCreditProxy contracts. It allows to set a custom initial voice
+credit balance for MACI's voters.
+
+### getVoiceCredits
+
+```solidity
+function getVoiceCredits(address _user, bytes _data) public view virtual returns (uint256)
+```
+
+Returns the initial voice credit balance for a new MACI's voter
+
+#### Parameters
+
+| Name   | Type    | Description              |
+| ------ | ------- | ------------------------ |
+| \_user | address | the address of the voter |
+| \_data | bytes   | additional data          |
+
+#### Return Values
+
+| Name | Type    | Description |
+| ---- | ------- | ----------- |
+| [0]  | uint256 | the balance |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IEAS.md

@@ -0,0 +1,40 @@
+# IEAS
+
+An interface to the EAS contract.
+
+### Attestation
+
+```solidity
+struct Attestation {
+  bytes32 uid;
+  bytes32 schema;
+  uint64 time;
+  uint64 expirationTime;
+  uint64 revocationTime;
+  bytes32 refUID;
+  address recipient;
+  address attester;
+  bool revocable;
+  bytes data;
+}
+```
+
+### getAttestation
+
+```solidity
+function getAttestation(bytes32 uid) external view returns (struct IEAS.Attestation)
+```
+
+Get an attestation by its unique identifier.
+
+#### Parameters
+
+| Name | Type    | Description                               |
+| ---- | ------- | ----------------------------------------- |
+| uid  | bytes32 | The unique identifier of the attestation. |
+
+#### Return Values
+
+| Name | Type                    | Description                  |
+| ---- | ----------------------- | ---------------------------- |
+| [0]  | struct IEAS.Attestation | attestation The attestation. |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IHats.md

@@ -0,0 +1,103 @@
+# IHats
+
+Minimal interface for the Hats Protocol contract
+
+_Includes only the functions required for the HatsGatekeepers and associated tests_
+
+### mintTopHat
+
+```solidity
+function mintTopHat(address _target, string _details, string _imageURI) external returns (uint256)
+```
+
+Creates and mints a Hat that is its own admin, i.e. a "topHat"
+
+_A topHat has no eligibility and no toggle_
+
+#### Parameters
+
+| Name       | Type    | Description                                                                                                                                              |
+| ---------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| \_target   | address | The address to which the newly created topHat is minted                                                                                                  |
+| \_details  | string  | A description of the Hat [optional]. Should not be larger than 7000 bytes (enforced in changeHatDetails)                                                 |
+| \_imageURI | string  | The image uri for this top hat and the fallback for its downstream hats [optional]. Should not be larger than 7000 bytes (enforced in changeHatImageURI) |
+
+#### Return Values
+
+| Name | Type    | Description                                 |
+| ---- | ------- | ------------------------------------------- |
+| [0]  | uint256 | topHatId The id of the newly created topHat |
+
+### createHat
+
+```solidity
+function createHat(uint256 _admin, string _details, uint32 _maxSupply, address _eligibility, address _toggle, bool _mutable, string _imageURI) external returns (uint256)
+```
+
+Creates a new hat. The msg.sender must wear the `_admin` hat.
+
+_Initializes a new Hat struct, but does not mint any tokens._
+
+#### Parameters
+
+| Name          | Type    | Description                                                                                                                                          |
+| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| \_admin       | uint256 | The id of the Hat that will control who wears the newly created hat                                                                                  |
+| \_details     | string  | A description of the Hat. Should not be larger than 7000 bytes (enforced in changeHatDetails)                                                        |
+| \_maxSupply   | uint32  | The total instances of the Hat that can be worn at once                                                                                              |
+| \_eligibility | address | The address that can report on the Hat wearer's status                                                                                               |
+| \_toggle      | address | The address that can deactivate the Hat                                                                                                              |
+| \_mutable     | bool    | Whether the hat's properties are changeable after creation                                                                                           |
+| \_imageURI    | string  | The image uri for this hat and the fallback for its downstream hats [optional]. Should not be larger than 7000 bytes (enforced in changeHatImageURI) |
+
+#### Return Values
+
+| Name | Type    | Description                              |
+| ---- | ------- | ---------------------------------------- |
+| [0]  | uint256 | newHatId The id of the newly created Hat |
+
+### mintHat
+
+```solidity
+function mintHat(uint256 _hatId, address _wearer) external returns (bool success)
+```
+
+Mints an ERC1155-similar token of the Hat to an eligible recipient, who then "wears" the hat
+
+_The msg.sender must wear an admin Hat of `_hatId`, and the recipient must be eligible to wear `_hatId`_
+
+#### Parameters
+
+| Name     | Type    | Description                            |
+| -------- | ------- | -------------------------------------- |
+| \_hatId  | uint256 | The id of the Hat to mint              |
+| \_wearer | address | The address to which the Hat is minted |
+
+#### Return Values
+
+| Name    | Type | Description                |
+| ------- | ---- | -------------------------- |
+| success | bool | Whether the mint succeeded |
+
+### isWearerOfHat
+
+```solidity
+function isWearerOfHat(address account, uint256 hat) external view returns (bool)
+```
+
+Checks whether a given address wears a given Hat
+
+_Convenience function that wraps `balanceOf`_
+
+#### Parameters
+
+| Name    | Type    | Description                                   |
+| ------- | ------- | --------------------------------------------- |
+| account | address | The address in question                       |
+| hat     | uint256 | The id of the Hat that the `_user` might wear |
+
+#### Return Values
+
+| Name | Type | Description                                 |
+| ---- | ---- | ------------------------------------------- |
+| [0]  | bool | isWearer Whether the `_user` wears the Hat. |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMPFactory.md

@@ -0,0 +1,26 @@
+# IMessageProcessorFactory
+
+MessageProcessorFactory interface
+
+### deploy
+
+```solidity
+function deploy(address _verifier, address _vkRegistry, address _poll, address _owner) external returns (address)
+```
+
+Deploy a new MessageProcessor contract and return the address.
+
+#### Parameters
+
+| Name         | Type    | Description                            |
+| ------------ | ------- | -------------------------------------- |
+| \_verifier   | address | Verifier contract                      |
+| \_vkRegistry | address | VkRegistry contract                    |
+| \_poll       | address | Poll contract                          |
+| \_owner      | address | Owner of the MessageProcessor contract |
+
+#### Return Values
+
+| Name | Type    | Description                            |
+| ---- | ------- | -------------------------------------- |
+| [0]  | address | The deployed MessageProcessor contract |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMessageProcessor.md

@@ -0,0 +1,31 @@
+# IMessageProcessor
+
+MessageProcessor interface
+
+### processingComplete
+
+```solidity
+function processingComplete() external view returns (bool)
+```
+
+Get the result of whether there are unprocessed messages left
+
+#### Return Values
+
+| Name | Type | Description                                 |
+| ---- | ---- | ------------------------------------------- |
+| [0]  | bool | Whether there are unprocessed messages left |
+
+### sbCommitment
+
+```solidity
+function sbCommitment() external view returns (uint256)
+```
+
+Get the commitment to the state and ballot roots
+
+#### Return Values
+
+| Name | Type    | Description                                  |
+| ---- | ------- | -------------------------------------------- |
+| [0]  | uint256 | The commitment to the state and ballot roots |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPoll.md

@@ -0,0 +1,217 @@
+# IPoll
+
+Poll interface
+
+### numSignUpsAndMessages
+
+```solidity
+function numSignUpsAndMessages() external view returns (uint256 numSignups, uint256 numMsgs)
+```
+
+The number of messages which have been processed and the number of signups
+
+#### Return Values
+
+| Name       | Type    | Description                           |
+| ---------- | ------- | ------------------------------------- |
+| numSignups | uint256 | The number of signups                 |
+| numMsgs    | uint256 | The number of messages sent by voters |
+
+### topup
+
+```solidity
+function topup(uint256 stateIndex, uint256 amount) external
+```
+
+Allows to publish a Topup message
+
+#### Parameters
+
+| Name       | Type    | Description                          |
+| ---------- | ------- | ------------------------------------ |
+| stateIndex | uint256 | The index of user in the state queue |
+| amount     | uint256 | The amount of credits to topup       |
+
+### publishMessage
+
+```solidity
+function publishMessage(struct DomainObjs.Message _message, struct DomainObjs.PubKey _encPubKey) external
+```
+
+Allows anyone to publish a message (an encrypted command and signature).
+This function also enqueues the message.
+
+#### Parameters
+
+| Name        | Type                      | Description                                                                                                                                        |
+| ----------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| \_message   | struct DomainObjs.Message | The message to publish                                                                                                                             |
+| \_encPubKey | struct DomainObjs.PubKey  | An ephemeral public key which can be combined with the coordinator's private key to generate an ECDH shared key with which to encrypt the message. |
+
+### mergeMaciStateAqSubRoots
+
+```solidity
+function mergeMaciStateAqSubRoots(uint256 _numSrQueueOps, uint256 _pollId) external
+```
+
+The first step of merging the MACI state AccQueue. This allows the
+ProcessMessages circuit to access the latest state tree and ballots via
+currentSbCommitment.
+
+#### Parameters
+
+| Name            | Type    | Description               |
+| --------------- | ------- | ------------------------- |
+| \_numSrQueueOps | uint256 | Number of operations      |
+| \_pollId        | uint256 | The ID of the active Poll |
+
+### mergeMaciStateAq
+
+```solidity
+function mergeMaciStateAq(uint256 _pollId) external
+```
+
+The second step of merging the MACI state AccQueue. This allows the
+ProcessMessages circuit to access the latest state tree and ballots via
+currentSbCommitment.
+
+#### Parameters
+
+| Name     | Type    | Description               |
+| -------- | ------- | ------------------------- |
+| \_pollId | uint256 | The ID of the active Poll |
+
+### mergeMessageAqSubRoots
+
+```solidity
+function mergeMessageAqSubRoots(uint256 _numSrQueueOps) external
+```
+
+The first step in merging the message AccQueue so that the
+ProcessMessages circuit can access the message root.
+
+#### Parameters
+
+| Name            | Type    | Description                                       |
+| --------------- | ------- | ------------------------------------------------- |
+| \_numSrQueueOps | uint256 | The number of subroot queue operations to perform |
+
+### mergeMessageAq
+
+```solidity
+function mergeMessageAq() external
+```
+
+The second step in merging the message AccQueue so that the
+ProcessMessages circuit can access the message root.
+
+### getDeployTimeAndDuration
+
+```solidity
+function getDeployTimeAndDuration() external view returns (uint256 _deployTime, uint256 _duration)
+```
+
+Returns the Poll's deploy time and duration
+
+#### Return Values
+
+| Name         | Type    | Description              |
+| ------------ | ------- | ------------------------ |
+| \_deployTime | uint256 | The deployment timestamp |
+| \_duration   | uint256 | The duration of the poll |
+
+### stateAqMerged
+
+```solidity
+function stateAqMerged() external view returns (bool)
+```
+
+Get the result of whether the MACI contract's stateAq has been merged by this contract
+
+#### Return Values
+
+| Name | Type | Description                                                          |
+| ---- | ---- | -------------------------------------------------------------------- |
+| [0]  | bool | Whether the MACI contract's stateAq has been merged by this contract |
+
+### treeDepths
+
+```solidity
+function treeDepths() external view returns (uint8 intStateTreeDepth, uint8 messageTreeSubDepth, uint8 messageTreeDepth, uint8 voteOptionTreeDepth)
+```
+
+Get the depths of the merkle trees
+
+#### Return Values
+
+| Name                | Type  | Description                          |
+| ------------------- | ----- | ------------------------------------ |
+| intStateTreeDepth   | uint8 | The depth of the state tree          |
+| messageTreeSubDepth | uint8 | The subdepth of the message tree     |
+| messageTreeDepth    | uint8 | The depth of the message tree        |
+| voteOptionTreeDepth | uint8 | The subdepth of the vote option tree |
+
+### maxValues
+
+```solidity
+function maxValues() external view returns (uint256 maxMessages, uint256 maxVoteOptions)
+```
+
+Get the max values for the poll
+
+#### Return Values
+
+| Name           | Type    | Description                        |
+| -------------- | ------- | ---------------------------------- |
+| maxMessages    | uint256 | The maximum number of messages     |
+| maxVoteOptions | uint256 | The maximum number of vote options |
+
+### extContracts
+
+```solidity
+function extContracts() external view returns (contract IMACI maci, contract AccQueue messageAq, contract TopupCredit topupCredit)
+```
+
+Get the external contracts
+
+#### Return Values
+
+| Name        | Type                 | Description              |
+| ----------- | -------------------- | ------------------------ |
+| maci        | contract IMACI       | The IMACI contract       |
+| messageAq   | contract AccQueue    | The AccQueue contract    |
+| topupCredit | contract TopupCredit | The TopupCredit contract |
+
+### coordinatorPubKeyHash
+
+```solidity
+function coordinatorPubKeyHash() external view returns (uint256 _coordinatorPubKeyHash)
+```
+
+Get the hash of coordinator's public key
+
+#### Return Values
+
+| Name                    | Type    | Description                          |
+| ----------------------- | ------- | ------------------------------------ |
+| \_coordinatorPubKeyHash | uint256 | the hash of coordinator's public key |
+
+### currentSbCommitment
+
+```solidity
+function currentSbCommitment() external view returns (uint256)
+```
+
+Get the commitment to the state leaves and the ballots. This is
+hash3(stateRoot, ballotRoot, salt).
+Its initial value should be
+hash(maciStateRootSnapshot, emptyBallotRoot, 0)
+Each successful invocation of processMessages() should use a different
+salt to update this value, so that an external observer cannot tell in
+the case that none of the messages are valid.
+
+#### Return Values
+
+| Name | Type    | Description                                        |
+| ---- | ------- | -------------------------------------------------- |
+| [0]  | uint256 | The commitment to the state leaves and the ballots |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPollFactory.md

@@ -0,0 +1,29 @@
+# IPollFactory
+
+PollFactory interface
+
+### deploy
+
+```solidity
+function deploy(uint256 _duration, struct Params.MaxValues _maxValues, struct Params.TreeDepths _treeDepths, struct DomainObjs.PubKey _coordinatorPubKey, address _maci, contract TopupCredit _topupCredit, address _pollOwner) external returns (address)
+```
+
+Deploy a new Poll contract and AccQueue contract for messages.
+
+#### Parameters
+
+| Name                | Type                     | Description                           |
+| ------------------- | ------------------------ | ------------------------------------- |
+| \_duration          | uint256                  | The duration of the poll              |
+| \_maxValues         | struct Params.MaxValues  | The max values for the poll           |
+| \_treeDepths        | struct Params.TreeDepths | The depths of the merkle trees        |
+| \_coordinatorPubKey | struct DomainObjs.PubKey | The coordinator's public key          |
+| \_maci              | address                  | The MACI contract interface reference |
+| \_topupCredit       | contract TopupCredit     | The TopupCredit contract              |
+| \_pollOwner         | address                  | The owner of the poll                 |
+
+#### Return Values
+
+| Name | Type    | Description                |
+| ---- | ------- | -------------------------- |
+| [0]  | address | The deployed Poll contract |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallyFactory.md

@@ -0,0 +1,28 @@
+# ITallyFactory
+
+TallyFactory interface
+
+### deploy
+
+```solidity
+function deploy(address _verifier, address _vkRegistry, address _poll, address _messageProcessor, address _owner, bool _isQv) external returns (address)
+```
+
+Deploy a new Tally contract and return the address.
+
+#### Parameters
+
+| Name               | Type    | Description                  |
+| ------------------ | ------- | ---------------------------- |
+| \_verifier         | address | Verifier contract            |
+| \_vkRegistry       | address | VkRegistry contract          |
+| \_poll             | address | Poll contract                |
+| \_messageProcessor | address | MessageProcessor contract    |
+| \_owner            | address | Owner of the contract        |
+| \_isQv             | bool    | Whether to support QV or not |
+
+#### Return Values
+
+| Name | Type    | Description           |
+| ---- | ------- | --------------------- |
+| [0]  | address | The deployed contract |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallySubsidyFactory.md

@@ -0,0 +1,27 @@
+# ITallySubsidyFactory
+
+TallySubsidyFactory interface
+
+### deploy
+
+```solidity
+function deploy(address _verifier, address _vkRegistry, address _poll, address _messageProcessor, address _owner) external returns (address)
+```
+
+Deploy a new Tally or Subsidy contract and return the address.
+
+#### Parameters
+
+| Name               | Type    | Description               |
+| ------------------ | ------- | ------------------------- |
+| \_verifier         | address | Verifier contract         |
+| \_vkRegistry       | address | VkRegistry contract       |
+| \_poll             | address | Poll contract             |
+| \_messageProcessor | address | MessageProcessor contract |
+| \_owner            | address | Owner of the contract     |
+
+#### Return Values
+
+| Name | Type    | Description           |
+| ---- | ------- | --------------------- |
+| [0]  | address | The deployed contract |

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

@@ -0,0 +1,25 @@
+# IVerifier
+
+an interface for a Groth16 verifier contract
+
+### verify
+
+```solidity
+function verify(uint256[8] _proof, struct SnarkCommon.VerifyingKey vk, uint256 input) external view returns (bool)
+```
+
+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                                                                                                                                                                                                          |
+| ---- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [0]  | 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. |

package/versioned_docs/version-v1.2/solidity-docs/interfaces/IVkRegistry.md

@@ -0,0 +1,70 @@
+# IVkRegistry
+
+VkRegistry interface
+
+### getTallyVk
+
+```solidity
+function getTallyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) external view returns (struct SnarkCommon.VerifyingKey)
+```
+
+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       |
+| ---- | ------------------------------- | ----------------- |
+| [0]  | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### getProcessVk
+
+```solidity
+function getProcessVk(uint256 _stateTreeDepth, uint256 _messageTreeDepth, uint256 _voteOptionTreeDepth, uint256 _messageBatchSize) external view returns (struct SnarkCommon.VerifyingKey)
+```
+
+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       |
+| ---- | ------------------------------- | ----------------- |
+| [0]  | struct SnarkCommon.VerifyingKey | The verifying key |
+
+### getSubsidyVk
+
+```solidity
+function getSubsidyVk(uint256 _stateTreeDepth, uint256 _intStateTreeDepth, uint256 _voteOptionTreeDepth) external view returns (struct SnarkCommon.VerifyingKey)
+```
+
+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       |
+| ---- | ------------------------------- | ----------------- |
+| [0]  | struct SnarkCommon.VerifyingKey | The verifying key |