π₯ 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 JavaScript code only. |
---|
β Yarn workspaces: minimal monorepo package management (yarn
, yarn build
, yarn docs
)
β Conventional Commits: human and machine readable meaning to commit messages (yarn commit
)
β Jest: tests and test coverage for all libraries (yarn test:libraries
)
β ESLint, Prettier: code quality and formatting (yarn prettier
& yarn lint
)
β Typedocs: documentation generator for TypeScript (yarn docs
)
β Benny: simple benchmarking framework for JavaScript/TypeScript (yarn benchmarks
)
β Github actions: software workflows for automatic testing, documentation deploy and code quality checks
- 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 | Size | Audited |
---|---|---|---|---|
@zk-kit/eddsa-poseidon (docs) | βοΈ | |||
@zk-kit/poseidon-cipher (docs) | β | |||
@zk-kit/baby-jubjub (docs) | βοΈ | |||
@zk-kit/utils (docs) | βοΈ | |||
@zk-kit/imt (docs) | β | |||
@zk-kit/lean-imt (docs) | βοΈ | |||
@zk-kit/smt (docs) | β | |||
@zk-kit/poseidon-proof (docs) | β | |||
@zk-kit/logical-expressions (docs) | β |
- π§ 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.git
and install the dependencies:
cd zk-kit && yarn
Run ESLint to analyze the code and catch bugs:
yarn lint
Run Prettier to check formatting rules:
yarn format
or to automatically format the code:
yarn format:write
ZK-Kit uses conventional commits. A command line utility to commit using the correct syntax can be used by running:
yarn commit
It will also automatically check that the modified files comply with ESLint and Prettier rules.
Test the code:
yarn test
Build all the packages:
yarn build
A dist
folder will be created inside each JavaScript package.
Generate a documentation website for each package:
yarn docs
The output will be placed on the docs
folder.
- Bump a new version of the package with:
yarn version:bump <package-name> <version>
# e.g. yarn version:bump utils 2.0.0
This 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 utils-v2.0.0
After 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.
ZK-kit provides a set of pre-configured development tools. All you have to deal with is your own code, testing and documentation. To create a package follow these steps:
- Fork this repository and clone it (or simply clone it directly if you are a collaborator),
- Copy one of our current libraries and update the
README.md
andpackage.json
files with your package name:
cd zk-kit
cp -r packages/smt packages/my-package
cd packages/my-package && rm -fr node_modules dist
grep -r -l "smt" . | xargs sed -i 's/smt/my-package/'
# Update the remaining description/usage sections, and write your code in the src & tests folders!
- Create an issue for your package and open a PR.
You can see some examples in the benchmarks
folder. All you have to do is create a file that exports a function to run your benchmark in that folder, and add that function to the index.ts
file. The yarn benchmarks
command can be run with no parameters (it will run all the benchmarks), or you can specify the name of your benchmark file to run just that. When you run the command it will create a benchmarks/results
folder with your results.
I need to use a Merkle Tree to prove the inclusion or exclusion of data elements within a set. Which type of Merkle Tree should I use?
Incremental: Ideal for applications where you frequently add new elements and need to update the tree efficiently.
Lean Incremental: A more memory-efficient version of the incremental Merkle tree, suitable for use cases with memory constraints.
Sparse: Best suited for scenarios where you need to manage a large, mostly empty set of possible elements.
Type | Library Name | Main Feature | Recommended for | Not Recommended for | Used by | Proof Gen Speed |
---|---|---|---|---|---|---|
Incremental | @zk-kit/imt | Fastest for incremental updates | Applications requiring frequent updates | Scenarios with very large datasets | Semaphore, Tornado Cash | Fast |
Lean incremental | @zk-kit/lean-imt | Optimized for lightweight environments | Mobile and browser-based ZK applications | High-frequency update requirements | zkSync, Loopring | Moderate |
Sparse | @zk-kit/smt | Handles very large sets efficiently | Applications with large static datasets | Frequent updates due to higher computational cost | Aztec, Zcash | Slow (due to large set handling) |