mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
a53df8d790
Former-commit-id: ffdd572440b54c36de1f9577515252b4f0f0987b [formerly 3908b3b0b9f54ef313d7e646c406e03f98b581ff] [formerly 88195bb54c0d2d6326b5de64fc679eebba788487 [formerly 67d40fff3c]]
Former-commit-id: 6bc1484c5b4eb757ea478cb9e680340371a39f25 [formerly 8a9bfc1ab9a1fb4232154e834d75ed5bb98cae73]
Former-commit-id: 32fada66669ec9b912efcb697d3bd15cdd4cb0e6
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.