mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
ccf3926a59
Former-commit-id: 2a46aecb70879372902c6986e566773bd7245ff4 [formerly 9ad7d317dcba713f04e4a8f80bbea467b81b940a] [formerly 0ccddfe306e3d3abb30b3556c450089c7bb725b1 [formerly 1b8992f7bf]]
Former-commit-id: 9bc8f58d282149c9fa83ff5babd9a67a7db4cf4b [formerly 9beab1b7dfd1e20fa38dedd92a56a071229774f0]
Former-commit-id: 4270935a7ee171b018e313b9d52bd24485a5f8ee
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.