mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
d6faef4598
Former-commit-id: bb1a077d2c3189ed9cc7fe19e74ea6e5915cf049 [formerly 625d421119025d93b07a2761bcf46cee16969105] [formerly 9728e6026d86e32a73143fdc59ed10c1da828b8a [formerly 532c5ead7e]]
Former-commit-id: fda52937c2d57da3165d81d07f93a35b906832b6 [formerly 850c5b62d323be4edabc8dc4b48511d1a2b1a3a6]
Former-commit-id: f7d95a23ca6c8c0aa6491ea212f30eb7644a9255
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.