mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
cb2733c356
Former-commit-id: 448d550fec8c9b2c4766c47bb9c9714ce97c8206 [formerly 057d03f785f4fc05a3a8150861ac58598f9652b3] [formerly 5bbce8c55eeb61ad3d82fdddb240556332c64c10 [formerly 72ebf65d1e]]
Former-commit-id: d97deef2f1e7b39ae9332da689dc1cbcdd66d72f [formerly c9183a4cdda5cf86d1c8384a92a108a47d0051e5]
Former-commit-id: fa40bc588c0327fb96ad1cd6629005945203fc15
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 (npm run commit or yarn commit).
📦 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.