chore: refining AppFactory and AppDeployer implementations

aorumbayev · aorumbayev · commit 3af564c71488 · 2024-12-18T15:13:31.000+01:00
diff --git a/src/algokit_utils/applications/app_deployer.py b/src/algokit_utils/applications/app_deployer.py
@@ -80,37 +80,37 @@ class AppLookup:
 class OnSchemaBreak(str, Enum):
     """Action to take if an Application's schema has breaking changes"""
 
-    FAIL = "fail"
+    Fail = "fail"
     """Fail the deployment"""
-    REPLACE_APP = "replace_app"
+    ReplaceApp = "replace_app"
     """Create a new Application and delete the old Application in a single transaction"""
-    APPEND_APP = "append_app"
+    AppendApp = "append_app"
     """Create a new Application"""
 
 
 class OnUpdate(str, Enum):
     """Action to take if an Application has been updated"""
 
-    FAIL = "fail"
+    Fail = "fail"
     """Fail the deployment"""
-    UPDATE_APP = "update_app"
+    UpdateApp = "update_app"
     """Update the Application with the new approval and clear programs"""
-    REPLACE_APP = "replace_app"
+    ReplaceApp = "replace_app"
     """Create a new Application and delete the old Application in a single transaction"""
-    APPEND_APP = "append_app"
+    AppendApp = "append_app"
     """Create a new application"""
 
 
 class OperationPerformed(str, Enum):
     """Describes the actions taken during deployment"""
 
-    NOTHING = "nothing"
+    Nothing = "nothing"
     """An existing Application was found"""
-    CREATE = "create"
+    Create = "create"
     """No existing Application was found, created a new Application"""
-    UPDATE = "update"
+    Update = "update"
     """An existing Application was found, but was out of date, updated to latest version"""
-    REPLACE = "replace"
+    Replace = "replace"
     """An existing Application was found, but was out of date, created a new Application and deleted the original"""
 
 
@@ -120,8 +120,8 @@ class AppDeployParams:
 
     metadata: AppDeployMetaData
     deploy_time_params: TealTemplateParams | None = None
-    on_schema_break: Literal["replace", "fail", "append"] | OnSchemaBreak = OnSchemaBreak.FAIL
-    on_update: Literal["update", "replace", "fail", "append"] | OnUpdate = OnUpdate.FAIL
+    on_schema_break: Literal["replace", "fail", "append"] | OnSchemaBreak = OnSchemaBreak.Fail
+    on_update: Literal["update", "replace", "fail", "append"] | OnUpdate = OnUpdate.Fail
     create_params: AppCreateParams | AppCreateMethodCallParams
     update_params: AppUpdateParams | AppUpdateMethodCallParams
     delete_params: AppDeleteParams | AppDeleteMethodCallParams
