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

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

@@ -0,0 +1,289 @@
+---
+title: PubKey
+sidebar_label: PubKey
+---
+
+**`Notice`**
+
+A class representing a public key
+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
+
+## Table of contents
+
+### Constructors
+
+- [constructor](PubKey.md#constructor)
+
+### Properties
+
+- [rawPubKey](PubKey.md#rawpubkey)
+
+### Methods
+
+- [asArray](PubKey.md#asarray)
+- [asCircuitInputs](PubKey.md#ascircuitinputs)
+- [asContractParam](PubKey.md#ascontractparam)
+- [copy](PubKey.md#copy)
+- [equals](PubKey.md#equals)
+- [hash](PubKey.md#hash)
+- [serialize](PubKey.md#serialize)
+- [toJSON](PubKey.md#tojson)
+- [deserialize](PubKey.md#deserialize)
+- [fromJSON](PubKey.md#fromjson)
+- [isValidSerializedPubKey](PubKey.md#isvalidserializedpubkey)
+
+## Constructors
+
+### constructor
+
+• **new PubKey**(`rawPubKey`): [`PubKey`](PubKey.md)
+
+Create a new instance of a public key
+
+#### Parameters
+
+| Name        | Type     | Description        |
+| :---------- | :------- | :----------------- |
+| `rawPubKey` | `PubKey` | the raw public key |
+
+#### Returns
+
+[`PubKey`](PubKey.md)
+
+#### Defined in
+
+[publicKey.ts:24](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L24)
+
+## Properties
+
+### rawPubKey
+
+• **rawPubKey**: `PubKey`
+
+#### Defined in
+
+[publicKey.ts:18](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L18)
+
+## Methods
+
+### asArray
+
+▸ **asArray**(): `bigint`[]
+
+Return this public key as an array of bigints
+
+#### Returns
+
+`bigint`[]
+
+the public key as an array of bigints
+
+#### Defined in
+
+[publicKey.ts:59](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L59)
+
+---
+
+### asCircuitInputs
+
+▸ **asCircuitInputs**(): `string`[]
+
+Return this public key as circuit inputs
+
+#### Returns
+
+`string`[]
+
+an array of strings
+
+#### Defined in
+
+[publicKey.ts:53](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L53)
+
+---
+
+### asContractParam
+
+▸ **asContractParam**(): [`IG1ContractParams`](../interfaces/IG1ContractParams.md)
+
+Return this public key as smart contract parameters
+
+#### Returns
+
+[`IG1ContractParams`](../interfaces/IG1ContractParams.md)
+
+the public key as smart contract parameters
+
+#### Defined in
+
+[publicKey.ts:40](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L40)
+
+---
+
+### copy
+
+▸ **copy**(): [`PubKey`](PubKey.md)
+
+Create a copy of the public key
+
+#### Returns
+
+[`PubKey`](PubKey.md)
+
+a copy of the public key
+
+#### Defined in
+
+[publicKey.ts:34](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L34)
+
+---
+
+### equals
+
+▸ **equals**(`p`): `boolean`
+
+Check whether this public key equals to another public key
+
+#### Parameters
+
+| Name | Type                  | Description                    |
+| :--- | :-------------------- | :----------------------------- |
+| `p`  | [`PubKey`](PubKey.md) | the public key to compare with |
+
+#### Returns
+
+`boolean`
+
+whether they match
+
+#### Defined in
+
+[publicKey.ts:92](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L92)
+
+---
+
+### hash
+
+▸ **hash**(): `bigint`
+
+Hash the two baby jubjub coordinates
+
+#### Returns
+
+`bigint`
+
+the hash of this public key
+
+#### Defined in
+
+[publicKey.ts:85](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L85)
+
+---
+
+### serialize
+
+▸ **serialize**(): `string`
+
+Generate a serialized public key from this public key object
+
+#### Returns
+
+`string`
+
+the string representation of a serialized public key
+
+#### Defined in
+
+[publicKey.ts:65](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L65)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IJsonPublicKey`](../modules.md#ijsonpublickey)
+
+Serialize this object
+
+#### Returns
+
+[`IJsonPublicKey`](../modules.md#ijsonpublickey)
+
+#### Defined in
+
+[publicKey.ts:128](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L128)
+
+---
+
+### deserialize
+
+▸ **deserialize**(`s`): [`PubKey`](PubKey.md)
+
+Deserialize a serialized public key
+
+#### Parameters
+
+| Name | Type     | Description               |
+| :--- | :------- | :------------------------ |
+| `s`  | `string` | the serialized public key |
+
+#### Returns
+
+[`PubKey`](PubKey.md)
+
+the deserialized public key
+
+#### Defined in
+
+[publicKey.ts:99](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L99)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`PubKey`](PubKey.md)
+
+Deserialize a JSON object into a PubKey instance
+
+#### Parameters
+
+| Name   | Type                                             | Description     |
+| :----- | :----------------------------------------------- | :-------------- |
+| `json` | [`IJsonPublicKey`](../modules.md#ijsonpublickey) | the json object |
+
+#### Returns
+
+[`PubKey`](PubKey.md)
+
+PubKey
+
+#### Defined in
+
+[publicKey.ts:139](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L139)
+
+---
+
+### isValidSerializedPubKey
+
+▸ **isValidSerializedPubKey**(`s`): `boolean`
+
+Check whether a serialized public key is serialized correctly
+
+#### Parameters
+
+| Name | Type     | Description               |
+| :--- | :------- | :------------------------ |
+| `s`  | `string` | the serialized public key |
+
+#### Returns
+
+`boolean`
+
+whether the serialized public key is valid
+
+#### Defined in
+
+[publicKey.ts:114](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L114)

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

@@ -0,0 +1,340 @@
+---
+title: StateLeaf
+sidebar_label: StateLeaf
+---
+
+**`Notice`**
+
+A leaf in the state tree, which maps
+public keys to voice credit balances
+
+## Implements
+
+- [`IStateLeaf`](../interfaces/IStateLeaf.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](StateLeaf.md#constructor)
+
+### Properties
+
+- [pubKey](StateLeaf.md#pubkey)
+- [timestamp](StateLeaf.md#timestamp)
+- [voiceCreditBalance](StateLeaf.md#voicecreditbalance)
+
+### Methods
+
+- [asArray](StateLeaf.md#asarray)
+- [asCircuitInputs](StateLeaf.md#ascircuitinputs)
+- [asContractParam](StateLeaf.md#ascontractparam)
+- [copy](StateLeaf.md#copy)
+- [equals](StateLeaf.md#equals)
+- [hash](StateLeaf.md#hash)
+- [serialize](StateLeaf.md#serialize)
+- [toJSON](StateLeaf.md#tojson)
+- [deserialize](StateLeaf.md#deserialize)
+- [fromJSON](StateLeaf.md#fromjson)
+- [genBlankLeaf](StateLeaf.md#genblankleaf)
+- [genRandomLeaf](StateLeaf.md#genrandomleaf)
+
+## Constructors
+
+### constructor
+
+• **new StateLeaf**(`pubKey`, `voiceCreditBalance`, `timestamp`): [`StateLeaf`](StateLeaf.md)
+
+Create a new instance of a state leaf
+
+#### Parameters
+
+| Name                 | Type                  | Description                              |
+| :------------------- | :-------------------- | :--------------------------------------- |
+| `pubKey`             | [`PubKey`](PubKey.md) | the public key of the user signin up     |
+| `voiceCreditBalance` | `bigint`              | the voice credit balance of the user     |
+| `timestamp`          | `bigint`              | the timestamp of when the user signed-up |
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+#### Defined in
+
+[stateLeaf.ts:25](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L25)
+
+## Properties
+
+### pubKey
+
+• **pubKey**: [`PubKey`](PubKey.md)
+
+#### Implementation of
+
+[IStateLeaf](../interfaces/IStateLeaf.md).[pubKey](../interfaces/IStateLeaf.md#pubkey)
+
+#### Defined in
+
+[stateLeaf.ts:13](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L13)
+
+---
+
+### timestamp
+
+• **timestamp**: `bigint`
+
+#### Defined in
+
+[stateLeaf.ts:17](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L17)
+
+---
+
+### voiceCreditBalance
+
+• **voiceCreditBalance**: `bigint`
+
+#### Implementation of
+
+[IStateLeaf](../interfaces/IStateLeaf.md).[voiceCreditBalance](../interfaces/IStateLeaf.md#voicecreditbalance)
+
+#### Defined in
+
+[stateLeaf.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L15)
+
+## Methods
+
+### asArray
+
+▸ **asArray**(): `bigint`[]
+
+Return this state leaf as an array of bigints
+
+#### Returns
+
+`bigint`[]
+
+the state leaf as an array of bigints
+
+#### Defined in
+
+[stateLeaf.ts:79](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L79)
+
+---
+
+### asCircuitInputs
+
+▸ **asCircuitInputs**(): `bigint`[]
+
+Return this state leaf as an array of bigints
+
+#### Returns
+
+`bigint`[]
+
+the state leaf as an array of bigints
+
+#### Defined in
+
+[stateLeaf.ts:85](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L85)
+
+---
+
+### asContractParam
+
+▸ **asContractParam**(): [`IStateLeafContractParams`](../interfaces/IStateLeafContractParams.md)
+
+Return this state leaf as a contract param
+
+#### Returns
+
+[`IStateLeafContractParams`](../interfaces/IStateLeafContractParams.md)
+
+the state leaf as a contract param (object)
+
+#### Defined in
+
+[stateLeaf.ts:97](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L97)
+
+---
+
+### copy
+
+▸ **copy**(): [`StateLeaf`](StateLeaf.md)
+
+Crate a deep copy of the object
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+a copy of the state leaf
+
+#### Defined in
+
+[stateLeaf.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L35)
+
+---
+
+### equals
+
+▸ **equals**(`s`): `boolean`
+
+Check if two state leaves are equal
+
+#### Parameters
+
+| Name | Type                        | Description                    |
+| :--- | :-------------------------- | :----------------------------- |
+| `s`  | [`StateLeaf`](StateLeaf.md) | the state leaf to compare with |
+
+#### Returns
+
+`boolean`
+
+whether they are equal or not
+
+#### Defined in
+
+[stateLeaf.ts:110](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L110)
+
+---
+
+### hash
+
+▸ **hash**(): `bigint`
+
+Hash this state leaf (first convert as array)
+
+#### Returns
+
+`bigint`
+
+the has of the state leaf elements
+
+#### Defined in
+
+[stateLeaf.ts:91](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L91)
+
+---
+
+### serialize
+
+▸ **serialize**(): `string`
+
+Serialize the state leaf
+
+#### Returns
+
+`string`
+
+**`Notice`**
+
+serialize the public key
+
+**`Notice`**
+
+convert the voice credit balance and timestamp to a hex string
+
+#### Defined in
+
+[stateLeaf.ts:122](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L122)
+
+---
+
+### toJSON
+
+▸ **toJSON**(): [`IJsonStateLeaf`](../interfaces/IJsonStateLeaf.md)
+
+Serialize to a JSON object
+
+#### Returns
+
+[`IJsonStateLeaf`](../interfaces/IJsonStateLeaf.md)
+
+#### Defined in
+
+[stateLeaf.ts:143](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L143)
+
+---
+
+### deserialize
+
+▸ **deserialize**(`serialized`): [`StateLeaf`](StateLeaf.md)
+
+Deserialize the state leaf
+
+#### Parameters
+
+| Name         | Type     | Description               |
+| :----------- | :------- | :------------------------ |
+| `serialized` | `string` | the serialized state leaf |
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+a deserialized state leaf
+
+#### Defined in
+
+[stateLeaf.ts:133](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L133)
+
+---
+
+### fromJSON
+
+▸ **fromJSON**(`json`): [`StateLeaf`](StateLeaf.md)
+
+Deserialize into a StateLeaf instance
+
+#### Parameters
+
+| Name   | Type                                                | Description             |
+| :----- | :-------------------------------------------------- | :---------------------- |
+| `json` | [`IJsonStateLeaf`](../interfaces/IJsonStateLeaf.md) | the json representation |
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+the deserialized object as a StateLeaf instance
+
+#### Defined in
+
+[stateLeaf.ts:156](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L156)
+
+---
+
+### genBlankLeaf
+
+▸ **genBlankLeaf**(): [`StateLeaf`](StateLeaf.md)
+
+Generate a blank state leaf
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+a blank state leaf
+
+#### Defined in
+
+[stateLeaf.ts:47](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L47)
+
+---
+
+### genRandomLeaf
+
+▸ **genRandomLeaf**(): [`StateLeaf`](StateLeaf.md)
+
+Generate a random leaf (random salt and random key pair)
+
+#### Returns
+
+[`StateLeaf`](StateLeaf.md)
+
+a random state leaf
+
+#### Defined in
+
+[stateLeaf.ts:70](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/stateLeaf.ts#L70)