Maci
Minimal Anti-Collusion Infrastructure (MACI)
Install / Use
/learn @privacy-ethereum/MaciREADME
Minimal Anti-Collusion Infrastructure
Minimal Anti-Collusion Infrastructure (MACI) is an on-chain voting protocol which protects privacy and minimizes the risk of collusion and bribery.
MACI blog, resources, and documentation for developers and integrators can be found here: https://maci.pse.dev/
We welcome contributions to this project. Please join our
Discord server (in the #🗳️-maci channel) to discuss.
Packages
Below you can find a list of the packages included in this repository.
| package | npm | tests |
| --------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------- |
| maci-circuits | 
| 
|
| maci-cli | 
| |
| maci-contracts | 
| 
|
| maci-core | 
| 
|
| maci-crypto | 
| 
|
| maci-domainobjs | 
| 
|
| maci-testing | 
| |
| maci-subgraph | 
| 
|
| maci-sdk | 
| |
| maci-coordinator | 
| |
| maci-relayer | 
| 
|
Development and testing
Branches
The base branch of the project is main, which is used for ongoing development.
This project uses tags for releases. View all MACI releases.
To contribute to MACI, create feature/fix branches, then open PRs into main. Learn more about contributing.
Local development
For installation and local development instructions, please see our installation docs.
This repository is organized as pnpm workspace. Each package contains its own unit tests.
crypto: low-level cryptographic operations.circuits: zk-SNARK circuits.contracts: Solidity contracts and deployment code.domainobjs: Classes which represent high-level domain objects particular to this project.core: Business logic functions for message processing, vote tallying, and circuit input generation throughMaciState, a state machine abstraction.cli: A command-line interface with which one can deploy and interact with an instance of MACI.testing: Tests for the MACI protocol.subgraph: The subgraph for the MACI contracts.website: The documentation website.sdk: The SDK to interact with the MACI protocol.coordinator: The coordinator service for the MACI protocol.relayer: The relayer service for the MACI protocol.
Testing
Please refer to the testing documentation for more information.
CI pipeline
CI pipeline ensures that we have automated tests that constantly validate. For more information about pipeline workflows, read our CI documentation.
