mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
bc64581bda
Former-commit-id: dcbf84856f69310f14a3e04f445692e5e1339566 [formerly 1d9d0f05e08e408faa7098e724a7c9c9884f2c61] [formerly 8ccf45abd6dffdd90fcd859c2b67cac8944d350f [formerly 9110903fee]]
Former-commit-id: d61f87e5325f63d3f40f20f6137debca96917baf [formerly fe377e6b9287150a8e66610b5039ad485df218b3]
Former-commit-id: 108afd418b670e6866df3a44c1cafa42dd129ff3
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.
📦 Packages
| Package | Version | Downloads | Size |
|---|---|---|---|
| @zk-kit/identity |
|
|
|
| @zk-kit/protocols |
|
|
|
| @zk-kit/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 && npm i
📜 Usage
$ npm run lint # Syntax check with ESLint (npm run lint:fix to fix errors).
$ npm run prettier # Syntax check with Prettier (npm run prettier:fix to fix errors).
$ npm run commit # Interactive Commitizen commit.
$ npm run test # Test all packages (with common coverage).
$ npm run build # Create a JS build for each package.
$ npm run publish:fp # Publish packages on npm.
You can see the other npm scripts in the package.json file.