refactor(exceptions,specs): Support general block exceptions - Pydantic context to parse using mapper (#1396)

* feat(clis,exceptions,specs): Pydantic validation using exception mapper

* fix(specs): Skip block exception check on requests modifications

* fix(docs): Links

* fix(tests): EIP-4844: mark block as skip block exception verification

* refactor(exceptions): Mapper mappings allow regex, convert from `property` to `ClassVar`

* fix(docs): tox

* chore(deps): remove now unused bdict dependency

* Suggestions for #1396, refactor(exceptions,specs): Support general block exceptions - Pydantic context to parse using mapper (#1404)

* refactor(fw): use enum helper; rename `ty` to `execution_context`

* refactor(fw): use more specific names for exception classes

* fix(tests): Add comment explaining `skip_exception_verification`

* feat(clis): Add `reliable` flag to exception mapper class

* fix: tests

* fix(specs,clis,tools): Use `default_t8n` and remove `run_in_serial` from most unit tests

* fix(specs): Bug and variable names

* fix: bug

* feat(clis/evmone): Add insufficient-blob-fee error

* fix(tests): Allow similar blob exceptions

* Apply suggestions from code review

Co-authored-by: danceratopz <[email protected]>

---------

Co-authored-by: danceratopz <[email protected]>

Author: marioevz

docs/consuming_tests/blockchain_test.md

@@ -216,7 +216,7 @@ Optional list of withdrawals included in the block RLP.
 
 ### `InvalidFixtureBlock`
 
-#### - `expectException`: [`TransactionException`](./exceptions.md#transactionexception)` | `[`BlockException`](./exceptions.md#blockexception)
+#### - `expectException`: [`TransactionException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.TransactionException)` | `[`BlockException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.BlockException)
 
 Expected exception that invalidates the block.
 

docs/consuming_tests/blockchain_test_engine.md

@@ -104,7 +104,7 @@ They can mismatch the hashes of the versioned blobs in the execution payload, fo
 
 Hash of the parent beacon block root.
 
-#### - `validationError`: [`TransactionException`](./exceptions.md#transactionexception)` | `[`BlockException`](./exceptions.md#blockexception)
+#### - `validationError`: [`TransactionException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.TransactionException)` | `[`BlockException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.BlockException)
 
 Validation error expected when executing the payload.
 

docs/consuming_tests/exceptions.md

@@ -13,14 +13,4 @@ The JSON string can contain multiple exception types, separated by the `|`
 character, denoting that the transaction or block can throw either one of
 the exceptions.
 
-## `TransactionException`
-
-::: ethereum_test_exceptions.TransactionException
-
-## `BlockException`
-
-::: ethereum_test_exceptions.BlockException
-
-## `EOFException`
-
-::: ethereum_test_exceptions.EOFException
+For a list of all defined exceptions look at [Ethereum Test Exceptions Package](../library/ethereum_test_exceptions.md).

docs/consuming_tests/state_test.md

@@ -179,7 +179,7 @@ Expected state root value that results of applying the transaction to the pre-st
 Hash of the RLP representation of the state logs result of applying the transaction to the pre-state
 (TODO: double-check this.)
 
-#### - `expectException`: [`TransactionException`](./exceptions.md#transactionexception)
+#### - `expectException`: [`TransactionException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.TransactionException)
 
 Exception that is expected to be thrown by the transaction execution (Field is missing if the transaction is expected to succeed)
 

docs/consuming_tests/transaction_test.md

@@ -62,6 +62,6 @@ Total intrinsic gas cost of the transaction (Field is missing if the transaction
 
 Sender address of the transaction (Field is missing if the transaction is expected to fail).
 
-#### - `exception`: [`TransactionException`](./exceptions.md#transactionexception)
+#### - `exception`: [`TransactionException`](../library/ethereum_test_exceptions.md#ethereum_test_exceptions.TransactionException)
 
 Exception that is expected to be thrown by the transaction parsing (Field is missing if the transaction is expected to succeed).

pyproject.toml

@@ -25,7 +25,6 @@ dependencies = [
     "gitpython>=3.1.31,<4",
     "PyJWT>=2.3.0,<3",
     "tenacity>8.2.0,<9",
-    "bidict>=0.23,<1",
     "requests>=2.31.0,<3",
     "requests_unixsocket2>=0.4.0",
     "colorlog>=6.7.0,<7",

src/conftest.py

@@ -1,13 +1,36 @@
 """Local pytest configuration for framework tests."""
 
 import os
+from typing import Generator
 
 import pytest
 
+from ethereum_clis import ExecutionSpecsTransitionTool, TransitionTool
+
 
 def pytest_runtest_setup(item):
     """Skip tests if running with pytest-xdist in parallel."""
     marker = item.get_closest_marker(name="run_in_serial")
     if marker is not None:
         if os.getenv("PYTEST_XDIST_WORKER_COUNT") not in [None, "1"]:
             pytest.skip("Skipping test because pytest-xdist is running with more than one worker.")
+
+
+DEFAULT_T8N_FOR_UNIT_TESTS = ExecutionSpecsTransitionTool
+
+
+@pytest.fixture(scope="session")
+def default_t8n_instance() -> Generator[TransitionTool, None, None]:
+    """Fixture to provide a default t8n instance."""
+    instance = ExecutionSpecsTransitionTool()
+    instance.start_server()
+    yield instance
+    instance.shutdown()
+
+
+@pytest.fixture
+def default_t8n(
+    default_t8n_instance: TransitionTool,
+) -> TransitionTool:
+    """Fixture to provide a default t8n instance."""
+    return default_t8n_instance

src/ethereum_clis/clis/besu.py

@@ -7,15 +7,15 @@
 import tempfile
 import textwrap
 from pathlib import Path
-from typing import List, Optional
+from typing import ClassVar, Dict, List, Optional
 
 import requests
 
 from ethereum_test_base_types import BlobSchedule
 from ethereum_test_exceptions import (
     EOFException,
+    ExceptionBase,
     ExceptionMapper,
-    ExceptionMessage,
     TransactionException,
 )
 from ethereum_test_forks import Fork
@@ -163,7 +163,9 @@ def evaluate(
 
         response = requests.post(self.server_url, json=post_data, timeout=5)
         response.raise_for_status()  # exception visible in pytest failure output
-        output: TransitionToolOutput = TransitionToolOutput.model_validate(response.json())
+        output: TransitionToolOutput = TransitionToolOutput.model_validate(
+            response.json(), context={"exception_mapper": self.exception_mapper}
+        )
 
         if debug_output_path:
             dump_files_to_directory(
@@ -209,138 +211,76 @@ def is_fork_supported(self, fork: Fork) -> bool:
 class BesuExceptionMapper(ExceptionMapper):
     """Translate between EEST exceptions and error strings returned by Besu."""
 
-    @property
-    def _mapping_data(self):
-        return [
-            ExceptionMessage(
-                TransactionException.TYPE_4_TX_CONTRACT_CREATION,
-                "transaction code delegation transactions must have a non-empty code "
-                "delegation list",
-            ),
-            ExceptionMessage(
-                TransactionException.INSUFFICIENT_ACCOUNT_FUNDS,
-                "exceeds transaction sender account balance",
-            ),
-            ExceptionMessage(
-                TransactionException.TYPE_3_TX_MAX_BLOB_GAS_ALLOWANCE_EXCEEDED,
-                "would exceed block maximum",
-            ),
-            ExceptionMessage(
-                TransactionException.INSUFFICIENT_MAX_FEE_PER_BLOB_GAS,
-                "max fee per blob gas less than block blob gas fee",
-            ),
-            ExceptionMessage(
-                TransactionException.INSUFFICIENT_MAX_FEE_PER_GAS,
-                "gasPrice is less than the current BaseFee",
-            ),
-            ExceptionMessage(
-                TransactionException.TYPE_3_TX_PRE_FORK,
-                (
-                    "Transaction type BLOB is invalid, accepted transaction types are "
-                    "[EIP1559, ACCESS_LIST, FRONTIER]"
-                ),
-            ),
-            ExceptionMessage(
-                TransactionException.TYPE_3_TX_INVALID_BLOB_VERSIONED_HASH,
-                "Only supported hash version is 0x01, sha256 hash.",
-            ),
-            # This message is the same as TYPE_3_TX_MAX_BLOB_GAS_ALLOWANCE_EXCEEDED
-            ExceptionMessage(
-                TransactionException.TYPE_3_TX_BLOB_COUNT_EXCEEDED,
-                "exceed block maximum",
-            ),
-            ExceptionMessage(
-                TransactionException.TYPE_3_TX_ZERO_BLOBS,
-                "Blob transaction must have at least one versioned hash",
-            ),
-            ExceptionMessage(
-                TransactionException.INTRINSIC_GAS_TOO_LOW,
-                "intrinsic gas",
-            ),
-            ExceptionMessage(
-                TransactionException.INITCODE_SIZE_EXCEEDED,
-                "exceeds maximum size",
-            ),
-            ExceptionMessage(
-                TransactionException.NONCE_MISMATCH_TOO_LOW,
-                "below sender account nonce",
-            ),
-            # TODO EVMONE needs to differentiate when the section is missing in the header or body
-            ExceptionMessage(EOFException.MISSING_STOP_OPCODE, "err: no_terminating_instruction"),
-            ExceptionMessage(EOFException.MISSING_CODE_HEADER, "err: code_section_missing"),
-            ExceptionMessage(EOFException.MISSING_TYPE_HEADER, "err: type_section_missing"),
-            # TODO EVMONE these exceptions are too similar, this leeds to ambiguity
-            ExceptionMessage(EOFException.MISSING_TERMINATOR, "err: header_terminator_missing"),
-            ExceptionMessage(
-                EOFException.MISSING_HEADERS_TERMINATOR, "err: section_headers_not_terminated"
-            ),
-            ExceptionMessage(EOFException.INVALID_VERSION, "err: eof_version_unknown"),
-            ExceptionMessage(
-                EOFException.INVALID_NON_RETURNING_FLAG, "err: invalid_non_returning_flag"
-            ),
-            ExceptionMessage(EOFException.INVALID_MAGIC, "err: invalid_prefix"),
-            ExceptionMessage(
-                EOFException.INVALID_FIRST_SECTION_TYPE, "err: invalid_first_section_type"
-            ),
-            ExceptionMessage(
-                EOFException.INVALID_SECTION_BODIES_SIZE, "err: invalid_section_bodies_size"
-            ),
-            ExceptionMessage(
-                EOFException.INVALID_TYPE_SECTION_SIZE, "err: invalid_type_section_size"
-            ),
-            ExceptionMessage(EOFException.INCOMPLETE_SECTION_SIZE, "err: incomplete_section_size"),
-            ExceptionMessage(
-                EOFException.INCOMPLETE_SECTION_NUMBER, "err: incomplete_section_number"
-            ),
-            ExceptionMessage(EOFException.TOO_MANY_CODE_SECTIONS, "err: too_many_code_sections"),
-            ExceptionMessage(EOFException.ZERO_SECTION_SIZE, "err: zero_section_size"),
-            ExceptionMessage(EOFException.MISSING_DATA_SECTION, "err: data_section_missing"),
-            ExceptionMessage(EOFException.UNDEFINED_INSTRUCTION, "err: undefined_instruction"),
-            ExceptionMessage(
-                EOFException.INPUTS_OUTPUTS_NUM_ABOVE_LIMIT, "err: inputs_outputs_num_above_limit"
-            ),
-            ExceptionMessage(
-                EOFException.UNREACHABLE_INSTRUCTIONS, "err: unreachable_instructions"
-            ),
-            ExceptionMessage(
-                EOFException.INVALID_RJUMP_DESTINATION, "err: invalid_rjump_destination"
-            ),
-            ExceptionMessage(
-                EOFException.UNREACHABLE_CODE_SECTIONS, "err: unreachable_code_sections"
-            ),
-            ExceptionMessage(EOFException.STACK_UNDERFLOW, "err: stack_underflow"),
-            ExceptionMessage(
-                EOFException.MAX_STACK_HEIGHT_ABOVE_LIMIT, "err: max_stack_height_above_limit"
-            ),
-            ExceptionMessage(
-                EOFException.STACK_HIGHER_THAN_OUTPUTS, "err: stack_higher_than_outputs_required"
-            ),
-            ExceptionMessage(
-                EOFException.JUMPF_DESTINATION_INCOMPATIBLE_OUTPUTS,
-                "err: jumpf_destination_incompatible_outputs",
-            ),
-            ExceptionMessage(
-                EOFException.INVALID_MAX_STACK_HEIGHT, "err: invalid_max_stack_height"
-            ),
-            ExceptionMessage(EOFException.INVALID_DATALOADN_INDEX, "err: invalid_dataloadn_index"),
-            ExceptionMessage(EOFException.TRUNCATED_INSTRUCTION, "err: truncated_instruction"),
-            ExceptionMessage(
-                EOFException.TOPLEVEL_CONTAINER_TRUNCATED, "err: toplevel_container_truncated"
-            ),
-            ExceptionMessage(EOFException.ORPHAN_SUBCONTAINER, "err: unreferenced_subcontainer"),
-            ExceptionMessage(
-                EOFException.CONTAINER_SIZE_ABOVE_LIMIT, "err: container_size_above_limit"
-            ),
-            ExceptionMessage(
-                EOFException.INVALID_CONTAINER_SECTION_INDEX,
-                "err: invalid_container_section_index",
-            ),
-            ExceptionMessage(
-                EOFException.INCOMPATIBLE_CONTAINER_KIND, "err: incompatible_container_kind"
-            ),
-            ExceptionMessage(EOFException.STACK_HEIGHT_MISMATCH, "err: stack_height_mismatch"),
-            ExceptionMessage(EOFException.TOO_MANY_CONTAINERS, "err: too_many_container_sections"),
-            ExceptionMessage(
-                EOFException.INVALID_CODE_SECTION_INDEX, "err: invalid_code_section_index"
-            ),
-        ]
+    mapping_substring: ClassVar[Dict[ExceptionBase, str]] = {
+        TransactionException.TYPE_4_TX_CONTRACT_CREATION: (
+            "transaction code delegation transactions must have a non-empty code delegation list"
+        ),
+        TransactionException.INSUFFICIENT_ACCOUNT_FUNDS: (
+            "exceeds transaction sender account balance"
+        ),
+        TransactionException.TYPE_3_TX_MAX_BLOB_GAS_ALLOWANCE_EXCEEDED: (
+            "would exceed block maximum"
+        ),
+        TransactionException.INSUFFICIENT_MAX_FEE_PER_BLOB_GAS: (
+            "max fee per blob gas less than block blob gas fee"
+        ),
+        TransactionException.INSUFFICIENT_MAX_FEE_PER_GAS: (
+            "gasPrice is less than the current BaseFee"
+        ),
+        TransactionException.TYPE_3_TX_PRE_FORK: (
+            "Transaction type BLOB is invalid, accepted transaction types are "
+            "[EIP1559, ACCESS_LIST, FRONTIER]"
+        ),
+        TransactionException.TYPE_3_TX_INVALID_BLOB_VERSIONED_HASH: (
+            "Only supported hash version is 0x01, sha256 hash."
+        ),
+        # This message is the same as TYPE_3_TX_MAX_BLOB_GAS_ALLOWANCE_EXCEEDED
+        TransactionException.TYPE_3_TX_BLOB_COUNT_EXCEEDED: "exceed block maximum",
+        TransactionException.TYPE_3_TX_ZERO_BLOBS: (
+            "Blob transaction must have at least one versioned hash"
+        ),
+        TransactionException.INTRINSIC_GAS_TOO_LOW: "intrinsic gas",
+        TransactionException.INITCODE_SIZE_EXCEEDED: "exceeds maximum size",
+        TransactionException.NONCE_MISMATCH_TOO_LOW: "below sender account nonce",
+        # TODO EVMONE needs to differentiate when the section is missing in the header or body
+        EOFException.MISSING_STOP_OPCODE: "err: no_terminating_instruction",
+        EOFException.MISSING_CODE_HEADER: "err: code_section_missing",
+        EOFException.MISSING_TYPE_HEADER: "err: type_section_missing",
+        # TODO EVMONE these exceptions are too similar, this leeds to ambiguity
+        EOFException.MISSING_TERMINATOR: "err: header_terminator_missing",
+        EOFException.MISSING_HEADERS_TERMINATOR: "err: section_headers_not_terminated",
+        EOFException.INVALID_VERSION: "err: eof_version_unknown",
+        EOFException.INVALID_NON_RETURNING_FLAG: "err: invalid_non_returning_flag",
+        EOFException.INVALID_MAGIC: "err: invalid_prefix",
+        EOFException.INVALID_FIRST_SECTION_TYPE: "err: invalid_first_section_type",
+        EOFException.INVALID_SECTION_BODIES_SIZE: "err: invalid_section_bodies_size",
+        EOFException.INVALID_TYPE_SECTION_SIZE: "err: invalid_type_section_size",
+        EOFException.INCOMPLETE_SECTION_SIZE: "err: incomplete_section_size",
+        EOFException.INCOMPLETE_SECTION_NUMBER: "err: incomplete_section_number",
+        EOFException.TOO_MANY_CODE_SECTIONS: "err: too_many_code_sections",
+        EOFException.ZERO_SECTION_SIZE: "err: zero_section_size",
+        EOFException.MISSING_DATA_SECTION: "err: data_section_missing",
+        EOFException.UNDEFINED_INSTRUCTION: "err: undefined_instruction",
+        EOFException.INPUTS_OUTPUTS_NUM_ABOVE_LIMIT: "err: inputs_outputs_num_above_limit",
+        EOFException.UNREACHABLE_INSTRUCTIONS: "err: unreachable_instructions",
+        EOFException.INVALID_RJUMP_DESTINATION: "err: invalid_rjump_destination",
+        EOFException.UNREACHABLE_CODE_SECTIONS: "err: unreachable_code_sections",
+        EOFException.STACK_UNDERFLOW: "err: stack_underflow",
+        EOFException.MAX_STACK_HEIGHT_ABOVE_LIMIT: "err: max_stack_height_above_limit",
+        EOFException.STACK_HIGHER_THAN_OUTPUTS: "err: stack_higher_than_outputs_required",
+        EOFException.JUMPF_DESTINATION_INCOMPATIBLE_OUTPUTS: (
+            "err: jumpf_destination_incompatible_outputs"
+        ),
+        EOFException.INVALID_MAX_STACK_HEIGHT: "err: invalid_max_stack_height",
+        EOFException.INVALID_DATALOADN_INDEX: "err: invalid_dataloadn_index",
+        EOFException.TRUNCATED_INSTRUCTION: "err: truncated_instruction",
+        EOFException.TOPLEVEL_CONTAINER_TRUNCATED: "err: toplevel_container_truncated",
+        EOFException.ORPHAN_SUBCONTAINER: "err: unreferenced_subcontainer",
+        EOFException.CONTAINER_SIZE_ABOVE_LIMIT: "err: container_size_above_limit",
+        EOFException.INVALID_CONTAINER_SECTION_INDEX: "err: invalid_container_section_index",
+        EOFException.INCOMPATIBLE_CONTAINER_KIND: "err: incompatible_container_kind",
+        EOFException.STACK_HEIGHT_MISMATCH: "err: stack_height_mismatch",
+        EOFException.TOO_MANY_CONTAINERS: "err: too_many_container_sections",
+        EOFException.INVALID_CODE_SECTION_INDEX: "err: invalid_code_section_index",
+    }
+    mapping_regex: ClassVar[Dict[ExceptionBase, str]] = {}