feat(consume): Add consume sync tests

Add a new type of test that is basically `consume_engine` but gets another client to sync after payloads are executed.

- These tests can be filled with: `uv run fill ... -m "blockchain_engine_sync_test"`
- Filled tests can be run against hive with `uv run consume sync`

Squashes:

- chore: fix formatting and lint errors
- chore: lower some of the timeouts and sleeps for sync tests
- some cleanup

Author: fselmo

src/cli/pytest_commands/consume.py

@@ -48,6 +48,10 @@ def get_command_logic_test_paths(command_name: str, is_hive: bool) -> List[Path]
         command_logic_test_paths = [
             base_path / "simulators" / "simulator_logic" / f"test_via_{command_name}.py"
         ]
+    elif command_name == "sync":
+        command_logic_test_paths = [
+            base_path / "simulators" / "simulator_logic" / "test_via_sync.py"
+        ]
     elif command_name == "direct":
         command_logic_test_paths = [base_path / "direct" / "test_via_direct.py"]
     else:
@@ -107,6 +111,12 @@ def engine() -> None:
     pass
 
 
+@consume_command(is_hive=True)
+def sync() -> None:
+    """Client consumes via the Engine API with sync testing."""
+    pass
+
+
 @consume_command(is_hive=True)
 def hive() -> None:
     """Client consumes via all available hive methods (rlp, engine)."""

src/cli/pytest_commands/processors.py

@@ -101,6 +101,8 @@ def process_args(self, args: List[str]) -> List[str]:
 
         if self.command_name == "engine":
             modified_args.extend(["-p", "pytest_plugins.consume.simulators.engine.conftest"])
+        elif self.command_name == "sync":
+            modified_args.extend(["-p", "pytest_plugins.consume.simulators.sync.conftest"])
         elif self.command_name == "rlp":
             modified_args.extend(["-p", "pytest_plugins.consume.simulators.rlp.conftest"])
         else:

src/ethereum_test_fixtures/__init__.py

