mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
3b8856fb80
Former-commit-id: d9b39832a82cae191d1ed4ceeecfbc9bffcea3b4 [formerly 118ef484a81324e6bbf57702762d98ac8ee666de] [formerly a4e3e53a753da75f439afcce42a63d1f7bf95d95 [formerly f7b93a858c]]
Former-commit-id: 5ab7b748a02a3d2d3776cf7fbe85d2f0c25e3ded [formerly ae35192e85ce39aa546c1afaae8b610dbe383c7c]
Former-commit-id: 5d810e2c1b114b247a579deeb64938323ae3a7ac
ZK-kit
A monorepo of reusable JS libraries for zero-knowledge technologies.
ZK-kit is a set of NPM modules (algorithms or utility functions) that can be reused in different projects and zero-knowledge protocols, making it easier for developers to access ready-to-use and tested libraries for common tasks.
🟢 ZK-kit uses Conventional Commits (yarn commit).
📦 Packages
| Package | Version | Downloads | Size |
|---|---|---|---|
| @zk-kit/identity |
|
|
|
| @zk-kit/protocols |
|
|
|
| @zk-kit/incremental-merkle-tree |
|
|
|
| @zk-kit/sparse-merkle-tree |
|
|
|
🛠 Install
Clone this repository and install the dependencies:
$ git clone https://github.com/appliedzkp/zk-kit.git
$ cd zk-kit && yarn
📜 Usage
$ yarn lint # Syntax check with ESLint (yarn lint:fix to fix errors).
$ yarn prettier # Syntax check with Prettier (yarn prettier:fix to fix errors).
$ yarn commit # Interactive Commitizen commit.
$ yarn test # Test all packages (with common coverage).
$ yarn build # Create a JS build for each package.
$ yarn publish:fp # Publish packages on npm.
You can see the other npm scripts in the package.json file.