Make room for a new trace function (#1351)

Author: SamWilsn

pyproject.toml

@@ -36,6 +36,7 @@ packages = [
     "ethereum_spec_tools",
     "ethereum_spec_tools.evm_tools",
     "ethereum_spec_tools.evm_tools.t8n",
+    "ethereum_spec_tools.evm_tools.t8n.evm_trace",
     "ethereum_spec_tools.evm_tools.b11r",
     "ethereum_spec_tools.evm_tools.statetest",
     "ethereum_spec_tools.evm_tools.loaders",

src/ethereum_spec_tools/evm_tools/t8n/__init__.py

@@ -25,7 +25,7 @@
     parse_hex_or_int,
 )
 from .env import Env
-from .evm_trace import evm_trace
+from .evm_trace.eip3155 import evm_trace
 from .t8n_types import Alloc, Result, Txs
 
 

src/ethereum_spec_tools/evm_tools/t8n/evm_trace/__init__.py

@@ -0,0 +1,5 @@
+"""
+EVM Trace Implementations.
+
+See [`ethereum.trace`](ref:ethereum.trace).
+"""

src/ethereum_spec_tools/evm_tools/t8n/evm_trace.py renamed to src/ethereum_spec_tools/evm_tools/t8n/evm_trace/eip3155.py

@@ -6,19 +6,7 @@
 import os
 from contextlib import ExitStack
 from dataclasses import asdict, dataclass, is_dataclass
-from typing import (
-    Any,
-    List,
-    Optional,
-    Protocol,
-    TextIO,
-    TypeAlias,
-    Union,
-    runtime_checkable,
-)
-
-from ethereum_types.bytes import Bytes
-from ethereum_types.numeric import U256, Uint
+from typing import Any, List, Optional, TextIO, TypeAlias, Union
 
 from ethereum.exceptions import EthereumException
 from ethereum.trace import (
@@ -34,6 +22,8 @@
     TransactionStart,
 )
 
+from .protocols import Evm, EvmWithReturnData, TransactionEnvironment
+
 EXCLUDE_FROM_OUTPUT = ["gasCostTraced", "errorTraced", "precompile"]
 
 
@@ -79,63 +69,6 @@ def __init__(
             self.error = type(error).__name__
 
 
-@runtime_checkable
-class TransactionEnvironment(Protocol):
-    """
-    The class implements the tx_env interface for trace.
-    """
-
-    index_in_block: Optional[Uint]
-    tx_hash: Optional[Bytes]
-
-
-@runtime_checkable
-class Message(Protocol):
-    """
-    The class implements the message interface for trace.
-    """
-
-    depth: int
-    tx_env: TransactionEnvironment
-    parent_evm: Optional["Evm"]
-
-
-@runtime_checkable
-class EvmWithoutReturnData(Protocol):
-    """
-    The class implements the EVM interface for pre-byzantium forks trace.
-    """
-
-    pc: Uint
-    stack: List[U256]
-    memory: bytearray
-    code: Bytes
-    gas_left: Uint
-    refund_counter: int
-    running: bool
-    message: Message
-
-
-@runtime_checkable
-class EvmWithReturnData(Protocol):
-    """
-    The class implements the EVM interface for post-byzantium forks trace.
-    """
-
-    pc: Uint
-    stack: List[U256]
-    memory: bytearray
-    code: Bytes
-    gas_left: Uint
-    refund_counter: int
-    running: bool
-    message: Message
-    return_data: Bytes
-
-
-Evm = Union[EvmWithoutReturnData, EvmWithReturnData]
-
-
 _ActiveTraces: TypeAlias = tuple[
     TransactionEnvironment, list[Trace | FinalTrace]
 ]
@@ -162,7 +95,7 @@ def evm_trace(
     ):
         return
 
-    assert isinstance(evm, (EvmWithoutReturnData, EvmWithReturnData))
+    assert isinstance(evm, Evm)
 
     if _active_traces and _active_traces[0] is evm.message.tx_env:
         traces = _active_traces[1]

src/ethereum_spec_tools/evm_tools/t8n/evm_trace/protocols.py

@@ -0,0 +1,54 @@
+"""
+Protocol definitions for working with EVM trace events.
+"""
+
+from typing import Optional, Protocol, runtime_checkable
+
+from ethereum_types.bytes import Bytes
+from ethereum_types.numeric import U256, Uint
+
+
+@runtime_checkable
+class TransactionEnvironment(Protocol):
+    """
+    The class implements the tx_env interface for trace.
+    """
+
+    index_in_block: Uint | None
+    tx_hash: Bytes | None
+
+
+@runtime_checkable
+class Message(Protocol):
+    """
+    The class implements the message interface for trace.
+    """
+
+    depth: int
+    tx_env: TransactionEnvironment
+    parent_evm: Optional["Evm"]
+
+
+@runtime_checkable
+class Evm(Protocol):
+    """
+    The class describes the EVM interface for pre-byzantium forks trace.
+    """
+
+    pc: Uint
+    stack: list[U256]
+    memory: bytearray
+    code: Bytes
+    gas_left: Uint
+    refund_counter: int
+    running: bool
+    message: Message
+
+
+@runtime_checkable
+class EvmWithReturnData(Evm, Protocol):
+    """
+    The class describes the EVM interface for post-byzantium forks trace.
+    """
+
+    return_data: Bytes

tests/conftest.py

@@ -60,7 +60,7 @@ def pytest_configure(config: Config) -> None:
 
     if config.getoption("evm_trace"):
         import ethereum.trace
-        from ethereum_spec_tools.evm_tools.t8n.evm_trace import (
+        from ethereum_spec_tools.evm_tools.t8n.evm_trace.eip3155 import (
             evm_trace as new_trace_function,
         )
 

vulture_whitelist.py

@@ -9,7 +9,10 @@
     TransactionLoad,
 )
 from ethereum_spec_tools.evm_tools.t8n.env import Ommer
-from ethereum_spec_tools.evm_tools.t8n.evm_trace import Trace, FinalTrace
+from ethereum_spec_tools.evm_tools.t8n.evm_trace.eip3155 import (
+    Trace,
+    FinalTrace,
+)
 from ethereum_spec_tools.evm_tools.t8n.transition_tool import EELST8N
 from ethereum_spec_tools.lint.lints.glacier_forks_hygiene import (
     GlacierForksHygiene,
@@ -87,7 +90,7 @@
 # src/ethereum_spec_tools/evm_tools/t8n/env.py
 Ommer.delta
 
-# src/ethereum_spec_tools/evm_tools/t8n/evm_trace.py
+# src/ethereum_spec_tools/evm_tools/t8n/evm_trace/eip3155.py
 Trace.gasCost
 Trace.memSize
 Trace.returnData

whitelist.txt

@@ -20,6 +20,7 @@ coincurve
 crypto
 E501
 EIP
+eip3155
 encodings
 endian
 eth
@@ -499,4 +500,4 @@ sig
 CLZ
 EELST8N
 clis
-T8
+T8