Crate sp1_sdk

Source
Expand description

§SP1 SDK

A library for interacting with the SP1 RISC-V zkVM.

Visit the Getting Started section in the official SP1 documentation for a quick start guide.

Re-exports§

pub use crate::client::ProverClient;
pub use crate::cpu::CpuProver;
pub use crate::cuda::CudaProver;
pub use crate::env::EnvProver;
pub use crate::network::prover::NetworkProver;
pub use prover::Prover;
pub use prover::SP1VerificationError;
pub use proof::*;

Modules§

artifacts
SP1 Artifacts
client
SP1 Prover Client
cpu
SP1 CPU Prover
cuda
SP1 CUDA Prover
env
SP1 Environment Prover
install
SP1 Install
network
SP1 Network
proof
SP1 Proof
prover
SP1 Prover Trait
utils
SP1 SDK Utilities

Macros§

include_elf
Returns the raw ELF bytes by the zkVM program target name.

Structs§

ExecutionReport
An execution report.
Executor
An executor for the SP1 RISC-V zkVM.
HookEnv
Environment that a hook may read from.
SP1Context
Context to run a program inside SP1.
SP1ContextBuilder
A builder for SP1Context.
SP1Prover
A end-to-end for the SP1 RISC-V zkVM.
SP1ProvingKey
The information necessary to generate a proof for a given RISC-V program.
SP1PublicValues
Public values for the prover.
SP1Stdin
Standard input for the prover.
SP1VerifyingKey
The information necessary to verify a proof for a given RISC-V program.

Enums§

ProverMode
The mode of the prover.

Constants§

SP1_CIRCUIT_VERSION
The global version for all components of SP1.

Traits§

HashableKey
A trait for keys that can be hashed into a digest.

Functions§

setup_logger
A simple logger.