algokit-utils 2.3.0b2__py3-none-any.whl → 2.3.1__py3-none-any.whl

algokit_utils/__init__.py

@@ -88,7 +88,6 @@ from algokit_utils.network_clients import (
     get_default_localnet_config,
     get_indexer_client,
     get_kmd_client_from_algod_client,
-    get_purestake_config,
     is_localnet,
     is_mainnet,
     is_testnet,
@@ -160,7 +159,6 @@ __all__ = [
     "get_default_localnet_config",
     "get_indexer_client",
     "get_kmd_client_from_algod_client",
-    "get_purestake_config",
     "is_localnet",
     "is_mainnet",
     "is_testnet",

algokit_utils/application_client.py

@@ -1,6 +1,5 @@
 import base64
 import copy
-import dataclasses
 import json
 import logging
 import re
@@ -50,6 +49,7 @@ from algokit_utils.models import (
     CreateCallParametersDict,
     OnCompleteCallParameters,
     OnCompleteCallParametersDict,
+    SimulationTrace,
     TransactionParameters,
     TransactionParametersDict,
     TransactionResponse,
@@ -59,6 +59,7 @@ if typing.TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient
     from algosdk.v2client.indexer import IndexerClient
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -375,7 +376,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_transaction_parameters(CreateCallParameters, 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
@@ -388,7 +389,7 @@ class ApplicationClient:
             abi_args=abi_kwargs,
             on_complete=transaction_parameters.on_complete or transaction.OnComplete.NoOpOC,
             call_config=au_spec.CallConfig.CREATE,
-            parameters=_convert_transaction_parameters(TransactionParameters, transaction_parameters),
+            parameters=transaction_parameters,
             approval_program=approval_program.raw_binary,
             clear_program=clear_program.raw_binary,
             global_schema=self.app_spec.global_state_schema,
@@ -567,12 +568,12 @@ class ApplicationClient:
         **abi_kwargs: ABIArgType,
     ) -> None:
         """Adds a signed transaction with specified parameters to atc"""
-        _parameters = _convert_transaction_parameters(OnCompleteCallParameters, transaction_parameters)
+        _parameters = _convert_transaction_parameters(transaction_parameters)
         self.add_method_call(
             atc,
             abi_method=call_abi_method,
             abi_args=abi_kwargs,
-            parameters=_convert_transaction_parameters(TransactionParameters, transaction_parameters),
+            parameters=_parameters,
             on_complete=_parameters.on_complete or transaction.OnComplete.NoOpOC,
         )
 
@@ -607,7 +608,7 @@ class ApplicationClient:
     ) -> TransactionResponse | ABITransactionResponse:
         """Submits a signed transaction with specified parameters"""
         atc = AtomicTransactionComposer()
-        _parameters = _convert_transaction_parameters(OnCompleteCallParameters, transaction_parameters)
+        _parameters = _convert_transaction_parameters(transaction_parameters)
         self.compose_call(
             atc,
             call_abi_method=call_abi_method,
@@ -1003,7 +1004,7 @@ class ApplicationClient:
         if app_id is None:
             self._load_reference_and_check_app_id()
             app_id = self.app_id
-        parameters = _convert_transaction_parameters(TransactionParameters, 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)
@@ -1236,7 +1237,7 @@ def _try_convert_to_logic_error(
     source_ex: Exception | str,
     approval_program: str,
     approval_source_map: SourceMap | typing.Callable[[], SourceMap | None] | None = None,
-    simulate_traces: list | None = None,
+    simulate_traces: list[SimulationTrace] | None = None,
 ) -> Exception | None:
     source_ex_str = str(source_ex)
     logic_error_data = parse_logic_error(source_ex_str)
@@ -1297,7 +1298,7 @@ def execute_atc_with_logic_error(
         raise ex
 
 
-def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list[dict[str, Any]]:
+def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list[SimulationTrace]:
     traces = []
     if hasattr(simulate, "simulate_response") and hasattr(simulate, "failed_at") and simulate.failed_at:
         for txn_group in simulate.simulate_response["txn-groups"]:
@@ -1307,28 +1308,21 @@ def _create_simulate_traces(simulate: SimulateAtomicTransactionResponse) -> list
             txn_result = txn_group.get("txn-results", [{}])[0]
             exec_trace = txn_result.get("exec-trace", {})
             traces.append(
-                {
-                    "app-budget-added": app_budget_added,
-                    "app-budget-consumed": app_budget_consumed,
-                    "failure-message": failure_message,
-                    "exec-trace": exec_trace,
-                }
+                SimulationTrace(
+                    app_budget_added=app_budget_added,
+                    app_budget_consumed=app_budget_consumed,
+                    failure_message=failure_message,
+                    exec_trace=exec_trace,
+                )
             )
     return traces
 
 
-_TParams = typing.TypeVar("_TParams", TransactionParameters, OnCompleteCallParameters, CreateCallParameters)
-
-
 def _convert_transaction_parameters(
-    cls: type[_TParams],
-    args: object | None,
-) -> _TParams:
-    if args is None:
-        return cls()
-    args_dict = args.__dict__ if not isinstance(args, dict) else (args or {})
-    _args = {f.name: args_dict[f.name] for f in dataclasses.fields(cls) if f.name in args_dict}
-    return cls(**_args)
+    args: TransactionParameters | TransactionParametersDict | None,
+) -> CreateCallParameters:
+    _args = args.__dict__ if isinstance(args, TransactionParameters) else (args or {})
+    return CreateCallParameters(**_args)
 
 
 def get_sender_from_signer(signer: TransactionSigner | None) -> str | None:

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/logic_error.py

@@ -2,6 +2,8 @@ import re
 from copy import copy
 from typing import TYPE_CHECKING, TypedDict
 
+from algokit_utils.models import SimulationTrace
+
 if TYPE_CHECKING:
     from algosdk.source_map import SourceMap as AlgoSourceMap
 
@@ -46,7 +48,7 @@ class LogicError(Exception):
         message: str,
         pc: int,
         logic_error: Exception | None = None,
-        traces: list | None = None,
+        traces: list[SimulationTrace] | None = None,
     ):
         self.logic_error = logic_error
         self.logic_error_str = logic_error_str

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
 
 
@@ -332,3 +230,11 @@ class CommonCallParameters(TransactionParameters):
 @deprecated(reason="Use TransactionParametersDict instead", version="1.3.1")
 class CommonCallParametersDict(TransactionParametersDict):
     """Deprecated, use TransactionParametersDict instead"""
+
+
+@dataclasses.dataclass
+class SimulationTrace:
+    app_budget_added: int | None
+    app_budget_consumed: int | None
+    failure_message: str | None
+    exec_trace: dict[str, object]

algokit_utils/network_clients.py

@@ -14,7 +14,6 @@ __all__ = [
     "get_default_localnet_config",
     "get_indexer_client",
     "get_kmd_client_from_algod_client",
-    "get_purestake_config",
     "is_localnet",
     "is_mainnet",
     "is_testnet",
@@ -22,8 +21,6 @@ __all__ = [
     "get_kmd_client",
 ]
 
-_PURE_STAKE_HOST = "purestake.io"
-
 
 @dataclasses.dataclass
 class AlgoClientConfig:
@@ -59,22 +56,12 @@ def get_algonode_config(
     )
 
 
-def get_purestake_config(
-    network: Literal["testnet", "mainnet"], config: Literal["algod", "indexer"], token: str
-) -> AlgoClientConfig:
-    client = "ps2" if config == "algod" else "idx2"
-    return AlgoClientConfig(
-        server=f"https://{network}-algorand.api.purestake.io/{client}",
-        token=token,
-    )
-
-
 def get_algod_client(config: AlgoClientConfig | None = None) -> AlgodClient:
     """Returns an {py:class}`algosdk.v2client.algod.AlgodClient` from `config` or environment
 
     If no configuration provided will use environment variables `ALGOD_SERVER`, `ALGOD_PORT` and `ALGOD_TOKEN`"""
     config = config or _get_config_from_environment("ALGOD")
-    headers = _get_headers(config, "X-Algo-API-Token")
+    headers = {"X-Algo-API-Token": config.token}
     return AlgodClient(config.token, config.server, headers)
 
 
@@ -91,7 +78,7 @@ def get_indexer_client(config: AlgoClientConfig | None = None) -> IndexerClient:
 
     If no configuration provided will use environment variables `INDEXER_SERVER`, `INDEXER_PORT` and `INDEXER_TOKEN`"""
     config = config or _get_config_from_environment("INDEXER")
-    headers = _get_headers(config, "X-Indexer-API-Token")
+    headers = {"X-Indexer-API-Token": config.token}
     return IndexerClient(config.token, config.server, headers)  # type: ignore[no-untyped-call]
 
 
@@ -141,14 +128,3 @@ def _get_config_from_environment(environment_prefix: str) -> AlgoClientConfig:
         parsed = parse.urlparse(server)
         server = parsed._replace(netloc=f"{parsed.hostname}:{port}").geturl()
     return AlgoClientConfig(server, os.getenv(f"{environment_prefix}_TOKEN", ""))
-
-
-def _is_pure_stake_url(url: str) -> bool:
-    parsed = parse.urlparse(url)
-    host = parsed.netloc.split(":")[0].lower()
-    return host.endswith(_PURE_STAKE_HOST)
-
-
-def _get_headers(config: AlgoClientConfig, default_auth_header: str) -> dict[str, str] | None:
-    auth_header = "X-API-Key" if _is_pure_stake_url(config.server) else default_auth_header
-    return {auth_header: config.token}

{algokit_utils-2.3.0b2.dist-info → algokit_utils-2.3.1.dist-info}/METADATA

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

{algokit_utils-2.3.0b2.dist-info → algokit_utils-2.3.1.dist-info}/RECORD

@@ -1,9 +1,9 @@
-algokit_utils/__init__.py,sha256=yeufbE_5wjRILZs_10UD5B3_sjdwAfPXskdFKskzXhg,4963
+algokit_utils/__init__.py,sha256=Xc9NVy3cETI2qzbkkAea2YrZ9-CLtZLHnuS1UHQ13wQ,4909
 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=qylA2aI4Ecs532bIs6fyc6FgLnWey9PBzZBZW_jnYtk,59092
+algokit_utils/application_client.py,sha256=rBV5QnMJ8wBwfV6KCz5QS9dtI97aF61a0TGPy2ZnEu0,58703
 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
@@ -12,13 +12,13 @@ algokit_utils/beta/client_manager.py,sha256=rW58VVBdYAV_5QwXNyt3VMP8NGon_IRhq1Dr
 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=BxIFPtZd1lO8o_JmQQDIKk0O93E_bE-ZzglEWXwbefw,35110
+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=iJUiV6eLq5N_FKki4X5ll5rYQslU_wSPiSTtl61Z1CI,12803
-algokit_utils/network_clients.py,sha256=O4nJ3ECms4hFbuB1X64nzTMNOfK1Uj2oyjKxeieri-g,5929
+algokit_utils/logic_error.py,sha256=I9fJJ09zfpPlKgcJJ7fqC77BBPTz37QsSlGfZwXDdPQ,2684
+algokit_utils/models.py,sha256=KMpSUv7XGjZ9_50U6qUjcPjGh9_7lsRj3ZlO9Fb2zyE,8421
+algokit_utils/network_clients.py,sha256=TlGRZ4l62_vi__AKg9zyVGiAawTrA0ca6AfPDzRL44E,5136
 algokit_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-algokit_utils-2.3.0b2.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
-algokit_utils-2.3.0b2.dist-info/METADATA,sha256=o9prEi5x37Ryru-KqugNKOsQ3nQYLAeI7_TpzDpKrDE,2207
-algokit_utils-2.3.0b2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-algokit_utils-2.3.0b2.dist-info/RECORD,,
+algokit_utils-2.3.1.dist-info/LICENSE,sha256=J5i7U1Q9Q2c7saUzlvFRmrCCFhQyXb5Juz_LO5omNUw,1076
+algokit_utils-2.3.1.dist-info/METADATA,sha256=ntCMbzLSfDWUPdUKPVku6Ast-kVeUfJZKWI360_EIl8,2205
+algokit_utils-2.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+algokit_utils-2.3.1.dist-info/RECORD,,