&style=flat-square&logo=coveralls)
| 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 Solidity code only. |
|---|
- 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
| Package | Version | Downloads | Audited |
|---|---|---|---|
| @zk-kit/imt.sol |
|
|
❌ |
| @zk-kit/lean-imt.sol |
|
|
✔️ |
| @zk-kit/lazy-imt.sol |
|
|
❌ |
| @zk-kit/excubiae |
|
|
❌ |
- 🔧 Work on open issues
- 📦 Suggest new packages
- 🚀 Share ideas for new features
- 🐛 Create a report if you find any bugs in the code
Clone this repository:
git clone https://github.com/privacy-scaling-explorations/zk-kit.solidity.gitand install the dependencies:
cd zk-kit.solidity && yarnRun Prettier to check formatting rules:
yarn formator to automatically format the code:
yarn format:writeyarn lintWill lint all the packages with solhint
yarn slitherWill perform a static analysis of all the contracts with slither to identify potential vulnerabilities.
You'll need to install slither beforehand.
ZK-Kit uses conventional commits. A command line utility to commit using the correct syntax can be used by running:
yarn commitIt will also automatically check that the modified files comply with ESLint and Prettier rules.
Test the code:
yarn testCompile all contracts:
yarn compile- Bump a new version of the package with:
yarn version:bump <package-name> <version>
# e.g. yarn version:bump imt.sol 2.0.0This step creates a commit and a git tag.
- Push the changes to main:
git push origin main- Push the new git tag:
git push origin <package-name>-<version>
# e.g. git push origin imt.sol-v2.0.0After pushing the new git tag, a workflow will be triggered and will publish the package on npm and release a new version on Github with its changelogs automatically.