refactor: move box storage onto ApplicationContextData (#12)

* refactor: move box storage onto ApplicationContextData

Require app reference when interacting with boxes

* refactor: moving getters setters of global local state to ledger context

* refactor: more laconic names for methods/vars referencing application -> app

---------

Co-authored-by: Altynbek Orumbayev <altynbek.orumbayev@makerx.com.au>

Author: daniel-makerx

examples/box/test_contract.py

@@ -22,5 +22,5 @@ def test_enums(context: AlgopyTestContext) -> None:
     oca, txn = contract.read_enums()
 
     # Assert
-    assert context.ledger.get_box(b"oca") == op.itob(oca.native)
-    assert context.ledger.get_box(b"txn") == op.itob(txn.native)
+    assert context.ledger.get_box(contract, b"oca") == op.itob(oca.native)
+    assert context.ledger.get_box(contract, b"txn") == op.itob(txn.native)

examples/marketplace/test_contract.py

@@ -63,7 +63,7 @@ def test_first_deposit(
         nonce=test_nonce,
     )
     listing_value = ListingValue.from_bytes(
-        context.ledger.get_box(b"listings" + listing_key.bytes)
+        context.ledger.get_box(contract, b"listings" + listing_key.bytes)
     )
     assert listing_value.deposited == UInt64(10)
 
@@ -100,7 +100,7 @@ def test_deposit(
     )
 
     # Assert
-    assert context.ledger.box_exists(b"listings" + listing_key.bytes)
+    assert context.ledger.box_exists(contract, b"listings" + listing_key.bytes)
 
 
 def test_set_price(
@@ -129,7 +129,7 @@ def test_set_price(
 
     # Assert
     updated_listing = ListingValue.from_bytes(
-        context.ledger.get_box(b"listings" + listing_key.bytes)
+        context.ledger.get_box(contract, b"listings" + listing_key.bytes)
     )
     assert updated_listing.unitary_price == test_unitary_price
 
@@ -173,7 +173,7 @@ def test_buy(
 
     # Assert
     updated_listing = ListingValue.from_bytes(
-        context.ledger.get_box(b"listings" + listing_key.bytes)
+        context.ledger.get_box(contract, b"listings" + listing_key.bytes)
     )
     assert updated_listing.deposited == initial_deposit.native - test_buy_quantity.native
     assert (
@@ -206,7 +206,7 @@ def test_withdraw(
     contract.withdraw(asset=test_asset, nonce=test_nonce)
 
     # Assert
-    assert not context.ledger.box_exists(b"listings" + listing_key.bytes)
+    assert not context.ledger.box_exists(contract, b"listings" + listing_key.bytes)
     assert len(context.txn.last_group.itxn_groups) == 2
 
     payment_txn = context.txn.last_group.get_itxn_group(0).payment(0)

examples/proof_of_attendance/test_contract.py

@@ -57,9 +57,9 @@ def test_confirm_attendance(
     confirm()
 
     # Assert
-    assert context.ledger.get_box(key_prefix + context.default_sender.bytes) == algopy.op.itob(
-        1001
-    )
+    assert context.ledger.get_box(
+        contract, key_prefix + context.default_sender.bytes
+    ) == algopy.op.itob(1001)
 
 
 @pytest.mark.parametrize(
@@ -88,7 +88,9 @@ def test_claim_poa(
         fee=algopy.UInt64(0),
         asset_amount=algopy.UInt64(0),
     )
-    context.ledger.set_box(key_prefix + context.default_sender.bytes, algopy.op.itob(dummy_poa.id))
+    context.ledger.set_box(
+        contract, key_prefix + context.default_sender.bytes, algopy.op.itob(dummy_poa.id)
+    )
 
     # Act
     claim = getattr(contract, claim_poa)

src/algopy_testing/__init__.py

@@ -1,8 +1,5 @@
 from algopy_testing import arc4, gtxn, itxn
-from algopy_testing._context_helpers.context_storage import (
-    algopy_testing_context,
-    get_test_context,
-)
+from algopy_testing._context_helpers.context_storage import algopy_testing_context
 from algopy_testing._itxn_loader import ITxnGroupLoader, ITxnLoader
 from algopy_testing._value_generators.arc4 import ARC4ValueGenerator
 from algopy_testing.context import AlgopyTestContext

src/algopy_testing/_context_helpers/__init__.py

@@ -1,6 +1,5 @@
 from algopy_testing._context_helpers.context_storage import (
     algopy_testing_context,
-    get_test_context,
     lazy_context,
 )
 from algopy_testing._context_helpers.ledger_context import LedgerContext
@@ -10,6 +9,5 @@
     "LedgerContext",
     "TransactionContext",
     "algopy_testing_context",
-    "get_test_context",
     "lazy_context",
 ]

src/algopy_testing/_context_helpers/context_storage.py

@@ -20,26 +20,20 @@
 _var: ContextVar[AlgopyTestContext] = ContextVar("_var")
 
 
-# functions for use by algopy_testing implementations that shouldn't be exposed to the user
-def get_test_context() -> AlgopyTestContext:
-    try:
-        result = _var.get()
-    except LookupError:
-        raise ValueError(
-            "Test context is not initialized! Use `with algopy_testing_context()` to "
-            "access the context manager."
-        ) from None
-    return result
-
-
 class _InternalContext:
     """For accessing implementation specific functions, with a convenient
     single entry point for other modules to import Also allows for a single
     place to check and provide."""
 
     @property
     def value(self) -> AlgopyTestContext:
-        return get_test_context()
+        try:
+            return _var.get()
+        except LookupError:
+            raise ValueError(
+                "Test context is not initialized! Use `with algopy_testing_context()` to "
+                "access the context manager."
+            ) from None
 
     @property
     def ledger(self) -> LedgerContext:
@@ -67,32 +61,20 @@ def active_group(self) -> TransactionGroup:
         return group
 
     @property
-    def active_application(self) -> algopy.Application:
-        return self.ledger.get_application(self.active_group.active_app_id)
+    def active_app(self) -> algopy.Application:
+        return self.ledger.get_app(self.active_group.active_app_id)
+
+    @property
+    def active_app_id(self) -> int:
+        return self.active_group.active_app_id
 
     def get_app_data(
         self,
         app: algopy.Contract | algopy.Application | algopy.UInt64 | int,
     ) -> ApplicationContextData:
-        from algopy_testing.models import Application, Contract
-        from algopy_testing.primitives import UInt64
-
-        if isinstance(app, Contract):
-            app_id = app.__app_id__
-        elif isinstance(app, Application):
-            app_id = app.id.value
-        elif isinstance(app, UInt64):
-            app_id = app.value
-        elif isinstance(app, int):
-            app_id = app
-        else:
-            raise TypeError("invalid type")
-        if app_id == 0:
-            app_id = self.active_group.active_app_id
-        try:
-            return self.ledger.application_data[app_id]
-        except KeyError:
-            raise ValueError("Unknown app id, is there an active transaction?") from None
+        if app == 0:
+            app = self.active_group.active_app_id
+        return self.ledger._get_app_data(app)
 
     def get_asset_data(self, asset_id: int | algopy.UInt64) -> AssetFields:
         try: