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

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

@@ -0,0 +1,166 @@
+---
+title: TallyData
+sidebar_label: TallyData
+---
+
+Interface for the tally file data.
+
+## Table of contents
+
+### Properties
+
+- [chainId](TallyData.md#chainid)
+- [isQuadratic](TallyData.md#isquadratic)
+- [maci](TallyData.md#maci)
+- [network](TallyData.md#network)
+- [newTallyCommitment](TallyData.md#newtallycommitment)
+- [perVOSpentVoiceCredits](TallyData.md#pervospentvoicecredits)
+- [pollId](TallyData.md#pollid)
+- [results](TallyData.md#results)
+- [tallyAddress](TallyData.md#tallyaddress)
+- [totalSpentVoiceCredits](TallyData.md#totalspentvoicecredits)
+
+## Properties
+
+### chainId
+
+• `Optional` **chainId**: `string`
+
+The chain ID for which these proofs are valid for
+
+#### Defined in
+
+[utils/interfaces.ts:51](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L51)
+
+---
+
+### isQuadratic
+
+• **isQuadratic**: `boolean`
+
+Whether the poll is using quadratic voting or not.
+
+#### Defined in
+
+[utils/interfaces.ts:56](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L56)
+
+---
+
+### maci
+
+• **maci**: `string`
+
+The MACI address.
+
+#### Defined in
+
+[utils/interfaces.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L35)
+
+---
+
+### network
+
+• `Optional` **network**: `string`
+
+The name of the network for which these proofs
+are valid for
+
+#### Defined in
+
+[utils/interfaces.ts:46](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L46)
+
+---
+
+### newTallyCommitment
+
+• **newTallyCommitment**: `string`
+
+The new tally commitment.
+
+#### Defined in
+
+[utils/interfaces.ts:66](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L66)
+
+---
+
+### perVOSpentVoiceCredits
+
+• `Optional` **perVOSpentVoiceCredits**: `Object`
+
+The per VO spent voice credits.
+
+#### Type declaration
+
+| Name         | Type       | Description                                       |
+| :----------- | :--------- | :------------------------------------------------ |
+| `commitment` | `string`   | The commitment of the per VO spent voice credits. |
+| `salt`       | `string`   | The salt of the per VO spent voice credits.       |
+| `tally`      | `string`[] | The tally of the per VO spent voice credits.      |
+
+#### Defined in
+
+[utils/interfaces.ts:111](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L111)
+
+---
+
+### pollId
+
+• **pollId**: `string`
+
+The ID of the poll.
+
+#### Defined in
+
+[utils/interfaces.ts:40](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L40)
+
+---
+
+### results
+
+• **results**: `Object`
+
+The results of the poll.
+
+#### Type declaration
+
+| Name         | Type       | Description                    |
+| :----------- | :--------- | :----------------------------- |
+| `commitment` | `string`   | The commitment of the results. |
+| `salt`       | `string`   | The salt of the results.       |
+| `tally`      | `string`[] | The tally of the results.      |
+
+#### Defined in
+
+[utils/interfaces.ts:71](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L71)
+
+---
+
+### tallyAddress
+
+• **tallyAddress**: `string`
+
+The address of the Tally contract.
+
+#### Defined in
+
+[utils/interfaces.ts:61](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L61)
+
+---
+
+### totalSpentVoiceCredits
+
+• **totalSpentVoiceCredits**: `Object`
+
+The total spent voice credits.
+
+#### Type declaration
+
+| Name         | Type     | Description                                |
+| :----------- | :------- | :----------------------------------------- |
+| `commitment` | `string` | The commitment of the spent voice credits. |
+| `salt`       | `string` | The salt of the spent voice credits.       |
+| `spent`      | `string` | The spent voice credits.                   |
+
+#### Defined in
+
+[utils/interfaces.ts:91](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L91)

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

@@ -0,0 +1,89 @@
+---
+title: TopupArgs
+sidebar_label: TopupArgs
+---
+
+Interface for the arguments to the topup command
+
+## Table of contents
+
+### Properties
+
+- [amount](TopupArgs.md#amount)
+- [maciAddress](TopupArgs.md#maciaddress)
+- [pollId](TopupArgs.md#pollid)
+- [quiet](TopupArgs.md#quiet)
+- [signer](TopupArgs.md#signer)
+- [stateIndex](TopupArgs.md#stateindex)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+The amount to topup
+
+#### Defined in
+
+[utils/interfaces.ts:970](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L970)
+
+---
+
+### maciAddress
+
+• `Optional` **maciAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:985](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L985)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The poll ID
+
+#### Defined in
+
+[utils/interfaces.ts:980](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L980)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:995](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L995)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:990](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L990)
+
+---
+
+### stateIndex
+
+• **stateIndex**: `number`
+
+The state index of the user
+
+#### Defined in
+
+[utils/interfaces.ts:975](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L975)

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

@@ -0,0 +1,128 @@
+---
+title: VerifyArgs
+sidebar_label: VerifyArgs
+---
+
+Interface for the arguments to the verifyProof command
+
+## Table of contents
+
+### Properties
+
+- [maciAddress](VerifyArgs.md#maciaddress)
+- [pollId](VerifyArgs.md#pollid)
+- [quiet](VerifyArgs.md#quiet)
+- [signer](VerifyArgs.md#signer)
+- [subsidyAddress](VerifyArgs.md#subsidyaddress)
+- [subsidyData](VerifyArgs.md#subsidydata)
+- [subsidyEnabled](VerifyArgs.md#subsidyenabled)
+- [tallyAddress](VerifyArgs.md#tallyaddress)
+- [tallyData](VerifyArgs.md#tallydata)
+
+## Properties
+
+### maciAddress
+
+• **maciAddress**: `string`
+
+The address of the MACI contract
+
+#### Defined in
+
+[utils/interfaces.ts:1025](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1025)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+The id of the poll
+
+#### Defined in
+
+[utils/interfaces.ts:1005](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1005)
+
+---
+
+### quiet
+
+• `Optional` **quiet**: `boolean`
+
+Whether to log the output
+
+#### Defined in
+
+[utils/interfaces.ts:1045](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1045)
+
+---
+
+### signer
+
+• **signer**: `Signer`
+
+A signer object
+
+#### Defined in
+
+[utils/interfaces.ts:1015](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1015)
+
+---
+
+### subsidyAddress
+
+• `Optional` **subsidyAddress**: `string`
+
+The address of the Subsidy contract
+
+#### Defined in
+
+[utils/interfaces.ts:1035](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1035)
+
+---
+
+### subsidyData
+
+• `Optional` **subsidyData**: [`SubsidyData`](SubsidyData.md)
+
+The subsidy data
+
+#### Defined in
+
+[utils/interfaces.ts:1040](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1040)
+
+---
+
+### subsidyEnabled
+
+• **subsidyEnabled**: `boolean`
+
+Whether to deploy subsidy contract
+
+#### Defined in
+
+[utils/interfaces.ts:1010](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1010)
+
+---
+
+### tallyAddress
+
+• **tallyAddress**: `string`
+
+The address of the Tally contract
+
+#### Defined in
+
+[utils/interfaces.ts:1030](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1030)
+
+---
+
+### tallyData
+
+• **tallyData**: [`TallyData`](TallyData.md)
+
+The tally data
+
+#### Defined in
+
+[utils/interfaces.ts:1020](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/cli/ts/utils/interfaces.ts#L1020)