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

♚ Yarn workspaces: minimal monorepo package management (yarn, yarn build, yarn docs)
♛ Conventional Commits: human and machine readable meaning to commit messages (yarn commit)
♜ Jest: tests and test coverage for all packages (yarn test, yarn test:all)
♞ ESLint, Prettier: code quality and formatting (yarn prettier & yarn lint)
♝ Typedocs: documentation generator for TypeScript (yarn docs)
♟ Benny: simple benchmarking framework for JavaScript/TypeScript (yarn benchmarks)
♟ Github actions: software workflows for automatic testing, decumentation deploy and code quality checks

Package	Version	Downloads	Size
@zk-kit/incremental-merkle-tree (docs)
@zk-kit/incremental-merkle-tree.sol
@zk-kit/sparse-merkle-tree (docs)
@zk-kit/rollup-plugin-rust

• 🔧 Work on open issues
• 📦 Suggest new packages
• 🚀 Share ideas for new features
• 🐛 Create a report if you find any bugs in the code

Clone this repository:

git clone https://github.com/privacy-scaling-explorations/zk-kit.git

and install the dependencies:

cd zk-kit && yarn

Run ESLint to analyze the code and catch bugs:

yarn lint

Run Prettier to check formatting rules:

yarn prettier

or to automatically format the code:

yarn prettier:write

Semaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:

yarn commit

It will also automatically check that the modified files comply with ESLint and Prettier rules.

Run Jest to test the code with coverage:

yarn test

Run Rollup to build all the packages:

yarn build

A dist folder will be created inside each package.

Run TypeDoc to generate a documentation website for each package:

yarn docs

The output will be placed on the docs folder.

ZK-kit provides a set of pre-configured development tools. All you have to deal with is your own code, testing and documentation. To create a package follow these steps:

1. Fork this repository and clone it (or simply clone it directly if you are a collaborator),
2. Copy one of our current libraries and update the README.md and package.json files with your package name:

cd zk-kit
cp -r packages/sparse-merkle-tree packages/my-package
cd packages/my-package && rm -fr node_modules dist
grep -r -l "sparse-merkle-tree" . | xargs sed -i 's/sparse-merkle-tree/my-package/'
# Update the remaining description/usage sections, and write your code in the src & tests folders!

3. Create an issue for your package and open a PR.

You can see some examples in the benchmarks folder. All you have to do is create a file that exports a function to run your benchmark in that folder, and add that function to the index.ts file. The yarn benchmarks command can be run with no parameters (it will run all the benchmarks), or you can specify the name of your benchmark file to run just that. When you run the command it will creates a benchmarks/results folder with your results.

You just need to insert the NPM docs command in your package.json file, as in the other packages. This command will be executed by Yarn and the output of typedocs will be placed in the docs folder of the root directory, which will be used to deploy the documentation websites by the Github docs workflow whenever the main branch is updated.