Merge pull request #12 from marioevz/eips-support-debugging

Transition Tool EIPs Support, Print Traces, Helper Methods

Author: lightclient

src/ethereum_test_filling_tool/main.py

@@ -68,6 +68,13 @@ def parse_arguments() -> argparse.Namespace:
             help="limit to filling only tests with matching name",
         )
 
+        parser.add_argument(
+            "--traces",
+            action="store_true",
+            help="collect traces of the execution information from the "
+            + "transition tool",
+        )
+
         return parser.parse_args()
 
     options: argparse.Namespace
@@ -115,7 +122,9 @@ def fill(self) -> None:
 
         os.makedirs(self.options.output, exist_ok=True)
 
-        t8n = EvmTransitionTool(binary=self.options.evm_bin)
+        t8n = EvmTransitionTool(
+            binary=self.options.evm_bin, trace=self.options.traces
+        )
         b11r = EvmBlockBuilder(binary=self.options.evm_bin)
 
         for filler in fillers:

src/ethereum_test_tools/__init__.py

@@ -7,6 +7,7 @@
 from .common import (
     Account,
     Block,
+    CodeGasMeasure,
     Environment,
     JSONEncoder,
     TestAddress,
@@ -23,6 +24,7 @@
     "Block",
     "BlockchainTest",
     "Code",
+    "CodeGasMeasure",
     "Environment",
     "JSONEncoder",
     "StateTest",

src/ethereum_test_tools/code/code.py

@@ -6,7 +6,7 @@
 from typing import Union
 
 
-class Code(str):
+class Code(object):
     """
     Generic code object.
     """

src/ethereum_test_tools/common/__init__.py

@@ -8,7 +8,7 @@
     TestAddress,
     TestPrivateKey,
 )
-from .helpers import to_address, to_hash
+from .helpers import CodeGasMeasure, to_address, to_hash
 from .types import (
     Account,
     Block,
@@ -29,6 +29,7 @@
     "AddrAA",
     "AddrBB",
     "Block",
+    "CodeGasMeasure",
     "EmptyTrieRoot",
     "Environment",
     "Fixture",

src/ethereum_test_tools/common/helpers.py

@@ -1,7 +1,11 @@
 """
-Helper functions for generating Ethereum tests.
+Helper functions/classes used to generate Ethereum tests.
 """
 
+from dataclasses import dataclass
+
+from ..code import Code, code_to_bytes
+
 
 def to_address(input: int | str) -> str:
     """
@@ -25,3 +29,75 @@ def to_hash(input: int | str) -> str:
     if type(input) is int:
         return "0x" + input.to_bytes(32, "big").hex()
     raise Exception("invalid type to convert to hash")
+
+
+@dataclass(kw_only=True)
+class CodeGasMeasure(Code):
+    """
+    Helper class used to generate bytecode that measures gas usage of a
+    bytecode, taking into account and subtracting any extra overhead gas costs
+    required to execute.
+    By default, the result gas calculation is saved to storage key 0.
+    """
+
+    code: bytes | str | Code
+    """
+    Bytecode to be executed to measure the gas usage.
+    """
+    overhead_cost: int = 0
+    """
+    Extra gas cost to be subtracted from extra operations.
+    """
+    extra_stack_items: int = 0
+    """
+    Extra stack items that remain at the end of the execution.
+    To be considered when subtracting the value of the previous GAS operation,
+    and to be popped at the end of the execution.
+    """
+    sstore_key: int = 0
+    """
+    Storage key to save the gas used.
+    """
+
+    def assemble(self) -> bytes:
+        """
+        Assemble the bytecode that measures gas usage.
+        """
+        res = bytes()
+        res += bytes(
+            [
+                0x5A,  # GAS
+            ]
+        )
+        res += code_to_bytes(self.code)  # Execute code to measure its gas cost
+        res += bytes(
+            [
+                0x5A,  # GAS
+            ]
+        )
+        # We need to swap and pop for each extra stack item that remained from
+        # the execution of the code
+        res += (
+            bytes(
+                [
+                    0x90,  # SWAP1
+                    0x50,  # POP
+                ]
+            )
+            * self.extra_stack_items
+        )
+        res += bytes(
+            [
+                0x90,  # SWAP1
+                0x03,  # SUB
+                0x60,  # PUSH1
+                self.overhead_cost + 2,  # Overhead cost + GAS opcode price
+                0x90,  # SWAP1
+                0x03,  # SUB
+                0x60,  # PUSH1
+                self.sstore_key,  # -> SSTORE key
+                0x55,  # SSTORE
+                0x00,  # STOP
+            ]
+        )
+        return res