refactor: moving scratch slots and app logs to TransactionBase (#10)

* refactor: moving scratch slots and app logs to TransactionBase

* build: updated to latest puyapy

* refactor: minor refactors

* refactor: refactor txn group initialization

* refactor: add additional gtxn properties from 2.0 stubs

* refactor: consolidate log and scratch space implementation.

logs can be mocked on the underlying application, or for specific transactions
active txn can append logs

* refactor: defer some imports to reduce circular imports

* chore: add some TODO's for future work

* test: tweak test for mocking abi_call, by ensuring mocked function is in algopy namespace

* feat: implement gaid op

* fix: added mock implementations for new algopy functions, add util for raising consistent mockable method errors

* chore: add TODO for asset property

---------

Co-authored-by: Daniel McGregor <daniel.mcgregor@makerx.com.au>

Author: aorumbayev

examples/scratch_storage/test_contract.py

@@ -22,7 +22,7 @@ def test_arc4_contract(context: AlgopyTestContext) -> None:
 
     # Assert
     assert result
-    scratch_space = context.txn.get_scratch_space(context.txn.last_active)
+    scratch_space = context.txn.last_group.get_scratch_space()
     assert scratch_space[1] == 5
     assert scratch_space[2] == b"Hello World"
 

examples/zk_whitelist/test_contract.py

@@ -36,13 +36,8 @@ def test_add_address_to_whitelist(
         )
     )
 
-    # TODO: allow callables for side effects
-    dummy_verifier_app = context.any.application()
+    dummy_verifier_app = context.any.application(logs=[arc4_prefix(b"\x80")])
     context.set_template_var("VERIFIER_APP_ID", dummy_verifier_app.id)
-    context.txn.add_app_logs(
-        app_id=dummy_verifier_app.id,
-        logs=arc4_prefix(b"\x80"),
-    )
 
     # Act
     result = contract.add_address_to_whitelist(address, proof)
@@ -64,12 +59,8 @@ def test_add_address_to_whitelist_invalid_proof(
             *[algopy.arc4.Byte(0) for _ in range(32)]
         )
     )
-    dummy_verifier_app = context.any.application()
+    dummy_verifier_app = context.any.application(logs=[arc4_prefix(b"")])
     context.set_template_var("VERIFIER_APP_ID", dummy_verifier_app.id)
-    context.txn.add_app_logs(
-        app_id=dummy_verifier_app.id,
-        logs=arc4_prefix(b""),
-    )
 
     # Act
     result = contract.add_address_to_whitelist(address, proof)

pyproject.toml

@@ -29,7 +29,7 @@ dependencies = [
     "pynacl>=1.4.0,<2",
     "ecdsa>=0.17.0",
     "coincurve>=19.0.1",
-    "algorand-python>=1.2"
+    "algorand-python>=2.0"
 ]
 
 [project.urls]
