Struct SP1ContextBuilder

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

A builder for SP1Context.

Implementations

impl<'a> SP1ContextBuilder<'a>

pub fn new() -> SP1ContextBuilder<'a>

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 SP1ContextBuilder<'a>

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].

Panics

Panics if fd <= LOWEST_ALLOWED_FD.

pub fn without_default_hooks(&mut self) -> &mut SP1ContextBuilder<'a>

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 calculate_gas(&mut self, value: bool) -> &mut SP1ContextBuilder<'a>

Whether gas should be calculated while executing. Defaults to true. Determines whether the gas field in the ExecutionReport is None or Some.

During proving, gas is not calculated, so this option has no effect.

Disabling gas calculation will likely speed up execution.

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

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 SP1ContextBuilder<'a>

Set the maximum number of cpu cycles to use for execution. report.total_instruction_count() will be less than or equal to max_cycles.

pub fn set_deferred_proof_verification( &mut self, value: bool, ) -> &mut SP1ContextBuilder<'a>

Set the deferred proof verification flag.

pub fn stdout<W>(&mut self, writer: &'a mut W) -> &mut SP1ContextBuilder<'a>

where W: IoWriter,

Set the stdout writer.

pub fn stderr<W>(&mut self, writer: &'a mut W) -> &mut SP1ContextBuilder<'a>

where W: IoWriter,

Set the stderr writer.

Trait Implementations

impl Default for SP1ContextBuilder<'_>

fn default() -> SP1ContextBuilder<'_>

Returns the “default value” for a type.