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

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

@@ -0,0 +1,44 @@
+---
+title: Crypto
+sidebar_label: Crypto
+---
+
+[![NPM Package][crypto-npm-badge]][crypto-npm-link]
+[![Actions Status][crypto-actions-badge]][crypto-actions-link]
+
+This module implements abstractions over cryptographic functions which MACI
+employs.
+
+## AccQueue
+
+AccQueue is an implementation of an Accumulator Queue. This is used to manage a queue of elements in merkle-tree like structure. This TypeScript class conforms with the smart contract implemented in _maci-contracts_ - AccQueue.sol.
+
+The main tree is divided into subtrees to allow for easier management. Each of the subtrees has its own root and leaves, with the depth being defined by the _subDepth_ property of the AccQueue class. When a new leaf is "enqued", this is actually added to the current subtree. If this is full, we calculate the root of the subtree and store it, while the new leaf is added to the next subtree.
+
+The use of subtrees allows to more efficiently fill the tree, where instead of computing the root each time a new leaf is added, we only need to compute the root of the subtrees.
+
+## Crypto
+
+Various cryptographic utilities, which can be used to hash values with the Poseidon hash function, and to generate and manage points on the Baby jubjub curve.
+
+## Test
+
+To run the tests, execute the following command:
+
+```bash
+pnpm run test
+```
+
+To run tests on the individual files, you can execute the following commands:
+
+```bash
+pnpm run test-crypto
+pnpm run test-accQueue
+```
+
+For more details about testing please refer to the [tests documentation](https://maci.pse.dev/docs/v1.2/testing).
+
+[crypto-npm-badge]: https://img.shields.io/npm/v/maci-crypto.svg
+[crypto-npm-link]: https://www.npmjs.com/package/maci-crypto
+[crypto-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/crypto-build.yml/badge.svg
+[crypto-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Acrypto

package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Keypair.md

@@ -0,0 +1,33 @@
+---
+title: Keypair
+sidebar_label: Keypair
+---
+
+A private key and a public key
+
+## Table of contents
+
+### Properties
+
+- [privKey](Keypair.md#privkey)
+- [pubKey](Keypair.md#pubkey)
+
+## Properties
+
+### privKey
+
+• **privKey**: `SnarkBigNumber`
+
+#### Defined in
+
+[crypto/ts/types.ts:38](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L38)
+
+---
+
+### pubKey
+
+• **pubKey**: [`PubKey`](../modules.md#pubkey)\<`bigint`\>
+
+#### Defined in
+
+[crypto/ts/types.ts:39](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L39)

package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/PoseidonFuncs.md

@@ -0,0 +1,115 @@
+---
+title: PoseidonFuncs
+sidebar_label: PoseidonFuncs
+---
+
+A interface for poseidon hash functions
+
+## Indexable
+
+▪ [key: `number`]: (`inputs`: `bigint`[]) => `bigint`
+
+## Table of contents
+
+### Properties
+
+- [2](PoseidonFuncs.md#2)
+- [3](PoseidonFuncs.md#3)
+- [4](PoseidonFuncs.md#4)
+- [5](PoseidonFuncs.md#5)
+
+## Properties
+
+### 2
+
+• **2**: (`inputs`: `bigint`[]) => `bigint`
+
+#### Type declaration
+
+▸ (`inputs`): `bigint`
+
+##### Parameters
+
+| Name     | Type       |
+| :------- | :--------- |
+| `inputs` | `bigint`[] |
+
+##### Returns
+
+`bigint`
+
+#### Defined in
+
+[crypto/ts/types.ts:57](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L57)
+
+---
+
+### 3
+
+• **3**: (`inputs`: `bigint`[]) => `bigint`
+
+#### Type declaration
+
+▸ (`inputs`): `bigint`
+
+##### Parameters
+
+| Name     | Type       |
+| :------- | :--------- |
+| `inputs` | `bigint`[] |
+
+##### Returns
+
+`bigint`
+
+#### Defined in
+
+[crypto/ts/types.ts:58](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L58)
+
+---
+
+### 4
+
+• **4**: (`inputs`: `bigint`[]) => `bigint`
+
+#### Type declaration
+
+▸ (`inputs`): `bigint`
+
+##### Parameters
+
+| Name     | Type       |
+| :------- | :--------- |
+| `inputs` | `bigint`[] |
+
+##### Returns
+
+`bigint`
+
+#### Defined in
+
+[crypto/ts/types.ts:59](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L59)
+
+---
+
+### 5
+
+• **5**: (`inputs`: `bigint`[]) => `bigint`
+
+#### Type declaration
+
+▸ (`inputs`): `bigint`
+
+##### Parameters
+
+| Name     | Type       |
+| :------- | :--------- |
+| `inputs` | `bigint`[] |
+
+##### Returns
+
+`bigint`
+
+#### Defined in
+
+[crypto/ts/types.ts:60](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L60)

package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Queue.md

@@ -0,0 +1,33 @@
+---
+title: Queue
+sidebar_label: Queue
+---
+
+A acc queue
+
+## Table of contents
+
+### Properties
+
+- [indices](Queue.md#indices)
+- [levels](Queue.md#levels)
+
+## Properties
+
+### indices
+
+• **indices**: `number`[]
+
+#### Defined in
+
+[crypto/ts/types.ts:31](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L31)
+
+---
+
+### levels
+
+• **levels**: `Map`\<`number`, `Map`\<`number`, `bigint`\>\>
+
+#### Defined in
+
+[crypto/ts/types.ts:30](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L30)

package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Signature.md

@@ -0,0 +1,37 @@
+---
+title: Signature
+sidebar_label: Signature
+---
+
+## Type parameters
+
+| Name | Type             |
+| :--- | :--------------- |
+| `N`  | `SnarkBigNumber` |
+
+## Table of contents
+
+### Properties
+
+- [R8](Signature.md#r8)
+- [S](Signature.md#s)
+
+## Properties
+
+### R8
+
+• **R8**: [`Point`](../modules.md#point)\<`N`\>
+
+#### Defined in
+
+[crypto/ts/types.ts:48](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L48)
+
+---
+
+### S
+
+• **S**: `N`
+
+#### Defined in
+
+[crypto/ts/types.ts:49](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/crypto/ts/types.ts#L49)