@@ -52,7 +52,7 @@ type = "virtual"
 path = ".venv"
 python = "3.12"
 dependencies = [
-    "puyapy>=2.2.0",
+    "puyapy>=3.0",
     "pytest>=7.4",
     "pytest-mock>=3.10.0",
     "pytest-xdist[psutil]>=3.3",
@@ -243,6 +243,11 @@ unfixable = [
     "F841", # don't delete unused local variables automatically
 ]
 [tool.ruff.lint.per-file-ignores]
+"src/algopy/**" = [
+    "PLC0414", # allow explicit alias
+    "F401", # allow unused imports in module with stubs
+    "F403"  # allow * imports in module with stubs
+]
 "src/**" = [
     "PT", # no pytest rules
 ]

src/algopy/__init__.py

@@ -1,3 +1,9 @@
+from algopy_testing._compiled import (
+    CompiledContract,
+    CompiledLogicSig,
+    compile_contract,
+    compile_logicsig,
+)
 from algopy_testing.decorators.subroutine import subroutine
 from algopy_testing.enums import OnCompleteAction, TransactionType
 from algopy_testing.models.account import Account
@@ -23,6 +29,8 @@
     "BigUInt",
     "Bytes",
     "BytesBacked",
+    "CompiledContract",
+    "CompiledLogicSig",
     "Contract",
     "Global",
     "GlobalState",
@@ -37,6 +45,8 @@
     "Txn",
     "UInt64",
     "arc4",
+    "compile_contract",
+    "compile_logicsig",
     "ensure_budget",
     "gtxn",
     "itxn",

src/algopy/arc4.py

@@ -1 +1,5 @@
-from algopy_testing.arc4 import *  # noqa: F403
+from algopy_testing.arc4 import *
+from algopy_testing.decorators.arc4 import (
+    abimethod as abimethod,
+    baremethod as baremethod,
+)

src/algopy/gtxn.py

@@ -1 +1 @@
-from algopy_testing.gtxn import *  # noqa: F403
+from algopy_testing.gtxn import *

src/algopy/itxn.py

@@ -1 +1 @@
-from algopy_testing.itxn import *  # noqa: F403
+from algopy_testing.itxn import *

src/algopy/op.py

@@ -1 +1 @@
-from algopy_testing.op import *  # noqa: F403
+from algopy_testing.op import *

src/algopy_testing/_compiled.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+# ruff: noqa: ARG001, PLR0913
+import dataclasses
+import typing
+
+from algopy_testing.utils import raise_mocked_function_error
+
+if typing.TYPE_CHECKING:
+    from collections.abc import Mapping
+
+    import algopy
+
+
+@dataclasses.dataclass
+class CompiledContract:
+    approval_program: tuple[algopy.Bytes, algopy.Bytes]
+    clear_state_program: tuple[algopy.Bytes, algopy.Bytes]
+    extra_program_pages: algopy.UInt64
+    global_uints: algopy.UInt64
+    global_bytes: algopy.UInt64
+    local_uints: algopy.UInt64
+    local_bytes: algopy.UInt64
+
+
+@dataclasses.dataclass
+class CompiledLogicSig:
+    account: algopy.Account
+
+
+def compile_contract(
+    contract: type[algopy.Contract],
+    /,
+    *,
+    extra_program_pages: algopy.UInt64 | int = 0,
+    global_uints: algopy.UInt64 | int = 0,
+    global_bytes: algopy.UInt64 | int = 0,
+    local_uints: algopy.UInt64 | int = 0,
+    local_bytes: algopy.UInt64 | int = 0,
+    template_vars: Mapping[str, object] | None = None,
+    template_vars_prefix: str = "",
+) -> CompiledContract:
+    raise_mocked_function_error("compile_contract")
+
+
+def compile_logicsig(
+    logicsig: algopy.LogicSig,
+    /,
+    *,
+    template_vars: Mapping[str, object] | None = None,
+    template_vars_prefix: str = "",
+) -> CompiledLogicSig:
+    raise_mocked_function_error("compile_logicsig")

src/algopy_testing/_context_helpers/ledger_context.py

@@ -3,19 +3,21 @@
 import typing
 from collections import defaultdict
 
-from algopy_testing.models.account import AccountContextData, AccountFields, get_empty_account
 from algopy_testing.utils import assert_address_is_valid, get_default_global_fields
 
 if typing.TYPE_CHECKING:
     import algopy
 
+    from algopy_testing.models.account import AccountFields
     from algopy_testing.models.application import ApplicationContextData, ApplicationFields
     from algopy_testing.models.asset import AssetFields
     from algopy_testing.op.global_values import GlobalFields
 
 
 class LedgerContext:
     def __init__(self) -> None:
+        from algopy_testing.models.account import AccountContextData, get_empty_account
+
         self.account_data = defaultdict[str, AccountContextData](get_empty_account)
         self.application_data: dict[int, ApplicationContextData] = {}
         self.asset_data: dict[int, AssetFields] = {}