Simulation: Lift log limits option in SimulateRequest

.test-env

@@ -1,6 +1,6 @@
 # Configs for testing repo download:
 SDK_TESTING_URL="https://github.com/algorand/algorand-sdk-testing"
-SDK_TESTING_BRANCH="master"
+SDK_TESTING_BRANCH="simulate-request-log-option"
 SDK_TESTING_HARNESS="test-harness"
 
 INSTALL_ONLY=0

algosdk/atomic_transaction_composer.py

@@ -256,15 +256,13 @@ def __init__(
         decode_error: Optional[Exception],
         tx_info: dict,
         method: abi.Method,
-        missing_signature: bool,
     ) -> None:
         self.tx_id = tx_id
         self.raw_value = raw_value
         self.return_value = return_value
         self.decode_error = decode_error
         self.tx_info = tx_info
         self.method = method
-        self.missing_signature = missing_signature
 
 
 class SimulateEvalOverrides:
@@ -299,16 +297,14 @@ class SimulateAtomicTransactionResponse:
     def __init__(
         self,
         version: int,
-        would_succeed: bool,
         failure_message: str,
         failed_at: Optional[List[int]],
         simulate_response: Dict[str, Any],
         tx_ids: List[str],
         results: List[SimulateABIResult],
-        eval_overrides: Optional[SimulateEvalOverrides],
+        eval_overrides: Optional[SimulateEvalOverrides] = None,
     ) -> None:
         self.version = version
-        self.would_succeed = would_succeed
         self.failure_message = failure_message
         self.failed_at = failed_at
         self.simulate_response = simulate_response
@@ -788,13 +784,11 @@ def __report_simulation_response(self, simulation_result: Dict[str, Any]):
                     decode_error=result.decode_error,
                     tx_info=result.tx_info,
                     method=result.method,
-                    missing_signature=sim_txn.get("missing-signature", False),
                 )
             )
 
         return SimulateAtomicTransactionResponse(
             version=simulation_result.get("version", 0),
-            would_succeed=simulation_result.get("would-succeed", False),
             failure_message=txn_group.get("failure-message", ""),
             failed_at=txn_group.get("failed-at"),
             simulate_response=simulation_result,

algosdk/v2client/models/simulate_request.py

@@ -34,5 +34,5 @@ def dictify(self) -> Dict[str, Any]:
             "txn-groups": [
                 txn_group.dictify() for txn_group in self.txn_groups
             ],
-            "lift-log-limits": self.lift_log_limits,
+            "allow-more-logging": self.lift_log_limits,
         }

tests/integration.tags

@@ -15,3 +15,4 @@
 @send
 @send.keyregtxn
 @simulate
+@simulate.lift_log_limits

tests/steps/other_v2_steps.py

@@ -31,6 +31,7 @@
     ApplicationLocalState,
     DryrunRequest,
     DryrunSource,
+    SimulateRequest,
 )
 from tests.steps.steps import algod_port, indexer_port
 from tests.steps.steps import token as daemon_token
@@ -1441,9 +1442,12 @@ def simulate_transaction(context):
 @then("the simulation should succeed without any failure message")
 def simulate_transaction_succeed(context):
     if hasattr(context, "simulate_response"):
-        assert context.simulate_response["would-succeed"] is True
+        assert len(context.simulate_response["failure-message"]) == 0
     else:
-        assert context.atomic_transaction_composer_return.would_succeed is True
+        assert (
+            len(context.atomic_transaction_composer_return.failure_message)
+            == 0
+        )
 
 
 @then("I simulate the current transaction group with the composer")
@@ -1469,11 +1473,42 @@ def simulate_atc_failure(context, group, path, message):
             ]
         ]
     )
-    assert resp.would_succeed is False
     assert fail_path == path
     assert message in resp.failure_message
 
 
+@when("I make a new simulate request.")
+def make_simulate_request(context):
+    context.simulate_request = SimulateRequest(txn_groups=[])
+
+
+@then("I lift log limits on that simulate request.")
+def lift_log_limits_in_request(context):
+    context.simulate_request.lift_log_limits = True
+
+
+@then("I attach the simulate request to simulate the transaction group.")
+def attach_sim_request_to_txn_group_simulation(context):
+    context.simulate_response = (
+        context.atomic_transaction_composer.simulate_with_request(
+            context.app_acl, context.simulate_request
+        )
+    )
+
+
+@then('the simulation with "{power}" should not have failure message.')
+def power_pack_simulation_should_pass(context, power: str):
+    packs = power.split(",")
+    if len(packs) > 0:
+        assert context.simulate_response.eval_overrides
+
+    if "allow-more-logging" in packs:
+        assert context.simulate_response.eval_overrides.max_log_calls
+        assert context.simulate_response.eval_overrides.max_log_size
+
+    assert len(context.simulate_response.failure_message) == 0
+
+
 @when("I prepare the transaction without signatures for simulation")
 def step_impl(context):
     context.stx = transaction.SignedTransaction(context.txn, None)
@@ -1491,10 +1526,8 @@ def check_missing_signatures(context, group, path):
     group_idx: int = int(group)
     tx_idxs: list[int] = [int(pe) for pe in path.split(",")]
 
-    assert resp["would-succeed"] is False
-
     for tx_idx in tx_idxs:
         missing_sig = resp["txn-groups"][group_idx]["txn-results"][tx_idx][
-            "missing-signature"
+            "failure-message"
         ]
         assert missing_sig is True