algokit-utils 3.0.0b10__py3-none-any.whl → 3.0.0b11__py3-none-any.whl

algokit_utils/_legacy_v2/_ensure_funded.py

@@ -10,12 +10,10 @@ from algokit_utils._legacy_v2._transfer import TransferParameters, transfer
 from algokit_utils._legacy_v2.account import get_dispenser_account
 from algokit_utils._legacy_v2.models import Account
 from algokit_utils._legacy_v2.network_clients import is_testnet
-from algokit_utils.clients.dispenser_api_client import (
-    DispenserAssetName,
-    TestNetDispenserApiClient,
-)
+from algokit_utils.clients.dispenser_api_client import TestNetDispenserApiClient
 
 
+@deprecated("Use `algorand.account.ensure_funded()` instead")
 @dataclass(kw_only=True)
 class EnsureBalanceParameters:
     """Parameters for ensuring an account has a minimum number of µALGOs"""
@@ -86,9 +84,7 @@ def _calculate_fund_amount(
 def _fund_using_dispenser_api(
     dispenser_client: TestNetDispenserApiClient, address_to_fund: str, fund_amount_micro_algos: int
 ) -> EnsureFundedResponse | None:
-    response = dispenser_client.fund(
-        address=address_to_fund, amount=fund_amount_micro_algos, asset_id=DispenserAssetName.ALGO
-    )
+    response = dispenser_client.fund(address=address_to_fund, amount=fund_amount_micro_algos)
 
     return EnsureFundedResponse(transaction_id=response.tx_id, amount=response.amount)
 

algokit_utils/_legacy_v2/_transfer.py

@@ -17,6 +17,7 @@ __all__ = ["TransferAssetParameters", "TransferParameters", "transfer", "transfe
 logger = logging.getLogger(__name__)
 
 
+@deprecated("Send transactions via `algorand.{send|create_transaction}.{txn_type}()` instead")
 @dataclasses.dataclass(kw_only=True)
 class TransferParametersBase:
     """Parameters for transferring µALGOs between accounts.
@@ -39,6 +40,7 @@ class TransferParametersBase:
     max_fee_micro_algos: int | None = None
 
 
+@deprecated("Use `algorand.send.payment(...)` / `algorand.create_transaction.payment(...)` instead")
 @dataclasses.dataclass(kw_only=True)
 class TransferParameters(TransferParametersBase):
     """Parameters for transferring µALGOs between accounts"""
@@ -46,6 +48,7 @@ class TransferParameters(TransferParametersBase):
     micro_algos: int
 
 
+@deprecated("Use `algorand.send.asset_transfer(...)` / `algorand.create_transaction.asset_transfer(...)` instead")
 @dataclasses.dataclass(kw_only=True)
 class TransferAssetParameters(TransferParametersBase):
     """Parameters for transferring assets between accounts.
@@ -79,7 +82,7 @@ def _check_fee(transaction: PaymentTxn | AssetTransferTxn, max_fee: int | None)
             )
 
 
-@deprecated("Use the `TransactionComposer` abstraction instead to construct appropriate transfer transactions")
+@deprecated("Use `algorand.send.payment(...)` / `algorand.create_transaction.payment(...)` instead")
 def transfer(client: "AlgodClient", parameters: TransferParameters) -> PaymentTxn:
     """Transfer µALGOs between accounts"""
 
@@ -100,7 +103,7 @@ def transfer(client: "AlgodClient", parameters: TransferParameters) -> PaymentTx
     return result
 
 
-@deprecated("Use the `TransactionComposer` abstraction instead to construct appropriate transfer transactions")
+@deprecated("Use `algorand.send.asset_transfer(...)` / `algorand.create_transaction.asset_transfer(...)` instead")
 def transfer_asset(client: "AlgodClient", parameters: TransferAssetParameters) -> AssetTransferTxn:
     """Transfer assets between accounts"""
 

algokit_utils/_legacy_v2/account.py

@@ -41,7 +41,9 @@ def get_account_from_mnemonic(mnemonic: str) -> Account:
     return Account(private_key=private_key, address=address)
 
 
-@deprecated("Use `algorand.account.from_kmd()` instead. Example: " "`account = algorand.account.from_kmd(name)`")
+@deprecated(
+    "Use `algorand.account.kmd.get_or_create_wallet_account(name, fund_with)` or `KMDAccountManager(clientManager).get_or_create_wallet_account(name, fund_with)` instead"
+)
 def create_kmd_wallet_account(kmd_client: "KMDClient", name: str) -> Account:
     """Creates a wallet with specified name"""
     wallet_id = kmd_client.create_wallet(name, "")["id"]
@@ -56,8 +58,7 @@ def create_kmd_wallet_account(kmd_client: "KMDClient", name: str) -> Account:
 
 
 @deprecated(
-    "Use `algorand.account.from_kmd()` instead. Example: "
-    "`account = algorand.account.from_kmd(name, fund_with=AlgoAmount.from_algo(1000))`"
+    "Use `algorand.account.kmd.get_or_create_wallet_account(name, fund_with)` or `KMDAccountManager(clientManager).get_or_create_wallet_account(name, fund_with)` instead"
 )
 def get_or_create_kmd_wallet_account(
     client: "AlgodClient", name: str, fund_with_algos: float = 1000, kmd_client: "KMDClient | None" = None
@@ -100,8 +101,7 @@ def _is_default_account(account: dict[str, Any]) -> bool:
 
 
 @deprecated(
-    "Use `algorand.account.from_kmd()` instead. Example: "
-    "`account = algorand.account.from_kmd('unencrypted-default-wallet', lambda a: a['status'] != 'Offline' and a['amount'] > 1_000_000_000)`"
+    "Use `algorand.account.localnet_dispenser()` or `algorand.account.from_kmd('unencrypted-default-wallet', lambda a: a['status'] != 'Offline' and a['amount'] > 1_000_000_000)`"
 )
 def get_localnet_default_account(client: "AlgodClient") -> Account:
     """Returns the default Account in a LocalNet instance"""

algokit_utils/_legacy_v2/deploy.py

@@ -175,7 +175,7 @@ def _parse_note(metadata_b64: str | None) -> AppDeployMetaData | None:
         return None
 
 
-@deprecated("Use algorand.appDeployer.get_creator_apps_by_name() instead. ")
+@deprecated("Use algorand.app_deployer.get_creator_apps_by_name() instead. ")
 def get_creator_apps(indexer: "IndexerClient", creator_account: Account | str) -> AppLookup:
     """Returns a mapping of Application names to {py:class}`AppMetaData` for all Applications created by specified
     creator that have a transaction note containing {py:class}`AppDeployMetaData`

algokit_utils/_legacy_v2/network_clients.py

@@ -41,14 +41,14 @@ class AlgoClientConfigs:
     kmd_config: AlgoClientConfig | None
 
 
-@deprecated("Use AlgorandClient.client.algod")
+@deprecated("Use `ClientManager.get_default_localnet_config(config)` instead")
 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]
     return AlgoClientConfig(server=f"http://localhost:{port}", token="a" * 64)
 
 
-@deprecated("Use AlgorandClient.testnet() or AlgorandClient.mainnet() instead")
+@deprecated("Use `ClientManager.get_algonode_config(network, config)` instead")
 def get_algonode_config(
     network: Literal["testnet", "mainnet"], config: Literal["algod", "indexer"], token: str
 ) -> AlgoClientConfig:
@@ -59,7 +59,9 @@ def get_algonode_config(
     )
 
 
-@deprecated("Use AlgorandClient.from_environment() instead.")
+@deprecated(
+    "Use `ClientManager.get_algod_client(config)` or `ClientManager.get_algod_client_from_environment()` instead."
+)
 def get_algod_client(config: AlgoClientConfig | None = None) -> AlgodClient:
     """Returns an {py:class}`algosdk.v2client.algod.AlgodClient` from `config` or environment
 
@@ -69,7 +71,7 @@ def get_algod_client(config: AlgoClientConfig | None = None) -> AlgodClient:
     return AlgodClient(config.token, config.server, headers)
 
 
-@deprecated("Use AlgorandClient.default_localnet().kmd instead")
+@deprecated("Use `ClientManager.get_kmd_client(config)` or `ClientManager.get_kmd_client_from_environment()` instead.")
 def get_kmd_client(config: AlgoClientConfig | None = None) -> KMDClient:
     """Returns an {py:class}`algosdk.kmd.KMDClient` from `config` or environment
 
@@ -78,7 +80,9 @@ def get_kmd_client(config: AlgoClientConfig | None = None) -> KMDClient:
     return KMDClient(config.token, config.server)
 
 
-@deprecated("Use AlgorandClient.client.from_environment().indexer instead")
+@deprecated(
+    "Use `ClientManager.get_indexer_client(config)` or `ClientManager.get_indexer_client_from_environment()` instead."
+)
 def get_indexer_client(config: AlgoClientConfig | None = None) -> IndexerClient:
     """Returns an {py:class}`algosdk.v2client.indexer.IndexerClient` from `config` or environment.
 
@@ -109,7 +113,7 @@ def is_testnet(client: AlgodClient) -> bool:
     return params.gen in ["testnet-v1.0", "testnet-v1", "testnet"]
 
 
-@deprecated("Use AlgorandClient.default_localnet().kmd instead")
+@deprecated("Use `ClientManager.get_kmd_client(config)` or `ClientManager.get_kmd_client_from_environment()` instead.")
 def get_kmd_client_from_algod_client(client: AlgodClient) -> KMDClient:
     """Returns an {py:class}`algosdk.kmd.KMDClient` from supplied `client`
 

algokit_utils/accounts/account_manager.py

@@ -12,7 +12,7 @@ from typing_extensions import Self
 
 from algokit_utils.accounts.kmd_account_manager import KmdAccountManager
 from algokit_utils.clients.client_manager import ClientManager
-from algokit_utils.clients.dispenser_api_client import DispenserAssetName, TestNetDispenserApiClient
+from algokit_utils.clients.dispenser_api_client import TestNetDispenserApiClient
 from algokit_utils.config import config
 from algokit_utils.models.account import (
     DISPENSER_ACCOUNT_NAME,
@@ -49,7 +49,9 @@ class _CommonEnsureFundedParams:
     """
 
     transaction_id: str
+    """The transaction ID of the funded transaction"""
     amount_funded: AlgoAmount
+    """The amount of Algos funded"""
 
 
 @dataclass(frozen=True, kw_only=True)
@@ -72,69 +74,68 @@ class AccountInformation:
     Information about an Algorand account's current status, balance and other properties.
 
     See `https://developer.algorand.org/docs/rest-apis/algod/#account` for detailed field descriptions.
-
-    :ivar str address: The account's address
-    :ivar AlgoAmount amount: The account's current balance
-    :ivar AlgoAmount amount_without_pending_rewards: The account's balance without the pending rewards
-    :ivar AlgoAmount min_balance: The account's minimum required balance
-    :ivar AlgoAmount pending_rewards: The amount of pending rewards
-    :ivar AlgoAmount rewards: The amount of rewards earned
-    :ivar int round: The round for which this information is relevant
-    :ivar str status: The account's status (e.g., 'Offline', 'Online')
-    :ivar int|None total_apps_opted_in: Number of applications this account has opted into
-    :ivar int|None total_assets_opted_in: Number of assets this account has opted into
-    :ivar int|None total_box_bytes: Total number of box bytes used by this account
-    :ivar int|None total_boxes: Total number of boxes used by this account
-    :ivar int|None total_created_apps: Number of applications created by this account
-    :ivar int|None total_created_assets: Number of assets created by this account
-    :ivar list[dict]|None apps_local_state: Local state of applications this account has opted into
-    :ivar int|None apps_total_extra_pages: Number of extra pages allocated to applications
-    :ivar dict|None apps_total_schema: Total schema for all applications
-    :ivar list[dict]|None assets: Assets held by this account
-    :ivar str|None auth_addr: If rekeyed, the authorized address
-    :ivar int|None closed_at_round: Round when this account was closed
-    :ivar list[dict]|None created_apps: Applications created by this account
-    :ivar list[dict]|None created_assets: Assets created by this account
-    :ivar int|None created_at_round: Round when this account was created
-    :ivar bool|None deleted: Whether this account is deleted
-    :ivar bool|None incentive_eligible: Whether this account is eligible for incentives
-    :ivar int|None last_heartbeat: Last heartbeat round for this account
-    :ivar int|None last_proposed: Last round this account proposed a block
-    :ivar dict|None participation: Participation information for this account
-    :ivar int|None reward_base: Base reward for this account
-    :ivar str|None sig_type: Signature type for this account
     """
 
     address: str
+    """The account's address"""
     amount: AlgoAmount
+    """The account's current balance"""
     amount_without_pending_rewards: AlgoAmount
+    """The account's balance without the pending rewards"""
     min_balance: AlgoAmount
+    """The account's minimum required balance"""
     pending_rewards: AlgoAmount
+    """The amount of pending rewards"""
     rewards: AlgoAmount
+    """The amount of rewards earned"""
     round: int
+    """The round for which this information is relevant"""
     status: str
+    """The account's status (e.g., 'Offline', 'Online')"""
     total_apps_opted_in: int | None = None
+    """Number of applications this account has opted into"""
     total_assets_opted_in: int | None = None
+    """Number of assets this account has opted into"""
     total_box_bytes: int | None = None
+    """Total number of box bytes used by this account"""
     total_boxes: int | None = None
+    """Total number of boxes used by this account"""
     total_created_apps: int | None = None
+    """Number of applications created by this account"""
     total_created_assets: int | None = None
+    """Number of assets created by this account"""
     apps_local_state: list[dict] | None = None
+    """Local state of applications this account has opted into"""
     apps_total_extra_pages: int | None = None
+    """Number of extra pages allocated to applications"""
     apps_total_schema: dict | None = None
+    """Total schema for all applications"""
     assets: list[dict] | None = None
+    """Assets held by this account"""
     auth_addr: str | None = None
+    """If rekeyed, the authorized address"""
     closed_at_round: int | None = None
+    """Round when this account was closed"""
     created_apps: list[dict] | None = None
+    """Applications created by this account"""
     created_assets: list[dict] | None = None
+    """Assets created by this account"""
     created_at_round: int | None = None
+    """Round when this account was created"""
     deleted: bool | None = None
+    """Whether this account is deleted"""
     incentive_eligible: bool | None = None
+    """Whether this account is eligible for incentives"""
     last_heartbeat: int | None = None
+    """Last heartbeat round for this account"""
     last_proposed: int | None = None
+    """Last round this account proposed a block"""
     participation: dict | None = None
+    """Participation information for this account"""
     reward_base: int | None = None
+    """Base reward for this account"""
     sig_type: str | None = None
+    """Signature type for this account"""
 
 
 class AccountManager:
@@ -158,6 +159,13 @@ class AccountManager:
 
     @property
     def kmd(self) -> KmdAccountManager:
+        """
+        KMD account manager that allows you to easily get and create accounts using KMD.
+
+        :return KmdAccountManager: The 'KmdAccountManager' instance
+        :example:
+            >>> kmd_manager = account_manager.kmd
+        """
         return self._kmd_account_manager
 
     def set_default_signer(self, signer: TransactionSigner | TransactionSignerAccountProtocol) -> Self:
@@ -172,10 +180,7 @@ class AccountManager:
 
         :example:
             >>> signer_account = account_manager.random()
-            >>> account_manager.set_default_signer(signer_account.signer)
-            >>> # When signing a transaction, if there is no signer registered for the sender
-            >>> # then the default signer will be used
-            >>> signer = account_manager.get_signer("{SENDERADDRESS}")
+            >>> account_manager.set_default_signer(signer_account)
         """
         self._default_signer = signer if isinstance(signer, TransactionSigner) else signer.signer
         return self
@@ -201,6 +206,9 @@ class AccountManager:
         :param another_account_manager: The `AccountManager` to merge into this one
         :param overwrite_existing: Whether to overwrite existing signers in this manager
         :returns: The `AccountManager` instance for method chaining
+
+        :example:
+            >>> accountManager2.set_signers(accountManager1)
         """
         self._accounts = (
             {**self._accounts, **another_account_manager._accounts}  # noqa: SLF001
@@ -417,7 +425,7 @@ class AccountManager:
         :returns: A logic signature account wrapper
 
         :example:
-            >>> account = account.logic_sig(program, [new Uint8Array(3, ...)])
+            >>> account = account.logicsig(program, [new Uint8Array(3, ...)])
         """
         return self._register_logicsig(program, args)
 
@@ -540,22 +548,22 @@ class AccountManager:
 
         :example:
             >>> # Basic example (with string addresses):
-            >>> algorand.account.rekey_account({account: "ACCOUNTADDRESS", rekey_to: "NEWADDRESS"})
+            >>> algorand.account.rekey_account("ACCOUNTADDRESS", "NEWADDRESS")
             >>> # Basic example (with signer accounts):
-            >>> algorand.account.rekey_account({account: account1, rekey_to: newSignerAccount})
+            >>> algorand.account.rekey_account(account1, newSignerAccount)
             >>> # Advanced example:
-            >>> algorand.account.rekey_account({
-            ...     account: "ACCOUNTADDRESS",
-            ...     rekey_to: "NEWADDRESS",
-            ...     lease: 'lease',
-            ...     note: 'note',
-            ...     first_valid_round: 1000,
-            ...     validity_window: 10,
-            ...     extra_fee: AlgoAmount.from_micro_algo(1000),
-            ...     static_fee: AlgoAmount.from_micro_algo(1000),
-            ...     max_fee: AlgoAmount.from_micro_algo(3000),
-            ...     suppress_log: True,
-            ... })
+            >>> algorand.account.rekey_account(
+            ...     account="ACCOUNTADDRESS",
+            ...     rekey_to="NEWADDRESS",
+            ...     lease='lease',
+            ...     note='note',
+            ...     first_valid_round=1000,
+            ...     validity_window=10,
+            ...     extra_fee=AlgoAmount.from_micro_algo(1000),
+            ...     static_fee=AlgoAmount.from_micro_algo(1000),
+            ...     max_fee=AlgoAmount.from_micro_algo(3000),
+            ...     suppress_log=True,
+            ... )
         """
         sender_address = self._get_address(account)
         rekey_address = self._get_address(rekey_to)
@@ -640,13 +648,13 @@ class AccountManager:
 
         :example:
             >>> # Basic example:
-            >>> algorand.account.ensure_funded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1))
+            >>> algorand.account.ensure_funded("ACCOUNTADDRESS", "DISPENSERADDRESS", AlgoAmount.from_algo(1))
             >>> # With configuration:
             >>> algorand.account.ensure_funded(
             ...     "ACCOUNTADDRESS",
             ...     "DISPENSERADDRESS",
-            ...     algokit.algo(1),
-            ...     min_funding_increment=algokit.algo(2),
+            ...     AlgoAmount.from_algo(1),
+            ...     min_funding_increment=AlgoAmount.from_algo(2),
             ...     fee=AlgoAmount.from_micro_algo(1000),
             ...     suppress_log=True
             ... )
@@ -746,12 +754,12 @@ class AccountManager:
 
         :example:
             >>> # Basic example:
-            >>> algorand.account.ensure_funded_from_environment("ACCOUNTADDRESS", algokit.algo(1))
+            >>> algorand.account.ensure_funded_from_environment("ACCOUNTADDRESS", AlgoAmount.from_algo(1))
             >>> # With configuration:
             >>> algorand.account.ensure_funded_from_environment(
             ...     "ACCOUNTADDRESS",
-            ...     algokit.algo(1),
-            ...     min_funding_increment=algokit.algo(2),
+            ...     AlgoAmount.from_algo(1),
+            ...     min_funding_increment=AlgoAmount.from_algo(2),
             ...     fee=AlgoAmount.from_micro_algo(1000),
             ...     suppress_log=True
             ... )
@@ -825,17 +833,17 @@ class AccountManager:
 
         :example:
             >>> # Basic example:
-            >>> algorand.account.ensure_funded_from_testnet_dispenser_api(
+            >>> account_manager.ensure_funded_from_testnet_dispenser_api(
             ...     "ACCOUNTADDRESS",
             ...     algorand.client.get_testnet_dispenser_from_environment(),
-            ...     algokit.algo(1)
+            ...     AlgoAmount.from_algo(1)
             ... )
             >>> # With configuration:
-            >>> algorand.account.ensure_funded_from_testnet_dispenser_api(
+            >>> account_manager.ensure_funded_from_testnet_dispenser_api(
             ...     "ACCOUNTADDRESS",
             ...     algorand.client.get_testnet_dispenser_from_environment(),
-            ...     algokit.algo(1),
-            ...     min_funding_increment=algokit.algo(2)
+            ...     AlgoAmount.from_algo(1),
+            ...     min_funding_increment=AlgoAmount.from_algo(2)
             ... )
         """
         account_to_fund = self._get_address(account_to_fund)
@@ -848,11 +856,7 @@ class AccountManager:
         if not amount_funded:
             return None
 
-        result = dispenser_client.fund(
-            address=account_to_fund,
-            amount=amount_funded.micro_algo,
-            asset_id=DispenserAssetName.ALGO,
-        )
+        result = dispenser_client.fund(address=account_to_fund, amount=amount_funded.micro_algo)
 
         return EnsureFundedFromTestnetDispenserApiResult(
             transaction_id=result.tx_id,