feat: ConfigureEvm::NextBlockEnvCtx (paradigmxyz#14801)

Author: klkvr

crates/ethereum/evm/src/execute.rs

@@ -4,7 +4,7 @@ use crate::{
     dao_fork::{DAO_HARDFORK_ACCOUNTS, DAO_HARDFORK_BENEFICIARY},
     EthEvmConfig,
 };
-use alloc::{boxed::Box, sync::Arc, vec::Vec};
+use alloc::{borrow::Cow, boxed::Box, sync::Arc, vec::Vec};
 use alloy_consensus::{Header, Transaction};
 use alloy_eips::{eip4895::Withdrawals, eip6110, eip7685::Requests};
 use alloy_evm::FromRecoveredTx;
@@ -17,8 +17,7 @@ use reth_evm::{
     },
     state_change::post_block_balance_increments,
     system_calls::{OnStateHook, StateChangePostBlockSource, StateChangeSource, SystemCaller},
-    Database, Evm, EvmEnv, EvmFactory, EvmFor, InspectorFor, NextBlockEnvAttributes,
-    TransactionEnv,
+    Database, Evm, EvmEnv, EvmFactory, EvmFor, InspectorFor, TransactionEnv,
 };
 use reth_execution_types::BlockExecutionResult;
 use reth_primitives::{
@@ -48,20 +47,20 @@ where
             parent_hash: block.header().parent_hash,
             parent_beacon_block_root: block.header().parent_beacon_block_root,
             ommers: &block.body().ommers,
-            withdrawals: block.body().withdrawals.as_ref(),
+            withdrawals: block.body().withdrawals.as_ref().map(Cow::Borrowed),
         }
     }
 
-    fn context_for_next_block<'a>(
+    fn context_for_next_block(
         &self,
         parent: &SealedHeader,
-        attributes: NextBlockEnvAttributes<'a>,
-    ) -> Self::ExecutionCtx<'a> {
+        attributes: Self::NextBlockEnvCtx,
+    ) -> Self::ExecutionCtx<'_> {
         EthBlockExecutionCtx {
             parent_hash: parent.hash(),
             parent_beacon_block_root: attributes.parent_beacon_block_root,
             ommers: &[],
-            withdrawals: attributes.withdrawals,
+            withdrawals: attributes.withdrawals.map(Cow::Owned),
         }
     }
 
@@ -79,7 +78,7 @@ where
 }
 
 /// Context for Ethereum block execution.
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone)]
 pub struct EthBlockExecutionCtx<'a> {
     /// Parent block hash.
     pub parent_hash: B256,
@@ -88,7 +87,7 @@ pub struct EthBlockExecutionCtx<'a> {
     /// Block ommers
     pub ommers: &'a [Header],
     /// Block withdrawals.
-    pub withdrawals: Option<&'a Withdrawals>,
+    pub withdrawals: Option<Cow<'a, Withdrawals>>,
 }
 
 /// Block execution strategy for Ethereum.
@@ -216,7 +215,7 @@ where
             self.chain_spec,
             self.evm.block(),
             self.ctx.ommers,
-            self.ctx.withdrawals,
+            self.ctx.withdrawals.as_deref(),
         );
 
         // Irregular state change at Ethereum DAO hardfork

crates/ethereum/evm/src/lib.rs

@@ -96,6 +96,7 @@ where
     type Error = Infallible;
     type TxEnv = EvmF::Tx;
     type Spec = SpecId;
