mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
2d22ddbc9a
Former-commit-id: 8fcf52d83832b6c46497dde5a47ab7e696d3fbe1 [formerly eec8d284d3ca8e9558e5e5eed8fa67383dd2f9f4] [formerly 1a8b1b98a705df3d9b4219ab3cce77a92caec155 [formerly 10a8df6d39]]
Former-commit-id: 45eaa25b884ca5e045c8f107cdbdfc5236d3b8b9 [formerly 4a85a9dbb4ecbd523f9eb5b559696dc2431d729c]
Former-commit-id: 36262a373e4862416702ccc79f424fe3c138e91c
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.
📦 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.