fix: bumping mypy; making traces object typed to prevent misc mypy er…

…ror on LogicError (#105)

.vscode/settings.json

@@ -2,9 +2,8 @@
   // General - see also /.editorconfig
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    // Don't want to use isort because it conflicts with Ruff - see run on save below
-    "source.organizeImports": true,
-    "source.fixAll": true
+    "source.organizeImports": "explicit",
+    "source.fixAll": "explicit"
   },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "files.exclude": {
@@ -54,10 +53,10 @@
     ]
   },
 
-    // PowerShell
-    "[powershell]": {
-        "editor.defaultFormatter": "ms-vscode.powershell"
-    },
-    "powershell.codeFormatting.preset": "Stroustrup",
-    "python.testing.pytestArgs": ["."]
+  // PowerShell
+  "[powershell]": {
+    "editor.defaultFormatter": "ms-vscode.powershell"
+  },
+  "powershell.codeFormatting.preset": "Stroustrup",
+  "python.testing.pytestArgs": ["."]
 }

src/algokit_utils/application_client.py

@@ -49,6 +49,7 @@
     CreateCallParametersDict,
     OnCompleteCallParameters,
     OnCompleteCallParametersDict,
+    SimulationTrace,
     TransactionParameters,
     TransactionParametersDict,
     TransactionResponse,
@@ -1236,7 +1237,7 @@ def _try_convert_to_logic_error(
     source_ex: Exception | str,
     approval_program: str,
     approval_source_map: SourceMap | typing.Callable[[], SourceMap | None] | None = None,
-    simulate_traces: list | None = None,
+    simulate_traces: list[SimulationTrace] | None = None,
 ) -> Exception | None:
     source_ex_str = str(source_ex)
     logic_error_data = parse_logic_error(source_ex_str)
@@ -1297,7 +1298,7 @@ def execute_atc_with_logic_error(
         raise ex
 
 
-def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list[dict[str, Any]]:
+def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list[SimulationTrace]:
     traces = []
     if hasattr(simulate, "simulate_response") and hasattr(simulate, "failed_at") and simulate.failed_at:
         for txn_group in simulate.simulate_response["txn-groups"]:
@@ -1307,12 +1308,12 @@ def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list
             txn_result = txn_group.get("txn-results", [{}])[0]
             exec_trace = txn_result.get("exec-trace", {})
             traces.append(
-                {
-                    "app-budget-added": app_budget_added,
-                    "app-budget-consumed": app_budget_consumed,
-                    "failure-message": failure_message,
-                    "exec-trace": exec_trace,
-                }
+                SimulationTrace(
+                    app_budget_added=app_budget_added,
+                    app_budget_consumed=app_budget_consumed,
+                    failure_message=failure_message,
+                    exec_trace=exec_trace,
+                )
             )
     return traces
 

src/algokit_utils/logic_error.py

@@ -2,6 +2,8 @@
 from copy import copy
 from typing import TYPE_CHECKING, TypedDict
 
+from algokit_utils.models import SimulationTrace
+
 if TYPE_CHECKING:
     from algosdk.source_map import SourceMap as AlgoSourceMap
 
@@ -46,7 +48,7 @@ def __init__(  # noqa: PLR0913
         message: str,
         pc: int,
         logic_error: Exception | None = None,
-        traces: list | None = None,
+        traces: list[SimulationTrace] | None = None,
     ):
         self.logic_error = logic_error
         self.logic_error_str = logic_error_str

src/algokit_utils/models.py

@@ -230,3 +230,11 @@ class CommonCallParameters(TransactionParameters):
 @deprecated(reason="Use TransactionParametersDict instead", version="1.3.1")
 class CommonCallParametersDict(TransactionParametersDict):
     """Deprecated, use TransactionParametersDict instead"""
+
+
+@dataclasses.dataclass
+class SimulationTrace:
+    app_budget_added: int | None
+    app_budget_consumed: int | None
+    failure_message: str | None
+    exec_trace: dict[str, object]

tests/test_app_client_call.py

@@ -309,7 +309,7 @@ def test_readonly_call_with_error_debug_mode_enabled(client_fixture: Application
         )
 
     assert ex.value.traces is not None
-    assert ex.value.traces[0]["exec-trace"]["approval-program-trace"] is not None
+    assert ex.value.traces[0].exec_trace["approval-program-trace"] is not None
 
 
 def test_app_call_with_error_debug_mode_disabled(mock_config: Mock, client_fixture: ApplicationClient) -> None:
@@ -350,4 +350,4 @@ def test_app_call_with_error_debug_mode_enabled(client_fixture: ApplicationClien
         )
 
     assert ex.value.traces is not None
-    assert ex.value.traces[0]["exec-trace"]["approval-program-trace"] is not None
+    assert ex.value.traces[0].exec_trace["approval-program-trace"] is not None