fixed serialization/deserialization of fork:Fork (not str anymore), other fixes

Author: felix314159

src/ethereum_test_forks/forks/forks.py

@@ -4,7 +4,7 @@
 from hashlib import sha256
 from os.path import realpath
 from pathlib import Path
-from typing import Dict, List, Literal, Mapping, Optional, Sized, Tuple, Union
+from typing import List, Literal, Mapping, Optional, Sized, Tuple
 
 from semver import Version
 

src/ethereum_test_types/blob_types.py

@@ -9,12 +9,12 @@
 
 import ckzg  # type: ignore
 import platformdirs
+from pydantic import field_serializer, field_validator
 
 from ethereum_test_base_types.base_types import Bytes, Hash
 from ethereum_test_base_types.pydantic import CamelModel
 from ethereum_test_forks import (
     Cancun,
-    CancunToPragueAtTime15k,
     Fork,
     Osaka,
     Prague,
@@ -25,6 +25,19 @@
 )
 
 
+def fork_string_to_object(fork_name: str) -> type[Cancun] | type[Prague] | type[Osaka]:
+    """Take a fork string and return the respective fork as object."""
+    fork_name = fork_name.lower()
+
+    if fork_name == "cancun":
+        return Cancun
+    if fork_name == "prague":
+        return Prague
+    if fork_name == "osaka":
+        return Osaka
+    raise ValueError(f"Fork {fork_name} has not yet been implemented in this function.")
+
+
 class Blob(CamelModel):
     """Class representing a full blob."""
 
@@ -50,6 +63,25 @@ def trusted_setup(cls):
             print(f"{trusted_setup_path} has been loaded")
             cls._trusted_setup = trusted_setup
 
+    @field_validator("fork", mode="before")
+    @classmethod
+    def validate_fork(cls, v):
+        """
+        When reading JSON file and trying to go back from fork string to fork object we must
+        tell pydantic how to do this.
+        """
+        if isinstance(v, str):
+            return fork_string_to_object(v)
+        return v
+
+    @field_serializer("fork")
+    def serialize_fork(self, fork: Fork) -> str:
+        """
+        When trying to serialize a Blob object into a JSON file we must
+        tell pydantic how to do this.
+        """
+        return fork.name()
+
     @staticmethod
     def get_filename(fork: Fork, seed: int) -> str:
         """Return filename this blob would have as string (with .json extension)."""
@@ -405,8 +437,9 @@ def corrupt_byte(b: bytes) -> Bytes:
 # mytestfork: Fork = CancunToPragueAtTime15k
 # mytestfork.fork_at(timestamp=14999)  # returns cancun
 # mytestfork.fork_at(timestamp=15000)  # returns prague
-# TODO: call this once only at blob creation (not when reading blob from file) + remove timestamp from json
+# TODO: call this once only at blob creation (not when reading blob from file) + remove timestamp from json  # noqa: E501
 
+# TODO: fix tests/osaka/eip7594_peerdas/test_get_blobs.py
 # TODO: test all functions again
 
 # --------- generate static blobs ------------
@@ -436,60 +469,60 @@ def corrupt_byte(b: bytes) -> Bytes:
 # print(f"Generated and wrote {amount_of_blobs} blobs to disk in: {duration_ms:.3f} ms")
 
 
