Skip to main content

Prover/Relayer API

The Prover/Relayer API enables developers to interact with RibbleChain's proof generation and relayer services for Zero-Knowledge (ZK) rollups. This API is critical for submitting validity proofs, relaying transactions to the Layer 1 (L1), and ensuring the integrity of ZK rollups.

Overview​

For ZK rollups, provers generate cryptographic proofs to verify transaction batches, while relayers submit these proofs to RibbleChain's L1 for settlement. The Prover/Relayer API provides endpoints for:

  • Submitting transaction batches for proof generation.
  • Querying proof status and relayer activity.
  • Configuring prover settings (e.g., proof type, circuit parameters).

Prerequisites​

  • A deployed ZK rollup (see Deploying a ZK Rollup).
  • RibbleChain CLI: npm install -g ribblechain-cli.
  • ZK proof library: npm install @ribblechain/zk-proof.

Step 1: Set Up API Access​

Authenticate with the Prover/Relayer API:

ribblechain-cli api init --rollup my-zk-rollup --type prover