Enum EnvProver 

pub enum EnvProver {
    Mock(MockProver),
    Light(LightProver),
    Cpu(CpuProver),
    Network(Box<NetworkProver>),
}

A prover that can execute programs and generate proofs with a different implementation based on the value of the SP1_PROVER environment variable.

Variants

Mock(MockProver)

A mock prover that does not prove anything.

Light(LightProver)

A light prover that only executes and verifies but does not generate proofs.

Cpu(CpuProver)

A CPU prover.

Network(Box<NetworkProver>)

A network prover.

Implementations

impl EnvProver

pub fn new() -> Self

Creates a new EnvProver from the environment.

This method will read from the SP1_PROVER environment variable to determine which prover to use. If the variable is not set, it will default to the CPU prover.

If the prover is a network prover, the NETWORK_PRIVATE_KEY variable must be set.

pub fn new_with_machine(machine: Machine<SP1Field, RiscvAir<SP1Field>>) -> Self

Same as Self::new but with a custom machine.

pub fn with_opts(self, opts: SP1CoreOpts) -> Self

Updates the core options for this prover.

This method allows you to configure the prover after creation. It recreates the prover with the new options based on the current environment settings.

Example

use sp1_core_executor::SP1CoreOpts;
use sp1_sdk::blocking::ProverClient;

let mut client = ProverClient::from_env();
let opts = SP1CoreOpts { shard_size: 500_000, ..Default::default() };
client = client.with_opts(opts);

pub fn from_env_with_opts(core_opts: Option<SP1CoreOpts>) -> Self

Creates an EnvProver from the environment with optional custom SP1CoreOpts.

This method will read from the SP1_PROVER environment variable to determine which prover to use. If the variable is not set, it will default to the CPU prover.

If the prover is a network prover, the NETWORK_PRIVATE_KEY variable must be set.

pub fn from_env_with_opts_and_machine( core_opts: Option<SP1CoreOpts>, machine: Machine<SP1Field, RiscvAir<SP1Field>>, ) -> Self

Same as Self::from_env_with_opts but with a custom machine.

Trait Implementations

impl Clone for EnvProver

fn clone(&self) -> EnvProver

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for EnvProver

fn default() -> Self

Returns the “default value” for a type.

impl Prover for EnvProver

type Error = Error

The possible errors that can occur when proving.

type ProvingKey = EnvProvingKey

The proving key used for this prover type.

type ProveRequest<'a> = EnvProveRequest<'a>

The prove request builder.

fn inner(&self) -> &SP1NodeCore

The inner SP1NodeCore struct used by the prover.

fn setup(&self, elf: Elf) -> Result<Self::ProvingKey, Self::Error>

Setup the prover with the given ELF.

fn prove<'a>( &'a self, pk: &'a Self::ProvingKey, stdin: SP1Stdin, ) -> Self::ProveRequest<'a>

Prove the given program on the given input in the given proof mode.

fn verify( &self, proof: &SP1ProofWithPublicValues, vkey: &SP1VerifyingKey, status_code: Option<StatusCode>, ) -> Result<(), SP1VerificationError>

Verify the given proof.

fn version(&self) -> &str

The version of the current SP1 circuit.

fn execute(&self, elf: Elf, stdin: SP1Stdin) -> ExecuteRequest<'_, Self>

Execute the program on the given input.