-myosaka: Fork = Osaka
-print(f"Fork test print: {myosaka.name()}")
-myprague: Fork = Prague
-mycancun: Fork = Cancun
-myseed: int = 1337  # fork+seed is the unique ID of a blob
-mytimestamp: int = 168123123
-# test 1: blob construction
-b: Blob = Blob.from_fork(myosaka, myseed, mytimestamp)
-# test 2: reconstruction from json
-json_str: str = b.model_dump_json()
-restored: Blob = Blob.model_validate_json(json_str)
-assert b.data == restored.data
-assert b.commitment == restored.commitment
-assert b.proof == restored.proof
-assert b.cells == restored.cells
-assert b.versioned_hash == restored.versioned_hash
-assert b.name == restored.name
-assert b.fork == restored.fork
-assert b.seed == restored.seed
-assert b.timestamp == restored.timestamp
-print(type(b.proof), len(b.proof))
-# test 3: write to file
-b.write_to_file()
-# test 4: read from file
-bzzz = Blob.from_file("blob_1337_cell_proofs_128")
-print("read osaka blob file from cache dir")
-# test 5: prague blob creation + write
-d: Blob = Blob.from_fork(myprague, myseed, 123)
-d.write_to_file()
-# test 6: reading prague from file
-e: Blob = Blob.from_file("blob_1337_cell_proofs_0")
-print("read prague blob file from cache dir")
-# test 7: cancun (will overwrite prague blob cuz same target filename)
-dddddde: Blob = Blob.from_fork(mycancun, myseed, 123)
-dddddde.write_to_file()
-print("line above should say file existed already (cancun overwrites prague)")
-# test 8: non-blob forks can't create blobs
-# myparis: Fork = Paris
-# parisapriaparip: Blob = Blob.from_fork(myparis, myseed, 123)
-
-# test proof corruption
-#  osaka
-testseed = 55
-ddd: Blob = Blob.from_fork(Osaka, testseed + 10)
-assert isinstance(ddd.proof[0], bytes)  # mypy fix
-oldValue = ddd.proof[0][5]
-for m in Blob.ProofCorruptionMode:
-    ddd.corrupt_proof(m)
-print("proof corruption works (osaka):", oldValue != ddd.proof[0][5])
-#   prague
-eeeeeeeeee: Blob = Blob.from_fork(Prague, testseed + 11)
-assert isinstance(eeeeeeeeee.proof[5], int)  # mypy fix
-oldValue = eeeeeeeeee.proof[5]
-for m in Blob.ProofCorruptionMode:
-    eeeeeeeeee.corrupt_proof(m)
-print("proof corruption works (prague):", oldValue != eeeeeeeeee.proof[5])
-print("pydantic model works")
+# myosaka: Fork = Osaka
+# print(f"Fork test print: {myosaka.name()}")
+# myprague: Fork = Prague
+# mycancun: Fork = Cancun
+# myseed: int = 1337  # fork+seed is the unique ID of a blob
+# mytimestamp: int = 168123123
+# # test 1: blob construction
+# b: Blob = Blob.from_fork(myosaka, myseed, mytimestamp)
+# # test 2: reconstruction from json
+# json_str: str = b.write_to_file()
+# restored: Blob = Blob.from_file("blob_1337_cell_proofs_128")
+# assert b.data == restored.data
+# assert b.commitment == restored.commitment
+# assert b.proof == restored.proof
+# assert b.cells == restored.cells
+# assert b.versioned_hash == restored.versioned_hash
+# assert b.name == restored.name
+# assert b.fork == restored.fork
+# assert b.seed == restored.seed
+# assert b.timestamp == restored.timestamp
+# print(type(b.proof), len(b.proof))
+# # test 3: write to file
+# b.write_to_file()
+# # test 4: read from file
+# bzzz = Blob.from_file("blob_1337_cell_proofs_128")
+# print("read osaka blob file from cache dir")
+# # test 5: prague blob creation + write
+# d: Blob = Blob.from_fork(myprague, myseed, 123)
+# d.write_to_file()
+# # test 6: reading prague from file
+# e: Blob = Blob.from_file("blob_1337_cell_proofs_0")
+# print("read prague blob file from cache dir")
+# # test 7: cancun (will overwrite prague blob cuz same target filename)
+# dddddde: Blob = Blob.from_fork(mycancun, myseed, 123)
+# dddddde.write_to_file()
+# print("line above should say file existed already (cancun overwrites prague)")
+# # test 8: non-blob forks can't create blobs
+# # myparis: Fork = Paris
+# # parisapriaparip: Blob = Blob.from_fork(myparis, myseed, 123)
+
+# # test proof corruption
+# #  osaka
+# testseed = 55
+# ddd: Blob = Blob.from_fork(Osaka, testseed + 10)
+# assert isinstance(ddd.proof[0], bytes)  # mypy fix
+# oldValue = ddd.proof[0][5]
+# for m in Blob.ProofCorruptionMode:
+#     ddd.corrupt_proof(m)
+# print("proof corruption works (osaka):", oldValue != ddd.proof[0][5])
+# #   prague
+# eeeeeeeeee: Blob = Blob.from_fork(Prague, testseed + 11)
+# assert isinstance(eeeeeeeeee.proof[5], int)  # mypy fix
+# oldValue = eeeeeeeeee.proof[5]
+# for m in Blob.ProofCorruptionMode:
+#     eeeeeeeeee.corrupt_proof(m)
+# print("proof corruption works (prague):", oldValue != eeeeeeeeee.proof[5])
+# print("pydantic model works")

tests/osaka/eip7594_peerdas/spec.py

@@ -1,7 +1,6 @@
 """Defines EIP-7594 specification constants and functions."""
 
 from dataclasses import dataclass
-from typing import Literal
 
 
 @dataclass(frozen=True)