wip(fw): add the witness to fixture from t8n output result.

Author: spencer-tb

src/ethereum_test_base_types/pydantic.py

@@ -1,6 +1,7 @@
 """
 Base pydantic classes used to define the models for Ethereum tests.
 """
+
 from typing import TypeVar
 
 from pydantic import BaseModel, ConfigDict

src/ethereum_test_fixtures/blockchain.py

@@ -40,6 +40,7 @@
     WithdrawalRequest,
     WithdrawalRequestGeneric,
 )
+from ethereum_test_types.verkle import Witness
 
 from .base import BaseFixture
 from .formats import FixtureFormats
@@ -412,6 +413,19 @@ def from_consolidation_request(
         return cls(**d.model_dump())
 
 
+class FixtureWitness(Witness):
+    """
+    Structure to represent a single verkle block witness.
+    """
+
+    @classmethod
+    def from_witness(cls, w: Witness) -> "FixtureWitness":
+        """
+        Returns a FixtureWitness from a Witness.
+        """
+        return cls(**w.model_dump(exclude_none=False))
+
+
 class FixtureBlockBase(CamelModel):
     """Representation of an Ethereum block within a test Fixture without RLP bytes."""
 
@@ -423,6 +437,8 @@ class FixtureBlockBase(CamelModel):
     withdrawal_requests: List[FixtureWithdrawalRequest] | None = None
     consolidation_requests: List[FixtureConsolidationRequest] | None = None
 
+    witness: FixtureWitness | None = None
+
     @computed_field(alias="blocknumber")  # type: ignore[misc]
     @cached_property
     def block_number(self) -> Number:

src/ethereum_test_specs/blockchain.py

@@ -33,6 +33,7 @@
     FixtureTransaction,
     FixtureWithdrawal,
     FixtureWithdrawalRequest,
+    FixtureWitness,
     InvalidFixtureBlock,
 )
 from ethereum_test_forks import EIP6800Transition, Fork, Verkle
@@ -47,7 +48,7 @@
     Withdrawal,
     WithdrawalRequest,
 )
-from ethereum_test_types.verkle import VerkleTree
+from ethereum_test_types.verkle import VerkleTree, Witness
 from evm_transition_tool import TransitionTool
 
 from .base import BaseTest, verify_result, verify_transactions
@@ -411,6 +412,7 @@ def generate_block_data(
         Alloc,
         Optional[Requests],
         Optional[VerkleTree],
+        Optional[Witness],
     ]:
         """
         Generate common block data for both make_fixture and make_hive_fixture.
@@ -453,13 +455,17 @@ def generate_block_data(
         try:
             rejected_txs = verify_transactions(txs, transition_tool_output.result)
             verify_result(transition_tool_output.result, env)
+            # TODO: add verify witness (against vkt)
+            # verify_witness(transition_tool_output.witness, transition_tool_output.vkt)
         except Exception as e:
             print_traces(t8n.get_traces())
             pprint(transition_tool_output.result)
             pprint(previous_alloc)
             pprint(transition_tool_output.alloc)
             if transition_tool_output.vkt is not None:
                 pprint(transition_tool_output.vkt)
+            if transition_tool_output.witness is not None:
+                pprint(transition_tool_output.witness)
             raise e
 
         if len(rejected_txs) > 0 and block.exception is None:
@@ -532,6 +538,11 @@ def generate_block_data(
                 )
             )
             transition_tool_output.alloc = previous_alloc
+            # TODO: hack for now
+            transition_tool_output.witness = Witness(
+                verkle_proof=transition_tool_output.result.verkle_proof,
+                state_diff=transition_tool_output.result.state_diff,
+            )
 
         return (
             env,
@@ -540,6 +551,7 @@ def generate_block_data(
             transition_tool_output.alloc,
             requests,
             transition_tool_output.vkt,
+            transition_tool_output.witness,
         )
 
     def network_info(self, fork: Fork, eips: Optional[List[int]] = None):
@@ -616,14 +628,16 @@ def make_fixture(
                 # This is the most common case, the RLP needs to be constructed
                 # based on the transactions to be included in the block.
                 # Set the environment according to the block to execute.
-                new_env, header, txs, new_alloc, requests, new_vkt = self.generate_block_data(
-                    t8n=t8n,
-                    fork=fork,
-                    block=block,
-                    previous_env=env,
-                    previous_alloc=alloc,
-                    previous_vkt=vkt,
-                    eips=eips,
+                new_env, header, txs, new_alloc, requests, new_vkt, witness = (
+                    self.generate_block_data(
+                        t8n=t8n,
+                        fork=fork,
+                        block=block,
+                        previous_env=env,
+                        previous_alloc=alloc,
+                        previous_vkt=vkt,
+                        eips=eips,
+                    )
                 )
                 fixture_block = FixtureBlockBase(
                     header=header,
@@ -658,6 +672,7 @@ def make_fixture(
                         if requests is not None
                         else None
                     ),
+                    witness=FixtureWitness.from_witness(witness) if witness is not None else None,
                 ).with_rlp(txs=txs, requests=requests)
                 if block.exception is None:
                     fixture_blocks.append(fixture_block)
@@ -731,7 +746,8 @@ def make_hive_fixture(
             self.blocks.append(Block())
 
         for block in self.blocks:
-            new_env, header, txs, new_alloc, requests, new_vkt = self.generate_block_data(
+            # TODO: fix witness for hive fixture? Do we need it?
+            new_env, header, txs, new_alloc, requests, new_vkt, _ = self.generate_block_data(
                 t8n=t8n,
                 fork=fork,
                 block=block,
@@ -775,7 +791,7 @@ def make_hive_fixture(
             # 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.
-            _, sync_header, _, _, requests, _ = self.generate_block_data(
+            _, sync_header, _, _, requests, _, _ = self.generate_block_data(
                 t8n=t8n,
                 fork=fork,
                 block=Block(),

src/ethereum_test_types/verkle/types.py

@@ -74,8 +74,8 @@ class SuffixStateDiff(CamelModel):
     """
 
     suffix: int
