Skip to main content
Version: v2.x

Testing introduction

Unit tests​

Unit tests within the project are built using Mocha and Chai. Mocha is a test framework that provides the environment to write and run JavaScript tests, while Chai is an assertion library that allows us to write assertions in a more expressive and readable way.

The following submodules contain unit tests: core, crypto, circuits, contracts, and domainobjs.

You can run all unit tests from the root directory of the repo by running:

pnpm run test

Or you can run unit tests within each submodule. for example to run the crypto tests:

cd packages/crypto
pnpm run test

You can also run individual tests within submodules, for example:

cd packages/contracts
pnpm run test:accQueue

This test command will run AccQueue.test.ts

Contracts​

First, compile the contracts.

From the main maci/ directory, run:

cd packages/contracts && \
pnpm run compileSol

To run Contracts only tests, run:

pnpm run test

Circuits​

To test the circuits, from the main maci/ directory, run:

cd packages/circuits && \
pnpm run test

Tests are run using Mocha and circom_tester.

CLI​

You can test the CLI locally. First, you need to either generate .zkey files, or download them. Please remember to not use these testing .zkey files in production.

Download .zkey files or the witness generation binaries​

MACI has two main zk-SNARK circuits, processMessages and tallyVotes.

info

The processMessages and tallyVotes circuits are also provided in a non-quadratic voting (non-QV) version. Currently these new versions have not undergone a trusted setup ceremony.

Each circuit is parameterised and there should be one .zkey file for each circuit and set of parameters.

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.

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

For testing purposes you can download the required artifacts using the download-zkeys:test. The script will place all required artifacts inside the cli/zkeys folder.

You can run the script directly with bash or use pnpm: pnpm run download:test-zkeys from the monorepo root.

Compile the circuits and generate zkeys (if decided to generate from scratch)​

From the root folder, run:

for c++ witness generator

pnpm build:circuits-c -- --outPath ../cli/zkeys

for wasm witness generator

pnpm build:circuits-wasm -- --outPath ../cli/zkeys

generate zkeys

pnpm setup:zkeys --outPath ../cli/zkeys

Check the Rapidsnark binary​

Next, ensure that the prover binary of rapidsnark is in ~/rapidsnark/build/prover.

info

This step is only required if you wish to use rapidsnark, for faster proof generation. You can also use the WASM witnesses provided in the cli/zkeys folder.

Run CLI tests​

You can find the tests in maci/cli/tests.

To run the tests first start a hardhat node in the background:

cd packages/contracts
pnpm run hardhat &
cd ../cli

Then run the tests (this will run all tests):

pnpm run test

To run e2e tests (quadratic voting):

pnpm run test:e2e

To run e2e tests with normal voting (not quadratic voting):

pnpm run test:e2e-non-qv

Run integration tests​

You can find the tests in maci/integrationTests/.

You can run them with:

pnpm run test