feat(forks): Add gas costs functions (ethereum#779)

* feat(forks): Add memory expansion, calldata calculators to each fork

* fix(fw): Remove `copy_opcode_cost`, `cost_memory_bytes` and `eip_2028_transaction_data_cost`

* refactor(tests): Use fork calculator methods instead of helpers

* refactor(base_types): Move `AccessList` to base types

* fix(forks): GasCosts field description

* fix(forks): Initcode word cost

* feat(forks): Add transaction_intrinsic_cost_calculator

* refactor(tests): Use fork gas calculator methods

* refactor(forks): Add authorization to intrinsic gas cost calc

* refactor(plugins/execute): Use fork gas calc functions

* refactor(tests): Use `fork` gas calc functions

* docs: changelog

Author: marioevz

cancun/eip4844_blobs/test_blob_txs.py

@@ -44,7 +44,6 @@
     Transaction,
     TransactionException,
     add_kzg_version,
-    eip_2028_transaction_data_cost,
 )
 
 from .spec import Spec, SpecHelpers, ref_spec_4844
@@ -90,20 +89,13 @@ def tx_value() -> int:
 
 @pytest.fixture
 def tx_gas(
+    fork: Fork,
     tx_calldata: bytes,
     tx_access_list: List[AccessList],
 ) -> int:
     """Default gas allocated to transactions sent during test."""
-    access_list_gas = 0
-    if tx_access_list:
-        ACCESS_LIST_ADDRESS_COST = 2400
-        ACCESS_LIST_STORAGE_KEY_COST = 1900
-
-        for address in tx_access_list:
-            access_list_gas += ACCESS_LIST_ADDRESS_COST
-            access_list_gas += len(address.storage_keys) * ACCESS_LIST_STORAGE_KEY_COST
-
-    return 21000 + eip_2028_transaction_data_cost(tx_calldata) + access_list_gas
+    tx_intrinsic_cost_calculator = fork.transaction_intrinsic_cost_calculator()
+    return tx_intrinsic_cost_calculator(calldata=tx_calldata, access_list=tx_access_list)
 
 
 @pytest.fixture

cancun/eip4844_blobs/test_blob_txs_full.py

@@ -45,7 +45,7 @@ def tx_value() -> int:
 @pytest.fixture
 def tx_gas() -> int:
     """Default gas allocated to transactions sent during test."""
-    return 21000
+    return 21_000
 
 
 @pytest.fixture

cancun/eip4844_blobs/test_point_evaluation_precompile.py

@@ -35,6 +35,7 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import (
     EOA,
     Account,
@@ -48,7 +49,6 @@
     Storage,
     Transaction,
     call_return_code,
-    eip_2028_transaction_data_cost,
 )
 from ethereum_test_tools.vm.opcode import Opcodes as Op
 
