Start op-revm changes

crates/interpreter/Cargo.toml

@@ -59,3 +59,4 @@ arbitrary = [
     "dep:proptest-derive",
     "revm-primitives/arbitrary",
 ]
+optimism = ["revm-primitives/optimism"]

crates/interpreter/src/instructions/opcode.rs

@@ -924,5 +924,13 @@ pub const fn spec_opcode_gas(spec_id: SpecId) -> &'static [OpInfo; 256] {
             gas_opcodee!(LATEST, SpecId::LATEST);
             LATEST
         }
+        SpecId::BEDROCK => {
+            gas_opcodee!(BEDROCK, SpecId::BEDROCK);
+            BEDROCK
+        }
+        SpecId::REGOLITH => {
+            gas_opcodee!(REGOLITH, SpecId::REGOLITH);
+            REGOLITH
+        }
     }
 }

crates/precompile/Cargo.toml

@@ -31,3 +31,4 @@ default = ["secp256k1"]
 # Only problem that it has, it fails to build for wasm target on windows and mac as it is c lib.
 # If you dont require wasm on win/mac, i would recommend its usage.
 secp256k1 = ["dep:secp256k1"]
+optimism = ["revm-primitives/optimism"]

crates/precompile/src/lib.rs

@@ -109,6 +109,8 @@ impl SpecId {
                 Self::BERLIN
             }
             LATEST => Self::LATEST,
+            #[cfg(feature = "optimism")]
+            BEDROCK | REGOLITH => Self::LATEST,
         }
     }
 

crates/primitives/Cargo.toml

@@ -89,3 +89,4 @@ arbitrary = [
     "dep:proptest-derive",
     "bitflags/arbitrary",
 ]
+optimism = []

crates/primitives/src/env.rs

@@ -45,6 +45,12 @@ pub struct TxEnv {
     pub chain_id: Option<u64>,
     pub nonce: Option<u64>,
     pub access_list: Vec<(B160, Vec<U256>)>,
+    #[cfg(feature = "optimism")]
+    pub source_hash: Option<B256>,
+    #[cfg(feature = "optimism")]
+    pub mint: Option<u128>,
+    #[cfg(feature = "optimism")]
+    pub is_system_transaction: Option<bool>,
 }
 
 #[derive(Clone, Debug)]
@@ -122,6 +128,10 @@ pub struct CfgEnv {
     /// This is useful for testing method calls with zero gas price.
     #[cfg(feature = "optional_no_base_fee")]
     pub disable_base_fee: bool,
+    /// Enables Optimism's execution changes for deposit transactions and fee
+    /// collection.
+    #[cfg(feature = "optimism")]
+    pub optimism: bool,
 }
 
 impl CfgEnv {
@@ -174,6 +184,16 @@ impl CfgEnv {
     pub fn is_block_gas_limit_disabled(&self) -> bool {
         false
     }
+
+    #[cfg(feature = "optimism")]
+    pub fn is_optimism(&self) -> bool {
+        self.optimism
+    }
+
+    #[cfg(not(feature = "optimism"))]
+    pub fn is_optimism(&self) -> bool {
+        false
+    }
 }
 
 #[derive(Clone, Default, Debug, Eq, PartialEq)]
@@ -205,6 +225,8 @@ impl Default for CfgEnv {
             disable_gas_refund: false,
             #[cfg(feature = "optional_no_base_fee")]
             disable_base_fee: false,
+            #[cfg(feature = "optimism")]
+            optimism: false,
         }
     }
 }
@@ -236,6 +258,12 @@ impl Default for TxEnv {
             chain_id: None,
             nonce: None,
             access_list: Vec::new(),
+            #[cfg(feature = "optimism")]
+            source_hash: None,
+            #[cfg(feature = "optimism")]
+            mint: None,
+            #[cfg(feature = "optimism")]
+            is_system_transaction: None,
         }
     }
 }
