refactor: refinements to support client generator v3 (#130)

* chore: initial methods for typed client generator

* fix: fixing arc2 note generation in AppDeployer

* fix: changing CompiledTeal compiled to str from bytes; patching _build_source_map

* refactor: adding usage of collections.abc.Sequence for args params

* refactor: expose algorand client protocol; expand to cover latest interface

* refactor: patch compile_teal_template behaviour around deployment_metadata

* refactor: using generics for abi_return type in AppFactoryCreateMethodCallResult

* refactor: making deploy arg types in app factory rely on generic (for redefinition in client generator)

* refactor: further leveraging generics to match ts behaviour, the abi_return type turns into ABIValue

* fix: proper use of type vars for client manager typed class getters

* refactor: make all bare properties on app client send/createTxn/params optional

* refactor: add error handler for simulate responses

* fix: proper handling of default args from hints

* fix: proper handling of getting abi args with default values (when no args given)

* fix: typo in generics inheritance

* refactor: ensure send calls from AppClient for methods parse output to arc56 values

* fix: skip snake case conversion for struct field in arc56

* fix: group id generation for log during send atc

* fix: exposing AppMethodCallTransactionArgument for typed client

* fix: fixing params creation in factory

* fix: safer global state decoding

* refactor: parametrize indent in to_json methods of arc classes

* fix: typo in get_map decoding

* fix: box key decoding

* refactor: contravariant typevars for typed factory protocol

plus a fix for box decoding

Author: aorumbayev

poetry.lock

@@ -14,6 +14,7 @@
 from algokit_utils.applications.app_manager import DELETABLE_TEMPLATE_NAME, UPDATABLE_TEMPLATE_NAME
 from algokit_utils.errors.logic_error import LogicError
 from algokit_utils.clients.algorand_client import AlgorandClient
+from algokit_utils.protocols import AlgorandClientProtocol
 
 # Common managers/clients that are frequently used entry points
 from algokit_utils.accounts.account_manager import AccountManager
@@ -138,6 +139,7 @@
     "AlgorandClient",
     "DELETABLE_TEMPLATE_NAME",
     "UPDATABLE_TEMPLATE_NAME",
+    "AlgorandClientProtocol",
     # Common managers/clients
     "AccountManager",
     "AppClient",

src/algokit_utils/__init__.py

@@ -169,7 +169,7 @@ def _build_avm_sourcemap(
         source_map = compiled_teal.source_map.__dict__
         teal_content = compiled_teal.teal
     elif isinstance(compiled_teal, CompiledTeal):
-        program_hash = base64.b64encode(checksum(compiled_teal.compiled)).decode()
+        program_hash = base64.b64encode(checksum(compiled_teal.compiled_base64_to_bytes)).decode()
         source_map = compiled_teal.source_map.__dict__ if compiled_teal.source_map else {}
         teal_content = compiled_teal.teal
     else:

src/algokit_utils/_debugging.py

@@ -15,6 +15,7 @@
 ABIStruct: TypeAlias = dict[str, list[dict[str, "ABIValue"]]]
 Arc56ReturnValueType: TypeAlias = ABIValue | ABIStruct | None
 
+
 ABIType: TypeAlias = algosdk.abi.ABIType
 ABIArgumentType: TypeAlias = algosdk.abi.ABIType | algosdk.abi.ABITransactionType | algosdk.abi.ABIReferenceType
 
@@ -56,13 +57,13 @@ def is_success(self) -> bool:
 
     def get_arc56_value(
         self, method: Arc56Method | AlgorandABIMethod, structs: dict[str, list[StructField]]
-    ) -> ABIValue | ABIStruct | None:
+    ) -> Arc56ReturnValueType:
         return get_arc56_value(self, method, structs)
 
 
 def get_arc56_value(
     abi_return: ABIReturn, method: Arc56Method | AlgorandABIMethod, structs: dict[str, list[StructField]]
-) -> ABIValue | ABIStruct | None:
+) -> Arc56ReturnValueType:
     if isinstance(method, AlgorandABIMethod):
         type_str = method.returns.type
         struct = None  # AlgorandABIMethod doesn't have struct info