Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.61 KB

README.md

File metadata and controls

78 lines (50 loc) · 2.61 KB
Raw

Madara Prover API

RPC server and client to run the Stone Prover on the Madara sequencer.

Description

This project provides a server that can run any set of Cairo programs on top of the Starknet bootloader and generate the proof of execution of these programs. This server is used as part of the Madara sequencer to prove the transactions inside each (Madara) block.

To prove transactions, the server relies on the Stone prover.

This project is made of 3 main crates. stone-prover provides a Rust wrapper for the Stone prover. It builds the prover using a build.rs script and provides a Rust library that invokes the prover as a child process behind the scenes. madara-prover-rpc-server contains the server code. This crate provides a binary and library to spawn the server. madara-prover-rpc-client provides a client to interact with the server.

The client and server communicate using gRPC. You can find the protocol description in protocols/prover.proto.

Usage

Prove and execute a Cairo program

use madara_prover_rpc_client::client::execute_and_prove;
use madara_prover_rpc_client::prover::prover_client::ProverClient;

pub async fn prove_cairo_program() -> Result((), Box<dyn Error>) {
    let mut client = ProverClient::connect("http://[::1]:10000").await?;
    
    let compiled_program = std::fs::read("cairo_program_compiled.json")?;
    let prover_config = ProverConfig {...};
    let prover_parameters = ProverParameters {...};
    
    let proof = execute_and_prove(&mut client, compiled_program, prover_config, prover_parameters).await?;
    println!("Proof: {}", proof.proof_hex);
}

Project structure

  • integration-tests: Integration tests.
  • madara-prover-rpc-client: Prover API client.
  • madara-prover-rpc-server: Prover API server.
  • protocols: Protocol buffers are stored here.
  • test-cases: Cairo programs used as test cases.
  • test-fixtures: Shared test fixtures and utilities.

Getting started

Build and test the project

The project can be built and tested using cargo.

First, clone the repository and its submodules:

git clone --recursive https://github.com/Moonsong-Labs/madara-prover-api.git

Then, install dependencies:

sudo apt install protobuf-compiler  # Ubuntu
brew install protobuf   # macOS

Note that building this project requires Docker. The Stone prover is built using a Dockerfile.

Once all dependencies are installed, you can simply run cargo build to build the project.

The first build takes ~10 minutes because compiling the Stone prover takes a while.