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

package/versioned_docs/version-v1.2/typedoc/domainobjs/.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/domainobjs/classes/Ballot.md

@@ -0,0 +1,274 @@
+---
+title: Ballot
+sidebar_label: Ballot
+---
+
+A Ballot represents a User's votes in a Poll, as well as their next valid
+nonce.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Ballot.md#constructor)
+
+### Properties
+
+- [nonce](Ballot.md#nonce)
+- [voteOptionTreeDepth](Ballot.md#voteoptiontreedepth)
+- [votes](Ballot.md#votes)
+
+### Methods
+
+- [asArray](Ballot.md#asarray)
+- [asCircuitInputs](Ballot.md#ascircuitinputs)
+- [copy](Ballot.md#copy)
+- [equals](Ballot.md#equals)
+- [hash](Ballot.md#hash)
+- [toJSON](Ballot.md#tojson)
+- [fromJSON](Ballot.md#fromjson)
+- [genBlankBallot](Ballot.md#genblankballot)
+- [genRandomBallot](Ballot.md#genrandomballot)
+
+## Constructors
+
+### constructor
+
+• **new Ballot**(`_numVoteOptions`, `_voteOptionTreeDepth`): [`Ballot`](Ballot.md)
+
+Create a new Ballot instance
+
+#### Parameters
+
+| Name                   | Type     | Description                                           |
+| :--------------------- | :------- | :---------------------------------------------------- |
+| `_numVoteOptions`      | `number` | How many vote options are available in the poll       |
+| `_voteOptionTreeDepth` | `number` | The depth of the merkle tree holding the vote options |
+
+#### Returns
+
+[`Ballot`](Ballot.md)
+
+#### Defined in
+
+[ballot.ts:23](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L23)
+
+## Properties
+
+### nonce
+
+• **nonce**: `bigint`
+
+#### Defined in
+
+[ballot.ts:14](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L14)
+
+---
+
+### voteOptionTreeDepth
+
+• **voteOptionTreeDepth**: `number`
+
+#### Defined in
+
+[ballot.ts:16](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L16)
+
+---
+
+### votes
+
+• **votes**: `bigint`[] = `[]`
+
+#### Defined in
+
+[ballot.ts:12](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L12)
+
+## Methods
+
+### asArray
+
+▸ **asArray**(): `bigint`[]
+
+Convert in a an array of bigints
+
+#### Returns
+
+`bigint`[]
+
+the ballot as a bigint array
+
+**`Notice`**
+
+this is the nonce and the root of the vote option tree
+
+#### Defined in
+
+[ballot.ts:52](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L52)
+
+---
+
+### asCircuitInputs
+
+▸ **asCircuitInputs**(): `bigint`[]
+
+Convert in a format suitable for the circuit
+
+#### Returns
+
+`bigint`[]
+
+the ballot as a BigInt array
+
+#### Defined in
+
+[ballot.ts:45](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L45)
+
+---
+
+### copy
+
+▸ **copy**(): [`Ballot`](Ballot.md)
+
+Create a deep clone of this Ballot
+
+#### Returns
+
+[`Ballot`](Ballot.md)
+
+a copy of the ballot
+
+#### Defined in
+
+[ballot.ts:68](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L68)
+
+---
+
+### equals
+
+▸ **equals**(`b`): `boolean`
+
+Check if two ballots are equal (same votes and same nonce)
+
+#### Parameters
+
+| Name | Type                  | Description                |
+| :--- | :-------------------- | :------------------------- |
+| `b`  | [`Ballot`](Ballot.md) | The ballot to compare with |
+
+#### Returns
+
+`boolean`
+
+whether the two ballots are equal
+
+#### Defined in
+
+[ballot.ts:81](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L81)
+
+---
+
+### hash
+
+▸ **hash**(): `bigint`
+
+Generate an hash of this ballot
+
+#### Returns
+
+`bigint`
+
+The hash of the ballot
+
+#### Defined in
+
+[ballot.ts:36](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L36)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IJsonBallot`](../interfaces/IJsonBallot.md)
+
+Serialize to a JSON object
+
+#### Returns
+
+[`IJsonBallot`](../interfaces/IJsonBallot.md)
+
+#### Defined in
+
+[ballot.ts:112](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L112)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`Ballot`](Ballot.md)
+
+Deserialize into a Ballot instance
+
+#### Parameters
+
+| Name   | Type                                          | Description             |
+| :----- | :-------------------------------------------- | :---------------------- |
+| `json` | [`IJsonBallot`](../interfaces/IJsonBallot.md) | the json representation |
+
+#### Returns
+
+[`Ballot`](Ballot.md)
+
+the deserialized object as a Ballot instance
+
+#### Defined in
+
+[ballot.ts:125](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L125)
+
+---
+
+### genBlankBallot
+
+▸ **genBlankBallot**(`numVoteOptions`, `voteOptionTreeDepth`): [`Ballot`](Ballot.md)
+
+Generate a blank ballot
+
+#### Parameters
+
+| Name                  | Type     | Description                                          |
+| :-------------------- | :------- | :--------------------------------------------------- |
+| `numVoteOptions`      | `number` | How many vote options are available                  |
+| `voteOptionTreeDepth` | `number` | How deep is the merkle tree holding the vote options |
+
+#### Returns
+
+[`Ballot`](Ballot.md)
+
+a Blank Ballot object
+
+#### Defined in
+
+[ballot.ts:104](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L104)
+
+---
+
+### genRandomBallot
+
+▸ **genRandomBallot**(`numVoteOptions`, `voteOptionTreeDepth`): [`Ballot`](Ballot.md)
+
+Generate a random ballot
+
+#### Parameters
+
+| Name                  | Type     | Description                                          |
+| :-------------------- | :------- | :--------------------------------------------------- |
+| `numVoteOptions`      | `number` | How many vote options are available                  |
+| `voteOptionTreeDepth` | `number` | How deep is the merkle tree holding the vote options |
+
+#### Returns
+
+[`Ballot`](Ballot.md)
+
+a random Ballot
+
+#### Defined in
+
+[ballot.ts:92](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/ballot.ts#L92)

package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Keypair.md

@@ -0,0 +1,181 @@
+---
+title: Keypair
+sidebar_label: Keypair
+---
+
+**`Notice`**
+
+A KeyPair is a pair of public and private keys
+This is a MACI keypair, which is not to be
+confused with an Ethereum public and private keypair.
+A MACI keypair is comprised of a MACI public key and a MACI private key
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Keypair.md#constructor)
+
+### Properties
+
+- [privKey](Keypair.md#privkey)
+- [pubKey](Keypair.md#pubkey)
+
+### Methods
+
+- [copy](Keypair.md#copy)
+- [equals](Keypair.md#equals)
+- [toJSON](Keypair.md#tojson)
+- [fromJSON](Keypair.md#fromjson)
+- [genEcdhSharedKey](Keypair.md#genecdhsharedkey)
+
+## Constructors
+
+### constructor
+
+• **new Keypair**(`privKey?`): [`Keypair`](Keypair.md)
+
+Create a new instance of a Keypair
+
+#### Parameters
+
+| Name       | Type                    | Description                |
+| :--------- | :---------------------- | :------------------------- |
+| `privKey?` | [`PrivKey`](PrivKey.md) | the private key (optional) |
+
+#### Returns
+
+[`Keypair`](Keypair.md)
+
+**`Notice`**
+
+if no privKey is passed, it will automatically generate a new private key
+
+#### Defined in
+
+[keyPair.ts:26](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L26)
+
+## Properties
+
+### privKey
+
+• **privKey**: [`PrivKey`](PrivKey.md)
+
+#### Defined in
+
+[keyPair.ts:17](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L17)
+
+---
+
+### pubKey
+
+• **pubKey**: [`PubKey`](PubKey.md)
+
+#### Defined in
+
+[keyPair.ts:19](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L19)
+
+## Methods
+
+### copy
+
+▸ **copy**(): [`Keypair`](Keypair.md)
+
+Create a deep clone of this Keypair
+
+#### Returns
+
+[`Keypair`](Keypair.md)
+
+a copy of the Keypair
+
+#### Defined in
+
+[keyPair.ts:41](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L41)
+
+---
+
+### equals
+
+▸ **equals**(`keypair`): `boolean`
+
+Check whether two Keypairs are equal
+
+#### Parameters
+
+| Name      | Type                    | Description                 |
+| :-------- | :---------------------- | :-------------------------- |
+| `keypair` | [`Keypair`](Keypair.md) | the keypair to compare with |
+
+#### Returns
+
+`boolean`
+
+whether they are equal or not
+
+#### Defined in
+
+[keyPair.ts:58](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L58)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IJsonKeyPair`](../interfaces/IJsonKeyPair.md)
+
+Serialize into a JSON object
+
+#### Returns
+
+[`IJsonKeyPair`](../interfaces/IJsonKeyPair.md)
+
+#### Defined in
+
+[keyPair.ts:75](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L75)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`Keypair`](Keypair.md)
+
+Deserialize into a Keypair instance
+
+#### Parameters
+
+| Name   | Type                                            |
+| :----- | :---------------------------------------------- |
+| `json` | [`IJsonKeyPair`](../interfaces/IJsonKeyPair.md) |
+
+#### Returns
+
+[`Keypair`](Keypair.md)
+
+a keypair instance
+
+#### Defined in
+
+[keyPair.ts:87](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L87)
+
+---
+
+### genEcdhSharedKey
+
+▸ **genEcdhSharedKey**(`privKey`, `pubKey`): `EcdhSharedKey`
+
+Generate a shared key
+
+#### Parameters
+
+| Name      | Type                    |
+| :-------- | :---------------------- |
+| `privKey` | [`PrivKey`](PrivKey.md) |
+| `pubKey`  | [`PubKey`](PubKey.md)   |
+
+#### Returns
+
+`EcdhSharedKey`
+
+#### Defined in
+
+[keyPair.ts:49](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/keyPair.ts#L49)

package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Message.md

@@ -0,0 +1,244 @@
+---
+title: Message
+sidebar_label: Message
+---
+
+**`Notice`**
+
+An encrypted command and signature.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Message.md#constructor)
+
+### Properties
+
+- [data](Message.md#data)
+- [msgType](Message.md#msgtype)
+- [DATA_LENGTH](Message.md#data_length)
+
+### Methods
+
+- [asArray](Message.md#asarray)
+- [asCircuitInputs](Message.md#ascircuitinputs)
+- [asContractParam](Message.md#ascontractparam)
+- [copy](Message.md#copy)
+- [equals](Message.md#equals)
+- [hash](Message.md#hash)
+- [toJSON](Message.md#tojson)
+- [fromJSON](Message.md#fromjson)
+
+## Constructors
+
+### constructor
+
+• **new Message**(`msgType`, `data`): [`Message`](Message.md)
+
+Create a new instance of a Message
+
+#### Parameters
+
+| Name      | Type       | Description             |
+| :-------- | :--------- | :---------------------- |
+| `msgType` | `bigint`   | the type of the message |
+| `data`    | `bigint`[] | the data of the message |
+
+#### Returns
+
+[`Message`](Message.md)
+
+#### Defined in
+
+[message.ts:23](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L23)
+
+## Properties
+
+### data
+
+• **data**: `bigint`[]
+
+#### Defined in
+
+[message.ts:14](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L14)
+
+---
+
+### msgType
+
+• **msgType**: `bigint`
+
+#### Defined in
+
+[message.ts:12](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L12)
+
+---
+
+### DATA_LENGTH
+
+▪ `Static` **DATA_LENGTH**: `number` = `10`
+
+#### Defined in
+
+[message.ts:16](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L16)
+
+## Methods
+
+### asArray
+
+▸ **asArray**(): `bigint`[]
+
+Return the message as an array of bigints
+
+#### Returns
+
+`bigint`[]
+
+the message as an array of bigints
+
+#### Defined in
+
+[message.ts:33](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L33)
+
+---
+
+### asCircuitInputs
+
+▸ **asCircuitInputs**(): `bigint`[]
+
+Return the message as a circuit input
+
+#### Returns
+
+`bigint`[]
+
+the message as a circuit input
+
+#### Defined in
+
+[message.ts:48](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L48)
+
+---
+
+### asContractParam
+
+▸ **asContractParam**(): [`IMessageContractParams`](../interfaces/IMessageContractParams.md)
+
+Return the message as a contract param
+
+#### Returns
+
+[`IMessageContractParams`](../interfaces/IMessageContractParams.md)
+
+the message as a contract param
+
+#### Defined in
+
+[message.ts:39](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L39)
+
+---
+
+### copy
+
+▸ **copy**(): [`Message`](Message.md)
+
+Create a copy of the message
+
+#### Returns
+
+[`Message`](Message.md)
+
+a copy of the message
+
+#### Defined in
+
+[message.ts:61](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L61)
+
+---
+
+### equals
+
+▸ **equals**(`m`): `boolean`
+
+Check if two messages are equal
+
+#### Parameters
+
+| Name | Type                    | Description                 |
+| :--- | :---------------------- | :-------------------------- |
+| `m`  | [`Message`](Message.md) | the message to compare with |
+
+#### Returns
+
+`boolean`
+
+the result of the comparison
+
+#### Defined in
+
+[message.ts:72](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L72)
+
+---
+
+### hash
+
+▸ **hash**(`encPubKey`): `bigint`
+
+Hash the message data and a public key
+
+#### Parameters
+
+| Name        | Type                  | Description                                         |
+| :---------- | :-------------------- | :-------------------------------------------------- |
+| `encPubKey` | [`PubKey`](PubKey.md) | the public key that is used to encrypt this message |
+
+#### Returns
+
+`bigint`
+
+the hash of the message data and the public key
+
+#### Defined in
+
+[message.ts:55](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L55)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IMessageContractParams`](../interfaces/IMessageContractParams.md)
+
+Serialize to a JSON object
+
+#### Returns
+
+[`IMessageContractParams`](../interfaces/IMessageContractParams.md)
+
+#### Defined in
+
+[message.ts:86](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L86)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`Message`](Message.md)
+
+Deserialize into a Message instance
+
+#### Parameters
+
+| Name   | Type                                                                | Description             |
+| :----- | :------------------------------------------------------------------ | :---------------------- |
+| `json` | [`IMessageContractParams`](../interfaces/IMessageContractParams.md) | the json representation |
+
+#### Returns
+
+[`Message`](Message.md)
+
+the deserialized object as a Message instance
+
+#### Defined in
+
+[message.ts:95](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/message.ts#L95)