EIP-7516: BLOBBASEFEE opcode (#721)

rakita · web-flow · commit 26af13eaa89d · 2023-09-21T23:55:09.000+02:00
* feat(Cancun): EIP-7516 BLOBBASEFEE opcode

* Update crates/interpreter/src/instructions/host_env.rs

Co-authored-by: DaniPopes &lt;57450786+DaniPopes@users.noreply.github.com&gt;

* rename blobfee to baseblobfee

* some renamings

* rename and doc
diff --git a/bins/revme/src/statetest/runner.rs b/bins/revme/src/statetest/runner.rs
@@ -190,10 +190,11 @@ pub fn execute_test_suite(
             unit.env.parent_blob_gas_used,
             unit.env.parent_excess_blob_gas,
         ) {
-            env.block.excess_blob_gas = Some(calc_excess_blob_gas(
-                parent_blob_gas_used.to(),
-                parent_excess_blob_gas.to(),
-            ));
+            env.block
+                .set_blob_excess_gas_and_price(calc_excess_blob_gas(
+                    parent_blob_gas_used.to(),
+                    parent_excess_blob_gas.to(),
+                ));
         }
 
         // tx env
diff --git a/crates/interpreter/src/instructions/host_env.rs b/crates/interpreter/src/instructions/host_env.rs
@@ -68,3 +68,13 @@ pub fn blob_hash<SPEC: Spec>(interpreter: &mut Interpreter, host: &mut dyn Host)
         None => U256::ZERO,
     };
 }
