From f13b03af90b0635d6bec47390dfe6d344526a35f Mon Sep 17 00:00:00 2001 From: Neil Campbell Date: Fri, 5 Jul 2024 21:55:11 +0800 Subject: [PATCH] chore: remove purestake code --- .../algokit_utils/algokit_utils.md.txt | 2 +- docs/html/_sources/capabilities/client.md.txt | 15 +++++----- .../apidocs/algokit_utils/algokit_utils.html | 4 +-- docs/html/capabilities/client.html | 3 +- docs/html/index.html | 2 +- docs/html/searchindex.js | 2 +- example.env | 12 -------- src/algokit_utils/__init__.py | 2 -- src/algokit_utils/network_clients.py | 28 ++----------------- tests/test_network_clients.py | 21 ++------------ 10 files changed, 17 insertions(+), 74 deletions(-) diff --git a/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt b/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt index 9eab990e..ed1d22ca 100644 --- a/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt +++ b/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt @@ -555,7 +555,7 @@ Bases: {py:obj}`algokit_utils.models.TransactionResponse`, {py:obj}`typing.Gener :canonical: algokit_utils.models.Account.address :type: str :value: > - None + 'field(...)' ```{autodoc2-docstring} algokit_utils.models.Account.address :parser: myst diff --git a/docs/html/_sources/capabilities/client.md.txt b/docs/html/_sources/capabilities/client.md.txt index 3a77a909..851c66ff 100644 --- a/docs/html/_sources/capabilities/client.md.txt +++ b/docs/html/_sources/capabilities/client.md.txt @@ -1,11 +1,11 @@ # Client management -Client management is one of the core capabilities provided by AlgoKit Utils. -It allows you to create [algod](https://developer.algorand.org/docs/rest-apis/algod), [indexer](https://developer.algorand.org/docs/rest-apis/indexer) +Client management is one of the core capabilities provided by AlgoKit Utils. +It allows you to create [algod](https://developer.algorand.org/docs/rest-apis/algod), [indexer](https://developer.algorand.org/docs/rest-apis/indexer) and [kmd](https://developer.algorand.org/docs/rest-apis/kmd) clients against various networks resolved from environment or specified configuration. -Any AlgoKit Utils function that needs one of these clients will take the underlying `algosdk` classes (`algosdk.v2client.algod.AlgodClient`, `algosdk.v2client.indexer.IndexerClient`, -`algosdk.kmd.KMDClient`) so inline with the [Modularity](../index.md#core-principles) principle you can use existing logic to get instances of these clients without needing to use the +Any AlgoKit Utils function that needs one of these clients will take the underlying `algosdk` classes (`algosdk.v2client.algod.AlgodClient`, `algosdk.v2client.indexer.IndexerClient`, +`algosdk.kmd.KMDClient`) so inline with the [Modularity](../index.md#core-principles) principle you can use existing logic to get instances of these clients without needing to use the Client management capability if you prefer. To see some usage examples check out the [automated tests](https://github.com/algorandfoundation/algokit-utils-py/blob/main/tests/test_network_clients.py). @@ -16,10 +16,9 @@ The network configuration is specified using the `AlgoClientConfig` class. This There are a number of ways to produce one of these configuration objects: -* Manually creating the object, e.g. `AlgoClientConfig(server="https://myalgodnode.com", token="SECRET_TOKEN")` -* `algokit_utils.get_algonode_config(network, config, token)`: Loads an Algod or indexer config against [AlgoNode](https://algonode.io/api/) to either MainNet or TestNet -* `algokit_utils.get_purestake_config(network, config, token)`: Loads an Algod or indexer config against [PureStake](https://developer.purestake.io/) to either MainNet or TestNet -* `algokit_utils.get_default_localnet_config(configOrPort)`: Loads an Algod, Indexer or Kmd config against [LocalNet](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/localnet.md) using the default configuration +- Manually creating the object, e.g. `AlgoClientConfig(server="https://myalgodnode.com", token="SECRET_TOKEN")` +- `algokit_utils.get_algonode_config(network, config, token)`: Loads an Algod or indexer config against [Nodely](https://nodely.io/docs/free/start) to either MainNet or TestNet +- `algokit_utils.get_default_localnet_config(configOrPort)`: Loads an Algod, Indexer or Kmd config against [LocalNet](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/localnet.md) using the default configuration ## Clients diff --git a/docs/html/apidocs/algokit_utils/algokit_utils.html b/docs/html/apidocs/algokit_utils/algokit_utils.html index 9a4aebc1..b9ba4247 100644 --- a/docs/html/apidocs/algokit_utils/algokit_utils.html +++ b/docs/html/apidocs/algokit_utils/algokit_utils.html @@ -528,7 +528,7 @@

API
address: str
-

None

+

‘field(…)’

Address for this account

@@ -1508,7 +1508,7 @@

API
-algokit_utils.execute_atc_with_logic_error(atc: algosdk.atomic_transaction_composer.AtomicTransactionComposer, algod_client: algosdk.v2client.algod.AlgodClient, approval_program: str, wait_rounds: int = 4, approval_source_map: algosdk.source_map.SourceMap | Callable[[], algosdk.source_map.SourceMap | None] | None = None) → algosdk.atomic_transaction_composer.AtomicTransactionResponse
+algokit_utils.execute_atc_with_logic_error(atc: algosdk.atomic_transaction_composer.AtomicTransactionComposer, algod_client: algosdk.v2client.algod.AlgodClient, approval_program: str, wait_rounds: int = 4, approval_source_map: algosdk.source_map.SourceMap | Callable[[], algosdk.source_map.SourceMap | None] | None = None) → algosdk.atomic_transaction_composer.AtomicTransactionResponse

Calls AtomicTransactionComposer.execute() on provided atc, but will parse any errors and raise a LogicError if possible

diff --git a/docs/html/capabilities/client.html b/docs/html/capabilities/client.html index 335f2b5f..33c9ab55 100644 --- a/docs/html/capabilities/client.html +++ b/docs/html/capabilities/client.html @@ -96,8 +96,7 @@

Network configurationThere are a number of ways to produce one of these configuration objects:

 diff --git a/docs/html/index.html b/docs/html/index.html index ce389a02..07ac79a2 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -182,7 +182,7 @@

