refactor(clis,tools,types): Move TransactionReceipt to types

Author: marioevz

src/ethereum_clis/tests/test_execution_specs.py

@@ -34,7 +34,13 @@ def monkeypatch_path_for_entry_points(monkeypatch):
     monkeypatch.setenv("PATH", f"{bin_dir}:{os.environ['PATH']}")
 
 
-@pytest.mark.parametrize("t8n", [ExecutionSpecsTransitionTool()])
+@pytest.fixture
+def t8n(request):
+    """Fixture for the `t8n` argument."""
+    return request.param()
+
+
+@pytest.mark.parametrize("t8n", [ExecutionSpecsTransitionTool], indirect=True)
 @pytest.mark.parametrize("fork", [London, Istanbul])
 @pytest.mark.parametrize(
     "alloc,base_fee,expected_hash",
@@ -150,7 +156,7 @@ def env(test_dir: str) -> Environment:
         return Environment.model_validate_json(f.read())
 
 
-@pytest.mark.parametrize("t8n", [ExecutionSpecsTransitionTool()])
+@pytest.mark.parametrize("t8n", [ExecutionSpecsTransitionTool], indirect=True)
 @pytest.mark.parametrize("test_dir", os.listdir(path=FIXTURES_ROOT))
 def test_evm_t8n(
     t8n: TransitionTool,

src/ethereum_clis/types.py

@@ -4,49 +4,8 @@
 
 from pydantic import Field
 
-from ethereum_test_base_types import Address, Bloom, Bytes, CamelModel, Hash, HexNumber
-from ethereum_test_types import Alloc, Environment, Transaction
-
-
-class TransactionLog(CamelModel):
-    """Transaction log."""
-
-    address: Address
-    topics: List[Hash]
-    data: Bytes
-    block_number: HexNumber
-    transaction_hash: Hash
-    transaction_index: HexNumber
-    block_hash: Hash
-    log_index: HexNumber
-    removed: bool
-
-
-class SetCodeDelegation(CamelModel):
-    """Set code delegation."""
-
-    from_address: Address = Field(..., alias="from")
-    nonce: HexNumber
-    target: Address
-
-
-class TransactionReceipt(CamelModel):
-    """Transaction receipt."""
-
-    transaction_hash: Hash
-    gas_used: HexNumber
-    root: Bytes | None = None
-    status: HexNumber | None = None
-    cumulative_gas_used: HexNumber | None = None
-    logs_bloom: Bloom | None = None
-    logs: List[TransactionLog] | None = None
-    contract_address: Address | None = None
-    effective_gas_price: HexNumber | None = None
-    block_hash: Hash | None = None
-    transaction_index: HexNumber | None = None
-    blob_gas_used: HexNumber | None = None
-    blob_gas_price: HexNumber | None = None
-    delegations: List[SetCodeDelegation] | None = None
+from ethereum_test_base_types import Bloom, Bytes, CamelModel, Hash, HexNumber
+from ethereum_test_types import Alloc, Environment, Transaction, TransactionReceipt
 
 
 class RejectedTransaction(CamelModel):

src/ethereum_test_tools/__init__.py

@@ -51,6 +51,7 @@
     Storage,
     TestParameterGroup,
     Transaction,
+    TransactionReceipt,
     Withdrawal,
     WithdrawalRequest,
     add_kzg_version,
@@ -144,6 +145,7 @@
     "TestPrivateKey2",
     "Transaction",
     "TransactionException",
+    "TransactionReceipt",
     "TransactionTest",
     "TransactionTestFiller",
     "Withdrawal",

src/ethereum_test_types/__init__.py

@@ -22,6 +22,7 @@
     Storage,
     Transaction,
     TransactionDefaults,
+    TransactionReceipt,
     Withdrawal,
     WithdrawalRequest,
     keccak256,
@@ -49,6 +50,7 @@
     "TestPrivateKey2",
     "Transaction",
     "TransactionDefaults",
+    "TransactionReceipt",
     "Withdrawal",
     "WithdrawalRequest",
     "ZeroPaddedHexNumber",

src/ethereum_test_types/helpers.py

@@ -78,19 +78,19 @@ def compute_eofcreate_address(
 
 def add_kzg_version(
     b_hashes: List[bytes | SupportsBytes | int | str], kzg_version: int
-) -> List[bytes]:
+) -> List[Hash]:
     """Add  Kzg Version to each blob hash."""
     kzg_version_hex = bytes([kzg_version])
     kzg_versioned_hashes = []
 
     for b_hash in b_hashes:
         b_hash = bytes(Hash(b_hash))
         if isinstance(b_hash, int) or isinstance(b_hash, str):
-            kzg_versioned_hashes.append(kzg_version_hex + b_hash[1:])
+            kzg_versioned_hashes.append(Hash(kzg_version_hex + b_hash[1:]))
         elif isinstance(b_hash, bytes) or isinstance(b_hash, SupportsBytes):
             if isinstance(b_hash, SupportsBytes):
                 b_hash = bytes(b_hash)
-            kzg_versioned_hashes.append(kzg_version_hex + b_hash[1:])
+            kzg_versioned_hashes.append(Hash(kzg_version_hex + b_hash[1:]))
         else:
             raise TypeError("Blob hash must be either an integer, string or bytes")
     return kzg_versioned_hashes

src/ethereum_test_types/types.py

@@ -27,6 +27,7 @@
     AccessList,
     Account,
     Address,
+    Bloom,
     BLSPublicKey,
     BLSSignature,
     Bytes,
@@ -558,6 +559,47 @@ def sign(self, private_key: Hash) -> None:
         self.s = HexNumber(signature[2])
 
 
+class TransactionLog(CamelModel):
+    """Transaction log."""
+
+    address: Address
+    topics: List[Hash]
+    data: Bytes
+    block_number: HexNumber
+    transaction_hash: Hash
+    transaction_index: HexNumber
+    block_hash: Hash
+    log_index: HexNumber
+    removed: bool
+
+
+class ReceiptDelegation(CamelModel):
+    """Transaction receipt set-code delegation."""
+
+    from_address: Address = Field(..., alias="from")
+    nonce: HexNumber
+    target: Address
+
+
+class TransactionReceipt(CamelModel):
+    """Transaction receipt."""
+
+    transaction_hash: Hash | None = None
+    gas_used: HexNumber | None = None
+    root: Bytes | None = None
+    status: HexNumber | None = None
+    cumulative_gas_used: HexNumber | None = None
+    logs_bloom: Bloom | None = None
+    logs: List[TransactionLog] | None = None
+    contract_address: Address | None = None
+    effective_gas_price: HexNumber | None = None
+    block_hash: Hash | None = None
+    transaction_index: HexNumber | None = None
+    blob_gas_used: HexNumber | None = None
+    blob_gas_price: HexNumber | None = None
+    delegations: List[ReceiptDelegation] | None = None
+
+
 @dataclass
 class TransactionDefaults:
     """Default values for transactions."""
@@ -660,6 +702,8 @@ class Transaction(TransactionGeneric[HexNumber], TransactionTransitionToolConver
     protected: bool = Field(True, exclude=True)
     rlp_override: Bytes | None = Field(None, exclude=True)
 
+    expected_receipt: TransactionReceipt | None = Field(None, exclude=True)
+
     wrapped_blob_transaction: bool = Field(False, exclude=True)
     blobs: Sequence[Bytes] | None = Field(None, exclude=True)
     blob_kzg_commitments: Sequence[Bytes] | None = Field(None, exclude=True)