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

package/versioned_docs/version-v1.2/typedoc/core/interfaces/ITallyCircuitInputs.md

@@ -0,0 +1,231 @@
+---
+title: ITallyCircuitInputs
+sidebar_label: ITallyCircuitInputs
+---
+
+An interface describing the circuit inputs to the TallyVotes circuit
+
+## Table of contents
+
+### Properties
+
+- [ballotPathElements](ITallyCircuitInputs.md#ballotpathelements)
+- [ballotRoot](ITallyCircuitInputs.md#ballotroot)
+- [ballots](ITallyCircuitInputs.md#ballots)
+- [currentPerVOSpentVoiceCredits](ITallyCircuitInputs.md#currentpervospentvoicecredits)
+- [currentPerVOSpentVoiceCreditsRootSalt](ITallyCircuitInputs.md#currentpervospentvoicecreditsrootsalt)
+- [currentResults](ITallyCircuitInputs.md#currentresults)
+- [currentResultsRootSalt](ITallyCircuitInputs.md#currentresultsrootsalt)
+- [currentSpentVoiceCreditSubtotal](ITallyCircuitInputs.md#currentspentvoicecreditsubtotal)
+- [currentSpentVoiceCreditSubtotalSalt](ITallyCircuitInputs.md#currentspentvoicecreditsubtotalsalt)
+- [currentTallyCommitment](ITallyCircuitInputs.md#currenttallycommitment)
+- [inputHash](ITallyCircuitInputs.md#inputhash)
+- [newPerVOSpentVoiceCreditsRootSalt](ITallyCircuitInputs.md#newpervospentvoicecreditsrootsalt)
+- [newResultsRootSalt](ITallyCircuitInputs.md#newresultsrootsalt)
+- [newSpentVoiceCreditSubtotalSalt](ITallyCircuitInputs.md#newspentvoicecreditsubtotalsalt)
+- [newTallyCommitment](ITallyCircuitInputs.md#newtallycommitment)
+- [packedVals](ITallyCircuitInputs.md#packedvals)
+- [sbCommitment](ITallyCircuitInputs.md#sbcommitment)
+- [sbSalt](ITallyCircuitInputs.md#sbsalt)
+- [stateRoot](ITallyCircuitInputs.md#stateroot)
+- [votes](ITallyCircuitInputs.md#votes)
+
+## Properties
+
+### ballotPathElements
+
+• **ballotPathElements**: `PathElements`
+
+#### Defined in
+
+[utils/types.ts:190](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L190)
+
+---
+
+### ballotRoot
+
+• **ballotRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:182](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L182)
+
+---
+
+### ballots
+
+• **ballots**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:189](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L189)
+
+---
+
+### currentPerVOSpentVoiceCredits
+
+• `Optional` **currentPerVOSpentVoiceCredits**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:196](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L196)
+
+---
+
+### currentPerVOSpentVoiceCreditsRootSalt
+
+• `Optional` **currentPerVOSpentVoiceCreditsRootSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:197](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L197)
+
+---
+
+### currentResults
+
+• **currentResults**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:192](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L192)
+
+---
+
+### currentResultsRootSalt
+
+• **currentResultsRootSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:193](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L193)
+
+---
+
+### currentSpentVoiceCreditSubtotal
+
+• **currentSpentVoiceCreditSubtotal**: `string`
+
+#### Defined in
+
+[utils/types.ts:194](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L194)
+
+---
+
+### currentSpentVoiceCreditSubtotalSalt
+
+• **currentSpentVoiceCreditSubtotalSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:195](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L195)
+
+---
+
+### currentTallyCommitment
+
+• **currentTallyCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:185](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L185)
+
+---
+
+### inputHash
+
+• **inputHash**: `string`
+
+#### Defined in
+
+[utils/types.ts:188](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L188)
+
+---
+
+### newPerVOSpentVoiceCreditsRootSalt
+
+• `Optional` **newPerVOSpentVoiceCreditsRootSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:199](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L199)
+
+---
+
+### newResultsRootSalt
+
+• **newResultsRootSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:198](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L198)
+
+---
+
+### newSpentVoiceCreditSubtotalSalt
+
+• **newSpentVoiceCreditSubtotalSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:200](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L200)
+
+---
+
+### newTallyCommitment
+
+• **newTallyCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:186](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L186)
+
+---
+
+### packedVals
+
+• **packedVals**: `string`
+
+#### Defined in
+
+[utils/types.ts:187](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L187)
+
+---
+
+### sbCommitment
+
+• **sbCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:184](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L184)
+
+---
+
+### sbSalt
+
+• **sbSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:183](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L183)
+
+---
+
+### stateRoot
+
+• **stateRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:181](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L181)
+
+---
+
+### votes
+
+• **votes**: `string`[][]
+
+#### Defined in
+
+[utils/types.ts:191](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L191)

package/versioned_docs/version-v1.2/typedoc/core/interfaces/MaxValues.md

@@ -0,0 +1,37 @@
+---
+title: MaxValues
+sidebar_label: MaxValues
+---
+
+This interface defines the maximum values that the circuit can handle.
+
+## Table of contents
+
+### Properties
+
+- [maxMessages](MaxValues.md#maxmessages)
+- [maxVoteOptions](MaxValues.md#maxvoteoptions)
+
+## Properties
+
+### maxMessages
+
+• **maxMessages**: `number`
+
+The maximum number of messages.
+
+#### Defined in
+
+[utils/types.ts:56](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L56)
+
+---
+
+### maxVoteOptions
+
+• **maxVoteOptions**: `number`
+
+The maximum number of vote options.
+
+#### Defined in
+
+[utils/types.ts:57](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L57)

package/versioned_docs/version-v1.2/typedoc/core/interfaces/TreeDepths.md

@@ -0,0 +1,63 @@
+---
+title: TreeDepths
+sidebar_label: TreeDepths
+---
+
+This interface defines the tree depths.
+
+## Table of contents
+
+### Properties
+
+- [intStateTreeDepth](TreeDepths.md#intstatetreedepth)
+- [messageTreeDepth](TreeDepths.md#messagetreedepth)
+- [messageTreeSubDepth](TreeDepths.md#messagetreesubdepth)
+- [voteOptionTreeDepth](TreeDepths.md#voteoptiontreedepth)
+
+## Properties
+
+### intStateTreeDepth
+
+• **intStateTreeDepth**: `number`
+
+The depth of the intermediate state tree.
+
+#### Defined in
+
+[utils/types.ts:32](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L32)
+
+---
+
+### messageTreeDepth
+
+• **messageTreeDepth**: `number`
+
+The depth of the message tree.
+
+#### Defined in
+
+[utils/types.ts:33](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L33)
+
+---
+
+### messageTreeSubDepth
+
+• **messageTreeSubDepth**: `number`
+
+The depth of the message tree sub.
+
+#### Defined in
+
+[utils/types.ts:34](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L34)
+
+---
+
+### voteOptionTreeDepth
+
+• **voteOptionTreeDepth**: `number`
+
+The depth of the vote option tree.
+
+#### Defined in
+
+[utils/types.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L35)

package/versioned_docs/version-v1.2/typedoc/core/modules.md

@@ -0,0 +1,289 @@
+---
+title: Core Module
+sidebar_label: module
+sidebar_position: 1
+---
+
+## Table of contents
+
+### Classes
+
+- [MaciState](classes/MaciState.md)
+- [Poll](classes/Poll.md)
+
+### Interfaces
+
+- [BatchSizes](interfaces/BatchSizes.md)
+- [IJsonMaciState](interfaces/IJsonMaciState.md)
+- [IProcessMessagesCircuitInputs](interfaces/IProcessMessagesCircuitInputs.md)
+- [ISubsidyCircuitInputs](interfaces/ISubsidyCircuitInputs.md)
+- [ITallyCircuitInputs](interfaces/ITallyCircuitInputs.md)
+- [MaxValues](interfaces/MaxValues.md)
+- [TreeDepths](interfaces/TreeDepths.md)
+
+### Type Aliases
+
+- [CircuitInputs](modules.md#circuitinputs)
+
+### Variables
+
+- [STATE_TREE_ARITY](modules.md#state_tree_arity)
+
+### Functions
+
+- [genProcessVkSig](modules.md#genprocessvksig)
+- [genSubsidyVkSig](modules.md#gensubsidyvksig)
+- [genTallyVkSig](modules.md#gentallyvksig)
+- [packProcessMessageSmallVals](modules.md#packprocessmessagesmallvals)
+- [packSubsidySmallVals](modules.md#packsubsidysmallvals)
+- [packTallyVotesSmallVals](modules.md#packtallyvotessmallvals)
+- [unpackProcessMessageSmallVals](modules.md#unpackprocessmessagesmallvals)
+- [unpackTallyVotesSmallVals](modules.md#unpacktallyvotessmallvals)
+
+## Type Aliases
+
+### CircuitInputs
+
+Ƭ **CircuitInputs**: `Record`\<`string`, `string` \| `bigint` \| `bigint`[] \| `bigint`[][] \| `string`[] \| `bigint`[][][]\>
+
+A circuit inputs for the circom circuit
+
+#### Defined in
+
+[utils/types.ts:22](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L22)
+
+## Variables
+
+### STATE_TREE_ARITY
+
+• `Const` **STATE_TREE_ARITY**: `5`
+
+#### Defined in
+
+[utils/constants.ts:2](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/constants.ts#L2)
+
+## Functions
+
+### genProcessVkSig
+
+▸ **genProcessVkSig**(`stateTreeDepth`, `messageTreeDepth`, `voteOptionTreeDepth`, `batchSize`): `bigint`
+
+This function generates the signature of a ProcessMessage Verifying Key(VK).
+This can be used to check if a ProcessMessages' circuit VK is registered
+in a smart contract that holds several VKs.
+
+#### Parameters
+
+| Name                  | Type     | Description                        |
+| :-------------------- | :------- | :--------------------------------- |
+| `stateTreeDepth`      | `number` | The depth of the state tree.       |
+| `messageTreeDepth`    | `number` | The depth of the message tree.     |
+| `voteOptionTreeDepth` | `number` | The depth of the vote option tree. |
+| `batchSize`           | `number` | The size of the batch.             |
+
+#### Returns
+
+`bigint`
+
+Returns a signature for querying if a verifying key with the given parameters is already registered in the contract.
+
+#### Defined in
+
+[utils/utils.ts:14](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L14)
+
+---
+
+### genSubsidyVkSig
+
+▸ **genSubsidyVkSig**(`_stateTreeDepth`, `_intStateTreeDepth`, `_voteOptionTreeDepth`): `bigint`
+
+This function generates the signature of a Subsidy Verifying Key(VK).
+This can be used to check if a SubsidyCalculations' circuit VK is registered
+in a smart contract that holds several VKs.
+
+#### Parameters
+
+| Name                   | Type     | Description                               |
+| :--------------------- | :------- | :---------------------------------------- |
+| `_stateTreeDepth`      | `number` | The depth of the state tree.              |
+| `_intStateTreeDepth`   | `number` | The depth of the intermediate state tree. |
+| `_voteOptionTreeDepth` | `number` | The depth of the vote option tree.        |
+
+#### Returns
+
+`bigint`
+
+Returns a signature for querying if a verifying key with
+the given parameters is already registered in the contract.
+
+#### Defined in
+
+[utils/utils.ts:51](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L51)
+
+---
+
+### genTallyVkSig
+
+▸ **genTallyVkSig**(`_stateTreeDepth`, `_intStateTreeDepth`, `_voteOptionTreeDepth`): `bigint`
+
+This function generates the signature of a Tally Verifying Key(VK).
+This can be used to check if a TallyVotes' circuit VK is registered
+in a smart contract that holds several VKs.
+
+#### Parameters
+
+| Name                   | Type     | Description                               |
+| :--------------------- | :------- | :---------------------------------------- |
+| `_stateTreeDepth`      | `number` | The depth of the state tree.              |
+| `_intStateTreeDepth`   | `number` | The depth of the intermediate state tree. |
+| `_voteOptionTreeDepth` | `number` | The depth of the vote option tree.        |
+
+#### Returns
+
+`bigint`
+
+Returns a signature for querying if a verifying key with
+the given parameters is already registered in the contract.
+
+#### Defined in
+
+[utils/utils.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L35)
+
+---
+
+### packProcessMessageSmallVals
+
+▸ **packProcessMessageSmallVals**(`maxVoteOptions`, `numUsers`, `batchStartIndex`, `batchEndIndex`): `bigint`
+
+This function packs it's parameters into a single bigint.
+
+#### Parameters
+
+| Name              | Type     | Description                         |
+| :---------------- | :------- | :---------------------------------- |
+| `maxVoteOptions`  | `bigint` | The maximum number of vote options. |
+| `numUsers`        | `bigint` | The number of users.                |
+| `batchStartIndex` | `number` | The start index of the batch.       |
+| `batchEndIndex`   | `number` | The end index of the batch.         |
+
+#### Returns
+
+`bigint`
+
+Returns a single bigint that contains the packed values.
+
+#### Defined in
+
+[utils/utils.ts:65](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L65)
+
+---
+
+### packSubsidySmallVals
+
+▸ **packSubsidySmallVals**(`row`, `col`, `numSignUps`): `bigint`
+
+This function packs it's parameters into a single bigint.
+
+#### Parameters
+
+| Name         | Type     | Description            |
+| :----------- | :------- | :--------------------- |
+| `row`        | `number` | The row.               |
+| `col`        | `number` | The column.            |
+| `numSignUps` | `number` | The number of signups. |
+
+#### Returns
+
+`bigint`
+
+Returns a single bigint that contains the packed values.
+
+#### Defined in
+
+[utils/utils.ts:150](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L150)
+
+---
+
+### packTallyVotesSmallVals
+
+▸ **packTallyVotesSmallVals**(`batchStartIndex`, `batchSize`, `numSignUps`): `bigint`
+
+This function packs it's parameters into a single bigint.
+
+#### Parameters
+
+| Name              | Type     | Description                   |
+| :---------------- | :------- | :---------------------------- |
+| `batchStartIndex` | `number` | The start index of the batch. |
+| `batchSize`       | `number` | The size of the batch.        |
+| `numSignUps`      | `number` | The number of signups.        |
+
+#### Returns
+
+`bigint`
+
+Returns a single bigint that contains the packed values.
+
+#### Defined in
+
+[utils/utils.ts:119](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L119)
+
+---
+
+### unpackProcessMessageSmallVals
+
+▸ **unpackProcessMessageSmallVals**(`packedVals`): `Object`
+
+This function unpacks partial values for the ProcessMessages circuit from a single bigint.
+
+#### Parameters
+
+| Name         | Type     | Description                                        |
+| :----------- | :------- | :------------------------------------------------- |
+| `packedVals` | `bigint` | The single bigint that contains the packed values. |
+
+#### Returns
+
+`Object`
+
+Returns an object that contains the unpacked values.
+
+| Name              | Type     |
+| :---------------- | :------- |
+| `batchEndIndex`   | `bigint` |
+| `batchStartIndex` | `bigint` |
+| `maxVoteOptions`  | `bigint` |
+| `numUsers`        | `bigint` |
+
+#### Defined in
+
+[utils/utils.ts:86](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L86)
+
+---
+
+### unpackTallyVotesSmallVals
+
+▸ **unpackTallyVotesSmallVals**(`packedVals`): `Object`
+
+This function unpacks partial values for the TallyVotes circuit from a single bigint.
+
+#### Parameters
+
+| Name         | Type     | Description                                        |
+| :----------- | :------- | :------------------------------------------------- |
+| `packedVals` | `bigint` | The single bigint that contains the packed values. |
+
+#### Returns
+
+`Object`
+
+Returns an object that contains the unpacked values.
+
+| Name              | Type     |
+| :---------------- | :------- |
+| `batchStartIndex` | `bigint` |
+| `numSignUps`      | `bigint` |
+
+#### Defined in
+
+[utils/utils.ts:131](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/utils.ts#L131)

package/versioned_docs/version-v1.2/typedoc/crypto/.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.