feat(fw,tests): framework changes for eip7742.

spencer-tb · spencer-tb · commit d91fb5094ebf · 2024-11-20T16:30:27.000+07:00
diff --git a/src/ethereum_test_fixtures/blockchain.py b/src/ethereum_test_fixtures/blockchain.py
@@ -111,6 +111,9 @@ class FixtureHeader(CamelModel):
         None
     )
     requests_hash: Annotated[Hash, HeaderForkRequirement("requests")] | None = Field(None)
+    target_blob_count: Annotated[
+        ZeroPaddedHexNumber, HeaderForkRequirement("target_blob_count")
+    ] | None = Field(None)
 
     fork: Fork | None = Field(None, exclude=True)
 
@@ -199,6 +202,8 @@ class FixtureExecutionPayload(CamelModel):
     blob_gas_used: HexNumber | None = Field(None)
     excess_blob_gas: HexNumber | None = Field(None)
 
+    target_blob_count: HexNumber | None = Field(None)
+
     block_hash: Hash
 
     transactions: List[Bytes]
@@ -224,7 +229,7 @@ def from_fixture_header(
 
 EngineNewPayloadV1Parameters = Tuple[FixtureExecutionPayload]
 EngineNewPayloadV3Parameters = Tuple[FixtureExecutionPayload, List[Hash], Hash]
-EngineNewPayloadV4Parameters = Tuple[FixtureExecutionPayload, List[Hash], Hash, List[Bytes]]
+EngineNewPayloadV4Parameters = Tuple[FixtureExecutionPayload, List[Hash], Hash, List[Bytes], HexNumber]
 
 # Important: We check EngineNewPayloadV3Parameters first as it has more fields, and pydantic
 # has a weird behavior when the smaller tuple is checked first.
@@ -286,32 +291,34 @@ def from_fixture_header(
             transactions=transactions,
             withdrawals=withdrawals,
         )
-        params: EngineNewPayloadParameters
-        if (
-            fork.engine_new_payload_requests(header.number, header.timestamp)
-            and requests is not None
-        ):
-            parent_beacon_block_root = header.parent_beacon_block_root
-            assert parent_beacon_block_root is not None
-            params = (
-                execution_payload,
-                Transaction.list_blob_versioned_hashes(transactions),
-                parent_beacon_block_root,
-                requests,
-            )
-        elif fork.engine_new_payload_blob_hashes(header.number, header.timestamp):
-            parent_beacon_block_root = header.parent_beacon_block_root
-            assert parent_beacon_block_root is not None
-            params = (
-                execution_payload,
-                Transaction.list_blob_versioned_hashes(transactions),
-                parent_beacon_block_root,
-            )
-        else:
-            params = (execution_payload,)
 
+        params: List[Any] = [execution_payload]
+        if fork.engine_new_payload_blob_hashes(header.number, header.timestamp):
+            blob_hashes = Transaction.list_blob_versioned_hashes(transactions)
+            if blob_hashes is None:
+                raise ValueError(f"Blob hashes are required for ${fork}.")
+            params.append(blob_hashes)
+
+        if fork.engine_new_payload_beacon_root(header.number, header.timestamp):
+            parent_beacon_block_root = header.parent_beacon_block_root
+            if parent_beacon_block_root is None:
+                raise ValueError(f"Parent beacon block root is required for ${fork}.")
+            params.append(parent_beacon_block_root)
+
+        if fork.engine_new_payload_requests(header.number, header.timestamp):
+            if requests is None:
+                raise ValueError(f"Requests are required for ${fork}.")
+            params.append(requests)
+
+        if fork.engine_new_payload_target_blob_count(header.number, header.timestamp):
+            target_blob_count = header.target_blob_count
+            if target_blob_count is None:
+                raise ValueError(f"Target blob count is required for ${fork}.")
+            params.append(target_blob_count)
+
+        payload_params: EngineNewPayloadParameters = tuple(params)
         new_payload = cls(
-            params=params,
+            params=payload_params,
             new_payload_version=new_payload_version,
             forkchoice_updated_version=forkchoice_updated_version,
             **kwargs,
diff --git a/src/ethereum_test_fixtures/tests/test_blockchain.py b/src/ethereum_test_fixtures/tests/test_blockchain.py
@@ -668,6 +668,7 @@
                     excess_blob_gas=18,
                     parent_beacon_block_root=19,
                     requests_hash=20,
+                    target_blob_count=10,
                 ),
                 transactions=[
                     Transaction(
@@ -790,7 +791,7 @@
                         ).requests_list
                     ],
                 ],
-                "forkchoiceUpdatedVersion": "3",
+                "forkchoiceUpdatedVersion": "4",
                 "newPayloadVersion": "4",
                 "validationError": "BlockException.INCORRECT_BLOCK_FORMAT"
                 "|TransactionException.INTRINSIC_GAS_TOO_LOW",
