_Noir

👥 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 Noir circuits only.

Important

Installation of Nargo required for circuit tests.

🗂️ Repositories

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

📦 Packages

• merkle-trees
• ecdh

👥 Ways to contribute

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

Note

Need inspiration? Check this list of circuits from the Atzec team: https://aztecnetwork.notion.site/f06968995c124de1be359459775ca2cb?v=613d3cb893dd46899a5bd3793b01e63b.

🛠 Install

Clone this repository:

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

and install the dependencies:

cd zk-kit.noir && yarn

📜 Usage

Conventional commits

ZK-Kit 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