fix: show trace on transaction fail (#129)

Author: antazoey

.github/workflows/codeql.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2

.github/workflows/commitlint.yaml

@@ -9,7 +9,7 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
           with:
               fetch-depth: 0
 

.github/workflows/docs.yaml

@@ -16,7 +16,7 @@ jobs:
       contents: write
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Setup Python
       uses: actions/setup-python@v5

.github/workflows/prtitle.yaml

@@ -12,7 +12,7 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
 
         - name: Setup Python
           uses: actions/setup-python@v5

.github/workflows/publish.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python
       uses: actions/setup-python@v5

.github/workflows/test.yaml

@@ -14,7 +14,7 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
 
         - name: Setup Python
           uses: actions/setup-python@v5
@@ -26,14 +26,11 @@ jobs:
             python -m pip install --upgrade pip
             pip install .[lint]
 
-        - name: Run Black
-          run: black --check .
+        - name: Run Ruff Lint
+          run: ruff check .
 
-        - name: Run isort
-          run: isort --check-only .
-
-        - name: Run flake8
-          run: flake8 .
+        - name: Run Ruff Format
+          run: ruff format --check .
 
         - name: Run mdformat
           run: mdformat . --check
@@ -42,7 +39,7 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
 
         - name: Setup Python
           uses: actions/setup-python@v5
@@ -66,7 +63,7 @@ jobs:
                 python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
 
         steps:
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@v5
 
         - name: Install Foundry
           uses: foundry-rs/foundry-toolchain@v1
@@ -102,7 +99,7 @@ jobs:
 #            fail-fast: true
 #
 #        steps:
-#        - uses: actions/checkout@v4
+#        - uses: actions/checkout@v5
 #
 #        - name: Setup Python
 #          uses: actions/setup-python@v5

.pre-commit-config.yaml

@@ -4,31 +4,21 @@ repos:
     hooks:
     -   id: check-yaml
 
--   repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.0  # Latest ruff version
     hooks:
-      - id: isort
-
--   repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-        name: black
-
--   repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
-    hooks:
-    -   id: flake8
-        additional_dependencies: [flake8-breakpoint, flake8-print, flake8-pydantic, flake8-type-checking]
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+    -   id: ruff-format
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.16.1
     hooks:
     -   id: mypy
-        additional_dependencies: [types-PyYAML, types-requests, types-setuptools, pydantic]
+        additional_dependencies: [types-setuptools, pydantic]
 
 -   repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.19
+    rev: 0.7.22
     hooks:
     -   id: mdformat
         additional_dependencies: [mdformat-gfm, mdformat-frontmatter, mdformat-pyproject]

ape_foundry/provider.py

@@ -26,17 +26,18 @@
 from ape.utils import cached_property
 from ape_ethereum.provider import Web3Provider
 from ape_test import ApeTestConfig
-from eth_pydantic_types import HexBytes, HexBytes32
 from eth_typing import HexStr
 from eth_utils import add_0x_prefix, is_0x_prefixed, is_hex, to_hex
 from pydantic import field_validator, model_validator
 from pydantic_settings import SettingsConfigDict
 from web3 import HTTPProvider, Web3
-from web3.exceptions import ContractCustomError
+from web3.exceptions import ContractCustomError, ExtraDataLengthError
 from web3.exceptions import ContractLogicError as Web3ContractLogicError
-from web3.exceptions import ExtraDataLengthError
 from web3.gas_strategies.rpc import rpc_gas_price_strategy
 
+from eth_pydantic_types import HexBytes, HexBytes32
+from eth_pydantic_types.utils import PadDirection
+
 try:
     from web3.middleware import ExtraDataToPOAMiddleware  # type: ignore
 except ImportError:
@@ -66,6 +67,9 @@
 EPHEMERAL_PORTS_END = 60999
 DEFAULT_PORT = 8545
 FOUNDRY_CHAIN_ID = 31337
+FOUNDRY_REVERT_PREFIX = (
+    "Error: VM Exception while processing transaction: reverted with reason string"
+)
 
 
 class FoundryForkConfig(PluginConfig):
@@ -345,16 +349,15 @@ def connect(self):
                 else:
                     # The user configured a host and the anvil process was already running.
                     logger.info(
-                        f"Connecting to existing '{self.process_name}' "
-                        f"at host '{self._clean_uri}'."
+                        f"Connecting to existing '{self.process_name}' at host '{self._clean_uri}'."
                     )
             else:
                 for _ in range(self.settings.process_attempts):
                     try:
                         self._start()
                         break
                     except FoundryNotInstalledError:
-                        # Is a sub-class of `FoundrySubprocessError` but we to still raise
+                        # Is a subclass of `FoundrySubprocessError` but we to still raise
                         # so we don't keep retrying.
                         raise
                     except SubprocessError as exc:
@@ -562,14 +565,9 @@ def get_virtual_machine_error(self, exception: Exception, **kwargs) -> VirtualMa
         if not message:
             return VirtualMachineError(base_err=exception, **kwargs)
 
-        # Handle specific cases based on message content
-        foundry_prefix = (
-            "Error: VM Exception while processing transaction: reverted with reason string "
-        )
-
         # Handle Foundry error prefix
-        if message.startswith(foundry_prefix):
-            message = message.replace(foundry_prefix, "").strip("'")
+        if message.startswith(FOUNDRY_REVERT_PREFIX):
+            message = message.replace(f"{FOUNDRY_REVERT_PREFIX} ", "").strip("'")
             return self._handle_execution_reverted(exception, message, **kwargs)
 
         # Handle various cases of transaction reverts
@@ -604,6 +602,9 @@ def get_virtual_machine_error(self, exception: Exception, **kwargs) -> VirtualMa
     def _handle_execution_reverted(  # type: ignore[override]
         self, exception: Exception, revert_message: Optional[str] = None, **kwargs
     ):
+        trace = kwargs.get("trace")
+        txn = kwargs.get("txn")
+
         # Assign default message if revert_message is invalid
         if revert_message == "0x":
             revert_message = TransactionError.DEFAULT_MESSAGE
@@ -618,12 +619,25 @@ def _handle_execution_reverted(  # type: ignore[override]
         enriched = self.compiler_manager.enrich_error(sub_err)
 
         # Show call trace if available
-        txn = enriched.txn
-        if txn and hasattr(txn, "show_trace"):
-            if isinstance(txn, TransactionAPI) and txn.receipt:
-                txn.receipt.show_trace()
+        if trace and callable(trace):
+            trace = trace()
+
+        if not trace and (txn := txn):
+            if isinstance(txn, TransactionAPI):
+                if txn.receipt:
+                    trace = txn.receipt.trace
+                else:
+                    # Calls it from the provider.
+                    try:
+                        trace = txn.trace
+                    except Exception:
+                        pass
+
             elif isinstance(txn, ReceiptAPI):
-                txn.show_trace()
+                trace = txn.trace
+
+        if trace:
+            trace.show()
 
         return enriched
 
@@ -668,8 +682,8 @@ def set_storage(self, address: "AddressType", slot: int, value: HexBytes):
             "anvil_setStorageAt",
             [
                 address,
-                to_hex(HexBytes32.__eth_pydantic_validate__(slot)),
-                to_hex(HexBytes32.__eth_pydantic_validate__(value)),
+                to_hex(HexBytes32.__eth_pydantic_validate__(slot, pad=PadDirection.LEFT)),
+                to_hex(HexBytes32.__eth_pydantic_validate__(value, pad=PadDirection.LEFT)),
             ],
         )