@@ -4,6 +4,7 @@
 from .blockchain import (
     BlockchainEngineFixture,
     BlockchainEngineFixtureCommon,
+    BlockchainEngineSyncFixture,
     BlockchainEngineXFixture,
     BlockchainFixture,
     BlockchainFixtureCommon,
@@ -19,6 +20,7 @@
     "BaseFixture",
     "BlockchainEngineFixture",
     "BlockchainEngineFixtureCommon",
+    "BlockchainEngineSyncFixture",
     "BlockchainEngineXFixture",
     "BlockchainFixture",
     "BlockchainFixtureCommon",

src/ethereum_test_fixtures/blockchain.py

@@ -568,3 +568,29 @@ class BlockchainEngineXFixture(BlockchainEngineFixtureCommon):
 
     sync_payload: FixtureEngineNewPayload | None = None
     """Optional sync payload for blockchain synchronization."""
+
+
+class BlockchainEngineSyncFixture(BlockchainEngineFixtureCommon):
+    """
+    Engine Sync specific test fixture information.
+
+    This fixture format is specifically designed for sync testing where:
+    - The client under test receives all payloads
+    - A sync client attempts to sync from the client under test
+    - Both client types are parametrized from hive client config
+    """
+
+    format_name: ClassVar[str] = "blockchain_engine_sync_test"
+    description: ClassVar[str] = (
+        "Tests that generate a blockchain test fixture for Engine API testing with client sync."
+    )
+    pre: Alloc
+    genesis: FixtureHeader = Field(..., alias="genesisBlockHeader")
+    post_state: Alloc | None = Field(None)
+    payloads: List[FixtureEngineNewPayload] = Field(..., alias="engineNewPayloads")
+    sync_payload: FixtureEngineNewPayload | None = None
+
+    @classmethod
+    def output_base_dir_name(cls) -> str:
+        """Return the proper output directory name for sync fixtures."""
+        return "blockchain_engine_sync_tests"

src/ethereum_test_rpc/__init__.py

@@ -1,6 +1,14 @@
 """JSON-RPC methods and helper functions for EEST consume based hive simulators."""
 
-from .rpc import BlockNumberType, DebugRPC, EngineRPC, EthRPC, SendTransactionExceptionError
+from .rpc import (
+    AdminRPC,
+    BlockNumberType,
+    DebugRPC,
+    EngineRPC,
+    EthRPC,
+    NetRPC,
+    SendTransactionExceptionError,
+)
 from .types import (
     BlobAndProofV1,
     BlobAndProofV2,
@@ -10,6 +18,7 @@
 )
 
 __all__ = [
+    "AdminRPC",
     "BlobAndProofV1",
     "BlobAndProofV2",
     "BlockNumberType",
@@ -19,5 +28,6 @@
     "EthRPC",
     "ForkConfig",
     "ForkConfigBlobSchedule",
+    "NetRPC",
     "SendTransactionExceptionError",
 ]

src/ethereum_test_rpc/rpc.py

@@ -152,6 +152,10 @@ def get_block_by_number(self, block_number: BlockNumberType = "latest", full_txs
         block = hex(block_number) if isinstance(block_number, int) else block_number
         return self.post_request("getBlockByNumber", block, full_txs)
 
+    def get_block_by_hash(self, block_hash: Hash, full_txs: bool = True):
+        """`eth_getBlockByHash`: Returns information about a block by hash."""
+        return self.post_request("getBlockByHash", f"{block_hash}", full_txs)
+
     def get_balance(self, address: Address, block_number: BlockNumberType = "latest") -> int:
         """`eth_getBalance`: Returns the balance of the account of given address."""
         block = hex(block_number) if isinstance(block_number, int) else block_number
@@ -378,3 +382,20 @@ def get_blobs(
             ),
             context=self.response_validation_context,
         )
+
+
+class NetRPC(BaseRPC):
+    """Represents a net RPC class for network-related RPC calls."""
+
+    def peer_count(self) -> int:
+        """`net_peerCount`: Get the number of peers connected to the client."""
+        response = self.post_request("peerCount")
+        return int(response, 16)  # hex -> int
+
+
+class AdminRPC(BaseRPC):
+    """Represents an admin RPC class for administrative RPC calls."""
+
+    def add_peer(self, enode: str) -> bool:
+        """`admin_addPeer`: Add a peer by enode URL."""
+        return self.post_request("addPeer", enode)

src/ethereum_test_specs/blockchain.py

@@ -33,6 +33,7 @@
 from ethereum_test_fixtures import (
     BaseFixture,
     BlockchainEngineFixture,
+    BlockchainEngineSyncFixture,
     BlockchainEngineXFixture,
     BlockchainFixture,
     FixtureFormat,
@@ -415,6 +416,7 @@ class BlockchainTest(BaseTest):
         BlockchainFixture,
         BlockchainEngineFixture,
         BlockchainEngineXFixture,
+        BlockchainEngineSyncFixture,
     ]
     supported_execute_formats: ClassVar[Sequence[LabeledExecuteFormat]] = [
         LabeledExecuteFormat(
@@ -427,6 +429,7 @@ class BlockchainTest(BaseTest):
     supported_markers: ClassVar[Dict[str, str]] = {
         "blockchain_test_engine_only": "Only generate a blockchain test engine fixture",
         "blockchain_test_only": "Only generate a blockchain test fixture",
+        "blockchain_engine_sync_test": "Generate a blockchain engine sync test fixture",
     }
 
     @classmethod
@@ -437,11 +440,18 @@ def discard_fixture_format_by_marks(
         markers: List[pytest.Mark],
     ) -> bool:
         """Discard a fixture format from filling if the appropriate marker is used."""
-        if "blockchain_test_only" in [m.name for m in markers]:
+        marker_names = [m.name for m in markers]
+
+        if "blockchain_test_only" in marker_names:
             return fixture_format != BlockchainFixture
-        if "blockchain_test_engine_only" in [m.name for m in markers]:
+        if "blockchain_test_engine_only" in marker_names:
             return fixture_format != BlockchainEngineFixture
-        return False
+        if "blockchain_engine_sync_test" in marker_names:
+            # Only generate sync fixture when marker is present
+            return fixture_format != BlockchainEngineSyncFixture
+        else:
+            # When sync marker is NOT present, exclude sync fixture
+            return fixture_format == BlockchainEngineSyncFixture
 
     def get_genesis_environment(self, fork: Fork) -> Environment:
         """Get the genesis environment for pre-allocation groups."""
@@ -710,7 +720,7 @@ def make_hive_fixture(
         t8n: TransitionTool,
         fork: Fork,
         fixture_format: FixtureFormat = BlockchainEngineFixture,
-    ) -> BlockchainEngineFixture | BlockchainEngineXFixture:
+    ) -> BlockchainEngineFixture | BlockchainEngineXFixture | BlockchainEngineSyncFixture:
         """Create a hive fixture from the blocktest definition."""
         fixture_payloads: List[FixtureEngineNewPayload] = []
 
@@ -755,15 +765,12 @@ def make_hive_fixture(
         self.verify_post_state(t8n, t8n_state=alloc)
 
         sync_payload: Optional[FixtureEngineNewPayload] = None
-        if self.verify_sync:
+        # Only include sync_payload for BlockchainEngineSyncFixture
+        if fixture_format == BlockchainEngineSyncFixture:
             # Test is marked for syncing verification.
-            assert genesis.header.block_hash != head_hash, (
-                "Invalid payload tests negative test via sync is not supported yet."
-            )
-
             # Most clients require the header to start the sync process, so we create an empty
-            # block on top of the last block of the test to send it as new payload and trigger the
-            # sync process.
+            # block on top of the last block of the test to send it as new payload and trigger
+            # the sync process.
             sync_built_block = self.generate_block_data(
                 t8n=t8n,
                 fork=fork,
@@ -802,6 +809,17 @@ def make_hive_fixture(
                 }
             )
             return BlockchainEngineXFixture(**fixture_data)
+        elif fixture_format == BlockchainEngineSyncFixture:
+            # For sync fixture format
+            fixture_data.update(
+                {
+                    "payloads": fixture_payloads,
+                    "sync_payload": sync_payload,
+                    "pre": pre,
+                    "post_state": alloc if not self.exclude_full_post_state_in_output else None,
+                }
+            )
+            return BlockchainEngineSyncFixture(**fixture_data)
         else:
             # Standard engine fixture
             fixture_data.update(
@@ -822,7 +840,11 @@ def generate(
     ) -> BaseFixture:
         """Generate the BlockchainTest fixture."""
         t8n.reset_traces()
-        if fixture_format in [BlockchainEngineFixture, BlockchainEngineXFixture]:
+        if fixture_format in [
+            BlockchainEngineFixture,
+            BlockchainEngineXFixture,
+            BlockchainEngineSyncFixture,
+        ]:
             return self.make_hive_fixture(t8n, fork, fixture_format)
         elif fixture_format == BlockchainFixture:
             return self.make_fixture(t8n, fork)

src/pytest_plugins/consume/simulators/base.py

@@ -29,6 +29,8 @@ def check_live_port(test_suite_name: str) -> Literal[8545, 8551]:
         return 8545
     elif test_suite_name == "eest/consume-engine":
         return 8551
+    elif test_suite_name == "eest/consume-sync":
+        return 8551
     raise ValueError(
         f"Unexpected test suite name '{test_suite_name}' while setting HIVE_CHECK_LIVE_PORT."
     )