Skip to content

Files

Latest commit

 

History

History
126 lines (105 loc) · 8.82 KB

README.md

File metadata and controls

126 lines (105 loc) · 8.82 KB

Minimal Anti-Collusion Infrastructure

CI License

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 NPM Package Actions Status
maci-cli NPM Package Actions Status
maci-contracts NPM Package Actions Status
maci-core NPM Package Actions Status
maci-crypto NPM Package Actions Status
maci-domainobjs NPM Package Actions Status
maci-testing NPM Package Actions Status
maci-subgraph NPM Package Actions Status
maci-sdk NPM Package Actions Status
maci-coordinator
maci-relayer Actions Status

Development and testing

Branches

The base branch of the project is dev, 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 dev. 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 through MaciState, 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.