feat(executor): EIP-2935 Syscall Support [ISTHMUS] (#963)

crates/executor/src/executor/mod.rs

@@ -4,7 +4,10 @@ use crate::{
     constants::{L2_TO_L1_BRIDGE, OUTPUT_ROOT_VERSION},
     db::TrieDB,
     errors::TrieDBError,
-    syscalls::{ensure_create2_deployer_canyon, pre_block_beacon_root_contract_call},
+    syscalls::{
+        ensure_create2_deployer_canyon, pre_block_beacon_root_contract_call,
+        pre_block_block_hash_contract_call,
+    },
     ExecutorError, ExecutorResult, TrieDBProvider,
 };
 use alloc::vec::Vec;
@@ -120,6 +123,8 @@ where
             tx_len = transactions.len(),
         );
 
+        let parent_block_hash: B256 = self.trie_db.parent_block_header().seal();
+
         let mut state =
             State::builder().with_database(&mut self.trie_db).with_bundle_update().build();
 
@@ -133,6 +138,17 @@ where
             &payload,
         )?;
 
+        // Apply the pre-block EIP-2935 contract call.
+        pre_block_block_hash_contract_call(
+            &mut state,
+            self.config,
+            block_number,
+            &initialized_cfg,
+            &initialized_block_env,
+            parent_block_hash,
+            &payload,
+        )?;
+
         // Ensure that the create2 contract is deployed upon transition to the Canyon hardfork.
         ensure_create2_deployer_canyon(
             &mut state,

crates/executor/src/syscalls/eip2935.rs

@@ -0,0 +1,183 @@
+//! Contains the [EIP-2935][eip-2935] syscall.
+//!
+//! [eip-2935]: https://eips.ethereum.org/EIPS/eip-2935
+
+use crate::{
+    db::TrieDB,
+    errors::{ExecutorError, ExecutorResult},
+    TrieDBProvider,
+};
+use alloc::{boxed::Box, vec::Vec};
+use alloy_primitives::{Address, Bytes, B256, U256};
+use kona_mpt::TrieHinter;
+use maili_genesis::RollupConfig;
+use op_alloy_rpc_types_engine::OpPayloadAttributes;
+use revm::{
+    db::State,
+    primitives::{
+        BlockEnv, CfgEnvWithHandlerCfg, Env, EnvWithHandlerCfg, OptimismFields, TransactTo, TxEnv,
+    },
+    DatabaseCommit, Evm,
+};
+
+/// Execute the [EIP-2935][EIP-2935] pre-block block hash contract call.
+///
+/// If Isthmus is not activated, or the block is the genesis block, then this is a no-op, and no
+/// state changes are made.
+///
+/// Note: this does not commit the state changes to the database, it only transact the call.
+///
+/// Returns `None` if Isthmus is not active or the block is the genesis block, otherwise returns the
+/// result of the call.
+///
+/// [EIP-2935]: https://eips.ethereum.org/EIPS/eip-2935
+pub(crate) fn pre_block_block_hash_contract_call<F, H>(
+    db: &mut State<&mut TrieDB<F, H>>,
+    config: &RollupConfig,
+    block_number: u64,
+    initialized_cfg: &CfgEnvWithHandlerCfg,
+    initialized_block_env: &BlockEnv,
+    parent_block_hash: B256,
+    payload: &OpPayloadAttributes,
+) -> ExecutorResult<()>
+where
+    F: TrieDBProvider,
+    H: TrieHinter,
+{
+    // apply pre-block EIP-4788 contract call
+    let mut evm_pre_block = Evm::builder()
+        .with_db(db)
+        .with_env_with_handler_cfg(EnvWithHandlerCfg::new_with_cfg_env(
+            initialized_cfg.clone(),
+            initialized_block_env.clone(),
+            Default::default(),
+        ))
+        .build();
+
+    // initialize a block from the env, because the pre block call needs the block itself
+    apply_block_hash_contract_call(
+        config,
+        payload.payload_attributes.timestamp,
+        block_number,
+        parent_block_hash,
+        &mut evm_pre_block,
+    )
+}
+
+/// Apply the EIP-4788 pre-block beacon root contract call to a given EVM instance.
+fn apply_block_hash_contract_call<F, H>(
+    config: &RollupConfig,
+    timestamp: u64,
+    block_number: u64,
+    parent_block_hash: B256,
+    evm: &mut Evm<'_, (), &mut State<&mut TrieDB<F, H>>>,
+) -> ExecutorResult<()>
+where
+    F: TrieDBProvider,
+    H: TrieHinter,
+{
+    if !config.is_isthmus_active(timestamp) {
+        return Ok(());
+    }
+
+    // If the block number is zero (genesis block) then no system
+    // transaction may occur as per EIP-2935.
+    if block_number == 0 {
+        return Ok(())
+    }
+
+    // Get the previous environment
+    let previous_env = Box::new(evm.context.evm.env().clone());
+
+    // modify env for pre block call
+    fill_tx_env_with_block_hash_contract_call(&mut evm.context.evm.env, parent_block_hash);
+
+    let mut state = match evm.transact() {
+        Ok(res) => res.state,
+        Err(e) => {
+            evm.context.evm.env = previous_env;
+            return Err(ExecutorError::ExecutionError(e));
+        }
+    };
+
+    // NOTE: Revm currently marks these accounts as "touched" when we do the above transact calls,
+    // and includes them in the result.
+    //
+    // There should be no state changes to these addresses anyways as a result of this system call,
+    // so we can just remove them from the state returned.
+    state.remove(&alloy_eips::eip4788::SYSTEM_ADDRESS);
+    state.remove(&evm.block().coinbase);
+
+    evm.context.evm.db.commit(state);
+
+    // re-set the previous env
+    evm.context.evm.env = previous_env;
+
+    Ok(())
+}
+
+/// Fill transaction environment with the EIP-2935 system contract message data.
+///
+/// This requirements for the beacon root contract call defined by
+/// [EIP-2935](https://eips.ethereum.org/EIPS/eip-2935) are:
+fn fill_tx_env_with_block_hash_contract_call(env: &mut Env, parent_block_hash: B256) {
+    fill_tx_env_with_system_contract_call(
+        env,
+        alloy_eips::eip4788::SYSTEM_ADDRESS,
+        alloy_eips::eip2935::HISTORY_STORAGE_ADDRESS,
+        parent_block_hash.into(),
+    );
+}
+
+/// Fill transaction environment with the system caller and the system contract address and message
+/// data.
+///
+/// This is a system operation and therefore:
+///  * the call must execute to completion
+///  * the call does not count against the block’s gas limit
+///  * the call does not follow the EIP-1559 burn semantics - no value should be transferred as part
+///    of the call
+///  * if no code exists at the provided address, the call will fail silently
+fn fill_tx_env_with_system_contract_call(
+    env: &mut Env,
+    caller: Address,
+    contract: Address,
+    data: Bytes,
+) {
+    env.tx = TxEnv {
+        caller,
+        transact_to: TransactTo::Call(contract),
+        // Explicitly set nonce to None so revm does not do any nonce checks
+        nonce: None,
+        gas_limit: 30_000_000,
+        value: U256::ZERO,
+        data,
+        // Setting the gas price to zero enforces that no value is transferred as part of the call,
+        // and that the call will not count against the block's gas limit
+        gas_price: U256::ZERO,
+        // The chain ID check is not relevant here and is disabled if set to None
+        chain_id: None,
+        // Setting the gas priority fee to None ensures the effective gas price is derived from the
+        // `gas_price` field, which we need to be zero
+        gas_priority_fee: None,
+        access_list: Vec::new(),
+        authorization_list: None,
+        // blob fields can be None for this tx
+        blob_hashes: Vec::new(),
+        max_fee_per_blob_gas: None,
+        optimism: OptimismFields {
+            source_hash: None,
+            mint: None,
+            is_system_transaction: Some(false),
+            // The L1 fee is not charged for the EIP-4788 transaction, submit zero bytes for the
+            // enveloped tx size.
+            enveloped_tx: Some(Bytes::default()),
+        },
+    };
+
+    // ensure the block gas limit is >= the tx
+    env.block.gas_limit = U256::from(env.tx.gas_limit);
+
+    // disable the base fee check for this call by setting the base fee to zero
+    env.block.basefee = U256::ZERO;
+}

crates/executor/src/syscalls/mod.rs

@@ -1,5 +1,8 @@
 //! Optimism EVM System calls.
 
+mod eip2935;
+pub(crate) use eip2935::pre_block_block_hash_contract_call;
+
 mod eip4788;
 pub(crate) use eip4788::pre_block_beacon_root_contract_call;