address issues, refactor the code (WIP)

Author: winsvega

src/entry_points/gentest.py

@@ -6,11 +6,11 @@
 import os
 import sys
 from dataclasses import asdict, dataclass
-from typing import Dict, List, Union
+from typing import Dict, List
 
 import requests
 
-from ethereum_test_tools import Account, Address, Transaction
+from ethereum_test_tools import Account, Address, Transaction, common
 
 
 def main():  # noqa: D103
@@ -45,74 +45,131 @@ def make_test(args):  # noqa: D103
     print("Perform debug_trace_call")
     state = request.debug_trace_call(tr)
 
+    print("Perform eth_get_block_by_number")
+    block = request.eth_get_block_by_number(tr.block_number)
+
     print("Generate py test >> " + output_file)
-    test = make_test_template(tr, state)
+    constructor = TestConstructor(PYTEST_TEMPLATE)
+    test = constructor.make_test_template(block, tr, state)
     with open(output_file, "w") as file:
         file.write(test)
 
-    print(test)
+    print("Finished")
 
 
-def make_test_template(
-    tr: "RequestManager.RemoteTransaction", state: Dict[Address, Account]
-) -> str:
+class TestConstructor:
     """
-    Prepare the .py file template
+    Construct .py file from test template, by replacing keywords with test data
     """
-    test = PYTEST_TEMPLATE
-    test = test.replace(
-        "$HEADLINE_COMMENT",
-        "gentest autogenerated test with debug_traceCall of tx.hash " + tr.tr_hash,
-    )
-    test = test.replace("$TEST_NAME", "test_transaction_" + tr.tr_hash[2:])
-    test = test.replace(
-        "$TEST_COMMENT", "gentest autogenerated test for tx.hash " + tr.tr_hash[2:]
-    )
 
-    # Print a nice .py storage pre
-    pad = "            "
-    state_str = ""
-    for address, account in state.items():
-        if isinstance(account, dict):
-            account_obj = Account(**account)
-            state_str += '        "' + str(address) + '": Account(\n'
-            state_str += pad + "balance=" + str(account_obj.balance) + ",\n"
-            if address == tr.transaction.sender:
-                state_str += pad + "nonce=" + str(tr.transaction.nonce) + ",\n"
-            else:
-                state_str += pad + "nonce=" + str(account_obj.nonce) + ",\n"
+    test_template: str
 