@@ -323,14 +351,25 @@ impl Env {
 
     /// Validate transaction against state.
     #[inline]
-    pub fn validate_tx_against_state(&self, account: &Account) -> Result<(), InvalidTransaction> {
+    pub fn validate_tx_against_state(
+        &self,
+        account: &Account,
+        #[cfg(feature = "optimism")] is_deposit: bool,
+    ) -> Result<(), InvalidTransaction> {
         // EIP-3607: Reject transactions from senders with deployed code
         // This EIP is introduced after london but there was no collision in past
         // so we can leave it enabled always
         if !self.cfg.is_eip3607_disabled() && account.info.code_hash != KECCAK_EMPTY {
             return Err(InvalidTransaction::RejectCallerWithCode);
         }
 
+        // On Optimism, deposit transactions do not have verification on the nonce
+        // nor the balance of the account.
+        #[cfg(feature = "optimism")]
+        if is_deposit {
+            return Ok(());
+        }
+
         // Check that the transaction's nonce is correct
         if let Some(tx) = self.tx.nonce {
             let state = account.info.nonce;

crates/primitives/src/specification.rs

@@ -25,6 +25,10 @@ pub enum SpecId {
     SHANGHAI = 16,
     CANCUN = 17,
     LATEST = 18,
+    #[cfg(feature = "optimism")]
+    BEDROCK = 128,
+    #[cfg(feature = "optimism")]
+    REGOLITH = 129,
 }
 
 impl SpecId {
@@ -52,6 +56,10 @@ impl From<&str> for SpecId {
             "Merge" => SpecId::MERGE,
             "Shanghai" => SpecId::SHANGHAI,
             "Cancun" => SpecId::CANCUN,
+            #[cfg(feature = "optimism")]
+            "Bedrock" => SpecId::BEDROCK,
+            #[cfg(feature = "optimism")]
+            "Regolith" => SpecId::REGOLITH,
             _ => SpecId::LATEST,
         }
     }
@@ -69,6 +77,17 @@ pub trait Spec: Sized {
 
     #[inline(always)]
     fn enabled(spec_id: SpecId) -> bool {
+        // Optimism's Bedrock and Regolith hardforks implement changes on top of the Merge
+        // hardfork. This function is modified to preserve the original behavior of the
+        // spec IDs without having to put hardforks past Merge under
+        // `#[cfg(not(feature = "optimism"))]`.
+        #[cfg(feature = "optimism")]
+        if (Self::SPEC_ID == SpecId::BEDROCK || Self::SPEC_ID == SpecId::REGOLITH)
+            && spec_id > SpecId::MERGE
+        {
+            return false;
+        }
+
         Self::SPEC_ID as u8 >= spec_id as u8
     }
 }
@@ -103,3 +122,9 @@ spec!(MERGE, MergeSpec);
 spec!(SHANGHAI, ShanghaiSpec);
 spec!(CANCUN, CancunSpec);
 spec!(LATEST, LatestSpec);
+
+// Optimism Hardforks
+#[cfg(feature = "optimism")]
+spec!(BEDROCK, BedrockSpec);
+#[cfg(feature = "optimism")]
+spec!(REGOLITH, RegolithSpec);

crates/revm/Cargo.toml

@@ -65,6 +65,7 @@ arbitrary = ["revm-interpreter/arbitrary"]
 # deprecated feature
 web3db = []
 with-serde = []
+optimism = ["revm-interpreter/optimism", "revm-precompile/optimism"]
 
 [[example]]
 name = "fork_ref_transact"

crates/revm/src/evm.rs

@@ -239,6 +239,8 @@ pub fn to_precompile_id(spec_id: SpecId) -> revm_precompile::SpecId {
         | SpecId::SHANGHAI
         | SpecId::CANCUN
         | SpecId::LATEST => revm_precompile::SpecId::BERLIN,
+        #[cfg(feature = "optimism")]
+        SpecId::BEDROCK | SpecId::REGOLITH => revm_precompile::SpecId::BERLIN,
     }
 }
 
@@ -264,5 +266,9 @@ pub fn evm_inner<'a, DB: Database, const INSPECT: bool>(
         SpecId::SHANGHAI => create_evm!(ShanghaiSpec, db, env, insp),
         SpecId::CANCUN => create_evm!(CancunSpec, db, env, insp),
         SpecId::LATEST => create_evm!(LatestSpec, db, env, insp),
+        #[cfg(feature = "optimism")]
+        SpecId::BEDROCK => create_evm!(BedrockSpec, db, env, insp),
+        #[cfg(feature = "optimism")]
+        SpecId::REGOLITH => create_evm!(RegolithSpec, db, env, insp),
     }
 }

crates/revm/src/evm_impl.rs

@@ -94,7 +94,20 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> Transact<DB::Error>
     fn preverify_transaction(&mut self) -> Result<(), EVMError<DB::Error>> {
         let env = self.env();
 
+        #[cfg(feature = "optimism")]
+        let is_deposit = env.tx.source_hash.is_some();
+
         env.validate_block_env::<GSPEC, DB::Error>()?;
+
+        // If the transaction is a deposit transaction on Optimism, there are no fee fields to check,
+        // no nonce to check, and no need to check if EOA (L1 already verified it for us)
+        // Gas is free, but no refunds!
+        #[cfg(feature = "optimism")]
+        if !is_deposit {
+            env.validate_tx::<GSPEC>()?;
+        }
+
+        #[cfg(not(feature = "optimism"))]
         env.validate_tx::<GSPEC>()?;
 
         let tx_caller = env.tx.caller;
@@ -114,7 +127,11 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> Transact<DB::Error>
             .load_account(tx_caller, self.data.db)
             .map_err(EVMError::Database)?;
 
-        self.data.env.validate_tx_against_state(caller_account)?;
+        self.data.env.validate_tx_against_state(
+            caller_account,
+            #[cfg(feature = "optimism")]
+            is_deposit,
+        )?;
 
         Ok(())
     }
@@ -127,6 +144,8 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> Transact<DB::Error>
         let tx_gas_limit = env.tx.gas_limit;
         let tx_is_create = env.tx.transact_to.is_create();
         let effective_gas_price = env.effective_gas_price();
+        #[cfg(feature = "optimism")]
+        let tx_mint = env.tx.mint;
 
         let initial_gas_spend =
             initial_tx_gas::<GSPEC>(&tx_data, tx_is_create, &env.tx.access_list);
@@ -143,6 +162,21 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> Transact<DB::Error>
 
         // load acc
         let journal = &mut self.data.journaled_state;
+
+        // If the transaction is a deposit with a `Some` `mint` value, add the minted value
+        // in wei to the caller's balance. This should be persisted to the database prior
+        // to the rest of execution below.
+        #[cfg(feature = "optimism")]
+        if let Some(mint) = tx_mint {
+            journal
+                .load_account(tx_caller, self.data.db)
+                .map_err(EVMError::Database)?
+                .0
+                .info
+                .balance += U256::from(mint);
+            journal.checkpoint();
+        }
+
         let (caller_account, _) = journal
             .load_account(tx_caller, self.data.db)
             .map_err(EVMError::Database)?;
@@ -304,8 +338,15 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> EVMImpl<'a, GSPEC, DB,
                     effective_gas_price * U256::from(gas.remaining() + gas_refunded),
                 );
 
