47a82a3983
feat(zk-protocol): structure the public signals array obtained while generating a proof from snarkjs
Former-commit-id: ef1e31e83f0fc7093ff967cddb4c104156bf4f46 [formerly 257d03e01d2395aa1bebcc83f35ff19c784ed942] [formerly 0a14f53831ac1f633564c121de2cd52a80249ef2 [formerly 56204bf4695cee1c51aa9a6661be8dc281da0771]] [formerly f0cc2c9b7b319e58b4b97da17115b45fadea9014 [formerly c41a83c20d080db3d3a6372380bc2ecbf450b2f4] [formerly 43b4f30154f215514969af37bd08d1624a377206 [formerly 89d6d730e3]]]
Former-commit-id: 184e42d23dc71e66f0961805929766bb88fa657b [formerly 35a3b1646ade9f78d68c38e6c166bd394fd30002] [formerly cedc0eb9d78e56ceb14b66a71910bd3c50fd2317 [formerly b42e068fd090e4925d374b0411f28a8bcf0647fa]]
Former-commit-id: 001d9ec2da39fc13970db3c4cdf3b1526a29275a [formerly 32eb83c3ec842164d2797665076f8ad8d98a03de]
Former-commit-id: 06bb43dd5f3fa2320fc085487eccb3114e7f182d
🧰 ZK-kit
A monorepo of reusable JS libraries for zero-knowledge technologies.
| 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)
♝ Automatic deployment of documentation generated with typedocs
♟ Simple benchmarking framework for JavaScript/TypeScript libraries with Benny (yarn benchmarks)
📦 Packages
🛠 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.
❓ FAQ
I have a library that could be reused in other projects. How can I integrate it on ZK-kit?
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:
- Fork this repository and clone it (or simply clone it directly if you are a collaborator),
- Copy one of our current libraries and update the
README.mdandpackage.jsonfiles 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!
How can I test and publish my library?
ZK-kit provides two commands: yarn test and yarn publish:fp. Both must be run from the root folder. yarn test will test all packages in the monorepo, including yours using the files inside your packages/my-package/tests folder. yarn publish:fp can only be run by those who own the NPM token of the ZK-kit organization. They will then have to publish your package. This task could be automated in the future.
How can I create benchmarks for my library?
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.
How can I publish the documentation of my library with typedocs?
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 Lerna 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.