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

package/versioned_docs/version-v1.2/trusted-setup.md

@@ -0,0 +1,76 @@
+---
+title: MACI Trusted Setup
+description: Introduction to the MACI multi-party trusted setup
+sidebar_label: Trusted Setup
+sidebar_position: 10
+---
+
+# Trusted setup
+
+MACI currently uses Groth16 zk-SNARKs written in `circom`. Teams who wish to
+build on MACI may choose to perform a multi-party trusted setup. This allows
+observers to have a higher degree of confidence that the coordinator cannot
+generate fake proofs. Some teams, however, may forgo the trusted setup.
+
+There are two possible reasons for doing so: if a team does not intend
+to manage a large amount of value, and if their users accept that the risk of
+coordinator misbehaviour is insufficient to justify doing the work of a
+trusted setup. After all, MACI's security model presumes a trusted coordinator.
+
+The [PSE team](https://pse.dev/) is making available a trusted set of zKeys for MACI's circuits,
+which are available and accessible on
+[p0tion's website](https://ceremony.pse.dev/).
+For more info on trusted setup ceremonies please refer to p0tion's [docs](https://p0tion.super.site/).
+
+## Maci v1.2 Trusted Setup Ceremony (most recent)
+
+For your convenience, here is a list of the artifacts that can be used in production:
+
+:::info
+You can download all of the artifacts using the following command from maci's monorepo root:
+
+```bash
+download:ceremony-zkeys
+```
+
+:::
+
+| Artifact                               | Description                                                                                              | Parameters | Link                                                                                                                                                                                                                                            |
+| -------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| processMessages zKey                   | The production-ready zKey for the processMessages circuit.                                               | 6-9-2-3    | [processMessages_6-9-2-3_final.zkey](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessages_6-9-2-3/contributions/maci-processmessages_6-9-2-3_final.zkey)                |
+| processMessagesNonQv zKey              | The production-ready zKey for the processMessagesNonQv circuit.                                          | 6-9-2-3    | [processMessagesNonQv_6-9-2-3_final.zkey](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessagesnonqv_6-9-2-3/contributions/maci-processmessagesnonqv_6-9-2-3_final.zkey) |
+| tallyVotes zKey                        | The production-ready zKey for the tallyVotes circuit.                                                    | 6-2-3      | [tallyVotes_6-2-3_final.zkey](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/contributions/tallyvotes_6-2-3_final.zkey)                                                   |
+| tallyVotesNonQv zKey                   | The production-ready zKey for the tallyVotesNonQv circuit.                                               | 6-2-3      | [tallyVotesNonQv_6-2-3_final.zkey](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-tallyvotesnonqv_6-2-3/contributions/maci-tallyvotesnonqv_6-2-3_final.zkey)                      |
+| processMessages r1cs                   | The Rank-1 Constraint System file that was used to generate the zKey                                     | 6-9-2-3    | [MACI-ProcessMessages_6-9-2-3.r1cs ](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessages_6-9-2-3/MACI-ProcessMessages_6-9-2-3.r1cs)                                    |
+| processMessagesNonQv r1cs              | The Rank-1 Constraint System file that was used to generate the zKey                                     | 6-9-2-3    | [MACI-ProcessMessagesNonQv_6-9-2-3.r1cs](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessagesnonqv_6-9-2-3/MACI-ProcessMessagesNonQv_6-9-2-3.r1cs)                      |
+| tallyVotes r1cs                        | The Rank-1 Constraint System file that was used to generate the zKey                                     | 6-2-3      | [tallyvotes_6-2-3.r1cs](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3.r1cs)                                                                             |
+| tallyVotesNonQv r1cs                   | The Rank-1 Constraint System file that was used to generate the zKey                                     | 6-2-3      | [tallyvotesnonqv_6-2-3.r1cs](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-tallyvotesnonqv_6-2-3/MACI-TallyVotesNonQv_6-2-3.r1cs)                                                |
+| processMessages wasm                   | The WASM file that can be used to generate proofs                                                        | 6-9-2-3    | [MACI-ProcessMessages_6-9-2-3.wasm](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessages_6-9-2-3/MACI-ProcessMessages_6-9-2-3.wasm)                                     |
+| processMessagesNonQv wasm              | The WASM file that can be used to generate proofs                                                        | 6-9-2-3    | [MACI-ProcessMessagesNonQv_6-9-2-3.wasm](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessagesnonqv_6-9-2-3/MACI-ProcessMessagesNonQv_6-9-2-3.wasm)                      |
+| tallyVotes wasm                        | The WASM file that can be used to generate proofs                                                        | 6-2-3      | [tallyvotes_6-2-3.wasm](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3.wasm)                                                                             |
+| tallyVotesNonQv wasm                   | The WASM file that can be used to generate proofs                                                        | 6-2-3      | [tallyvotesnonqv_6-2-3.wasm](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-tallyvotesnonqv_6-2-3/MACI-TallyVotesNonQv_6-2-3.wasm)                                                |
+| processMessages vKey                   | The verification key that can be used to verify the processMessages circuit's proofs                     | 6-9-2-3    | [maci-processmessages_6-9-2-3_vkey.json](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessages_6-9-2-3/maci-processmessages_6-9-2-3_vkey.json)                           |
+| processMessagesNonQv vKey              | The verification key that can be used to verify the processMessagesNonQv circuit's proofs                | 6-9-2-3    | [maci-processmessagesnonqv_6-9-2-3_vkey.json](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessagesnonqv_6-9-2-3/maci-processmessagesnonqv_6-9-2-3_vkey.json)            |
+| tallyVotes vKey                        | The verification key that can be used to verify the tallyVotes circuit's proofs                          | 6-2-3      | [tallyvotes_6-2-3_vkey.json](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3_vkey.json)                                                                   |
+| tallyVotesNonQv vKey                   | The verification key that can be used to verify the tallyVotesNonQv circuit's proofs                     | 6-2-3      | [tallyvotesnonqv_6-2-3_vkey.json](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-tallyvotesnonqv_6-2-3/maci-tallyvotesnonqv_6-2-3_vkey.json)                                      |
+| processMessages Solidity verifier      | The Solidity smart contract which can be used to verify the processMessages circuit proofs on-chain      | 6-9-2-3    | [maci-processmessages_6-9-2-3_verifier.sol](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessages_6-9-2-3/maci-processmessages_6-9-2-3_verifier.sol)                     |
+| processMessagesNonQv Solidity verifier | The Solidity smart contract which can be used to verify the processMessagesNonQv circuit proofs on-chain | 6-9-2-3    | [maci-processmessagesnonqv_6-9-2-3_verifier.sol](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-processmessagesnonqv_6-9-2-3/maci-processmessagesnonqv_6-9-2-3_verifier.sol)      |
+| tallyVotes Solidity verifier           | The Solidity smart contract which can be used to verify the tallyVotes circuit proofs on-chain           | 6-2-3      | [tallyvotes_6-2-3_verifier.sol](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3_verifier.sol)                                                             |
+| tallyVotesNonQv Solidity verifier      | The Solidity smart contract which can be used to verify the tallyVotesNonQv circuit proofs on-chain      | 6-2-3      | [tallyvotesnonqv_6-2-3_verifier.sol](https://maci-v1-2-0-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/maci-tallyvotesnonqv_6-2-3/maci-tallyvotesnonqv_6-2-3_verifier.sol)                                |
+
+## Maci v1.1 Trusted Setup Ceremony
+
+For your convenience, here is a list of the artifacts that can be used in production:
+
+| Artifact                          | Description                                                                                         | Parameters | Link                                                                                                                                                                                                               |
+| --------------------------------- | --------------------------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| processMessages zKey              | The production-ready zKey for the processMessages circuit.                                          | 6-8-2-3    | [processmessages_6-8-2-3_final.zkey](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/processmessages_6-8-2-3/contributions/processmessages_6-8-2-3_final.zkey) |
+| tallyVotes zKey                   | The production-ready zKey for the tallyVotes circuit.                                               | 6-2-3      | [tallyvotes_6-2-3_final.zkey](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/contributions/tallyvotes_6-2-3_final.zkey)                      |
+| processMessages r1cs              | The Rank-1 Constraint System file that was used to generate the zKey                                | 6-8-2-3    | [processmessages_6-8-2-3.r1cs](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/processmessages_6-8-2-3/processmessages_6-8-2-3.r1cs)                           |
+| tallyVotes r1cs                   | The Rank-1 Constraint System file that was used to generate the zKey                                | 6-2-3      | [tallyvotes_6-2-3.r1cs](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3.r1cs)                                                |
+| processMessage wasm               | The WASM file that can be used to generate proofs                                                   | 6-8-2-3    | [processmessages_6-8-2-3.wasm](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/processmessages_6-8-2-3/processmessages_6-8-2-3.wasm)                           |
+| tallyVotes wasm                   | The WASM file that can be used to generate proofs                                                   | 6-2-3      | [tallyvotes_6-2-3.wasm](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3.wasm)                                                |
+| processMessages vKey              | The verification key that can be used to verify the processMessages circuit's proofs                | 6-8-2-3    | [processmessages_6-8-2-3_vkey.json](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/processmessages_6-8-2-3/processmessages_6-8-2-3_vkey.json)                 |
+| tallyVotes vKey                   | The verification key that can be used to verify the tallyVotes circuit's proofs                     | 6-2-3      | [tallyvotes_6-2-3_vkey.json](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3_vkey.json)                                      |
+| processMessages Solidity verifier | The Solidity smart contract which can be used to verify the processMessages circuit proofs on-chain | 6-8-2-3    | [processmessages_6-8-2-3_verifier.sol](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/processmessages_6-8-2-3/processmessages_6-8-2-3_verifier.sol)           |
+| tallyVotes Solidity verifier      | The Solidity smart contract which can be used to verify the tallyVotes circuit proofs on-chain      | 6-2-3      | [tallyvotes_6-2-3_verifier.sol](https://maci-v1-trusted-setup-ceremony-pse-p0tion-production.s3.eu-central-1.amazonaws.com/circuits/tallyvotes_6-2-3/tallyvotes_6-2-3_verifier.sol)                                |

package/versioned_docs/version-v1.2/typedoc/cli/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/versioned_docs/version-v1.2/typedoc/cli/index.md

@@ -0,0 +1,15 @@
+---
+title: Cli
+sidebar_label: Cli
+---
+
+[![NPM Package][cli-npm-badge]][cli-npm-link]
+[![Actions Status][cli-actions-badge]][cli-actions-link]
+
+Please refer to the [documentation for the
+CLI](https://maci.pse.dev/docs/cli).
+
+[cli-npm-badge]: https://img.shields.io/npm/v/maci-cli.svg
+[cli-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/e2e.yml/badge.svg
+[cli-npm-link]: https://www.npmjs.com/package/maci-cli
+[cli-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3ACI

package/versioned_docs/version-v1.2/typedoc/cli/interfaces/AirdropArgs.md

@@ -0,0 +1,89 @@
+---
+title: AirdropArgs
+sidebar_label: AirdropArgs
+---
+
+Interface for the arguments to the airdrop command
+
+## Table of contents
+
+### Properties
+
+- [amount](AirdropArgs.md#amount)
+- [contractAddress](AirdropArgs.md#contractaddress)
+- [maciAddress](AirdropArgs.md#maciaddress)
+- [pollId](AirdropArgs.md#pollid)
+- [quiet](AirdropArgs.md#quiet)
+- [signer](AirdropArgs.md#signer)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+The amount of credits to airdrop
+
+#### Defined in
+
+[utils/interfaces.ts:174](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L174)
+
+---
+
+### contractAddress
+
+• `Optional` **contractAddress**: `string`
+
+The address of the ERC20 contract
+
+#### Defined in
+
+[utils/interfaces.ts:184](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L184)
+
+---
+
+### maciAddress
+
+• `Optional` **maciAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:194](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L194)
+
+---
+
+### pollId
+
+• `Optional` **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:189](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L189)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:199](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L199)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:179](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L179)

package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployArgs.md

@@ -0,0 +1,154 @@
+---
+title: DeployArgs
+sidebar_label: DeployArgs
+---
+
+Interface for the arguments to the deploy command
+
+## Table of contents
+
+### Properties
+
+- [initialVoiceCredits](DeployArgs.md#initialvoicecredits)
+- [initialVoiceCreditsProxyAddress](DeployArgs.md#initialvoicecreditsproxyaddress)
+- [poseidonT3Address](DeployArgs.md#poseidont3address)
+- [poseidonT4Address](DeployArgs.md#poseidont4address)
+- [poseidonT5Address](DeployArgs.md#poseidont5address)
+- [poseidonT6Address](DeployArgs.md#poseidont6address)
+- [quiet](DeployArgs.md#quiet)
+- [signer](DeployArgs.md#signer)
+- [signupGatekeeperAddress](DeployArgs.md#signupgatekeeperaddress)
+- [stateTreeDepth](DeployArgs.md#statetreedepth)
+- [useQv](DeployArgs.md#useqv)
+
+## Properties
+
+### initialVoiceCredits
+
+• `Optional` **initialVoiceCredits**: `number`
+
+The initial voice credits to be minted
+
+#### Defined in
+
+[utils/interfaces.ts:279](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L279)
+
+---
+
+### initialVoiceCreditsProxyAddress
+
+• `Optional` **initialVoiceCreditsProxyAddress**: `string`
+
+The address of the initialVoiceCreditsProxy contract
+
+#### Defined in
+
+[utils/interfaces.ts:284](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L284)
+
+---
+
+### poseidonT3Address
+
+• `Optional` **poseidonT3Address**: `string`
+
+The address of the PoseidonT3 contract
+
+#### Defined in
+
+[utils/interfaces.ts:294](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L294)
+
+---
+
+### poseidonT4Address
+
+• `Optional` **poseidonT4Address**: `string`
+
+The address of the PoseidonT4 contract
+
+#### Defined in
+
+[utils/interfaces.ts:299](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L299)
+
+---
+
+### poseidonT5Address
+
+• `Optional` **poseidonT5Address**: `string`
+
+The address of the PoseidonT5 contract
+
+#### Defined in
+
+[utils/interfaces.ts:304](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L304)
+
+---
+
+### poseidonT6Address
+
+• `Optional` **poseidonT6Address**: `string`
+
+The address of the PoseidonT6 contract
+
+#### Defined in
+
+[utils/interfaces.ts:309](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L309)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:314](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L314)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:274](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L274)
+
+---
+
+### signupGatekeeperAddress
+
+• `Optional` **signupGatekeeperAddress**: `string`
+
+The address of the signupGatekeeper contract
+
+#### Defined in
+
+[utils/interfaces.ts:289](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L289)
+
+---
+
+### stateTreeDepth
+
+• **stateTreeDepth**: `number`
+
+The depth of the state tree
+
+#### Defined in
+
+[utils/interfaces.ts:269](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L269)
+
+---
+
+### useQv
+
+• `Optional` **useQv**: `boolean`
+
+Whether to use quadratic voting or not
+
+#### Defined in
+
+[utils/interfaces.ts:319](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L319)

package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployPollArgs.md

@@ -0,0 +1,154 @@
+---
+title: DeployPollArgs
+sidebar_label: DeployPollArgs
+---
+
+Interface for the arguments to the deployPoll command
+
+## Table of contents
+
+### Properties
+
+- [coordinatorPubkey](DeployPollArgs.md#coordinatorpubkey)
+- [intStateTreeDepth](DeployPollArgs.md#intstatetreedepth)
+- [maciAddress](DeployPollArgs.md#maciaddress)
+- [messageTreeDepth](DeployPollArgs.md#messagetreedepth)
+- [messageTreeSubDepth](DeployPollArgs.md#messagetreesubdepth)
+- [pollDuration](DeployPollArgs.md#pollduration)
+- [quiet](DeployPollArgs.md#quiet)
+- [signer](DeployPollArgs.md#signer)
+- [subsidyEnabled](DeployPollArgs.md#subsidyenabled)
+- [vkRegistryAddress](DeployPollArgs.md#vkregistryaddress)
+- [voteOptionTreeDepth](DeployPollArgs.md#voteoptiontreedepth)
+
+## Properties
+
+### coordinatorPubkey
+
+• **coordinatorPubkey**: `string`
+
+The coordinator's public key
+
+#### Defined in
+
+[utils/interfaces.ts:354](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L354)
+
+---
+
+### intStateTreeDepth
+
+• **intStateTreeDepth**: `number`
+
+The depth of the intermediate state tree
+
+#### Defined in
+
+[utils/interfaces.ts:334](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L334)
+
+---
+
+### maciAddress
+
+• `Optional` **maciAddress**: `string`
+
+The MACI contract address
+
+#### Defined in
+
+[utils/interfaces.ts:369](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L369)
+
+---
+
+### messageTreeDepth
+
+• **messageTreeDepth**: `number`
+
+The depth of the message tree
+
+#### Defined in
+
+[utils/interfaces.ts:344](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L344)
+
+---
+
+### messageTreeSubDepth
+
+• **messageTreeSubDepth**: `number`
+
+The depth of the message tree sublevels
+
+#### Defined in
+
+[utils/interfaces.ts:339](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L339)
+
+---
+
+### pollDuration
+
+• **pollDuration**: `number`
+
+The duration of the poll in seconds
+
+#### Defined in
+
+[utils/interfaces.ts:329](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L329)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output to the console
+
+#### Defined in
+
+[utils/interfaces.ts:379](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L379)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:364](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L364)
+
+---
+
+### subsidyEnabled
+
+• **subsidyEnabled**: `boolean`
+
+Whether to deploy subsidy contract
+
+#### Defined in
+
+[utils/interfaces.ts:359](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L359)
+
+---
+
+### vkRegistryAddress
+
+• `Optional` **vkRegistryAddress**: `string`
+
+The vkRegistry contract address
+
+#### Defined in
+
+[utils/interfaces.ts:374](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L374)
+
+---
+
+### voteOptionTreeDepth
+
+• **voteOptionTreeDepth**: `number`
+
+The depth of the vote option tree
+
+#### Defined in
+
+[utils/interfaces.ts:349](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L349)

package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployedContracts.md

@@ -0,0 +1,130 @@
+---
+title: DeployedContracts
+sidebar_label: DeployedContracts
+---
+
+## Table of contents
+
+### Properties
+
+- [initialVoiceCreditProxyAddress](DeployedContracts.md#initialvoicecreditproxyaddress)
+- [maciAddress](DeployedContracts.md#maciaddress)
+- [pollFactoryAddress](DeployedContracts.md#pollfactoryaddress)
+- [poseidonT3Address](DeployedContracts.md#poseidont3address)
+- [poseidonT4Address](DeployedContracts.md#poseidont4address)
+- [poseidonT5Address](DeployedContracts.md#poseidont5address)
+- [poseidonT6Address](DeployedContracts.md#poseidont6address)
+- [signUpGatekeeperAddress](DeployedContracts.md#signupgatekeeperaddress)
+- [stateAqAddress](DeployedContracts.md#stateaqaddress)
+- [topupCreditAddress](DeployedContracts.md#topupcreditaddress)
+- [verifierAddress](DeployedContracts.md#verifieraddress)
+
+## Properties
+
+### initialVoiceCreditProxyAddress
+
+• **initialVoiceCreditProxyAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:16](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L16)
+
+---
+
+### maciAddress
+
+• **maciAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:8](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L8)
+
+---
+
+### pollFactoryAddress
+
+• **pollFactoryAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:10](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L10)
+
+---
+
+### poseidonT3Address
+
+• **poseidonT3Address**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:12](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L12)
+
+---
+
+### poseidonT4Address
+
+• **poseidonT4Address**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:13](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L13)
+
+---
+
+### poseidonT5Address
+
+• **poseidonT5Address**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:14](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L14)
+
+---
+
+### poseidonT6Address
+
+• **poseidonT6Address**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L15)
+
+---
+
+### signUpGatekeeperAddress
+
+• **signUpGatekeeperAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:17](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L17)
+
+---
+
+### stateAqAddress
+
+• **stateAqAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:9](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L9)
+
+---
+
+### topupCreditAddress
+
+• **topupCreditAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:11](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L11)
+
+---
+
+### verifierAddress
+
+• **verifierAddress**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:18](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L18)