-            if account_obj.code is None:
-                state_str += pad + 'code="0x",\n'
-            else:
-                state_str += pad + 'code="' + str(account_obj.code) + '",\n'
-            state_str += pad + "storage={\n"
-
-            if account_obj.storage is not None:
-                for record, value in account_obj.storage.items():
-                    state_str += pad + '    "' + str(record) + '" : "' + str(value) + '",\n'
-
-            state_str += pad + "}\n"
-            state_str += "        ),\n"
-    test = test.replace("$PRE", state_str)
-
-    # Print legacy transaction in .py
-    tr_str = ""
-    tr_str += pad + "ty=" + str(tr.transaction.ty) + ",\n"
-    tr_str += pad + "chain_id=" + str(tr.transaction.chain_id) + ",\n"
-    tr_str += pad + "nonce=" + str(tr.transaction.nonce) + ",\n"
-    tr_str += pad + 'to="' + str(tr.transaction.to) + '",\n'
-    tr_str += pad + "gas_price=" + str(tr.transaction.gas_price) + ",\n"
-    tr_str += pad + "protected=False,\n"
-    tr_str += pad + 'data="' + str(tr.transaction.data) + '",\n'
-    tr_str += pad + "gas_limit=" + str(tr.transaction.gas_limit) + ",\n"
-    tr_str += pad + "value=" + str(tr.transaction.value) + ",\n"
-    tr_str += pad + "v=" + str(tr.transaction.v) + ",\n"
-    tr_str += pad + "r=" + str(tr.transaction.r) + ",\n"
-    tr_str += pad + "s=" + str(tr.transaction.s) + ",\n"
-
-    test = test.replace("$TR", tr_str)
-    return test
+    def __init__(self, test_template: str):
+        """
+        Initialize with template
+        """
+        self.test_template = test_template
+
+    def _make_test_comments(self, test: str, tr_hash: str) -> str:
+        test = test.replace(
+            "$HEADLINE_COMMENT",
+            "gentest autogenerated test with debug_traceCall of tx.hash " + tr_hash,
+        )
+        test = test.replace("$TEST_NAME", "test_transaction_" + tr_hash[2:])
+        test = test.replace(
+            "$TEST_COMMENT", "gentest autogenerated test for tx.hash " + tr_hash[2:]
+        )
+        return test
+
+    def _make_test_environment(self, test: str, bl: "RequestManager.RemoteBlock") -> str:
+        env_str = ""
+        pad = "        "
+        for field, value in asdict(bl).items():
+            env_str += (
+                f'{pad}{field}="{value}",\n' if field == "coinbase" else f"{pad}{field}={value},\n"
+            )
+        test = test.replace("$ENV", env_str)
+        return test
+
+    def _make_pre_state(
+        self, test: str, tr: "RequestManager.RemoteTransaction", state: Dict[Address, Account]
+    ) -> str:
+        # Print a nice .py storage pre
+        pad = "            "
+        state_str = ""
+        for address, account in state.items():
+            if isinstance(account, dict):
+                account_obj = Account(**account)
+                state_str += f'        "{address}": Account(\n'
+                state_str += f"{pad}balance={account_obj.balance},\n"
+                if address == tr.transaction.sender:
+                    state_str += f"{pad}nonce={tr.transaction.nonce},\n"
+                else:
+                    state_str += f"{pad}nonce={account_obj.nonce},\n"
+
+                if account_obj.code is None:
+                    state_str += f'{pad}code="0x",\n'
+                else:
+                    state_str += f'{pad}code="{account_obj.code}",\n'
+                state_str += pad + "storage={\n"
+
+                if account_obj.storage is not None:
+                    for record, value in account_obj.storage.items():
+                        pad_record = common.ZeroPaddedHexNumber(record)
+                        pad_value = common.ZeroPaddedHexNumber(value)
+                        state_str += f'{pad}    "{pad_record}" : "{pad_value}",\n'
+
+                state_str += pad + "}\n"
+                state_str += "        ),\n"
+        return test.replace("$PRE", state_str)
+
+    def _make_transaction(self, test: str, tr: "RequestManager.RemoteTransaction") -> str:
+        """
+        Print legacy transaction in .py
+        """
+        pad = "            "
+        tr_str = ""
+        quoted_fields_array = ["data", "to"]
+        hex_fields_array = ["v", "r", "s"]
+        legacy_fields_array = [
+            "ty",
+            "chain_id",
+            "nonce",
+            "gas_price",
+            "protected",
+            "gas_limit",
+            "value",
+        ]
+        for field, value in asdict(tr.transaction).items():
+            if value is None:
+                continue
+
+            if field in legacy_fields_array:
+                tr_str += f"{pad}{field}={value},\n"
+
+            if field in quoted_fields_array:
+                tr_str += f'{pad}{field}="{value}",\n'
+
+            if field in hex_fields_array:
+                tr_str += f"{pad}{field}={hex(value)},\n"
+
+        return test.replace("$TR", tr_str)
+
+    def make_test_template(
+        self,
+        bl: "RequestManager.RemoteBlock",
+        tr: "RequestManager.RemoteTransaction",
+        state: Dict[Address, Account],
+    ) -> str:
+        """
+        Prepare the .py file template
+        """
+        test = self.test_template
+        test = self._make_test_comments(test, tr.tr_hash)
+        test = self._make_test_environment(test, bl)
+        test = self._make_pre_state(test, tr, state)
+        test = self._make_transaction(test, tr)
+        return test
 
 
 class PyspecConfig:
