Skip to content

Commit

Permalink
chore: add programming language links
Browse files Browse the repository at this point in the history
  • Loading branch information
samajammin committed Dec 4, 2023
1 parent 5c98942 commit 7e850a0
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions website/versioned_docs/version-v1.x/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ To implement an on-chain, privacy-preserving, voting system, the MACI protocol c

## Circuits

MACI has multiple zk-SNARK circuits that ensure all off-chain computation is completed correctly. The circuits enforce that message processing and vote tallying were correctly executed by the coordinator. The circuits for these zero-knowledge proofs are written
in [Circom](https://docs.circom.io/).
MACI has multiple zk-SNARK circuits that ensure all off-chain computation is completed correctly. The circuits enforce that message processing and vote tallying were correctly executed by the coordinator.

The circuits for these zero-knowledge proofs are written
in [Circom](https://iden3.io/circom).

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

Expand All @@ -26,15 +28,17 @@ The MACI circuits are released through the [`@maci-circuits`](https://www.npmjs.

The MACI smart contracts handle the management and on-chain voting aspects of the system. They provide the functionality to sign up voters, deploy polls, and they store on-chain data from transactions, such as the encrypted votes of a poll. They also verify proofs of the zk-SNARK circuits.

The MACI contracts are released through the [`@maci-contracts`](https://www.npmjs.com/package/maci-contracts) NPM package.
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)

## TypeScript libraries

The TypeScript libraries manage the business logic between the smart contracts and the circuit code. They provide a variety of functionality, such as encryption tools, utilities, and a CLI for interacting with MACI (such as vote tallying & proof-generation).

The MACI TS libraries are released through the following NPM packages:
The MACI [TypeScript](https://www.typescriptlang.org/) libraries are released through the following NPM packages:

- [`@maci-cli`](https://www.npmjs.com/package/maci-cli)
- [`@maci-common`](https://www.npmjs.com/package/maci-common)
Expand Down

0 comments on commit 7e850a0

Please sign in to comment.