mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
d7d20008ea
Former-commit-id: c8b7ab9fd6c5de81f01b11459eb6a4b56af88848 [formerly 6560fdda9fb03885dad8343df4f09ba287c5b2d2] [formerly 5828364c55767ccdaf12afb19abdf7a1a21a6753 [formerly d711e1e2ac]]
Former-commit-id: 83cd2802d80ca8c5b6239ca94315440ce5ab6842 [formerly 618a64d399b4e99a781406a46f4593d9840554b7]
Former-commit-id: 4af399be2c19ea0c59f70d9c0bf6c4c1119df728
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/types |
|
|
🛠 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.