+    type NextBlockEnvCtx = NextBlockEnvAttributes;
 
     fn evm_env(&self, header: &Self::Header) -> EvmEnv {
         let spec = config::revm_spec(self.chain_spec(), header);
@@ -123,7 +124,7 @@ where
     fn next_evm_env(
         &self,
         parent: &Self::Header,
-        attributes: NextBlockEnvAttributes<'_>,
+        attributes: &NextBlockEnvAttributes,
     ) -> Result<EvmEnv, Self::Error> {
         // ensure we're not missing any timestamp based hardforks
         let spec_id = revm_spec_by_timestamp_and_block_number(

crates/ethereum/node/src/node.rs

@@ -9,7 +9,7 @@ use reth_ethereum_engine_primitives::{
     EthBuiltPayload, EthPayloadAttributes, EthPayloadBuilderAttributes,
 };
 use reth_ethereum_primitives::{EthPrimitives, PooledTransaction};
-use reth_evm::{execute::BasicBlockExecutorProvider, ConfigureEvm};
+use reth_evm::{execute::BasicBlockExecutorProvider, ConfigureEvm, NextBlockEnvAttributes};
 use reth_network::{EthNetworkPrimitives, NetworkHandle, PeersInfo};
 use reth_node_api::{AddOnsContext, BlockTy, FullNodeComponents, NodeAddOns, ReceiptTy, TxTy};
 use reth_node_builder::{
@@ -178,7 +178,7 @@ where
             Primitives = EthPrimitives,
             Engine = EthEngineTypes,
         >,
-        Evm: ConfigureEvm<TxEnv = TxEnv>,
+        Evm: ConfigureEvm<TxEnv = TxEnv, NextBlockEnvCtx = NextBlockEnvAttributes>,
     >,
     EthApiError: FromEvmError<N::Evm>,
 {
@@ -218,7 +218,7 @@ where
             Primitives = EthPrimitives,
             Engine = EthEngineTypes,
         >,
-        Evm: ConfigureEvm<TxEnv = TxEnv>,
+        Evm: ConfigureEvm<TxEnv = TxEnv, NextBlockEnvCtx = NextBlockEnvAttributes>,
     >,
     EthApiError: FromEvmError<N::Evm>,
 {

crates/ethereum/payload/src/lib.rs

@@ -84,7 +84,10 @@ impl<Pool, Client, EvmConfig> EthereumPayloadBuilder<Pool, Client, EvmConfig> {
 // Default implementation of [PayloadBuilder] for unit type
 impl<Pool, Client, EvmConfig> PayloadBuilder for EthereumPayloadBuilder<Pool, Client, EvmConfig>
 where
-    EvmConfig: BlockExecutionStrategyFactory<Primitives = EthPrimitives>,
+    EvmConfig: BlockExecutionStrategyFactory<
+        Primitives = EthPrimitives,
+        NextBlockEnvCtx = NextBlockEnvAttributes,
+    >,
     Client: StateProviderFactory + ChainSpecProvider<ChainSpec = ChainSpec> + Clone,
     Pool: TransactionPool<Transaction: PoolTransaction<Consensus = TransactionSigned>>,
 {
@@ -139,7 +142,10 @@ pub fn default_ethereum_payload<EvmConfig, Client, Pool, F>(
     best_txs: F,
 ) -> Result<BuildOutcome<EthBuiltPayload>, PayloadBuilderError>
 where
-    EvmConfig: BlockExecutionStrategyFactory<Primitives = EthPrimitives>,
+    EvmConfig: BlockExecutionStrategyFactory<
+        Primitives = EthPrimitives,
+        NextBlockEnvCtx = NextBlockEnvAttributes,
+    >,
     Client: StateProviderFactory + ChainSpecProvider<ChainSpec = ChainSpec>,
     Pool: TransactionPool<Transaction: PoolTransaction<Consensus = TransactionSigned>>,
     F: FnOnce(BestTransactionsAttributes) -> BestTransactionsIter<Pool>,
@@ -158,7 +164,7 @@ where
         prev_randao: attributes.prev_randao(),
         gas_limit: builder_config.gas_limit(parent_header.gas_limit),
         parent_beacon_block_root: attributes.parent_beacon_block_root(),
-        withdrawals: Some(attributes.withdrawals()),
+        withdrawals: Some(attributes.withdrawals().clone()),
     };
 
     let mut strategy = evm_config

crates/evm/src/execute.rs

@@ -3,10 +3,7 @@
 use alloy_consensus::BlockHeader;
 use alloy_evm::Evm;
 // Re-export execution types
-use crate::{
-    system_calls::OnStateHook, ConfigureEvmFor, Database, EvmFor, InspectorFor,
-    NextBlockEnvAttributes,
-};
+use crate::{system_calls::OnStateHook, ConfigureEvmFor, Database, EvmFor, InspectorFor};
 use alloc::{boxed::Box, vec::Vec};
 use alloy_primitives::{
     map::{DefaultHashBuilder, HashMap},
@@ -235,7 +232,7 @@ pub trait BlockExecutionStrategy {
 ///
 /// Strategy is required to provide a way to obtain [`ExecutionCtx`] from either a complete
 /// [`SealedBlock`] (in case of execution of an externally obtained block), or from a parent header
-/// along with [`NextBlockEnvAttributes`] (in the case of block building).
+/// along with [`crate::ConfigureEvmEnv::NextBlockEnvCtx`] (in the case of block building).
 ///
 /// For more context on the strategy design, see the documentation for [`BlockExecutionStrategy`].
 ///
@@ -265,11 +262,11 @@ pub trait BlockExecutionStrategyFactory: ConfigureEvmFor<Self::Primitives> + 'st
 
     /// Returns the configured [`BlockExecutionStrategyFactory::ExecutionCtx`] for `parent + 1`
     /// block.
-    fn context_for_next_block<'a>(
+    fn context_for_next_block(
         &self,
         parent: &SealedHeader<<Self::Primitives as NodePrimitives>::BlockHeader>,
-        attributes: NextBlockEnvAttributes<'a>,
-    ) -> Self::ExecutionCtx<'a>;
+        attributes: Self::NextBlockEnvCtx,
+    ) -> Self::ExecutionCtx<'_>;
 
     /// Creates a strategy with given EVM and execution context.
     fn create_strategy<'a, DB, I>(
@@ -297,9 +294,9 @@ pub trait BlockExecutionStrategyFactory: ConfigureEvmFor<Self::Primitives> + 'st
         &'a self,
         db: &'a mut State<DB>,
         parent: &'a SealedHeader<<Self::Primitives as NodePrimitives>::BlockHeader>,
-        attributes: NextBlockEnvAttributes<'a>,
+        attributes: Self::NextBlockEnvCtx,
     ) -> Result<Self::Strategy<'a, DB, NoOpInspector>, Self::Error> {
-        let evm_env = self.next_evm_env(parent, attributes)?;
+        let evm_env = self.next_evm_env(parent, &attributes)?;
         let evm = self.evm_with_env(db, evm_env);
         let ctx = self.context_for_next_block(parent, attributes);
         Ok(self.create_strategy(evm, ctx))

crates/evm/src/lib.rs

@@ -161,6 +161,11 @@ pub trait ConfigureEvmEnv: Send + Sync + Unpin + Clone {
     /// Identifier of the EVM specification.
     type Spec: Debug + Copy + Send + Sync + 'static;
 
+    /// Context required for configuring next block environment.
+    ///
+    /// Contains values that can't be derived from the parent block.
+    type NextBlockEnvCtx: Debug + Clone;
+
     /// Returns a [`TxEnv`] from a transaction and [`Address`].
     fn tx_env(&self, transaction: impl IntoTxEnv<Self::TxEnv>) -> Self::TxEnv {
         transaction.into_tx_env()
@@ -177,16 +182,16 @@ pub trait ConfigureEvmEnv: Send + Sync + Unpin + Clone {
     fn next_evm_env(
         &self,
         parent: &Self::Header,
-        attributes: NextBlockEnvAttributes<'_>,
+        attributes: &Self::NextBlockEnvCtx,
     ) -> Result<EvmEnv<Self::Spec>, Self::Error>;
 }
 
 /// Represents additional attributes required to configure the next block.
 /// This is used to configure the next block's environment
 /// [`ConfigureEvmEnv::next_evm_env`] and contains fields that can't be derived from the
 /// parent header alone (attributes that are determined by the CL.)
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
-pub struct NextBlockEnvAttributes<'a> {
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct NextBlockEnvAttributes {
     /// The timestamp of the next block.
     pub timestamp: u64,
     /// The suggested fee recipient for the next block.
@@ -198,7 +203,7 @@ pub struct NextBlockEnvAttributes<'a> {
     /// The parent beacon block root.
     pub parent_beacon_block_root: Option<B256>,
     /// Withdrawals
-    pub withdrawals: Option<&'a Withdrawals>,
+    pub withdrawals: Option<Withdrawals>,
 }
 
 /// Abstraction over transaction environment.

crates/optimism/evm/src/config.rs

@@ -1,6 +1,24 @@
 use alloy_consensus::BlockHeader;
 use reth_optimism_forks::OpHardforks;
 use revm_optimism::OpSpecId;
+use revm_primitives::{Address, Bytes, B256};
+
+/// Context relevant for execution of a next block w.r.t OP.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct OpNextBlockEnvAttributes {
+    /// The timestamp of the next block.
+    pub timestamp: u64,
+    /// The suggested fee recipient for the next block.
+    pub suggested_fee_recipient: Address,
+    /// The randomness value for the next block.
+    pub prev_randao: B256,
+    /// Block gas limit.
+    pub gas_limit: u64,
+    /// The parent beacon block root.
+    pub parent_beacon_block_root: Option<B256>,
+    /// Encoded EIP-1559 parameters to include into block's `extra_data` field.
+    pub extra_data: Bytes,
+}
 
 /// Map the latest active hardfork at the given header to a revm [`OpSpecId`].
 pub fn revm_spec(chain_spec: impl OpHardforks, header: impl BlockHeader) -> OpSpecId {

crates/optimism/evm/src/execute.rs

@@ -18,7 +18,7 @@ use reth_evm::{
     },
     state_change::post_block_balance_increments,
     system_calls::{OnStateHook, StateChangePostBlockSource, StateChangeSource, SystemCaller},
-    Database, Evm, EvmFor, InspectorFor, NextBlockEnvAttributes,
+    Database, Evm, EvmFor, InspectorFor,
 };
 use reth_execution_types::BlockExecutionResult;
 use reth_optimism_chainspec::OpChainSpec;
@@ -48,11 +48,11 @@ where
         }
     }
 
-    fn context_for_next_block<'a>(
+    fn context_for_next_block(
         &self,
         parent: &SealedHeader<N::BlockHeader>,
-        attributes: NextBlockEnvAttributes<'a>,
-    ) -> Self::ExecutionCtx<'a> {
+        attributes: Self::NextBlockEnvCtx,
+    ) -> Self::ExecutionCtx<'_> {
         OpBlockExecutionCtx {
             parent_hash: parent.hash(),
             parent_beacon_block_root: attributes.parent_beacon_block_root,

crates/optimism/evm/src/lib.rs

@@ -18,7 +18,7 @@ use alloy_primitives::U256;
 use core::fmt::Debug;
 use op_alloy_consensus::EIP1559ParamError;
 use reth_chainspec::EthChainSpec;
-use reth_evm::{ConfigureEvm, ConfigureEvmEnv, EvmEnv, NextBlockEnvAttributes};
+use reth_evm::{ConfigureEvm, ConfigureEvmEnv, EvmEnv};
 use reth_optimism_chainspec::OpChainSpec;
 use reth_optimism_consensus::next_block_base_fee;
 use reth_optimism_forks::OpHardforks;
@@ -32,7 +32,7 @@ use revm::{
 use revm_optimism::{OpHaltReason, OpSpecId, OpTransaction};
 
 mod config;
-pub use config::{revm_spec, revm_spec_by_timestamp_after_bedrock};
+pub use config::{revm_spec, revm_spec_by_timestamp_after_bedrock, OpNextBlockEnvAttributes};
 mod execute;
 pub use execute::*;
 pub mod l1;
@@ -98,6 +98,7 @@ where
     type Error = EIP1559ParamError;
     type TxEnv = OpTransaction<TxEnv>;
     type Spec = OpSpecId;
+    type NextBlockEnvCtx = OpNextBlockEnvAttributes;
 
     fn evm_env(&self, header: &Self::Header) -> EvmEnv<Self::Spec> {
         let spec = config::revm_spec(self.chain_spec(), header);
@@ -132,7 +133,7 @@ where
     fn next_evm_env(
         &self,
         parent: &Self::Header,
-        attributes: NextBlockEnvAttributes<'_>,
+        attributes: &Self::NextBlockEnvCtx,
     ) -> Result<EvmEnv<Self::Spec>, Self::Error> {
         // ensure we're not missing any timestamp based hardforks
         let spec_id = revm_spec_by_timestamp_after_bedrock(&self.chain_spec, attributes.timestamp);

crates/optimism/node/src/node.rs

@@ -29,7 +29,7 @@ use reth_node_builder::{
 };
 use reth_optimism_chainspec::OpChainSpec;
 use reth_optimism_consensus::OpBeaconConsensus;
-use reth_optimism_evm::{BasicOpReceiptBuilder, OpEvmConfig};
+use reth_optimism_evm::{BasicOpReceiptBuilder, OpEvmConfig, OpNextBlockEnvAttributes};
 use reth_optimism_forks::OpHardforks;
 use reth_optimism_payload_builder::{
     builder::OpPayloadTransactions,
@@ -279,7 +279,10 @@ where
             Storage = OpStorage,
             Engine = OpEngineTypes,
         >,
-        Evm: ConfigureEvmEnv<TxEnv = revm_optimism::OpTransaction<TxEnv>>,
+        Evm: ConfigureEvmEnv<
+            TxEnv = revm_optimism::OpTransaction<TxEnv>,
+            NextBlockEnvCtx = OpNextBlockEnvAttributes,
+        >,
     >,
     OpEthApiError: FromEvmError<N::Evm>,
     <<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: MaybeConditionalTransaction,
@@ -351,7 +354,10 @@ where
             Storage = OpStorage,
             Engine = OpEngineTypes,
         >,
-        Evm: ConfigureEvm<TxEnv = revm_optimism::OpTransaction<TxEnv>>,
+        Evm: ConfigureEvm<
+            TxEnv = revm_optimism::OpTransaction<TxEnv>,
+            NextBlockEnvCtx = OpNextBlockEnvAttributes,
+        >,
     >,
     OpEthApiError: FromEvmError<N::Evm>,
     <<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: MaybeConditionalTransaction,