🧰 ZK-kit

A monorepo of reusable JS libraries for zero-knowledge technologies.

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues

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.