Files
zk-kit/README.md
cedoor a291ca7f86 docs: update npm scripts
Former-commit-id: 3bc82c4a950a820b0113fa0c8aad070e2ef725f2 [formerly 570bd4e838cae07edee3f730482f2542080be3bd] [formerly 6500163a8def73e92da0a43946fbbf6982c01030 [formerly 09329c231e]]
Former-commit-id: 2208a0dc168bdbea01be9e02c045a1bc3a843c04 [formerly 738c95942dd55ae726a28db4e0c967ca041ccacb]
Former-commit-id: d3b165b33045fd5a0bc36c3d3cf5f96a5854efe2
2022-01-16 21:56:49 +01:00

6.1 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)
@zk-kit/types NPM version Downloads

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