Files
zerokit/README.md
Ekaterina Broslavskaya 6965cf2852 feat(rln-wasm-utils): extracting identity generation and hash functions into a separate module (#332)
- separated all identity generation functions as separate functions,
rather than RLN methods
- added BE support - only for these functions so far
- covered the functions with tests, as well as conversion to big endian
- prepared for publication, but is actually awaiting the initial
publication of the RLN module

@vinhtc27, please check that everything is correct from the wasm point
of view. This module does not require parallel computing, so if there
are any unnecessary dependencies, builds, etc., please let me know.

---------

Co-authored-by: vinhtc27 <vinhtc27@gmail.com>
2025-07-31 16:05:46 +03:00

3.1 KiB

Zerokit

Crates.io GitHub Workflow Status License: MIT License: Apache 2.0

A collection of Zero Knowledge modules written in Rust and designed to be used in other system programming environments.

Overview

Zerokit provides zero-knowledge cryptographic primitives with a focus on performance, security, and usability. The current focus is on Rate-Limiting Nullifier RLN implementation.

Current implementation is based on the following specification and focused on RLNv2 which allows to set a rate limit for the number of messages that can be sent by a user.

Features

  • RLN Implementation: Efficient Rate-Limiting Nullifier using zkSNARKs
  • Circom Compatibility: Uses Circom-based circuits for RLN
  • Cross-Platform: Support for multiple architectures (see compatibility note below)
  • FFI-Friendly: Easy to integrate with other languages

Architecture

Zerokit currently focuses on RLN (Rate-Limiting Nullifier) implementation using Circom circuits through ark-circom, providing an alternative to existing native Rust implementations.

Build and Test

Install Dependencies

make installdeps

Use Nix to install dependencies

nix develop

Build and Test All Crates

make build
make test

Release Assets

We use cross-rs to cross-compile and generate release assets:

# Example: Build for specific target
cross build --target x86_64-unknown-linux-gnu --release -p rln

Used By

Zerokit powers zero-knowledge functionality in:

  • nwaku - Nim implementation of the Waku v2 protocol
  • js-rln - JavaScript bindings for RLN

Acknowledgements

  • Inspired by Applied ZKP group work, including zk-kit
  • Uses ark-circom for zkey and Groth16 proof generation
  • Witness calculation based on circom-witnesscalc by iden3. The execution graph file used by this code has been generated by means of the same iden3 software.

Important

The circom-witnesscalc code fragments have been borrowed instead of depending on this crate, because its types of input and output data were incompatible with the corresponding zerokit code fragments, and circom-witnesscalc has some dependencies, which are redundant for our purpose.

Documentation

For detailed documentation on each module:

cargo doc --open