risc0_steel::host

Struct EvmEnvBuilder

Source 
pub struct EvmEnvBuilder<P, F, S, B> { /* private fields */ }
Available on crate feature host only.
Expand description

Builder for constructing an EvmEnv instance on the host.

The EvmEnvBuilder is used to configure and create an EvmEnv, which is the environment in which the Ethereum Virtual Machine (EVM) operates. This builder provides flexibility in setting up the EVM environment by allowing configuration of RPC endpoints, block numbers, and other parameters.

§Usage

The builder can be created using EvmEnv::builder(). Various configurations can be chained to customize the environment before calling the build function to create the final EvmEnv.

Implementations§

Source§

impl<S> EvmEnvBuilder<(), EthEvmFactory, S, ()>

Source

pub fn rpc( self, url: Url, ) -> EvmEnvBuilder<RootProvider<Ethereum>, EthEvmFactory, S, ()>

Sets the Ethereum HTTP RPC endpoint that will be used by the EvmEnv.

Source§

impl<F: EvmFactory, S> EvmEnvBuilder<(), F, S, ()>

Source

pub fn provider<N, P>(self, provider: P) -> EvmEnvBuilder<P, F, S, ()>
where N: Network, P: Provider<N>, F::Header: TryFrom<<N as Network>::HeaderResponse>, <F::Header as TryFrom<<N as Network>::HeaderResponse>>::Error: Display,

Sets a custom [Provider] that will be used by the EvmEnv.

Source§

impl<P, F: EvmFactory, B> EvmEnvBuilder<P, F, (), B>

Source

pub fn chain_spec( self, chain_spec: &ChainSpec<F::Spec>, ) -> EvmEnvBuilder<P, F, &ChainSpec<F::Spec>, B>

Sets the ChainSpec that will be used by the EvmEnv.

Source§

impl<P, S> EvmEnvBuilder<P, EthEvmFactory, S, ()>

Source

pub fn beacon_api(self, url: Url) -> EvmEnvBuilder<P, EthEvmFactory, S, Beacon>

Sets the Beacon API URL for retrieving Ethereum Beacon block root commitments.

This function configures the EvmEnv to interact with an Ethereum Beacon chain. It assumes the use of the mainnet preset for consensus specs.

Source§

impl<P, F, S, B> EvmEnvBuilder<P, F, S, B>

Source

pub fn block_number(self, number: u64) -> Self

Sets the block number to be used for the EVM execution.

Source

pub fn block_number_or_tag(self, block: BlockNumberOrTag) -> Self

Sets the block number or block tag (“latest”, “earliest”, “pending”) to be used for the EVM execution.

Source

pub fn block_hash(self, hash: B256) -> Self

Sets the block hash to be used for the EVM execution.

Source

pub fn eip1186_proof_chunk_size(self, chunk_size: usize) -> Self

Sets the chunk size for eth_getProof calls (EIP-1186).

This configures the number of storage keys to request in a single call. The default is 1000, but this can be adjusted based on the RPC node configuration.

Source§

impl<P, F: EvmFactory> EvmEnvBuilder<P, F, &ChainSpec<F::Spec>, ()>

Source

pub async fn build<N>( self, ) -> Result<EvmEnv<ProofDb<ProviderDb<N, P>>, F, HostCommit<()>>>
where N: Network, P: Provider<N>, F::Header: TryFrom<<N as Network>::HeaderResponse>, <F::Header as TryFrom<<N as Network>::HeaderResponse>>::Error: Display,

Builds and returns an EvmEnv with the configured settings that commits to a block hash.

Source§

impl<P, S> EvmEnvBuilder<P, EthEvmFactory, S, Beacon>

Source

pub fn consensus_commitment(self) -> Self

Configures the environment builder to generate consensus commitments.

A consensus commitment contains the beacon block root indexed directly by its slot number. This is in contrast to the default mechanism, which relies on timestamps for lookups, for verification using the EIP-4788 beacon root contract deployed at the execution layer.

The use of slot-based indexing is particularly beneficial for verification methods that have direct access to the state of the beacon chain, such as systems using beacon light clients. This allows the commitment to be verified directly against the state of the consensus layer.

§Example
let builder = EthEvmEnv::builder()
    .rpc(Url::parse("https://ethereum-rpc.publicnode.com")?)
    .beacon_api(Url::parse("https://ethereum-beacon-api.publicnode.com")?)
    .chain_spec(&ETH_MAINNET_CHAIN_SPEC)
    // Configure the builder to use slot-indexed consensus commitments.
    .consensus_commitment();

