mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
4b19c9bc77
Former-commit-id: b19db0f44e99d09cdf1a60bdad0a20dd06e532f5 [formerly 39b5c51ce2d5761075a5f394f6b7cdc5530c6a47] [formerly 386f29b33dedd66997840e92e4370123991e4745 [formerly 3042de85ee]]
Former-commit-id: b7068f6d4bbcd08334a65b5743a980025bdc46b9 [formerly cb0075388e1899d1ce6f77c05ec5f939525648bf]
Former-commit-id: c37c2f06c0719cabdd465485ca964323b806e447
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.