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

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

@@ -0,0 +1,76 @@
+---
+title: MergeMessagesArgs
+sidebar_label: MergeMessagesArgs
+---
+
+Interface for the arguments to the mergeMessages command
+
+## Table of contents
+
+### Properties
+
+- [maciContractAddress](MergeMessagesArgs.md#macicontractaddress)
+- [numQueueOps](MergeMessagesArgs.md#numqueueops)
+- [pollId](MergeMessagesArgs.md#pollid)
+- [quiet](MergeMessagesArgs.md#quiet)
+- [signer](MergeMessagesArgs.md#signer)
+
+## Properties
+
+### maciContractAddress
+
+• `Optional` **maciContractAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:620](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L620)
+
+---
+
+### numQueueOps
+
+• `Optional` **numQueueOps**: `string`
+
+The number of queue operations to merge
+
+#### Defined in
+
+[utils/interfaces.ts:625](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L625)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:605](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L605)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:615](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L615)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:610](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L610)

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

@@ -0,0 +1,76 @@
+---
+title: MergeSignupsArgs
+sidebar_label: MergeSignupsArgs
+---
+
+Interface for the arguments to the mergeSignups command
+
+## Table of contents
+
+### Properties
+
+- [maciContractAddress](MergeSignupsArgs.md#macicontractaddress)
+- [numQueueOps](MergeSignupsArgs.md#numqueueops)
+- [pollId](MergeSignupsArgs.md#pollid)
+- [quiet](MergeSignupsArgs.md#quiet)
+- [signer](MergeSignupsArgs.md#signer)
+
+## Properties
+
+### maciContractAddress
+
+• `Optional` **maciContractAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:645](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L645)
+
+---
+
+### numQueueOps
+
+• `Optional` **numQueueOps**: `string`
+
+The number of queue operations to perform
+
+#### Defined in
+
+[utils/interfaces.ts:650](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L650)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:635](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L635)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:655](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L655)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:640](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L640)

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

@@ -0,0 +1,53 @@
+---
+title: PollContracts
+sidebar_label: PollContracts
+---
+
+## Table of contents
+
+### Properties
+
+- [messageProcessor](PollContracts.md#messageprocessor)
+- [poll](PollContracts.md#poll)
+- [subsidy](PollContracts.md#subsidy)
+- [tally](PollContracts.md#tally)
+
+## Properties
+
+### messageProcessor
+
+• **messageProcessor**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:23](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L23)
+
+---
+
+### poll
+
+• **poll**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:22](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L22)
+
+---
+
+### subsidy
+
+• `Optional` **subsidy**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:25](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L25)
+
+---
+
+### tally
+
+• **tally**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:24](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L24)

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

@@ -0,0 +1,128 @@
+---
+title: ProveOnChainArgs
+sidebar_label: ProveOnChainArgs
+---
+
+Interface for the arguments to the ProveOnChainArgs command
+
+## Table of contents
+
+### Properties
+
+- [maciAddress](ProveOnChainArgs.md#maciaddress)
+- [messageProcessorAddress](ProveOnChainArgs.md#messageprocessoraddress)
+- [pollId](ProveOnChainArgs.md#pollid)
+- [proofDir](ProveOnChainArgs.md#proofdir)
+- [quiet](ProveOnChainArgs.md#quiet)
+- [signer](ProveOnChainArgs.md#signer)
+- [subsidyAddress](ProveOnChainArgs.md#subsidyaddress)
+- [subsidyEnabled](ProveOnChainArgs.md#subsidyenabled)
+- [tallyAddress](ProveOnChainArgs.md#tallyaddress)
+
+## Properties
+
+### maciAddress
+
+• `Optional` **maciAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:685](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L685)
+
+---
+
+### messageProcessorAddress
+
+• `Optional` **messageProcessorAddress**: `string`
+
+The address of the MessageProcessor contract
+
+#### Defined in
+
+[utils/interfaces.ts:690](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L690)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:665](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L665)
+
+---
+
+### proofDir
+
+• **proofDir**: `string`
+
+The directory containing the proofs
+
+#### Defined in
+
+[utils/interfaces.ts:670](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L670)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:705](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L705)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:680](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L680)
+
+---
+
+### subsidyAddress
+
+• `Optional` **subsidyAddress**: `string`
+
+The address of the Subsidy contract
+
+#### Defined in
+
+[utils/interfaces.ts:700](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L700)
+
+---
+
+### subsidyEnabled
+
+• **subsidyEnabled**: `boolean`
+
+Whether to deploy subsidy contract
+
+#### Defined in
+
+[utils/interfaces.ts:675](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L675)
+
+---
+
+### tallyAddress
+
+• `Optional` **tallyAddress**: `string`
+
+The address of the Tally contract
+
+#### Defined in
+
+[utils/interfaces.ts:695](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L695)

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

@@ -0,0 +1,154 @@
+---
+title: PublishArgs
+sidebar_label: PublishArgs
+---
+
+Interface for the arguments to the publish command
+
+## Table of contents
+
+### Properties
+
+- [maciContractAddress](PublishArgs.md#macicontractaddress)
+- [newVoteWeight](PublishArgs.md#newvoteweight)
+- [nonce](PublishArgs.md#nonce)
+- [pollId](PublishArgs.md#pollid)
+- [privateKey](PublishArgs.md#privatekey)
+- [pubkey](PublishArgs.md#pubkey)
+- [quiet](PublishArgs.md#quiet)
+- [salt](PublishArgs.md#salt)
+- [signer](PublishArgs.md#signer)
+- [stateIndex](PublishArgs.md#stateindex)
+- [voteOptionIndex](PublishArgs.md#voteoptionindex)
+
+## Properties
+
+### maciContractAddress
+
+• **maciContractAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:750](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L750)
+
+---
+
+### newVoteWeight
+
+• **newVoteWeight**: `bigint`
+
+The new vote weight
+
+#### Defined in
+
+[utils/interfaces.ts:740](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L740)
+
+---
+
+### nonce
+
+• **nonce**: `bigint`
+
+The nonce of the message
+
+#### Defined in
+
+[utils/interfaces.ts:730](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L730)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:735](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L735)
+
+---
+
+### privateKey
+
+• **privateKey**: `string`
+
+The private key of the user
+
+#### Defined in
+
+[utils/interfaces.ts:755](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L755)
+
+---
+
+### pubkey
+
+• **pubkey**: `string`
+
+The public key of the user
+
+#### Defined in
+
+[utils/interfaces.ts:715](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L715)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:765](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L765)
+
+---
+
+### salt
+
+• `Optional` **salt**: `bigint`
+
+The salt of the message
+
+#### Defined in
+
+[utils/interfaces.ts:760](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L760)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:745](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L745)
+
+---
+
+### stateIndex
+
+• **stateIndex**: `bigint`
+
+The index of the state leaf
+
+#### Defined in
+
+[utils/interfaces.ts:720](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L720)
+
+---
+
+### voteOptionIndex
+
+• **voteOptionIndex**: `bigint`
+
+The index of the vote option
+
+#### Defined in
+
+[utils/interfaces.ts:725](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L725)

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

@@ -0,0 +1,89 @@
+---
+title: SignupArgs
+sidebar_label: SignupArgs
+---
+
+Interface for the arguments to the signup command
+
+## Table of contents
+
+### Properties
+
+- [ivcpDataArg](SignupArgs.md#ivcpdataarg)
+- [maciAddress](SignupArgs.md#maciaddress)
+- [maciPubKey](SignupArgs.md#macipubkey)
+- [quiet](SignupArgs.md#quiet)
+- [sgDataArg](SignupArgs.md#sgdataarg)
+- [signer](SignupArgs.md#signer)
+
+## Properties
+
+### ivcpDataArg
+
+• `Optional` **ivcpDataArg**: `string`
+
+The initial voice credit proxy data
+
+#### Defined in
+
+[utils/interfaces.ts:855](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L855)
+
+---
+
+### maciAddress
+
+• **maciAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:845](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L845)
+
+---
+
+### maciPubKey
+
+• **maciPubKey**: `string`
+
+The public key of the user
+
+#### Defined in
+
+[utils/interfaces.ts:835](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L835)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:860](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L860)
+
+---
+
+### sgDataArg
+
+• `Optional` **sgDataArg**: `string`
+
+The signup gateway data
+
+#### Defined in
+
+[utils/interfaces.ts:850](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L850)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:840](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L840)

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

@@ -0,0 +1,73 @@
+---
+title: SubsidyData
+sidebar_label: SubsidyData
+---
+
+A util interface that represents a subsidy file
+
+## Table of contents
+
+### Properties
+
+- [maci](SubsidyData.md#maci)
+- [newSubsidyCommitment](SubsidyData.md#newsubsidycommitment)
+- [pollId](SubsidyData.md#pollid)
+- [provider](SubsidyData.md#provider)
+- [results](SubsidyData.md#results)
+
+## Properties
+
+### maci
+
+• **maci**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:134](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L134)
+
+---
+
+### newSubsidyCommitment
+
+• **newSubsidyCommitment**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:136](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L136)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+#### Defined in
+
+[utils/interfaces.ts:135](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L135)
+
+---
+
+### provider
+
+• **provider**: `string`
+
+#### Defined in
+
+[utils/interfaces.ts:133](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L133)
+
+---
+
+### results
+
+• **results**: `Object`
+
+#### Type declaration
+
+| Name      | Type       |
+| :-------- | :--------- |
+| `salt`    | `string`   |
+| `subsidy` | `string`[] |
+
+#### Defined in
+
+[utils/interfaces.ts:137](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L137)