@maci-protocol/website 0.0.0-ci.26f28d6

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

@@ -0,0 +1,200 @@
+---
+title: TCommand
+sidebar_label: TCommand
+---
+
+**`Notice`**
+
+Command for submitting a topup request
+
+## Implements
+
+- [`ICommand`](../interfaces/ICommand.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](TCommand.md#constructor)
+
+### Properties
+
+- [amount](TCommand.md#amount)
+- [cmdType](TCommand.md#cmdtype)
+- [pollId](TCommand.md#pollid)
+- [stateIndex](TCommand.md#stateindex)
+
+### Methods
+
+- [copy](TCommand.md#copy)
+- [equals](TCommand.md#equals)
+- [toJSON](TCommand.md#tojson)
+- [fromJSON](TCommand.md#fromjson)
+
+## Constructors
+
+### constructor
+
+• **new TCommand**(`stateIndex`, `amount`, `pollId`): [`TCommand`](TCommand.md)
+
+Create a new TCommand
+
+#### Parameters
+
+| Name         | Type     | Description                 |
+| :----------- | :------- | :-------------------------- |
+| `stateIndex` | `bigint` | the state index of the user |
+| `amount`     | `bigint` | the amount of voice credits |
+| `pollId`     | `bigint` | the poll ID                 |
+
+#### Returns
+
+[`TCommand`](TCommand.md)
+
+#### Defined in
+
+[commands/TCommand.ts:21](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L21)
+
+## Properties
+
+### amount
+
+• **amount**: `bigint`
+
+#### Defined in
+
+[commands/TCommand.ts:11](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L11)
+
+---
+
+### cmdType
+
+• **cmdType**: `bigint`
+
+#### Implementation of
+
+[ICommand](../interfaces/ICommand.md).[cmdType](../interfaces/ICommand.md#cmdtype)
+
+#### Defined in
+
+[commands/TCommand.ts:7](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L7)
+
+---
+
+### pollId
+
+• **pollId**: `bigint`
+
+#### Defined in
+
+[commands/TCommand.ts:13](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L13)
+
+---
+
+### stateIndex
+
+• **stateIndex**: `bigint`
+
+#### Defined in
+
+[commands/TCommand.ts:9](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L9)
+
+## Methods
+
+### copy
+
+▸ **copy**\<`T`\>(): `T`
+
+Create a deep clone of this TCommand
+
+#### Type parameters
+
+| Name | Type                              |
+| :--- | :-------------------------------- |
+| `T`  | extends [`TCommand`](TCommand.md) |
+
+#### Returns
+
+`T`
+
+a copy of the TCommand
+
+#### Implementation of
+
+[ICommand](../interfaces/ICommand.md).[copy](../interfaces/ICommand.md#copy)
+
+#### Defined in
+
+[commands/TCommand.ts:32](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L32)
+
+---
+
+### equals
+
+▸ **equals**(`command`): `boolean`
+
+Check whether this command has deep equivalence to another command
+
+#### Parameters
+
+| Name      | Type                      | Description                 |
+| :-------- | :------------------------ | :-------------------------- |
+| `command` | [`TCommand`](TCommand.md) | the command to compare with |
+
+#### Returns
+
+`boolean`
+
+whether they are equal or not
+
+#### Implementation of
+
+[ICommand](../interfaces/ICommand.md).[equals](../interfaces/ICommand.md#equals)
+
+#### Defined in
+
+[commands/TCommand.ts:39](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L39)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IJsonTCommand`](../interfaces/IJsonTCommand.md)
+
+Serialize into a JSON object
+
+#### Returns
+
+[`IJsonTCommand`](../interfaces/IJsonTCommand.md)
+
+#### Implementation of
+
+[ICommand](../interfaces/ICommand.md).[toJSON](../interfaces/ICommand.md#tojson)
+
+#### Defined in
+
+[commands/TCommand.ts:48](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L48)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`TCommand`](TCommand.md)
+
+Deserialize into a TCommand object
+
+#### Parameters
+
+| Name   | Type                                              | Description             |
+| :----- | :------------------------------------------------ | :---------------------- |
+| `json` | [`IJsonTCommand`](../interfaces/IJsonTCommand.md) | the json representation |
+
+#### Returns
+
+[`TCommand`](TCommand.md)
+
+the TCommand instance
+
+#### Defined in
+
+[commands/TCommand.ts:62](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/TCommand.ts#L62)

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

@@ -0,0 +1,240 @@
+---
+title: VerifyingKey
+sidebar_label: VerifyingKey
+---
+
+**`Notice`**
+
+A TS Class representing a zk-SNARK VerifyingKey
+
+## Table of contents
+
+### Constructors
+
+- [constructor](VerifyingKey.md#constructor)
+
+### Properties
+
+- [alpha1](VerifyingKey.md#alpha1)
+- [beta2](VerifyingKey.md#beta2)
+- [delta2](VerifyingKey.md#delta2)
+- [gamma2](VerifyingKey.md#gamma2)
+- [ic](VerifyingKey.md#ic)
+
+### Methods
+
+- [asContractParam](VerifyingKey.md#ascontractparam)
+- [copy](VerifyingKey.md#copy)
+- [equals](VerifyingKey.md#equals)
+- [fromContract](VerifyingKey.md#fromcontract)
+- [fromJSON](VerifyingKey.md#fromjson)
+- [fromObj](VerifyingKey.md#fromobj)
+
+## Constructors
+
+### constructor
+
+• **new VerifyingKey**(`alpha1`, `beta2`, `gamma2`, `delta2`, `ic`): [`VerifyingKey`](VerifyingKey.md)
+
+Generate a new VerifyingKey
+
+#### Parameters
+
+| Name     | Type        | Description      |
+| :------- | :---------- | :--------------- |
+| `alpha1` | `G1Point`   | the alpha1 point |
+| `beta2`  | `G2Point`   | the beta2 point  |
+| `gamma2` | `G2Point`   | the gamma2 point |
+| `delta2` | `G2Point`   | the delta2 point |
+| `ic`     | `G1Point`[] | the ic points    |
+
+#### Returns
+
+[`VerifyingKey`](VerifyingKey.md)
+
+#### Defined in
+
+[verifyingKey.ts:27](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L27)
+
+## Properties
+
+### alpha1
+
+• **alpha1**: `G1Point`
+
+#### Defined in
+
+[verifyingKey.ts:9](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L9)
+
+---
+
+### beta2
+
+• **beta2**: `G2Point`
+
+#### Defined in
+
+[verifyingKey.ts:11](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L11)
+
+---
+
+### delta2
+
+• **delta2**: `G2Point`
+
+#### Defined in
+
+[verifyingKey.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L15)
+
+---
+
+### gamma2
+
+• **gamma2**: `G2Point`
+
+#### Defined in
+
+[verifyingKey.ts:13](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L13)
+
+---
+
+### ic
+
+• **ic**: `G1Point`[]
+
+#### Defined in
+
+[verifyingKey.ts:17](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L17)
+
+## Methods
+
+### asContractParam
+
+▸ **asContractParam**(): [`IVkContractParams`](../interfaces/IVkContractParams.md)
+
+Return this as an object which can be passed
+to the smart contract
+
+#### Returns
+
+[`IVkContractParams`](../interfaces/IVkContractParams.md)
+
+the object representation of this
+
+#### Defined in
+
+[verifyingKey.ts:40](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L40)
+
+---
+
+### copy
+
+▸ **copy**(): [`VerifyingKey`](VerifyingKey.md)
+
+Produce a copy of this verifying key
+
+#### Returns
+
+[`VerifyingKey`](VerifyingKey.md)
+
+the copy
+
+#### Defined in
+
+[verifyingKey.ts:94](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L94)
+
+---
+
+### equals
+
+▸ **equals**(`vk`): `boolean`
+
+Check whether this is equal to another verifying key
+
+#### Parameters
+
+| Name | Type                              | Description             |
+| :--- | :-------------------------------- | :---------------------- |
+| `vk` | [`VerifyingKey`](VerifyingKey.md) | the other verifying key |
+
+#### Returns
+
+`boolean`
+
+whether this is equal to the other verifying key
+
+#### Defined in
+
+[verifyingKey.ts:73](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L73)
+
+---
+
+### fromContract
+
+▸ **fromContract**(`data`): [`VerifyingKey`](VerifyingKey.md)
+
+Create a new verifying key from a contract representation of the VK
+
+#### Parameters
+
+| Name   | Type                                                      | Description               |
+| :----- | :-------------------------------------------------------- | :------------------------ |
+| `data` | [`IVkContractParams`](../interfaces/IVkContractParams.md) | the object representation |
+
+#### Returns
+
+[`VerifyingKey`](VerifyingKey.md)
+
+a new VerifyingKey
+
+#### Defined in
+
+[verifyingKey.ts:55](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L55)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`VerifyingKey`](VerifyingKey.md)
+
+Deserialize into a VerifyingKey instance
+
+#### Parameters
+
+| Name   | Type     | Description             |
+| :----- | :------- | :---------------------- |
+| `json` | `string` | the JSON representation |
+
+#### Returns
+
+[`VerifyingKey`](VerifyingKey.md)
+
+the VerifyingKey
+
+#### Defined in
+
+[verifyingKey.ts:115](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L115)
+
+---
+
+### fromObj
+
+▸ **fromObj**(`data`): [`VerifyingKey`](VerifyingKey.md)
+
+Convert an object representation to a VerifyingKey
+
+#### Parameters
+
+| Name   | Type                                                  | Description               |
+| :----- | :---------------------------------------------------- | :------------------------ |
+| `data` | [`IVkObjectParams`](../interfaces/IVkObjectParams.md) | the object representation |
+
+#### Returns
+
+[`VerifyingKey`](VerifyingKey.md)
+
+the VerifyingKey
+
+#### Defined in
+
+[verifyingKey.ts:125](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/verifyingKey.ts#L125)

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

@@ -0,0 +1,81 @@
+---
+title: Domainobjs
+sidebar_label: Domainobjs
+---
+
+[![NPM Package][domainobjs-npm-badge]][domainobjs-npm-link]
+[![Actions Status][domainobjs-actions-badge]][domainobjs-actions-link]
+
+This module implements domain objects. A domain object is:
+
+> a logical container of purely domain information, usually representing a
+> logical entity in the problem domain space
+
+https://wiki.c2.com/?DomainObject
+
+In effect, domain objects are representations of objects shared between other
+modules in this codebase. They also encapsulate helper functions which make it
+easy to use them with said modules.
+
+## `PrivKey`
+
+A private key. Provides helper functions to do with passing it into a circuit
+in the right format, serialisation and deserialisation, and deep copying.
+
+This is a MACI private key, which is not to be confused with an Ethereum private key.
+A serialized MACI private key is prefixed by 'macisk.'
+A raw MACI private key can be thought as a point on the baby jubjub curve.
+
+## `PubKey`
+
+A public key. Provides helper functions to do with passing it into a contract
+function or circuit in the right format, hashing, serialisation and
+deserialisation, and deep copying.
+
+This is a MACI public key, which is not to be confused with an Ethereum public key. A serialized MACI public key is prefixed by 'macipk.' A raw MACI public key can be thought as a pair of BigIntegers (x, y) representing a point on the baby jubjub curve.
+
+## `Keypair`
+
+Encapsulates a `PrivKey` and `PubKey`. Also provides `genEcdhSharedKey` which
+generates an ECDH shared key from a public key and a private key.
+
+This is a MACI keypair, which is not to be confused with an Ethereum keypair.
+A MACI keypair is comprised of a MACI public key and a MACI private key
+
+## `Command`
+
+The `Command` domain object represents a request by a user to cast a vote
+and/or change one's public key.
+
+## `Message`
+
+The `Message` domain object is an encrypted `Command` and signature. That is, a
+`Message` is a `Ciphertext` (defined in `maci-crypto`)
+which is the encrypted `Command` and its `Signature` (also defined in
+`maci-crypto`). In other terms:
+
+```
+Message = Encrypt([Command, Signature], Key)
+```
+
+## `Ballot`
+
+Represents a User's votes in a Poll, as well as their next valid nonce.
+
+## `StateLeaf`
+
+Represents a leaf in the state tree, which maps public keys to voice credit
+balances, as well as the timestamp at which it was inserted.
+
+## `VerifyingKey`
+
+Encapsulates a Groth16 zk-SNARK verifying key.
+
+## `Proof`
+
+Encapsulates a Groth16 zk-SNARK proof.
+
+[domainobjs-npm-badge]: https://img.shields.io/npm/v/maci-domainobjs.svg
+[domainobjs-npm-link]: https://www.npmjs.com/package/maci-domainobjs
+[domainobjs-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/domainobjs-build.yml/badge.svg
+[domainobjs-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Adomainobjs

package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/ICommand.md

@@ -0,0 +1,104 @@
+---
+title: ICommand
+sidebar_label: ICommand
+---
+
+**`Notice`**
+
+A parent interface for all the commands
+
+## Implemented by
+
+- [`PCommand`](../classes/PCommand.md)
+- [`TCommand`](../classes/TCommand.md)
+
+## Table of contents
+
+### Properties
+
+- [cmdType](ICommand.md#cmdtype)
+- [copy](ICommand.md#copy)
+- [equals](ICommand.md#equals)
+- [toJSON](ICommand.md#tojson)
+
+## Properties
+
+### cmdType
+
+• **cmdType**: `bigint`
+
+#### Defined in
+
+[commands/types.ts:5](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L5)
+
+---
+
+### copy
+
+• **copy**: \<T\>() => `T`
+
+#### Type declaration
+
+▸ \<`T`\>(): `T`
+
+##### Type parameters
+
+| Name | Type                              |
+| :--- | :-------------------------------- |
+| `T`  | extends [`ICommand`](ICommand.md) |
+
+##### Returns
+
+`T`
+
+#### Defined in
+
+[commands/types.ts:6](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L6)
+
+---
+
+### equals
+
+• **equals**: \<T\>(`command`: `T`) => `boolean`
+
+#### Type declaration
+
+▸ \<`T`\>(`command`): `boolean`
+
+##### Type parameters
+
+| Name | Type                              |
+| :--- | :-------------------------------- |
+| `T`  | extends [`ICommand`](ICommand.md) |
+
+##### Parameters
+
+| Name      | Type |
+| :-------- | :--- |
+| `command` | `T`  |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[commands/types.ts:7](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L7)
+
+---
+
+### toJSON
+
+• **toJSON**: () => `unknown`
+
+#### Type declaration
+
+▸ (): `unknown`
+
+##### Returns
+
+`unknown`
+
+#### Defined in
+
+[commands/types.ts:8](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L8)

package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG1ContractParams.md

@@ -0,0 +1,31 @@
+---
+title: IG1ContractParams
+sidebar_label: IG1ContractParams
+---
+
+## Table of contents
+
+### Properties
+
+- [x](IG1ContractParams.md#x)
+- [y](IG1ContractParams.md#y)
+
+## Properties
+
+### x
+
+• **x**: `BigNumberish`
+
+#### Defined in
+
+[types.ts:46](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L46)
+
+---
+
+### y
+
+• **y**: `BigNumberish`
+
+#### Defined in
+
+[types.ts:47](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L47)

package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG2ContractParams.md

@@ -0,0 +1,31 @@
+---
+title: IG2ContractParams
+sidebar_label: IG2ContractParams
+---
+
+## Table of contents
+
+### Properties
+
+- [x](IG2ContractParams.md#x)
+- [y](IG2ContractParams.md#y)
+
+## Properties
+
+### x
+
+• **x**: `BigNumberish`[]
+
+#### Defined in
+
+[types.ts:51](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L51)
+
+---
+
+### y
+
+• **y**: `BigNumberish`[]
+
+#### Defined in
+
+[types.ts:52](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L52)