Struct ProverClient

pub struct ProverClient;

An entrypoint for interacting with the prover for the SP1 RISC-V zkVM.

IMPORTANT: ProverClient only needs to be initialized ONCE and can be reused for subsequent proving operations (can be shared across tasks by wrapping in an Arc). Note that the initial initialization may be slow as it loads necessary proving parameters and sets up the environment.

Implementations

impl ProverClient

pub fn from_env() -> EnvProver

Builds an EnvProver, which loads the mode and any settings from the environment.

Usage

use sp1_sdk::{Prover, ProverClient, SP1Stdin};

std::env::set_var("SP1_PROVER", "network");
std::env::set_var("NETWORK_PRIVATE_KEY", "...");
let prover = ProverClient::from_env();

let elf = &[1, 2, 3];
let stdin = SP1Stdin::new();

let (pk, vk) = prover.setup(elf);
let proof = prover.prove(&pk, &stdin).compressed().run().unwrap();

pub fn builder() -> ProverClientBuilder

Creates a new ProverClientBuilder so that you can configure the prover client.

pub fn new() -> EnvProver

👎Deprecated since 4.0.0: use ProverClient::from_env() instead

Creates a new EnvProver from the environment.

Example

use sp1_sdk::ProverClient;

std::env::set_var("SP1_PROVER", "network");
std::env::set_var("NETWORK_PRIVATE_KEY", "...");
std::env::set_var("NETWORK_RPC_URL", "...");
let prover = ProverClient::from_env();