mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
c451d25965
Former-commit-id: 03ed9d710e05e6c8482e36d9c54731640f83bbad [formerly e561cca23f1402c9aac8cc8db22f6d0c962e3edb] [formerly 1101c73d4b65ad64c7dcf74558125d182a7b562a [formerly 99951a1844]]
Former-commit-id: a309ebb4e31d00635cd6625c14f8c3aac819bd7f [formerly 7b4790ab86aac4e63e8ddb836c0ace2fbe0b033e]
Former-commit-id: d39e5e57456b66455bfdd4bc0b85d149831b4d38
🧰 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. |
|---|
♚ Simplified package management with Lerna (yarn, yarn build, yarn publish:fp)
♛ Conventional Commits for adding human and machine readable meaning to commit messages (yarn commit)
♜ Jest tests & common test coverage for all packages (yarn test)
♞ ESLint & Prettier to keep the code neat and well organized (yarn prettier & yarn lint)
♝ Simple benchmarking framework for JavaScript/TypeScript libraries with Benny (yarn benchmark)
📦 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.