_Circom

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues   |   🗣️ Chat & Support

ZK-Kit is a set of libraries (algorithms or utility functions) that can be reused in different projects and zero-knowledge protocols, making it easier for developers to access user-friendly, tested, and documented code for common tasks. ZK-Kit provides different repositories for each language - this one contains Circom templates only.

Important

Installation of Circom required for circuit tests.

🗂️ Repositories

• Javascript & Solidity: https://github.com/privacy-scaling-explorations/zk-kit
• Circom: https://github.com/privacy-scaling-explorations/zk-kit.circom
• Noir: https://github.com/privacy-scaling-explorations/zk-kit.noir

📦 Packages

Package	Version	Downloads	Audit
@zk-kit/binary-merkle-root.circom			Semaphore_4.0.0_Audit.pdf
@zk-kit/ecdh.circom
@zk-kit/poseidon-cipher.circom
@zk-kit/poseidon-proof.circom
@zk-kit/utils.circom

👥 Ways to contribute

• 🔧 Work on open issues
• 📦 Suggest new circuits
• 🐛 Create a report if you find any bugs in the code

🛠 Install

Clone this repository:

git clone https://github.com/privacy-scaling-explorations/zk-kit.circom.git

and install the dependencies:

cd zk-kit.circom && yarn

📜 Usage

Code formatting

Run Prettier to check formatting rules:

yarn format

or to automatically format the code:

yarn format:write

Conventional commits

Semaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:

git commit

Testing

Test the code with:

yarn test

Compile

Compile all the circuits with:

yarn compile

Releases

Bump a new version for your package with:

yarn version:bump <package-name> <version>
# e.g. yarn version:bump utils 2.0.0

It will create a commit and a git tag that you'll need to push on the main branch. A workflow will be triggered and will publish your package on npm and release a new version on Github with its changelogs automatically.