refactor: update worst stateful opcode scenario

Author: LouisTsai-Csie

tests/benchmark/test_worst_stateful_opcodes.py

@@ -6,29 +6,29 @@
 """
 
 import math
+from enum import auto
 
 import pytest
 
+from ethereum_test_benchmark.benchmark_code_generator import ExtCallGenerator, JumpLoopGenerator
 from ethereum_test_forks import Fork
+from ethereum_test_specs import BlockchainTestFiller
+from ethereum_test_specs.benchmark import BenchmarkTestFiller
 from ethereum_test_tools import (
     Account,
     Address,
     Alloc,
     Block,
-    BlockchainTestFiller,
     Bytecode,
     Environment,
     Hash,
-    StateTestFiller,
     Transaction,
     While,
     compute_create2_address,
     compute_create_address,
 )
 from ethereum_test_tools.vm.opcode import Opcodes as Op
 
-from .helpers import code_loop_precompile_call
-
 REFERENCE_SPEC_GIT_PATH = "TODO"
 REFERENCE_SPEC_VERSION = "TODO"
 
@@ -47,7 +47,7 @@
     ],
 )
 def test_worst_address_state_cold(
-    blockchain_test: BlockchainTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     fork: Fork,
     opcode: Op,
@@ -107,11 +107,10 @@ def test_worst_address_state_cold(
     )
     blocks.append(Block(txs=[op_tx]))
 
-    blockchain_test(
+    benchmark_test(
         pre=pre,
         post=post,
         blocks=blocks,
-        exclude_full_post_state_in_output=True,
     )
 
 
@@ -135,17 +134,12 @@ def test_worst_address_state_cold(
     ],
 )
 def test_worst_address_state_warm(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
-    fork: Fork,
     opcode: Op,
     absent_target: bool,
-    gas_benchmark_value: int,
 ):
     """Test running a block with as many stateful opcodes doing warm access for an account."""
-    max_code_size = fork.max_code_size()
-    attack_gas_limit = gas_benchmark_value
-
     # Setup
     target_addr = Address(100_000)
     post = {}
@@ -155,45 +149,29 @@ def test_worst_address_state_warm(
         post[target_addr] = Account(balance=100, code=code)
 
     # Execution
-    prep = Op.MSTORE(0, target_addr)
-    jumpdest = Op.JUMPDEST
-    jump_back = Op.JUMP(len(prep))
-    iter_block = Op.POP(opcode(address=Op.MLOAD(0)))
-    max_iters_loop = (max_code_size - len(prep) - len(jumpdest) - len(jump_back)) // len(
-        iter_block
-    )
-    op_code = prep + jumpdest + sum([iter_block] * max_iters_loop) + jump_back
-    if len(op_code) > max_code_size:
-        # Must never happen, but keep it as a sanity check.
-        raise ValueError(f"Code size {len(op_code)} exceeds maximum code size {max_code_size}")
-    op_address = pre.deploy_contract(code=op_code)
-    tx = Transaction(
-        to=op_address,
-        gas_limit=attack_gas_limit,
-        sender=pre.fund_eoa(),
-    )
-
-    state_test(
+    setup = Op.MSTORE(0, target_addr)
+    attack_block = Op.POP(opcode(address=Op.MLOAD(0)))
+    benchmark_test(
         pre=pre,
         post=post,
-        tx=tx,
+        code_generator=JumpLoopGenerator(setup=setup, attack_block=attack_block),
     )
 
 
 class StorageAction:
     """Enum for storage actions."""
 
-    READ = 1
-    WRITE_SAME_VALUE = 2
-    WRITE_NEW_VALUE = 3
+    READ = auto()
+    WRITE_SAME_VALUE = auto()
+    WRITE_NEW_VALUE = auto()
 
 
 class TransactionResult:
     """Enum for the possible transaction outcomes."""
 
-    SUCCESS = 1
-    OUT_OF_GAS = 2
-    REVERT = 3
+    SUCCESS = auto()
+    OUT_OF_GAS = auto()
+    REVERT = auto()
 
 
 @pytest.mark.parametrize(
@@ -244,7 +222,7 @@ class TransactionResult:
     ],
 )
 def test_worst_storage_access_cold(
-    blockchain_test: BlockchainTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     fork: Fork,
     storage_action: StorageAction,
@@ -256,7 +234,6 @@ def test_worst_storage_access_cold(
     """Test running a block with as many cold storage slot accesses as possible."""
     gas_costs = fork.gas_costs()
     intrinsic_gas_cost_calc = fork.transaction_intrinsic_cost_calculator()
-    attack_gas_limit = gas_benchmark_value
 
     loop_cost = gas_costs.G_COLD_SLOAD  # All accesses are always cold
     if storage_action == StorageAction.WRITE_NEW_VALUE:
@@ -305,7 +282,7 @@ def test_worst_storage_access_cold(
         )
 
     num_target_slots = (
-        attack_gas_limit - intrinsic_gas_cost_calc() - prefix_cost - suffix_cost
+        gas_benchmark_value - intrinsic_gas_cost_calc() - prefix_cost - suffix_cost
     ) // loop_cost
     if tx_result == TransactionResult.OUT_OF_GAS:
         # Add an extra slot to make it run out-of-gas
@@ -362,18 +339,16 @@ def test_worst_storage_access_cold(
 
     op_tx = Transaction(
         to=contract_address,
-        gas_limit=attack_gas_limit,
         sender=pre.fund_eoa(),
     )
     blocks.append(Block(txs=[op_tx]))
 
-    blockchain_test(
+    benchmark_test(
         pre=pre,
         post={},
         blocks=blocks,
-        exclude_full_post_state_in_output=True,
         expected_benchmark_gas_used=(
-            total_gas_used if tx_result != TransactionResult.OUT_OF_GAS else attack_gas_limit
+            total_gas_used if tx_result != TransactionResult.OUT_OF_GAS else gas_benchmark_value
         ),
     )
 
@@ -387,15 +362,12 @@ def test_worst_storage_access_cold(
     ],
 )
 def test_worst_storage_access_warm(
-    blockchain_test: BlockchainTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     storage_action: StorageAction,
     env: Environment,
-    gas_benchmark_value: int,
 ):
     """Test running a block with as many warm storage slot accesses as possible."""
-    attack_gas_limit = gas_benchmark_value
-
     blocks = []
 
     # The target storage slot for the warm access is storage slot 0.
@@ -438,12 +410,11 @@ def test_worst_storage_access_warm(
 
     op_tx = Transaction(
         to=contract_address,
-        gas_limit=attack_gas_limit,
         sender=pre.fund_eoa(),
     )
     blocks.append(Block(txs=[op_tx]))
 
-    blockchain_test(
+    benchmark_test(
         pre=pre,
         post={},
         blocks=blocks,
@@ -453,7 +424,6 @@ def test_worst_storage_access_warm(
 def test_worst_blockhash(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
-    gas_benchmark_value: int,
 ):
     """Test running a block with as many blockhash accessing oldest allowed block as possible."""
     # Create 256 dummy blocks to fill the blockhash window.
@@ -466,7 +436,6 @@ def test_worst_blockhash(
     execution_code_address = pre.deploy_contract(code=execution_code)
     op_tx = Transaction(
         to=execution_code_address,
-        gas_limit=gas_benchmark_value,
         sender=pre.fund_eoa(),
     )
     blocks.append(Block(txs=[op_tx]))
@@ -479,35 +448,14 @@ def test_worst_blockhash(
 
 
 def test_worst_selfbalance(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
-    fork: Fork,
-    gas_benchmark_value: int,
 ):
     """Test running a block with as many SELFBALANCE opcodes as possible."""
-    max_stack_height = fork.max_stack_height()
-
-    code_sequence = Op.SELFBALANCE * max_stack_height
-    target_address = pre.deploy_contract(code=code_sequence)
-
-    calldata = Bytecode()
-    attack_block = Op.POP(Op.STATICCALL(Op.GAS, target_address, 0, 0, 0, 0))
-
-    code = code_loop_precompile_call(calldata, attack_block, fork)
-    assert len(code) <= fork.max_code_size()
-
-    code_address = pre.deploy_contract(code=code)
-
-    tx = Transaction(
-        to=code_address,
-        gas_limit=gas_benchmark_value,
-        sender=pre.fund_eoa(),
-    )
-
-    state_test(
+    benchmark_test(
         pre=pre,
         post={},
-        tx=tx,
+        code_generator=ExtCallGenerator(setup=Bytecode(), attack_block=Op.SELFBALANCE),
     )
 
 
@@ -520,7 +468,7 @@ def test_worst_selfbalance(
     ],
 )
 def test_worst_extcodecopy_warm(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     copied_size: int,
     gas_benchmark_value: int,
@@ -544,7 +492,7 @@ def test_worst_extcodecopy_warm(
         sender=pre.fund_eoa(),
     )
 
-    state_test(
+    benchmark_test(
         pre=pre,
         post={},
         tx=tx,
@@ -553,7 +501,7 @@ def test_worst_extcodecopy_warm(
 
 @pytest.mark.parametrize("value_bearing", [True, False])
 def test_worst_selfdestruct_existing(
-    blockchain_test: BlockchainTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     fork: Fork,
     pre: Alloc,
     value_bearing: bool,
@@ -678,21 +626,20 @@ def test_worst_selfdestruct_existing(
         post[deployed_contract_address] = Account(nonce=1)
         deployed_contract_addresses.append(deployed_contract_address)
 
-    blockchain_test(
+    benchmark_test(
         pre=pre,
         post=post,
         blocks=[
             Block(txs=[contracts_deployment_tx]),
             Block(txs=[opcode_tx], fee_recipient=fee_recipient),
         ],
-        exclude_full_post_state_in_output=True,
         expected_benchmark_gas_used=expected_benchmark_gas_used,
     )
 
 
 @pytest.mark.parametrize("value_bearing", [True, False])
 def test_worst_selfdestruct_created(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     value_bearing: bool,
     fork: Fork,
@@ -775,13 +722,11 @@ def test_worst_selfdestruct_created(
     )
     code_tx = Transaction(
         to=code_addr,
-        gas_limit=gas_benchmark_value,
         sender=pre.fund_eoa(),
     )
 
     post = {code_addr: Account(storage={0: 42})}  # Check for successful execution.
-    state_test(
-        env=env,
+    benchmark_test(
         pre=pre,
         post=post,
         tx=code_tx,
@@ -791,7 +736,7 @@ def test_worst_selfdestruct_created(
 
 @pytest.mark.parametrize("value_bearing", [True, False])
 def test_worst_selfdestruct_initcode(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
     value_bearing: bool,
     fork: Fork,
@@ -862,7 +807,7 @@ def test_worst_selfdestruct_initcode(
     )
 
     post = {code_addr: Account(storage={0: 42})}  # Check for successful execution.
-    state_test(
+    benchmark_test(
         env=env,
         pre=pre,
         post=post,