tools: state_test_only, genesis blockchain modifications

Author: marioevz

docs/CHANGELOG.md

@@ -16,6 +16,7 @@ Test fixtures for use by clients are available for each release on the [Github r
 - ✨ Fork objects used to write tests can now be compared using the `>`, `>=`, `<`, `<=` operators, to check for a fork being newer than, newer than or equal, older than, older than or equal, respectively when compared against other fork ([#367](https://github.com/ethereum/execution-spec-tests/pull/367))
 - 💥 Removed `--enable-hive` parameter, now all test types are generated by default ([#358](https://github.com/ethereum/execution-spec-tests/pull/358))
 - 💥 `StateTest`, spec format used to write tests, is now limited to a single transaction per test ([#361](https://github.com/ethereum/execution-spec-tests/pull/361))
+- ✨ `StateTestOnly`, spec format is now available and its only difference with `StateTest` is that it does not produce a `BlockchainTest` ([#368](https://github.com/ethereum/execution-spec-tests/pull/368))
 
 ### 🔧 EVM Tools
 

src/ethereum_test_tools/spec/__init__.py

@@ -6,9 +6,9 @@
 from .base.base_test import BaseFixture, BaseTest, TestSpec, verify_post_alloc
 from .blockchain.blockchain_test import BlockchainTest, BlockchainTestFiller, BlockchainTestSpec
 from .fixture_collector import FixtureCollector, TestInfo
-from .state.state_test import StateTest, StateTestFiller, StateTestSpec
+from .state.state_test import StateTest, StateTestFiller, StateTestOnly, StateTestSpec
 
-SPEC_TYPES: List[Type[BaseTest]] = [BlockchainTest, StateTest]
+SPEC_TYPES: List[Type[BaseTest]] = [BlockchainTest, StateTest, StateTestOnly]
 
 __all__ = (
     "SPEC_TYPES",
@@ -20,6 +20,7 @@
     "FixtureCollector",
     "StateTest",
     "StateTestFiller",
+    "StateTestOnly",
     "StateTestSpec",
     "TestInfo",
     "TestSpec",

src/ethereum_test_tools/spec/blockchain/types.py

@@ -410,14 +410,19 @@ def verify(self, baseline: Header):
                 assert baseline_value is not Header.REMOVE_FIELD, "invalid baseline header"
                 value = getattr(self, field_name)
                 if baseline_value is Header.EMPTY_FIELD:
-                    assert value is None, f"invalid header field {header_field}"
+                    assert (
+                        value is None
+                    ), f"invalid header field {field_name}, got {value}, want None"
                     continue
                 metadata = header_field.metadata
                 field_metadata = metadata.get("source")
                 # type check is performed on collect()
                 if field_metadata.parse_type is not None:  # type: ignore
                     baseline_value = field_metadata.parse_type(baseline_value)  # type: ignore
-                assert value == baseline_value, f"invalid header field {header_field}"
+                assert value == baseline_value, (
+                    f"invalid header field ({field_name}) value, "
+                    + f"got {value}, want {baseline_value}"
+                )
 
     def build(
         self,

src/ethereum_test_tools/spec/state/state_test.py

@@ -13,10 +13,12 @@
 from ...common.json import to_json
 from ..base.base_test import BaseFixture, BaseTest, verify_post_alloc
 from ..blockchain.blockchain_test import Block, BlockchainTest
+from ..blockchain.types import Header
 from ..debugging import print_traces
 from .types import Fixture, FixtureForkPost
 
 BEACON_ROOTS_ADDRESS = Address(0x000F3DF6D732807EF1319FB7B8BB8522D0BEAC02)
+TARGET_BLOB_GAS_PER_BLOCK = 393216
 
 
 @dataclass(kw_only=True)
@@ -30,6 +32,8 @@ class StateTest(BaseTest):
     post: Mapping
     tx: Transaction
     engine_api_error_code: Optional[EngineAPIError] = None
+    blockchain_test_header_verify: Optional[Header] = None
+    blockchain_test_rlp_modifier: Optional[Header] = None
     tag: str = ""
     chain_id: int = 1
 
@@ -58,12 +62,22 @@ def _generate_blockchain_genesis_environment(self) -> Environment:
         genesis_env = copy(self.env)
 
         # Modify values to the proper values for the genesis block
+        # TODO: All of this can be moved to a new method in `Fork`
         genesis_env.withdrawals = None
         genesis_env.beacon_root = None
         genesis_env.number = Number(genesis_env.number) - 1
         assert (
             genesis_env.number >= 0
         ), "genesis block number cannot be negative, set state test env.number to 1"
+        if genesis_env.excess_blob_gas:
+            # The excess blob gas environment value means the value of the context (block header)
+            # where the transaction is executed. In a blockchain test, we need to indirectly
+            # set the excess blob gas by setting the excess blob gas of the genesis block
+            # to the expected value plus the TARGET_BLOB_GAS_PER_BLOCK, which is the value
+            # that will be subtracted from the excess blob gas when the first block is mined.
+            genesis_env.excess_blob_gas = (
+                Number(genesis_env.excess_blob_gas) + TARGET_BLOB_GAS_PER_BLOCK
+            )
 
         return genesis_env
 
@@ -83,6 +97,9 @@ def _generate_blockchain_blocks(self) -> List[Block]:
                 beacon_root=self.env.beacon_root,
                 txs=[self.tx],
                 ommers=[],
+                exception=self.tx.error,
+                header_verify=self.blockchain_test_header_verify,
+                rlp_modifier=self.blockchain_test_rlp_modifier,
             )
         ]
 
@@ -186,5 +203,25 @@ def generate(
         raise Exception(f"Unknown fixture format: {self.fixture_format}")
 
 
+class StateTestOnly(StateTest):
+    """
+    StateTest filler that only generates a state test fixture.
+    """
+
+    @classmethod
+    def pytest_parameter_name(cls) -> str:
+        """
+        Returns the parameter name used to identify this filler in a test.
+        """
+        return "state_test_only"
+
+    @classmethod
+    def fixture_formats(cls) -> List[FixtureFormats]:
+        """
+        Returns a list of fixture formats that can be output to the test spec.
+        """
+        return [FixtureFormats.STATE_TEST]
+
+
 StateTestSpec = Callable[[str], Generator[StateTest, None, None]]
 StateTestFiller = Type[StateTest]

src/ethereum_test_tools/spec/state/types.py

@@ -19,12 +19,86 @@
     Environment,
     Hash,
     HexNumber,
+    Number,
+    NumberConvertible,
     Transaction,
     ZeroPaddedHexNumber,
 )
 from ..base.base_test import BaseFixture
 
 
+@dataclass(kw_only=True)
+class FixtureEnvironment:
+    """
+    Type used to describe the environment of a state test.
+    """
+
+    coinbase: FixedSizeBytesConvertible = field(
+        default="0x2adc25665018aa1fe0e6bc666dac8fc2697ff9ba",
+        json_encoder=JSONEncoder.Field(
+            name="currentCoinbase",
+            cast_type=Address,
+        ),
+    )
+    gas_limit: NumberConvertible = field(
+        default=100000000000000000,
+        json_encoder=JSONEncoder.Field(
+            name="currentGasLimit",
+            cast_type=Number,
+        ),
+    )
+    number: NumberConvertible = field(
+        default=1,
+        json_encoder=JSONEncoder.Field(
+            name="currentNumber",
+            cast_type=Number,
+        ),
+    )
+    timestamp: NumberConvertible = field(
+        default=1000,
+        json_encoder=JSONEncoder.Field(
+            name="currentTimestamp",
+            cast_type=Number,
+        ),
+    )
+    prev_randao: Optional[NumberConvertible] = field(
+        default=None,
+        json_encoder=JSONEncoder.Field(
+            name="currentRandom",
+            cast_type=Number,
+        ),
+    )
+    difficulty: Optional[NumberConvertible] = field(
+        default=None,
+        json_encoder=JSONEncoder.Field(
+            name="currentDifficulty",
+            cast_type=Number,
+        ),
+    )
+    base_fee: Optional[NumberConvertible] = field(
+        default=None,
+        json_encoder=JSONEncoder.Field(
+            name="currentBaseFee",
+            cast_type=Number,
+        ),
+    )
+    excess_blob_gas: Optional[NumberConvertible] = field(
+        default=None,
+        json_encoder=JSONEncoder.Field(
+            name="currentExcessBlobGas",
+            cast_type=Number,
+        ),
+    )
+
+    @classmethod
+    def from_env(cls, env: Environment) -> "FixtureEnvironment":
+        """
+        Returns a FixtureEnvironment from an Environment.
+        """
+        kwargs = {field.name: getattr(env, field.name) for field in fields(cls)}
+        return cls(**kwargs)
+
+
 @dataclass(kw_only=True)
 class FixtureTransaction:
     """
@@ -195,6 +269,7 @@ def collect(
             state_root=state_root,
             logs_hash=logs_hash,
             tx_bytes=transaction.serialized_bytes(),
+            expected_exception=transaction.error,
             indexes=indexes,
         )
 
@@ -207,6 +282,7 @@ class Fixture(BaseFixture):
 
     env: Environment = field(
         json_encoder=JSONEncoder.Field(
+            cast_type=FixtureEnvironment.from_env,
             to_json=True,
         ),
     )