-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
221 changed files
with
28,256 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -153,7 +153,4 @@ circuits/circom/test | |
# mdBook rendered files | ||
publish | ||
|
||
# typedoc | ||
docs/typedoc/* | ||
|
||
**/ts/__benchmarks__/results/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Cli | ||
sidebar_label: Cli | ||
--- | ||
|
||
[![NPM Package][cli-npm-badge]][cli-npm-link] | ||
[![Actions Status][cli-actions-badge]][cli-actions-link] | ||
|
||
Please refer to the [documentation for the | ||
CLI](https://maci.pse.dev/docs/cli). | ||
|
||
[cli-npm-badge]: https://img.shields.io/npm/v/maci-cli.svg | ||
[cli-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/e2e.yml/badge.svg | ||
[cli-npm-link]: https://www.npmjs.com/package/maci-cli | ||
[cli-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3ACI |
89 changes: 89 additions & 0 deletions
89
website/versioned_docs/version-v0.x/typedoc/cli/interfaces/AirdropArgs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
--- | ||
title: AirdropArgs | ||
sidebar_label: AirdropArgs | ||
--- | ||
|
||
Interface for the arguments to the airdrop command | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [amount](AirdropArgs.md#amount) | ||
- [contractAddress](AirdropArgs.md#contractaddress) | ||
- [maciAddress](AirdropArgs.md#maciaddress) | ||
- [pollId](AirdropArgs.md#pollid) | ||
- [quiet](AirdropArgs.md#quiet) | ||
- [signer](AirdropArgs.md#signer) | ||
|
||
## Properties | ||
|
||
### amount | ||
|
||
• **amount**: `number` | ||
|
||
The amount of credits to airdrop | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:159](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L159) | ||
|
||
--- | ||
|
||
### contractAddress | ||
|
||
• `Optional` **contractAddress**: `string` | ||
|
||
The address of the ERC20 contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:169](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L169) | ||
|
||
--- | ||
|
||
### maciAddress | ||
|
||
• `Optional` **maciAddress**: `string` | ||
|
||
The address of the MACI contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:179](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L179) | ||
|
||
--- | ||
|
||
### pollId | ||
|
||
• `Optional` **pollId**: `bigint` | ||
|
||
The id of the poll | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:174](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L174) | ||
|
||
--- | ||
|
||
### quiet | ||
|
||
• `Optional` **quiet**: `boolean` | ||
|
||
Whether to log the output | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:184](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L184) | ||
|
||
--- | ||
|
||
### signer | ||
|
||
• **signer**: `Signer` | ||
|
||
A signer object | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:164](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L164) |
141 changes: 141 additions & 0 deletions
141
website/versioned_docs/version-v0.x/typedoc/cli/interfaces/DeployArgs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
--- | ||
title: DeployArgs | ||
sidebar_label: DeployArgs | ||
--- | ||
|
||
Interface for the arguments to the deploy command | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [initialVoiceCredits](DeployArgs.md#initialvoicecredits) | ||
- [initialVoiceCreditsProxyAddress](DeployArgs.md#initialvoicecreditsproxyaddress) | ||
- [poseidonT3Address](DeployArgs.md#poseidont3address) | ||
- [poseidonT4Address](DeployArgs.md#poseidont4address) | ||
- [poseidonT5Address](DeployArgs.md#poseidont5address) | ||
- [poseidonT6Address](DeployArgs.md#poseidont6address) | ||
- [quiet](DeployArgs.md#quiet) | ||
- [signer](DeployArgs.md#signer) | ||
- [signupGatekeeperAddress](DeployArgs.md#signupgatekeeperaddress) | ||
- [stateTreeDepth](DeployArgs.md#statetreedepth) | ||
|
||
## Properties | ||
|
||
### initialVoiceCredits | ||
|
||
• `Optional` **initialVoiceCredits**: `number` | ||
|
||
The initial voice credits to be minted | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:259](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L259) | ||
|
||
--- | ||
|
||
### initialVoiceCreditsProxyAddress | ||
|
||
• `Optional` **initialVoiceCreditsProxyAddress**: `string` | ||
|
||
The address of the initialVoiceCreditsProxy contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:264](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L264) | ||
|
||
--- | ||
|
||
### poseidonT3Address | ||
|
||
• `Optional` **poseidonT3Address**: `string` | ||
|
||
The address of the PoseidonT3 contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:274](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L274) | ||
|
||
--- | ||
|
||
### poseidonT4Address | ||
|
||
• `Optional` **poseidonT4Address**: `string` | ||
|
||
The address of the PoseidonT4 contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:279](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L279) | ||
|
||
--- | ||
|
||
### poseidonT5Address | ||
|
||
• `Optional` **poseidonT5Address**: `string` | ||
|
||
The address of the PoseidonT5 contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:284](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L284) | ||
|
||
--- | ||
|
||
### poseidonT6Address | ||
|
||
• `Optional` **poseidonT6Address**: `string` | ||
|
||
The address of the PoseidonT6 contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:289](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L289) | ||
|
||
--- | ||
|
||
### quiet | ||
|
||
• `Optional` **quiet**: `boolean` | ||
|
||
Whether to log the output | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:294](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L294) | ||
|
||
--- | ||
|
||
### signer | ||
|
||
• **signer**: `Signer` | ||
|
||
A signer object | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:254](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L254) | ||
|
||
--- | ||
|
||
### signupGatekeeperAddress | ||
|
||
• `Optional` **signupGatekeeperAddress**: `string` | ||
|
||
The address of the signupGatekeeper contract | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:269](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L269) | ||
|
||
--- | ||
|
||
### stateTreeDepth | ||
|
||
• **stateTreeDepth**: `number` | ||
|
||
The depth of the state tree | ||
|
||
#### Defined in | ||
|
||
[utils/interfaces.ts:249](https://github.com/privacy-scaling-explorations/maci/blob/8f7a3f2ba/cli/ts/utils/interfaces.ts#L249) |
Oops, something went wrong.