Zerokit development planning

[s1fr0]

This is a tentative dynamic meta-issue which collects required and desirable features for Zerokit with a reasonably clear scope.

Ideally, each item should correspond to one or more issues to be addressed according to agreed monthly development planning.

Items marked with a (*) are currently prioritized.

Implementation

General

• Release v0.2 (select subset of items in this issue) (*):
  • Release v0.2 #100
• Check license compatibility with dependencies and add a license (*):
  • Check and add licenses #97
• Reduce static libraries and WASM sizes (includes revising dependencies):
  • Reduce static libraries sizes #37
• Standardize an abstract ZK circuit interface to be used on all modules:
  • Zerokit generalize API to allow for any Circom based proof #71
• Address any eventual requirement coming from projects using zerokit modules (nwaku, js-waku, etc.)
• Separate tests from logic (*):
  • feat: separate tests from logic #98
• Embed the circuit loading logic in utils (at the moment we use ark-circom, which uses heavy dependencies)
• Add Makefile for zerokit workspace and for each package (*):
  • Create a Makefile #41

rln

• Code refactoring/optimization/clean-up (chores, todos, clippy, revise serialization, etc.) (*):
  • feat(rln): Abstract ffi APIs structure with a helper function #96
  • serialization lengths should be u32 #39
• Complete documentation of the modules (ffi, protocol, utils, etc.) (*) :
  • Standalone RLN docs and tutorial #69
• Audit FFI (in particular usage of not_unsafe_ptr_arg_deref) (*):
  • feat(rln): Abstract ffi APIs structure with a helper function #96 (item)
• Push RLN crate to crates.io (requires license) (*):
  • feat(rln): publish rln crate #99
• MVP CLI interface:
  • Zerokit/RLN Command Line API #70
• Add support to nrln, i.e. use degree-n polynomials (requires analysis and agreement on coefficients generation)
  • not planned since nrln has been deprecated in favor of rln-v2

rln-wasm

• Generate proofs using multi-threading:
  • Parallel execution in rln-wasm #55
• Explore/implement WASM-friendly DB solutions (to be implemented in pmtree) for tree persistence using browsers
• Ensure all rln module public APIs are exposed by rln-wasm (*) :
  • Expose set_leaves_from and init_tree_with_leaves to rln-wasm #64

semaphore

• Refactor semaphore module (i.e. make it stand-alone similarly as RLN):
  • Semaphore: module refactoring #78

utils

Merkle tree (pmtree - in collaboration with PSE)

• Align pmtree APIs with OptimalMerkleTree APIs, i.e. make the two interchangeable
• Properly benchmark pmtree performances:
  • Benchmarking using the inbuilt lib #89
• Add support in pmtree to database DB configurations in order to keep traits and APIs abstract
  • feat(rln): integrate pmtree for MT persistance #86 (comment)

Poseidon Hash

• Generate Poseidon round parameters and constants:
  • Generate Poseidon round parameters and constants #50
    Only round parameters (easy) and secure MDS matrices verification algorithms (hard) missing

Design/analysis

rln

• RLN V2 (in collaboration with PSE):
• Optimize circuit evaluation costs, i.e. compute outside the circuit external_nullifier, etc.
• Implement/audit a single general degree-n zk circuit with n compile-time parameter (falls back to rln when n=1)
• Allow higher messaging rate (i.e. >1 message/epoch):
• Compare computational/communication/zk-evaluation costs of using n degree-1 RLN credentials vs. 1 degree-n RLN credential

utils

Merkle tree (pmtree)

• Based on benchmark results, tune sled DB parameters #151

[oskarth]

Should we cut up a Zerokit v0.2 release issue and aim to get it out in a few weeks?

Also generic Makefile probably useful #41