@@ -947,7 +948,7 @@
                     ],
                 ],
                 "newPayloadVersion": "4",
-                "forkchoiceUpdatedVersion": "3",
+                "forkchoiceUpdatedVersion": "4",
                 "validationError": "BlockException.INCORRECT_BLOCK_FORMAT"
                 "|TransactionException.INTRINSIC_GAS_TOO_LOW",
             },
@@ -1191,6 +1192,7 @@ def test_json_deserialization(
                         withdrawals_root=Hash(16),
                         blob_gas_used=17,
                         excess_blob_gas=18,
+                        target_blob_count=10,
                     ),
                     transactions=[
                         Transaction(
@@ -1249,6 +1251,7 @@ def test_json_deserialization(
                     "baseFeePerGas": hex(15),
                     "blobGasUsed": hex(17),
                     "excessBlobGas": hex(18),
+                    "targetBlobCount": hex(10),
                     "blockHash": "0xd90115b7fde329f64335763a446af1"
                     "50ab67e639281dccdb07a007d18bb80211",
                     "transactions": [
diff --git a/src/ethereum_test_forks/base_fork.py b/src/ethereum_test_forks/base_fork.py
@@ -246,6 +246,14 @@ def transaction_intrinsic_cost_calculator(
         """
         pass
 
+    @classmethod
+    @abstractmethod
+    def header_target_blob_count_required(cls, block_number: int, timestamp: int) -> bool:
+        """
+        Returns true if the header must contain target blob count
+        """
+        pass
+
     @classmethod
     @abstractmethod
     def blob_gas_per_blob(cls, block_number: int, timestamp: int) -> int:
@@ -254,6 +262,14 @@ def blob_gas_per_blob(cls, block_number: int, timestamp: int) -> int:
         """
         pass
 
+    @classmethod
+    @abstractmethod
+    def target_blob_count(cls, block_number: int, timestamp: int) -> int:
+        """
+        Returns the target blobs per block for a given fork.
+        """
+        pass
+
     @classmethod
     @abstractmethod
     def get_reward(cls, block_number: int = 0, timestamp: int = 0) -> int:
@@ -353,7 +369,15 @@ def engine_new_payload_beacon_root(cls, block_number: int = 0, timestamp: int =
     @abstractmethod
     def engine_new_payload_requests(cls, block_number: int = 0, timestamp: int = 0) -> bool:
         """
-        Returns true if the engine api version requires new payload calls to include requests.
+        returns true if the engine api version requires new payload calls to include requests.
+        """
+        pass
+
+    @classmethod
+    @abstractmethod
+    def engine_new_payload_target_blob_count(cls, block_number: int = 0, timestamp: int = 0) -> bool:
+        """
+        returns true if the engine api version requires new payload calls to include target blob count.
         """
         pass
 
diff --git a/src/ethereum_test_forks/forks/forks.py b/src/ethereum_test_forks/forks/forks.py
@@ -938,9 +938,16 @@ def header_beacon_root_required(cls, block_number: int = 0, timestamp: int = 0)
     @classmethod
     def blob_gas_per_blob(cls, block_number: int, timestamp: int) -> int:
         """
-        Blobs are enabled started from Cancun.
+        Blobs are enabled starting from Cancun.
         """
         return 2**17
+    
+    @classmethod
+    def target_blob_count(cls, block_number: int, timestamp: int) -> int:
+        """
+        Blobs are enabled starting from Cancun, with a static target of 3 blobs.
+        """
+        return 3
 
     @classmethod
     def tx_types(cls, block_number: int = 0, timestamp: int = 0) -> List[int]:
@@ -1176,6 +1183,14 @@ def header_requests_required(cls, block_number: int, timestamp: int) -> bool:
         """
         return True
 
+    @classmethod
+    def header_target_blob_count_required(cls, block_number: int = 0, timestamp: int = 0) -> bool:
+        """
+        Prague requires that the execution layer header contains the beacon
+        chain target blob count.
+        """
+        return True
+
     @classmethod
     def engine_new_payload_requests(cls, block_number: int = 0, timestamp: int = 0) -> bool:
         """
@@ -1184,9 +1199,9 @@ def engine_new_payload_requests(cls, block_number: int = 0, timestamp: int = 0)
         return True
 
     @classmethod
-    def engine_new_payload_blob_hashes(cls, block_number: int = 0, timestamp: int = 0) -> bool:
+    def engine_new_payload_target_blob_count(cls, block_number: int = 0, timestamp: int = 0) -> bool:
         """
-        Starting at Prague, new payload directives must contain requests as parameter.
+        Starting at Prague, new payloads include the target blob count as a parameter.
         """
         return True
 
@@ -1199,16 +1214,6 @@ def engine_new_payload_version(
         """
         return 4
 
-    @classmethod
-    def engine_forkchoice_updated_version(
-        cls, block_number: int = 0, timestamp: int = 0
-    ) -> Optional[int]:
-        """
-        At Prague, version number of NewPayload and ForkchoiceUpdated diverge.
-        """
-        return 3
-
-
 class CancunEIP7692(  # noqa: SC200
     Cancun,
     transition_tool_name="Prague",  # Evmone enables (only) EOF at Prague
diff --git a/src/ethereum_test_specs/blockchain.py b/src/ethereum_test_specs/blockchain.py
@@ -119,6 +119,7 @@ class Header(CamelModel):
     excess_blob_gas: Removable | HexNumber | None = None
     parent_beacon_block_root: Removable | Hash | None = None
     requests_hash: Removable | Hash | None = None
+    target_blob_count: Removable | HexNumber | None = None
 
     REMOVE_FIELD: ClassVar[Removable] = Removable()
     """
@@ -353,12 +354,17 @@ def make_genesis(
             blob_gas_used=env.blob_gas_used,
             excess_blob_gas=env.excess_blob_gas,
             withdrawals_root=(
-                Withdrawal.list_root(env.withdrawals) if env.withdrawals is not None else None
+                Withdrawal.list_root(env.withdrawals)
+                if env.withdrawals is not None
+                else None
             ),
             parent_beacon_block_root=env.parent_beacon_block_root,
             requests_hash=Requests(max_request_type=fork.max_request_type(0, 0))
             if fork.header_requests_required(0, 0)
             else None,
+            target_blob_count=fork.target_blob_count(0, 0)
+            if fork.header_target_blob_count_required(0, 0)
+            else None,
             fork=fork,
         )
 
diff --git a/src/ethereum_test_types/types.py b/src/ethereum_test_types/types.py
@@ -389,6 +389,7 @@ class EnvironmentGeneric(CamelModel, Generic[NumberBoundTypeVar]):
     difficulty: NumberBoundTypeVar | None = Field(None, alias="currentDifficulty")
     base_fee_per_gas: NumberBoundTypeVar | None = Field(None, alias="currentBaseFee")
     excess_blob_gas: NumberBoundTypeVar | None = Field(None, alias="currentExcessBlobGas")
+    target_blob_count: NumberBoundTypeVar | None = Field(None, alias="currentTargetBlobCount")
 
     parent_difficulty: NumberBoundTypeVar | None = Field(None)
     parent_timestamp: NumberBoundTypeVar | None = Field(None)
@@ -474,6 +475,9 @@ def set_fork_requirements(self, fork: Fork) -> "Environment":
         ):
             updated_values["parent_beacon_block_root"] = 0
 
+        if fork.header_target_blob_count_required(number, timestamp) and self.target_blob_count is None:
+            updated_values["target_blob_count"] = fork.target_blob_count(number, timestamp)
+
         return self.copy(**updated_values)
 
 
diff --git a/src/pytest_plugins/execute/rpc/hive.py b/src/pytest_plugins/execute/rpc/hive.py
@@ -260,7 +260,16 @@ def base_pre_genesis(
                 timestamp=timestamp,
             ),
         )
-        if base_fork.header_requests_required(block_number=block_number, timestamp=timestamp)
+        if base_fork.header_requests_required(
+            block_number=block_number, timestamp=timestamp
+        )
+        else None,
+        target_blob_count=base_fork.target_blob_count(
+            block_number=block_number, timestamp=timestamp
+        )
+        if base_fork.header_target_blob_count_required(
+            block_number=block_number, timestamp=timestamp
+        )
         else None,
     )
 
diff --git a/tests/cancun/eip4844_blobs/test_blob_txs.py b/tests/cancun/eip4844_blobs/test_blob_txs.py
@@ -738,7 +738,7 @@ def test_invalid_normal_gas(
 @pytest.mark.parametrize(
     "tx_error", [TransactionException.TYPE_3_TX_MAX_BLOB_GAS_ALLOWANCE_EXCEEDED], ids=[""]
 )
-@pytest.mark.valid_from("Cancun")
+@pytest.mark.valid_until("Cancun")
 def test_invalid_block_blob_count(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
@@ -1008,7 +1008,7 @@ def test_insufficient_balance_blob_tx_combinations(
     ],
     ids=["too_few_blobs", "too_many_blobs"],
 )
-@pytest.mark.valid_from("Cancun")
+@pytest.mark.valid_until("Cancun")
 def test_invalid_tx_blob_count(
     state_test: StateTestFiller,
     state_env: Environment,
