• Stars
    star
    290
  • Rank 142,981 (Top 3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 3 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A monorepo of reusable libraries for zero-knowledge technologies.

๐Ÿงฐ ZK-kit

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

Github license GitHub Workflow test Coveralls Linter eslint Code style prettier

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.

โ™š 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, documentation deploy and code quality checks

๐Ÿ“ฆ Packages

Package Version Downloads Size
@zk-kit/incremental-merkle-tree (docs) NPM version Downloads npm bundle size (scoped)
@zk-kit/incremental-merkle-tree.sol NPM version Downloads
@zk-kit/sparse-merkle-tree (docs) NPM version Downloads npm bundle size (scoped)
@zk-kit/rollup-plugin-rust NPM version Downloads npm bundle size (scoped)

๐Ÿ‘ฅ Ways to contribute

  • ๐Ÿ”ง Work on open issues
  • ๐Ÿ“ฆ Suggest new packages
  • ๐Ÿš€ Share ideas for new features
  • ๐Ÿ› Create a report if you find any bugs in the code

๐Ÿ›  Install

Clone this repository:

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

and install the dependencies:

cd zk-kit && yarn

๐Ÿ“œ Usage

Code quality and formatting

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

Conventional commits

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.

Testing

Test the code with coverage:

yarn test

Build

Build all the packages and compile contracts:

yarn build

A dist folder will be created inside each JavaScript package.

Documentation

Generate a documentation website for each package:

yarn docs

The output will be placed on the docs folder.

โ“ 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:

  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!
  1. Create an issue for your package and open a PR.

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

More Repositories

1

zkevm-circuits

Rust
819
star
2

maci

Minimal Anti-Collusion Infrastructure (MACI)
TypeScript
512
star
3

zkevm-specs

Python
332
star
4

zkp-app-boilerplate

Build your zkp app with typescript, hardhat, circom, and snarkjs!
TypeScript
221
star
5

chiquito

DSL for Halo2 circuits
Rust
186
star
6

sonobe

Experimental folding schemes library
Rust
185
star
7

mpz

Multi-party computation libraries written in Rust ๐Ÿฆ€
Rust
182
star
8

halo2curves

Rust
170
star
9

snark-verifier

Rust
143
star
10

core-program

141
star
11

halo2wrong

Rust
116
star
12

zk-eigentrust

EigenTrust - A distributed reputation system
Rust
109
star
13

p0tion

The MPC suite of tools for conducting zkSNARK Phase 2 Trusted Setup ceremonies
TypeScript
88
star
14

zkevm-chain

zkevm-chain: Deprecated
Rust
87
star
15

multifolding-poc

A PoC repo for a HyperNova impl
Rust
83
star
16

acceleration-program

Accelerate Early Stage Programmable Cryptography Talents
64
star
17

halo2-solidity-verifier

A set of tooling related to halo2 circuits verification inside Solidity contracts
Rust
62
star
18

maze

Multi proof Aggregation for Zk SNARK on Ethereum
Rust
61
star
19

anon-aadhaar

Anon Aadhaar is a zero-knowledge protocol that allows Aadhaar ID owners to prove their identity in a privacy preserving way.
JavaScript
61
star
20

bandada

A system for managing privacy-preserving groups.
TypeScript
51
star
21

incrementalquintree

An incremental Merkle tree written in Typescript and circom
TypeScript
43
star
22

nova-bench

A collection of comparison-benchmarks for Nova & related Proving systems
Rust
42
star
23

greco

Rust
42
star
24

poseidon

Rust
38
star
25

zkvm-ideas

A collection of the Vietnam Spring ZK Residency effort of the ZKWasm team
37
star
26

multisetups

A simple, IPFS-based multi-party trusted setup utility for snarkjs
TypeScript
27
star
27

e2e-zk-ecdsa

End to End ZK ECDSA
TypeScript
25
star
28

nova-ml

Jupyter Notebook
23
star
29

zkevm-docs

AppliedZKP's zkEVM Documentation
Shell
23
star
30

DefinitelySetup

The repository for high quality Trusted setups for groth16 based SNARKS
TypeScript
21
star
31

nova-by-hand

A collection of the Notes on the Nova folding scheme explained from scratch
21
star
32

zkey-manager

TypeScript
18
star
33

rln

Shell
18
star
34

pse.dev

PSE website v2 with more user research and new branding!
TypeScript
17
star
35

UniRep

A private and non-repudiable reputation system
TypeScript
16
star
36

semaphore-phase2-setup

Phase 2 of a multi-party trusted setup ceremony for the Semaphore zk-SNARK circuit
Python
16
star
37

taz-apps

Simple DApp to allow Devcon attendees to review events anonymously.
JavaScript
13
star
38

zk-kit.circom

A monorepo of reusable Circom circuits.
Circom
13
star
39

circom-ecdsa-p256

Big integer arithmetic // secp256k1 & additional P256 ECC operations in circom
Circom
12
star
40

PSE-Lectures-Notes

A collection of the Notes by Matan from each of the PSE Lectures sessions that have happened so far.
12
star
41

pairing

Rust
11
star
42

website

Privacy and Scaling Explorations
TypeScript
11
star
43

researches

10
star
44

webauth-circom

Circom
10
star
45

security

A collection of resources relevant to the PSE Security Team.
10
star
46

qdh

The Quadratic Dollar Homepage is a spin on the Million Dollar Homepage. While it also features a space for images on a webpage, it allows users to vote on how much space each image takes up. Moreover, it employs a quadratic and collusion-resistant voting mechanism on Ethereum called Minimal Anti-Collusion Infrastructure (MACI) to prevent bribery and scale images quadratically.
JavaScript
10
star
47

maci-platform

MACI Platform - Voting and Funding using MACI
TypeScript
10
star
48

zk-kit.solidity

A monorepo of reusable contracts for zero-knowledge technologies.
Solidity
10
star
49

crypt-keeper-extension

Crypt-Keeper Extension, zero knowledge identity management and proof generation tool.
TypeScript
7
star
50

zk-kit.rust

A monorepo of reusable crates for zero-knowledge technologies.
Rust
6
star
51

zk-keeper

ZK Keeper
TypeScript
6
star
52

hacking-pse

PSE Hackathon
TypeScript
5
star
53

poseidon_in_circomlib_check

5
star
54

zkevm-testing-vectors

Go
5
star
55

sonobe-docs

Docs for https://github.com/privacy-scaling-explorations/sonobe
5
star
56

ideas

4
star
57

keccak_circuit

Rust
4
star
58

snark-artifacts

A streamlined mechanism for distributing SNARK artifacts.
TypeScript
4
star
59

mixer

TypeScript
4
star
60

zk-kit.noir

A monorepo of reusable Noir circuits.
Roff
4
star
61

sugesto

Sugesto is an internal application to allow PSE members to send anonymous feedback on team events and activities.
TypeScript
3
star
62

perpetualpowersoftau

Standard ML
3
star
63

github-ops

Shell
2
star
64

poseidon-gadget

Poseidon gadget for Halo2, previously at halo2_gadgets.
Rust
2
star
65

technical-reports

PSE Technical Reports
TeX
2
star
66

maci-coordinator

๐Ÿ— coordinator = tallier + prover
Go
2
star
67

mpt-witness-generator

Go
2
star
68

zuzalu-feedback

An app to allow Zuzalu attendees to send anonymous feedback.
TypeScript
1
star
69

zkevm-chain-testing

Python
1
star
70

MACI-v2

MACI + Nova + ElGamal PoC
1
star
71

vFSM

An opinionated framework aimed at facilitating the zero knowledge verification of state transitions in Mealy machines with encrypted inputs.
1
star
72

maci-phase2-setup

TypeScript
1
star
73

qdh-admin

Admin panel for QDH. Based on Strapi
JavaScript
1
star
74

pse-gfis

A simple app to view good first issues from a set of repos/orgs
TypeScript
1
star
75

zkevm-params

Shell
1
star