Types

  • ARC-0032 Application Spec client - Builds on top of the App management and App deployment capabilities to provide a high productivity application client that works with ARC-0032 application spec defined smart contracts (e.g. via Beaker)

  • App deployment - Idempotent (safely retryable) deployment of an app, including deploy-time immutability and permanence control and TEAL template substitution

  • Algo transfers - Ability to easily initiate algo transfers between accounts, including dispenser management and idempotent account funding

    • -

  • Debugger - Provides a set of debugging tools that can be used to simulate and trace transactions on the Algorand blockchain. These tools and methods are optimized for developers who are building applications on Algorand and need to test and debug their smart contracts via AVM Debugger extension.

    • +

  • Debugger - Provides a set of debugging tools that can be used to simulate and trace transactions on the Algorand blockchain. These tools and methods are optimized for developers who are building applications on Algorand and need to test and debug their smart contracts via AVM Debugger extension.

    • diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index 1ff9e794..0cefec65 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["apidocs/algokit_utils/algokit_utils", "capabilities/account", "capabilities/app-client", "capabilities/app-deploy", "capabilities/client", "capabilities/debugging", "capabilities/dispenser-client", "capabilities/transfer", "index"], "filenames": ["apidocs/algokit_utils/algokit_utils.md", "capabilities/account.md", "capabilities/app-client.md", "capabilities/app-deploy.md", "capabilities/client.md", "capabilities/debugging.md", "capabilities/dispenser-client.md", "capabilities/transfer.md", "index.md"], "titles": ["algokit_utils", "Account management", "App client", "App deployment", "Client management", "Debugger", "TestNet Dispenser Client", "Algo transfers", "AlgoKit Python Utilities"], "terms": {"abicallarg": 0, "abi": 0, "paramet": [0, 7], "us": [0, 1, 2, 3, 4, 5, 6, 7, 8], "updat": [0, 2, 3, 5], "delet": [0, 2, 3], "an": [0, 1, 4, 5, 7, 8], "applic": [0, 5, 8], "when": [0, 1, 2, 3, 5, 7], "call": [0, 3, 5, 7, 8], "deploi": [0, 1, 2, 8], "abicallargsdict": 0, "abicreatecallarg": 0, "creat": [0, 1, 3, 4, 5, 8], "abicreatecallargsdict": 0, "abitransactionrespons": [0, 3], "respons": [0, 2, 5, 6], "account": [0, 2, 7, 8], "hold": [0, 3], "private_kei": [0, 1], "address": [0, 1, 2, 6, 7], "algoclientconfig": [0, 4], "connect": 0, "detail": [0, 2, 6], "algosdk": [0, 1, 2, 4], "v2client": [0, 4], "algod": [0, 3, 4, 7, 8], "algodcli": [0, 2, 4, 5], "index": [0, 2, 3, 4, 8], "indexercli": [0, 4], "appdeploymetadata": 0, "metadata": [0, 3], "about": [0, 5], "store": [0, 5, 7], "transact": [0, 1, 3, 5, 6, 7, 8], "note": [0, 2, 3, 7], "dure": [0, 2, 3, 7], "creation": [0, 3, 8], "applookup": [0, 3], "cach": 0, "appmetadata": [0, 3], "specif": [0, 2, 5], "creator": [0, 2, 8], "app": [0, 7, 8], "apprefer": 0, "inform": [0, 2, 5], "algorand": [0, 3, 5, 8], "applicationcli": [0, 2, 3], "A": [0, 2, 5, 8], "wrap": [0, 2, 8], "arc": [0, 2, 3, 8], "0032": [0, 2, 3, 8], "spec": [0, 2, 8], "provid": [0, 1, 2, 3, 4, 5, 6, 7, 8], "high": [0, 2, 8], "product": [0, 2, 8], "method": [0, 1, 3, 5, 6, 8], "applicationspecif": [0, 2], "callconfig": 0, "describ": [0, 3], "type": [0, 2, 5, 6], "can": [0, 1, 2, 3, 4, 5, 6, 7, 8], "base": [0, 1, 2, 3, 4], "oncomplet": 0, "createcallparamet": [0, 2], "addit": [0, 1, 2, 8], "includ": [0, 2, 3, 7, 8], "compose_cr": 0, "createcallparametersdict": 0, "createtransactionparamet": 0, "defaultargumentdict": 0, "defaultargu": 0, "i": [0, 1, 2, 3, 4, 5, 6, 7, 8], "contain": [0, 1, 2, 3, 5, 6, 8], "ani": [0, 2, 3, 4, 5, 6, 8], "argument": [0, 6], "mai": [0, 2], "resolv": [0, 1, 3, 4, 8], "prior": [0, 7], "some": [0, 1, 2, 3, 4, 7], "target": 0, "deploycallarg": 0, "deploycallargsdict": 0, "deploycreatecallarg": 0, "deploycreatecallargsdict": 0, "deployrespons": [0, 3], "action": [0, 2, 3], "taken": [0, 3], "deploy": [0, 2, 7, 8], "relat": 0, "ensurebalanceparamet": [0, 7], "ensur": [0, 8], "ha": [0, 2, 3, 5, 7, 8], "minimum": [0, 8], "number": [0, 2, 3, 4, 7, 8], "\u00b5algo": 0, "ensurefundedrespons": [0, 7], "methodhint": 0, "hint": [0, 8], "caller": 0, "how": [0, 6], "oncompletecallparamet": [0, 2], "compose_cal": [0, 2], "oncompletecallparametersdict": 0, "onschemabreak": 0, "take": [0, 2, 3, 4, 5, 6, 7], "": [0, 2, 3, 6, 7, 8], "schema": [0, 3], "break": [0, 3], "chang": [0, 3], "onupd": 0, "been": [0, 2, 3, 8], "operationperform": 0, "program": [0, 2], "compil": [0, 2], "teal": [0, 2, 3, 5, 8], "testnetdispenserapicli": [0, 6, 7], "client": [0, 5, 7, 8], "interact": [0, 5, 6], "algokit": [0, 1, 2, 3, 4, 5, 6, 7], "testnet": [0, 1, 3, 4, 7, 8], "dispens": [0, 1, 8], "To": [0, 2, 3, 4, 5, 6, 7, 8], "get": [0, 1, 2, 4, 7, 8], "start": 0, "new": [0, 1, 2, 3], "access": [0, 2, 7], "token": [0, 4, 6, 7], "via": [0, 2, 3, 5, 6, 7, 8], "login": 0, "ci": 0, "pass": [0, 2, 6], "constructor": [0, 6], "auth_token": [0, 6], "altern": [0, 2, 5], "set": [0, 2, 3, 5, 6, 7, 8], "environ": [0, 1, 3, 4, 5, 6, 7, 8], "variabl": [0, 1, 2, 4, 5, 6, 7, 8], "algokit_dispenser_access_token": [0, 6, 7], "auto": [0, 8], "load": [0, 1, 4], "If": [0, 1, 2, 3, 6, 7, 8], "both": [0, 2, 6], "ar": [0, 1, 2, 3, 4, 5, 6, 7, 8], "preced": [0, 6], "transactionparamet": 0, "transactionrespons": [0, 3], "non": [0, 3, 5], "transferassetparamet": [0, 7], "transfer": [0, 5, 8], "asset": [0, 2, 5, 6, 8], "between": [0, 7, 8], "transferparamet": [0, 7], "create_kmd_wallet_account": [0, 1], "wallet": [0, 1], "specifi": [0, 3, 4, 7, 8], "name": [0, 1, 2, 3, 5], "ensure_fund": [0, 7], "fund": [0, 1, 7, 8], "given": [0, 1, 2, 3, 4, 5], "sourc": [0, 2, 5], "certain": 0, "amount": [0, 2, 6, 7], "algo": [0, 1, 6, 8], "free": 0, "spend": [0, 7], "lock": 0, "balanc": [0, 7], "requir": [0, 2, 6, 7], "see": [0, 2, 3, 4, 6, 7], "http": [0, 4], "develop": [0, 2, 3, 5, 8], "org": 0, "doc": [0, 6, 8], "execute_atc_with_logic_error": 0, "atomictransactioncompos": [0, 2, 5], "execut": [0, 2, 3], "atc": [0, 2], "pars": [0, 2], "error": [0, 8], "rais": [0, 6], "logicerror": [0, 2], "possibl": [0, 2, 7, 8], "get_account": [0, 1], "return": [0, 1, 2, 4, 6, 7], "privat": [0, 1, 7], "kei": [0, 1, 2, 3, 7], "identifi": [0, 1, 2, 8], "get_account_from_mnemon": [0, 1], "convert": 0, "mnemon": [0, 1, 7, 8], "25": 0, "word": 0, "passphras": 0, "get_algod_cli": [0, 4], "from": [0, 1, 2, 3, 4, 5, 6, 8], "config": [0, 2, 4, 5], "get_app_id_from_tx_id": 0, "find": [0, 2, 7, 8], "app_id": [0, 2], "id": [0, 2, 3, 6, 7, 8], "get_creator_app": [0, 3], "map": [0, 2, 3], "all": [0, 2, 3, 5, 8], "have": [0, 1, 2, 3, 4, 7, 8], "get_default_localnet_config": [0, 4], "configur": [0, 3, 8], "point": 0, "default": [0, 1, 2, 4, 5, 7, 8], "localnet": [0, 1, 3, 4, 7], "get_dispenser_account": [0, 1, 7], "dispenser_mnenom": 0, "get_indexer_cli": [0, 4], "get_kmd_client_from_algod_cli": [0, 4], "kmd": [0, 1, 4, 7, 8], "kmdclient": [0, 4], "suppli": [0, 3], "get_kmd_wallet_account": [0, 1], "match": 0, "predic": 0, "none": [0, 2, 4, 7], "found": [0, 3], "get_localnet_default_account": [0, 1], "instanc": [0, 1, 2, 3, 4, 7], "get_next_vers": 0, "calcul": [0, 2], "next": 0, "version": [0, 3], "current_vers": 0, "get_or_create_kmd_wallet_account": [0, 1], "one": [0, 1, 2, 3, 4], "get_sender_from_sign": 0, "associ": [0, 1, 2], "signer": [0, 1, 2, 3, 7, 8], "is_localnet": 0, "true": [0, 2, 5, 7], "genesi": 0, "devnet": 0, "v1": 0, "sandnet": 0, "is_mainnet": 0, "mainnet": [0, 1, 3, 4, 7], "is_testnet": 0, "num_extra_program_pag": 0, "extra_pag": [0, 2], "approv": [0, 2], "clear": [0, 2], "replace_template_vari": 0, "replac": [0, 2, 3], "tmpl_": [0, 2, 3], "template_valu": [0, 2, 3], "transfer_asset": [0, 7], "appspecstatedict": 0, "defin": [0, 2, 3, 8], "state": [0, 3, 8], "entri": 0, "deletable_template_nam": 0, "templat": [0, 2, 8], "control": [0, 3, 8], "smart": [0, 2, 3, 5, 8], "contract": [0, 2, 3, 5, 8], "defaultargumenttyp": 0, "liter": 0, "valu": [0, 2, 5, 7], "methodconfigdict": 0, "dictionari": [0, 2], "dict": 0, "oncompletionactionnam": 0, "repres": [0, 1, 5], "allow": [0, 1, 2, 3, 4, 7], "each": [0, 5, 6], "complet": [0, 2, 8], "note_prefix": 0, "0002": 0, "compliant": [0, 5], "prefix": 0, "oncompleteactionnam": 0, "string": [0, 2, 3, 5, 7], "templatevaluedict": 0, "str": [0, 2], "int": 0, "byte": [0, 3], "templatevaluemap": 0, "updatable_template_nam": 0, "abical": 0, "typeddict": 0, "initi": [0, 6, 7, 8], "self": 0, "help": [0, 3, 8], "accur": 0, "signatur": [0, 2], "model": 0, "gener": [0, 2, 7, 8], "returntyp": 0, "decode_error": 0, "except": [0, 2, 6], "occur": [0, 2, 6], "attempt": [0, 2, 7], "decod": 0, "raw_valu": 0, "make": [0, 2, 6, 7, 8], "The": [0, 2, 3, 4, 5, 6, 7, 8], "raw": [0, 2], "befor": [0, 2], "return_valu": 0, "result": [0, 2, 3], "tx_info": 0, "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8], "base64": 0, "encod": [0, 3], "properti": [0, 1], "public_kei": [0, 1], "public": 0, "atomic_transaction_compos": [0, 2], "accounttransactionsign": [0, 7], "server": [0, 4], "url": 0, "servic": [0, 1, 4, 7], "e": [0, 2, 3, 4, 7, 8], "g": [0, 2, 3, 4, 8], "localhost": 0, "4001": 0, "algonod": [0, 4], "cloud": 0, "authent": 0, "serial": 0, "json": [0, 5], "field": [0, 3, 6, 7], "part": [0, 8], "reduc": 0, "multipl": [0, 2, 3], "discov": 0, "typealia": 0, "algod_cli": [0, 2, 7], "app_spec": [0, 2, 3], "application_specif": 0, "pathlib": 0, "path": [0, 5], "0": [0, 2, 3, 6, 7], "indexer_cli": 0, "existing_deploy": 0, "transactionsign": [0, 2], "sender": [0, 1, 2, 3, 6], "suggested_param": [0, 2, 7], "suggestedparam": [0, 2, 7], "app_nam": [0, 2], "exist": [0, 1, 2, 3, 4], "instead": [0, 2, 3], "onli": [0, 1, 2, 3], "sign": [0, 1, 2], "wa": [0, 3, 5, 7], "should": [0, 2, 3, 7], "NOT": 0, "add_method_cal": 0, "abi_method": 0, "abimethod": 0, "bool": 0, "abi_arg": 0, "abiargsdict": 0, "transactionparametersdict": 0, "on_complet": [0, 2], "noopoc": 0, "local_schema": 0, "stateschema": 0, "global_schema": 0, "approval_program": 0, "clear_program": 0, "app_arg": 0, "list": [0, 2, 5], "call_config": 0, "au_spec": 0, "add": [0, 3, 8], "call_abi_method": [0, 2], "transaction_paramet": [0, 2], "abi_kwarg": 0, "abiargtyp": 0, "submit": 0, "clear_stat": [0, 2], "clearstat": 0, "close_out": [0, 2], "closeout": 0, "compose_clear_st": 0, "compose_close_out": 0, "ac": 0, "compose_delet": 0, "deleteappl": 0, "compose_opt_in": 0, "optin": 0, "compose_upd": 0, "updateappl": 0, "allow_upd": [0, 3], "allow_delet": [0, 3], "on_upd": [0, 3], "au_deploi": 0, "fail": [0, 2, 3], "on_schema_break": [0, 3], "create_arg": [0, 3], "update_arg": [0, 3], "delete_arg": [0, 3], "refer": [0, 2, 3, 6, 7], "idempot": [0, 1, 7, 8], "against": [0, 1, 3, 4, 7, 8], "time": [0, 1, 3, 5, 8], "placehold": 0, "substitut": [0, 8], "understand": [0, 2], "architectur": [0, 3], "decis": [0, 3], "behind": [0, 3], "pleas": [0, 7], "github": 0, "com": [0, 4], "algorandfound": 0, "cli": [0, 7], "blob": 0, "main": 0, "2023": 0, "01": 0, "12_smart": 0, "md": 0, "replaceapp": 0, "re": [0, 1, 2], "differ": [0, 3, 4, 5, 7], "code": [0, 1, 3, 5, 6, 8], "increment": [0, 3], "tmpl_delet": [0, 2, 3], "condition": 0, "tmpl_updat": [0, 2, 3], "determin": [0, 3, 7], "what": [0, 2, 3], "increas": 0, "beyond": 0, "current": [0, 2, 3, 7, 8], "alloc": [0, 2], "relev": 0, "deploymenterror": 0, "export_source_map": [0, 2], "export": [0, 2], "later": 0, "import": [0, 2, 5, 6, 8], "import_source_map": [0, 2], "get_global_st": [0, 2], "fals": [0, 2, 5], "global": [0, 2, 3], "info": 0, "get_local_st": [0, 2], "local": [0, 1, 2, 3], "get_signer_send": 0, "tupl": [0, 2], "Will": 0, "otherwis": [0, 2, 3, 7], "fall": 0, "back": [0, 6], "obtain": [0, 1, 2, 6], "source_map_json": 0, "opt_in": [0, 2], "prepar": 0, "application_cli": 0, "copi": 0, "also": [0, 2, 3, 5], "to_resolv": 0, "resolve_signer_send": 0, "valueerror": 0, "variant": [0, 2], "pull": 0, "150": 0, "directori": [0, 5], "write": [0, 3, 8], "out": [0, 2, 3, 4, 7], "artifact": [0, 5], "disk": 0, "arg": [0, 3], "option": [0, 2, 3, 4, 7], "where": [0, 2, 5, 8], "written": [0, 8], "enum": 0, "intflag": 0, "3": [0, 2], "handl": [0, 8], "normal": 0, "1": [0, 2, 3, 5], "2": [0, 2, 3, 5], "never": 0, "deploymentfailederror": 0, "account_to_fund": [0, 7], "receiv": [0, 6, 7], "fee_micro_algo": [0, 7], "flat": [0, 7], "fee": [0, 2, 7], "you": [0, 1, 2, 3, 4, 5, 6, 7, 8], "want": [0, 5, 7, 8], "pai": [0, 7], "cover": [0, 7], "extra": [0, 7], "group": [0, 5, 7], "funding_sourc": [0, 7], "dispenser_api": 0, "send": [0, 6, 7], "which": [0, 3, 5, 6, 7, 8], "max_fee_micro_algo": [0, 7], "maximum": [0, 5, 7], "happi": [0, 7], "unbound": [0, 7], "could": [0, 7], "reject": [0, 7], "network": [0, 2, 3, 7, 8], "congest": [0, 7], "min_funding_increment_micro_algo": [0, 7], "issu": [0, 2, 6, 7, 8], "avoid": [0, 7], "mani": [0, 7], "small": [0, 7], "often": [0, 2, 7], "activ": [0, 2, 7], "min_spending_balance_micro_algo": [0, 7], "avail": [0, 2, 7, 8], "top": [0, 3, 7, 8], "meet": [0, 7], "transaction_id": [0, 2, 6], "were": 0, "logic_error_str": 0, "source_map": [0, 2], "algosourcemap": 0, "messag": [0, 2, 6], "pc": [0, 2], "logic_error": [0, 2], "trace": [0, 8], "algokit_deploy": [0, 3], "j": [0, 3], "kwd": 0, "appendapp": 0, "old": 0, "singl": [0, 2, 3], "updateapp": 0, "No": 0, "noth": [0, 3, 8], "date": [0, 3], "origin": [0, 2, 3], "latest": 0, "fulli": 0, "binari": 0, "line": [0, 2], "request_timeout": 0, "dispenser_request_timeout": 0, "request": [0, 3, 6], "timeout": 0, "15": 0, "second": 0, "modifi": 0, "asset_id": [0, 6, 7], "dispenserfundrespons": 0, "get_limit": [0, 6], "dispenserlimitrespons": 0, "limit": [0, 8], "refund": [0, 8], "refund_txn_id": [0, 6], "regist": [0, 8], "box": [0, 2, 3], "collect": 0, "abc": 0, "sequenc": [0, 2], "bytearrai": 0, "foreign_app": [0, 2], "foreign": [0, 2], "foreign_asset": [0, 2], "leas": [0, 2], "rekey_to": 0, "rekei": 0, "confirmed_round": 0, "round": [0, 5], "confirm": 0, "dry": 0, "run": [0, 4, 7], "static": [0, 3], "from_atr": 0, "atomictransactionrespons": 0, "simulateatomictransactionrespons": 0, "transaction_index": 0, "either": [0, 1, 2, 3, 4], "more": [0, 2, 3, 7], "last": [0, 3, 5], "tx_id": [0, 6], "_transfer": 0, "transferparametersbas": 0, "clawback_from": 0, "perform": [0, 3, 5, 6], "clawback": 0, "oper": [0, 3, 5], "case": [0, 3, 7, 8], "senderaccount": 0, "must": [0, 2, 3], "equal": 0, "asa": 0, "kmd_client": 0, "_ensure_fund": 0, "librari": [0, 8], "paymenttxn": 0, "need": [0, 2, 3, 4, 5, 6, 7, 8], "payment": [0, 5, 6, 7], "indic": [0, 2, 3, 5, 6], "wait_round": 0, "4": [0, 2], "approval_source_map": [0, 2], "sourcemap": [0, 2, 5], "callabl": 0, "abl": [0, 2, 3], "fund_with_algo": 0, "float": [0, 5], "1000": [0, 5, 6], "o": [0, 6], "f": 0, "_mnemon": [0, 1], "secret": 0, "Be": 0, "care": 0, "commit": 0, "ideal": 0, "storag": [0, 3, 5], "rather": [0, 3], "than": [0, 3, 7], "file": [0, 5, 8], "system": 0, "doesn": [0, 3], "t": [0, 3], "work": [0, 1, 2, 3, 8], "seamlessli": 0, "without": [0, 4, 8], "manual": [0, 4], "reset": 0, "account_mnemon": 0, "follow": [0, 2, 3, 4, 5, 7, 8], "object": [0, 2, 3, 4, 5, 6], "automat": [0, 1, 2, 3, 7], "network_cli": 0, "algod_serv": [0, 4], "algod_port": [0, 4], "algod_token": [0, 4], "creator_account": 0, "indexer_serv": [0, 4], "indexer_port": [0, 4], "indexer_token": [0, 4], "same": [0, 1, 3, 4], "port": [0, 4], "kmd_port": [0, 4], "4002": [0, 4], "semver": 0, "like": [0, 2, 7, 8], "lower": 0, "intend": 0, "mostli": 0, "conveni": [0, 1], "param": [0, 2], "within": 0, "valid": [0, 3], "input": 0, "output": [0, 2, 3, 5], "beta1": 0, "4567": 0, "4568": 0, "alpha": 0, "cannot": 0, "assettransfertxn": [0, 7], "util": [1, 3, 4, 6, 7], "api": [6, 7, 8], "It": [0, 1, 3, 4, 5, 6], "author": 6, "done": [3, 6], "two": [2, 6, 7], "wai": [2, 4, 6], "directli": [2, 6], "algokit_util": [2, 4, 5, 6, 8], "your_auth_token": 6, "receiver_address": 6, "fundrespons": 6, "keep": 6, "mind": 6, "yourself": 6, "first": [2, 6], "invok": [6, 7], "endpoint": [5, 6], "txn_id": 6, "your": [5, 6, 8], "txn": 6, "inspect": 6, "account_address": 6, "limitrespons": 6, "while": [3, 6], "individu": 6, "higher": [3, 7, 8], "order": [3, 7, 8], "capabl": [1, 3, 4, 7], "easili": [7, 8], "manag": [0, 3, 5, 7, 8], "usag": [2, 3, 4, 7], "exampl": [2, 3, 4, 5, 7], "check": [2, 3, 4, 7], "autom": [2, 3, 4, 7], "test": [2, 3, 4, 5, 7, 8], "function": [1, 2, 3, 4, 7, 8], "facilit": [7, 8], "transfer_paramet": 7, "underli": [4, 7, 8], "from_account": 7, "to_address": 7, "micro_algo": 7, "micro": 7, "abil": [3, 7, 8], "dispos": 7, "incredibli": 7, "script": 7, "made": [2, 7], "those": 7, "so": [2, 4, 7, 8], "use_dispenser_api": 7, "sure": 7, "document": 7, "smallest": 7, "divis": 7, "unit": 7, "programmat": 7, "sent": 7, "There": [1, 2, 3, 4, 7], "standard": [0, 7], "other": [2, 3, 7], "dispenser_mnemon": [1, 7], "doe": [3, 7], "separ": [5, 7], "abstract": 7, "dedic": 7, "releas": 8, "pypi": 8, "easier": [2, 3, 8], "build": [3, 5, 8], "solut": 8, "project": [0, 5, 8], "goal": [3, 8], "intuit": 8, "quicker": 8, "safer": 8, "larg": 8, "sdk": 8, "level": 8, "interfac": [4, 8], "sensibl": 8, "common": 8, "task": 8, "prefer": [3, 4, 8], "typescript": [3, 8], "equival": 8, "design": 8, "compos": 8, "read": 8, "logic": [3, 4, 8], "diagnos": 8, "packag": [5, 8], "modular": [4, 8], "thin": 8, "wrapper": [2, 8], "block": 8, "over": [3, 8], "primit": 8, "expos": [1, 2, 8], "wherev": 8, "opt": [0, 2, 8], "approach": [2, 8], "safeti": 8, "strong": 8, "support": [2, 3, 8], "effort": 8, "put": 8, "good": 8, "intellisens": 8, "built": [3, 8], "highli": 8, "mechan": 8, "terser": 8, "pip": 8, "poetri": 8, "simpli": [5, 8], "Then": 8, "variou": [1, 2, 4, 8], "favourit": 8, "integr": 8, "extens": [5, 8], "combin": [2, 8], "tool": [5, 8], "mypi": 8, "incorrect": 8, "incorrectli": 8, "multisig": 8, "inject": [1, 8], "beaker": [2, 3, 8], "safe": [3, 8], "retryabl": [3, 8], "immut": [3, 8], "perman": [3, 8], "we": 8, "natur": [3, 8], "evolv": [3, 8], "experi": 8, "improv": 8, "futur": [2, 8], "expand": 8, "blockchain": [0, 5, 8], "place": 0, "its": 0, "100": 0, "000": 0, "microalgo": 0, "opt_out": 0, "them": 0, "recov": 0, "optout": 0, "process": [0, 3], "permit": 0, "discontinu": 0, "persist_sourcemap": [0, 5], "persist": [0, 5], "avm": [0, 5, 8], "debugg": [0, 8], "simulate_and_persist_respons": [0, 5], "simul": [0, 2, 5, 8], "atom": [0, 3, 5], "integ": 0, "essenti": 0, "zero": 0, "_debug_util": [], "persistsourcemapinput": [0, 5], "project_root": [0, 5], "root": [0, 5], "buffer_size_mb": 0, "256": [0, 5], "size": [0, 5], "buffer": [0, 5], "megabyt": [0, 5], "256mb": 0, "core": [1, 3, 4], "well": 1, "encapsul": 1, "convent": [1, 3], "OR": [1, 2], "ny": 1, "power": 1, "new_account": 1, "generate_account": 1, "reli": 1, "being": [1, 3], "These": [1, 2, 3, 5, 8], "retriev": [1, 3, 4], "data": [2, 3], "correspond": 2, "instanti": 2, "By": [2, 5], "uncondition": 2, "app_lookup": 2, "search": [2, 5], "under": [2, 3], "overridden": 2, "deriv": 2, "suggest": 2, "no_op": 2, "update_appl": 2, "remov": [2, 5], "delete_appl": 2, "close": 2, "everyth": 2, "select": 2, "explicitli": 2, "infer": 2, "bare": 2, "compat": 2, "interpret": 2, "abireturnsubroutin": 2, "method_spec": 2, "algosd": 2, "python": [2, 3, 5], "keyword": 2, "hello": 2, "syntax": 2, "world": 2, "overrid": 2, "app_index": 2, "box_nam": 2, "page": 2, "suffici": 2, "dataclass": 2, "commoncallparamet": 2, "exact": 2, "depend": [2, 3], "compose_": 2, "onc": [2, 4], "ad": 2, "For": [2, 5], "execute_atc": 2, "let": 2, "caus": 2, "throw": 2, "becaus": 2, "assert": 2, "lack": 2, "exhaust": 2, "opcod": 2, "budget": 2, "reason": 2, "look": 2, "someth": 2, "transactionpool": 2, "rememb": 2, "eval": 2, "error_messag": 2, "program_counter_valu": 2, "list_of_op_cod": 2, "much": 2, "happen": [2, 3], "thrown": 2, "line_no": 2, "insight": 2, "format": 2, "surround": 2, "extend": 2, "show": 2, "alreadi": [2, 3], "previous": [2, 3], "crucial": 2, "complex": 2, "enabl": [2, 5], "particularli": 3, "articul": 3, "record": 3, "implement": 3, "diverg": 3, "principl": [3, 4], "comprehens": 3, "explain": 3, "concept": 3, "lifecycl": 3, "transpil": 3, "verifi": 3, "maintain": 3, "stabil": 3, "qualiti": 3, "final": 3, "runtim": 3, "confid": 3, "correct": 3, "utilis": 3, "furthermor": 3, "characterist": 3, "per": 3, "framework": 3, "0004": 3, "mean": [3, 5], "languag": 3, "explicit": 3, "upgrad": 3, "vari": 3, "present": 3, "whether": [3, 5], "had": 3, "creatoraccount": 3, "seri": 3, "lookup": 3, "payload": 3, "boolean": [3, 5], "chronolog": 3, "trivial": 3, "recommend": 3, "durat": 3, "recalcul": 3, "most": [3, 5], "fresh": 3, "detect": 3, "concert": 3, "reliabl": 3, "popul": 3, "sinc": 3, "again": 3, "appli": 3, "straight": 3, "after": [0, 3], "do": 3, "abov": 3, "In": 3, "arrai": 3, "wil": 3, "hexadecim": 3, "shouldn": 3, "beaker_product": 3, "action_taken": 3, "up": 3, "create_respons": 3, "update_respons": 3, "delete_respons": 3, "class": [4, 5], "inlin": 4, "produc": 4, "myalgodnod": 4, "secret_token": 4, "get_algonode_config": 4, "get_purestake_config": 4, "purestak": 4, "configorport": 4, "assumpt": 4, "host": 4, "optim": [5, 8], "who": [5, 8], "link": 5, "vscode": 5, "py": 5, "updatableconfig": 5, "attribut": 5, "mode": 5, "ignor": 5, "insid": 5, "toml": 5, "folder": 5, "algokit_project_root": 5, "trace_al": 5, "etc": 5, "trace_buffer_size_mb": 5, "exceed": 5, "oldest": 5, "consumpt": [0, 5], "max_search_depth": 5, "depth": 5, "travers": 5, "10": 5, "assum": 5, "simplifi": 5, "gather": 5, "debug": 8, "with_sourc": 0, "dump": [0, 5], "along": [0, 5], "_debug": 0, "thei": 5, "timestamp": 5, "_lr": 5, "last_round": 5, "_": 5, "transaction_typ": 5, "iso": 5, "8601": 5, "colon": 5, "period": 5, "count": 5, "underscor": 5, "might": 5, "20220301t123456z_lr1000_2": 5, "pay_1": 5, "axfer": 5, "2022": 5, "03": 5, "01t12": 5, "34": 5, "56z": 5}, "objects": {"": [[0, 0, 0, "-", "algokit_utils"]], "algokit_utils": [[0, 1, 1, "", "ABICallArgs"], [0, 1, 1, "", "ABICallArgsDict"], [0, 1, 1, "", "ABICreateCallArgs"], [0, 1, 1, "", "ABICreateCallArgsDict"], [0, 1, 1, "", "ABITransactionResponse"], [0, 1, 1, "", "Account"], [0, 1, 1, "", "AlgoClientConfig"], [0, 1, 1, "", "AppDeployMetaData"], [0, 1, 1, "", "AppLookup"], [0, 1, 1, "", "AppMetaData"], [0, 1, 1, "", "AppReference"], [0, 4, 1, "", "AppSpecStateDict"], [0, 1, 1, "", "ApplicationClient"], [0, 1, 1, "", "ApplicationSpecification"], [0, 1, 1, "", "CallConfig"], [0, 1, 1, "", "CreateCallParameters"], [0, 1, 1, "", "CreateCallParametersDict"], [0, 1, 1, "", "CreateTransactionParameters"], [0, 4, 1, "", "DELETABLE_TEMPLATE_NAME"], [0, 1, 1, "", "DefaultArgumentDict"], [0, 4, 1, "", "DefaultArgumentType"], [0, 1, 1, "", "DeployCallArgs"], [0, 1, 1, "", "DeployCallArgsDict"], [0, 1, 1, "", "DeployCreateCallArgs"], [0, 1, 1, "", "DeployCreateCallArgsDict"], [0, 1, 1, "", "DeployResponse"], [0, 6, 1, "", "DeploymentFailedError"], [0, 1, 1, "", "EnsureBalanceParameters"], [0, 1, 1, "", "EnsureFundedResponse"], [0, 6, 1, "", "LogicError"], [0, 4, 1, "", "MethodConfigDict"], [0, 1, 1, "", "MethodHints"], [0, 4, 1, "", "NOTE_PREFIX"], [0, 4, 1, "", "OnCompleteActionName"], [0, 1, 1, "", "OnCompleteCallParameters"], [0, 1, 1, "", "OnCompleteCallParametersDict"], [0, 1, 1, "", "OnSchemaBreak"], [0, 1, 1, "", "OnUpdate"], [0, 1, 1, "", "OperationPerformed"], [0, 1, 1, "", "Program"], [0, 4, 1, "", "TemplateValueDict"], [0, 4, 1, "", "TemplateValueMapping"], [0, 1, 1, "", "TestNetDispenserApiClient"], [0, 1, 1, "", "TransactionParameters"], [0, 1, 1, "", "TransactionParametersDict"], [0, 1, 1, "", "TransactionResponse"], [0, 1, 1, "", "TransferAssetParameters"], [0, 1, 1, "", "TransferParameters"], [0, 4, 1, "", "UPDATABLE_TEMPLATE_NAME"], [0, 7, 1, "", "create_kmd_wallet_account"], [0, 7, 1, "", "ensure_funded"], [0, 7, 1, "", "execute_atc_with_logic_error"], [0, 7, 1, "", "get_account"], [0, 7, 1, "", "get_account_from_mnemonic"], [0, 7, 1, "", "get_algod_client"], [0, 7, 1, "", "get_app_id_from_tx_id"], [0, 7, 1, "", "get_creator_apps"], [0, 7, 1, "", "get_default_localnet_config"], [0, 7, 1, "", "get_dispenser_account"], [0, 7, 1, "", "get_indexer_client"], [0, 7, 1, "", "get_kmd_client_from_algod_client"], [0, 7, 1, "", "get_kmd_wallet_account"], [0, 7, 1, "", "get_localnet_default_account"], [0, 7, 1, "", "get_next_version"], [0, 7, 1, "", "get_or_create_kmd_wallet_account"], [0, 7, 1, "", "get_sender_from_signer"], [0, 7, 1, "", "is_localnet"], [0, 7, 1, "", "is_mainnet"], [0, 7, 1, "", "is_testnet"], [0, 7, 1, "", "num_extra_program_pages"], [0, 7, 1, "", "opt_in"], [0, 7, 1, "", "opt_out"], [0, 7, 1, "", "persist_sourcemaps"], [0, 7, 1, "", "replace_template_variables"], [0, 7, 1, "", "simulate_and_persist_response"], [0, 7, 1, "", "transfer"], [0, 7, 1, "", "transfer_asset"]], "algokit_utils.ABITransactionResponse": [[0, 2, 1, "", "decode_error"], [0, 2, 1, "", "method"], [0, 2, 1, "", "raw_value"], [0, 2, 1, "", "return_value"], [0, 2, 1, "", "tx_info"]], "algokit_utils.Account": [[0, 2, 1, "", "address"], [0, 2, 1, "", "private_key"], [0, 3, 1, "", "public_key"], [0, 3, 1, "", "signer"]], "algokit_utils.AlgoClientConfig": [[0, 2, 1, "", "server"], [0, 2, 1, "", "token"]], "algokit_utils.ApplicationClient": [[0, 5, 1, "", "add_method_call"], [0, 5, 1, "", "call"], [0, 5, 1, "", "clear_state"], [0, 5, 1, "", "close_out"], [0, 5, 1, "", "compose_call"], [0, 5, 1, "", "compose_clear_state"], [0, 5, 1, "", "compose_close_out"], [0, 5, 1, "", "compose_create"], [0, 5, 1, "", "compose_delete"], [0, 5, 1, "", "compose_opt_in"], [0, 5, 1, "", "compose_update"], [0, 5, 1, "", "create"], [0, 5, 1, "", "delete"], [0, 5, 1, "", "deploy"], [0, 5, 1, "", "export_source_map"], [0, 5, 1, "", "get_global_state"], [0, 5, 1, "", "get_local_state"], [0, 5, 1, "", "get_signer_sender"], [0, 5, 1, "", "import_source_map"], [0, 5, 1, "", "opt_in"], [0, 5, 1, "", "prepare"], [0, 5, 1, "", "resolve"], [0, 5, 1, "", "resolve_signer_sender"], [0, 5, 1, "", "update"]], "algokit_utils.ApplicationSpecification": [[0, 5, 1, "", "export"]], "algokit_utils.CallConfig": [[0, 2, 1, "", "ALL"], [0, 2, 1, "", "CALL"], [0, 2, 1, "", "CREATE"], [0, 2, 1, "", "NEVER"]], "algokit_utils.EnsureBalanceParameters": [[0, 2, 1, "", "account_to_fund"], [0, 2, 1, "", "fee_micro_algos"], [0, 2, 1, "", "funding_source"], [0, 2, 1, "", "max_fee_micro_algos"], [0, 2, 1, "", "min_funding_increment_micro_algos"], [0, 2, 1, "", "min_spending_balance_micro_algos"], [0, 2, 1, "", "note"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.EnsureFundedResponse": [[0, 2, 1, "", "transaction_id"]], "algokit_utils.OnSchemaBreak": [[0, 2, 1, "", "AppendApp"], [0, 2, 1, "", "Fail"], [0, 2, 1, "", "ReplaceApp"]], "algokit_utils.OnUpdate": [[0, 2, 1, "", "AppendApp"], [0, 2, 1, "", "Fail"], [0, 2, 1, "", "ReplaceApp"], [0, 2, 1, "", "UpdateApp"]], "algokit_utils.OperationPerformed": [[0, 2, 1, "", "Create"], [0, 2, 1, "", "Nothing"], [0, 2, 1, "", "Replace"], [0, 2, 1, "", "Update"]], "algokit_utils.TestNetDispenserApiClient": [[0, 5, 1, "", "fund"], [0, 5, 1, "", "get_limit"], [0, 5, 1, "", "refund"]], "algokit_utils.TransactionParameters": [[0, 2, 1, "", "accounts"], [0, 2, 1, "", "boxes"], [0, 2, 1, "", "foreign_apps"], [0, 2, 1, "", "foreign_assets"], [0, 2, 1, "", "lease"], [0, 2, 1, "", "note"], [0, 2, 1, "", "rekey_to"], [0, 2, 1, "", "sender"], [0, 2, 1, "", "signer"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.TransactionParametersDict": [[0, 2, 1, "", "accounts"], [0, 2, 1, "", "boxes"], [0, 2, 1, "", "foreign_apps"], [0, 2, 1, "", "foreign_assets"], [0, 2, 1, "", "lease"], [0, 2, 1, "", "note"], [0, 2, 1, "", "rekey_to"], [0, 2, 1, "", "sender"], [0, 2, 1, "", "signer"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.TransactionResponse": [[0, 2, 1, "", "confirmed_round"], [0, 5, 1, "", "from_atr"], [0, 2, 1, "", "tx_id"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:property", "4": "py:data", "5": "py:method", "6": "py:exception", "7": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"], "4": ["py", "data", "Python data"], "5": ["py", "method", "Python method"], "6": ["py", "exception", "Python exception"], "7": ["py", "function", "Python function"]}, "titleterms": {"algokit_util": 0, "packag": 0, "content": [0, 8], "class": 0, "function": 0, "data": 0, "api": 0, "convent": 0, "exampl": 0, "testnet": 6, "dispens": [6, 7], "client": [2, 4, 6], "creat": [2, 6], "fund": 6, "an": [2, 3, 6], "account": [1, 6], "regist": 6, "refund": 6, "get": 6, "current": 6, "limit": 6, "error": [2, 6], "handl": [2, 6], "algo": 7, "transfer": 7, "ensur": 7, "minimum": 7, "asset": 7, "algokit": 8, "python": 8, "util": [5, 8], "core": 8, "principl": 8, "instal": 8, "usag": 8, "type": 8, "capabl": 8, "refer": 8, "document": 8, "roadmap": 8, "indic": 8, "tabl": 8, "manag": [1, 4], "app": [2, 3], "design": [2, 3], "applic": [2, 3], "call": 2, "method": 2, "specifi": 2, "which": 2, "abi": 2, "argument": 2, "transact": 2, "paramet": [2, 3], "compos": 2, "read": 2, "state": 2, "logic": 2, "diagnos": 2, "debug": [2, 5], "mode": 2, "trace": [2, 5], "field": 2, "deploy": 3, "find": 3, "creator": 3, "deploi": 3, "input": 3, "idempot": 3, "compil": 3, "templat": 3, "substitut": 3, "return": 3, "valu": 3, "network": 4, "configur": [4, 5], "debugg": 5, "filenam": 5, "format": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Account management": [[1, "account-management"]], "Account": [[1, "account"]], "App client": [[2, "app-client"]], "Design": [[2, "design"], [3, "design"]], "Creating an application client": [[2, "creating-an-application-client"]], "Calling methods on the app": [[2, "calling-methods-on-the-app"]], "Specifying which method": [[2, "specifying-which-method"]], "ABI arguments": [[2, "abi-arguments"]], "Transaction Parameters": [[2, "transaction-parameters"]], "Composing calls": [[2, "composing-calls"]], "Reading state": [[2, "reading-state"]], "Handling logic errors and diagnosing errors": [[2, "handling-logic-errors-and-diagnosing-errors"]], "Debug Mode and traces Field": [[2, "debug-mode-and-traces-field"]], "Client management": [[4, "client-management"]], "Network configuration": [[4, "network-configuration"]], "Clients": [[4, "clients"]], "App deployment": [[3, "app-deployment"]], "Finding apps by creator": [[3, "finding-apps-by-creator"]], "Deploying an application": [[3, "deploying-an-application"]], "Input parameters": [[3, "input-parameters"]], "Idempotency": [[3, "idempotency"]], "Compilation and template substitution": [[3, "compilation-and-template-substitution"]], "Return value": [[3, "return-value"]], "TestNet Dispenser Client": [[6, "testnet-dispenser-client"]], "Creating a Dispenser Client": [[6, "creating-a-dispenser-client"]], "Funding an Account": [[6, "funding-an-account"]], "Registering a Refund": [[6, "registering-a-refund"]], "Getting Current Limit": [[6, "getting-current-limit"]], "Error Handling": [[6, "error-handling"]], "Algo transfers": [[7, "algo-transfers"]], "Transferring Algos": [[7, "transferring-algos"]], "Ensuring minimum Algos": [[7, "ensuring-minimum-algos"]], "Transfering Assets": [[7, "transfering-assets"]], "Dispenser": [[7, "dispenser"]], "AlgoKit Python Utilities": [[8, "algokit-python-utilities"]], "Contents": [[8, null]], "Core principles": [[8, "core-principles"]], "Installation": [[8, "installation"]], "Usage": [[8, "usage"]], "Types": [[8, "types"]], "Capabilities": [[8, "capabilities"]], "Reference documentation": [[8, "reference-documentation"]], "Roadmap": [[8, "roadmap"]], "Indices and tables": [[8, "indices-and-tables"]], "algokit_utils": [[0, "module-algokit_utils"]], "Package Contents": [[0, "package-contents"]], "Classes": [[0, "classes"]], "Functions": [[0, "functions"]], "Data": [[0, "data"]], "API": [[0, "api"]], "Convention": [[0, "convention"]], "Example": [[0, "example"]], "Debugger": [[5, "debugger"]], "Configuration": [[5, "configuration"]], "Debugging Utilities": [[5, "debugging-utilities"]], "Trace filename format": [[5, "trace-filename-format"]]}, "indexentries": {"abicallargs (class in algokit_utils)": [[0, "algokit_utils.ABICallArgs"]], "abicallargsdict (class in algokit_utils)": [[0, "algokit_utils.ABICallArgsDict"]], "abicreatecallargs (class in algokit_utils)": [[0, "algokit_utils.ABICreateCallArgs"]], "abicreatecallargsdict (class in algokit_utils)": [[0, "algokit_utils.ABICreateCallArgsDict"]], "abitransactionresponse (class in algokit_utils)": [[0, "algokit_utils.ABITransactionResponse"]], "all (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.ALL"]], "account (class in algokit_utils)": [[0, "algokit_utils.Account"]], "algoclientconfig (class in algokit_utils)": [[0, "algokit_utils.AlgoClientConfig"]], "appdeploymetadata (class in algokit_utils)": [[0, "algokit_utils.AppDeployMetaData"]], "applookup (class in algokit_utils)": [[0, "algokit_utils.AppLookup"]], "appmetadata (class in algokit_utils)": [[0, "algokit_utils.AppMetaData"]], "appreference (class in algokit_utils)": [[0, "algokit_utils.AppReference"]], "appspecstatedict (in module algokit_utils)": [[0, "algokit_utils.AppSpecStateDict"]], "appendapp (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.AppendApp"]], "appendapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.AppendApp"]], "applicationclient (class in algokit_utils)": [[0, "algokit_utils.ApplicationClient"]], "applicationspecification (class in algokit_utils)": [[0, "algokit_utils.ApplicationSpecification"]], "call (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.CALL"]], "create (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.CREATE"]], "callconfig (class in algokit_utils)": [[0, "algokit_utils.CallConfig"]], "create (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Create"]], "createcallparameters (class in algokit_utils)": [[0, "algokit_utils.CreateCallParameters"]], "createcallparametersdict (class in algokit_utils)": [[0, "algokit_utils.CreateCallParametersDict"]], "createtransactionparameters (class in algokit_utils)": [[0, "algokit_utils.CreateTransactionParameters"]], "deletable_template_name (in module algokit_utils)": [[0, "algokit_utils.DELETABLE_TEMPLATE_NAME"]], "defaultargumentdict (class in algokit_utils)": [[0, "algokit_utils.DefaultArgumentDict"]], "defaultargumenttype (in module algokit_utils)": [[0, "algokit_utils.DefaultArgumentType"]], "deploycallargs (class in algokit_utils)": [[0, "algokit_utils.DeployCallArgs"]], "deploycallargsdict (class in algokit_utils)": [[0, "algokit_utils.DeployCallArgsDict"]], "deploycreatecallargs (class in algokit_utils)": [[0, "algokit_utils.DeployCreateCallArgs"]], "deploycreatecallargsdict (class in algokit_utils)": [[0, "algokit_utils.DeployCreateCallArgsDict"]], "deployresponse (class in algokit_utils)": [[0, "algokit_utils.DeployResponse"]], "deploymentfailederror": [[0, "algokit_utils.DeploymentFailedError"]], "ensurebalanceparameters (class in algokit_utils)": [[0, "algokit_utils.EnsureBalanceParameters"]], "ensurefundedresponse (class in algokit_utils)": [[0, "algokit_utils.EnsureFundedResponse"]], "fail (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.Fail"]], "fail (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.Fail"]], "logicerror": [[0, "algokit_utils.LogicError"]], "methodconfigdict (in module algokit_utils)": [[0, "algokit_utils.MethodConfigDict"]], "methodhints (class in algokit_utils)": [[0, "algokit_utils.MethodHints"]], "never (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.NEVER"]], "note_prefix (in module algokit_utils)": [[0, "algokit_utils.NOTE_PREFIX"]], "nothing (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Nothing"]], "oncompleteactionname (in module algokit_utils)": [[0, "algokit_utils.OnCompleteActionName"]], "oncompletecallparameters (class in algokit_utils)": [[0, "algokit_utils.OnCompleteCallParameters"]], "oncompletecallparametersdict (class in algokit_utils)": [[0, "algokit_utils.OnCompleteCallParametersDict"]], "onschemabreak (class in algokit_utils)": [[0, "algokit_utils.OnSchemaBreak"]], "onupdate (class in algokit_utils)": [[0, "algokit_utils.OnUpdate"]], "operationperformed (class in algokit_utils)": [[0, "algokit_utils.OperationPerformed"]], "program (class in algokit_utils)": [[0, "algokit_utils.Program"]], "replace (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Replace"]], "replaceapp (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.ReplaceApp"]], "replaceapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.ReplaceApp"]], "templatevaluedict (in module algokit_utils)": [[0, "algokit_utils.TemplateValueDict"]], "templatevaluemapping (in module algokit_utils)": [[0, "algokit_utils.TemplateValueMapping"]], "testnetdispenserapiclient (class in algokit_utils)": [[0, "algokit_utils.TestNetDispenserApiClient"]], "transactionparameters (class in algokit_utils)": [[0, "algokit_utils.TransactionParameters"]], "transactionparametersdict (class in algokit_utils)": [[0, "algokit_utils.TransactionParametersDict"]], "transactionresponse (class in algokit_utils)": [[0, "algokit_utils.TransactionResponse"]], "transferassetparameters (class in algokit_utils)": [[0, "algokit_utils.TransferAssetParameters"]], "transferparameters (class in algokit_utils)": [[0, "algokit_utils.TransferParameters"]], "updatable_template_name (in module algokit_utils)": [[0, "algokit_utils.UPDATABLE_TEMPLATE_NAME"]], "update (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Update"]], "updateapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.UpdateApp"]], "account_to_fund (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.account_to_fund"]], "accounts (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.accounts"]], "accounts (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.accounts"]], "add_method_call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.add_method_call"]], "address (algokit_utils.account attribute)": [[0, "algokit_utils.Account.address"]], "algokit_utils": [[0, "module-algokit_utils"]], "boxes (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.boxes"]], "boxes (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.boxes"]], "call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.call"]], "clear_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.clear_state"]], "close_out() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.close_out"]], "compose_call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_call"]], "compose_clear_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_clear_state"]], "compose_close_out() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_close_out"]], "compose_create() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_create"]], "compose_delete() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_delete"]], "compose_opt_in() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_opt_in"]], "compose_update() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_update"]], "confirmed_round (algokit_utils.transactionresponse attribute)": [[0, "algokit_utils.TransactionResponse.confirmed_round"]], "create() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.create"]], "create_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.create_kmd_wallet_account"]], "decode_error (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.decode_error"]], "delete() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.delete"]], "deploy() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.deploy"]], "ensure_funded() (in module algokit_utils)": [[0, "algokit_utils.ensure_funded"]], "execute_atc_with_logic_error() (in module algokit_utils)": [[0, "algokit_utils.execute_atc_with_logic_error"]], "export() (algokit_utils.applicationspecification method)": [[0, "algokit_utils.ApplicationSpecification.export"]], "export_source_map() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.export_source_map"]], "fee_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.fee_micro_algos"]], "foreign_apps (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.foreign_apps"]], "foreign_apps (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.foreign_apps"]], "foreign_assets (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.foreign_assets"]], "foreign_assets (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.foreign_assets"]], "from_atr() (algokit_utils.transactionresponse static method)": [[0, "algokit_utils.TransactionResponse.from_atr"]], "fund() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.fund"]], "funding_source (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.funding_source"]], "get_account() (in module algokit_utils)": [[0, "algokit_utils.get_account"]], "get_account_from_mnemonic() (in module algokit_utils)": [[0, "algokit_utils.get_account_from_mnemonic"]], "get_algod_client() (in module algokit_utils)": [[0, "algokit_utils.get_algod_client"]], "get_app_id_from_tx_id() (in module algokit_utils)": [[0, "algokit_utils.get_app_id_from_tx_id"]], "get_creator_apps() (in module algokit_utils)": [[0, "algokit_utils.get_creator_apps"]], "get_default_localnet_config() (in module algokit_utils)": [[0, "algokit_utils.get_default_localnet_config"]], "get_dispenser_account() (in module algokit_utils)": [[0, "algokit_utils.get_dispenser_account"]], "get_global_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_global_state"]], "get_indexer_client() (in module algokit_utils)": [[0, "algokit_utils.get_indexer_client"]], "get_kmd_client_from_algod_client() (in module algokit_utils)": [[0, "algokit_utils.get_kmd_client_from_algod_client"]], "get_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.get_kmd_wallet_account"]], "get_limit() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.get_limit"]], "get_local_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_local_state"]], "get_localnet_default_account() (in module algokit_utils)": [[0, "algokit_utils.get_localnet_default_account"]], "get_next_version() (in module algokit_utils)": [[0, "algokit_utils.get_next_version"]], "get_or_create_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.get_or_create_kmd_wallet_account"]], "get_sender_from_signer() (in module algokit_utils)": [[0, "algokit_utils.get_sender_from_signer"]], "get_signer_sender() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_signer_sender"]], "import_source_map() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.import_source_map"]], "is_localnet() (in module algokit_utils)": [[0, "algokit_utils.is_localnet"]], "is_mainnet() (in module algokit_utils)": [[0, "algokit_utils.is_mainnet"]], "is_testnet() (in module algokit_utils)": [[0, "algokit_utils.is_testnet"]], "lease (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.lease"]], "lease (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.lease"]], "max_fee_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.max_fee_micro_algos"]], "method (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.method"]], "min_funding_increment_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.min_funding_increment_micro_algos"]], "min_spending_balance_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.min_spending_balance_micro_algos"]], "module": [[0, "module-algokit_utils"]], "note (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.note"]], "note (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.note"]], "note (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.note"]], "num_extra_program_pages() (in module algokit_utils)": [[0, "algokit_utils.num_extra_program_pages"]], "opt_in() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.opt_in"]], "opt_in() (in module algokit_utils)": [[0, "algokit_utils.opt_in"]], "opt_out() (in module algokit_utils)": [[0, "algokit_utils.opt_out"]], "persist_sourcemaps() (in module algokit_utils)": [[0, "algokit_utils.persist_sourcemaps"]], "prepare() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.prepare"]], "private_key (algokit_utils.account attribute)": [[0, "algokit_utils.Account.private_key"]], "public_key (algokit_utils.account property)": [[0, "algokit_utils.Account.public_key"]], "raw_value (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.raw_value"]], "refund() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.refund"]], "rekey_to (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.rekey_to"]], "rekey_to (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.rekey_to"]], "replace_template_variables() (in module algokit_utils)": [[0, "algokit_utils.replace_template_variables"]], "resolve() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.resolve"]], "resolve_signer_sender() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.resolve_signer_sender"]], "return_value (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.return_value"]], "sender (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.sender"]], "sender (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.sender"]], "server (algokit_utils.algoclientconfig attribute)": [[0, "algokit_utils.AlgoClientConfig.server"]], "signer (algokit_utils.account property)": [[0, "algokit_utils.Account.signer"]], "signer (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.signer"]], "signer (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.signer"]], "simulate_and_persist_response() (in module algokit_utils)": [[0, "algokit_utils.simulate_and_persist_response"]], "suggested_params (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.suggested_params"]], "suggested_params (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.suggested_params"]], "suggested_params (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.suggested_params"]], "token (algokit_utils.algoclientconfig attribute)": [[0, "algokit_utils.AlgoClientConfig.token"]], "transaction_id (algokit_utils.ensurefundedresponse attribute)": [[0, "algokit_utils.EnsureFundedResponse.transaction_id"]], "transfer() (in module algokit_utils)": [[0, "algokit_utils.transfer"]], "transfer_asset() (in module algokit_utils)": [[0, "algokit_utils.transfer_asset"]], "tx_id (algokit_utils.transactionresponse attribute)": [[0, "algokit_utils.TransactionResponse.tx_id"]], "tx_info (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.tx_info"]], "update() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.update"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["apidocs/algokit_utils/algokit_utils", "capabilities/account", "capabilities/app-client", "capabilities/app-deploy", "capabilities/client", "capabilities/debugging", "capabilities/dispenser-client", "capabilities/transfer", "index"], "filenames": ["apidocs/algokit_utils/algokit_utils.md", "capabilities/account.md", "capabilities/app-client.md", "capabilities/app-deploy.md", "capabilities/client.md", "capabilities/debugging.md", "capabilities/dispenser-client.md", "capabilities/transfer.md", "index.md"], "titles": ["algokit_utils", "Account management", "App client", "App deployment", "Client management", "Debugger", "TestNet Dispenser Client", "Algo transfers", "AlgoKit Python Utilities"], "terms": {"abicallarg": 0, "abi": 0, "paramet": [0, 7], "us": [0, 1, 2, 3, 4, 5, 6, 7, 8], "updat": [0, 2, 3, 5], "delet": [0, 2, 3], "an": [0, 1, 4, 5, 7, 8], "applic": [0, 5, 8], "when": [0, 1, 2, 3, 5, 7], "call": [0, 3, 5, 7, 8], "deploi": [0, 1, 2, 8], "abicallargsdict": 0, "abicreatecallarg": 0, "creat": [0, 1, 3, 4, 5, 8], "abicreatecallargsdict": 0, "abitransactionrespons": [0, 3], "respons": [0, 2, 5, 6], "account": [0, 2, 7, 8], "hold": [0, 3], "private_kei": [0, 1], "address": [0, 1, 2, 6, 7], "algoclientconfig": [0, 4], "connect": 0, "detail": [0, 2, 6], "algosdk": [0, 1, 2, 4], "v2client": [0, 4], "algod": [0, 3, 4, 7, 8], "algodcli": [0, 2, 4, 5], "index": [0, 2, 3, 4, 8], "indexercli": [0, 4], "appdeploymetadata": 0, "metadata": [0, 3], "about": [0, 5], "store": [0, 5, 7], "transact": [0, 1, 3, 5, 6, 7, 8], "note": [0, 2, 3, 7], "dure": [0, 2, 3, 7], "creation": [0, 3, 8], "applookup": [0, 3], "cach": 0, "appmetadata": [0, 3], "specif": [0, 2, 5], "creator": [0, 2, 8], "app": [0, 7, 8], "apprefer": 0, "inform": [0, 2, 5], "algorand": [0, 3, 5, 8], "applicationcli": [0, 2, 3], "A": [0, 2, 5, 8], "wrap": [0, 2, 8], "arc": [0, 2, 3, 8], "0032": [0, 2, 3, 8], "spec": [0, 2, 8], "provid": [0, 1, 2, 3, 4, 5, 6, 7, 8], "high": [0, 2, 8], "product": [0, 2, 8], "method": [0, 1, 3, 5, 6, 8], "applicationspecif": [0, 2], "callconfig": 0, "describ": [0, 3], "type": [0, 2, 5, 6], "can": [0, 1, 2, 3, 4, 5, 6, 7, 8], "base": [0, 1, 2, 3, 4], "oncomplet": 0, "createcallparamet": [0, 2], "addit": [0, 1, 2, 8], "includ": [0, 2, 3, 7, 8], "compose_cr": 0, "createcallparametersdict": 0, "createtransactionparamet": 0, "defaultargumentdict": 0, "defaultargu": 0, "i": [0, 1, 2, 3, 4, 5, 6, 7, 8], "contain": [0, 1, 2, 3, 5, 6, 8], "ani": [0, 2, 3, 4, 5, 6, 8], "argument": [0, 6], "mai": [0, 2], "resolv": [0, 1, 3, 4, 8], "prior": [0, 7], "some": [0, 1, 2, 3, 4, 7], "target": 0, "deploycallarg": 0, "deploycallargsdict": 0, "deploycreatecallarg": 0, "deploycreatecallargsdict": 0, "deployrespons": [0, 3], "action": [0, 2, 3], "taken": [0, 3], "deploy": [0, 2, 7, 8], "relat": 0, "ensurebalanceparamet": [0, 7], "ensur": [0, 8], "ha": [0, 2, 3, 5, 7, 8], "minimum": [0, 8], "number": [0, 2, 3, 4, 7, 8], "\u00b5algo": 0, "ensurefundedrespons": [0, 7], "methodhint": 0, "hint": [0, 8], "caller": 0, "how": [0, 6], "oncompletecallparamet": [0, 2], "compose_cal": [0, 2], "oncompletecallparametersdict": 0, "onschemabreak": 0, "take": [0, 2, 3, 4, 5, 6, 7], "": [0, 2, 3, 6, 7, 8], "schema": [0, 3], "break": [0, 3], "chang": [0, 3], "onupd": 0, "been": [0, 2, 3, 8], "operationperform": 0, "program": [0, 2], "compil": [0, 2], "teal": [0, 2, 3, 5, 8], "testnetdispenserapicli": [0, 6, 7], "client": [0, 5, 7, 8], "interact": [0, 5, 6], "algokit": [0, 1, 2, 3, 4, 5, 6, 7], "testnet": [0, 1, 3, 4, 7, 8], "dispens": [0, 1, 8], "To": [0, 2, 3, 4, 5, 6, 7, 8], "get": [0, 1, 2, 4, 7, 8], "start": 0, "new": [0, 1, 2, 3], "access": [0, 2, 7], "token": [0, 4, 6, 7], "via": [0, 2, 3, 5, 6, 7, 8], "login": 0, "ci": 0, "pass": [0, 2, 6], "constructor": [0, 6], "auth_token": [0, 6], "altern": [0, 2, 5], "set": [0, 2, 3, 5, 6, 7, 8], "environ": [0, 1, 3, 4, 5, 6, 7, 8], "variabl": [0, 1, 2, 4, 5, 6, 7, 8], "algokit_dispenser_access_token": [0, 6, 7], "auto": [0, 8], "load": [0, 1, 4], "If": [0, 1, 2, 3, 6, 7, 8], "both": [0, 2, 6], "ar": [0, 1, 2, 3, 4, 5, 6, 7, 8], "preced": [0, 6], "transactionparamet": 0, "transactionrespons": [0, 3], "non": [0, 3, 5], "transferassetparamet": [0, 7], "transfer": [0, 5, 8], "asset": [0, 2, 5, 6, 8], "between": [0, 7, 8], "transferparamet": [0, 7], "create_kmd_wallet_account": [0, 1], "wallet": [0, 1], "specifi": [0, 3, 4, 7, 8], "name": [0, 1, 2, 3, 5], "ensure_fund": [0, 7], "fund": [0, 1, 7, 8], "given": [0, 1, 2, 3, 4, 5], "sourc": [0, 2, 5], "certain": 0, "amount": [0, 2, 6, 7], "algo": [0, 1, 6, 8], "free": 0, "spend": [0, 7], "lock": 0, "balanc": [0, 7], "requir": [0, 2, 6, 7], "see": [0, 2, 3, 4, 6, 7], "http": [0, 4], "develop": [0, 2, 3, 5, 8], "org": 0, "doc": [0, 6, 8], "execute_atc_with_logic_error": 0, "atomictransactioncompos": [0, 2, 5], "execut": [0, 2, 3], "atc": [0, 2], "pars": [0, 2], "error": [0, 8], "rais": [0, 6], "logicerror": [0, 2], "possibl": [0, 2, 7, 8], "get_account": [0, 1], "return": [0, 1, 2, 4, 6, 7], "privat": [0, 1, 7], "kei": [0, 1, 2, 3, 7], "identifi": [0, 1, 2, 8], "get_account_from_mnemon": [0, 1], "convert": 0, "mnemon": [0, 1, 7, 8], "25": 0, "word": 0, "passphras": 0, "get_algod_cli": [0, 4], "from": [0, 1, 2, 3, 4, 5, 6, 8], "config": [0, 2, 4, 5], "get_app_id_from_tx_id": 0, "find": [0, 2, 7, 8], "app_id": [0, 2], "id": [0, 2, 3, 6, 7, 8], "get_creator_app": [0, 3], "map": [0, 2, 3], "all": [0, 2, 3, 5, 8], "have": [0, 1, 2, 3, 4, 7, 8], "get_default_localnet_config": [0, 4], "configur": [0, 3, 8], "point": 0, "default": [0, 1, 2, 4, 5, 7, 8], "localnet": [0, 1, 3, 4, 7], "get_dispenser_account": [0, 1, 7], "dispenser_mnenom": 0, "get_indexer_cli": [0, 4], "get_kmd_client_from_algod_cli": [0, 4], "kmd": [0, 1, 4, 7, 8], "kmdclient": [0, 4], "suppli": [0, 3], "get_kmd_wallet_account": [0, 1], "match": 0, "predic": 0, "none": [0, 2, 4, 7], "found": [0, 3], "get_localnet_default_account": [0, 1], "instanc": [0, 1, 2, 3, 4, 7], "get_next_vers": 0, "calcul": [0, 2], "next": 0, "version": [0, 3], "current_vers": 0, "get_or_create_kmd_wallet_account": [0, 1], "one": [0, 1, 2, 3, 4], "get_sender_from_sign": 0, "associ": [0, 1, 2], "signer": [0, 1, 2, 3, 7, 8], "is_localnet": 0, "true": [0, 2, 5, 7], "genesi": 0, "devnet": 0, "v1": 0, "sandnet": 0, "is_mainnet": 0, "mainnet": [0, 1, 3, 4, 7], "is_testnet": 0, "num_extra_program_pag": 0, "extra_pag": [0, 2], "approv": [0, 2], "clear": [0, 2], "replace_template_vari": 0, "replac": [0, 2, 3], "tmpl_": [0, 2, 3], "template_valu": [0, 2, 3], "transfer_asset": [0, 7], "appspecstatedict": 0, "defin": [0, 2, 3, 8], "state": [0, 3, 8], "entri": 0, "deletable_template_nam": 0, "templat": [0, 2, 8], "control": [0, 3, 8], "smart": [0, 2, 3, 5, 8], "contract": [0, 2, 3, 5, 8], "defaultargumenttyp": 0, "liter": 0, "valu": [0, 2, 5, 7], "methodconfigdict": 0, "dictionari": [0, 2], "dict": 0, "oncompletionactionnam": 0, "repres": [0, 1, 5], "allow": [0, 1, 2, 3, 4, 7], "each": [0, 5, 6], "complet": [0, 2, 8], "note_prefix": 0, "0002": 0, "compliant": [0, 5], "prefix": 0, "oncompleteactionnam": 0, "string": [0, 2, 3, 5, 7], "templatevaluedict": 0, "str": [0, 2], "int": 0, "byte": [0, 3], "templatevaluemap": 0, "updatable_template_nam": 0, "abical": 0, "typeddict": 0, "initi": [0, 6, 7, 8], "self": 0, "help": [0, 3, 8], "accur": 0, "signatur": [0, 2], "model": 0, "gener": [0, 2, 7, 8], "returntyp": 0, "decode_error": 0, "except": [0, 2, 6], "occur": [0, 2, 6], "attempt": [0, 2, 7], "decod": 0, "raw_valu": 0, "make": [0, 2, 6, 7, 8], "The": [0, 2, 3, 4, 5, 6, 7, 8], "raw": [0, 2], "befor": [0, 2], "return_valu": 0, "result": [0, 2, 3], "tx_info": 0, "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8], "base64": 0, "encod": [0, 3], "properti": [0, 1], "public_kei": [0, 1], "public": 0, "atomic_transaction_compos": [0, 2], "accounttransactionsign": [0, 7], "server": [0, 4], "url": 0, "servic": [0, 1, 4, 7], "e": [0, 2, 3, 4, 7, 8], "g": [0, 2, 3, 4, 8], "localhost": 0, "4001": 0, "algonod": 0, "cloud": 0, "authent": 0, "serial": 0, "json": [0, 5], "field": [0, 3, 6, 7], "part": [0, 8], "reduc": 0, "multipl": [0, 2, 3], "discov": 0, "typealia": 0, "algod_cli": [0, 2, 7], "app_spec": [0, 2, 3], "application_specif": 0, "pathlib": 0, "path": [0, 5], "0": [0, 2, 3, 6, 7], "indexer_cli": 0, "existing_deploy": 0, "transactionsign": [0, 2], "sender": [0, 1, 2, 3, 6], "suggested_param": [0, 2, 7], "suggestedparam": [0, 2, 7], "app_nam": [0, 2], "exist": [0, 1, 2, 3, 4], "instead": [0, 2, 3], "onli": [0, 1, 2, 3], "sign": [0, 1, 2], "wa": [0, 3, 5, 7], "should": [0, 2, 3, 7], "NOT": 0, "add_method_cal": 0, "abi_method": 0, "abimethod": 0, "bool": 0, "abi_arg": 0, "abiargsdict": 0, "transactionparametersdict": 0, "on_complet": [0, 2], "noopoc": 0, "local_schema": 0, "stateschema": 0, "global_schema": 0, "approval_program": 0, "clear_program": 0, "app_arg": 0, "list": [0, 2, 5], "call_config": 0, "au_spec": 0, "add": [0, 3, 8], "call_abi_method": [0, 2], "transaction_paramet": [0, 2], "abi_kwarg": 0, "abiargtyp": 0, "submit": 0, "clear_stat": [0, 2], "clearstat": 0, "close_out": [0, 2], "closeout": 0, "compose_clear_st": 0, "compose_close_out": 0, "ac": 0, "compose_delet": 0, "deleteappl": 0, "compose_opt_in": 0, "optin": 0, "compose_upd": 0, "updateappl": 0, "allow_upd": [0, 3], "allow_delet": [0, 3], "on_upd": [0, 3], "au_deploi": 0, "fail": [0, 2, 3], "on_schema_break": [0, 3], "create_arg": [0, 3], "update_arg": [0, 3], "delete_arg": [0, 3], "refer": [0, 2, 3, 6, 7], "idempot": [0, 1, 7, 8], "against": [0, 1, 3, 4, 7, 8], "time": [0, 1, 3, 5, 8], "placehold": 0, "substitut": [0, 8], "understand": [0, 2], "architectur": [0, 3], "decis": [0, 3], "behind": [0, 3], "pleas": [0, 7], "github": 0, "com": [0, 4], "algorandfound": 0, "cli": [0, 7], "blob": 0, "main": 0, "2023": 0, "01": 0, "12_smart": 0, "md": 0, "replaceapp": 0, "re": [0, 1, 2], "differ": [0, 3, 4, 5, 7], "code": [0, 1, 3, 5, 6, 8], "increment": [0, 3], "tmpl_delet": [0, 2, 3], "condition": 0, "tmpl_updat": [0, 2, 3], "determin": [0, 3, 7], "what": [0, 2, 3], "increas": 0, "beyond": 0, "current": [0, 2, 3, 7, 8], "alloc": [0, 2], "relev": 0, "deploymenterror": 0, "export_source_map": [0, 2], "export": [0, 2], "later": 0, "import": [0, 2, 5, 6, 8], "import_source_map": [0, 2], "get_global_st": [0, 2], "fals": [0, 2, 5], "global": [0, 2, 3], "info": 0, "get_local_st": [0, 2], "local": [0, 1, 2, 3], "get_signer_send": 0, "tupl": [0, 2], "Will": 0, "otherwis": [0, 2, 3, 7], "fall": 0, "back": [0, 6], "obtain": [0, 1, 2, 6], "source_map_json": 0, "opt_in": [0, 2], "prepar": 0, "application_cli": 0, "copi": 0, "also": [0, 2, 3, 5], "to_resolv": 0, "resolve_signer_send": 0, "valueerror": 0, "variant": [0, 2], "pull": 0, "150": 0, "directori": [0, 5], "write": [0, 3, 8], "out": [0, 2, 3, 4, 7], "artifact": [0, 5], "disk": 0, "arg": [0, 3], "option": [0, 2, 3, 4, 7], "where": [0, 2, 5, 8], "written": [0, 8], "enum": 0, "intflag": 0, "3": [0, 2], "handl": [0, 8], "normal": 0, "1": [0, 2, 3, 5], "2": [0, 2, 3, 5], "never": 0, "deploymentfailederror": 0, "account_to_fund": [0, 7], "receiv": [0, 6, 7], "fee_micro_algo": [0, 7], "flat": [0, 7], "fee": [0, 2, 7], "you": [0, 1, 2, 3, 4, 5, 6, 7, 8], "want": [0, 5, 7, 8], "pai": [0, 7], "cover": [0, 7], "extra": [0, 7], "group": [0, 5, 7], "funding_sourc": [0, 7], "dispenser_api": 0, "send": [0, 6, 7], "which": [0, 3, 5, 6, 7, 8], "max_fee_micro_algo": [0, 7], "maximum": [0, 5, 7], "happi": [0, 7], "unbound": [0, 7], "could": [0, 7], "reject": [0, 7], "network": [0, 2, 3, 7, 8], "congest": [0, 7], "min_funding_increment_micro_algo": [0, 7], "issu": [0, 2, 6, 7, 8], "avoid": [0, 7], "mani": [0, 7], "small": [0, 7], "often": [0, 2, 7], "activ": [0, 2, 7], "min_spending_balance_micro_algo": [0, 7], "avail": [0, 2, 7, 8], "top": [0, 3, 7, 8], "meet": [0, 7], "transaction_id": [0, 2, 6], "were": 0, "logic_error_str": 0, "source_map": [0, 2], "algosourcemap": 0, "messag": [0, 2, 6], "pc": [0, 2], "logic_error": [0, 2], "trace": [0, 8], "algokit_deploy": [0, 3], "j": [0, 3], "kwd": 0, "appendapp": 0, "old": 0, "singl": [0, 2, 3], "updateapp": 0, "No": 0, "noth": [0, 3, 8], "date": [0, 3], "origin": [0, 2, 3], "latest": 0, "fulli": 0, "binari": 0, "line": [0, 2], "request_timeout": 0, "dispenser_request_timeout": 0, "request": [0, 3, 6], "timeout": 0, "15": 0, "second": 0, "modifi": 0, "asset_id": [0, 6, 7], "dispenserfundrespons": 0, "get_limit": [0, 6], "dispenserlimitrespons": 0, "limit": [0, 8], "refund": [0, 8], "refund_txn_id": [0, 6], "regist": [0, 8], "box": [0, 2, 3], "collect": 0, "abc": 0, "sequenc": [0, 2], "bytearrai": 0, "foreign_app": [0, 2], "foreign": [0, 2], "foreign_asset": [0, 2], "leas": [0, 2], "rekey_to": 0, "rekei": 0, "confirmed_round": 0, "round": [0, 5], "confirm": 0, "dry": 0, "run": [0, 4, 7], "static": [0, 3], "from_atr": 0, "atomictransactionrespons": 0, "simulateatomictransactionrespons": 0, "transaction_index": 0, "either": [0, 1, 2, 3, 4], "more": [0, 2, 3, 7], "last": [0, 3, 5], "tx_id": [0, 6], "_transfer": 0, "transferparametersbas": 0, "clawback_from": 0, "perform": [0, 3, 5, 6], "clawback": 0, "oper": [0, 3, 5], "case": [0, 3, 7, 8], "senderaccount": 0, "must": [0, 2, 3], "equal": 0, "asa": 0, "kmd_client": 0, "_ensure_fund": 0, "librari": [0, 8], "paymenttxn": 0, "need": [0, 2, 3, 4, 5, 6, 7, 8], "payment": [0, 5, 6, 7], "indic": [0, 2, 3, 5, 6], "wait_round": 0, "4": [0, 2], "approval_source_map": [0, 2], "sourcemap": [0, 2, 5], "callabl": 0, "abl": [0, 2, 3], "fund_with_algo": 0, "float": [0, 5], "1000": [0, 5, 6], "o": [0, 6], "f": 0, "_mnemon": [0, 1], "secret": 0, "Be": 0, "care": 0, "commit": 0, "ideal": 0, "storag": [0, 3, 5], "rather": [0, 3], "than": [0, 3, 7], "file": [0, 5, 8], "system": 0, "doesn": [0, 3], "t": [0, 3], "work": [0, 1, 2, 3, 8], "seamlessli": 0, "without": [0, 4, 8], "manual": [0, 4], "reset": 0, "account_mnemon": 0, "follow": [0, 2, 3, 4, 5, 7, 8], "object": [0, 2, 3, 4, 5, 6], "automat": [0, 1, 2, 3, 7], "network_cli": 0, "algod_serv": [0, 4], "algod_port": [0, 4], "algod_token": [0, 4], "creator_account": 0, "indexer_serv": [0, 4], "indexer_port": [0, 4], "indexer_token": [0, 4], "same": [0, 1, 3, 4], "port": [0, 4], "kmd_port": [0, 4], "4002": [0, 4], "semver": 0, "like": [0, 2, 7, 8], "lower": 0, "intend": 0, "mostli": 0, "conveni": [0, 1], "param": [0, 2], "within": 0, "valid": [0, 3], "input": 0, "output": [0, 2, 3, 5], "beta1": 0, "4567": 0, "4568": 0, "alpha": 0, "cannot": 0, "assettransfertxn": [0, 7], "util": [1, 3, 4, 6, 7], "api": [6, 7, 8], "It": [0, 1, 3, 4, 5, 6], "author": 6, "done": [3, 6], "two": [2, 6, 7], "wai": [2, 4, 6], "directli": [2, 6], "algokit_util": [2, 4, 5, 6, 8], "your_auth_token": 6, "receiver_address": 6, "fundrespons": 6, "keep": 6, "mind": 6, "yourself": 6, "first": [2, 6], "invok": [6, 7], "endpoint": [5, 6], "txn_id": 6, "your": [5, 6, 8], "txn": 6, "inspect": 6, "account_address": 6, "limitrespons": 6, "while": [3, 6], "individu": 6, "higher": [3, 7, 8], "order": [3, 7, 8], "capabl": [1, 3, 4, 7], "easili": [7, 8], "manag": [0, 3, 5, 7, 8], "usag": [2, 3, 4, 7], "exampl": [2, 3, 4, 5, 7], "check": [2, 3, 4, 7], "autom": [2, 3, 4, 7], "test": [2, 3, 4, 5, 7, 8], "function": [1, 2, 3, 4, 7, 8], "facilit": [7, 8], "transfer_paramet": 7, "underli": [4, 7, 8], "from_account": 7, "to_address": 7, "micro_algo": 7, "micro": 7, "abil": [3, 7, 8], "dispos": 7, "incredibli": 7, "script": 7, "made": [2, 7], "those": 7, "so": [2, 4, 7, 8], "use_dispenser_api": 7, "sure": 7, "document": 7, "smallest": 7, "divis": 7, "unit": 7, "programmat": 7, "sent": 7, "There": [1, 2, 3, 4, 7], "standard": [0, 7], "other": [2, 3, 7], "dispenser_mnemon": [1, 7], "doe": [3, 7], "separ": [5, 7], "abstract": 7, "dedic": 7, "releas": 8, "pypi": 8, "easier": [2, 3, 8], "build": [3, 5, 8], "solut": 8, "project": [0, 5, 8], "goal": [3, 8], "intuit": 8, "quicker": 8, "safer": 8, "larg": 8, "sdk": 8, "level": 8, "interfac": [4, 8], "sensibl": 8, "common": 8, "task": 8, "prefer": [3, 4, 8], "typescript": [3, 8], "equival": 8, "design": 8, "compos": 8, "read": 8, "logic": [3, 4, 8], "diagnos": 8, "packag": [5, 8], "modular": [4, 8], "thin": 8, "wrapper": [2, 8], "block": 8, "over": [3, 8], "primit": 8, "expos": [1, 2, 8], "wherev": 8, "opt": [0, 2, 8], "approach": [2, 8], "safeti": 8, "strong": 8, "support": [2, 3, 8], "effort": 8, "put": 8, "good": 8, "intellisens": 8, "built": [3, 8], "highli": 8, "mechan": 8, "terser": 8, "pip": 8, "poetri": 8, "simpli": [5, 8], "Then": 8, "variou": [1, 2, 4, 8], "favourit": 8, "integr": 8, "extens": [5, 8], "combin": [2, 8], "tool": [5, 8], "mypi": 8, "incorrect": 8, "incorrectli": 8, "multisig": 8, "inject": [1, 8], "beaker": [2, 3, 8], "safe": [3, 8], "retryabl": [3, 8], "immut": [3, 8], "perman": [3, 8], "we": 8, "natur": [3, 8], "evolv": [3, 8], "experi": 8, "improv": 8, "futur": [2, 8], "expand": 8, "blockchain": [0, 5, 8], "place": 0, "its": 0, "100": 0, "000": 0, "microalgo": 0, "opt_out": 0, "them": 0, "recov": 0, "optout": 0, "process": [0, 3], "permit": 0, "discontinu": 0, "persist_sourcemap": [0, 5], "persist": [0, 5], "avm": [0, 5, 8], "debugg": [0, 8], "simulate_and_persist_respons": [0, 5], "simul": [0, 2, 5, 8], "atom": [0, 3, 5], "integ": 0, "essenti": 0, "zero": 0, "_debug_util": [], "persistsourcemapinput": [0, 5], "project_root": [0, 5], "root": [0, 5], "buffer_size_mb": 0, "256": [0, 5], "size": [0, 5], "buffer": [0, 5], "megabyt": [0, 5], "256mb": 0, "core": [1, 3, 4], "well": 1, "encapsul": 1, "convent": [1, 3], "OR": [1, 2], "ny": 1, "power": 1, "new_account": 1, "generate_account": 1, "reli": 1, "being": [1, 3], "These": [1, 2, 3, 5, 8], "retriev": [1, 3, 4], "data": [2, 3], "correspond": 2, "instanti": 2, "By": [2, 5], "uncondition": 2, "app_lookup": 2, "search": [2, 5], "under": [2, 3], "overridden": 2, "deriv": 2, "suggest": 2, "no_op": 2, "update_appl": 2, "remov": [2, 5], "delete_appl": 2, "close": 2, "everyth": 2, "select": 2, "explicitli": 2, "infer": 2, "bare": 2, "compat": 2, "interpret": 2, "abireturnsubroutin": 2, "method_spec": 2, "algosd": 2, "python": [2, 3, 5], "keyword": 2, "hello": 2, "syntax": 2, "world": 2, "overrid": 2, "app_index": 2, "box_nam": 2, "page": 2, "suffici": 2, "dataclass": 2, "commoncallparamet": 2, "exact": 2, "depend": [2, 3], "compose_": 2, "onc": [2, 4], "ad": 2, "For": [2, 5], "execute_atc": 2, "let": 2, "caus": 2, "throw": 2, "becaus": 2, "assert": 2, "lack": 2, "exhaust": 2, "opcod": 2, "budget": 2, "reason": 2, "look": 2, "someth": 2, "transactionpool": 2, "rememb": 2, "eval": 2, "error_messag": 2, "program_counter_valu": 2, "list_of_op_cod": 2, "much": 2, "happen": [2, 3], "thrown": 2, "line_no": 2, "insight": 2, "format": 2, "surround": 2, "extend": 2, "show": 2, "alreadi": [2, 3], "previous": [2, 3], "crucial": 2, "complex": 2, "enabl": [2, 5], "particularli": 3, "articul": 3, "record": 3, "implement": 3, "diverg": 3, "principl": [3, 4], "comprehens": 3, "explain": 3, "concept": 3, "lifecycl": 3, "transpil": 3, "verifi": 3, "maintain": 3, "stabil": 3, "qualiti": 3, "final": 3, "runtim": 3, "confid": 3, "correct": 3, "utilis": 3, "furthermor": 3, "characterist": 3, "per": 3, "framework": 3, "0004": 3, "mean": [3, 5], "languag": 3, "explicit": 3, "upgrad": 3, "vari": 3, "present": 3, "whether": [3, 5], "had": 3, "creatoraccount": 3, "seri": 3, "lookup": 3, "payload": 3, "boolean": [3, 5], "chronolog": 3, "trivial": 3, "recommend": 3, "durat": 3, "recalcul": 3, "most": [3, 5], "fresh": 3, "detect": 3, "concert": 3, "reliabl": 3, "popul": 3, "sinc": 3, "again": 3, "appli": 3, "straight": 3, "after": [0, 3], "do": 3, "abov": 3, "In": 3, "arrai": 3, "wil": 3, "hexadecim": 3, "shouldn": 3, "beaker_product": 3, "action_taken": 3, "up": 3, "create_respons": 3, "update_respons": 3, "delete_respons": 3, "class": [4, 5], "inlin": 4, "produc": 4, "myalgodnod": 4, "secret_token": 4, "get_algonode_config": 4, "get_purestake_config": [], "purestak": [], "configorport": 4, "assumpt": 4, "host": 4, "optim": [5, 8], "who": [5, 8], "link": 5, "vscode": 5, "py": 5, "updatableconfig": 5, "attribut": 5, "mode": 5, "ignor": 5, "insid": 5, "toml": 5, "folder": 5, "algokit_project_root": 5, "trace_al": 5, "etc": 5, "trace_buffer_size_mb": 5, "exceed": 5, "oldest": 5, "consumpt": [0, 5], "max_search_depth": 5, "depth": 5, "travers": 5, "10": 5, "assum": 5, "simplifi": 5, "gather": 5, "debug": 8, "with_sourc": 0, "dump": [0, 5], "along": [0, 5], "_debug": 0, "thei": 5, "timestamp": 5, "_lr": 5, "last_round": 5, "_": 5, "transaction_typ": 5, "iso": 5, "8601": 5, "colon": 5, "period": 5, "count": 5, "underscor": 5, "might": 5, "20220301t123456z_lr1000_2": 5, "pay_1": 5, "axfer": 5, "2022": 5, "03": 5, "01t12": 5, "34": 5, "56z": 5, "node": 4}, "objects": {"": [[0, 0, 0, "-", "algokit_utils"]], "algokit_utils": [[0, 1, 1, "", "ABICallArgs"], [0, 1, 1, "", "ABICallArgsDict"], [0, 1, 1, "", "ABICreateCallArgs"], [0, 1, 1, "", "ABICreateCallArgsDict"], [0, 1, 1, "", "ABITransactionResponse"], [0, 1, 1, "", "Account"], [0, 1, 1, "", "AlgoClientConfig"], [0, 1, 1, "", "AppDeployMetaData"], [0, 1, 1, "", "AppLookup"], [0, 1, 1, "", "AppMetaData"], [0, 1, 1, "", "AppReference"], [0, 4, 1, "", "AppSpecStateDict"], [0, 1, 1, "", "ApplicationClient"], [0, 1, 1, "", "ApplicationSpecification"], [0, 1, 1, "", "CallConfig"], [0, 1, 1, "", "CreateCallParameters"], [0, 1, 1, "", "CreateCallParametersDict"], [0, 1, 1, "", "CreateTransactionParameters"], [0, 4, 1, "", "DELETABLE_TEMPLATE_NAME"], [0, 1, 1, "", "DefaultArgumentDict"], [0, 4, 1, "", "DefaultArgumentType"], [0, 1, 1, "", "DeployCallArgs"], [0, 1, 1, "", "DeployCallArgsDict"], [0, 1, 1, "", "DeployCreateCallArgs"], [0, 1, 1, "", "DeployCreateCallArgsDict"], [0, 1, 1, "", "DeployResponse"], [0, 6, 1, "", "DeploymentFailedError"], [0, 1, 1, "", "EnsureBalanceParameters"], [0, 1, 1, "", "EnsureFundedResponse"], [0, 6, 1, "", "LogicError"], [0, 4, 1, "", "MethodConfigDict"], [0, 1, 1, "", "MethodHints"], [0, 4, 1, "", "NOTE_PREFIX"], [0, 4, 1, "", "OnCompleteActionName"], [0, 1, 1, "", "OnCompleteCallParameters"], [0, 1, 1, "", "OnCompleteCallParametersDict"], [0, 1, 1, "", "OnSchemaBreak"], [0, 1, 1, "", "OnUpdate"], [0, 1, 1, "", "OperationPerformed"], [0, 1, 1, "", "Program"], [0, 4, 1, "", "TemplateValueDict"], [0, 4, 1, "", "TemplateValueMapping"], [0, 1, 1, "", "TestNetDispenserApiClient"], [0, 1, 1, "", "TransactionParameters"], [0, 1, 1, "", "TransactionParametersDict"], [0, 1, 1, "", "TransactionResponse"], [0, 1, 1, "", "TransferAssetParameters"], [0, 1, 1, "", "TransferParameters"], [0, 4, 1, "", "UPDATABLE_TEMPLATE_NAME"], [0, 7, 1, "", "create_kmd_wallet_account"], [0, 7, 1, "", "ensure_funded"], [0, 7, 1, "", "execute_atc_with_logic_error"], [0, 7, 1, "", "get_account"], [0, 7, 1, "", "get_account_from_mnemonic"], [0, 7, 1, "", "get_algod_client"], [0, 7, 1, "", "get_app_id_from_tx_id"], [0, 7, 1, "", "get_creator_apps"], [0, 7, 1, "", "get_default_localnet_config"], [0, 7, 1, "", "get_dispenser_account"], [0, 7, 1, "", "get_indexer_client"], [0, 7, 1, "", "get_kmd_client_from_algod_client"], [0, 7, 1, "", "get_kmd_wallet_account"], [0, 7, 1, "", "get_localnet_default_account"], [0, 7, 1, "", "get_next_version"], [0, 7, 1, "", "get_or_create_kmd_wallet_account"], [0, 7, 1, "", "get_sender_from_signer"], [0, 7, 1, "", "is_localnet"], [0, 7, 1, "", "is_mainnet"], [0, 7, 1, "", "is_testnet"], [0, 7, 1, "", "num_extra_program_pages"], [0, 7, 1, "", "opt_in"], [0, 7, 1, "", "opt_out"], [0, 7, 1, "", "persist_sourcemaps"], [0, 7, 1, "", "replace_template_variables"], [0, 7, 1, "", "simulate_and_persist_response"], [0, 7, 1, "", "transfer"], [0, 7, 1, "", "transfer_asset"]], "algokit_utils.ABITransactionResponse": [[0, 2, 1, "", "decode_error"], [0, 2, 1, "", "method"], [0, 2, 1, "", "raw_value"], [0, 2, 1, "", "return_value"], [0, 2, 1, "", "tx_info"]], "algokit_utils.Account": [[0, 2, 1, "", "address"], [0, 2, 1, "", "private_key"], [0, 3, 1, "", "public_key"], [0, 3, 1, "", "signer"]], "algokit_utils.AlgoClientConfig": [[0, 2, 1, "", "server"], [0, 2, 1, "", "token"]], "algokit_utils.ApplicationClient": [[0, 5, 1, "", "add_method_call"], [0, 5, 1, "", "call"], [0, 5, 1, "", "clear_state"], [0, 5, 1, "", "close_out"], [0, 5, 1, "", "compose_call"], [0, 5, 1, "", "compose_clear_state"], [0, 5, 1, "", "compose_close_out"], [0, 5, 1, "", "compose_create"], [0, 5, 1, "", "compose_delete"], [0, 5, 1, "", "compose_opt_in"], [0, 5, 1, "", "compose_update"], [0, 5, 1, "", "create"], [0, 5, 1, "", "delete"], [0, 5, 1, "", "deploy"], [0, 5, 1, "", "export_source_map"], [0, 5, 1, "", "get_global_state"], [0, 5, 1, "", "get_local_state"], [0, 5, 1, "", "get_signer_sender"], [0, 5, 1, "", "import_source_map"], [0, 5, 1, "", "opt_in"], [0, 5, 1, "", "prepare"], [0, 5, 1, "", "resolve"], [0, 5, 1, "", "resolve_signer_sender"], [0, 5, 1, "", "update"]], "algokit_utils.ApplicationSpecification": [[0, 5, 1, "", "export"]], "algokit_utils.CallConfig": [[0, 2, 1, "", "ALL"], [0, 2, 1, "", "CALL"], [0, 2, 1, "", "CREATE"], [0, 2, 1, "", "NEVER"]], "algokit_utils.EnsureBalanceParameters": [[0, 2, 1, "", "account_to_fund"], [0, 2, 1, "", "fee_micro_algos"], [0, 2, 1, "", "funding_source"], [0, 2, 1, "", "max_fee_micro_algos"], [0, 2, 1, "", "min_funding_increment_micro_algos"], [0, 2, 1, "", "min_spending_balance_micro_algos"], [0, 2, 1, "", "note"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.EnsureFundedResponse": [[0, 2, 1, "", "transaction_id"]], "algokit_utils.OnSchemaBreak": [[0, 2, 1, "", "AppendApp"], [0, 2, 1, "", "Fail"], [0, 2, 1, "", "ReplaceApp"]], "algokit_utils.OnUpdate": [[0, 2, 1, "", "AppendApp"], [0, 2, 1, "", "Fail"], [0, 2, 1, "", "ReplaceApp"], [0, 2, 1, "", "UpdateApp"]], "algokit_utils.OperationPerformed": [[0, 2, 1, "", "Create"], [0, 2, 1, "", "Nothing"], [0, 2, 1, "", "Replace"], [0, 2, 1, "", "Update"]], "algokit_utils.TestNetDispenserApiClient": [[0, 5, 1, "", "fund"], [0, 5, 1, "", "get_limit"], [0, 5, 1, "", "refund"]], "algokit_utils.TransactionParameters": [[0, 2, 1, "", "accounts"], [0, 2, 1, "", "boxes"], [0, 2, 1, "", "foreign_apps"], [0, 2, 1, "", "foreign_assets"], [0, 2, 1, "", "lease"], [0, 2, 1, "", "note"], [0, 2, 1, "", "rekey_to"], [0, 2, 1, "", "sender"], [0, 2, 1, "", "signer"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.TransactionParametersDict": [[0, 2, 1, "", "accounts"], [0, 2, 1, "", "boxes"], [0, 2, 1, "", "foreign_apps"], [0, 2, 1, "", "foreign_assets"], [0, 2, 1, "", "lease"], [0, 2, 1, "", "note"], [0, 2, 1, "", "rekey_to"], [0, 2, 1, "", "sender"], [0, 2, 1, "", "signer"], [0, 2, 1, "", "suggested_params"]], "algokit_utils.TransactionResponse": [[0, 2, 1, "", "confirmed_round"], [0, 5, 1, "", "from_atr"], [0, 2, 1, "", "tx_id"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:property", "4": "py:data", "5": "py:method", "6": "py:exception", "7": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"], "4": ["py", "data", "Python data"], "5": ["py", "method", "Python method"], "6": ["py", "exception", "Python exception"], "7": ["py", "function", "Python function"]}, "titleterms": {"algokit_util": 0, "packag": 0, "content": [0, 8], "class": 0, "function": 0, "data": 0, "api": 0, "convent": 0, "exampl": 0, "testnet": 6, "dispens": [6, 7], "client": [2, 4, 6], "creat": [2, 6], "fund": 6, "an": [2, 3, 6], "account": [1, 6], "regist": 6, "refund": 6, "get": 6, "current": 6, "limit": 6, "error": [2, 6], "handl": [2, 6], "algo": 7, "transfer": 7, "ensur": 7, "minimum": 7, "asset": 7, "algokit": 8, "python": 8, "util": [5, 8], "core": 8, "principl": 8, "instal": 8, "usag": 8, "type": 8, "capabl": 8, "refer": 8, "document": 8, "roadmap": 8, "indic": 8, "tabl": 8, "manag": [1, 4], "app": [2, 3], "design": [2, 3], "applic": [2, 3], "call": 2, "method": 2, "specifi": 2, "which": 2, "abi": 2, "argument": 2, "transact": 2, "paramet": [2, 3], "compos": 2, "read": 2, "state": 2, "logic": 2, "diagnos": 2, "debug": [2, 5], "mode": 2, "trace": [2, 5], "field": 2, "deploy": 3, "find": 3, "creator": 3, "deploi": 3, "input": 3, "idempot": 3, "compil": 3, "templat": 3, "substitut": 3, "return": 3, "valu": 3, "network": 4, "configur": [4, 5], "debugg": 5, "filenam": 5, "format": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Account management": [[1, "account-management"]], "Account": [[1, "account"]], "App client": [[2, "app-client"]], "Design": [[2, "design"], [3, "design"]], "Creating an application client": [[2, "creating-an-application-client"]], "Calling methods on the app": [[2, "calling-methods-on-the-app"]], "Specifying which method": [[2, "specifying-which-method"]], "ABI arguments": [[2, "abi-arguments"]], "Transaction Parameters": [[2, "transaction-parameters"]], "Composing calls": [[2, "composing-calls"]], "Reading state": [[2, "reading-state"]], "Handling logic errors and diagnosing errors": [[2, "handling-logic-errors-and-diagnosing-errors"]], "Debug Mode and traces Field": [[2, "debug-mode-and-traces-field"]], "App deployment": [[3, "app-deployment"]], "Finding apps by creator": [[3, "finding-apps-by-creator"]], "Deploying an application": [[3, "deploying-an-application"]], "Input parameters": [[3, "input-parameters"]], "Idempotency": [[3, "idempotency"]], "Compilation and template substitution": [[3, "compilation-and-template-substitution"]], "Return value": [[3, "return-value"]], "Debugger": [[5, "debugger"]], "Configuration": [[5, "configuration"]], "Debugging Utilities": [[5, "debugging-utilities"]], "Trace filename format": [[5, "trace-filename-format"]], "TestNet Dispenser Client": [[6, "testnet-dispenser-client"]], "Creating a Dispenser Client": [[6, "creating-a-dispenser-client"]], "Funding an Account": [[6, "funding-an-account"]], "Registering a Refund": [[6, "registering-a-refund"]], "Getting Current Limit": [[6, "getting-current-limit"]], "Error Handling": [[6, "error-handling"]], "Algo transfers": [[7, "algo-transfers"]], "Transferring Algos": [[7, "transferring-algos"]], "Ensuring minimum Algos": [[7, "ensuring-minimum-algos"]], "Transfering Assets": [[7, "transfering-assets"]], "Dispenser": [[7, "dispenser"]], "AlgoKit Python Utilities": [[8, "algokit-python-utilities"]], "Contents": [[8, null]], "Core principles": [[8, "core-principles"]], "Installation": [[8, "installation"]], "Usage": [[8, "usage"]], "Types": [[8, "types"]], "Capabilities": [[8, "capabilities"]], "Reference documentation": [[8, "reference-documentation"]], "Roadmap": [[8, "roadmap"]], "Indices and tables": [[8, "indices-and-tables"]], "Client management": [[4, "client-management"]], "Network configuration": [[4, "network-configuration"]], "Clients": [[4, "clients"]], "algokit_utils": [[0, "module-algokit_utils"]], "Package Contents": [[0, "package-contents"]], "Classes": [[0, "classes"]], "Functions": [[0, "functions"]], "Data": [[0, "data"]], "API": [[0, "api"]], "Convention": [[0, "convention"]], "Example": [[0, "example"]]}, "indexentries": {"abicallargs (class in algokit_utils)": [[0, "algokit_utils.ABICallArgs"]], "abicallargsdict (class in algokit_utils)": [[0, "algokit_utils.ABICallArgsDict"]], "abicreatecallargs (class in algokit_utils)": [[0, "algokit_utils.ABICreateCallArgs"]], "abicreatecallargsdict (class in algokit_utils)": [[0, "algokit_utils.ABICreateCallArgsDict"]], "abitransactionresponse (class in algokit_utils)": [[0, "algokit_utils.ABITransactionResponse"]], "all (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.ALL"]], "account (class in algokit_utils)": [[0, "algokit_utils.Account"]], "algoclientconfig (class in algokit_utils)": [[0, "algokit_utils.AlgoClientConfig"]], "appdeploymetadata (class in algokit_utils)": [[0, "algokit_utils.AppDeployMetaData"]], "applookup (class in algokit_utils)": [[0, "algokit_utils.AppLookup"]], "appmetadata (class in algokit_utils)": [[0, "algokit_utils.AppMetaData"]], "appreference (class in algokit_utils)": [[0, "algokit_utils.AppReference"]], "appspecstatedict (in module algokit_utils)": [[0, "algokit_utils.AppSpecStateDict"]], "appendapp (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.AppendApp"]], "appendapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.AppendApp"]], "applicationclient (class in algokit_utils)": [[0, "algokit_utils.ApplicationClient"]], "applicationspecification (class in algokit_utils)": [[0, "algokit_utils.ApplicationSpecification"]], "call (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.CALL"]], "create (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.CREATE"]], "callconfig (class in algokit_utils)": [[0, "algokit_utils.CallConfig"]], "create (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Create"]], "createcallparameters (class in algokit_utils)": [[0, "algokit_utils.CreateCallParameters"]], "createcallparametersdict (class in algokit_utils)": [[0, "algokit_utils.CreateCallParametersDict"]], "createtransactionparameters (class in algokit_utils)": [[0, "algokit_utils.CreateTransactionParameters"]], "deletable_template_name (in module algokit_utils)": [[0, "algokit_utils.DELETABLE_TEMPLATE_NAME"]], "defaultargumentdict (class in algokit_utils)": [[0, "algokit_utils.DefaultArgumentDict"]], "defaultargumenttype (in module algokit_utils)": [[0, "algokit_utils.DefaultArgumentType"]], "deploycallargs (class in algokit_utils)": [[0, "algokit_utils.DeployCallArgs"]], "deploycallargsdict (class in algokit_utils)": [[0, "algokit_utils.DeployCallArgsDict"]], "deploycreatecallargs (class in algokit_utils)": [[0, "algokit_utils.DeployCreateCallArgs"]], "deploycreatecallargsdict (class in algokit_utils)": [[0, "algokit_utils.DeployCreateCallArgsDict"]], "deployresponse (class in algokit_utils)": [[0, "algokit_utils.DeployResponse"]], "deploymentfailederror": [[0, "algokit_utils.DeploymentFailedError"]], "ensurebalanceparameters (class in algokit_utils)": [[0, "algokit_utils.EnsureBalanceParameters"]], "ensurefundedresponse (class in algokit_utils)": [[0, "algokit_utils.EnsureFundedResponse"]], "fail (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.Fail"]], "fail (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.Fail"]], "logicerror": [[0, "algokit_utils.LogicError"]], "methodconfigdict (in module algokit_utils)": [[0, "algokit_utils.MethodConfigDict"]], "methodhints (class in algokit_utils)": [[0, "algokit_utils.MethodHints"]], "never (algokit_utils.callconfig attribute)": [[0, "algokit_utils.CallConfig.NEVER"]], "note_prefix (in module algokit_utils)": [[0, "algokit_utils.NOTE_PREFIX"]], "nothing (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Nothing"]], "oncompleteactionname (in module algokit_utils)": [[0, "algokit_utils.OnCompleteActionName"]], "oncompletecallparameters (class in algokit_utils)": [[0, "algokit_utils.OnCompleteCallParameters"]], "oncompletecallparametersdict (class in algokit_utils)": [[0, "algokit_utils.OnCompleteCallParametersDict"]], "onschemabreak (class in algokit_utils)": [[0, "algokit_utils.OnSchemaBreak"]], "onupdate (class in algokit_utils)": [[0, "algokit_utils.OnUpdate"]], "operationperformed (class in algokit_utils)": [[0, "algokit_utils.OperationPerformed"]], "program (class in algokit_utils)": [[0, "algokit_utils.Program"]], "replace (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Replace"]], "replaceapp (algokit_utils.onschemabreak attribute)": [[0, "algokit_utils.OnSchemaBreak.ReplaceApp"]], "replaceapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.ReplaceApp"]], "templatevaluedict (in module algokit_utils)": [[0, "algokit_utils.TemplateValueDict"]], "templatevaluemapping (in module algokit_utils)": [[0, "algokit_utils.TemplateValueMapping"]], "testnetdispenserapiclient (class in algokit_utils)": [[0, "algokit_utils.TestNetDispenserApiClient"]], "transactionparameters (class in algokit_utils)": [[0, "algokit_utils.TransactionParameters"]], "transactionparametersdict (class in algokit_utils)": [[0, "algokit_utils.TransactionParametersDict"]], "transactionresponse (class in algokit_utils)": [[0, "algokit_utils.TransactionResponse"]], "transferassetparameters (class in algokit_utils)": [[0, "algokit_utils.TransferAssetParameters"]], "transferparameters (class in algokit_utils)": [[0, "algokit_utils.TransferParameters"]], "updatable_template_name (in module algokit_utils)": [[0, "algokit_utils.UPDATABLE_TEMPLATE_NAME"]], "update (algokit_utils.operationperformed attribute)": [[0, "algokit_utils.OperationPerformed.Update"]], "updateapp (algokit_utils.onupdate attribute)": [[0, "algokit_utils.OnUpdate.UpdateApp"]], "account_to_fund (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.account_to_fund"]], "accounts (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.accounts"]], "accounts (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.accounts"]], "add_method_call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.add_method_call"]], "address (algokit_utils.account attribute)": [[0, "algokit_utils.Account.address"]], "algokit_utils": [[0, "module-algokit_utils"]], "boxes (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.boxes"]], "boxes (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.boxes"]], "call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.call"]], "clear_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.clear_state"]], "close_out() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.close_out"]], "compose_call() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_call"]], "compose_clear_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_clear_state"]], "compose_close_out() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_close_out"]], "compose_create() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_create"]], "compose_delete() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_delete"]], "compose_opt_in() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_opt_in"]], "compose_update() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.compose_update"]], "confirmed_round (algokit_utils.transactionresponse attribute)": [[0, "algokit_utils.TransactionResponse.confirmed_round"]], "create() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.create"]], "create_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.create_kmd_wallet_account"]], "decode_error (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.decode_error"]], "delete() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.delete"]], "deploy() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.deploy"]], "ensure_funded() (in module algokit_utils)": [[0, "algokit_utils.ensure_funded"]], "execute_atc_with_logic_error() (in module algokit_utils)": [[0, "algokit_utils.execute_atc_with_logic_error"]], "export() (algokit_utils.applicationspecification method)": [[0, "algokit_utils.ApplicationSpecification.export"]], "export_source_map() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.export_source_map"]], "fee_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.fee_micro_algos"]], "foreign_apps (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.foreign_apps"]], "foreign_apps (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.foreign_apps"]], "foreign_assets (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.foreign_assets"]], "foreign_assets (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.foreign_assets"]], "from_atr() (algokit_utils.transactionresponse static method)": [[0, "algokit_utils.TransactionResponse.from_atr"]], "fund() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.fund"]], "funding_source (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.funding_source"]], "get_account() (in module algokit_utils)": [[0, "algokit_utils.get_account"]], "get_account_from_mnemonic() (in module algokit_utils)": [[0, "algokit_utils.get_account_from_mnemonic"]], "get_algod_client() (in module algokit_utils)": [[0, "algokit_utils.get_algod_client"]], "get_app_id_from_tx_id() (in module algokit_utils)": [[0, "algokit_utils.get_app_id_from_tx_id"]], "get_creator_apps() (in module algokit_utils)": [[0, "algokit_utils.get_creator_apps"]], "get_default_localnet_config() (in module algokit_utils)": [[0, "algokit_utils.get_default_localnet_config"]], "get_dispenser_account() (in module algokit_utils)": [[0, "algokit_utils.get_dispenser_account"]], "get_global_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_global_state"]], "get_indexer_client() (in module algokit_utils)": [[0, "algokit_utils.get_indexer_client"]], "get_kmd_client_from_algod_client() (in module algokit_utils)": [[0, "algokit_utils.get_kmd_client_from_algod_client"]], "get_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.get_kmd_wallet_account"]], "get_limit() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.get_limit"]], "get_local_state() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_local_state"]], "get_localnet_default_account() (in module algokit_utils)": [[0, "algokit_utils.get_localnet_default_account"]], "get_next_version() (in module algokit_utils)": [[0, "algokit_utils.get_next_version"]], "get_or_create_kmd_wallet_account() (in module algokit_utils)": [[0, "algokit_utils.get_or_create_kmd_wallet_account"]], "get_sender_from_signer() (in module algokit_utils)": [[0, "algokit_utils.get_sender_from_signer"]], "get_signer_sender() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.get_signer_sender"]], "import_source_map() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.import_source_map"]], "is_localnet() (in module algokit_utils)": [[0, "algokit_utils.is_localnet"]], "is_mainnet() (in module algokit_utils)": [[0, "algokit_utils.is_mainnet"]], "is_testnet() (in module algokit_utils)": [[0, "algokit_utils.is_testnet"]], "lease (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.lease"]], "lease (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.lease"]], "max_fee_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.max_fee_micro_algos"]], "method (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.method"]], "min_funding_increment_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.min_funding_increment_micro_algos"]], "min_spending_balance_micro_algos (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.min_spending_balance_micro_algos"]], "module": [[0, "module-algokit_utils"]], "note (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.note"]], "note (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.note"]], "note (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.note"]], "num_extra_program_pages() (in module algokit_utils)": [[0, "algokit_utils.num_extra_program_pages"]], "opt_in() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.opt_in"]], "opt_in() (in module algokit_utils)": [[0, "algokit_utils.opt_in"]], "opt_out() (in module algokit_utils)": [[0, "algokit_utils.opt_out"]], "persist_sourcemaps() (in module algokit_utils)": [[0, "algokit_utils.persist_sourcemaps"]], "prepare() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.prepare"]], "private_key (algokit_utils.account attribute)": [[0, "algokit_utils.Account.private_key"]], "public_key (algokit_utils.account property)": [[0, "algokit_utils.Account.public_key"]], "raw_value (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.raw_value"]], "refund() (algokit_utils.testnetdispenserapiclient method)": [[0, "algokit_utils.TestNetDispenserApiClient.refund"]], "rekey_to (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.rekey_to"]], "rekey_to (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.rekey_to"]], "replace_template_variables() (in module algokit_utils)": [[0, "algokit_utils.replace_template_variables"]], "resolve() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.resolve"]], "resolve_signer_sender() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.resolve_signer_sender"]], "return_value (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.return_value"]], "sender (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.sender"]], "sender (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.sender"]], "server (algokit_utils.algoclientconfig attribute)": [[0, "algokit_utils.AlgoClientConfig.server"]], "signer (algokit_utils.account property)": [[0, "algokit_utils.Account.signer"]], "signer (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.signer"]], "signer (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.signer"]], "simulate_and_persist_response() (in module algokit_utils)": [[0, "algokit_utils.simulate_and_persist_response"]], "suggested_params (algokit_utils.ensurebalanceparameters attribute)": [[0, "algokit_utils.EnsureBalanceParameters.suggested_params"]], "suggested_params (algokit_utils.transactionparameters attribute)": [[0, "algokit_utils.TransactionParameters.suggested_params"]], "suggested_params (algokit_utils.transactionparametersdict attribute)": [[0, "algokit_utils.TransactionParametersDict.suggested_params"]], "token (algokit_utils.algoclientconfig attribute)": [[0, "algokit_utils.AlgoClientConfig.token"]], "transaction_id (algokit_utils.ensurefundedresponse attribute)": [[0, "algokit_utils.EnsureFundedResponse.transaction_id"]], "transfer() (in module algokit_utils)": [[0, "algokit_utils.transfer"]], "transfer_asset() (in module algokit_utils)": [[0, "algokit_utils.transfer_asset"]], "tx_id (algokit_utils.transactionresponse attribute)": [[0, "algokit_utils.TransactionResponse.tx_id"]], "tx_info (algokit_utils.abitransactionresponse attribute)": [[0, "algokit_utils.ABITransactionResponse.tx_info"]], "update() (algokit_utils.applicationclient method)": [[0, "algokit_utils.ApplicationClient.update"]]}}) \ No newline at end of file diff --git a/example.env b/example.env index 61092a33..4d328625 100644 --- a/example.env +++ b/example.env @@ -30,15 +30,3 @@ INDEXER_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa #INDEXER_TOKEN= #INDEXER_SERVER=https://testnet-idx.algonode.cloud/ #INDEXER_PORT=443 - -# OR: - -# PureStake - https://developer.purestake.io/ -# Useful service to target testnet and mainnet without having to run our own node -# You'll need to fund the CREATOR_MNEMONIC and DISPENSER_MNEMONIC accounts via a TestNet dispenser -#ALGOD_TOKEN={token} -#ALGOD_SERVER=https://testnet-algorand.api.purestake.io/ps2 -#ALGOD_PORT=443 -#INDEXER_TOKEN={token} -#INDEXER_SERVER=https://testnet-algorand.api.purestake.io/idx2 -#INDEXER_PORT=443 diff --git a/src/algokit_utils/__init__.py b/src/algokit_utils/__init__.py index a71df939..02a5e341 100644 --- a/src/algokit_utils/__init__.py +++ b/src/algokit_utils/__init__.py @@ -88,7 +88,6 @@ 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 @@ "get_default_localnet_config", "get_indexer_client", "get_kmd_client_from_algod_client", - "get_purestake_config", "is_localnet", "is_mainnet", "is_testnet", diff --git a/src/algokit_utils/network_clients.py b/src/algokit_utils/network_clients.py index 7129be7c..2de270da 100644 --- a/src/algokit_utils/network_clients.py +++ b/src/algokit_utils/network_clients.py @@ -14,7 +14,6 @@ "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 @@ "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} diff --git a/tests/test_network_clients.py b/tests/test_network_clients.py index 7269ee55..c0edcb65 100644 --- a/tests/test_network_clients.py +++ b/tests/test_network_clients.py @@ -6,7 +6,6 @@ get_algonode_config, get_default_localnet_config, get_indexer_client, - get_purestake_config, ) DEFAULT_TOKEN = "a" * 64 @@ -24,26 +23,10 @@ def test_localnet_indexer() -> None: assert isinstance(health_response, dict) -def test_purestake_headers() -> None: - algod_client = get_algod_client(get_purestake_config("testnet", "algod", DEFAULT_TOKEN)) - indexer_client = get_indexer_client(get_purestake_config("testnet", "indexer", DEFAULT_TOKEN)) - - assert algod_client.headers == {"X-API-Key": DEFAULT_TOKEN} - assert indexer_client.headers == {"X-API-Key": DEFAULT_TOKEN} - - -def test_purestake_address() -> None: - algod_client = get_algod_client(get_purestake_config("testnet", "algod", DEFAULT_TOKEN)) - indexer_client = get_indexer_client(get_purestake_config("testnet", "indexer", DEFAULT_TOKEN)) - - assert algod_client.algod_address == "https://testnet-algorand.api.purestake.io/ps2" - assert indexer_client.indexer_address == "https://testnet-algorand.api.purestake.io/idx2" - - @mock.patch.dict( os.environ, { - "ALGOD_SERVER": "https://testnet-algorand.api.purestake.io/ps2", + "ALGOD_SERVER": "https://testnet-api.algonode.cloud", "ALGOD_PORT": "443", "ALGOD_TOKEN": DEFAULT_TOKEN, }, @@ -51,7 +34,7 @@ def test_purestake_address() -> None: def test_environment_config() -> None: algod_client = get_algod_client() - assert algod_client.algod_address == "https://testnet-algorand.api.purestake.io:443/ps2" + assert algod_client.algod_address == "https://testnet-api.algonode.cloud:443" def test_cloudnode_algod_headers() -> None: