chore: refreshing todos (#11)

[skip ci]

Author: aorumbayev

src/algopy_testing/__init__.py

@@ -24,6 +24,9 @@
 from algopy_testing.primitives import BigUInt, Bytes, String, UInt64
 from algopy_testing.state import Box, BoxMap, BoxRef, GlobalState, LocalState
 
+# TODO: clean up and ensure only algopy_testing namespace specific user facing abstractions
+# are exposed Only keep the _value_generators, ledger_context, txn_context,
+# context, and arc4_prexif from utils (make utils private)
 __all__ = [
     "ARC4Contract",
     "ARC4ValueGenerator",

src/algopy_testing/_context_helpers/ledger_context.py

@@ -19,7 +19,7 @@ def __init__(self) -> None:
         self.account_data = defaultdict[str, AccountContextData](get_empty_account)
         self.application_data: dict[int, ApplicationContextData] = {}
         self.asset_data: dict[int, AssetFields] = {}
-        # TODO: move boxes onto application data
+        # TODO: 1.0 move boxes onto application data
         self.boxes: dict[bytes, bytes] = {}
         self.blocks: dict[int, dict[str, int]] = {}
         self.global_fields: GlobalFields = get_default_global_fields()
@@ -85,6 +85,7 @@ def update_application(
 
         self.application_data[app_id].fields.update(application_fields)
 
+    # TODO: 1.0 add app ids, access the boxes from application data
     def get_box(self, name: algopy.Bytes | bytes) -> bytes:
         name_bytes = name if isinstance(name, bytes) else name.value
         return self.boxes.get(name_bytes, b"")

src/algopy_testing/_value_generators/avm.py

@@ -117,7 +117,7 @@ def asset(
         if asset_id and asset_id in lazy_context.ledger.asset_data:
             raise ValueError("Asset with such ID already exists in testing context!")
 
-        # TODO: ensure passed fields are valid names and types
+        # TODO: 1.0 ensure passed fields are valid names and types
         new_asset = algopy.Asset(asset_id or next(lazy_context.ledger.asset_id))
         default_asset_fields = {
             "total": lazy_context.any.uint64(),

src/algopy_testing/_value_generators/txn.py

@@ -123,7 +123,6 @@ def transaction(
         return self._new_gtxn(gtxn.Transaction, **fields)
 
     def _new_gtxn(self, txn_type: type[_TGlobalTxn], **fields: object) -> _TGlobalTxn:
-        # TODO: check reference types are known?
         fields.setdefault("type", txn_type.type_enum)
         fields.setdefault("sender", lazy_context.value.default_sender)
 

src/algopy_testing/arc4.py

@@ -277,9 +277,6 @@ def __init__(
         bytes_value = int_to_bytes(value, self.type_info.max_bytes_len)
         self._value = as_bytes(bytes_value)
 
-    # ~~~ https://docs.python.org/3/reference/datamodel.html#basic-customization ~~~
-    # TODO: mypy suggests due to Liskov below should be other: object
-    #       need to consider ramifications here, ignoring it for now
     def __eq__(  # type: ignore[override]
         self,
         other: UIntN[_TBitSize] | BigUIntN[_TBitSize] | algopy.UInt64 | algopy.BigUInt | int,
@@ -1031,7 +1028,7 @@ def _tuple_type_from_struct(struct: type[Struct]) -> type[Tuple]:  # type: ignor
 class Struct(metaclass=_StructMeta):
     """Base class for ARC4 Struct types."""
 
-    type_info: typing.ClassVar[_TypeInfo]  # TODO: this could clash with user values
+    type_info: typing.ClassVar[_TypeInfo]  # TODO: 1.0 this could clash with user values
 
     def __init_subclass__(cls) -> None:
         dataclasses.dataclass(cls)

src/algopy_testing/context.py

@@ -32,7 +32,6 @@ def __init__(
     ) -> None:
         import algopy
 
-        # TODO: remove direct reads of data mappings outside of context_storage
         self._default_sender = algopy.Account(
             default_sender or algosdk.account.generate_account()[1]
         )

src/algopy_testing/decorators/arc4.py

@@ -64,7 +64,7 @@ def get_arc4_metadata(fn: object) -> MethodMetadata:
 def get_ordered_args(
     _fn: Callable[..., typing.Any], app_args: list[typing.Any], kwargs: dict[str, typing.Any]
 ) -> list[typing.Any]:
-    # TODO: order kwargs correctly based on fn signature
+    # TODO: 1.0 order kwargs correctly based on fn signature
     return [*app_args, *kwargs.values()]
 
 
@@ -140,8 +140,6 @@ def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _R:
         app_id = contract.__app_id__
 
         context = lazy_context.value
-        # TODO: does contract need to be active here?
-        # TODO: handle custom txn groups
         ordered_args = get_ordered_args(fn, app_args, kwargs)
         assert metadata.arc4_signature is not None, "expected abimethod"
         txns = create_abimethod_txns(
@@ -152,7 +150,7 @@ def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _R:
         with context.txn._maybe_implicit_txn_group(txns):
             check_routing_conditions(app_id, metadata)
             result = fn(*args, **kwargs)
-            # TODO: add result along with ARC4 log prefix to application logs?
+            # TODO: 1.0 add result along with ARC4 log prefix to application logs?
             return result
 
     return wrapper
@@ -202,7 +200,6 @@ def create_baremethod_txns(app_id: int) -> list[algopy.gtxn.TransactionBase]:
     contract_app = lazy_context.ledger.get_application(app_id)
     txn_fields.setdefault("app_id", contract_app)
 
-    # TODO: fill out other fields where possible (see abimethod)
     txn_fields.setdefault(
         "approval_program_pages", [algopy_testing.Bytes(ALWAYS_APPROVE_TEAL_PROGRAM)]
     )
@@ -253,7 +250,7 @@ def _extract_arrays_from_args(
             case _ as maybe_native:
                 app_args.append(algopy_testing.arc4.native_value_to_arc4(maybe_native).bytes)
     if len(app_args) > 16:
-        # TODO: pack extra args into an ARC4 tuple
+        # TODO:1.0 pack extra args into an ARC4 tuple
         raise NotImplementedError
     return _TxnArrays(
         txns=txns,
@@ -374,7 +371,6 @@ def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _R:
         assert isinstance(contract, algopy_testing.ARC4Contract), "expected ARC4 contract"
         assert fn is not None, "expected function"
 
-        # TODO: handle custom txn groups
         txns = create_baremethod_txns(contract.__app_id__)
 
         with lazy_context.txn._maybe_implicit_txn_group(txns):

src/algopy_testing/models/application.py

@@ -42,6 +42,7 @@ class ApplicationContextData:
     )
     is_creating: bool = False
     contract: Contract | None = None
+    # TODO: 1.0 add getter to ledger context, get_global_state, get_local_state, get_box
 
     def get_global_state(self, key: algopy.Bytes | bytes) -> StateValueType:
         return self.global_state[as_bytes(key)]
@@ -99,7 +100,7 @@ def fields(self) -> ApplicationFields:
     def __getattr__(self, name: str) -> typing.Any:
         if name in inspect.get_annotations(ApplicationFields):
             value = self.fields.get(name)
-            # TODO: ensure reasonable default values are present (like account does)
+            # TODO: 1.0 ensure reasonable default values are present (like account does)
             if value is None:
                 raise ValueError(
                     f"The Application value '{name}' has not been defined on the test context. "

src/algopy_testing/models/contract.py

@@ -48,7 +48,7 @@ def __call__(cls, *args: typing.Any, **kwargs: dict[str, typing.Any]) -> object:
         fields = lazy_context.get_txn_op_fields()
         fields["app_id"] = app_ref
 
-        # TODO: provide app_id during instantiation without requiring a txn
+        # TODO: 1.0 provide app_id during instantiation without requiring a txn
         txn = context.any.txn.application_call(**fields)
         with context.txn.create_group([txn]):
             instance = super().__call__(*args, **kwargs)
@@ -91,7 +91,7 @@ def __init_subclass__(
         ) = None,
         state_totals: StateTotals | None = None,
     ):
-        # TODO: check storing these on cls does not interfere with instances
+        # TODO: 1.0 add test : check storing these on cls does not interfere with instances
         #       by having a contract with _name, _scratch_slots and _state_totals attributes
         cls._name = name or cls.__name__
         cls._scratch_slots = scratch_slots
@@ -113,7 +113,7 @@ def set_active_contract(
                 *args: typing.Any, **kwargs: dict[str, typing.Any]
             ) -> typing.Any:
                 context = lazy_context.value
-                # TODO: this should populate the app txn as much as possible like abimethod does
+                # TODO: 1.0 should populate the app txn as much as possible like abimethod does
                 app = context.ledger.get_application(_get_self_or_active_app_id(self))
                 txns = [context.any.txn.application_call(app_id=app)]
                 with context.txn._maybe_implicit_txn_group(txns):
@@ -207,7 +207,7 @@ def _get_state_totals(contract: Contract, cls_state_totals: StateTotals) -> _Sta
         else:
             local_bytes += 1
 
-    # TODO: add tests for state overrides
+    # TODO: 1.0 add tests for state overrides
     # apply any cls specific overrides
     if cls_state_totals.global_uints is not None:
         global_uints = cls_state_totals.global_uints

src/algopy_testing/models/txn_fields.py

@@ -76,8 +76,8 @@ class ApplicationCallFields(TransactionBaseFields, total=False):
     accounts: Sequence[algopy.Account]
     assets: Sequence[algopy.Asset]
     apps: Sequence[algopy.Application]
-    # TODO: when storing these pages values, combine into one bytes and then
-    # "chop" into 4096 length pieces
+    # TODO: 1.0 when storing these pages values, combine into one bytes and then
+    # "chop" into 4096 length pieces. Covered in ITxns, ensure Txns use the same method
     approval_program: Sequence[algopy.Bytes]
     clear_state_program: Sequence[algopy.Bytes]
 
@@ -104,7 +104,6 @@ class TransactionFields(  # type: ignore[misc]
     type: algopy.TransactionType
 
 
-# TODO: can this easily be derived from annotations?
 _FIELD_TYPES = {
     "sender": Account,
     "rekey_to": Account,
@@ -201,7 +200,7 @@ def sender(self) -> algopy.Account:
         return self.fields["sender"]  # type: ignore[return-value]
 
     @property
-    def txn_id(self) -> algopy.Bytes:  # TODO: txn_id or tx_id
+    def txn_id(self) -> algopy.Bytes:
         return self.fields["txn_id"]  # type: ignore[return-value]
 
     @property