+
+/// EIP-7516: BLOBBASEFEE opcode
+pub fn blob_basefee<SPEC: Spec>(interpreter: &mut Interpreter, host: &mut dyn Host) {
+    check!(interpreter, CANCUN);
+    gas!(interpreter, gas::BASE);
+    push!(
+        interpreter,
+        U256::from(host.env().block.get_blob_gasprice().unwrap_or_default())
+    );
+}
diff --git a/crates/interpreter/src/instructions/opcode.rs b/crates/interpreter/src/instructions/opcode.rs
@@ -151,7 +151,7 @@ opcodes! {
     0x47 => SELFBALANCE    => host::selfbalance::<SPEC>,
     0x48 => BASEFEE        => host_env::basefee::<SPEC>,
     0x49 => BLOBHASH       => host_env::blob_hash::<SPEC>,
-    // 0x4A
+    0x4A => BLOBBASEFEE    => host_env::blob_basefee::<SPEC>,
     // 0x4B
     // 0x4C
     // 0x4D
@@ -333,7 +333,7 @@ opcodes! {
     // 0xF9
     0xFA => STATICCALL   => host::static_call::<SPEC>,
     // 0xFB
-    // 0xF
+    // 0xFC
     0xFD => REVERT       => control::revert::<SPEC>,
     0xFE => INVALID      => control::invalid,
     0xFF => SELFDESTRUCT => host::selfdestruct::<SPEC>,
@@ -498,7 +498,10 @@ const fn opcode_gas_info(opcode: u8, spec: SpecId) -> OpInfo {
         MULMOD => OpInfo::gas(gas::MID),
         EXP => OpInfo::dynamic_gas(),
         SIGNEXTEND => OpInfo::gas(gas::LOW),
-
+        0x0C => OpInfo::none(),
+        0x0D => OpInfo::none(),
+        0x0E => OpInfo::none(),
+        0x0F => OpInfo::none(),
         LT => OpInfo::gas(gas::VERYLOW),
         GT => OpInfo::gas(gas::VERYLOW),
         SLT => OpInfo::gas(gas::VERYLOW),
@@ -525,9 +528,24 @@ const fn opcode_gas_info(opcode: u8, spec: SpecId) -> OpInfo {
         } else {
             0
         }),
-
+        0x1E => OpInfo::none(),
+        0x1F => OpInfo::none(),
         KECCAK256 => OpInfo::dynamic_gas(),
-
+        0x21 => OpInfo::none(),
+        0x22 => OpInfo::none(),
+        0x23 => OpInfo::none(),
+        0x24 => OpInfo::none(),
+        0x25 => OpInfo::none(),
+        0x26 => OpInfo::none(),
+        0x27 => OpInfo::none(),
+        0x28 => OpInfo::none(),
+        0x29 => OpInfo::none(),
+        0x2A => OpInfo::none(),
+        0x2B => OpInfo::none(),
+        0x2C => OpInfo::none(),
+        0x2D => OpInfo::none(),
+        0x2E => OpInfo::none(),
+        0x2F => OpInfo::none(),
         ADDRESS => OpInfo::gas(gas::BASE),
         BALANCE => OpInfo::dynamic_gas(),
         ORIGIN => OpInfo::gas(gas::BASE),
@@ -594,7 +612,16 @@ const fn opcode_gas_info(opcode: u8, spec: SpecId) -> OpInfo {
         } else {
             0
         }),
-
+        BLOBBASEFEE => OpInfo::gas(if SpecId::enabled(spec, SpecId::CANCUN) {
+            gas::BASE
+        } else {
+            0
+        }),
+        0x4B => OpInfo::none(),
+        0x4C => OpInfo::none(),
+        0x4D => OpInfo::none(),
+        0x4E => OpInfo::none(),
+        0x4F => OpInfo::none(),
         POP => OpInfo::gas(gas::BASE),
         MLOAD => OpInfo::gas(gas::VERYLOW),
         MSTORE => OpInfo::gas(gas::VERYLOW),
@@ -697,21 +724,97 @@ const fn opcode_gas_info(opcode: u8, spec: SpecId) -> OpInfo {
         LOG2 => OpInfo::dynamic_gas(),
         LOG3 => OpInfo::dynamic_gas(),
         LOG4 => OpInfo::dynamic_gas(),
-
+        0xA5 => OpInfo::none(),
+        0xA6 => OpInfo::none(),
+        0xA7 => OpInfo::none(),
+        0xA8 => OpInfo::none(),
+        0xA9 => OpInfo::none(),
+        0xAA => OpInfo::none(),
+        0xAB => OpInfo::none(),
+        0xAC => OpInfo::none(),
+        0xAD => OpInfo::none(),
+        0xAE => OpInfo::none(),
+        0xAF => OpInfo::none(),
+        0xB0 => OpInfo::none(),
+        0xB1 => OpInfo::none(),
+        0xB2 => OpInfo::none(),
+        0xB3 => OpInfo::none(),
+        0xB4 => OpInfo::none(),
+        0xB5 => OpInfo::none(),
+        0xB6 => OpInfo::none(),
+        0xB7 => OpInfo::none(),
+        0xB8 => OpInfo::none(),
+        0xB9 => OpInfo::none(),
+        0xBA => OpInfo::none(),
+        0xBB => OpInfo::none(),
+        0xBC => OpInfo::none(),
+        0xBD => OpInfo::none(),
+        0xBE => OpInfo::none(),
+        0xBF => OpInfo::none(),
+        0xC0 => OpInfo::none(),
+        0xC1 => OpInfo::none(),
+        0xC2 => OpInfo::none(),
+        0xC3 => OpInfo::none(),
+        0xC4 => OpInfo::none(),
+        0xC5 => OpInfo::none(),
+        0xC6 => OpInfo::none(),
+        0xC7 => OpInfo::none(),
+        0xC8 => OpInfo::none(),
+        0xC9 => OpInfo::none(),
+        0xCA => OpInfo::none(),
+        0xCB => OpInfo::none(),
+        0xCC => OpInfo::none(),
+        0xCD => OpInfo::none(),
+        0xCE => OpInfo::none(),
+        0xCF => OpInfo::none(),
+        0xD0 => OpInfo::none(),
+        0xD1 => OpInfo::none(),
+        0xD2 => OpInfo::none(),
+        0xD3 => OpInfo::none(),
+        0xD4 => OpInfo::none(),
+        0xD5 => OpInfo::none(),
+        0xD6 => OpInfo::none(),
+        0xD7 => OpInfo::none(),
+        0xD8 => OpInfo::none(),
+        0xD9 => OpInfo::none(),
+        0xDA => OpInfo::none(),
+        0xDB => OpInfo::none(),
+        0xDC => OpInfo::none(),
+        0xDD => OpInfo::none(),
+        0xDE => OpInfo::none(),
+        0xDF => OpInfo::none(),
+        0xE0 => OpInfo::none(),
+        0xE1 => OpInfo::none(),
+        0xE2 => OpInfo::none(),
+        0xE3 => OpInfo::none(),
+        0xE4 => OpInfo::none(),
+        0xE5 => OpInfo::none(),
+        0xE6 => OpInfo::none(),
+        0xE7 => OpInfo::none(),
+        0xE8 => OpInfo::none(),
+        0xE9 => OpInfo::none(),
+        0xEA => OpInfo::none(),
+        0xEB => OpInfo::none(),
+        0xEC => OpInfo::none(),
+        0xED => OpInfo::none(),
+        0xEE => OpInfo::none(),
+        0xEF => OpInfo::none(),
         CREATE => OpInfo::gas_block_end(0),
         CALL => OpInfo::gas_block_end(0),
         CALLCODE => OpInfo::gas_block_end(0),
         RETURN => OpInfo::gas_block_end(0),
         DELEGATECALL => OpInfo::gas_block_end(0),
         CREATE2 => OpInfo::gas_block_end(0),
-
+        0xF6 => OpInfo::none(),
+        0xF7 => OpInfo::none(),
+        0xF8 => OpInfo::none(),
+        0xF9 => OpInfo::none(),
         STATICCALL => OpInfo::gas_block_end(0),
-
+        0xFB => OpInfo::none(),
+        0xFC => OpInfo::none(),
         REVERT => OpInfo::gas_block_end(0),
         INVALID => OpInfo::gas_block_end(0),
         SELFDESTRUCT => OpInfo::gas_block_end(0),
-
-        _ => OpInfo::none(),
     }
 }
 
