Struct EnvProver 

pub struct EnvProver { /* private fields */ }

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

The environment variables are described in EnvProver::new.

Implementations

impl EnvProver

pub fn new() -> Self

Creates a new EnvProver with the given configuration.

The following environment variables are used to configure the prover:

• SP1_PROVER: The type of prover to use. Must be one of mock, local, cuda, or network.
• NETWORK_PRIVATE_KEY: The private key to use for the network prover.
• NETWORK_RPC_URL: The RPC URL to use for the network prover.

pub fn execute<'a>( &'a self, elf: &'a [u8], stdin: &SP1Stdin, ) -> CpuExecuteBuilder<'a>

Creates a new CpuExecuteBuilder for simulating the execution of a program on the CPU.

Details

The builder is used for both the crate::cpu::CpuProver and crate::CudaProver client types.

Example

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

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

let client = ProverClient::from_env();
let (public_values, execution_report) = client.execute(elf, &stdin).run().unwrap();

pub fn prove<'a>( &'a self, pk: &'a SP1ProvingKey, stdin: &'a SP1Stdin, ) -> EnvProveBuilder<'a>

Creates a new EnvProveBuilder for proving a program on the CPU.

Details

The builder is used for only the crate::cpu::CpuProver client type.

Example

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

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

let client = ProverClient::from_env();
let (pk, vk) = client.setup(elf);
let builder = client.prove(&pk, &stdin).core().run();

pub fn verify( &self, proof: &SP1ProofWithPublicValues, vk: &SP1VerifyingKey, ) -> Result<(), SP1VerificationError>

Verifies that the given proof is valid and matches the given verification key produced by Self::setup.

Examples

use sp1_sdk::{ProverClient, SP1Stdin};

let elf = test_artifacts::FIBONACCI_ELF;
let stdin = SP1Stdin::new();

let client = ProverClient::from_env();
let (pk, vk) = client.setup(elf);
let proof = client.prove(&pk, &stdin).run().unwrap();
client.verify(&proof, &vk).unwrap();

pub fn setup(&self, elf: &[u8]) -> (SP1ProvingKey, SP1VerifyingKey)

Setup a program to be proven and verified by the SP1 RISC-V zkVM by computing the proving and verifying keys.

Trait Implementations

impl Default for EnvProver

fn default() -> Self

Returns the “default value” for a type.

impl Prover<CpuProverComponents> for EnvProver

fn inner(&self) -> &SP1Prover<CpuProverComponents>

The inner SP1Prover struct used by the prover.

fn setup(&self, elf: &[u8]) -> (SP1ProvingKey, SP1VerifyingKey)

Generate the proving and verifying keys for the given program.

fn prove( &self, pk: &SP1ProvingKey, stdin: &SP1Stdin, mode: SP1ProofMode, ) -> Result<SP1ProofWithPublicValues>

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

fn verify( &self, bundle: &SP1ProofWithPublicValues, vkey: &SP1VerifyingKey, ) -> Result<(), SP1VerificationError>

Verify that an SP1 proof is valid given its vkey and metadata. For Plonk proofs, verifies that the public inputs of the PlonkBn254 proof match the hash of the VK and the committed public values of the SP1ProofWithPublicValues.

fn version(&self) -> &str

The version of the current SP1 circuit.

fn execute( &self, elf: &[u8], stdin: &SP1Stdin, ) -> Result<(SP1PublicValues, ExecutionReport)>

Executes the program on the given input.