-    current_value: Hash | None = Field(None)
-    new_value: Hash | None = Field(None)
+    current_value: Hash | None = Field(default_factory=None)
+    new_value: Hash | None = Field(default_factory=None)
 
 
 class StemStateDiff(CamelModel):
@@ -119,9 +119,9 @@ class Witness(CamelModel):
     hash of the state tree before the current block execution.
     """
 
-    state_diff: StateDiff = Field(..., alias="Diff")
-    verkle_proof: VerkleProof | None = Field(None, alias="Proof")
-    parent_state_root: Hash
+    state_diff: StateDiff
+    verkle_proof: VerkleProof
+    # parent_state_root: Hash
 
 
 class VerkleTree(RootModel[Dict[Hash, Hash]]):

src/evm_transition_tool/transition_tool.py

@@ -311,8 +311,16 @@ def _evaluate_filesystem(
 
         # TODO: Verkle specific logic, update when Verkle fork is confirmed.
         if t8n_data.fork_name == "Verkle":
-            output_paths["vkt"] = os.path.join("output", "vkt.json")
-            args.extend(["--output.vkt", output_paths["vkt"]])
+            output_paths.update(
+                {
+                    "vkt": os.path.join("output", "vkt.json"),
+                    "witness": os.path.join("output", "witness.json"),
+                }
+            )
+            args.extend(
+                ["--output.vkt", output_paths["vkt"], "--output.witness", output_paths["witness"]]
+            )
+            print(output_paths)
             if t8n_data.vkt is not None:
                 args.extend(["--input.vkt", input_paths["vkt"]])
 
@@ -371,6 +379,7 @@ def _evaluate_filesystem(
             with open(file_path, "r+") as file:
                 output_contents[key] = json.load(file)
         output = TransitionToolOutput(**output_contents)
+        print(output)
         if self.trace:
             self.collect_traces(output.result.receipts, temp_dir, debug_output_path)
 

src/evm_transition_tool/types.py

@@ -15,7 +15,7 @@
     Transaction,
     WithdrawalRequest,
 )
-from ethereum_test_types.verkle import VerkleTree
+from ethereum_test_types.verkle import StateDiff, VerkleProof, VerkleTree, Witness
 
 
 class TransactionLog(CamelModel):
@@ -99,6 +99,9 @@ class Result(CamelModel):
         alias="currentConversionStorageProcessed",
     )
 
+    verkle_proof: VerkleProof | None = None
+    state_diff: StateDiff | None = None
+
 
 class TransitionToolInput(CamelModel):
     """
@@ -120,3 +123,4 @@ class TransitionToolOutput(CamelModel):
     result: Result
     body: Bytes | None = None
     vkt: VerkleTree | None = None
+    witness: Witness | None = None