Temp: Gather opcode counts in fixtures

Author: marioevz

src/ethereum_clis/cli_types.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 from typing import Annotated, Any, Dict, List, Self
 
-from pydantic import Field
+from pydantic import Field, PlainSerializer, PlainValidator
 
 from ethereum_test_base_types import (
     BlobSchedule,
@@ -29,6 +29,7 @@
     Transaction,
     TransactionReceipt,
 )
+from ethereum_test_vm import Opcode, Opcodes
 from pytest_plugins.custom_logging import get_logger
 
 logger = get_logger(__name__)
@@ -175,6 +176,40 @@ def print(self):
             tx.print()
 
 
+_opcode_synonyms = {
+    "KECCAK256": "SHA3",
+}
+
+
+def validate_opcode(obj: Any) -> Opcodes:
+    """Validate an opcode from a string."""
+    if isinstance(obj, Opcode) or isinstance(obj, Opcodes):
+        return obj
+    if isinstance(obj, str):
+        if obj in _opcode_synonyms:
+            obj = _opcode_synonyms[obj]
+        for op in Opcodes:
+            if str(op) == obj:
+                return op
+    raise Exception(f"Unable to validate {obj} (type={type(obj)})")
+
+
+class OpcodeCount(EthereumTestRootModel):
+    """Opcode count returned from the evm tool."""
+
+    root: Dict[
+        Annotated[Opcodes, PlainValidator(validate_opcode), PlainSerializer(lambda o: str(o))], int
+    ]
+
+    def __add__(self, other: Self) -> Self:
+        """Add two instances of opcode count dictionaries."""
+        assert isinstance(other, OpcodeCount), f"Incompatible type {type(other)}"
+        new_dict = self.model_dump() | other.model_dump()
+        for match_key in self.root.keys() & other.root.keys():
+            new_dict[match_key] = self.root[match_key] + other.root[match_key]
+        return OpcodeCount(new_dict)
+
+
 class Result(CamelModel):
     """Result of a transition tool output."""
 
@@ -202,6 +237,7 @@ class Result(CamelModel):
         BlockExceptionWithMessage | UndefinedException | None, ExceptionMapperValidator
     ] = None
     traces: Traces | None = None
+    opcode_count: OpcodeCount | None = None
 
 
 class TransitionToolInput(CamelModel):

src/ethereum_clis/clis/evmone.py

@@ -25,6 +25,7 @@ class EvmOneTransitionTool(TransitionTool):
     binary: Path
     cached_version: Optional[str] = None
     trace: bool
+    supports_opcode_count: ClassVar[bool] = True
 
     def __init__(
         self,

src/ethereum_clis/transition_tool.py

@@ -25,6 +25,7 @@
 from ethereum_test_types import Alloc, Environment, Transaction
 
 from .cli_types import (
+    OpcodeCount,
     Traces,
     TransactionReceipt,
     TransactionTraces,
@@ -71,6 +72,7 @@ class TransitionTool(EthereumCLI):
     t8n_use_server: bool = False
     server_url: str | None = None
     process: Optional[subprocess.Popen] = None
+    supports_opcode_count: ClassVar[bool] = False
 
     supports_xdist: ClassVar[bool] = True
 
@@ -248,6 +250,13 @@ def _evaluate_filesystem(
             "--state.chainid",
             str(t8n_data.chain_id),
         ]
+        if self.supports_opcode_count:
+            args.extend(
+                [
+                    "--opcode.count",
+                    "opcodes.json",
+                ]
+            )
 
         if self.trace:
             args.append("--trace")
@@ -308,6 +317,20 @@ def _evaluate_filesystem(
         output = TransitionToolOutput.model_validate(
             output_contents, context={"exception_mapper": self.exception_mapper}
         )
+        if self.supports_opcode_count:
+            opcode_count_file_path = Path(temp_dir.name) / "opcodes.json"
+            if opcode_count_file_path.exists():
+                opcode_count = OpcodeCount.model_validate_json(opcode_count_file_path.read_text())
+                output.result.opcode_count = opcode_count
+
+                if debug_output_path:
+                    dump_files_to_directory(
+                        debug_output_path,
+                        {
+                            "opcodes.json": opcode_count.model_dump(),
+                        },
+                    )
+
         if self.trace:
             output.result.traces = self.collect_traces(
                 output.result.receipts, temp_dir, debug_output_path

src/ethereum_test_specs/base.py

@@ -15,6 +15,7 @@
 from typing_extensions import Self
 
 from ethereum_clis import Result, TransitionTool
+from ethereum_clis.types import OpcodeCount
 from ethereum_test_base_types import to_hex
 from ethereum_test_execution import BaseExecute, ExecuteFormat, LabeledExecuteFormat
 from ethereum_test_fixtures import (
@@ -75,6 +76,7 @@ class BaseTest(BaseModel):
     _operation_mode: OpMode | None = PrivateAttr(None)
     _gas_optimization: int | None = PrivateAttr(None)
     _gas_optimization_max_gas_limit: int | None = PrivateAttr(None)
+    _opcode_count: OpcodeCount | None = PrivateAttr(None)
 
     expected_benchmark_gas_used: int | None = None
     skip_gas_used_validation: bool = False
@@ -130,6 +132,7 @@ def from_test(
         )
         new_instance._request = base_test._request
         new_instance._operation_mode = base_test._operation_mode
+        new_instance._opcode_count = base_test._opcode_count
         return new_instance
 
     @classmethod

src/ethereum_test_specs/blockchain.py

@@ -531,6 +531,12 @@ def generate_block_data(
             slow_request=self.is_tx_gas_heavy_test(),
         )
 
+        if transition_tool_output.result.opcode_count is not None:
+            if self._opcode_count is None:
+                self._opcode_count = transition_tool_output.result.opcode_count
+            else:
+                self._opcode_count += transition_tool_output.result.opcode_count
+
         # One special case of the invalid transactions is the blob gas used,
         # since this value is not included in the transition tool result, but
         # it is included in the block header, and some clients check it before
@@ -760,6 +766,9 @@ def make_fixture(
                 blob_schedule=FixtureBlobSchedule.from_blob_schedule(fork.blob_schedule()),
                 chain_id=self.chain_id,
             ),
+            info={
+                "opcode_count": self._opcode_count.model_dump(),
+            },
         )
 
     def make_hive_fixture(
@@ -825,6 +834,9 @@ def make_hive_fixture(
                 chain_id=self.chain_id,
                 blob_schedule=FixtureBlobSchedule.from_blob_schedule(fork.blob_schedule()),
             ),
+            "info": {
+                "opcode_count": self._opcode_count.model_dump(),
+            },
         }
 
         # Add format-specific fields