How internetmaximalism/intmax2-zkp works
Project Type and Purpose
• Type: A Rust library implementing Zero-Knowledge (ZK) rollup circuits.
• Purpose: Provide a suite of recursive ZK circuits (Validity, Balance, Withdrawal, Claim, Proof of Innocence) to offload computation from Layer 1 to clients, ensuring privacy and scalability.
File Structure
Top-level modules:
• src/circuits – ZK circuit implementations, organized by feature (validity, balance, withdrawal, claim, proof_of_innocence, plus test utilities).
• src/common – Shared data types: blocks, deposits, trees, witnesses, signatures, errors.
• src/utils – Helper algorithms: Merkle trees, Poseidon hashes, serialization, recursive-verifiability utilities.
• src/wrapper_config – Configuration for plonky2 backends (curve parameters, hashing).
• tests – End-to-end test harness.
• Cargo.toml, rustfmt, toolchain, coverage scripts – Build, test, and formatting config.
README for Additional Insights
• Circuits form a processing pipeline: each circuit both consumes and produces a public state.
• Recursive proofs: e.g. the Validity circuit wraps previous validity proofs.
• External dependencies: plonky2_keccak and plonky2_bn254 for hashing and curve operations.
Main Components and Their Relationships
– Transaction sets, Deposits, Withdrawals, Privacy-mining requests.
– Validity Circuit
– Balance Circuit (send/receive/update)
– Withdrawal Circuit
– Claim Circuit
– Proof of Innocence
– Data models, Merkle-tree structures, witness formats used by all circuits.
– Merkle-tree algorithms, hashing helpers, recursive-verifiability abstractions.
– plonky2 configurations (curve, hashing parameters).
– plonky2_keccak, plonky2_bn254
– Drives a full end-to-end proof generation and verification.
Architectural Patterns and Design Principles
• Modularity: Each circuit feature is its own directory, with processors, targets, and PIs.
• Separation of concerns:
– src/common for data definitions,
– src/utils for algorithms,
– src/circuits for ZK logic,
– wrapper_config for backend parameters.
• Recursion: Validity proofs wrap prior proofs; recursive-verifiable utilities support this.
• Extensibility: New circuits can plug into the same common and util layers, reusing wrapper_config.