algokit-utils 1.3.0b1__py3-none-any.whl → 1.3.1b1__py3-none-any.whl

algokit_utils/__init__.py

@@ -63,14 +63,14 @@ from algokit_utils.models import (
     ABIMethod,
     ABITransactionResponse,
     Account,
-    CommonCallParameters,
-    CommonCallParametersDict,
+    CommonCallParameters,  # noqa: ignore[F401]
+    CommonCallParametersDict,  # noqa: ignore[F401]
     CreateCallParameters,
     CreateCallParametersDict,
     CreateTransactionParameters,
     OnCompleteCallParameters,
     OnCompleteCallParametersDict,
-    RawTransactionParameters,
+    RawTransactionParameters,  # noqa: ignore[F401]
     TransactionParameters,
     TransactionResponse,
 )
@@ -111,8 +111,6 @@ __all__ = [
     "ABICreateCallArgs",
     "ABICreateCallArgsDict",
     "ABIMethod",
-    "CommonCallParameters",
-    "CommonCallParametersDict",
     "CreateCallParameters",
     "CreateCallParametersDict",
     "CreateTransactionParameters",
@@ -122,7 +120,6 @@ __all__ = [
     "DeployCreateCallArgsDict",
     "OnCompleteCallParameters",
     "OnCompleteCallParametersDict",
-    "RawTransactionParameters",
     "TransactionParameters",
     "ApplicationClient",
     "DeployResponse",

algokit_utils/application_client.py

@@ -40,12 +40,12 @@ from algokit_utils.models import (
     ABIMethod,
     ABITransactionResponse,
     Account,
-    CommonCallParameters,
-    CommonCallParametersDict,
     CreateCallParameters,
     CreateCallParametersDict,
     OnCompleteCallParameters,
     OnCompleteCallParametersDict,
+    TransactionParameters,
+    TransactionParametersDict,
     TransactionResponse,
 )
 
@@ -372,7 +372,7 @@ class ApplicationClient:
     ) -> None:
         """Adds a signed transaction with application id == 0 and the schema and source of client's app_spec to atc"""
         approval_program, clear_program = self._check_is_compiled()
-        transaction_parameters = _convert_call_parameters(transaction_parameters)
+        transaction_parameters = _convert_transaction_parameters(transaction_parameters)
 
         extra_pages = transaction_parameters.extra_pages or num_extra_program_pages(
             approval_program.raw_binary, clear_program.raw_binary
@@ -444,7 +444,7 @@ class ApplicationClient:
         atc: AtomicTransactionComposer,
         /,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with on_complete=UpdateApplication to atc"""
@@ -464,7 +464,7 @@ class ApplicationClient:
     def update(
         self,
         call_abi_method: ABIMethod | Literal[True],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> ABITransactionResponse:
         ...
@@ -473,7 +473,7 @@ class ApplicationClient:
     def update(
         self,
         call_abi_method: Literal[False],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
     ) -> TransactionResponse:
         ...
 
@@ -481,7 +481,7 @@ class ApplicationClient:
     def update(
         self,
         call_abi_method: ABIMethod | bool | None = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         ...
@@ -489,7 +489,7 @@ class ApplicationClient:
     def update(
         self,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with on_complete=UpdateApplication"""
@@ -508,7 +508,7 @@ class ApplicationClient:
         atc: AtomicTransactionComposer,
         /,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with on_complete=DeleteApplication to atc"""
@@ -525,7 +525,7 @@ class ApplicationClient:
     def delete(
         self,
         call_abi_method: ABIMethod | Literal[True],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> ABITransactionResponse:
         ...
@@ -534,7 +534,7 @@ class ApplicationClient:
     def delete(
         self,
         call_abi_method: Literal[False],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
     ) -> TransactionResponse:
         ...
 
@@ -542,7 +542,7 @@ class ApplicationClient:
     def delete(
         self,
         call_abi_method: ABIMethod | bool | None = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         ...
@@ -550,7 +550,7 @@ class ApplicationClient:
     def delete(
         self,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with on_complete=DeleteApplication"""
@@ -573,7 +573,7 @@ class ApplicationClient:
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with specified parameters to atc"""
-        _parameters = _convert_call_parameters(transaction_parameters)
+        _parameters = _convert_transaction_parameters(transaction_parameters)
         self.add_method_call(
             atc,
             abi_method=call_abi_method,
@@ -616,7 +616,7 @@ class ApplicationClient:
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with specified parameters"""
         atc = AtomicTransactionComposer()
-        _parameters = _convert_call_parameters(transaction_parameters)
+        _parameters = _convert_transaction_parameters(transaction_parameters)
         self.compose_call(
             atc,
             call_abi_method=call_abi_method,
@@ -639,7 +639,7 @@ class ApplicationClient:
         atc: AtomicTransactionComposer,
         /,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with on_complete=OptIn to atc"""
@@ -655,7 +655,7 @@ class ApplicationClient:
     def opt_in(
         self,
         call_abi_method: ABIMethod | Literal[True] = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> ABITransactionResponse:
         ...
@@ -664,7 +664,7 @@ class ApplicationClient:
     def opt_in(
         self,
         call_abi_method: Literal[False] = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
     ) -> TransactionResponse:
         ...
 
@@ -672,7 +672,7 @@ class ApplicationClient:
     def opt_in(
         self,
         call_abi_method: ABIMethod | bool | None = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         ...
@@ -680,7 +680,7 @@ class ApplicationClient:
     def opt_in(
         self,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with on_complete=OptIn"""
@@ -698,7 +698,7 @@ class ApplicationClient:
         atc: AtomicTransactionComposer,
         /,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with on_complete=CloseOut to ac"""
@@ -714,7 +714,7 @@ class ApplicationClient:
     def close_out(
         self,
         call_abi_method: ABIMethod | Literal[True],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> ABITransactionResponse:
         ...
@@ -723,7 +723,7 @@ class ApplicationClient:
     def close_out(
         self,
         call_abi_method: Literal[False],
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
     ) -> TransactionResponse:
         ...
 
@@ -731,7 +731,7 @@ class ApplicationClient:
     def close_out(
         self,
         call_abi_method: ABIMethod | bool | None = ...,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = ...,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         ...
@@ -739,7 +739,7 @@ class ApplicationClient:
     def close_out(
         self,
         call_abi_method: ABIMethod | bool | None = None,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         **abi_kwargs: ABIArgType,
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with on_complete=CloseOut"""
@@ -756,7 +756,7 @@ class ApplicationClient:
         self,
         atc: AtomicTransactionComposer,
         /,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         app_args: list[bytes] | None = None,
     ) -> None:
         """Adds a signed transaction with on_complete=ClearState to atc"""
@@ -769,7 +769,7 @@ class ApplicationClient:
 
     def clear_state(
         self,
-        transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        transaction_parameters: TransactionParameters | TransactionParametersDict | None = None,
         app_args: list[bytes] | None = None,
     ) -> TransactionResponse:
         """Submits a signed transaction with on_complete=ClearState"""
@@ -999,7 +999,7 @@ class ApplicationClient:
         *,
         abi_args: ABIArgsDict | None = None,
         app_id: int | None = None,
-        parameters: CommonCallParameters | CommonCallParametersDict | None = None,
+        parameters: TransactionParameters | TransactionParametersDict | None = None,
         on_complete: transaction.OnComplete = transaction.OnComplete.NoOpOC,
         local_schema: transaction.StateSchema | None = None,
         global_schema: transaction.StateSchema | None = None,
@@ -1013,7 +1013,7 @@ class ApplicationClient:
         if app_id is None:
             self._load_reference_and_check_app_id()
             app_id = self.app_id
-        parameters = _convert_call_parameters(parameters)
+        parameters = _convert_transaction_parameters(parameters)
         method = self._resolve_method(abi_method, abi_args, on_complete, call_config)
         sp = parameters.suggested_params or self.suggested_params or self.algod_client.suggested_params()
         signer, sender = self.resolve_signer_sender(parameters.signer, parameters.sender)
@@ -1283,8 +1283,10 @@ def execute_atc_with_logic_error(
         raise ex
 
 
-def _convert_call_parameters(args: CommonCallParameters | CommonCallParametersDict | None) -> CreateCallParameters:
-    _args = args.__dict__ if isinstance(args, CommonCallParameters) else (args or {})
+def _convert_transaction_parameters(
+    args: TransactionParameters | TransactionParametersDict | None,
+) -> CreateCallParameters:
+    _args = args.__dict__ if isinstance(args, TransactionParameters) else (args or {})
     return CreateCallParameters(**_args)
 
 

algokit_utils/models.py

@@ -12,6 +12,21 @@ from algosdk.atomic_transaction_composer import (
     TransactionSigner,
 )
 from algosdk.encoding import decode_address
+from deprecated import deprecated
+
+__all__ = [
+    "ABIArgsDict",
+    "ABIMethod",
+    "ABITransactionResponse",
+    "Account",
+    "CreateCallParameters",
+    "CreateCallParametersDict",
+    "CreateTransactionParameters",
+    "OnCompleteCallParameters",
+    "OnCompleteCallParametersDict",
+    "TransactionParameters",
+    "TransactionResponse",
+]
 
 ReturnType = TypeVar("ReturnType")
 
@@ -115,75 +130,104 @@ ABIMethod: TypeAlias = ABIReturnSubroutine | Method | str
 
 @dataclasses.dataclass(kw_only=True)
 class TransactionParameters:
-    """Transaction parameters that can be used on ABI and non-ABI calls"""
+    """Additional parameters that can be included in a transaction"""
 
     signer: TransactionSigner | None = None
+    """Signer to use when signing this transaction"""
     sender: str | None = None
+    """Sender of this transaction"""
     suggested_params: transaction.SuggestedParams | None = None
+    """SuggestedParams to use for this transaction"""
     note: bytes | str | None = None
+    """Note for this transaction"""
     lease: bytes | str | None = None
+    """Lease value for this transaction"""
     boxes: Sequence[tuple[int, bytes | bytearray | str | int]] | None = None
-
-
-@dataclasses.dataclass(kw_only=True)
-class CreateTransactionParameters(TransactionParameters):
-    """Transaction parameters that can be used on ABI and non-ABI create calls"""
-
-    extra_pages: int | None = None
-
-
-@dataclasses.dataclass(kw_only=True)
-class RawTransactionParameters(TransactionParameters):
-    """Transaction parameters that can be used on non-ABI calls"""
-
+    """Box references to include in transaction. A sequence of (app id, box key) tuples"""
     accounts: list[str] | None = None
+    """Accounts to include in transaction"""
     foreign_apps: list[int] | None = None
+    """List of foreign apps (by app id) to include in transaction"""
     foreign_assets: list[int] | None = None
+    """List of foreign assets (by asset id) to include in transaction"""
+    rekey_to: str | None = None
+    """Address to rekey to"""
 
 
+# CreateTransactionParameters is used by algokit-client-generator clients
 @dataclasses.dataclass(kw_only=True)
-class CommonCallParameters(RawTransactionParameters):
-    """Transaction parameters used when making update, delete, opt_in, close_out or clear_state calls"""
+class CreateTransactionParameters(TransactionParameters):
+    """Additional parameters that can be included in a transaction when calling a create method"""
 
-    rekey_to: str | None = None
+    extra_pages: int | None = None
 
 
 @dataclasses.dataclass(kw_only=True)
-class OnCompleteCallParameters(CommonCallParameters):
-    """Transaction parameters used when making any call to an Application"""
+class OnCompleteCallParameters(TransactionParameters):
+    """Additional parameters that can be included in a transaction when using the
+    ApplicationClient.call/compose_call methods"""
 
     on_complete: transaction.OnComplete | None = None
 
 
 @dataclasses.dataclass(kw_only=True)
 class CreateCallParameters(OnCompleteCallParameters):
-    """Transaction parameters used when making a create call for Application"""
+    """Additional parameters that can be included in a transaction when using the
+    ApplicationClient.create/compose_create methods"""
 
     extra_pages: int | None = None
 
 
-class CommonCallParametersDict(TypedDict, total=False):
-    """Common transaction parameters used when making update, delete, opt_in, close_out or clear_state calls"""
+class TransactionParametersDict(TypedDict, total=False):
+    """Additional parameters that can be included in a transaction"""
 
     signer: TransactionSigner
+    """Signer to use when signing this transaction"""
     sender: str
+    """Sender of this transaction"""
     suggested_params: transaction.SuggestedParams
+    """SuggestedParams to use for this transaction"""
     note: bytes | str
+    """Note for this transaction"""
     lease: bytes | str
+    """Lease value for this transaction"""
+    boxes: Sequence[tuple[int, bytes | bytearray | str | int]]
+    """Box references to include in transaction. A sequence of (app id, box key) tuples"""
     accounts: list[str]
+    """Accounts to include in transaction"""
     foreign_apps: list[int]
+    """List of foreign apps (by app id) to include in transaction"""
     foreign_assets: list[int]
-    boxes: Sequence[tuple[int, bytes | bytearray | str | int]]
+    """List of foreign assets (by asset id) to include in transaction"""
     rekey_to: str
+    """Address to rekey to"""
 
 
-class OnCompleteCallParametersDict(TypedDict, CommonCallParametersDict, total=False):
-    """Transaction parameters used when making any call to an Application"""
+class OnCompleteCallParametersDict(TypedDict, TransactionParametersDict, total=False):
+    """Additional parameters that can be included in a transaction when using the
+    ApplicationClient.call/compose_call methods"""
 
     on_complete: transaction.OnComplete
 
 
 class CreateCallParametersDict(TypedDict, OnCompleteCallParametersDict, total=False):
-    """Transaction parameters used when making a create call for Application"""
+    """Additional parameters that can be included in a transaction when using the
+    ApplicationClient.create/compose_create methods"""
 
     extra_pages: int
+
+
+# Pre 1.3.1 backwards compatibility
+@deprecated(reason="Use TransactionParameters instead", version="1.3.1")
+class RawTransactionParameters(TransactionParameters):
+    """Deprecated, use TransactionParameters instead"""
+
+
+@deprecated(reason="Use TransactionParameters instead", version="1.3.1")
+class CommonCallParameters(TransactionParameters):
+    """Deprecated, use TransactionParameters instead"""
+
+
+@deprecated(reason="Use TransactionParametersDict instead", version="1.3.1")
+class CommonCallParametersDict(TransactionParametersDict):
+    """Deprecated, use TransactionParametersDict instead"""

{algokit_utils-1.3.0b1.dist-info → algokit_utils-1.3.1b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: algokit-utils
-Version: 1.3.0b1
+Version: 1.3.1b1
 Summary: Utilities for Algorand development for use by AlgoKit
 License: MIT
 Author: Algorand Foundation
@@ -10,6 +10,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: deprecated (>=1.2.14,<2.0.0)
 Requires-Dist: py-algorand-sdk (>=2.2.0,<3.0.0)
 Description-Content-Type: text/markdown
 

{algokit_utils-1.3.0b1.dist-info → algokit_utils-1.3.1b1.dist-info}/RECORD

@@ -1,16 +1,16 @@
-algokit_utils/__init__.py,sha256=Ko-gEPeER-Ho8lRU_a6k5SsV3mTfZa6CP1I9dmZjQvk,4159
+algokit_utils/__init__.py,sha256=8_zT0ryHuEi7Vn51LRjNPCnq6wXL6er5x_tvGPg8ZLo,4133
 algokit_utils/_ensure_funded.py,sha256=DjwGnCC_6USLQV5wIMJZRVQFlQ1uLrGDMxRF471atsQ,4410
 algokit_utils/_simulate_315_compat.py,sha256=9qCsNnKa1FXYfCccMFiE0mGEcZJiBuPmUy7ZRvvUSqU,2841
 algokit_utils/_transfer.py,sha256=K8TMoaFcZE74xZ1rhp1De0Ri4mg8vs8pu-iJLOa5WoE,3569
 algokit_utils/account.py,sha256=UIuOQZe28pQxjEP9TzhtYlOU20tUdzzS-nIIZM9Bp6Y,7364
-algokit_utils/application_client.py,sha256=k3eTyhY3zyfpajHffo1uJ2u1C0vlYPmdALl5jmgH1WM,56488
+algokit_utils/application_client.py,sha256=4_NM-RJYMCRCS4_4xFeG68yYvgTJRC1_y9mSCgYHSR4,56581
 algokit_utils/application_specification.py,sha256=XusOe7VrGPun2UoNspC9Ei202NzPkxRNx5USXiABuXc,7466
 algokit_utils/deploy.py,sha256=sY6u0T39DuF6oLpal0eJAc76EmjPWdoCPk2OSKGccnM,34650
 algokit_utils/logic_error.py,sha256=8O_4rJ1t57JEG81ucRNih2ojc1-EOm2fVxW6m-1ZXI8,2550
-algokit_utils/models.py,sha256=75tWWa3W-37Om3YgkcuKiuHAGzMkFIJ9U-eHO29RPi4,6319
+algokit_utils/models.py,sha256=KynZnM2YbOyTgr2NCT8CA-cYrO0eiyK6u48eeAzj82I,8246
 algokit_utils/network_clients.py,sha256=KmuSHG2kSdJfo9W4pIB_4RjnBL2yMQNGlF54lxXTnsQ,5267
 algokit_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-algokit_utils-1.3.0b1.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
-algokit_utils-1.3.0b1.dist-info/METADATA,sha256=75vQhThgjoQUr2xDl-t--FnVEl9bHz7kAs7LS4jVwns,2072
-algokit_utils-1.3.0b1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-algokit_utils-1.3.0b1.dist-info/RECORD,,
+algokit_utils-1.3.1b1.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
+algokit_utils-1.3.1b1.dist-info/METADATA,sha256=qJ1Che639w5ftvOOakseRd2P8UxuKfCSGkLdpva6RlE,2116
+algokit_utils-1.3.1b1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+algokit_utils-1.3.1b1.dist-info/RECORD,,