@@ -289,7 +289,7 @@ def deploy(self, deployment: AppDeployParams) -> AppDeployResponse:
         logger.debug("No detected changes in app, nothing to do.", suppress_log=deployment.suppress_log)
         return AppDeployResponse(
             app=existing_app,
-            operation_performed=OperationPerformed.NOTHING,
+            operation_performed=OperationPerformed.Nothing,
         )
 
     def _create_app(
@@ -339,7 +339,7 @@ def _create_app(
 
         return AppDeployResponse(
             app=app_metadata,
-            operation_performed=OperationPerformed.CREATE,
+            operation_performed=OperationPerformed.Create,
             create_response=create_response,
         )
 
@@ -413,7 +413,7 @@ def _replace_app(
 
         return AppDeployResponse(
             app=app_metadata,
-            operation_performed=OperationPerformed.REPLACE,
+            operation_performed=OperationPerformed.Replace,
             create_response=create_response,
             update_response=None,
             delete_response=delete_response,
@@ -465,7 +465,7 @@ def _update_app(
 
         return AppDeployResponse(
             app=app_metadata,
-            operation_performed=OperationPerformed.UPDATE,
+            operation_performed=OperationPerformed.Update,
             update_response=result,
         )
 
@@ -476,14 +476,14 @@ def _handle_schema_break(
         approval_program: bytes,
         clear_program: bytes,
     ) -> AppDeployResponse:
-        if deployment.on_schema_break in (OnSchemaBreak.FAIL, "fail"):
+        if deployment.on_schema_break in (OnSchemaBreak.Fail, "fail"):
             raise ValueError(
                 "Schema break detected and onSchemaBreak=OnSchemaBreak.Fail, stopping deployment. "
                 "If you want to try deleting and recreating the app then "
                 "re-run with onSchemaBreak=OnSchemaBreak.ReplaceApp"
             )
 
-        if deployment.on_schema_break in (OnSchemaBreak.APPEND_APP, "append"):
+        if deployment.on_schema_break in (OnSchemaBreak.AppendApp, "append"):
             return self._create_app(deployment, approval_program, clear_program)
 
         if existing_app.deletable:
@@ -498,21 +498,21 @@ def _handle_update(
         approval_program: bytes,
         clear_program: bytes,
     ) -> AppDeployResponse:
-        if deployment.on_update in (OnUpdate.FAIL, "fail"):
+        if deployment.on_update in (OnUpdate.Fail, "fail"):
             raise ValueError(
                 "Update detected and onUpdate=Fail, stopping deployment. " "Try a different onUpdate value to not fail."
             )
 
-        if deployment.on_update in (OnUpdate.APPEND_APP, "append"):
+        if deployment.on_update in (OnUpdate.AppendApp, "append"):
             return self._create_app(deployment, approval_program, clear_program)
 
-        if deployment.on_update in (OnUpdate.UPDATE_APP, "update"):
+        if deployment.on_update in (OnUpdate.UpdateApp, "update"):
             if existing_app.updatable:
                 return self._update_app(deployment, existing_app, approval_program, clear_program)
             else:
                 raise ValueError("App is not updatable but onUpdate=UpdateApp, cannot update app")
 
-        if deployment.on_update in (OnUpdate.REPLACE_APP, "replace"):
+        if deployment.on_update in (OnUpdate.ReplaceApp, "replace"):
             if existing_app.deletable:
                 return self._replace_app(deployment, existing_app, approval_program, clear_program)
             else:
diff --git a/src/algokit_utils/applications/app_factory.py b/src/algokit_utils/applications/app_factory.py
@@ -48,13 +48,13 @@
 from algokit_utils.models.state import TealTemplateParams
 from algokit_utils.models.transaction import (
     SendAppCreateTransactionResult,
+    SendAppCreateTransactionResultBase,
     SendAppTransactionResult,
+    SendAppTransactionResultBase,
     SendAppUpdateTransactionResult,
+    SendAppUpdateTransactionResultBase,
     SendParams,
     SendSingleTransactionResult,
-    _SendAppCreateTransactionResult,
-    _SendAppTransactionResult,
-    _SendAppUpdateTransactionResult,
 )
 from algokit_utils.protocols.application import AlgorandClientProtocol
 from algokit_utils.transactions.transaction_composer import (
@@ -117,7 +117,7 @@ class AppFactoryCreateMethodCallWithSendParams(AppFactoryCreateMethodCallParams,
 
 
 @dataclass(frozen=True)
-class SendAppTransactionResultWithABIValue(_SendAppTransactionResult[ABIValue | ABIStruct | None]):
+class SendAppTransactionResultWithABIValue(SendAppTransactionResultBase[ABIValue | ABIStruct | None]):
     @classmethod
     def from_send_app_txn(
         cls, response: SendAppTransactionResult | None, abi_return: ABIValue | ABIStruct | None
@@ -131,7 +131,7 @@ def from_send_app_txn(
 
 
 @dataclass(frozen=True)
-class SendAppUpdateTransactionResultWithABIValue(_SendAppUpdateTransactionResult[ABIValue | ABIStruct | None]):
+class SendAppUpdateTransactionResultWithABIValue(SendAppUpdateTransactionResultBase[ABIValue | ABIStruct | None]):
     @classmethod
     def from_send_app_update_txn(
         cls, response: SendAppUpdateTransactionResult | None, abi_return: ABIValue | ABIStruct | None
@@ -145,7 +145,7 @@ def from_send_app_update_txn(
 
 
 @dataclass(frozen=True, kw_only=True)
-class SendAppCreateTransactionResultWithABIValue(_SendAppCreateTransactionResult[ABIValue | ABIStruct | None]):
+class SendAppCreateTransactionResultWithABIValue(SendAppCreateTransactionResultBase[ABIValue | ABIStruct | None]):
     @classmethod
     def from_send_app_create_txn(
         cls, response: SendAppCreateTransactionResult | None, abi_return: ABIValue | ABIStruct | None
@@ -180,10 +180,12 @@ def from_deploy_response(
         def set_compilation_data(response: Any, compilation_data: AppClientCompilationResult | None) -> Any:  # noqa: ANN401
             if compilation_data is None:
                 return response
-            if hasattr(response, "compiled_approval"):
-                response.compiled_approval = compilation_data.compiled_approval
-            if hasattr(response, "compiled_clear"):
-                response.compiled_clear = compilation_data.compiled_clear
+            if hasattr(response, "compiled_approval") and hasattr(compilation_data, "compiled_approval"):
+                return replace(
+                    response,
+                    compiled_approval=compilation_data.compiled_approval,
+                    compiled_clear=compilation_data.compiled_clear,
+                )
             return response
 
         def process_abi_response(
@@ -198,7 +200,7 @@ def process_abi_response(
                 return None
 
             abi_return = None
-            if isinstance(params, AppClientMethodCallParams):
+            if response_data.abi_return and hasattr(params, "method"):
                 abi_return = get_arc56_return_value(
                     response_data.abi_return,
                     get_arc56_method(params.method, app_client.app_spec),
@@ -528,8 +530,8 @@ def deploy(  # noqa: PLR0913
         self,
         *,
         deploy_time_params: TealTemplateParams | None = None,
-        on_update: OnUpdate = OnUpdate.FAIL,
-        on_schema_break: OnSchemaBreak = OnSchemaBreak.FAIL,
+        on_update: OnUpdate = OnUpdate.Fail,
+        on_schema_break: OnSchemaBreak = OnSchemaBreak.Fail,
         create_params: AppClientMethodCallParams | AppClientBareCallParams | None = None,
         update_params: AppClientMethodCallParams | AppClientBareCallParams | None = None,
         delete_params: AppClientMethodCallParams | AppClientBareCallParams | None = None,
diff --git a/src/algokit_utils/applications/utils.py b/src/algokit_utils/applications/utils.py
@@ -33,7 +33,10 @@
 T = TypeVar("T", bound=ABIValue | bytes | ABIStruct | None)
 
 
-def get_arc56_method(method_name_or_signature: str, app_spec: Arc56Contract) -> Arc56Method:
+def get_arc56_method(method_name_or_signature: str | Arc56Method, app_spec: Arc56Contract) -> Arc56Method:
+    if isinstance(method_name_or_signature, Arc56Method):
+        return method_name_or_signature
+
     if "(" not in method_name_or_signature:
         # Filter by method name
         methods = [m for m in app_spec.methods if m.name == method_name_or_signature]
diff --git a/src/algokit_utils/models/transaction.py b/src/algokit_utils/models/transaction.py
@@ -125,77 +125,80 @@ class SendSingleTransactionResult:
     def from_composer_result(cls, result: SendAtomicTransactionComposerResults, index: int = -1) -> Self:
         # Get base parameters
         base_params = {
-            "transaction": TransactionWrapper(result.transactions[index]),
+            "transaction": result.transactions[index],
             "confirmation": result.confirmations[index],
             "group_id": result.group_id,
             "tx_id": result.tx_ids[index],
             "tx_ids": result.tx_ids,
-            "transactions": result.transactions,
+            "transactions": [result.transactions[index]],
             "confirmations": result.confirmations,
             "returns": result.returns,
         }
 
         # For asset creation, extract asset_id from confirmation
         if cls is SendSingleAssetCreateTransactionResult:
-            base_params["asset_id"] = result.confirmations[index]["asset-index"]  # type: ignore[index]
+            base_params["asset_id"] = result.confirmations[index]["asset-index"]  # type: ignore[call-overload]
         # For app creation, extract app_id and calculate app_address
         elif cls is SendAppCreateTransactionResult:
-            app_id = result.confirmations[index]["application-index"]  # type: ignore[index]
+            app_id = result.confirmations[index]["application-index"]  # type: ignore[call-overload]
             base_params.update(
                 {
                     "app_id": app_id,
                     "app_address": algosdk.logic.get_application_address(app_id),
-                    "abi_return": result.returns[index] if result.returns else None,
-                    "compiled_approval": None,  # These would need to be passed in separately
-                    "compiled_clear": None,  # if needed
+                    "abi_return": result.returns[index] if result.returns else None,  # type: ignore[dict-item]
                 }
             )
         # For regular app transactions, just add abi_return
         elif cls is SendAppTransactionResult:
-            base_params["abi_return"] = result.returns[index] if result.returns else None
+            base_params["abi_return"] = result.returns[index] if result.returns else None  # type: ignore[assignment]
 
-        return cls(**base_params)
+        return cls(**base_params)  # type: ignore[arg-type]
 
 
 @dataclass(frozen=True, kw_only=True)
 class SendSingleAssetCreateTransactionResult(SendSingleTransactionResult):
     asset_id: int
 
 
-T = TypeVar("T")
+ABIReturnT = TypeVar("ABIReturnT")
 
 
 @dataclass(frozen=True)
-class _SendAppTransactionResult(Generic[T], SendSingleTransactionResult):
-    abi_return: T | None = None
-
+class SendAppTransactionResultBase(SendSingleTransactionResult, Generic[ABIReturnT]):
+    """Base class for all app transaction results with generic ABI return type"""
 
-@dataclass(frozen=True)
-class SendAppTransactionResult(_SendAppTransactionResult[ABIReturn]):
-    pass
+    abi_return: ABIReturnT | None = None
 
 
 @dataclass(frozen=True)
-class _SendAppUpdateTransactionResult(Generic[T], SendSingleTransactionResult):
-    abi_return: T | None = None
+class SendAppUpdateTransactionResultBase(SendAppTransactionResultBase[ABIReturnT]):
+    """Base class for app update transaction results"""
+
     compiled_approval: Any | None = None
     compiled_clear: Any | None = None
 
 
-@dataclass(frozen=True)
-class SendAppUpdateTransactionResult(_SendAppUpdateTransactionResult[ABIReturn]):
-    pass
-
+@dataclass(frozen=True, kw_only=True)
+class SendAppCreateTransactionResultBase(SendAppTransactionResultBase[ABIReturnT]):
+    """Base class for app create transaction results"""
 
-@dataclass(frozen=True)
-class _SendAppCreateTransactionResult(Generic[T], SendSingleTransactionResult):
     app_id: int
     app_address: str
-    abi_return: T | None = None
     compiled_approval: Any | None = None
     compiled_clear: Any | None = None
 
 
+# Concrete implementations with ABIReturn type
+@dataclass(frozen=True)
+class SendAppTransactionResult(SendAppTransactionResultBase[ABIReturn]):
+    """Standard app transaction result with ABIReturn type"""
+
+
+@dataclass(frozen=True)
+class SendAppUpdateTransactionResult(SendAppUpdateTransactionResultBase[ABIReturn]):
+    """Standard app update transaction result with ABIReturn type"""
+
+
 @dataclass(frozen=True, kw_only=True)
-class SendAppCreateTransactionResult(_SendAppCreateTransactionResult):
-    pass
+class SendAppCreateTransactionResult(SendAppCreateTransactionResultBase[ABIReturn]):
+    """Standard app create transaction result with ABIReturn type"""
diff --git a/src/algokit_utils/protocols/application.py b/src/algokit_utils/protocols/application.py
@@ -18,7 +18,7 @@
 
 
 @dataclass
-class NetworkDetails:
+class _NetworkDetails:
     genesis_id: str
     genesis_hash: str
     network_name: str
@@ -52,7 +52,7 @@ def algod(self) -> AlgodClient: ...
     @property
     def indexer(self) -> IndexerClient | None: ...
 
-    async def network(self) -> NetworkDetails: ...
+    async def network(self) -> _NetworkDetails: ...
 
     async def is_local_net(self) -> bool: ...
 
diff --git a/src/algokit_utils/transactions/transaction_composer.py b/src/algokit_utils/transactions/transaction_composer.py
@@ -19,7 +19,6 @@
 from algokit_utils._debugging import simulate_and_persist_response, simulate_response
 from algokit_utils.applications.app_manager import AppManager
 from algokit_utils.config import config
-from algokit_utils.models.state import BoxIdentifier
 from algokit_utils.models.transaction import SendAtomicTransactionComposerResults, SendParams, TransactionWrapper
 from algokit_utils.transactions.utils import encode_lease, get_abi_return_value, populate_app_call_resources
 
@@ -32,7 +31,7 @@
 
     from algokit_utils.models.abi import ABIValue
     from algokit_utils.models.amount import AlgoAmount
-    from algokit_utils.models.state import BoxReference
+    from algokit_utils.models.state import BoxIdentifier, BoxReference
     from algokit_utils.models.transaction import Arc2TransactionNote
 
 
diff --git a/tests/applications/test_app_factory.py b/tests/applications/test_app_factory.py
diff --git a/tests/transactions/test_transaction_composer.py b/tests/transactions/test_transaction_composer.py
