mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
7977be151b
Former-commit-id: 8897355314ecd76fb3b82b65e82da3e7c0270b01 [formerly 9e61424deb3400b8a5d2a921832b2636a2d2389d] [formerly 53687b0b4e5d03a71077c90f3bbb6083b996e89e [formerly b95cfe8340]]
Former-commit-id: 2681369eb86774b4a9d3dc950c9b87e83f1dc7f6 [formerly 0614ea82a8af138e26e727fe9f43c82d5a4828c8]
Former-commit-id: 210f1bd80b5b26eb479c829fce7c2edf18f90ba8
6.9 KiB
6.9 KiB
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.