@@ -542,6 +542,7 @@ def test_call_opcode_types(
 )
 @pytest.mark.valid_from("Cancun")
 def test_tx_entry_point(
+    fork: Fork,
     state_test: StateTestFiller,
     precompile_input: bytes,
     call_gas: int,
@@ -559,7 +560,8 @@ def test_tx_entry_point(
     sender = pre.fund_eoa(amount=start_balance)
 
     # Gas is appended the intrinsic gas cost of the transaction
-    intrinsic_gas_cost = 21_000 + eip_2028_transaction_data_cost(precompile_input)
+    tx_intrinsic_gas_cost_calculator = fork.transaction_intrinsic_cost_calculator()
+    intrinsic_gas_cost = tx_intrinsic_gas_cost_calculator(calldata=precompile_input)
 
     # Consumed gas will only be the precompile gas if the proof is correct and
     # the call gas is sufficient.

cancun/eip4844_blobs/test_point_evaluation_precompile_gas.py

@@ -7,6 +7,7 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import (
     Account,
     Address,
@@ -16,7 +17,7 @@
     Environment,
     StateTestFiller,
     Transaction,
-    copy_opcode_cost,
+    ceiling_division,
 )
 from ethereum_test_tools.vm.opcode import Opcodes as Op
 
@@ -69,8 +70,23 @@ def call_gas() -> int:
     return Spec.POINT_EVALUATION_PRECOMPILE_GAS
 
 
+def copy_opcode_cost(fork: Fork, length: int) -> int:
+    """
+    Calculates the cost of the COPY opcodes, assuming memory expansion from
+    empty memory, based on the costs specified in the yellow paper:
+    https://ethereum.github.io/yellowpaper/paper.pdf
+    """
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
+    return (
+        3
+        + (ceiling_division(length, 32) * 3)
+        + cost_memory_bytes(new_bytes=length, previous_bytes=0)
+    )
+
+
 @pytest.fixture
 def precompile_caller_code(
+    fork: Fork,
     call_type: Op,
     call_gas: int,
     precompile_input: bytes,
@@ -87,7 +103,7 @@ def precompile_caller_code(
         WARM_STORAGE_READ_COST
         + (CALLDATASIZE_COST * 1)
         + (PUSH_OPERATIONS_COST * 2)
-        + copy_opcode_cost(len(precompile_input))
+        + copy_opcode_cost(fork, len(precompile_input))
     )
     if call_type == Op.CALL or call_type == Op.CALLCODE:
         precompile_caller_code += call_type(  # type: ignore # https://github.com/ethereum/execution-spec-tests/issues/348 # noqa: E501

cancun/eip5656_mcopy/test_mcopy_memory_expansion.py

@@ -9,10 +9,10 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import Account, Address, Alloc, Bytecode, Environment
 from ethereum_test_tools import Opcodes as Op
-from ethereum_test_tools import StateTestFiller, Transaction, cost_memory_bytes
-from ethereum_test_types.helpers import eip_2028_transaction_data_cost
+from ethereum_test_tools import StateTestFiller, Transaction
 
 from .common import REFERENCE_SPEC_GIT_PATH, REFERENCE_SPEC_VERSION
 
@@ -53,30 +53,35 @@ def callee_bytecode(dest: int, src: int, length: int) -> Bytecode:
 
 @pytest.fixture
 def call_exact_cost(
+    fork: Fork,
     initial_memory: bytes,
     dest: int,
     length: int,
 ) -> int:
     """
     Returns the exact cost of the subcall, based on the initial memory and the length of the copy.
     """
-    intrinsic_cost = 21000 + eip_2028_transaction_data_cost(initial_memory)
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
+    gas_costs = fork.gas_costs()
+    tx_intrinsic_gas_cost_calculator = fork.transaction_intrinsic_cost_calculator()
 
     mcopy_cost = 3
     mcopy_cost += 3 * ((length + 31) // 32)
     if length > 0 and dest + length > len(initial_memory):
-        mcopy_cost += cost_memory_bytes(dest + length, len(initial_memory))
+        mcopy_cost += cost_memory_bytes(
+            new_bytes=dest + length, previous_bytes=len(initial_memory)
+        )
 
     calldatacopy_cost = 3
     calldatacopy_cost += 3 * ((len(initial_memory) + 31) // 32)
-    calldatacopy_cost += cost_memory_bytes(len(initial_memory), 0)
+    calldatacopy_cost += cost_memory_bytes(new_bytes=len(initial_memory))
 
-    pushes_cost = 3 * 9
-    calldatasize_cost = 2
+    pushes_cost = gas_costs.G_VERY_LOW * 9
+    calldatasize_cost = gas_costs.G_BASE
 
     sstore_cost = 22100
     return (
-        intrinsic_cost
+        tx_intrinsic_gas_cost_calculator(calldata=initial_memory)
         + mcopy_cost
         + calldatacopy_cost
         + pushes_cost

osaka/eip7692_eof_v1/eip7069_extcall/test_gas.py

@@ -5,10 +5,10 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import Alloc, Environment, StateTestFiller
 from ethereum_test_tools.eof.v1 import Container
 from ethereum_test_tools.vm.opcode import Opcodes as Op
-from ethereum_test_types.helpers import cost_memory_bytes
 
 from .. import EOF_FORK_NAME
 from ..gas_test import gas_test
@@ -114,6 +114,7 @@ def state_env() -> Environment:
 def test_ext_calls_gas(
     state_test: StateTestFiller,
     pre: Alloc,
+    fork: Fork,
     state_env: Environment,
     opcode: Op,
     pre_setup: Op,
@@ -126,7 +127,7 @@ def test_ext_calls_gas(
     address_target = (
         pre.fund_eoa(0) if new_account else pre.deploy_contract(Container.Code(Op.STOP))
     )
-
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
     gas_test(
         state_test,
         state_env,
@@ -137,8 +138,8 @@ def test_ext_calls_gas(
         + Op.PUSH20(address_target),
         subject_code=opcode,
         tear_down_code=Op.STOP,
-        cold_gas=cold_gas + cost_memory_bytes(mem_expansion_bytes, 0),
-        warm_gas=warm_gas + cost_memory_bytes(mem_expansion_bytes, 0),
+        cold_gas=cold_gas + cost_memory_bytes(new_bytes=mem_expansion_bytes),
+        warm_gas=warm_gas + cost_memory_bytes(new_bytes=mem_expansion_bytes),
     )
 
 

osaka/eip7692_eof_v1/eip7069_extcall/test_returndatacopy_memory_expansion.py

@@ -6,9 +6,10 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import Account, Address, Alloc, Bytecode, Environment
 from ethereum_test_tools import Opcodes as Op
-from ethereum_test_tools import StateTestFiller, Storage, Transaction, cost_memory_bytes
+from ethereum_test_tools import StateTestFiller, Storage, Transaction
 from ethereum_test_tools.eof.v1 import Container
 
 from .. import EOF_FORK_NAME
@@ -42,21 +43,26 @@ def callee_bytecode(dest: int, src: int, length: int) -> Container:
 
 @pytest.fixture
 def subcall_exact_cost(
+    fork: Fork,
     initial_memory: bytes,
     dest: int,
     length: int,
 ) -> int:
     """
     Returns the exact cost of the subcall, based on the initial memory and the length of the copy.
     """
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
+
     returndatacopy_cost = 3
     returndatacopy_cost += 3 * ((length + 31) // 32)
     if length > 0 and dest + length > len(initial_memory):
-        returndatacopy_cost += cost_memory_bytes(dest + length, len(initial_memory))
+        returndatacopy_cost += cost_memory_bytes(
+            new_bytes=dest + length, previous_bytes=len(initial_memory)
+        )
 
     calldatacopy_cost = 3
     calldatacopy_cost += 3 * ((len(initial_memory) + 31) // 32)
-    calldatacopy_cost += cost_memory_bytes(len(initial_memory), 0)
+    calldatacopy_cost += cost_memory_bytes(new_bytes=len(initial_memory))
 
     pushes_cost = 3 * 7
     calldatasize_cost = 2

osaka/eip7692_eof_v1/eip7480_data_section/test_datacopy_memory_expansion.py

@@ -5,6 +5,7 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import (
     Account,
     Address,
@@ -14,7 +15,6 @@
     StateTestFiller,
     Storage,
     Transaction,
-    cost_memory_bytes,
 )
 from ethereum_test_tools.eof.v1 import Container, Section
 from ethereum_test_tools.vm.opcode import Opcodes as Op
@@ -50,21 +50,26 @@ def callee_bytecode(dest: int, src: int, length: int, data_section: bytes) -> Co
 
 @pytest.fixture
 def subcall_exact_cost(
+    fork: Fork,
     initial_memory: bytes,
     dest: int,
     length: int,
 ) -> int:
     """
     Returns the exact cost of the subcall, based on the initial memory and the length of the copy.
     """
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
+
     datacopy_cost = 3
     datacopy_cost += 3 * ((length + 31) // 32)
     if length > 0 and dest + length > len(initial_memory):
-        datacopy_cost += cost_memory_bytes(dest + length, len(initial_memory))
+        datacopy_cost += cost_memory_bytes(
+            new_bytes=dest + length, previous_bytes=len(initial_memory)
+        )
 
     calldatacopy_cost = 3
     calldatacopy_cost += 3 * ((len(initial_memory) + 31) // 32)
-    calldatacopy_cost += cost_memory_bytes(len(initial_memory), 0)
+    calldatacopy_cost += cost_memory_bytes(new_bytes=len(initial_memory))
 
     pushes_cost = 3 * 7
     calldatasize_cost = 2

osaka/eip7692_eof_v1/eip7620_eof_create/test_gas.py

@@ -4,10 +4,10 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
 from ethereum_test_tools import Alloc, Environment, StateTestFiller, compute_eofcreate_address
 from ethereum_test_tools.eof.v1 import Container, Section
 from ethereum_test_tools.vm.opcode import Opcodes as Op
-from ethereum_test_types.helpers import cost_memory_bytes
 
 from .. import EOF_FORK_NAME
 from ..gas_test import gas_test
@@ -115,6 +115,7 @@ def make_factory(initcode: Container):
 def test_eofcreate_gas(
     state_test: StateTestFiller,
     pre: Alloc,
+    fork: Fork,
     value: int,
     new_account: bool,
     mem_expansion_bytes: int,
@@ -139,7 +140,7 @@ def test_eofcreate_gas(
     code_increment_counter = (
         Op.TLOAD(slot_counter) + Op.DUP1 + Op.TSTORE(slot_counter, Op.PUSH1(1) + Op.ADD)
     )
-
+    cost_memory_bytes = fork.memory_expansion_gas_calculator()
     gas_test(
         state_test,
         Environment(),
@@ -151,7 +152,7 @@ def test_eofcreate_gas(
         subject_code=Op.EOFCREATE[0],
         tear_down_code=Op.STOP,
         cold_gas=EOFCREATE_GAS
-        + cost_memory_bytes(mem_expansion_bytes, 0)
+        + cost_memory_bytes(new_bytes=mem_expansion_bytes)
         + initcode_hashing_cost
         + initcode_execution_cost
         + deployed_code_cost,