+                #[cfg(not(feature = "optimism"))]
+                let disable_coinbase_tip = self.data.env.cfg.disable_coinbase_tip;
+
+                #[cfg(feature = "optimism")]
+                let disable_coinbase_tip = self.data.env.cfg.disable_coinbase_tip
+                    || self.data.env.tx.source_hash.is_some();
+
                 // transfer fee to coinbase/beneficiary.
-                if !self.data.env.cfg.disable_coinbase_tip {
+                if !disable_coinbase_tip {
                     // EIP-1559 discard basefee for coinbase transfer. Basefee amount of gas is discarded.
                     let coinbase_gas_price = if SPEC::enabled(LONDON) {
                         effective_gas_price.saturating_sub(basefee)
@@ -326,6 +367,15 @@ impl<'a, GSPEC: Spec, DB: Database, const INSPECT: bool> EVMImpl<'a, GSPEC, DB,
                     );
                 }
 
+                #[cfg(feature = "optimism")]
+                if self.data.env.cfg.optimism && self.data.env.tx.source_hash.is_none() {
+                    // If the transaction is not a deposit transaction, fees are paid out
+                    // to both the Base Fee Vault as well as the Sequencer Fee Vault.
+                    // TODO(clabby): Need to load the L1 fee information from the L1 block contract
+                    //               and pay out fees to the vaults.
+                    todo!()
+                }
+
                 (gas.spend() - gas_refunded, gas_refunded)
             } else {
                 // touch coinbase