Struct SP1ContextBuilder

pub struct SP1ContextBuilder<'a> { /* private fields */ }

A builder for SP1Context.

Implementations

impl<'a> SP1ContextBuilder<'a>

pub fn new() -> Self

Create a new SP1ContextBuilder.

Prefer using SP1Context::builder.

pub fn build(&mut self) -> SP1Context<'a>

Build and return the SP1Context.

Clears and resets the builder, allowing it to be reused.

pub fn hook( &mut self, fd: u32, f: impl FnMut(HookEnv<'_, '_>, &[u8]) -> Vec<Vec<u8>> + Send + Sync + 'a, ) -> &mut Self

Add a runtime Hook into the context.

Hooks may be invoked from within SP1 by writing to the specified file descriptor fd with [sp1_zkvm::io::write], returning a list of arbitrary data that may be read with successive calls to [sp1_zkvm::io::read].

pub fn without_default_hooks(&mut self) -> &mut Self

Avoid registering the default hooks in the runtime.

It is not necessary to call this to override hooks — instead, simply register a hook with the same value of fd by calling Self::hook.

pub fn subproof_verifier( &mut self, subproof_verifier: Arc<dyn SubproofVerifier + 'a>, ) -> &mut Self

Add a subproof verifier.

The verifier is used to sanity check verify_sp1_proof during runtime.

pub fn max_cycles(&mut self, max_cycles: u64) -> &mut Self

Set the maximum number of cpu cycles to use for execution.

Trait Implementations

impl<'a> Clone for SP1ContextBuilder<'a>

fn clone(&self) -> SP1ContextBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for SP1ContextBuilder<'a>

fn default() -> SP1ContextBuilder<'a>

Returns the “default value” for a type.