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

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

@@ -0,0 +1,110 @@
+---
+title: Core
+sidebar_label: Core
+---
+
+[![NPM Package][core-npm-badge]][core-npm-link]
+[![Actions Status][core-actions-badge]][core-actions-link]
+
+This submodule assists with handling key business logic functions and
+processes.
+
+## Overview
+
+One may conceive of MACI as a state machine with 1) data and 2) functions which
+transform said data. This makes it easier to reason about the system, write
+tests, and implement functionality. It also allows us to implement the smart
+contracts in discrete components which are easy to test.
+
+To this end, this submodule exposes a `MaciState` class and a `Poll` class.
+Developers should instantiate objects from these classes to test MACI. For
+instance, [`MACI.test.ts`](https://github.com/privacy-scaling-explorations/maci/blob/dev/packages/contracts/tests/MACI.test.ts) creates a
+`MaciState` object and every time it interacts with the MACI smart contract, it
+mirrors said interaction on the `MaciState` and `Poll`. As such, the developer
+can then use their helper functions like `maciState.signUp()`,
+`poll.publishMessage`, `poll.processMessages()`, and `poll.tallyVotes()` to
+step through the various stages of the MACI flow.
+
+## `MaciState`
+
+### Key functions
+
+#### **`signUp`**
+
+Accepts a user's public key and creates a new state leaf and ballot leaf.
+
+In testing, whenever a test suite submits a `signUp()` transaction, it should
+call `maciState.signUp()` as well, so that the off-chain representation of MACI
+is kept up to date.
+
+In production, `genMaciStateFromContract()` in
+[`genMaciState.ts`](https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/ts/genMaciState.ts) uses this function when it
+scans a MACI contract's event log for signups, so as to bring its `MaciState`
+instance up to date.
+
+#### **`deployPoll`**
+
+Creates a new `Poll`. This should be done whenever the MACI contract's
+`deployPoll()` function is called.
+
+### Helper functions
+
+#### **`copy`**
+
+A function that deep-copies an object.
+
+### Key data structures
+
+#### **`stateTree`**
+
+`stateTree` is a quinary Merkle tree, chosen over a binary tree due to the gas and circuit constraints associated with the Poseidon hash function ([details here][ethresearch-link]). Each leaf in this tree represents a participant's public key, their voice credit balance and the block timestamp at which they signed up. The tree features a configurable depth and an arity of five, with insertions starting at index 1. The zeroth leaf is reserved as a security measure against denial-of-service attacks.
+
+## **`Poll`**
+
+A `Poll` is an off-chain representation of a Poll. In testing, `Poll` instances
+should mirror their on-chain counterparts.
+
+### Key functions
+
+#### **`publishMessage`**
+
+Publishes a message by updating the message tree and message accumulation
+queue.
+
+#### **`processMessages`**
+
+Processes a batch of messages and returns the inputs to the `processMessages`
+circuit which can be used to prove correct execution.
+
+#### **`tallyVotes`**
+
+Tallies a batch of votes and returns the inputs to the `tallyVotes`
+circuit which can be used to prove correct execution.
+
+### Helper functions
+
+#### **`copy`**
+
+Deep-copies and returns this object.
+
+### Key data structures
+
+#### **`messageTree`**
+
+`messageTree` is also a quinary Merkle tree. Each message in this tree represents an encrypted command, such as a user casting a vote in a poll or changing their public key.
+
+## Testing
+
+For more details about testing please refer to the [tests documentation](https://maci.pse.dev/docs/testing).
+
+[core-npm-badge]: https://img.shields.io/npm/v/maci-core.svg
+[core-npm-link]: https://www.npmjs.com/package/maci-core
+[core-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/core-build.yml/badge.svg
+[core-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Acore
+[ethresearch-link]: https://ethresear.ch/t/gas-and-circuit-constraint-benchmarks-of-binary-and-quinary-incremental-merkle-trees-using-the-poseidon-hash-function/7446
+
+## Directory Structure
+
+- `ts/`: The home for our core classes, `MaciState` and `Poll`
+- `ts/utls/`: Contains supporting utilities
+- `ts/__tests__/`: A dedicated test suite directory

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

@@ -0,0 +1,50 @@
+---
+title: BatchSizes
+sidebar_label: BatchSizes
+---
+
+This interface defines the batch sizes.
+
+## Table of contents
+
+### Properties
+
+- [messageBatchSize](BatchSizes.md#messagebatchsize)
+- [subsidyBatchSize](BatchSizes.md#subsidybatchsize)
+- [tallyBatchSize](BatchSizes.md#tallybatchsize)
+
+## Properties
+
+### messageBatchSize
+
+• **messageBatchSize**: `number`
+
+The size of the message batch.
+
+#### Defined in
+
+[utils/types.ts:46](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L46)
+
+---
+
+### subsidyBatchSize
+
+• **subsidyBatchSize**: `number`
+
+The size of the subsidy batch.
+
+#### Defined in
+
+[utils/types.ts:47](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L47)
+
+---
+
+### tallyBatchSize
+
+• **tallyBatchSize**: `number`
+
+The size of the tally batch.
+
+#### Defined in
+
+[utils/types.ts:45](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L45)

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

@@ -0,0 +1,77 @@
+---
+title: IJsonMaciState
+sidebar_label: IJsonMaciState
+---
+
+This interface defines the JSON representation of a MaciState
+
+## Table of contents
+
+### Properties
+
+- [currentPollBeingProcessed](IJsonMaciState.md#currentpollbeingprocessed)
+- [numSignUps](IJsonMaciState.md#numsignups)
+- [pollBeingProcessed](IJsonMaciState.md#pollbeingprocessed)
+- [polls](IJsonMaciState.md#polls)
+- [stateLeaves](IJsonMaciState.md#stateleaves)
+- [stateTreeDepth](IJsonMaciState.md#statetreedepth)
+
+## Properties
+
+### currentPollBeingProcessed
+
+• **currentPollBeingProcessed**: `string`
+
+#### Defined in
+
+[utils/types.ts:130](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L130)
+
+---
+
+### numSignUps
+
+• **numSignUps**: `number`
+
+#### Defined in
+
+[utils/types.ts:131](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L131)
+
+---
+
+### pollBeingProcessed
+
+• **pollBeingProcessed**: `boolean`
+
+#### Defined in
+
+[utils/types.ts:129](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L129)
+
+---
+
+### polls
+
+• **polls**: `IJsonPoll`[]
+
+#### Defined in
+
+[utils/types.ts:127](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L127)
+
+---
+
+### stateLeaves
+
+• **stateLeaves**: `IJsonStateLeaf`[]
+
+#### Defined in
+
+[utils/types.ts:128](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L128)
+
+---
+
+### stateTreeDepth
+
+• **stateTreeDepth**: `number`
+
+#### Defined in
+
+[utils/types.ts:126](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L126)

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

@@ -0,0 +1,242 @@
+---
+title: IProcessMessagesCircuitInputs
+sidebar_label: IProcessMessagesCircuitInputs
+---
+
+An interface describing the circuit inputs to the ProcessMessage circuit
+
+## Table of contents
+
+### Properties
+
+- [coordPrivKey](IProcessMessagesCircuitInputs.md#coordprivkey)
+- [coordPubKey](IProcessMessagesCircuitInputs.md#coordpubkey)
+- [currentBallotRoot](IProcessMessagesCircuitInputs.md#currentballotroot)
+- [currentBallots](IProcessMessagesCircuitInputs.md#currentballots)
+- [currentBallotsPathElements](IProcessMessagesCircuitInputs.md#currentballotspathelements)
+- [currentSbCommitment](IProcessMessagesCircuitInputs.md#currentsbcommitment)
+- [currentSbSalt](IProcessMessagesCircuitInputs.md#currentsbsalt)
+- [currentStateLeaves](IProcessMessagesCircuitInputs.md#currentstateleaves)
+- [currentStateLeavesPathElements](IProcessMessagesCircuitInputs.md#currentstateleavespathelements)
+- [currentStateRoot](IProcessMessagesCircuitInputs.md#currentstateroot)
+- [currentVoteWeights](IProcessMessagesCircuitInputs.md#currentvoteweights)
+- [currentVoteWeightsPathElements](IProcessMessagesCircuitInputs.md#currentvoteweightspathelements)
+- [encPubKeys](IProcessMessagesCircuitInputs.md#encpubkeys)
+- [inputHash](IProcessMessagesCircuitInputs.md#inputhash)
+- [msgRoot](IProcessMessagesCircuitInputs.md#msgroot)
+- [msgSubrootPathElements](IProcessMessagesCircuitInputs.md#msgsubrootpathelements)
+- [msgs](IProcessMessagesCircuitInputs.md#msgs)
+- [newSbCommitment](IProcessMessagesCircuitInputs.md#newsbcommitment)
+- [newSbSalt](IProcessMessagesCircuitInputs.md#newsbsalt)
+- [packedVals](IProcessMessagesCircuitInputs.md#packedvals)
+- [pollEndTimestamp](IProcessMessagesCircuitInputs.md#pollendtimestamp)
+
+## Properties
+
+### coordPrivKey
+
+• **coordPrivKey**: `string`
+
+#### Defined in
+
+[utils/types.ts:159](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L159)
+
+---
+
+### coordPubKey
+
+• **coordPubKey**: `string`
+
+#### Defined in
+
+[utils/types.ts:160](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L160)
+
+---
+
+### currentBallotRoot
+
+• **currentBallotRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:163](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L163)
+
+---
+
+### currentBallots
+
+• **currentBallots**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:168](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L168)
+
+---
+
+### currentBallotsPathElements
+
+• **currentBallotsPathElements**: `string`[][]
+
+#### Defined in
+
+[utils/types.ts:169](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L169)
+
+---
+
+### currentSbCommitment
+
+• **currentSbCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:164](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L164)
+
+---
+
+### currentSbSalt
+
+• **currentSbSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:165](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L165)
+
+---
+
+### currentStateLeaves
+
+• **currentStateLeaves**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:166](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L166)
+
+---
+
+### currentStateLeavesPathElements
+
+• **currentStateLeavesPathElements**: `string`[][]
+
+#### Defined in
+
+[utils/types.ts:167](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L167)
+
+---
+
+### currentStateRoot
+
+• **currentStateRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:162](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L162)
+
+---
+
+### currentVoteWeights
+
+• **currentVoteWeights**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:170](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L170)
+
+---
+
+### currentVoteWeightsPathElements
+
+• **currentVoteWeightsPathElements**: `string`[][]
+
+#### Defined in
+
+[utils/types.ts:171](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L171)
+
+---
+
+### encPubKeys
+
+• **encPubKeys**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:161](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L161)
+
+---
+
+### inputHash
+
+• **inputHash**: `string`
+
+#### Defined in
+
+[utils/types.ts:172](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L172)
+
+---
+
+### msgRoot
+
+• **msgRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:156](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L156)
+
+---
+
+### msgSubrootPathElements
+
+• **msgSubrootPathElements**: `string`[][]
+
+#### Defined in
+
+[utils/types.ts:158](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L158)
+
+---
+
+### msgs
+
+• **msgs**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:157](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L157)
+
+---
+
+### newSbCommitment
+
+• **newSbCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:174](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L174)
+
+---
+
+### newSbSalt
+
+• **newSbSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:173](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L173)
+
+---
+
+### packedVals
+
+• **packedVals**: `string`
+
+#### Defined in
+
+[utils/types.ts:155](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L155)
+
+---
+
+### pollEndTimestamp
+
+• **pollEndTimestamp**: `string`
+
+#### Defined in
+
+[utils/types.ts:154](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L154)

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

@@ -0,0 +1,198 @@
+---
+title: ISubsidyCircuitInputs
+sidebar_label: ISubsidyCircuitInputs
+---
+
+An interface describing the circuit inputs to the Subsidy circuit
+
+## Table of contents
+
+### Properties
+
+- [ballotPathElements1](ISubsidyCircuitInputs.md#ballotpathelements1)
+- [ballotPathElements2](ISubsidyCircuitInputs.md#ballotpathelements2)
+- [ballotRoot](ISubsidyCircuitInputs.md#ballotroot)
+- [ballots1](ISubsidyCircuitInputs.md#ballots1)
+- [ballots2](ISubsidyCircuitInputs.md#ballots2)
+- [currentSubsidy](ISubsidyCircuitInputs.md#currentsubsidy)
+- [currentSubsidyCommitment](ISubsidyCircuitInputs.md#currentsubsidycommitment)
+- [currentSubsidySalt](ISubsidyCircuitInputs.md#currentsubsidysalt)
+- [inputHash](ISubsidyCircuitInputs.md#inputhash)
+- [newSubsidyCommitment](ISubsidyCircuitInputs.md#newsubsidycommitment)
+- [newSubsidySalt](ISubsidyCircuitInputs.md#newsubsidysalt)
+- [packedVals](ISubsidyCircuitInputs.md#packedvals)
+- [sbCommitment](ISubsidyCircuitInputs.md#sbcommitment)
+- [sbSalt](ISubsidyCircuitInputs.md#sbsalt)
+- [stateRoot](ISubsidyCircuitInputs.md#stateroot)
+- [votes1](ISubsidyCircuitInputs.md#votes1)
+- [votes2](ISubsidyCircuitInputs.md#votes2)
+
+## Properties
+
+### ballotPathElements1
+
+• **ballotPathElements1**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:222](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L222)
+
+---
+
+### ballotPathElements2
+
+• **ballotPathElements2**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:223](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L223)
+
+---
+
+### ballotRoot
+
+• **ballotRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:208](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L208)
+
+---
+
+### ballots1
+
+• **ballots1**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:218](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L218)
+
+---
+
+### ballots2
+
+• **ballots2**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:219](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L219)
+
+---
+
+### currentSubsidy
+
+• **currentSubsidy**: `string`[]
+
+#### Defined in
+
+[utils/types.ts:215](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L215)
+
+---
+
+### currentSubsidyCommitment
+
+• **currentSubsidyCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:213](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L213)
+
+---
+
+### currentSubsidySalt
+
+• **currentSubsidySalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:210](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L210)
+
+---
+
+### inputHash
+
+• **inputHash**: `string`
+
+#### Defined in
+
+[utils/types.ts:217](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L217)
+
+---
+
+### newSubsidyCommitment
+
+• **newSubsidyCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:214](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L214)
+
+---
+
+### newSubsidySalt
+
+• **newSubsidySalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:211](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L211)
+
+---
+
+### packedVals
+
+• **packedVals**: `string`
+
+#### Defined in
+
+[utils/types.ts:216](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L216)
+
+---
+
+### sbCommitment
+
+• **sbCommitment**: `string`
+
+#### Defined in
+
+[utils/types.ts:212](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L212)
+
+---
+
+### sbSalt
+
+• **sbSalt**: `string`
+
+#### Defined in
+
+[utils/types.ts:209](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L209)
+
+---
+
+### stateRoot
+
+• **stateRoot**: `string`
+
+#### Defined in
+
+[utils/types.ts:207](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L207)
+
+---
+
+### votes1
+
+• **votes1**: `number`[]
+
+#### Defined in
+
+[utils/types.ts:220](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L220)
+
+---
+
+### votes2
+
+• **votes2**: `number`[]
+
+#### Defined in
+
+[utils/types.ts:221](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/core/ts/utils/types.ts#L221)