Skip to content

Commit

Permalink
Merge pull request #1367 from privacy-scaling-explorations/docs/v1.2.…
Browse files Browse the repository at this point in the history
…0-docs

docs(website): update v1.2.0 docs
  • Loading branch information
ctrlc03 authored Apr 16, 2024
2 parents 2d9ee07 + bd70c5f commit 0398b8e
Show file tree
Hide file tree
Showing 145 changed files with 16,875 additions and 27 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,4 @@ circuits/circom/test
# mdBook rendered files
publish

# typedoc
docs/typedoc/*

**/ts/__benchmarks__/results/**
4 changes: 0 additions & 4 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,5 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*

versioned_docs/version-v1.2/solidity-docs
versioned_docs/version-v1.2/typedoc
versioned_docs/version-v1.3_alpha/typedoc/
versioned_docs/version-v1.3_alpha/solidity-docs/

typedoc
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.2/circuits.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ pnpm build-test-circuits-c
pnpm build-test-circuits-wasm
```

Please note that the circuits are configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, please refer to the individual circuit documentation within this page. Also, within the [configure-circomkit](https://maci.pse.dev/docs/installation#configure-circomkit) section of the `installation` page, you'll see how you can update the config file with new params.
Please note that the circuits are configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, please refer to the individual circuit documentation within this page. Also, within the [configure-circomkit](/docs/v1.2/installation#configure-circomkit) section of the `installation` page, you'll see how you can update the config file with new params.

To compile a single circuit, you can run:

Expand Down Expand Up @@ -505,4 +505,4 @@ To run individual tests, you can use the following commands (for all other circu
- `pnpm run test:processMessages` to run the tests for the `processMessages` circuit.
- `pnpm run test:tallyVotes` to run the tests for the `tallyVotes` circuit.

More details on testing are provided in the [testing section](/docs/testing) of the documentation.
More details on testing are provided in the [testing section](/docs/v1.2/testing) of the documentation.
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.2/cli.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions website/versioned_docs/version-v1.2/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ In order, these are the steps for contract deployment:

### Note on ZKey artifacts

For testing purposes, you can use the test zkeys and artifacts that you can download using `pnpm download:test-zkeys`. For production use, you can download the most recent artifacts that have undergone a trusted setup. Please refer to the [Trusted Setup](/docs/trusted-setup) section for more information. To download those, please use `pnpm download:ceremony-zkeys`.
For testing purposes, you can use the test zkeys and artifacts that you can download using `pnpm download:test-zkeys`. For production use, you can download the most recent artifacts that have undergone a trusted setup. Please refer to the [Trusted Setup](/docs/v1.2/trusted-setup) section for more information. To download those, please use `pnpm download:ceremony-zkeys`.

Please do not use test artifacts in production. If you do require zKeys configured for larger param sizes, please reach out to us if you will be using them in production and we'll discuss running a new ceremony for those parameters. To build new circuits artifacts for testing purposes, please refer to the [installation page](/docs/installation/#configure-circomkit) and to the [circuits](/docs/circuits) section.
Please do not use test artifacts in production. If you do require zKeys configured for larger param sizes, please reach out to us if you will be using them in production and we'll discuss running a new ceremony for those parameters. To build new circuits artifacts for testing purposes, please refer to the [installation page](/docs/v1.2/installation/#configure-circomkit) and to the [circuits](/docs/v1.2/circuits) section.

### Deployment using `maci-cli`

Expand Down Expand Up @@ -118,5 +118,5 @@ Should you wish to deploy on a different network, you will need to update the [c
6. You will find all of the deployed contracts addresses and configs in the `deployed-contracts.json` file inside the contracts folder.

:::info
You can find more information on integration and usage in the [Integrating MACI](/docs/integrating) section.
You can find more information on integration and usage in the [Integrating MACI](/docs/v1.2/integrating) section.
:::
2 changes: 1 addition & 1 deletion website/versioned_docs/version-v1.2/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ MACI has two main zk-SNARK circuits (plus an optional Subsidy circuit). Each cir
Unless you wish to generate a fresh set of `.zkey` files, you should obtain
them from someone who has performed a multi-party trusted setup for said
circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/trusted-setup) page.
circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/v1.2/trusted-setup) page.
Note the locations of the `.zkey` files as the CLI requires them as command-line flags.
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.2/integrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Deployment order is:
9. Deploy MACI, AccQueueQuinaryMaci
10. Deploy Poll, AccQueueQuinaryMaci, MessageProcessor, Tally and Subsidy (optional)

Before running the deploy command make sure you have [zkey files](https://maci.pse.dev/docs/trusted-setup) from trusted setup and env variables `ETH_PROVIDER` (RPC endpoint) and `ETH_SK` (wallet private key) are set. For production environment make sure you don't use zkey files from our examples.
Before running the deploy command make sure you have [zkey files](/docs/v1.2/trusted-setup) from trusted setup and env variables `ETH_PROVIDER` (RPC endpoint) and `ETH_SK` (wallet private key) are set. For production environment make sure you don't use zkey files from our examples.

```bash
maci-cli deployVkRegistry
Expand Down Expand Up @@ -102,7 +102,7 @@ event BallotsTallied(address poll);

## MACI Contract

The MACI contract is the core of the protocol. Contracts can inherit from MACI and thus expose the signup and topup functions. As with standalone MACI, one would need to deploy a [sign up gatekeeper](./contracts#signupgatekeeper) as well as the [voice credit proxy](./contracts#voicecreditproxy).
The MACI contract is the core of the protocol. Contracts can inherit from MACI and thus expose the signup and topup functions. As with standalone MACI, one would need to deploy a [sign up gatekeeper](/docs/v1.2/contracts#signupgatekeeper) as well as the [voice credit proxy](/docs/v1.2/contracts#voicecreditproxy).

As an example, within the quadratic funding infrastructure project, the QFI contract inherits from MACI and allows sign up via the contribute function.

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.2/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ in [Circom](https://iden3.io/circom).

The MACI circuits are released through the [`@maci-circuits`](https://www.npmjs.com/package/maci-circuits) NPM package.

[Learn more about MACI circuits](/docs/circuits)
[Learn more about MACI circuits](/docs/v1.2/circuits)

## Smart contracts

Expand All @@ -32,7 +32,7 @@ The MACI smart contracts are written in [Solidity](https://soliditylang.org/).

Contracts are released through the [`@maci-contracts`](https://www.npmjs.com/package/maci-contracts) NPM package.

[Learn more about MACI contracts](/docs/contracts)
[Learn more about MACI contracts](/docs/v1.2/contracts)

## TypeScript libraries

Expand Down
Loading

0 comments on commit 0398b8e

Please sign in to comment.