refactor(forks): Make Fork Pydantic-Compatible (#1686)

* refactor(forks): Pydantic-friendly `Fork` type

* fix(tests): Bad import

* docs(forks): remove `blockchain_test_network_name` from docs

---------

Co-authored-by: danceratopz <danceratopz@gmail.com>

Author: marioevz

docs/writing_tests/fork_methods.md

@@ -153,7 +153,6 @@ fork.name()  # Returns the name of the fork
 fork.transition_tool_name(block_number=0, timestamp=0)  # Returns name for transition tools
 fork.solc_name()  # Returns name for the solc compiler
 fork.solc_min_version()  # Returns minimum solc version supporting this fork
-fork.blockchain_test_network_name()  # Returns network name for blockchain tests
 fork.is_deployed()  # Returns whether the fork is deployed to mainnet
 ```
 

src/ethereum_clis/clis/besu.py

@@ -106,7 +106,6 @@ def evaluate(
         chain_id: int,
         reward: int,
         blob_schedule: BlobSchedule | None = None,
-        eips: Optional[List[int]] = None,
         debug_output_path: str = "",
         state_test: bool = False,
         slow_request: bool = False,
@@ -119,8 +118,6 @@ def evaluate(
             block_number=env.number,
             timestamp=env.timestamp,
         )
-        if eips is not None:
-            fork_name = "+".join([fork_name] + [str(eip) for eip in eips])
 
         input_json = TransitionToolInput(
             alloc=alloc,

src/ethereum_clis/transition_tool.py

@@ -500,7 +500,6 @@ def evaluate(
         chain_id: int,
         reward: int,
         blob_schedule: BlobSchedule | None,
-        eips: Optional[List[int]] = None,
         debug_output_path: str = "",
         state_test: bool = False,
         slow_request: bool = False,
@@ -515,8 +514,6 @@ def evaluate(
             block_number=env.number,
             timestamp=env.timestamp,
         )
-        if eips is not None:
-            fork_name = "+".join([fork_name] + [str(eip) for eip in eips])
         if env.number == 0:
             reward = -1
         t8n_data = self.TransitionToolData(

src/ethereum_test_fixtures/base.py

@@ -132,7 +132,7 @@ def fill_info(
         if _info_metadata:
             self.info.update(_info_metadata)
 
-    def get_fork(self) -> str | None:
+    def get_fork(self) -> Fork | None:
         """Return fork of the fixture as a string."""
         raise NotImplementedError
 

src/ethereum_test_fixtures/blockchain.py

@@ -386,7 +386,7 @@ def without_rlp(self) -> FixtureBlockBase:
 class FixtureConfig(CamelModel):
     """Chain configuration for a fixture."""
 
-    fork: str = Field(..., alias="network")
+    fork: Fork = Field(..., alias="network")
     chain_id: ZeroPaddedHexNumber = Field(ZeroPaddedHexNumber(1), alias="chainid")
     blob_schedule: FixtureBlobSchedule | None = None
 
@@ -402,7 +402,7 @@ class InvalidFixtureBlock(CamelModel):
 class BlockchainFixtureCommon(BaseFixture):
     """Base blockchain test fixture model."""
 
-    fork: str = Field(..., alias="network")
+    fork: Fork = Field(..., alias="network")
     genesis: FixtureHeader = Field(..., alias="genesisBlockHeader")
     pre: Alloc
     post_state: Alloc | None = Field(None)
@@ -435,7 +435,7 @@ def config_defaults_for_backwards_compatibility(cls, data: Any) -> Any:
                     data["config"]["chainid"] = "0x01"
         return data
 
-    def get_fork(self) -> str | None:
+    def get_fork(self) -> Fork | None:
         """Return fork of the fixture as a string."""
         return self.fork
 

src/ethereum_test_fixtures/consume.py

@@ -8,6 +8,7 @@
 from pydantic import BaseModel, RootModel
 
 from ethereum_test_base_types import HexNumber
+from ethereum_test_forks import Fork
 
 from .base import BaseFixture, FixtureFormat
 from .file import Fixtures
@@ -44,7 +45,7 @@ class TestCaseBase(BaseModel):
 
     id: str
     fixture_hash: HexNumber | None
-    fork: str | None
+    fork: Fork | None
     format: FixtureFormat
     __test__ = False  # stop pytest from collecting this class as a test
 
@@ -80,7 +81,7 @@ class IndexFile(BaseModel):
     root_hash: HexNumber | None
     created_at: datetime.datetime
     test_count: int
-    forks: Optional[List[str]] = []
+    forks: Optional[List[Fork]] = []
     fixture_formats: Optional[List[str]] = []
     test_cases: List[TestCaseIndexFile]
 

src/ethereum_test_fixtures/eof.py

@@ -6,6 +6,7 @@
 
 from ethereum_test_base_types import Bytes, CamelModel, Number
 from ethereum_test_exceptions.exceptions import EOFExceptionInstanceOrList
+from ethereum_test_forks import Fork
 from ethereum_test_types.eof.v1 import ContainerKind
 
 from .base import BaseFixture
@@ -34,7 +35,7 @@ class Vector(CamelModel):
 
     code: Bytes
     container_kind: ContainerKind = ContainerKind.RUNTIME
-    results: Mapping[str, Result]
+    results: Mapping[Fork, Result]
 
 
 class EOFFixture(BaseFixture):
@@ -45,6 +46,6 @@ class EOFFixture(BaseFixture):
 
     vectors: Mapping[Number, Vector]
 
-    def get_fork(self) -> str | None:
+    def get_fork(self) -> Fork | None:
         """Return fork of the fixture as a string."""
         return None

src/ethereum_test_fixtures/state.py

@@ -14,6 +14,7 @@
     ZeroPaddedHexNumber,
 )
 from ethereum_test_exceptions import TransactionExceptionInstanceOrList
+from ethereum_test_forks import Fork
 from ethereum_test_types.block_types import EnvironmentGeneric
 from ethereum_test_types.transaction_types import (
     Transaction,
@@ -97,10 +98,10 @@ class StateFixture(BaseFixture):
     env: FixtureEnvironment
     pre: Alloc
     transaction: FixtureTransaction
-    post: Mapping[str, List[FixtureForkPost]]
+    post: Mapping[Fork, List[FixtureForkPost]]
     config: FixtureConfig
 
-    def get_fork(self) -> str | None:
+    def get_fork(self) -> Fork | None:
         """Return fork of the fixture as a string."""
         forks = list(self.post.keys())
         assert len(forks) == 1, "Expected state test fixture with single fork"

src/ethereum_test_fixtures/tests/test_base.py

@@ -12,7 +12,7 @@ def test_json_dict():
     """Test that the json_dict property does not include the info field."""
     fixture = TransactionFixture(
         txbytes="0x1234",
-        result={"fork": FixtureResult(intrinsic_gas=0)},
+        result={"Paris": FixtureResult(intrinsic_gas=0)},
     )
     assert "_info" not in fixture.json_dict, "json_dict should exclude the 'info' field"
 
@@ -38,7 +38,7 @@ def test_json_dict():
         pytest.param(
             TransactionFixture(
                 transaction="0x1234",
-                result={"fork": FixtureResult(intrinsic_gas=0)},
+                result={"Paris": FixtureResult(intrinsic_gas=0)},
             ),
             id="TransactionFixture",
         ),

src/ethereum_test_fixtures/tests/test_eof.py

@@ -21,7 +21,7 @@
                         code=Bytes(b"\x00"),
                         container_kind=ContainerKind.INITCODE,
                         results={
-                            "result1": Result(
+                            "Paris": Result(
                                 exception=None,
                                 valid=True,
                             ),
@@ -35,7 +35,7 @@
                         "code": "0x00",
                         "containerKind": "INITCODE",
                         "results": {
-                            "result1": {
+                            "Paris": {
                                 "result": True,
                             },
                         },
@@ -52,7 +52,7 @@
                         code=Bytes(b"\x00"),
                         container_kind=ContainerKind.RUNTIME,
                         results={
-                            "result1": Result(
+                            "Paris": Result(
                                 exception=EOFException.INVALID_MAGIC,
                                 valid=False,
                             ),
@@ -66,7 +66,7 @@
                         "code": "0x00",
                         "containerKind": "RUNTIME",
                         "results": {
-                            "result1": {
+                            "Paris": {
                                 "exception": "EOFException.INVALID_MAGIC",
                                 "result": False,
                             },