diff --git a/crates/primitives/src/env.rs b/crates/primitives/src/env.rs
@@ -1,6 +1,6 @@
 use crate::{
-    alloc::vec::Vec, calc_blob_fee, Account, InvalidHeader, InvalidTransaction, Spec, SpecId, B160,
-    B256, GAS_PER_BLOB, KECCAK_EMPTY, MAX_BLOB_NUMBER_PER_BLOCK, MAX_INITCODE_SIZE, U256,
+    alloc::vec::Vec, calc_blob_gasprice, Account, InvalidHeader, InvalidTransaction, Spec, SpecId,
+    B160, B256, GAS_PER_BLOB, KECCAK_EMPTY, MAX_BLOB_NUMBER_PER_BLOCK, MAX_INITCODE_SIZE, U256,
     VERSIONED_HASH_VERSION_KZG,
 };
 use bytes::Bytes;
@@ -28,12 +28,10 @@ pub struct BlockEnv {
     pub timestamp: U256,
     /// The gas limit of the block.
     pub gas_limit: U256,
-
     /// The base fee per gas, added in the London upgrade with [EIP-1559].
     ///
     /// [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559
     pub basefee: U256,
-
     /// The difficulty of the block.
     ///
     /// Unused after the Paris (AKA the merge) upgrade, and replaced by `prevrandao`.
@@ -46,24 +44,67 @@ pub struct BlockEnv {
     ///
     /// [EIP-4399]: https://eips.ethereum.org/EIPS/eip-4399
     pub prevrandao: Option<B256>,
-
-    /// Excess blob gas. See also [`calc_excess_blob_gas`](crate::calc_excess_blob_gas).
+    /// Excess blob gas and blob gasprice.
+    /// See also [`calc_excess_blob_gas`](crate::calc_excess_blob_gas)
+    /// and [`calc_blob_gasprice`](crate::calc_blob_gasprice).
     ///
     /// Incorporated as part of the Cancun upgrade via [EIP-4844].
     ///
     /// [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844
-    pub excess_blob_gas: Option<u64>,
+    pub blob_excess_gas_and_price: Option<BlobExcessGasAndPrice>,
+}
+
+/// Structure holding block blob excess gas and it calculates blob fee.
+///
+/// Incorporated as part of the Cancun upgrade via [EIP-4844].
+///
+/// [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844
+#[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct BlobExcessGasAndPrice {
+    pub excess_blob_gas: u64,
+    pub blob_gasprice: u64,
+}
+
+impl BlobExcessGasAndPrice {
+    /// Takes excess blob gas and calculated blob fee with [`calc_blob_fee`]
+    pub fn new(excess_blob_gas: u64) -> Self {
+        let blob_gasprice = calc_blob_gasprice(excess_blob_gas);
+        Self {
+            excess_blob_gas,
+            blob_gasprice,
+        }
+    }
 }
 
 impl BlockEnv {
-    /// See [EIP-4844] and [`Env::calc_data_fee`].
+    /// Takes `blob_excess_gas` saves it inside env
+    /// and calculates `blob_fee` with [`BlobGasAndFee`].
+    pub fn set_blob_excess_gas_and_price(&mut self, excess_blob_gas: u64) {
+        self.blob_excess_gas_and_price = Some(BlobExcessGasAndPrice::new(excess_blob_gas));
+    }
+    /// See [EIP-4844] and [`crate::calc_blob_gasprice`].
     ///
     /// Returns `None` if `Cancun` is not enabled. This is enforced in [`Env::validate_block_env`].
     ///
     /// [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844
     #[inline]
     pub fn get_blob_gasprice(&self) -> Option<u64> {
-        self.excess_blob_gas.map(calc_blob_fee)
+        self.blob_excess_gas_and_price
+            .as_ref()
+            .map(|a| a.blob_gasprice)
+    }
+
+    /// Return `blob_excess_gas` header field. See [EIP-4844].
+    ///
+    /// Returns `None` if `Cancun` is not enabled. This is enforced in [`Env::validate_block_env`].
+    ///
+    /// [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844
+    #[inline]
+    pub fn get_blob_excess_gas(&self) -> Option<u64> {
+        self.blob_excess_gas_and_price
+            .as_ref()
+            .map(|a| a.excess_blob_gas)
     }
 }
 
