mirror of https://github.com/privacy-scaling-explorations/zk-kit.git synced 2026-04-22 03:00:15 -04:00

Files

Omar Desogus d206ee0096 docs: add conventional commits info

Former-commit-id: 36439b4f52a91dc29cb33c5e4518abafe8336c2c [formerly bc9ff90cf00e3604ad5a19ae24f6a7d2fb3a72d7] [formerly 2efa18cfc531f0a613b94ec70e6f6b6936bb1d35 [formerly 8ecd847c62]]
Former-commit-id: dace455096a05a1aa7822556b627780b6d8dfcdd [formerly ec632a8f9a87ea8bac7f74957acf3821fd568862]
Former-commit-id: 8b1bb02f2aef7169b105a9a5b41537e1ccf0c7eb

2022-01-17 16:44:51 +01:00

6.9 KiB

Raw Blame History

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.

🟢 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.