// The resulting 'env' will be configured to generate a consensus commitment
// (beacon root indexed by slot) when processing blocks or state.
let env = builder.build().await?;
Source

pub fn commitment_block_hash( self, hash: BlockHash, ) -> EvmEnvBuilder<P, EthEvmFactory, S, History>

Sets the block hash for the commitment block, which can be different from the execution block.

This allows for historical state execution while maintaining security through a more recent commitment. The commitment block must be more recent than the execution block.

Note that this feature requires a Beacon chain RPC provider, as it relies on EIP-4788.

§Example
let commitment_hash = B256::from_str("0x1234...")?;
let builder = EthEvmEnv::builder()
    .rpc(Url::parse("https://ethereum-rpc.publicnode.com")?)
    .beacon_api(Url::parse("https://ethereum-beacon-api.publicnode.com")?)
    .block_number(1_000_000) // execute against historical state
    .commitment_block_hash(commitment_hash) // commit to recent block
    .chain_spec(&ETH_MAINNET_CHAIN_SPEC);
let env = builder.build().await?;
Source

pub fn commitment_block_number_or_tag( self, block: BlockNumberOrTag, ) -> EvmEnvBuilder<P, EthEvmFactory, S, History>

Sets the block number or block tag (“latest”, “earliest”, “pending”) for the commitment.

See EvmEnvBuilder::commitment_block_hash for detailed documentation.

Source

pub fn commitment_block_number( self, number: BlockNumber, ) -> EvmEnvBuilder<P, EthEvmFactory, S, History>

Sets the block number for the commitment.

See EvmEnvBuilder::commitment_block_hash for detailed documentation.

Source§

impl<P> EvmEnvBuilder<P, EthEvmFactory, &ChainSpec<<EthEvmFactory as EvmFactory>::Spec>, Beacon>

Source

pub async fn build( self, ) -> Result<EthEvmEnv<ProofDb<ProviderDb<Ethereum, P>>, HostCommit<BeaconCommit>>>
where P: Provider<Ethereum>,

Builds and returns an EvmEnv with the configured settings that commits to a beacon root.

Source§

impl<P> EvmEnvBuilder<P, EthEvmFactory, &ChainSpec<<EthEvmFactory as EvmFactory>::Spec>, History>

Source

pub fn consensus_commitment(self) -> Self

Configures the environment builder to generate consensus commitments.

See EvmEnvBuilder<P, EthBlockHeader, Beacon>::consensus_commitment for more info.

Source

pub async fn build( self, ) -> Result<EthEvmEnv<ProofDb<ProviderDb<Ethereum, P>>, HostCommit<HistoryCommit>>>
where P: Provider<Ethereum>,

Builds and returns an EvmEnv with the configured settings, using a dedicated commitment block that is different from the execution block.

Trait Implementations§

Source§

impl<P: Clone, F: Clone, S: Clone, B: Clone> Clone for EvmEnvBuilder<P, F, S, B>

Source§

fn clone(&self) -> EvmEnvBuilder<P, F, S, B>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P: Debug, F: Debug, S: Debug, B: Debug> Debug for EvmEnvBuilder<P, F, S, B>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P, F, S, B> Freeze for EvmEnvBuilder<P, F, S, B>
where P: Freeze, S: Freeze, B: Freeze,

§

impl<P, F, S, B> RefUnwindSafe for EvmEnvBuilder<P, F, S, B>
where P: RefUnwindSafe, S: RefUnwindSafe, B: RefUnwindSafe, F: RefUnwindSafe,

§

impl<P, F, S, B> Send for EvmEnvBuilder<P, F, S, B>
where P: Send, S: Send, B: Send, F: Send,

§

impl<P, F, S, B> Sync for EvmEnvBuilder<P, F, S, B>
where P: Sync, S: Sync, B: Sync, F: Sync,

§

impl<P, F, S, B> Unpin for EvmEnvBuilder<P, F, S, B>
where P: Unpin, S: Unpin, B: Unpin, F: Unpin,

§

impl<P, F, S, B> UnwindSafe for EvmEnvBuilder<P, F, S, B>
where P: UnwindSafe, S: UnwindSafe, B: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a [TxEnv] from a transaction and a sender address.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a [TxEnv] from a transaction, its sender, and encoded transaction bytes.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,