mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
ec96f12cbf
Former-commit-id: c214da494298044b04414e137c7a52b14b36faa7 [formerly 3fe10d6d66231d4ffc6f105d23fdb496267781e8] [formerly af88f1b73915c377a7f1ff6c900ee4ba0b505bb8 [formerly 28a736bed8]]
Former-commit-id: 67e3ac5620e6fae02fa0c948182d0768f7b86c4c [formerly 9387ebc52c3bd3db0eb090bc59e3b0ff1cc335f3]
Former-commit-id: cb7a941e3c50664e0e91e17805d7e9d2a21463f7
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/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.