algokit-utils 2.2.2b5__py3-none-any.whl → 2.3.0__py3-none-any.whl

algokit_utils/deploy.py

@@ -23,7 +23,6 @@ from algokit_utils.models import (
     ABIMethod,
     Account,
     CreateCallParameters,
-    TransactionParameters,
     TransactionResponse,
 )
 
@@ -725,7 +724,7 @@ class Deployer:
     def _create_app(self) -> DeployResponse:
         assert self.app_client.existing_deployments
 
-        method, abi_args, parameters = _convert_create_deploy_args(
+        method, abi_args, parameters = _convert_deploy_args(
             self.create_args, self.new_app_metadata, self.signer, self.sender
         )
         create_response = self.app_client.create(
@@ -752,7 +751,7 @@ class Deployer:
             f"{self.new_app_metadata.name} ({self.new_app_metadata.version}) in {self.creator} account."
         )
         atc = AtomicTransactionComposer()
-        create_method, create_abi_args, create_parameters = _convert_create_deploy_args(
+        create_method, create_abi_args, create_parameters = _convert_deploy_args(
             self.create_args, self.new_app_metadata, self.signer, self.sender
         )
         self.app_client.compose_create(
@@ -851,10 +850,11 @@ def _convert_deploy_args(
     note: AppDeployMetaData,
     signer: TransactionSigner | None,
     sender: str | None,
-) -> tuple[ABIMethod | bool | None, ABIArgsDict, TransactionParameters]:
+) -> tuple[ABIMethod | bool | None, ABIArgsDict, CreateCallParameters]:
     args = _args.__dict__ if isinstance(_args, DeployCallArgs) else (_args or {})
 
-    parameters = TransactionParameters(
+    # return most derived type, unused parameters are ignored
+    parameters = CreateCallParameters(
         note=note.encode(),
         signer=signer,
         sender=sender,
@@ -865,25 +865,11 @@ def _convert_deploy_args(
         foreign_apps=args.get("foreign_apps"),
         boxes=args.get("boxes"),
         rekey_to=args.get("rekey_to"),
-    )
-
-    return args.get("method"), args.get("args") or {}, parameters
-
-
-def _convert_create_deploy_args(
-    _args: DeployCallArgs | DeployCallArgsDict | None,
-    note: AppDeployMetaData,
-    signer: TransactionSigner | None,
-    sender: str | None,
-) -> tuple[ABIMethod | bool | None, ABIArgsDict, CreateCallParameters]:
-    method, args, parameters = _convert_deploy_args(_args, note, signer, sender)
-    create_parameters = CreateCallParameters(
-        **parameters.__dict__,
         extra_pages=args.get("extra_pages"),
         on_complete=args.get("on_complete"),
     )
 
-    return method, args, create_parameters
+    return args.get("method"), args.get("args") or {}, parameters
 
 
 def get_app_id_from_tx_id(algod_client: "AlgodClient", tx_id: str) -> int:

algokit_utils/models.py

@@ -155,86 +155,25 @@ class TransactionParameters:
 
 # CreateTransactionParameters is used by algokit-client-generator clients
 @dataclasses.dataclass(kw_only=True)
-class CreateTransactionParameters:
+class CreateTransactionParameters(TransactionParameters):
     """Additional parameters that can be included in a transaction when calling a create method"""
 
-    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
-    """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"""
     extra_pages: int | None = None
 
 
 @dataclasses.dataclass(kw_only=True)
-class OnCompleteCallParameters:
+class OnCompleteCallParameters(TransactionParameters):
     """Additional parameters that can be included in a transaction when using the
     ApplicationClient.call/compose_call methods"""
 
-    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
-    """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"""
     on_complete: transaction.OnComplete | None = None
 
 
 @dataclasses.dataclass(kw_only=True)
-class CreateCallParameters:
+class CreateCallParameters(OnCompleteCallParameters):
     """Additional parameters that can be included in a transaction when using the
     ApplicationClient.create/compose_create methods"""
 
-    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
-    """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"""
-    on_complete: transaction.OnComplete | None = None
     extra_pages: int | None = None
 
 
@@ -263,58 +202,17 @@ class TransactionParametersDict(TypedDict, total=False):
     """Address to rekey to"""
 
 
-class OnCompleteCallParametersDict(TypedDict, total=False):
+class OnCompleteCallParametersDict(TypedDict, TransactionParametersDict, total=False):
     """Additional parameters that can be included in a transaction when using the
     ApplicationClient.call/compose_call methods"""
 
-    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]
-    """List of foreign assets (by asset id) to include in transaction"""
-    rekey_to: str
-    """Address to rekey to"""
     on_complete: transaction.OnComplete
 
 
-class CreateCallParametersDict(TypedDict, total=False):
+class CreateCallParametersDict(TypedDict, OnCompleteCallParametersDict, total=False):
     """Additional parameters that can be included in a transaction when using the
     ApplicationClient.create/compose_create methods"""
 
-    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]
-    """List of foreign assets (by asset id) to include in transaction"""
-    rekey_to: str
-    """Address to rekey to"""
-    on_complete: transaction.OnComplete
     extra_pages: int
 
 

algokit_utils/network_clients.py

@@ -18,6 +18,8 @@ __all__ = [
     "is_localnet",
     "is_mainnet",
     "is_testnet",
+    "AlgoClientConfigs",
+    "get_kmd_client",
 ]
 
 _PURE_STAKE_HOST = "purestake.io"
@@ -34,6 +36,13 @@ class AlgoClientConfig:
     """API Token to authenticate with the service"""
 
 
+@dataclasses.dataclass
+class AlgoClientConfigs:
+    algod_config: AlgoClientConfig
+    indexer_config: AlgoClientConfig
+    kmd_config: AlgoClientConfig | None
+
+
 def get_default_localnet_config(config: Literal["algod", "indexer", "kmd"]) -> AlgoClientConfig:
     """Returns the client configuration to point to the default LocalNet"""
     port = {"algod": 4001, "indexer": 8980, "kmd": 4002}[config]
@@ -69,6 +78,14 @@ def get_algod_client(config: AlgoClientConfig | None = None) -> AlgodClient:
     return AlgodClient(config.token, config.server, headers)
 
 
+def get_kmd_client(config: AlgoClientConfig | None = None) -> KMDClient:
+    """Returns an {py:class}`algosdk.kmd.KMDClient` from `config` or environment
+
+    If no configuration provided will use environment variables `KMD_SERVER`, `KMD_PORT` and `KMD_TOKEN`"""
+    config = config or _get_config_from_environment("KMD")
+    return KMDClient(config.token, config.server)  # type: ignore[no-untyped-call]
+
+
 def get_indexer_client(config: AlgoClientConfig | None = None) -> IndexerClient:
     """Returns an {py:class}`algosdk.v2client.indexer.IndexerClient` from `config` or environment.
 

{algokit_utils-2.2.2b5.dist-info → algokit_utils-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: algokit-utils
-Version: 2.2.2b5
+Version: 2.3.0
 Summary: Utilities for Algorand development for use by AlgoKit
 License: MIT
 Author: Algorand Foundation

algokit_utils-2.3.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+algokit_utils/__init__.py,sha256=yeufbE_5wjRILZs_10UD5B3_sjdwAfPXskdFKskzXhg,4963
+algokit_utils/_debugging.py,sha256=4UC5NZGqxF32y742TUB34rX9kWaObXCCPOs-lbkQjGQ,10732
+algokit_utils/_ensure_funded.py,sha256=ZdEdUB43QGIQrg7cSSgNrDmWaLSUhli9x9I6juwKfgo,6786
+algokit_utils/_transfer.py,sha256=R9q8RoMHiwtqcwQjuGHEluMxIzmYqAsI5WrTsQd24Ds,6021
+algokit_utils/account.py,sha256=UIuOQZe28pQxjEP9TzhtYlOU20tUdzzS-nIIZM9Bp6Y,7364
+algokit_utils/application_client.py,sha256=xOZJ8i3y8wDJL0Uvaw1o-UmJKvSmbv8ib5RwGl4ar0w,58661
+algokit_utils/application_specification.py,sha256=XusOe7VrGPun2UoNspC9Ei202NzPkxRNx5USXiABuXc,7466
+algokit_utils/asset.py,sha256=jsc7T1dH9HZA3Yve2gRLObwUlK6xLDoQz0NxLLnqaGs,7216
+algokit_utils/beta/account_manager.py,sha256=dSb-jpBAWRfmKFYzG6T8t5vkh6ysX2NkZXl5UcZY5WA,8015
+algokit_utils/beta/algorand_client.py,sha256=y1CYYn_ADwgOLTVID9BFMvdubDgKqUfx9R6XH3PrzsA,12649
+algokit_utils/beta/client_manager.py,sha256=rW58VVBdYAV_5QwXNyt3VMP8NGon_IRhq1Dr35Mp31g,3117
+algokit_utils/beta/composer.py,sha256=qpIWQ6Xeysk1FzqW8AntHJ_go_W2qIEDB4uvGFOOdgM,28627
+algokit_utils/common.py,sha256=K6-3_9dv2clDn0WMYb8AWE_N46kWWIXglZIPfHIowDs,812
+algokit_utils/config.py,sha256=oY3o1kPzVPRiQH--f4HzrMMNPojT078CSudqS9WQaEc,4279
+algokit_utils/deploy.py,sha256=ydE3QSq1lRkjXQC9zdFclywx8q1UgV9l-l3Mx-shbHg,34668
+algokit_utils/dispenser_api.py,sha256=BpwEhKDig6qz54wbO-htG8hmLxFIrvdzXpESUb7Y1zw,5584
+algokit_utils/logic_error.py,sha256=YeE70qHZ6WBeoKCXqnto3uBg8R4ODXiNZkLmfEmASQo,2617
+algokit_utils/models.py,sha256=GWpZQ2bTGfkldM12VZntGlVJTFBTtWf5SM7ZYXC_LHE,8238
+algokit_utils/network_clients.py,sha256=O4nJ3ECms4hFbuB1X64nzTMNOfK1Uj2oyjKxeieri-g,5929
+algokit_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+algokit_utils-2.3.0.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
+algokit_utils-2.3.0.dist-info/METADATA,sha256=jAqL6L3gHaVkXH9jzsWn7o9JePrVCTstcLhP3c8heqk,2205
+algokit_utils-2.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+algokit_utils-2.3.0.dist-info/RECORD,,

algokit_utils-2.2.2b5.dist-info/RECORD

@@ -1,20 +0,0 @@
-algokit_utils/__init__.py,sha256=yeufbE_5wjRILZs_10UD5B3_sjdwAfPXskdFKskzXhg,4963
-algokit_utils/_debugging.py,sha256=4UC5NZGqxF32y742TUB34rX9kWaObXCCPOs-lbkQjGQ,10732
-algokit_utils/_ensure_funded.py,sha256=ZdEdUB43QGIQrg7cSSgNrDmWaLSUhli9x9I6juwKfgo,6786
-algokit_utils/_transfer.py,sha256=CyXGOR_Zy-2crQhk-78uUbB8Sj_ZeTzxPwOAHU7wwno,5947
-algokit_utils/account.py,sha256=UIuOQZe28pQxjEP9TzhtYlOU20tUdzzS-nIIZM9Bp6Y,7364
-algokit_utils/application_client.py,sha256=qylA2aI4Ecs532bIs6fyc6FgLnWey9PBzZBZW_jnYtk,59092
-algokit_utils/application_specification.py,sha256=XusOe7VrGPun2UoNspC9Ei202NzPkxRNx5USXiABuXc,7466
-algokit_utils/asset.py,sha256=jsc7T1dH9HZA3Yve2gRLObwUlK6xLDoQz0NxLLnqaGs,7216
-algokit_utils/common.py,sha256=K6-3_9dv2clDn0WMYb8AWE_N46kWWIXglZIPfHIowDs,812
-algokit_utils/config.py,sha256=oY3o1kPzVPRiQH--f4HzrMMNPojT078CSudqS9WQaEc,4279
-algokit_utils/deploy.py,sha256=BxIFPtZd1lO8o_JmQQDIKk0O93E_bE-ZzglEWXwbefw,35110
-algokit_utils/dispenser_api.py,sha256=BpwEhKDig6qz54wbO-htG8hmLxFIrvdzXpESUb7Y1zw,5584
-algokit_utils/logic_error.py,sha256=YeE70qHZ6WBeoKCXqnto3uBg8R4ODXiNZkLmfEmASQo,2617
-algokit_utils/models.py,sha256=iJUiV6eLq5N_FKki4X5ll5rYQslU_wSPiSTtl61Z1CI,12803
-algokit_utils/network_clients.py,sha256=sj5y_g5uclddWCEyUCptA-KjWuAtLV06hZH4QIGM1yE,5313
-algokit_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-algokit_utils-2.2.2b5.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
-algokit_utils-2.2.2b5.dist-info/METADATA,sha256=8mkuN9VkBEa_Z2oH1GmzccM-SH63NFZmlBsXxc5CHQ4,2207
-algokit_utils-2.2.2b5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-algokit_utils-2.2.2b5.dist-info/RECORD,,