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 cpu::CpuProver;pub use mock::MockProver;pub use light::LightProver;pub use cuda::CudaProver;pub use crate::client::ProverClient;pub use prover::ProveRequest;pub use prover::Prover;pub use prover::ProvingKey;pub use prover::SP1ProvingKey;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
- light
- Light Prover
- mock
- Mock Prover
- prelude
- A prelude, including all the types and traits that are commonly used.
- 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§
- Execution
Report - An execution report.
- HookEnv
- Environment that a hook may read from.
- SP1Context
- Context to run a program inside SP1.
- SP1Context
Builder - A builder for
SP1Context. - SP1Public
Values - Public values for the prover.
- SP1Stdin
- Standard input for the prover.
- SP1Verifying
Key - The information necessary to verify a proof for a given RISC-V program.
- Status
Code - The status code of the execution.
Enums§
- Elf
- A type that represents an ELF binary, always cheap to clone.
- Prover
Mode - The mode of the prover.
Constants§
- SP1_
CIRCUIT_ VERSION - The global version for all components of SP1.
Traits§
- Hashable
Key - A trait for keys that can be hashed into a digest.
Functions§
- setup_
logger - A simple logger.