Files
zk-kit/README.md
cedoor bd4f3a2d0d docs: remove @zk-kit/types package
Former-commit-id: 2d846e4bed1cc0e2055325e252fd68ba471892ee [formerly fd94e38385a9184aa3d2ad6c80f64034329e5e80] [formerly 06e15eb82860c588b8604f1174c8a1e9d61b155a [formerly 637c65dec7]]
Former-commit-id: c0e2d5334bb9207690300a55717018aacbc43f97 [formerly 50dc13594b3ecd0c4ddb614c42588885ad00dbb0]
Former-commit-id: 6e5406d8e34c83d2b74f78263e77108352fc85a4
2022-01-17 13:21:23 +01:00

5.2 KiB

ZK-kit

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

Github license GitHub Workflow test Linter eslint Code style prettier Lerna

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 NPM version Downloads npm bundle size (scoped)
@zk-kit/protocols NPM version Downloads npm bundle size (scoped)
@zk-kit/merkle-tree NPM version Downloads npm bundle size (scoped)

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