@@ -139,15 +196,7 @@ def __init__(self, config_path: str):
         """
         with open(config_path, "r") as file:
             data = json.load(file)
-            self.remote_nodes = [self._json_to_remote_node(node) for node in data["remote_nodes"]]
-
-    def _json_to_remote_node(self, d):
-        return PyspecConfig.RemoteNode(
-            name=d["name"],
-            node_url=d["node_url"],
-            client_id=d["client_id"],
-            secret=d["secret"],
-        )
+            self.remote_nodes = [PyspecConfig.RemoteNode(**node) for node in data["remote_nodes"]]
 
 
 class RequestManager:
@@ -165,6 +214,18 @@ class RemoteTransaction:
         tr_hash: str
         transaction: Transaction
 
+    @dataclass
+    class RemoteBlock:
+        """
+        Remote block header information structure
+        """
+
+        coinbase: str
+        difficulty: str
+        gas_limit: str
+        number: str
+        timestamp: str
+
     node_url: str
     headers: dict[str, str]
 
@@ -179,6 +240,19 @@ def __init__(self, node_config: PyspecConfig.RemoteNode):
             "Content-Type": "application/json",
         }
 
+    def _make_request(self, data) -> requests.Response:
+        error_str = "An error occurred while making remote request: "
+        try:
+            response = requests.post(self.node_url, headers=self.headers, data=json.dumps(data))
+            if response.status_code >= 200 and response.status_code < 300:
+                return response
+            else:
+                print(error_str + response.text)
+                raise requests.exceptions.HTTPError
+        except requests.exceptions.RequestException as e:
+            print(error_str, e)
+            raise e
+
     def eth_get_transaction_by_hash(self, transaction_hash: str) -> RemoteTransaction:
         """
         Get transaction data.
@@ -189,7 +263,8 @@ def eth_get_transaction_by_hash(self, transaction_hash: str) -> RemoteTransactio
             "params": [f"{transaction_hash}"],
             "id": 1,
         }
-        response = requests.post(self.node_url, headers=self.headers, data=json.dumps(data))
+
+        response = self._make_request(data)
         res = response.json().get("result", None)
 
         return RequestManager.RemoteTransaction(
@@ -207,10 +282,11 @@ def eth_get_transaction_by_hash(self, transaction_hash: str) -> RemoteTransactio
                 v=int(res["v"], 16),
                 r=int(res["r"], 16),
                 s=int(res["s"], 16),
+                protected=True if int(res["v"], 16) > 30 else False,
             ),
         )
 
-    def eth_get_block_by_number(self, block_number: str):
+    def eth_get_block_by_number(self, block_number: str) -> RemoteBlock:
         """
         Get block by number
         """
@@ -220,8 +296,16 @@ def eth_get_block_by_number(self, block_number: str):
             "params": [f"{block_number}", False],
             "id": 1,
         }
-        response = requests.post(self.node_url, headers=self.headers, data=json.dumps(data))
-        return response.json().get("result", None)
+        response = self._make_request(data)
+        res = response.json().get("result", None)
+
+        return RequestManager.RemoteBlock(
+            coinbase=res["miner"],
+            number=res["number"],
+            difficulty=res["difficulty"],
+            gas_limit=res["gasLimit"],
+            timestamp=res["timestamp"],
+        )
 
     def debug_trace_call(self, tr: RemoteTransaction) -> Dict[Address, Account]:
         """
@@ -242,7 +326,7 @@ def debug_trace_call(self, tr: RemoteTransaction) -> Dict[Address, Account]:
             "id": 1,
         }
 
-        response = requests.post(self.node_url, headers=self.headers, data=json.dumps(data))
+        response = self._make_request(data)
         return response.json().get("result", None)
 
 
@@ -262,19 +346,14 @@ def debug_trace_call(self, tr: RemoteTransaction) -> Dict[Address, Account]:
     Transaction,
 )
 
-REFERENCE_SPEC_GIT_PATH = "EIPS/eip-6780.md"
-REFERENCE_SPEC_VERSION = "2f8299df31bb8173618901a03a8366a3183479b0"
+REFERENCE_SPEC_GIT_PATH = "N/A"
+REFERENCE_SPEC_VERSION = "N/A"
 
 
 @pytest.fixture
 def env():  # noqa: D103
     return Environment(
-        coinbase="0x2adc25665018aa1fe0e6bc666dac8fc2697ff9ba",
-        difficulty=3402669764409613,
-        #gas_limit=12469470,
-        gas_limit=0x016345785d8a0000,
-        number=11114732,
-        timestamp="0x5f933d46",
+$ENV
     )