@@ -342,7 +383,7 @@ impl Default for BlockEnv {
             basefee: U256::ZERO,
             difficulty: U256::ZERO,
             prevrandao: Some(B256::zero()),
-            excess_blob_gas: Some(0),
+            blob_excess_gas_and_price: Some(BlobExcessGasAndPrice::new(0)),
         }
     }
 }
@@ -397,7 +438,7 @@ impl Env {
             return Err(InvalidHeader::PrevrandaoNotSet);
         }
         // `excess_blob_gas` is required for Cancun
-        if SPEC::enabled(SpecId::CANCUN) && self.block.excess_blob_gas.is_none() {
+        if SPEC::enabled(SpecId::CANCUN) && self.block.blob_excess_gas_and_price.is_none() {
             return Err(InvalidHeader::ExcessBlobGasNotSet);
         }
         Ok(())
diff --git a/crates/primitives/src/utilities.rs b/crates/primitives/src/utilities.rs
@@ -41,11 +41,11 @@ pub fn calc_excess_blob_gas(parent_excess_blob_gas: u64, parent_blob_gas_used: u
     (parent_excess_blob_gas + parent_blob_gas_used).saturating_sub(TARGET_BLOB_GAS_PER_BLOCK)
 }
 
-/// Calculates the blobfee from the header's excess blob gas field.
+/// Calculates the blob gasprice from the header's excess blob gas field.
 ///
 /// See also [the EIP-4844 helpers](https://eips.ethereum.org/EIPS/eip-4844#helpers).
 #[inline]
-pub fn calc_blob_fee(excess_blob_gas: u64) -> u64 {
+pub fn calc_blob_gasprice(excess_blob_gas: u64) -> u64 {
     fake_exponential(
         MIN_BLOB_GASPRICE,
         excess_blob_gas,
@@ -174,7 +174,7 @@ mod tests {
     #[test]
     fn test_calc_blob_fee() {
         for &(excess, expected) in &[(0, 1), (2314057, 1), (2314058, 2), (10 * 1024 * 1024, 23)] {
-            let actual = calc_blob_fee(excess);
+            let actual = calc_blob_gasprice(excess);
             assert_eq!(actual, expected, "test: {excess}");
         }
     }
