Skip to content

Commit

Permalink
Merge pull request #1015 from privacy-scaling-explorations/feat/updat…
Browse files Browse the repository at this point in the history
…e-testing-docs

Feat/update testing docs
  • Loading branch information
ctrlc03 authored Jan 14, 2024
2 parents bc3351d + 688225c commit fada36f
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions website/blog/2023-01-18-maci-v1.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ For further reading on coordinator services, please refer to this [doc](https://

MACI can be used as a standalone application to carry out on-chain polls, or be implemented into new projects that can then benefit from its properties.

For use as a standalone application, a `cli` package is provided which allows coordinators and voters to use MACI. Please refer to this [doc](https://maci.pse.dev/docs/cli.html) for details on how to use it.
For use as a standalone application, a `cli` package is provided which allows coordinators and voters to use MACI. Please refer to this [doc](/docs/cli) for details on how to use it.

To implement MACI into a project, the [documentation](https://maci.pse.dev/docs/introduction) can be used a reference, as well as reviewing how [clr.fund](https://github.com/clrfund) and [qf](https://github.com/privacy-scaling-explorations/qf) use MACI in their code.
To implement MACI into a project, the [documentation](/docs/introduction) can be used a reference, as well as reviewing how [clr.fund](https://github.com/clrfund) and [qf](https://github.com/privacy-scaling-explorations/qf) use MACI in their code.

## MACI 0.x

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.x/circuits.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ circom --r1cs --sym --wasm --output ./build circom/test/processMessages_test.cir
circom --r1cs --sym --wasm --output ./build circom/test/tallyVotes_test.circom
```

Please note that the circuit is 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, refer to [this page](https://maci.pse.dev/docs/circuits.html#compile-circuits).
Please note that the circuit is 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, refer to [this page](/docs/circuits/#compile-circuits).

### Generating zKeys

Expand Down Expand Up @@ -486,4 +486,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](https://maci.pse.dev/docs/testing) of the documentation.
More details on testing are provided in the [testing section](/docs/testing) of the documentation.
2 changes: 1 addition & 1 deletion website/versioned_docs/version-v1.x/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,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](https://maci.pse.dev/docs/trusted-setup) page.
circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/trusted-setup) page.

Note the locations of the `.zkey` files as the CLI requires them as command-line flags.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: MACI Testing in Details
description: How MACI tests work in details
sidebar_label: How Our Test Suites Work
title: MACI Testing in Detail
description: How MACI tests work in detail
sidebar_label: Testing in detail
sidebar_position: 10
---

# Testing
# Testing in detail

This doc extends on the [Testing](https://maci.pse.dev/docs/testing.md) doc and explains how MACI tests work in details. This information should be used by MACI's maintainers as well as contributors.
This doc expands on our [introduction to testing](/docs/testing) doc and explains how MACI tests work in greater detail. This information should be used by MACI's maintainers as well as contributors.

## Automated Tests

Expand Down Expand Up @@ -171,7 +171,7 @@ Within the circuits folder, there are a number of tests that are used to verify

These tests often use mock data from the `core` package. For instance, when testing the `processMessages` circuit, we are required to generate the parameters from the `core` packing, using the `Poll:processMessages` function. The same applies to vote tallying, where we need the `Poll:tally` function to be run first with mock users and vote messages.

All of the tests run using test parameters, usually `10, 2, 1, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](https://maci.pse.dev/docs/trusted-setup).
All of the tests run using test parameters, usually `10, 2, 1, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](/docs/trusted-setup).

### Core

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-v1.x/testing.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Testing MACI
description: How to test MACI
description: An introduction on how to test MACI
sidebar_label: Testing
sidebar_position: 9
---

# Testing
# Testing introduction

## Unit tests

Expand Down

0 comments on commit fada36f

Please sign in to comment.