This is page 79 of 93. Use http://codebase.md/goplausible/algorand-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── llms-install.md
├── llms.txt
├── package.json
├── packages
│ ├── client
│ │ ├── .env.example
│ │ ├── package.json
│ │ ├── README.md
│ │ ├── src
│ │ │ ├── env.ts
│ │ │ ├── index.ts
│ │ │ └── LocalWallet.ts
│ │ └── tsconfig.json
│ └── server
│ ├── .env.example
│ ├── API specs
│ │ ├── algod_api.json
│ │ ├── indexer_api.json
│ │ ├── mcp.json
│ │ ├── nfd_api.json
│ │ ├── ultrade_api.json
│ │ ├── vestige_api.json
│ │ └── vestige_free_api.json
│ ├── Dockerfile
│ ├── jest.config.js
│ ├── package.json
│ ├── README.md
│ ├── smithery.yaml
│ ├── src
│ │ ├── algorand-client.ts
│ │ ├── env.ts
│ │ ├── index.ts
│ │ ├── resources
│ │ │ ├── index.ts
│ │ │ ├── knowledge
│ │ │ │ ├── ARCs.txt
│ │ │ │ ├── developers-algokit-architecture-decisions.txt
│ │ │ │ ├── developers-algokit-cli.txt
│ │ │ │ ├── developers-algokit-utils-python.txt
│ │ │ │ ├── developers-algokit-utils-typescript.txt
│ │ │ │ ├── developers-clis.txt
│ │ │ │ ├── developers-details.txt
│ │ │ │ ├── developers-liquid-auth.txt
│ │ │ │ ├── developers-nodes.txt
│ │ │ │ ├── developers-puya.txt
│ │ │ │ ├── developers-python.txt
│ │ │ │ ├── developers-sdks-js.txt
│ │ │ │ ├── developers-sdks-python.txt
│ │ │ │ ├── developers-tealscript.txt
│ │ │ │ ├── developers.txt
│ │ │ │ ├── index.ts
│ │ │ │ ├── taxonomy
│ │ │ │ │ ├── algokit-cli:README.md
│ │ │ │ │ ├── algokit:cli:algokit.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_brew_install.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-13_native_binaries.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md
│ │ │ │ │ ├── algokit:cli:articles:output_stability.md
│ │ │ │ │ ├── algokit:cli:cli:index.md
│ │ │ │ │ ├── algokit:cli:features:compile.md
│ │ │ │ │ ├── algokit:cli:features:completions.md
│ │ │ │ │ ├── algokit:cli:features:config.md
│ │ │ │ │ ├── algokit:cli:features:dispenser.md
│ │ │ │ │ ├── algokit:cli:features:doctor.md
│ │ │ │ │ ├── algokit:cli:features:explore.md
│ │ │ │ │ ├── algokit:cli:features:generate.md
│ │ │ │ │ ├── algokit:cli:features:goal.md
│ │ │ │ │ ├── algokit:cli:features:init.md
│ │ │ │ │ ├── algokit:cli:features:localnet.md
│ │ │ │ │ ├── algokit:cli:features:project:bootstrap.md
│ │ │ │ │ ├── algokit:cli:features:project:deploy.md
│ │ │ │ │ ├── algokit:cli:features:project:link.md
│ │ │ │ │ ├── algokit:cli:features:project:list.md
│ │ │ │ │ ├── algokit:cli:features:project:run.md
│ │ │ │ │ ├── algokit:cli:features:project.md
│ │ │ │ │ ├── algokit:cli:features:tasks:analyze.md
│ │ │ │ │ ├── algokit:cli:features:tasks:ipfs.md
│ │ │ │ │ ├── algokit:cli:features:tasks:mint.md
│ │ │ │ │ ├── algokit:cli:features:tasks:nfd.md
│ │ │ │ │ ├── algokit:cli:features:tasks:opt.md
│ │ │ │ │ ├── algokit:cli:features:tasks:send.md
│ │ │ │ │ ├── algokit:cli:features:tasks:sign.md
│ │ │ │ │ ├── algokit:cli:features:tasks:transfer.md
│ │ │ │ │ ├── algokit:cli:features:tasks:vanity_address.md
│ │ │ │ │ ├── algokit:cli:features:tasks:wallet.md
│ │ │ │ │ ├── algokit:cli:features:tasks.md
│ │ │ │ │ ├── algokit:cli:tutorials:algokit-template.md
│ │ │ │ │ ├── algokit:cli:tutorials:intro.md
│ │ │ │ │ ├── algokit:cli:tutorials:smart-contracts.md
│ │ │ │ │ ├── algokit:docs:testnet_api.md
│ │ │ │ │ ├── algokit:lora:README.md
│ │ │ │ │ ├── algokit:README.md
│ │ │ │ │ ├── algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:markdown:index.md
│ │ │ │ │ ├── algokit:utils:python:README.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:source:index.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:algorand-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:amount.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:asset.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:event-emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction-composer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:typed-app-clients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TestLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TransactionLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.MultisigAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.SigningAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.AppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_manager.AppManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_logic_error.LogicError.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnUpdate.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.SignatureType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppState.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxName.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_config.Config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_interface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_arc56.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_deployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_composer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_expand.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_kmd_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_lifecycle_events.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logic_error.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_network_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:README.md
│ │ │ │ │ ├── algokit:utils:typescript:README.md
│ │ │ │ │ ├── algokit:utils:typescript:v7-migration.md
│ │ │ │ │ ├── algokit:utils:typescript:v8-migration.md
│ │ │ │ │ ├── ARCs:ARC-template.md
│ │ │ │ │ ├── ARCs:assets:arc-0012:README.md
│ │ │ │ │ ├── ARCs:assets:arc-0034:TemplateForm.md
│ │ │ │ │ ├── ARCs:assets:arc-0062:README.md
│ │ │ │ │ ├── ARCs:pages:nfts.md
│ │ │ │ │ ├── ARCs:pages:wallets.md
│ │ │ │ │ ├── ARCs:README.md
│ │ │ │ │ ├── ARCs:specs:arc-0000.md
│ │ │ │ │ ├── ARCs:specs:arc-0001.md
│ │ │ │ │ ├── ARCs:specs:arc-0002.md
│ │ │ │ │ ├── ARCs:specs:arc-0003.md
│ │ │ │ │ ├── ARCs:specs:arc-0004.md
│ │ │ │ │ ├── ARCs:specs:arc-0005.md
│ │ │ │ │ ├── ARCs:specs:arc-0006.md
│ │ │ │ │ ├── ARCs:specs:arc-0007.md
│ │ │ │ │ ├── ARCs:specs:arc-0008.md
│ │ │ │ │ ├── ARCs:specs:arc-0009.md
│ │ │ │ │ ├── ARCs:specs:arc-0010.md
│ │ │ │ │ ├── ARCs:specs:arc-0011.md
│ │ │ │ │ ├── ARCs:specs:arc-0012.md
│ │ │ │ │ ├── ARCs:specs:arc-0015.md
│ │ │ │ │ ├── ARCs:specs:arc-0016.md
│ │ │ │ │ ├── ARCs:specs:arc-0018.md
│ │ │ │ │ ├── ARCs:specs:arc-0019.md
│ │ │ │ │ ├── ARCs:specs:arc-0020.md
│ │ │ │ │ ├── ARCs:specs:arc-0021.md
│ │ │ │ │ ├── ARCs:specs:arc-0022.md
│ │ │ │ │ ├── ARCs:specs:arc-0023.md
│ │ │ │ │ ├── ARCs:specs:arc-0025.md
│ │ │ │ │ ├── ARCs:specs:arc-0026.md
│ │ │ │ │ ├── ARCs:specs:arc-0028.md
│ │ │ │ │ ├── ARCs:specs:arc-0032.md
│ │ │ │ │ ├── ARCs:specs:arc-0033.md
│ │ │ │ │ ├── ARCs:specs:arc-0034.md
│ │ │ │ │ ├── ARCs:specs:arc-0035.md
│ │ │ │ │ ├── ARCs:specs:arc-0036.md
│ │ │ │ │ ├── ARCs:specs:arc-0042.md
│ │ │ │ │ ├── ARCs:specs:arc-0047.md
│ │ │ │ │ ├── ARCs:specs:arc-0048.md
│ │ │ │ │ ├── ARCs:specs:arc-0049.md
│ │ │ │ │ ├── ARCs:specs:arc-0054.md
│ │ │ │ │ ├── ARCs:specs:arc-0055.md
│ │ │ │ │ ├── ARCs:specs:arc-0056.md
│ │ │ │ │ ├── ARCs:specs:arc-0059.md
│ │ │ │ │ ├── ARCs:specs:arc-0062.md
│ │ │ │ │ ├── ARCs:specs:arc-0065.md
│ │ │ │ │ ├── ARCs:specs:arc-0069.md
│ │ │ │ │ ├── ARCs:specs:arc-0072.md
│ │ │ │ │ ├── ARCs:specs:arc-0073.md
│ │ │ │ │ ├── ARCs:specs:arc-0074.md
│ │ │ │ │ ├── ARCs:specs:arc-0076.md
│ │ │ │ │ ├── ARCs:specs:arc-0078.md
│ │ │ │ │ ├── ARCs:specs:arc-0079.md
│ │ │ │ │ ├── ARCs:specs:arc-0200.md
│ │ │ │ │ ├── clis_index.md
│ │ │ │ │ ├── developer:docs:about.md
│ │ │ │ │ ├── developer:docs:clis:algokey:algokey.md
│ │ │ │ │ ├── developer:docs:clis:algokey:generate.md
│ │ │ │ │ ├── developer:docs:clis:algokey:import.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:append-auth-addr.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:multisig.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:info.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:part.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:reparent.md
│ │ │ │ │ ├── developer:docs:clis:algokey:sign.md
│ │ │ │ │ ├── developer:docs:clis:conduit:conduit.md
│ │ │ │ │ ├── developer:docs:clis:conduit:init.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:exporters.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:importers.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:list.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:processors.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:diagcfg.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:metric.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:endpoint.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:name.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:telemetry.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:restart.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:start.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:status.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:stop.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:wait.md
│ │ │ │ │ ├── developer:docs:clis:goal:protocols.md
│ │ │ │ │ ├── developer:docs:clis:goal:report.md
│ │ │ │ │ ├── developer:docs:clis:goal:version.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:list.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:new.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:wallet.md
│ │ │ │ │ ├── developer:docs:clis:indexer:api-config.md
│ │ │ │ │ ├── developer:docs:clis:indexer:daemon.md
│ │ │ │ │ ├── developer:docs:clis:indexer:indexer.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:util.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:validator.md
│ │ │ │ │ ├── developer:docs:clis:kmd.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:debug.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:remote.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:tealdbg.md
│ │ │ │ │ ├── developer:docs:details:accounts:create.md
│ │ │ │ │ ├── developer:docs:details:accounts:index.md
│ │ │ │ │ ├── developer:docs:details:accounts:rekey.md
│ │ │ │ │ ├── developer:docs:details:algorand_consensus.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:betanet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:index.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:mainnet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:testnet.md
│ │ │ │ │ ├── developer:docs:details:asa.md
│ │ │ │ │ ├── developer:docs:details:atc.md
│ │ │ │ │ ├── developer:docs:details:atomic_transfers.md
│ │ │ │ │ ├── developer:docs:details:conduit.md
│ │ │ │ │ ├── developer:docs:details:crust.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:jsonspec.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v1.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v10.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v2.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v3.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v4.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v5.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v6.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v7.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v8.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v9.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:specification.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:ABI:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:create.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:innertx.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:state.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:txs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:debugging.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:apps.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:modes.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:beaker.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:pyteal.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:python.md
│ │ │ │ │ ├── developer:docs:details:encoding.md
│ │ │ │ │ ├── developer:docs:details:ethereum_to_algorand.md
│ │ │ │ │ ├── developer:docs:details:index.md
│ │ │ │ │ ├── developer:docs:details:indexer.md
│ │ │ │ │ ├── developer:docs:details:parameter_tables.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:index.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:light_client.md
│ │ │ │ │ ├── developer:docs:details:technical_faq.md
│ │ │ │ │ ├── developer:docs:details:transactions:index.md
│ │ │ │ │ ├── developer:docs:details:transactions:offline_transactions.md
│ │ │ │ │ ├── developer:docs:details:transactions:payment_prompts.md
│ │ │ │ │ ├── developer:docs:details:transactions:signatures.md
│ │ │ │ │ ├── developer:docs:details:transactions:transactions.md
│ │ │ │ │ ├── developer:docs:details:useful_resources.md
│ │ │ │ │ ├── developer:docs:get-started:algokit.md
│ │ │ │ │ ├── developer:docs:get-started:basics:what_is_blockchain.md
│ │ │ │ │ ├── developer:docs:get-started:basics:whats_a_dapp.md
│ │ │ │ │ ├── developer:docs:get-started:basics:where_to_start.md
│ │ │ │ │ ├── developer:docs:get-started:basics:why_algorand.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:ft.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:nft.md
│ │ │ │ │ ├── developer:docs:index.md
│ │ │ │ │ ├── developer:docs:rest-apis:algod.md
│ │ │ │ │ ├── developer:docs:rest-apis:indexer.md
│ │ │ │ │ ├── developer:docs:rest-apis:kmd.md
│ │ │ │ │ ├── developer:docs:rest-apis:restendpoints.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:catchup.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:switch_networks.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:generate_keys.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:index.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:offline.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:online.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:renew.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:artifacts.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:config.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:relay.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:telemetry-config.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:indexer.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:install.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:node-troubleshooting.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:types.md
│ │ │ │ │ ├── developer:docs:sdks:go:index.md
│ │ │ │ │ ├── developer:docs:sdks:index.md
│ │ │ │ │ ├── developer:docs:sdks:java:index.md
│ │ │ │ │ ├── developer:docs:sdks:javascript:index.md
│ │ │ │ │ ├── developer:docs:sdks:python:index.md
│ │ │ │ │ ├── developer:python:code:example:accounts.md
│ │ │ │ │ ├── developer:python:code:example:arc4_types.md
│ │ │ │ │ ├── developer:python:code:example:assets.md
│ │ │ │ │ ├── developer:python:code:example:box_storage.md
│ │ │ │ │ ├── developer:python:code:example:control_flow.md
│ │ │ │ │ ├── developer:python:code:example:crypto:merkle_tree.md
│ │ │ │ │ ├── developer:python:code:example:defi:amm.md
│ │ │ │ │ ├── developer:python:code:example:defi:auction.md
│ │ │ │ │ ├── developer:python:code:example:defi:htlc_logicsig.md
│ │ │ │ │ ├── developer:python:code:example:defi:marketplace.md
│ │ │ │ │ ├── developer:python:code:example:events:arc28_events.md
│ │ │ │ │ ├── developer:python:code:example:global_storage.md
│ │ │ │ │ ├── developer:python:code:example:governance:simple_voting.md
│ │ │ │ │ ├── developer:python:code:example:hello_world.md
│ │ │ │ │ ├── developer:python:code:example:inner_transactions.md
│ │ │ │ │ ├── developer:python:code:example:local_storage.md
│ │ │ │ │ ├── developer:python:code:example:nft:proof_of_attendance.md
│ │ │ │ │ ├── developer:python:code:example:privacy:zk_whitelist.md
│ │ │ │ │ ├── developer:python:code:example:scratch_storage.md
│ │ │ │ │ ├── developer:python:code:example:self_payment.md
│ │ │ │ │ ├── developer:python:code:example:struct_in_box.md
│ │ │ │ │ ├── developer:python:code:example:subsidize_app_call.md
│ │ │ │ │ ├── developer:python:code:example:transactions.md
│ │ │ │ │ ├── developer:python:code:example:utility:calculator.md
│ │ │ │ │ ├── devportal-code-examples:projects:python-contract-examples:README.md
│ │ │ │ │ ├── devportal-code-examples:README.md
│ │ │ │ │ ├── docs:.walletconnect:index.md
│ │ │ │ │ ├── docs:.walletconnect:walletconnect-schema.md
│ │ │ │ │ ├── docs:README.md
│ │ │ │ │ ├── docs:scripts:example_tracker:example_list.md
│ │ │ │ │ ├── docs:scripts:README.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── liquid_auth_index.md
│ │ │ │ │ ├── liquid-auth:ARCHITECTURE.md
│ │ │ │ │ ├── liquid-auth:decisions:1-Service-Authentication.md
│ │ │ │ │ ├── liquid-auth:decisions:2-Bidirectional-Communication.md
│ │ │ │ │ ├── liquid-auth:decisions:3-Peer-to-Peer-Signaling.md
│ │ │ │ │ ├── liquid-auth:decisions:4-Fido-Extension.md
│ │ │ │ │ ├── liquid-auth:decisions:README.md
│ │ │ │ │ ├── liquid-auth:docs:architecture.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:authenticate.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:register.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:authentication.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:example.md
│ │ │ │ │ ├── liquid-auth:docs:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:README.md
│ │ │ │ │ ├── liquid-auth:docs:server:environment-variables.md
│ │ │ │ │ ├── liquid-auth:docs:server:integrations.md
│ │ │ │ │ ├── liquid-auth:docs:server:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:server:running-locally.md
│ │ │ │ │ ├── liquid-auth:README.md
│ │ │ │ │ ├── liquid-auth:SEQUENCE.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md
│ │ │ │ │ ├── liquid-auth:sites:express-dapp:README.md
│ │ │ │ │ ├── liquid-auth:VISION.md
│ │ │ │ │ ├── puya_index.md
│ │ │ │ │ ├── puya:docs:algopy_testing:index.md
│ │ │ │ │ ├── puya:docs:api-algopy.arc4.md
│ │ │ │ │ ├── puya:docs:api-algopy.gtxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.itxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.md
│ │ │ │ │ ├── puya:docs:api-algopy.op.md
│ │ │ │ │ ├── puya:docs:api.md
│ │ │ │ │ ├── puya:docs:compiler.md
│ │ │ │ │ ├── puya:docs:index.md
│ │ │ │ │ ├── puya:docs:language-guide.md
│ │ │ │ │ ├── puya:docs:lg-arc28.md
│ │ │ │ │ ├── puya:docs:lg-arc4.md
│ │ │ │ │ ├── puya:docs:lg-builtins.md
│ │ │ │ │ ├── puya:docs:lg-calling-apps.md
│ │ │ │ │ ├── puya:docs:lg-compile.md
│ │ │ │ │ ├── puya:docs:lg-control.md
│ │ │ │ │ ├── puya:docs:lg-errors.md
│ │ │ │ │ ├── puya:docs:lg-logs.md
│ │ │ │ │ ├── puya:docs:lg-modules.md
│ │ │ │ │ ├── puya:docs:lg-opcode-budget.md
│ │ │ │ │ ├── puya:docs:lg-ops.md
│ │ │ │ │ ├── puya:docs:lg-storage.md
│ │ │ │ │ ├── puya:docs:lg-structure.md
│ │ │ │ │ ├── puya:docs:lg-transactions.md
│ │ │ │ │ ├── puya:docs:lg-types.md
│ │ │ │ │ ├── puya:docs:lg-unsupported-python-features.md
│ │ │ │ │ ├── puya:docs:principles.md
│ │ │ │ │ ├── puya:examples:auction:README.md
│ │ │ │ │ ├── puya:python:testing:docs:algopy.md
│ │ │ │ │ ├── puya:python:testing:docs:api.md
│ │ │ │ │ ├── puya:python:testing:docs:coverage.md
│ │ │ │ │ ├── puya:python:testing:docs:examples.md
│ │ │ │ │ ├── puya:python:testing:docs:faq.md
│ │ │ │ │ ├── puya:python:testing:docs:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:arc4-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:avm-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:concepts.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:contract-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:opcodes.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:signature-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:state-management.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:subroutines.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:transactions.md
│ │ │ │ │ ├── puya:python:testing:examples:README.md
│ │ │ │ │ ├── puya:python:testing:README.md
│ │ │ │ │ ├── puya:README.md
│ │ │ │ │ ├── puya:src:puya:ARCHITECTURE.md
│ │ │ │ │ ├── puya:src:puyapy:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:awst_build:README.md
│ │ │ │ │ ├── puya:stubs:README.md
│ │ │ │ │ ├── puya:tests:test_expected_output:README.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md
│ │ │ │ │ ├── puya:typescript:docs:README.md
│ │ │ │ │ ├── puya:typescript:packages:algo-ts:readme.md
│ │ │ │ │ ├── puya:typescript:README.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIAddressType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayDynamicType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayStaticType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIBoolType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIByteType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIContract.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIInterface.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIMethod.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIStringType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABITupleType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUfixedType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUintType.md
│ │ │ │ │ ├── SDKs:javascript:classes:Algodv2.md
│ │ │ │ │ ├── SDKs:javascript:classes:AtomicTransactionComposer.md
│ │ │ │ │ ├── SDKs:javascript:classes:DryrunResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:Indexer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogData.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetBalancesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHoldingsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Block.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockRewards.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeVote.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HashFactory.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HealthCheck.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.IndexerStateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MerkleArrayProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MiniAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ParticipationUpdates.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofFields.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofParticipant.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofReveal.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSigSlot.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofTracking.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofVerifier.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Transaction.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionApplication.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetFreeze.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetTransfer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionKeyreg.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionPayment.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureLogicsig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionStateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:Kmd.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSig.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetsInformationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AppCallLogs.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationKVStorage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateOperation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHoldingReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockHashResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockTxidsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BuildVersion.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.CompileResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DisassembleResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunSource.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunTxnResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetSyncRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.KvDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LightBlockHeaderProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.NodeStatusResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PostTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ScratchChange.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTraceConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionGroupResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationEvalOverrides.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationTransactionExecTrace.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SupplyResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionParametersResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionProofResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Version.md
│ │ │ │ │ ├── SDKs:javascript:classes:SourceMap.md
│ │ │ │ │ ├── SDKs:javascript:classes:Transaction.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABIReferenceType.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABITransactionType.md
│ │ │ │ │ ├── SDKs:javascript:enums:AtomicTransactionComposerStatus.md
│ │ │ │ │ ├── SDKs:javascript:enums:IntDecoding.md
│ │ │ │ │ ├── SDKs:javascript:enums:OnApplicationComplete.md
│ │ │ │ │ ├── SDKs:javascript:enums:TransactionType.md
│ │ │ │ │ ├── SDKs:javascript:examples:README.md
│ │ │ │ │ ├── SDKs:javascript:FAQ.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworkInfo.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworks.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIInterfaceParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodArgParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodReturnParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIResult.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Account.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Address.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:AlgodTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClient.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientError.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientResponse.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:CustomTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedAssetParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedBoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedGlobalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLocalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedMultisig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSubsig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:IndexerTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:KMDTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:MultisigMetadata.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SuggestedParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionWithSigner.md
│ │ │ │ │ ├── SDKs:javascript:modules:indexerModels.md
│ │ │ │ │ ├── SDKs:javascript:modules:modelsv2.md
│ │ │ │ │ ├── SDKs:javascript:modules.md
│ │ │ │ │ ├── SDKs:javascript:README.md
│ │ │ │ │ ├── SDKs:python:algosdk:v2client:harness:README.md
│ │ │ │ │ ├── SDKs:python:examples:README.md
│ │ │ │ │ ├── SDKs:python:README.md
│ │ │ │ │ ├── tealscript:examples_amm_README.md
│ │ │ │ │ ├── tealscript:examples_auction_README.md
│ │ │ │ │ ├── tealscript:examples_big_box_README.md
│ │ │ │ │ ├── tealscript:examples_itxns_README.md
│ │ │ │ │ ├── tealscript:examples_lsig_with_app_README.md
│ │ │ │ │ ├── tealscript:examples_reti_README.md
│ │ │ │ │ ├── tealscript:FEATURES.md
│ │ │ │ │ ├── tealscript:guides_atomic_txn.md
│ │ │ │ │ ├── tealscript:guides_features.md
│ │ │ │ │ ├── tealscript:guides_getting_started.md
│ │ │ │ │ ├── tealscript:guides_inner_transactions.md
│ │ │ │ │ ├── tealscript:guides_lifecycle.md
│ │ │ │ │ ├── tealscript:guides_math.md
│ │ │ │ │ ├── tealscript:guides_methods.md
│ │ │ │ │ ├── tealscript:guides_multiple_contracts.md
│ │ │ │ │ ├── tealscript:guides_pyteal.md
│ │ │ │ │ ├── tealscript:guides_storage.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_arrays.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_numbers.md
│ │ │ │ │ ├── TEALScript:README.md
│ │ │ │ │ ├── tealscript:tests_test_package_README.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0001-intro.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0002-init.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0003-contract.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0004-artifacts.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0005-hello.md
│ │ │ │ │ └── tealscript:tutorials_Hello World_0006-test.md
│ │ │ │ └── taxonomy-categories
│ │ │ │ ├── algokit-utils.json
│ │ │ │ ├── algokit.json
│ │ │ │ ├── arcs.json
│ │ │ │ ├── clis.json
│ │ │ │ ├── details.json
│ │ │ │ ├── developers.json
│ │ │ │ ├── liquid-auth.json
│ │ │ │ ├── nodes.json
│ │ │ │ ├── puya.json
│ │ │ │ ├── python.json
│ │ │ │ ├── sdks.json
│ │ │ │ └── tealscript.json
│ │ │ └── wallet
│ │ │ └── index.ts
│ │ ├── tools
│ │ │ ├── accountManager.ts
│ │ │ ├── algodManager.ts
│ │ │ ├── apiManager
│ │ │ │ ├── algod
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── example
│ │ │ │ │ ├── get-balance.ts
│ │ │ │ │ └── index.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── indexer
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── nfd
│ │ │ │ │ └── index.ts
│ │ │ │ ├── tinyman
│ │ │ │ │ ├── analytics.ts
│ │ │ │ │ ├── bootstrap.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── liquidity.ts
│ │ │ │ │ ├── opt_in.ts
│ │ │ │ │ ├── pool.ts
│ │ │ │ │ ├── remove_liquidity.ts
│ │ │ │ │ └── swap.ts
│ │ │ │ ├── ultrade
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── market.ts
│ │ │ │ │ ├── system.ts
│ │ │ │ │ └── wallet.ts
│ │ │ │ └── vestige
│ │ │ │ ├── assets.ts
│ │ │ │ ├── balances.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── networks.ts
│ │ │ │ ├── notes.ts
│ │ │ │ ├── pools.ts
│ │ │ │ ├── protocols.ts
│ │ │ │ ├── swaps.ts
│ │ │ │ └── vaults.ts
│ │ │ ├── arc26Manager.ts
│ │ │ ├── index.ts
│ │ │ ├── knowledgeManager.ts
│ │ │ ├── transactionManager
│ │ │ │ ├── accountTransactions.ts
│ │ │ │ ├── appTransactions
│ │ │ │ │ ├── callTxn.ts
│ │ │ │ │ ├── clearTxn.ts
│ │ │ │ │ ├── closeOutTxn.ts
│ │ │ │ │ ├── createTxn.ts
│ │ │ │ │ ├── deleteTxn.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── optInTxn.ts
│ │ │ │ │ ├── test
│ │ │ │ │ │ ├── counter_approval.teal
│ │ │ │ │ │ ├── counter_clear.teal
│ │ │ │ │ │ ├── storage_test_approval_v2.teal
│ │ │ │ │ │ ├── storage_test_approval.teal
│ │ │ │ │ │ └── storage_test_clear.teal
│ │ │ │ │ ├── types.ts
│ │ │ │ │ └── updateTxn.ts
│ │ │ │ ├── assetTransactions.ts
│ │ │ │ ├── generalTransaction.ts
│ │ │ │ └── index.ts
│ │ │ └── utilityManager.ts
│ │ ├── types.ts
│ │ └── utils
│ │ └── responseProcessor.ts
│ ├── tests
│ │ ├── resources
│ │ │ ├── algod
│ │ │ │ ├── account.test.ts
│ │ │ │ ├── application.test.ts
│ │ │ │ ├── asset.test.ts
│ │ │ │ └── transaction.test.ts
│ │ │ └── indexer
│ │ │ ├── account.test.ts
│ │ │ ├── application.test.ts
│ │ │ ├── asset.test.ts
│ │ │ └── transaction.test.ts
│ │ └── tools
│ │ ├── accountManager.test.ts
│ │ ├── algodManager.test.ts
│ │ ├── apiManager
│ │ │ └── example
│ │ │ └── get-balance.test.ts
│ │ ├── transactionManager
│ │ │ ├── accountTransactionManager.test.ts
│ │ │ ├── appTransactionManager.test.ts
│ │ │ ├── assetTransactionManager.test.ts
│ │ │ ├── generalTransactionManager.test.ts
│ │ │ └── transactionManager.test.ts
│ │ └── utilityManager.test.ts
│ └── tsconfig.json
├── README.md
├── rename_files.sh
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / index
2 |
3 | # Module: index
4 |
5 | ## Table of contents
6 |
7 | ### References
8 |
9 | - [ALGOKIT\_DIR](index.md#algokit_dir)
10 | - [AVMTracesEventData](index.md#avmtraceseventdata)
11 | - [AlgorandClient](index.md#algorandclient)
12 | - [DEFAULT\_MAX\_SEARCH\_DEPTH](index.md#default_max_search_depth)
13 | - [EventDataMap](index.md#eventdatamap)
14 | - [EventType](index.md#eventtype)
15 | - [SOURCES\_DIR](index.md#sources_dir)
16 | - [SearchForTransactions](index.md#searchfortransactions)
17 | - [TEAL\_FILE\_EXT](index.md#teal_file_ext)
18 | - [TEAL\_SOURCEMAP\_EXT](index.md#teal_sourcemap_ext)
19 | - [TealSourceDebugEventData](index.md#tealsourcedebugeventdata)
20 | - [TealSourcesDebugEventData](index.md#tealsourcesdebugeventdata)
21 | - [executePaginatedRequest](index.md#executepaginatedrequest)
22 | - [lookupAccountByAddress](index.md#lookupaccountbyaddress)
23 | - [lookupAccountCreatedApplicationByAddress](index.md#lookupaccountcreatedapplicationbyaddress)
24 | - [lookupAssetHoldings](index.md#lookupassetholdings)
25 | - [lookupTransactionById](index.md#lookuptransactionbyid)
26 | - [searchTransactions](index.md#searchtransactions)
27 |
28 | ### Namespaces
29 |
30 | - [indexer](index.indexer.md)
31 |
32 | ### Type Aliases
33 |
34 | - [AccountInformation](index.md#accountinformation)
35 | - [NumberConverter](index.md#numberconverter)
36 |
37 | ### Variables
38 |
39 | - [ALGORAND\_MIN\_TX\_FEE](index.md#algorand_min_tx_fee)
40 | - [Config](index.md#config)
41 | - [MAX\_APP\_CALL\_ACCOUNT\_REFERENCES](index.md#max_app_call_account_references)
42 | - [MAX\_APP\_CALL\_FOREIGN\_REFERENCES](index.md#max_app_call_foreign_references)
43 | - [MAX\_TRANSACTION\_GROUP\_SIZE](index.md#max_transaction_group_size)
44 |
45 | ### Functions
46 |
47 | - [algo](index.md#algo)
48 | - [algos](index.md#algos)
49 | - [assetBulkOptIn](index.md#assetbulkoptin)
50 | - [assetBulkOptOut](index.md#assetbulkoptout)
51 | - [assetOptIn](index.md#assetoptin)
52 | - [assetOptOut](index.md#assetoptout)
53 | - [callApp](index.md#callapp)
54 | - [capTransactionFee](index.md#captransactionfee)
55 | - [compileTeal](index.md#compileteal)
56 | - [controlFees](index.md#controlfees)
57 | - [createApp](index.md#createapp)
58 | - [createAsset](index.md#createasset)
59 | - [decodeAppState](index.md#decodeappstate)
60 | - [deployApp](index.md#deployapp)
61 | - [encodeLease](index.md#encodelease)
62 | - [encodeTransactionNote](index.md#encodetransactionnote)
63 | - [ensureFunded](index.md#ensurefunded)
64 | - [getABIMethodSignature](index.md#getabimethodsignature)
65 | - [getABIReturn](index.md#getabireturn)
66 | - [getABIReturnValue](index.md#getabireturnvalue)
67 | - [getAccount](index.md#getaccount)
68 | - [getAccountAddressAsString](index.md#getaccountaddressasstring)
69 | - [getAccountAddressAsUint8Array](index.md#getaccountaddressasuint8array)
70 | - [getAccountAssetInformation](index.md#getaccountassetinformation)
71 | - [getAccountConfigFromEnvironment](index.md#getaccountconfigfromenvironment)
72 | - [getAccountInformation](index.md#getaccountinformation)
73 | - [getAlgoClient](index.md#getalgoclient)
74 | - [getAlgoIndexerClient](index.md#getalgoindexerclient)
75 | - [getAlgoKmdClient](index.md#getalgokmdclient)
76 | - [getAlgoNodeConfig](index.md#getalgonodeconfig)
77 | - [getAlgodConfigFromEnvironment](index.md#getalgodconfigfromenvironment)
78 | - [getAppArgsForABICall](index.md#getappargsforabicall)
79 | - [getAppArgsForTransaction](index.md#getappargsfortransaction)
80 | - [getAppBoxNames](index.md#getappboxnames)
81 | - [getAppBoxValue](index.md#getappboxvalue)
82 | - [getAppBoxValueFromABIType](index.md#getappboxvaluefromabitype)
83 | - [getAppBoxValues](index.md#getappboxvalues)
84 | - [getAppBoxValuesFromABIType](index.md#getappboxvaluesfromabitype)
85 | - [getAppById](index.md#getappbyid)
86 | - [getAppClient](index.md#getappclient)
87 | - [getAppClientByCreatorAndName](index.md#getappclientbycreatorandname)
88 | - [getAppClientById](index.md#getappclientbyid)
89 | - [getAppDeploymentTransactionNote](index.md#getappdeploymenttransactionnote)
90 | - [getAppGlobalState](index.md#getappglobalstate)
91 | - [getAppLocalState](index.md#getapplocalstate)
92 | - [getAppOnCompleteAction](index.md#getapponcompleteaction)
93 | - [getAtomicTransactionComposerTransactions](index.md#getatomictransactioncomposertransactions)
94 | - [getBoxReference](index.md#getboxreference)
95 | - [getConfigFromEnvOrDefaults](index.md#getconfigfromenvordefaults)
96 | - [getCreatorAppsByName](index.md#getcreatorappsbyname)
97 | - [getDefaultLocalNetConfig](index.md#getdefaultlocalnetconfig)
98 | - [getDispenserAccount](index.md#getdispenseraccount)
99 | - [getIndexerConfigFromEnvironment](index.md#getindexerconfigfromenvironment)
100 | - [getKmdWalletAccount](index.md#getkmdwalletaccount)
101 | - [getLocalNetDispenserAccount](index.md#getlocalnetdispenseraccount)
102 | - [getOrCreateKmdWalletAccount](index.md#getorcreatekmdwalletaccount)
103 | - [getSenderAddress](index.md#getsenderaddress)
104 | - [getSenderTransactionSigner](index.md#getsendertransactionsigner)
105 | - [getTestNetDispenserApiClient](index.md#gettestnetdispenserapiclient)
106 | - [getTransactionParams](index.md#gettransactionparams)
107 | - [getTransactionWithSigner](index.md#gettransactionwithsigner)
108 | - [isLocalNet](index.md#islocalnet)
109 | - [isMainNet](index.md#ismainnet)
110 | - [isSchemaIsBroken](index.md#isschemaisbroken)
111 | - [isTestNet](index.md#istestnet)
112 | - [microAlgo](index.md#microalgo)
113 | - [microAlgos](index.md#microalgos)
114 | - [mnemonicAccount](index.md#mnemonicaccount)
115 | - [mnemonicAccountFromEnvironment](index.md#mnemonicaccountfromenvironment)
116 | - [multisigAccount](index.md#multisigaccount)
117 | - [performAtomicTransactionComposerSimulate](index.md#performatomictransactioncomposersimulate)
118 | - [performTemplateSubstitution](index.md#performtemplatesubstitution)
119 | - [performTemplateSubstitutionAndCompile](index.md#performtemplatesubstitutionandcompile)
120 | - [persistSourceMaps](index.md#persistsourcemaps)
121 | - [populateAppCallResources](index.md#populateappcallresources)
122 | - [randomAccount](index.md#randomaccount)
123 | - [rekeyAccount](index.md#rekeyaccount)
124 | - [rekeyedAccount](index.md#rekeyedaccount)
125 | - [replaceDeployTimeControlParams](index.md#replacedeploytimecontrolparams)
126 | - [sendAtomicTransactionComposer](index.md#sendatomictransactioncomposer)
127 | - [sendGroupOfTransactions](index.md#sendgroupoftransactions)
128 | - [sendTransaction](index.md#sendtransaction)
129 | - [signTransaction](index.md#signtransaction)
130 | - [stripTealComments](index.md#striptealcomments)
131 | - [transactionFees](index.md#transactionfees)
132 | - [transactionSignerAccount](index.md#transactionsigneraccount)
133 | - [transferAlgos](index.md#transferalgos)
134 | - [transferAsset](index.md#transferasset)
135 | - [updateApp](index.md#updateapp)
136 | - [waitForConfirmation](index.md#waitforconfirmation)
137 |
138 | ## References
139 |
140 | ### ALGOKIT\_DIR
141 |
142 | Re-exports [ALGOKIT_DIR](types_debugging.md#algokit_dir)
143 |
144 | ___
145 |
146 | ### AVMTracesEventData
147 |
148 | Re-exports [AVMTracesEventData](../interfaces/types_debugging.AVMTracesEventData.md)
149 |
150 | ___
151 |
152 | ### AlgorandClient
153 |
154 | Re-exports [AlgorandClient](../classes/types_algorand_client.AlgorandClient.md)
155 |
156 | ___
157 |
158 | ### DEFAULT\_MAX\_SEARCH\_DEPTH
159 |
160 | Re-exports [DEFAULT_MAX_SEARCH_DEPTH](types_debugging.md#default_max_search_depth)
161 |
162 | ___
163 |
164 | ### EventDataMap
165 |
166 | Re-exports [EventDataMap](types_lifecycle_events.md#eventdatamap)
167 |
168 | ___
169 |
170 | ### EventType
171 |
172 | Re-exports [EventType](../enums/types_lifecycle_events.EventType.md)
173 |
174 | ___
175 |
176 | ### SOURCES\_DIR
177 |
178 | Re-exports [SOURCES_DIR](types_debugging.md#sources_dir)
179 |
180 | ___
181 |
182 | ### SearchForTransactions
183 |
184 | Re-exports [SearchForTransactions](index.indexer.md#searchfortransactions)
185 |
186 | ___
187 |
188 | ### TEAL\_FILE\_EXT
189 |
190 | Re-exports [TEAL_FILE_EXT](types_debugging.md#teal_file_ext)
191 |
192 | ___
193 |
194 | ### TEAL\_SOURCEMAP\_EXT
195 |
196 | Re-exports [TEAL_SOURCEMAP_EXT](types_debugging.md#teal_sourcemap_ext)
197 |
198 | ___
199 |
200 | ### TealSourceDebugEventData
201 |
202 | Re-exports [TealSourceDebugEventData](../interfaces/types_debugging.TealSourceDebugEventData.md)
203 |
204 | ___
205 |
206 | ### TealSourcesDebugEventData
207 |
208 | Re-exports [TealSourcesDebugEventData](../interfaces/types_debugging.TealSourcesDebugEventData.md)
209 |
210 | ___
211 |
212 | ### executePaginatedRequest
213 |
214 | Re-exports [executePaginatedRequest](index.indexer.md#executepaginatedrequest)
215 |
216 | ___
217 |
218 | ### lookupAccountByAddress
219 |
220 | Re-exports [lookupAccountByAddress](index.indexer.md#lookupaccountbyaddress)
221 |
222 | ___
223 |
224 | ### lookupAccountCreatedApplicationByAddress
225 |
226 | Re-exports [lookupAccountCreatedApplicationByAddress](index.indexer.md#lookupaccountcreatedapplicationbyaddress)
227 |
228 | ___
229 |
230 | ### lookupAssetHoldings
231 |
232 | Re-exports [lookupAssetHoldings](index.indexer.md#lookupassetholdings)
233 |
234 | ___
235 |
236 | ### lookupTransactionById
237 |
238 | Re-exports [lookupTransactionById](index.indexer.md#lookuptransactionbyid)
239 |
240 | ___
241 |
242 | ### searchTransactions
243 |
244 | Re-exports [searchTransactions](index.indexer.md#searchtransactions)
245 |
246 | ## Type Aliases
247 |
248 | ### AccountInformation
249 |
250 | Ƭ **AccountInformation**: `Omit`\<[`NumberConverter`](index.md#numberconverter)\<`AccountInformationModel`\>, ``"getEncodingSchema"`` \| ``"toEncodingData"`` \| ``"authAddr"``\> & \{ `authAddr?`: `string` }
251 |
252 | **`Deprecated`**
253 |
254 | Account information at a given round.
255 |
256 | #### Defined in
257 |
258 | [src/account/account.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L135)
259 |
260 | ___
261 |
262 | ### NumberConverter
263 |
264 | Ƭ **NumberConverter**\<`T`\>: \{ [key in keyof T]: ToNumberIfExtends\<T[key], number \| bigint\> }
265 |
266 | #### Type parameters
267 |
268 | | Name | Type |
269 | | :------ | :------ |
270 | | `T` | extends `AccountInformationModel` |
271 |
272 | #### Defined in
273 |
274 | [src/account/account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L132)
275 |
276 | ## Variables
277 |
278 | ### ALGORAND\_MIN\_TX\_FEE
279 |
280 | • `Const` **ALGORAND\_MIN\_TX\_FEE**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
281 |
282 | #### Defined in
283 |
284 | [src/amount.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L93)
285 |
286 | ___
287 |
288 | ### Config
289 |
290 | • `Const` **Config**: [`UpdatableConfig`](../classes/types_config.UpdatableConfig.md)
291 |
292 | The AlgoKit config. To update it use the configure method.
293 |
294 | #### Defined in
295 |
296 | [src/config.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/config.ts#L4)
297 |
298 | ___
299 |
300 | ### MAX\_APP\_CALL\_ACCOUNT\_REFERENCES
301 |
302 | • `Const` **MAX\_APP\_CALL\_ACCOUNT\_REFERENCES**: ``4``
303 |
304 | #### Defined in
305 |
306 | [src/transaction/transaction.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L31)
307 |
308 | ___
309 |
310 | ### MAX\_APP\_CALL\_FOREIGN\_REFERENCES
311 |
312 | • `Const` **MAX\_APP\_CALL\_FOREIGN\_REFERENCES**: ``8``
313 |
314 | #### Defined in
315 |
316 | [src/transaction/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L30)
317 |
318 | ___
319 |
320 | ### MAX\_TRANSACTION\_GROUP\_SIZE
321 |
322 | • `Const` **MAX\_TRANSACTION\_GROUP\_SIZE**: ``16``
323 |
324 | #### Defined in
325 |
326 | [src/transaction/transaction.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L29)
327 |
328 | ## Functions
329 |
330 | ### algo
331 |
332 | ▸ **algo**(`algos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
333 |
334 | Returns an amount of Algo using AlgoAmount
335 |
336 | #### Parameters
337 |
338 | | Name | Type | Description |
339 | | :------ | :------ | :------ |
340 | | `algos` | `number` \| `bigint` | The amount of Algo |
341 |
342 | #### Returns
343 |
344 | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
345 |
346 | #### Defined in
347 |
348 | [src/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L68)
349 |
350 | ___
351 |
352 | ### algos
353 |
354 | ▸ **algos**(`algos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
355 |
356 | Returns an amount of Algo using AlgoAmount
357 |
358 | #### Parameters
359 |
360 | | Name | Type | Description |
361 | | :------ | :------ | :------ |
362 | | `algos` | `number` \| `bigint` | The amount of Algo |
363 |
364 | #### Returns
365 |
366 | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
367 |
368 | #### Defined in
369 |
370 | [src/amount.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L61)
371 |
372 | ___
373 |
374 | ### assetBulkOptIn
375 |
376 | ▸ **assetBulkOptIn**(`optIn`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\>
377 |
378 | #### Parameters
379 |
380 | | Name | Type | Description |
381 | | :------ | :------ | :------ |
382 | | `optIn` | [`AssetBulkOptInOutParams`](../interfaces/types_asset.AssetBulkOptInOutParams.md) | The bulk opt-in request. |
383 | | `algod` | `AlgodClient` | An instance of the Algodv2 class from the `algosdk` library. |
384 |
385 | #### Returns
386 |
387 | `Promise`\<`Record`\<`number`, `string`\>\>
388 |
389 | A record object where the keys are the asset IDs and the values are the corresponding transaction IDs for successful opt-ins.
390 |
391 | **`Deprecated`**
392 |
393 | use `algorand.asset.bulkOptIn()` instead
394 |
395 | Opt in to a list of assets on the Algorand blockchain.
396 |
397 | **`Throws`**
398 |
399 | If there is an error during the opt-in process.
400 |
401 | **`Example`**
402 |
403 | ```ts
404 | algokit.bulkOptIn({ account: account, assetIds: [12345, 67890] }, algod)
405 | ```
406 |
407 | #### Defined in
408 |
409 | [src/asset.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L130)
410 |
411 | ___
412 |
413 | ### assetBulkOptOut
414 |
415 | ▸ **assetBulkOptOut**(`optOut`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\>
416 |
417 | #### Parameters
418 |
419 | | Name | Type | Description |
420 | | :------ | :------ | :------ |
421 | | `optOut` | [`AssetBulkOptInOutParams`](../interfaces/types_asset.AssetBulkOptInOutParams.md) | The bulk opt-out request. |
422 | | `algod` | `AlgodClient` | An instance of the Algodv2 client used to interact with the Algorand blockchain. |
423 |
424 | #### Returns
425 |
426 | `Promise`\<`Record`\<`number`, `string`\>\>
427 |
428 | A record object containing asset IDs as keys and their corresponding transaction IDs as values.
429 |
430 | **`Deprecated`**
431 |
432 | use `algorand.asset.bulkOptOut()` instead
433 |
434 | Opt out of multiple assets in Algorand blockchain.
435 |
436 | **`Throws`**
437 |
438 | If there is an error during the opt-out process.
439 |
440 | **`Example`**
441 |
442 | ```ts
443 | algokit.bulkOptOut({ account: account, assetIds: [12345, 67890] }, algod)
444 | ```
445 |
446 | #### Defined in
447 |
448 | [src/asset.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L157)
449 |
450 | ___
451 |
452 | ### assetOptIn
453 |
454 | ▸ **assetOptIn**(`optIn`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
455 |
456 | #### Parameters
457 |
458 | | Name | Type | Description |
459 | | :------ | :------ | :------ |
460 | | `optIn` | [`AssetOptInParams`](../interfaces/types_asset.AssetOptInParams.md) | The opt-in definition |
461 | | `algod` | `AlgodClient` | An algod client |
462 |
463 | #### Returns
464 |
465 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
466 |
467 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
468 |
469 | **`Deprecated`**
470 |
471 | use `algorand.send.assetOptIn()` / `algorand.createTransaction.assetOptIn()` instead
472 |
473 | Opt-in an account to an asset.
474 |
475 | **`Example`**
476 |
477 | ```typescript
478 | await algokit.assetOptIn({ account, assetId }, algod)
479 | ```
480 |
481 | #### Defined in
482 |
483 | [src/asset.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L67)
484 |
485 | ___
486 |
487 | ### assetOptOut
488 |
489 | ▸ **assetOptOut**(`optOut`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
490 |
491 | #### Parameters
492 |
493 | | Name | Type | Description |
494 | | :------ | :------ | :------ |
495 | | `optOut` | [`AssetOptOutParams`](../interfaces/types_asset.AssetOptOutParams.md) | The opt-in definition |
496 | | `algod` | `AlgodClient` | An algod client |
497 |
498 | #### Returns
499 |
500 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
501 |
502 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
503 |
504 | **`Deprecated`**
505 |
506 | use `algorand.send.assetOptOut()` / `algorand.createTransaction.assetOptOut()` instead
507 |
508 | Opt-out an account from an asset.
509 |
510 | **`Example`**
511 |
512 | ```typescript
513 | await algokit.assetOptOut({ account, assetId, assetCreatorAddress }, algod)
514 | ```
515 |
516 | #### Defined in
517 |
518 | [src/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L98)
519 |
520 | ___
521 |
522 | ### callApp
523 |
524 | ▸ **callApp**(`call`, `algod`): `Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\>
525 |
526 | #### Parameters
527 |
528 | | Name | Type | Description |
529 | | :------ | :------ | :------ |
530 | | `call` | [`AppCallParams`](../interfaces/types_app.AppCallParams.md) | The call details. |
531 | | `algod` | `AlgodClient` | An algod client |
532 |
533 | #### Returns
534 |
535 | `Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\>
536 |
537 | The result of the call
538 |
539 | **`Deprecated`**
540 |
541 | Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()`
542 | / `algorand.createTransaction.appUpdateMethodCall()` instead
543 |
544 | Issues a call to a given app.
545 |
546 | #### Defined in
547 |
548 | [src/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L187)
549 |
550 | ___
551 |
552 | ### capTransactionFee
553 |
554 | ▸ **capTransactionFee**(`transaction`, `maxAcceptableFee`): `void`
555 |
556 | #### Parameters
557 |
558 | | Name | Type | Description |
559 | | :------ | :------ | :------ |
560 | | `transaction` | `Transaction` \| `SuggestedParams` | The transaction to cap or suggested params object about to be used to create a transaction |
561 | | `maxAcceptableFee` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The maximum acceptable fee to pay |
562 |
563 | #### Returns
564 |
565 | `void`
566 |
567 | **`Deprecated`**
568 |
569 | Use `TransactionComposer` and the `maxFee` field in the transaction params instead.
570 |
571 | Limit the acceptable fee to a defined amount of µAlgo.
572 | This also sets the transaction to be flatFee to ensure the transaction only succeeds at
573 | the estimated rate.
574 |
575 | #### Defined in
576 |
577 | [src/transaction/transaction.ts:874](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L874)
578 |
579 | ___
580 |
581 | ### compileTeal
582 |
583 | ▸ **compileTeal**(`tealCode`, `algod`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
584 |
585 | #### Parameters
586 |
587 | | Name | Type | Description |
588 | | :------ | :------ | :------ |
589 | | `tealCode` | `string` | The TEAL code |
590 | | `algod` | `AlgodClient` | An algod client |
591 |
592 | #### Returns
593 |
594 | `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
595 |
596 | The information about the compiled file
597 |
598 | **`Deprecated`**
599 |
600 | Use `algorand.app.compileTeal` instead.
601 |
602 | Compiles the given TEAL using algod and returns the result, including source map.
603 |
604 | #### Defined in
605 |
606 | [src/app.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L419)
607 |
608 | ___
609 |
610 | ### controlFees
611 |
612 | ▸ **controlFees**\<`T`\>(`transaction`, `feeControl`): `T`
613 |
614 | #### Type parameters
615 |
616 | | Name | Type |
617 | | :------ | :------ |
618 | | `T` | extends `Transaction` \| `SuggestedParams` |
619 |
620 | #### Parameters
621 |
622 | | Name | Type | Description |
623 | | :------ | :------ | :------ |
624 | | `transaction` | `T` | The transaction or suggested params |
625 | | `feeControl` | `Object` | The fee control parameters |
626 | | `feeControl.fee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - |
627 | | `feeControl.maxFee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - |
628 |
629 | #### Returns
630 |
631 | `T`
632 |
633 | **`Deprecated`**
634 |
635 | Use `TransactionComposer` and the `maxFee` and `staticFee` fields in the transaction params instead.
636 |
637 | Allows for control of fees on a `Transaction` or `SuggestedParams` object
638 |
639 | #### Defined in
640 |
641 | [src/transaction/transaction.ts:901](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L901)
642 |
643 | ___
644 |
645 | ### createApp
646 |
647 | ▸ **createApp**(`create`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\>
648 |
649 | #### Parameters
650 |
651 | | Name | Type | Description |
652 | | :------ | :------ | :------ |
653 | | `create` | [`CreateAppParams`](../interfaces/types_app.CreateAppParams.md) | The parameters to create the app with |
654 | | `algod` | `AlgodClient` | An algod client |
655 |
656 | #### Returns
657 |
658 | `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\>
659 |
660 | The details of the created app, or the transaction to create it if `skipSending` and the compilation result
661 |
662 | **`Deprecated`**
663 |
664 | Use `algorand.send.appCreate()` / `algorand.createTransaction.appCreate()` / `algorand.send.appCreateMethodCall()`
665 | / `algorand.createTransaction.appCreateMethodCall()` instead
666 |
667 | Creates a smart contract app, returns the details of the created app.
668 |
669 | #### Defined in
670 |
671 | [src/app.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L44)
672 |
673 | ___
674 |
675 | ### createAsset
676 |
677 | ▸ **createAsset**(`create`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) & \{ `confirmation?`: \{ `assetIndex`: `number` \| `bigint` } }\>
678 |
679 | #### Parameters
680 |
681 | | Name | Type | Description |
682 | | :------ | :------ | :------ |
683 | | `create` | [`CreateAssetParams`](../interfaces/types_asset.CreateAssetParams.md) | The asset creation definition |
684 | | `algod` | `AlgodClient` | An algod client |
685 |
686 | #### Returns
687 |
688 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) & \{ `confirmation?`: \{ `assetIndex`: `number` \| `bigint` } }\>
689 |
690 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
691 |
692 | **`Deprecated`**
693 |
694 | use `algorand.send.assetCreate()` / `algorand.createTransaction.assetCreate()` instead
695 |
696 | Create an Algorand Standard Asset (ASA).
697 |
698 | **`Example`**
699 |
700 | ```typescript
701 | await algokit.createAsset({ creator: account, total: 1, decimals: 0, name: 'My asset' }, algod)
702 | ```
703 |
704 | #### Defined in
705 |
706 | [src/asset.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L23)
707 |
708 | ___
709 |
710 | ### decodeAppState
711 |
712 | ▸ **decodeAppState**(`state`): [`AppState`](../interfaces/types_app.AppState.md)
713 |
714 | #### Parameters
715 |
716 | | Name | Type | Description |
717 | | :------ | :------ | :------ |
718 | | `state` | \{ `key`: `string` ; `value`: `TealValue` \| `EvalDelta` }[] | A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` |
719 |
720 | #### Returns
721 |
722 | [`AppState`](../interfaces/types_app.AppState.md)
723 |
724 | An object keyeed by the UTF-8 representation of the key with various parsings of the values
725 |
726 | **`Deprecated`**
727 |
728 | Use `AppManager.decodeAppState` instead.
729 |
730 | Converts an array of global/local state values from the algod api to a more friendly
731 | generic object keyed by the UTF-8 value of the key.
732 |
733 | #### Defined in
734 |
735 | [src/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L345)
736 |
737 | ___
738 |
739 | ### deployApp
740 |
741 | ▸ **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"create"`` \| ``"update"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](types_app.md#abireturn) ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` }\>
742 |
743 | #### Parameters
744 |
745 | | Name | Type | Description |
746 | | :------ | :------ | :------ |
747 | | `deployment` | [`AppDeploymentParams`](../interfaces/types_app.AppDeploymentParams.md) | The arguments to control the app deployment |
748 | | `algod` | `AlgodClient` | An algod client |
749 | | `indexer?` | `IndexerClient` | An indexer client, needed if `existingDeployments` not passed in |
750 |
751 | #### Returns
752 |
753 | `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"create"`` \| ``"update"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](types_app.md#abireturn) ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` }\>
754 |
755 | The app reference of the new/existing app
756 |
757 | **`Deprecated`**
758 |
759 | Use `algorand.appDeployer.deploy` instead.
760 |
761 | Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions.
762 |
763 | To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md
764 |
765 | **Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`.
766 |
767 | **Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.
768 |
769 | **Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.
770 |
771 | #### Defined in
772 |
773 | [src/app-deploy.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L51)
774 |
775 | ___
776 |
777 | ### encodeLease
778 |
779 | ▸ **encodeLease**(`lease?`): `Uint8Array` \| `undefined`
780 |
781 | Encodes a transaction lease into a 32-byte array ready to be included in an Algorand transaction.
782 |
783 | #### Parameters
784 |
785 | | Name | Type | Description |
786 | | :------ | :------ | :------ |
787 | | `lease?` | `string` \| `Uint8Array` | The transaction lease as a string or binary array or null/undefined if there is no lease |
788 |
789 | #### Returns
790 |
791 | `Uint8Array` \| `undefined`
792 |
793 | the transaction lease ready for inclusion in a transaction or `undefined` if there is no lease
794 |
795 | **`Throws`**
796 |
797 | if the length of the data is > 32 bytes or empty
798 |
799 | **`Example`**
800 |
801 | ```ts
802 | algokit.encodeLease('UNIQUE_ID')
803 | ```
804 |
805 | **`Example`**
806 |
807 | ```ts
808 | algokit.encodeLease(new Uint8Array([1, 2, 3]))
809 | ```
810 |
811 | #### Defined in
812 |
813 | [src/transaction/transaction.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L72)
814 |
815 | ___
816 |
817 | ### encodeTransactionNote
818 |
819 | ▸ **encodeTransactionNote**(`note?`): `Uint8Array` \| `undefined`
820 |
821 | #### Parameters
822 |
823 | | Name | Type | Description |
824 | | :------ | :------ | :------ |
825 | | `note?` | [`TransactionNote`](types_transaction.md#transactionnote) | The transaction note |
826 |
827 | #### Returns
828 |
829 | `Uint8Array` \| `undefined`
830 |
831 | the transaction note ready for inclusion in a transaction
832 |
833 | Case on the value of `data` this either be:
834 | * `null` | `undefined`: `undefined`
835 | * `string`: The string value
836 | * Uint8Array: passthrough
837 | * Arc2TransactionNote object: ARC-0002 compatible transaction note
838 | * Else: The object/value converted into a JSON string representation
839 |
840 | **`Deprecated`**
841 |
842 | Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `TransactionComposer.arc2Note`.
843 |
844 | Encodes a transaction note into a byte array ready to be included in an Algorand transaction.
845 |
846 | #### Defined in
847 |
848 | [src/transaction/transaction.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L48)
849 |
850 | ___
851 |
852 | ### ensureFunded
853 |
854 | ▸ **ensureFunded**\<`T`\>(`funding`, `algod`, `kmd?`): `Promise`\<[`EnsureFundedReturnType`](../interfaces/types_transfer.EnsureFundedReturnType.md) \| `undefined`\>
855 |
856 | #### Type parameters
857 |
858 | | Name | Type |
859 | | :------ | :------ |
860 | | `T` | extends [`EnsureFundedParams`](../interfaces/types_transfer.EnsureFundedParams.md) |
861 |
862 | #### Parameters
863 |
864 | | Name | Type | Description |
865 | | :------ | :------ | :------ |
866 | | `funding` | `T` | The funding configuration of type `EnsureFundedParams`, including the account to fund, minimum spending balance, and optional parameters. If you set `useDispenserApi` to true, you must also set `ALGOKIT_DISPENSER_ACCESS_TOKEN` in your environment variables. |
867 | | `algod` | `AlgodClient` | An instance of the Algodv2 client. |
868 | | `kmd?` | `KmdClient` | An optional instance of the Kmd client. |
869 |
870 | #### Returns
871 |
872 | `Promise`\<[`EnsureFundedReturnType`](../interfaces/types_transfer.EnsureFundedReturnType.md) \| `undefined`\>
873 |
874 | - `EnsureFundedReturnType` if funds were transferred.
875 | - `undefined` if no funds were needed.
876 |
877 | **`Deprecated`**
878 |
879 | Use `algorand.account.ensureFunded()` / `algorand.account.ensureFundedFromEnvironment()`
880 | / `algorand.account.ensureFundedFromTestNetDispenserApi()` instead
881 |
882 | Funds a given account using a funding source such that it has a certain amount of Algo free to spend (accounting for Algo locked in minimum balance requirement).
883 |
884 | https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
885 |
886 | #### Defined in
887 |
888 | [src/transfer/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L26)
889 |
890 | ___
891 |
892 | ### getABIMethodSignature
893 |
894 | ▸ **getABIMethodSignature**(`method`): `string`
895 |
896 | #### Parameters
897 |
898 | | Name | Type | Description |
899 | | :------ | :------ | :------ |
900 | | `method` | `ABIMethodParams` \| `ABIMethod` | The method to return a signature for |
901 |
902 | #### Returns
903 |
904 | `string`
905 |
906 | The encoded ABI method spec e.g. `method_name(uint64,string)string`
907 |
908 | **`Deprecated`**
909 |
910 | Use `abiMethod.getSignature()` or `new ABIMethod(abiMethodParams).getSignature()` instead.
911 |
912 | Returns the encoded ABI spec for a given ABI Method
913 |
914 | #### Defined in
915 |
916 | [src/app.ts:430](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L430)
917 |
918 | ___
919 |
920 | ### getABIReturn
921 |
922 | ▸ **getABIReturn**(`args?`, `confirmation?`): [`ABIReturn`](types_app.md#abireturn) \| `undefined`
923 |
924 | #### Parameters
925 |
926 | | Name | Type | Description |
927 | | :------ | :------ | :------ |
928 | | `args?` | [`AppCallArgs`](types_app.md#appcallargs) | The arguments that were used for the call |
929 | | `confirmation?` | `PendingTransactionResponse` | The transaction confirmation from algod |
930 |
931 | #### Returns
932 |
933 | [`ABIReturn`](types_app.md#abireturn) \| `undefined`
934 |
935 | The return value for the method call
936 |
937 | **`Deprecated`**
938 |
939 | Use `AppManager.getABIReturn` instead.
940 |
941 | Returns any ABI return values for the given app call arguments and transaction confirmation.
942 |
943 | #### Defined in
944 |
945 | [src/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L235)
946 |
947 | ___
948 |
949 | ### getABIReturnValue
950 |
951 | ▸ **getABIReturnValue**(`result`): [`ABIReturn`](types_app.md#abireturn)
952 |
953 | Takes an algosdk `ABIResult` and converts it to an `ABIReturn`.
954 | Converts `bigint`'s for Uint's < 64 to `number` for easier use.
955 |
956 | #### Parameters
957 |
958 | | Name | Type | Description |
959 | | :------ | :------ | :------ |
960 | | `result` | `ABIResult` | The `ABIReturn` |
961 |
962 | #### Returns
963 |
964 | [`ABIReturn`](types_app.md#abireturn)
965 |
966 | #### Defined in
967 |
968 | [src/transaction/transaction.ts:744](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L744)
969 |
970 | ___
971 |
972 | ### getAccount
973 |
974 | ▸ **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
975 |
976 | #### Parameters
977 |
978 | | Name | Type | Description |
979 | | :------ | :------ | :------ |
980 | | `account` | `string` \| \{ `fundWith?`: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: * `name`: The name identifier of the account * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
981 | | `algod` | `AlgodClient` | An algod client |
982 | | `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |
983 |
984 | #### Returns
985 |
986 | `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
987 |
988 | The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
989 |
990 | **`Deprecated`**
991 |
992 | use `algorand.account.fromEnvironment()` instead
993 |
994 | Returns an Algorand account with private key loaded by convention based on the given name identifier.
995 |
996 | Note: This function expects to run in a Node.js environment.
997 |
998 | ## Convention:
999 | * **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
1000 | never commit it into source control and ideally load it via a secret storage service rather than the file system.
1001 | If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
1002 | * **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you
1003 |
1004 | This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet).
1005 |
1006 | **`Example`**
1007 |
1008 | If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:
1009 | ```typescript
1010 | const account = await getAccount('ACCOUNT', algod)
1011 | ```
1012 |
1013 | If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser.
1014 |
1015 | #### Defined in
1016 |
1017 | [src/account/get-account.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L41)
1018 |
1019 | ▸ **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
1020 |
1021 | #### Parameters
1022 |
1023 | | Name | Type | Description |
1024 | | :------ | :------ | :------ |
1025 | | `account` | `Object` | The details of the account to get, an object with: * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
1026 | | `account.config` | [`AccountConfig`](../interfaces/types_account.AccountConfig.md) | - |
1027 | | `account.fundWith?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - |
1028 | | `algod` | `AlgodClient` | An algod client |
1029 | | `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |
1030 |
1031 | #### Returns
1032 |
1033 | `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
1034 |
1035 | The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
1036 |
1037 | **`Deprecated`**
1038 |
1039 | use `algorand.account.fromEnvironment()` instead
1040 | Returns an Algorand account with private key loaded by convention based on the given name identifier.
1041 |
1042 | Note: This function expects to run in a Node.js environment.
1043 |
1044 | **`Example`**
1045 |
1046 | If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:
1047 | ```typescript
1048 | const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod)
1049 | ```
1050 |
1051 | If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser.
1052 |
1053 | #### Defined in
1054 |
1055 | [src/account/get-account.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L68)
1056 |
1057 | ___
1058 |
1059 | ### getAccountAddressAsString
1060 |
1061 | ▸ **getAccountAddressAsString**(`addressEncodedInB64`): `string`
1062 |
1063 | #### Parameters
1064 |
1065 | | Name | Type | Description |
1066 | | :------ | :------ | :------ |
1067 | | `addressEncodedInB64` | `string` | The base64 encoded version of the underlying byte array of the address public key |
1068 |
1069 | #### Returns
1070 |
1071 | `string`
1072 |
1073 | **`Deprecated`**
1074 |
1075 | Use `algosdk.encodeAddress` instead.
1076 |
1077 | Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key
1078 |
1079 | #### Defined in
1080 |
1081 | [src/account/account.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L128)
1082 |
1083 | ___
1084 |
1085 | ### getAccountAddressAsUint8Array
1086 |
1087 | ▸ **getAccountAddressAsUint8Array**(`account`): `Uint8Array`
1088 |
1089 | #### Parameters
1090 |
1091 | | Name | Type | Description |
1092 | | :------ | :------ | :------ |
1093 | | `account` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | Either an account (with private key loaded) or the string address of an account |
1094 |
1095 | #### Returns
1096 |
1097 | `Uint8Array`
1098 |
1099 | **`Deprecated`**
1100 |
1101 | Use `algosdk.decodeAddress` instead.
1102 |
1103 | Returns an account's address as a byte array
1104 |
1105 | #### Defined in
1106 |
1107 | [src/account/account.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L117)
1108 |
1109 | ___
1110 |
1111 | ### getAccountAssetInformation
1112 |
1113 | ▸ **getAccountAssetInformation**(`sender`, `assetId`, `algod`): `Promise`\<[`AccountAssetInformation`](types_account.md#accountassetinformation)\>
1114 |
1115 | #### Parameters
1116 |
1117 | | Name | Type | Description |
1118 | | :------ | :------ | :------ |
1119 | | `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The address of the sender/account to look up |
1120 | | `assetId` | `number` \| `bigint` | The ID of the asset to return a holding for |
1121 | | `algod` | `AlgodClient` | The algod instance |
1122 |
1123 | #### Returns
1124 |
1125 | `Promise`\<[`AccountAssetInformation`](types_account.md#accountassetinformation)\>
1126 |
1127 | The account asset holding information
1128 |
1129 | **`Deprecated`**
1130 |
1131 | Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
1132 |
1133 | Returns the given sender account's asset holding for a given asset.
1134 |
1135 | **`Example`**
1136 |
1137 | ```typescript
1138 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
1139 | const assetId = 123345;
1140 | const accountInfo = await account.getAccountAssetInformation(address, assetId, algod);
1141 | ```
1142 |
1143 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
1144 |
1145 | #### Defined in
1146 |
1147 | [src/account/account.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L201)
1148 |
1149 | ___
1150 |
1151 | ### getAccountConfigFromEnvironment
1152 |
1153 | ▸ **getAccountConfigFromEnvironment**(`accountName`): [`AccountConfig`](../interfaces/types_account.AccountConfig.md)
1154 |
1155 | #### Parameters
1156 |
1157 | | Name | Type | Description |
1158 | | :------ | :------ | :------ |
1159 | | `accountName` | `string` | account name |
1160 |
1161 | #### Returns
1162 |
1163 | [`AccountConfig`](../interfaces/types_account.AccountConfig.md)
1164 |
1165 | **`Deprecated`**
1166 |
1167 | Use algokit.mnemonicAccountFromEnvironment, which doesn't need this function
1168 | Returns the Account configuration from environment variables
1169 |
1170 | **`Example`**
1171 |
1172 | ```ts
1173 | environment variables
1174 | {accountName}_MNEMONIC
1175 | {accountName}_SENDER
1176 | ```
1177 |
1178 | #### Defined in
1179 |
1180 | [src/account/get-account-config-from-environment.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account-config-from-environment.ts#L13)
1181 |
1182 | ___
1183 |
1184 | ### getAccountInformation
1185 |
1186 | ▸ **getAccountInformation**(`sender`, `algod`): `Promise`\<[`AccountInformation`](index.md#accountinformation)\>
1187 |
1188 | #### Parameters
1189 |
1190 | | Name | Type | Description |
1191 | | :------ | :------ | :------ |
1192 | | `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The address of the sender/account to look up |
1193 | | `algod` | `AlgodClient` | The algod instance |
1194 |
1195 | #### Returns
1196 |
1197 | `Promise`\<[`AccountInformation`](index.md#accountinformation)\>
1198 |
1199 | The account information
1200 |
1201 | **`Deprecated`**
1202 |
1203 | Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
1204 |
1205 | Returns the given sender account's current status, balance and spendable amounts.
1206 |
1207 | **`Example`**
1208 |
1209 | ```typescript
1210 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
1211 | const accountInfo = await account.getInformation(address, algod);
1212 | ```
1213 |
1214 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
1215 |
1216 | #### Defined in
1217 |
1218 | [src/account/account.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L156)
1219 |
1220 | ___
1221 |
1222 | ### getAlgoClient
1223 |
1224 | ▸ **getAlgoClient**(`config?`): `Algodv2`
1225 |
1226 | #### Parameters
1227 |
1228 | | Name | Type | Description |
1229 | | :------ | :------ | :------ |
1230 | | `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) |
1231 |
1232 | #### Returns
1233 |
1234 | `Algodv2`
1235 |
1236 | **`Deprecated`**
1237 |
1238 | Use `ClientManager.getAlgodClient(config)` or `ClientManager.getAlgodClientFromEnvironment()` instead.
1239 |
1240 | Returns an algod SDK client that automatically retries transient failures on idempotent calls
1241 |
1242 | **`Example`**
1243 |
1244 | ```typescript
1245 | // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN
1246 | // Automatically detects if you are using PureStake to switch in the right header name for ALGOD_TOKEN
1247 | const algod = getAlgoClient()
1248 | await algod.healthCheck().do()
1249 | ```
1250 |
1251 | **`Example`**
1252 |
1253 | ```typescript
1254 | const algod = getAlgoClient(getAlgoNodeConfig('testnet', 'algod'))
1255 | await algod.healthCheck().do()
1256 | ```
1257 |
1258 | **`Example`**
1259 |
1260 | ```typescript
1261 | const algod = getAlgoClient(getAlgoNodeConfig('mainnet', 'algod'))
1262 | await algod.healthCheck().do()
1263 | ```
1264 |
1265 | **`Example`**
1266 |
1267 | ```typescript
1268 | const algod = getAlgoClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
1269 | await algod.healthCheck().do()
1270 | ```
1271 |
1272 | #### Defined in
1273 |
1274 | [src/network-client.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L88)
1275 |
1276 | ___
1277 |
1278 | ### getAlgoIndexerClient
1279 |
1280 | ▸ **getAlgoIndexerClient**(`config?`): `Indexer`
1281 |
1282 | #### Parameters
1283 |
1284 | | Name | Type | Description |
1285 | | :------ | :------ | :------ |
1286 | | `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) |
1287 |
1288 | #### Returns
1289 |
1290 | `Indexer`
1291 |
1292 | **`Deprecated`**
1293 |
1294 | Use `ClientManager.getIndexerClient(config, overrideIntDecoding)` or `ClientManager.getIndexerClientFromEnvironment(overrideIntDecoding)` instead.
1295 |
1296 | Returns an indexer SDK client that automatically retries transient failures on idempotent calls
1297 |
1298 | **`Example`**
1299 |
1300 | ```typescript
1301 | // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN
1302 | const indexer = getAlgoIndexerClient()
1303 | await indexer.makeHealthCheck().do()
1304 | ```
1305 |
1306 | **`Example`**
1307 |
1308 | ```typescript
1309 | const indexer = getAlgoIndexerClient(getAlgoNodeConfig('testnet', 'indexer'))
1310 | await indexer.makeHealthCheck().do()
1311 | ```
1312 |
1313 | **`Example`**
1314 |
1315 | ```typescript
1316 | const indexer = getAlgoIndexerClient(getAlgoNodeConfig('mainnet', 'indexer'))
1317 | await indexer.makeHealthCheck().do()
1318 | ```
1319 |
1320 | **`Example`**
1321 |
1322 | ```typescript
1323 | const indexer = getAlgoIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
1324 | await indexer.makeHealthCheck().do()
1325 | ```
1326 |
1327 | #### Defined in
1328 |
1329 | [src/network-client.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L121)
1330 |
1331 | ___
1332 |
1333 | ### getAlgoKmdClient
1334 |
1335 | ▸ **getAlgoKmdClient**(`config?`): `Kmd`
1336 |
1337 | #### Parameters
1338 |
1339 | | Name | Type | Description |
1340 | | :------ | :------ | :------ |
1341 | | `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) |
1342 |
1343 | #### Returns
1344 |
1345 | `Kmd`
1346 |
1347 | **`Deprecated`**
1348 |
1349 | Use `ClientManager.getKmdClient(config)` or `ClientManager.getKmdClientFromEnvironment()` instead.
1350 |
1351 | Returns a KMD SDK client that automatically retries transient failures on idempotent calls.
1352 |
1353 | KMD client allows you to export private keys, which is useful to get the default account in a LocalNet network.
1354 |
1355 | **`Example`**
1356 |
1357 | ```typescript
1358 | // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN
1359 | const kmd = getAlgoKmdClient()
1360 | ```
1361 |
1362 | **`Example`**
1363 |
1364 | ```typescript
1365 | const kmd = getAlgoKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
1366 | ```
1367 |
1368 | #### Defined in
1369 |
1370 | [src/network-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L144)
1371 |
1372 | ___
1373 |
1374 | ### getAlgoNodeConfig
1375 |
1376 | ▸ **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
1377 |
1378 | #### Parameters
1379 |
1380 | | Name | Type | Description |
1381 | | :------ | :------ | :------ |
1382 | | `network` | ``"testnet"`` \| ``"mainnet"`` | Which network to connect to - TestNet or MainNet |
1383 | | `config` | ``"algod"`` \| ``"indexer"`` | Which algod config to return - Algod or Indexer |
1384 |
1385 | #### Returns
1386 |
1387 | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
1388 |
1389 | **`Deprecated`**
1390 |
1391 | Use `ClientManager.getAlgoNodeConfig(network, config)` instead.
1392 |
1393 | Returns the Algorand configuration to point to the AlgoNode service
1394 |
1395 | #### Defined in
1396 |
1397 | [src/network-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L43)
1398 |
1399 | ___
1400 |
1401 | ### getAlgodConfigFromEnvironment
1402 |
1403 | ▸ **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
1404 |
1405 | #### Returns
1406 |
1407 | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
1408 |
1409 | **`Deprecated`**
1410 |
1411 | Use `ClientManager.getAlgodConfigFromEnvironment()` instead.
1412 |
1413 | Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment not algod-side)
1414 |
1415 | #### Defined in
1416 |
1417 | [src/network-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L22)
1418 |
1419 | ___
1420 |
1421 | ### getAppArgsForABICall
1422 |
1423 | ▸ **getAppArgsForABICall**(`args`, `from`): `Promise`\<\{ `appAccounts`: `undefined` \| `string`[] ; `appForeignApps`: `undefined` \| `number`[] = args.apps; `appForeignAssets`: `undefined` \| `number`[] = args.assets; `boxes`: `undefined` \| `BoxReference`[] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`[] \| `TransactionWithSigner`)[] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }\>
1424 |
1425 | #### Parameters
1426 |
1427 | | Name | Type | Description |
1428 | | :------ | :------ | :------ |
1429 | | `args` | [`ABIAppCallArgs`](types_app.md#abiappcallargs) | The ABI app call args |
1430 | | `from` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The transaction signer |
1431 |
1432 | #### Returns
1433 |
1434 | `Promise`\<\{ `appAccounts`: `undefined` \| `string`[] ; `appForeignApps`: `undefined` \| `number`[] = args.apps; `appForeignAssets`: `undefined` \| `number`[] = args.assets; `boxes`: `undefined` \| `BoxReference`[] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`[] \| `TransactionWithSigner`)[] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }\>
1435 |
1436 | The parameters ready to pass into `addMethodCall` within AtomicTransactionComposer
1437 |
1438 | **`Deprecated`**
1439 |
1440 | Use `TransactionComposer` methods to construct transactions instead.
1441 |
1442 | Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer`
1443 |
1444 | #### Defined in
1445 |
1446 | [src/app.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L378)
1447 |
1448 | ___
1449 |
1450 | ### getAppArgsForTransaction
1451 |
1452 | ▸ **getAppArgsForTransaction**(`args?`): `undefined` \| \{ `accounts`: `undefined` \| `string`[] ; `appArgs`: `undefined` \| `Uint8Array`[] ; `boxes`: `undefined` \| `BoxReference`[] ; `foreignApps`: `undefined` \| `number`[] = args.apps; `foreignAssets`: `undefined` \| `number`[] = args.assets; `lease`: `undefined` \| `Uint8Array` }
1453 |
1454 | #### Parameters
1455 |
1456 | | Name | Type | Description |
1457 | | :------ | :------ | :------ |
1458 | | `args?` | [`RawAppCallArgs`](../interfaces/types_app.RawAppCallArgs.md) | The app call args |
1459 |
1460 | #### Returns
1461 |
1462 | `undefined` \| \{ `accounts`: `undefined` \| `string`[] ; `appArgs`: `undefined` \| `Uint8Array`[] ; `boxes`: `undefined` \| `BoxReference`[] ; `foreignApps`: `undefined` \| `number`[] = args.apps; `foreignAssets`: `undefined` \| `number`[] = args.assets; `lease`: `undefined` \| `Uint8Array` }
1463 |
1464 | The args ready to load into a `Transaction`
1465 |
1466 | **`Deprecated`**
1467 |
1468 | Use `TransactionComposer` methods to construct transactions instead.
1469 |
1470 | Returns the app args ready to load onto an app `Transaction` object
1471 |
1472 | #### Defined in
1473 |
1474 | [src/app.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L356)
1475 |
1476 | ___
1477 |
1478 | ### getAppBoxNames
1479 |
1480 | ▸ **getAppBoxNames**(`appId`, `algod`): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\>
1481 |
1482 | #### Parameters
1483 |
1484 | | Name | Type | Description |
1485 | | :------ | :------ | :------ |
1486 | | `appId` | `number` \| `bigint` | The ID of the app return box names for |
1487 | | `algod` | `AlgodClient` | An algod client instance |
1488 |
1489 | #### Returns
1490 |
1491 | `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\>
1492 |
1493 | The current box names
1494 |
1495 | **`Deprecated`**
1496 |
1497 | Use `algorand.app.getBoxNames` instead.
1498 | Returns the names of the boxes for the given app.
1499 |
1500 | #### Defined in
1501 |
1502 | [src/app.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L276)
1503 |
1504 | ___
1505 |
1506 | ### getAppBoxValue
1507 |
1508 | ▸ **getAppBoxValue**(`appId`, `boxName`, `algod`): `Promise`\<`Uint8Array`\>
1509 |
1510 | #### Parameters
1511 |
1512 | | Name | Type | Description |
1513 | | :------ | :------ | :------ |
1514 | | `appId` | `number` \| `bigint` | The ID of the app return box names for |
1515 | | `boxName` | `string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md) | The name of the box to return either as a string, binary array or `BoxName` |
1516 | | `algod` | `AlgodClient` | An algod client instance |
1517 |
1518 | #### Returns
1519 |
1520 | `Promise`\<`Uint8Array`\>
1521 |
1522 | The current box value as a byte array
1523 |
1524 | **`Deprecated`**
1525 |
1526 | Use `algorand.app.getBoxValue` instead.
1527 | Returns the value of the given box name for the given app.
1528 |
1529 | #### Defined in
1530 |
1531 | [src/app.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L288)
1532 |
1533 | ___
1534 |
1535 | ### getAppBoxValueFromABIType
1536 |
1537 | ▸ **getAppBoxValueFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`\>
1538 |
1539 | #### Parameters
1540 |
1541 | | Name | Type | Description |
1542 | | :------ | :------ | :------ |
1543 | | `request` | [`BoxValueRequestParams`](../interfaces/types_app.BoxValueRequestParams.md) | The parameters for the box value request |
1544 | | `algod` | `AlgodClient` | An algod client instance |
1545 |
1546 | #### Returns
1547 |
1548 | `Promise`\<`ABIValue`\>
1549 |
1550 | The current box value as an ABI value
1551 |
1552 | **`Deprecated`**
1553 |
1554 | Use `algorand.app.getBoxValueFromABIType` instead.
1555 | Returns the value of the given box name for the given app decoded based on the given ABI type.
1556 |
1557 | #### Defined in
1558 |
1559 | [src/app.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L314)
1560 |
1561 | ___
1562 |
1563 | ### getAppBoxValues
1564 |
1565 | ▸ **getAppBoxValues**(`appId`, `boxNames`, `algod`): `Promise`\<`Uint8Array`[]\>
1566 |
1567 | #### Parameters
1568 |
1569 | | Name | Type | Description |
1570 | | :------ | :------ | :------ |
1571 | | `appId` | `number` | The ID of the app return box names for |
1572 | | `boxNames` | (`string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md))[] | The names of the boxes to return either as a string, binary array or `BoxName` |
1573 | | `algod` | `AlgodClient` | An algod client instance |
1574 |
1575 | #### Returns
1576 |
1577 | `Promise`\<`Uint8Array`[]\>
1578 |
1579 | The current box values as a byte array in the same order as the passed in box names
1580 |
1581 | **`Deprecated`**
1582 |
1583 | Use `algorand.app.getBoxValues` instead.
1584 | Returns the value of the given box names for the given app.
1585 |
1586 | #### Defined in
1587 |
1588 | [src/app.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L300)
1589 |
1590 | ___
1591 |
1592 | ### getAppBoxValuesFromABIType
1593 |
1594 | ▸ **getAppBoxValuesFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`[]\>
1595 |
1596 | #### Parameters
1597 |
1598 | | Name | Type | Description |
1599 | | :------ | :------ | :------ |
1600 | | `request` | [`BoxValuesRequestParams`](../interfaces/types_app.BoxValuesRequestParams.md) | The parameters for the box value request |
1601 | | `algod` | `AlgodClient` | An algod client instance |
1602 |
1603 | #### Returns
1604 |
1605 | `Promise`\<`ABIValue`[]\>
1606 |
1607 | The current box values as an ABI value in the same order as the passed in box names
1608 |
1609 | **`Deprecated`**
1610 |
1611 | Use `algorand.app.getBoxValuesFromABIType` instead.
1612 | Returns the value of the given box names for the given app decoded based on the given ABI type.
1613 |
1614 | #### Defined in
1615 |
1616 | [src/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L329)
1617 |
1618 | ___
1619 |
1620 | ### getAppById
1621 |
1622 | ▸ **getAppById**(`appId`, `algod`): `Promise`\<`Application`\>
1623 |
1624 | #### Parameters
1625 |
1626 | | Name | Type | Description |
1627 | | :------ | :------ | :------ |
1628 | | `appId` | `number` \| `bigint` | The id of the app |
1629 | | `algod` | `AlgodClient` | An algod client |
1630 |
1631 | #### Returns
1632 |
1633 | `Promise`\<`Application`\>
1634 |
1635 | The data about the app
1636 |
1637 | **`Deprecated`**
1638 |
1639 | Use `algorand.app.getById` instead.
1640 |
1641 | Gets the current data for the given app from algod.
1642 |
1643 | #### Defined in
1644 |
1645 | [src/app.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L406)
1646 |
1647 | ___
1648 |
1649 | ### getAppClient
1650 |
1651 | ▸ **getAppClient**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1652 |
1653 | #### Parameters
1654 |
1655 | | Name | Type | Description |
1656 | | :------ | :------ | :------ |
1657 | | `appDetails` | [`AppSpecAppDetails`](types_app_client.md#appspecappdetails) | The details of the app |
1658 | | `algod` | `AlgodClient` | An algod instance |
1659 |
1660 | #### Returns
1661 |
1662 | [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1663 |
1664 | The application client
1665 |
1666 | **`Deprecated`**
1667 |
1668 | Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or
1669 | `algorand.client.getAppClientByCreatorAndName`.
1670 | If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
1671 | which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
1672 |
1673 | Create a new ApplicationClient instance
1674 |
1675 | **`Example`**
1676 |
1677 | ```ts
1678 | Resolve by creator and name
1679 | const client = algokit.getAppClient(
1680 | {
1681 | resolveBy: 'creatorAndName',
1682 | app: {appSpec},
1683 | sender: {account},
1684 | creatorAddress: {creator},
1685 | findExistingUsing: indexerClient,
1686 | },
1687 | algodClient,
1688 | )
1689 | ```
1690 |
1691 | **`Example`**
1692 |
1693 | ```ts
1694 | Resolve by id:
1695 | const client = algokit.getAppClient(
1696 | {
1697 | resolveBy: 'id',
1698 | app: {appSpec},
1699 | sender: {account},
1700 | id: {id},
1701 | },
1702 | algodClient,
1703 | )
1704 | ```
1705 |
1706 | #### Defined in
1707 |
1708 | [src/app-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L40)
1709 |
1710 | ___
1711 |
1712 | ### getAppClientByCreatorAndName
1713 |
1714 | ▸ **getAppClientByCreatorAndName**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1715 |
1716 | #### Parameters
1717 |
1718 | | Name | Type | Description |
1719 | | :------ | :------ | :------ |
1720 | | `appDetails` | [`AppSpecAppDetailsByCreatorAndName`](types_app_client.md#appspecappdetailsbycreatorandname) | The details of the app by creator and name |
1721 | | `algod` | `AlgodClient` | An algod instance |
1722 |
1723 | #### Returns
1724 |
1725 | [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1726 |
1727 | The application client
1728 |
1729 | **`Deprecated`**
1730 |
1731 | Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.
1732 | If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
1733 | which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
1734 |
1735 | Create a new ApplicationClient instance by creator and name
1736 |
1737 | **`Example`**
1738 |
1739 | ```ts
1740 | const client = algokit.getAppClientByCreatorAndName(
1741 | {
1742 | app: appSpec,
1743 | sender: account,
1744 | creatorAddress: account,
1745 | findExistingUsing: indexerClient,
1746 | },
1747 | algodClient,
1748 | )
1749 | ```
1750 |
1751 | #### Defined in
1752 |
1753 | [src/app-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L93)
1754 |
1755 | ___
1756 |
1757 | ### getAppClientById
1758 |
1759 | ▸ **getAppClientById**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1760 |
1761 | #### Parameters
1762 |
1763 | | Name | Type | Description |
1764 | | :------ | :------ | :------ |
1765 | | `appDetails` | [`AppSpecAppDetailsById`](types_app_client.md#appspecappdetailsbyid) | The details of the app |
1766 | | `algod` | `AlgodClient` | An algod instance |
1767 |
1768 | #### Returns
1769 |
1770 | [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md)
1771 |
1772 | The application client
1773 |
1774 | **`Deprecated`**
1775 |
1776 | Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.
1777 | If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
1778 | which will in turn give you an `AppClient` instance against the created/deployed app to make other calls.
1779 |
1780 | Create a new ApplicationClient instance by id
1781 |
1782 | **`Example`**
1783 |
1784 | ```ts
1785 | const client = algokit.getAppClientById(
1786 | {
1787 | app: {appSpec},
1788 | sender: {account},
1789 | id: {id},
1790 | },
1791 | algodClient,
1792 | )
1793 | ```
1794 |
1795 | #### Defined in
1796 |
1797 | [src/app-client.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L66)
1798 |
1799 | ___
1800 |
1801 | ### getAppDeploymentTransactionNote
1802 |
1803 | ▸ **getAppDeploymentTransactionNote**(`metadata`): [`Arc2TransactionNote`](types_transaction.md#arc2transactionnote)
1804 |
1805 | #### Parameters
1806 |
1807 | | Name | Type | Description |
1808 | | :------ | :------ | :------ |
1809 | | `metadata` | [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) | The metadata of the deployment |
1810 |
1811 | #### Returns
1812 |
1813 | [`Arc2TransactionNote`](types_transaction.md#arc2transactionnote)
1814 |
1815 | The transaction note as a utf-8 string
1816 |
1817 | **`Deprecated`**
1818 |
1819 | Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.
1820 |
1821 | Return the transaction note for an app deployment.
1822 |
1823 | #### Defined in
1824 |
1825 | [src/app-deploy.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L271)
1826 |
1827 | ___
1828 |
1829 | ### getAppGlobalState
1830 |
1831 | ▸ **getAppGlobalState**(`appId`, `algod`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
1832 |
1833 | #### Parameters
1834 |
1835 | | Name | Type | Description |
1836 | | :------ | :------ | :------ |
1837 | | `appId` | `number` \| `bigint` | The ID of the app return global state for |
1838 | | `algod` | `AlgodClient` | An algod client instance |
1839 |
1840 | #### Returns
1841 |
1842 | `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
1843 |
1844 | The current global state
1845 |
1846 | **`Deprecated`**
1847 |
1848 | Use `algorand.app.getGlobalState` instead.
1849 |
1850 | Returns the current global state values for the given app ID
1851 |
1852 | #### Defined in
1853 |
1854 | [src/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L252)
1855 |
1856 | ___
1857 |
1858 | ### getAppLocalState
1859 |
1860 | ▸ **getAppLocalState**(`appId`, `account`, `algod`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
1861 |
1862 | #### Parameters
1863 |
1864 | | Name | Type | Description |
1865 | | :------ | :------ | :------ |
1866 | | `appId` | `number` \| `bigint` | The ID of the app return global state for |
1867 | | `account` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | Either the string address of an account or an account object for the account to get local state for the given app |
1868 | | `algod` | `AlgodClient` | An algod client instance |
1869 |
1870 | #### Returns
1871 |
1872 | `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\>
1873 |
1874 | The current local state for the given (app, account) combination
1875 |
1876 | **`Deprecated`**
1877 |
1878 | Use `algorand.app.getLocalState` instead.
1879 |
1880 | Returns the current global state values for the given app ID and account
1881 |
1882 | #### Defined in
1883 |
1884 | [src/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L265)
1885 |
1886 | ___
1887 |
1888 | ### getAppOnCompleteAction
1889 |
1890 | ▸ **getAppOnCompleteAction**(`onCompletionAction?`): `OnApplicationComplete`
1891 |
1892 | #### Parameters
1893 |
1894 | | Name | Type | Description |
1895 | | :------ | :------ | :------ |
1896 | | `onCompletionAction?` | [`AppCallType`](types_app.md#appcalltype) \| `OnApplicationComplete` | The on completion action |
1897 |
1898 | #### Returns
1899 |
1900 | `OnApplicationComplete`
1901 |
1902 | The `algosdk.OnApplicationComplete`
1903 |
1904 | **`Deprecated`**
1905 |
1906 | Use `algosdk.OnApplicationComplete` directly instead.
1907 |
1908 | Returns a `algosdk.OnApplicationComplete` for the given onCompleteAction.
1909 |
1910 | If given `undefined` will return `OnApplicationComplete.NoOpOC`.
1911 |
1912 | If given an `AppCallType` will convert the string enum to the correct underlying `algosdk.OnApplicationComplete`.
1913 |
1914 | #### Defined in
1915 |
1916 | [src/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L154)
1917 |
1918 | ___
1919 |
1920 | ### getAtomicTransactionComposerTransactions
1921 |
1922 | ▸ **getAtomicTransactionComposerTransactions**(`atc`): `TransactionWithSigner`[]
1923 |
1924 | #### Parameters
1925 |
1926 | | Name | Type | Description |
1927 | | :------ | :------ | :------ |
1928 | | `atc` | `AtomicTransactionComposer` | The atomic transaction composer |
1929 |
1930 | #### Returns
1931 |
1932 | `TransactionWithSigner`[]
1933 |
1934 | The array of transactions with signers
1935 |
1936 | **`Deprecated`**
1937 |
1938 | Use `atc.clone().buildGroup()` instead.
1939 |
1940 | Returns the array of transactions currently present in the given `AtomicTransactionComposer`
1941 |
1942 | #### Defined in
1943 |
1944 | [src/transaction/transaction.ts:950](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L950)
1945 |
1946 | ___
1947 |
1948 | ### getBoxReference
1949 |
1950 | ▸ **getBoxReference**(`box`): `algosdk.BoxReference`
1951 |
1952 | #### Parameters
1953 |
1954 | | Name | Type | Description |
1955 | | :------ | :------ | :------ |
1956 | | `box` | [`BoxReference`](../interfaces/types_app.BoxReference.md) \| [`BoxIdentifier`](types_app.md#boxidentifier) \| `BoxReference` | The box to return a reference for |
1957 |
1958 | #### Returns
1959 |
1960 | `algosdk.BoxReference`
1961 |
1962 | The box reference ready to pass into a `Transaction`
1963 |
1964 | **`Deprecated`**
1965 |
1966 | Use `AppManager.getBoxReference()` instead.
1967 |
1968 | Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.
1969 |
1970 | #### Defined in
1971 |
1972 | [src/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L389)
1973 |
1974 | ___
1975 |
1976 | ### getConfigFromEnvOrDefaults
1977 |
1978 | ▸ **getConfigFromEnvOrDefaults**(): [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md)
1979 |
1980 | #### Returns
1981 |
1982 | [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md)
1983 |
1984 | **`Deprecated`**
1985 |
1986 | Use `ClientManager.getConfigFromEnvironmentOrLocalNet()` instead.
1987 |
1988 | Retrieve configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment not algod-side)
1989 |
1990 | #### Defined in
1991 |
1992 | [src/network-client.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L13)
1993 |
1994 | ___
1995 |
1996 | ### getCreatorAppsByName
1997 |
1998 | ▸ **getCreatorAppsByName**(`creatorAccount`, `indexer`): `Promise`\<[`AppLookup`](../interfaces/types_app.AppLookup.md)\>
1999 |
2000 | #### Parameters
2001 |
2002 | | Name | Type | Description |
2003 | | :------ | :------ | :------ |
2004 | | `creatorAccount` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The account (with private key loaded) or string address of an account that is the creator of the apps you want to search for |
2005 | | `indexer` | `IndexerClient` | An indexer client |
2006 |
2007 | #### Returns
2008 |
2009 | `Promise`\<[`AppLookup`](../interfaces/types_app.AppLookup.md)\>
2010 |
2011 | A name-based lookup of the app information (id, address)
2012 |
2013 | **`Deprecated`**
2014 |
2015 | Use `algorand.appDeployer.getCreatorAppsByName` instead.
2016 |
2017 | Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction.
2018 |
2019 | **Note:** It's recommended this is only called once and then stored since it's a somewhat expensive operation (multiple indexer calls).
2020 |
2021 | #### Defined in
2022 |
2023 | [src/app-deploy.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L244)
2024 |
2025 | ___
2026 |
2027 | ### getDefaultLocalNetConfig
2028 |
2029 | ▸ **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
2030 |
2031 | #### Parameters
2032 |
2033 | | Name | Type | Description |
2034 | | :------ | :------ | :------ |
2035 | | `configOrPort` | `number` \| ``"algod"`` \| ``"indexer"`` \| ``"kmd"`` | Which algod config to return - algod, kmd, or indexer OR a port number |
2036 |
2037 | #### Returns
2038 |
2039 | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
2040 |
2041 | **`Deprecated`**
2042 |
2043 | Use `ClientManager.getDefaultLocalNetConfig(configOrPort)` instead.
2044 |
2045 | Returns the Algorand configuration to point to the default LocalNet
2046 |
2047 | #### Defined in
2048 |
2049 | [src/network-client.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L54)
2050 |
2051 | ___
2052 |
2053 | ### getDispenserAccount
2054 |
2055 | ▸ **getDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](../classes/types_account.SigningAccount.md) }\>
2056 |
2057 | #### Parameters
2058 |
2059 | | Name | Type | Description |
2060 | | :------ | :------ | :------ |
2061 | | `algod` | `AlgodClient` | An algod client |
2062 | | `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |
2063 |
2064 | #### Returns
2065 |
2066 | `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](../classes/types_account.SigningAccount.md) }\>
2067 |
2068 | **`Deprecated`**
2069 |
2070 | Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
2071 |
2072 | Returns an account (with private key loaded) that can act as a dispenser
2073 |
2074 | If running on LocalNet then it will return the default dispenser account automatically,
2075 | otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC
2076 |
2077 | #### Defined in
2078 |
2079 | [src/account/get-dispenser-account.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-dispenser-account.ts#L19)
2080 |
2081 | ___
2082 |
2083 | ### getIndexerConfigFromEnvironment
2084 |
2085 | ▸ **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
2086 |
2087 | #### Returns
2088 |
2089 | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md)
2090 |
2091 | **`Deprecated`**
2092 |
2093 | Use `ClientManager.getIndexerConfigFromEnvironment()` instead.
2094 |
2095 | Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment not algod-side)
2096 |
2097 | #### Defined in
2098 |
2099 | [src/network-client.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L31)
2100 |
2101 | ___
2102 |
2103 | ### getKmdWalletAccount
2104 |
2105 | ▸ **getKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`Account` \| `undefined`\>
2106 |
2107 | #### Parameters
2108 |
2109 | | Name | Type | Description |
2110 | | :------ | :------ | :------ |
2111 | | `walletAccount` | `Object` | The details of the wallet, with: * `name`: The name of the wallet to retrieve an account from * `predicate`: An optional filter to use to find the account (otherwise it will return a random account from the wallet) |
2112 | | `walletAccount.name` | `string` | - |
2113 | | `walletAccount.predicate?` | (`account`: `Record`\<`string`, `any`\>) => `boolean` | - |
2114 | | `algod` | `AlgodClient` | An algod client |
2115 | | `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |
2116 |
2117 | #### Returns
2118 |
2119 | `Promise`\<`Account` \| `undefined`\>
2120 |
2121 | **`Deprecated`**
2122 |
2123 | use `algorand.account.kmd.getWalletAccount(name, predicate)` or `new KMDAccountManager(clientManager).getWalletAccount(name, predicate)` instead.
2124 |
2125 | Returns an Algorand account with private key loaded from the given KMD wallet (identified by name).
2126 |
2127 | **`Example`**
2128 |
2129 | ```typescript
2130 | const defaultDispenserAccount = await getKmdWalletAccount(algod,
2131 | 'unencrypted-default-wallet',
2132 | a => a.status !== 'Offline' && a.amount > 1_000_000_000
2133 | )
2134 | ```
2135 |
2136 | #### Defined in
2137 |
2138 | [src/localnet/get-kmd-wallet-account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-kmd-wallet-account.ts#L27)
2139 |
2140 | ___
2141 |
2142 | ### getLocalNetDispenserAccount
2143 |
2144 | ▸ **getLocalNetDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Account`\>
2145 |
2146 | #### Parameters
2147 |
2148 | | Name | Type | Description |
2149 | | :------ | :------ | :------ |
2150 | | `algod` | `AlgodClient` | An algod client |
2151 | | `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |
2152 |
2153 | #### Returns
2154 |
2155 | `Promise`\<`Account`\>
2156 |
2157 | **`Deprecated`**
2158 |
2159 | Use `algorand.account.kmd.getLocalNetDispenserAccount()` instead.
2160 |
2161 | Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts)
2162 |
2163 | #### Defined in
2164 |
2165 | [src/localnet/get-localnet-dispenser-account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-localnet-dispenser-account.ts#L15)
2166 |
2167 | ___
2168 |
2169 | ### getOrCreateKmdWalletAccount
2170 |
2171 | ▸ **getOrCreateKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`Account`\>
2172 |
2173 | #### Parameters
2174 |
2175 | | Name | Type | Description |
2176 | | :------ | :------ | :------ |
2177 | | `walletAccount` | `Object` | The wallet details with: * `name`: The name of the wallet to retrieve / create * `fundWith`: The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account |
2178 | | `walletAccount.fundWith?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - |
2179 | | `walletAccount.name` | `string` | - |
2180 | | `algod` | `AlgodClient` | An algod client |
2181 | | `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables |
2182 |
2183 | #### Returns
2184 |
2185 | `Promise`\<`Account`\>
2186 |
2187 | An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you
2188 |
2189 | **`Deprecated`**
2190 |
2191 | use `algorand.account.kmd.getOrCreateWalletAccount(name, fundWith)` or `new KMDAccountManager(clientManager).getOrCreateWalletAccount(name, fundWith)` instead.
2192 |
2193 | Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name.
2194 |
2195 | This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).
2196 |
2197 | This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet.
2198 |
2199 | If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!
2200 |
2201 | #### Defined in
2202 |
2203 | [src/localnet/get-or-create-kmd-wallet-account.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-or-create-kmd-wallet-account.ts#L28)
2204 |
2205 | ___
2206 |
2207 | ### getSenderAddress
2208 |
2209 | ▸ **getSenderAddress**(`sender`): `string`
2210 |
2211 | #### Parameters
2212 |
2213 | | Name | Type | Description |
2214 | | :------ | :------ | :------ |
2215 | | `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | A transaction sender |
2216 |
2217 | #### Returns
2218 |
2219 | `string`
2220 |
2221 | The public address
2222 |
2223 | **`Deprecated`**
2224 |
2225 | Use `algorand.client` to interact with accounts, and use `.addr` to get the address
2226 | and/or move from using `SendTransactionFrom` to `TransactionSignerAccount` and use `.addr` instead.
2227 |
2228 | Returns the public address of the given transaction sender.
2229 |
2230 | #### Defined in
2231 |
2232 | [src/transaction/transaction.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L108)
2233 |
2234 | ___
2235 |
2236 | ### getSenderTransactionSigner
2237 |
2238 | ▸ **getSenderTransactionSigner**(`val`): `TransactionSigner`
2239 |
2240 | #### Parameters
2241 |
2242 | | Name | Type |
2243 | | :------ | :------ |
2244 | | `val` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) |
2245 |
2246 | #### Returns
2247 |
2248 | `TransactionSigner`
2249 |
2250 | A transaction signer
2251 |
2252 | **`Deprecated`**
2253 |
2254 | Use `TransactionSignerAccount` instead of `SendTransactionFrom` or use
2255 | `algosdk.makeBasicAccountTransactionSigner` / `algosdk.makeLogicSigAccountTransactionSigner`.
2256 |
2257 | Returns a `TransactionSigner` for the given transaction sender.
2258 | This function has memoization, so will return the same transaction signer for a given sender.
2259 |
2260 | #### Defined in
2261 |
2262 | [src/transaction/transaction.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L166)
2263 |
2264 | ___
2265 |
2266 | ### getTestNetDispenserApiClient
2267 |
2268 | ▸ **getTestNetDispenserApiClient**(`params?`): [`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md)
2269 |
2270 | #### Parameters
2271 |
2272 | | Name | Type | Default value | Description |
2273 | | :------ | :------ | :------ | :------ |
2274 | | `params` | ``null`` \| [`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) | `null` | An object containing parameters for the TestNetDispenserApiClient class. Or null if you want the client to load the access token from the environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN`. |
2275 |
2276 | #### Returns
2277 |
2278 | [`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md)
2279 |
2280 | An instance of the TestNetDispenserApiClient class.
2281 |
2282 | **`Deprecated`**
2283 |
2284 | Use `clientManager.getTestNetDispenser` or `clientManager.getTestNetDispenserFromEnvironment` instead
2285 |
2286 | Create a new TestNetDispenserApiClient instance.
2287 | Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.
2288 |
2289 | **`Example`**
2290 |
2291 | ```ts
2292 | const client = algokit.getTestNetDispenserApiClient(
2293 | {
2294 | authToken: 'your_auth_token',
2295 | requestTimeout: 15,
2296 | }
2297 | )
2298 | ```
2299 |
2300 | #### Defined in
2301 |
2302 | [src/dispenser-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/dispenser-client.ts#L21)
2303 |
2304 | ___
2305 |
2306 | ### getTransactionParams
2307 |
2308 | ▸ **getTransactionParams**(`params`, `algod`): `Promise`\<`SuggestedParams`\>
2309 |
2310 | #### Parameters
2311 |
2312 | | Name | Type | Description |
2313 | | :------ | :------ | :------ |
2314 | | `params` | `undefined` \| `SuggestedParams` | Optionally provide parameters to use |
2315 | | `algod` | `AlgodClient` | Algod algod |
2316 |
2317 | #### Returns
2318 |
2319 | `Promise`\<`SuggestedParams`\>
2320 |
2321 | The suggested transaction parameters
2322 |
2323 | **`Deprecated`**
2324 |
2325 | Use `suggestedParams ? { ...suggestedParams } : await algod.getTransactionParams().do()` instead
2326 |
2327 | Returns suggested transaction parameters from algod unless some are already provided.
2328 |
2329 | #### Defined in
2330 |
2331 | [src/transaction/transaction.ts:928](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L928)
2332 |
2333 | ___
2334 |
2335 | ### getTransactionWithSigner
2336 |
2337 | ▸ **getTransactionWithSigner**(`transaction`, `defaultSender?`): `Promise`\<`TransactionWithSigner`\>
2338 |
2339 | #### Parameters
2340 |
2341 | | Name | Type | Description |
2342 | | :------ | :------ | :------ |
2343 | | `transaction` | `Transaction` \| [`TransactionToSign`](../interfaces/types_transaction.TransactionToSign.md) \| `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> \| `TransactionWithSigner` | One of: A TransactionWithSigner object (returned as is), a TransactionToSign object (signer is obtained from the signer property), a Transaction object (signer is extracted from the defaultSender parameter), an async SendTransactionResult returned by one of algokit utils' helpers (signer is obtained from the defaultSender parameter) |
2344 | | `defaultSender?` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The default sender to be used to obtain a signer where the object provided to the transaction parameter does not include a signer. |
2345 |
2346 | #### Returns
2347 |
2348 | `Promise`\<`TransactionWithSigner`\>
2349 |
2350 | A TransactionWithSigner object.
2351 |
2352 | **`Deprecated`**
2353 |
2354 | Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or
2355 | construct an `algosdk.TransactionWithSigner` manually instead.
2356 |
2357 | Given a transaction in a variety of supported formats, returns a TransactionWithSigner object ready to be passed to an
2358 | AtomicTransactionComposer's addTransaction method.
2359 |
2360 | #### Defined in
2361 |
2362 | [src/transaction/transaction.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L125)
2363 |
2364 | ___
2365 |
2366 | ### isLocalNet
2367 |
2368 | ▸ **isLocalNet**(`algod`): `Promise`\<`boolean`\>
2369 |
2370 | #### Parameters
2371 |
2372 | | Name | Type |
2373 | | :------ | :------ |
2374 | | `algod` | `AlgodClient` |
2375 |
2376 | #### Returns
2377 |
2378 | `Promise`\<`boolean`\>
2379 |
2380 | **`Deprecated`**
2381 |
2382 | Use `await algorand.client.isLocalNet()` or `await new ClientManager({ algod }).isLocalNet()` instead.
2383 |
2384 | Returns true if the algod client is pointing to a LocalNet Algorand network
2385 |
2386 | #### Defined in
2387 |
2388 | [src/localnet/is-localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/is-localnet.ts#L9)
2389 |
2390 | ___
2391 |
2392 | ### isMainNet
2393 |
2394 | ▸ **isMainNet**(`algod`): `Promise`\<`boolean`\>
2395 |
2396 | #### Parameters
2397 |
2398 | | Name | Type |
2399 | | :------ | :------ |
2400 | | `algod` | `AlgodClient` |
2401 |
2402 | #### Returns
2403 |
2404 | `Promise`\<`boolean`\>
2405 |
2406 | **`Deprecated`**
2407 |
2408 | Use `await algorand.client.isMainNet()` or `await new ClientManager({ algod }).isMainNet()` instead.
2409 |
2410 | #### Defined in
2411 |
2412 | [src/network-client.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L154)
2413 |
2414 | ___
2415 |
2416 | ### isSchemaIsBroken
2417 |
2418 | ▸ **isSchemaIsBroken**(`before`, `after`): `boolean`
2419 |
2420 | #### Parameters
2421 |
2422 | | Name | Type | Description |
2423 | | :------ | :------ | :------ |
2424 | | `before` | `ApplicationStateSchema` | The existing schema |
2425 | | `after` | `ApplicationStateSchema` | The new schema |
2426 |
2427 | #### Returns
2428 |
2429 | `boolean`
2430 |
2431 | Whether or not there is a breaking change
2432 |
2433 | **`Deprecated`**
2434 |
2435 | Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead.
2436 |
2437 | Returns true is there is a breaking change in the application state schema from before to after.
2438 | i.e. if the schema becomes larger, since applications can't ask for more schema after creation.
2439 | Otherwise, there is no error, the app just doesn't store data in the extra schema :(
2440 |
2441 | #### Defined in
2442 |
2443 | [src/app-deploy.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L229)
2444 |
2445 | ___
2446 |
2447 | ### isTestNet
2448 |
2449 | ▸ **isTestNet**(`algod`): `Promise`\<`boolean`\>
2450 |
2451 | #### Parameters
2452 |
2453 | | Name | Type |
2454 | | :------ | :------ |
2455 | | `algod` | `AlgodClient` |
2456 |
2457 | #### Returns
2458 |
2459 | `Promise`\<`boolean`\>
2460 |
2461 | **`Deprecated`**
2462 |
2463 | Use `await algorand.client.isTestNet()` or `await new ClientManager({ algod }).isTestNet()` instead.
2464 |
2465 | #### Defined in
2466 |
2467 | [src/network-client.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L149)
2468 |
2469 | ___
2470 |
2471 | ### microAlgo
2472 |
2473 | ▸ **microAlgo**(`microAlgos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
2474 |
2475 | Returns an amount of µAlgo using AlgoAmount
2476 |
2477 | #### Parameters
2478 |
2479 | | Name | Type | Description |
2480 | | :------ | :------ | :------ |
2481 | | `microAlgos` | `number` \| `bigint` | The amount of µAlgo |
2482 |
2483 | #### Returns
2484 |
2485 | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
2486 |
2487 | #### Defined in
2488 |
2489 | [src/amount.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L82)
2490 |
2491 | ___
2492 |
2493 | ### microAlgos
2494 |
2495 | ▸ **microAlgos**(`microAlgos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
2496 |
2497 | Returns an amount of µAlgo using AlgoAmount
2498 |
2499 | #### Parameters
2500 |
2501 | | Name | Type | Description |
2502 | | :------ | :------ | :------ |
2503 | | `microAlgos` | `number` \| `bigint` | The amount of µAlgo |
2504 |
2505 | #### Returns
2506 |
2507 | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
2508 |
2509 | #### Defined in
2510 |
2511 | [src/amount.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L75)
2512 |
2513 | ___
2514 |
2515 | ### mnemonicAccount
2516 |
2517 | ▸ **mnemonicAccount**(`mnemonicSecret`): `Account`
2518 |
2519 | #### Parameters
2520 |
2521 | | Name | Type | Description |
2522 | | :------ | :------ | :------ |
2523 | | `mnemonicSecret` | `string` | The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. |
2524 |
2525 | #### Returns
2526 |
2527 | `Account`
2528 |
2529 | **`Deprecated`**
2530 |
2531 | Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
2532 |
2533 | Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
2534 |
2535 | This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name.
2536 |
2537 | #### Defined in
2538 |
2539 | [src/account/mnemonic-account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/mnemonic-account.ts#L14)
2540 |
2541 | ___
2542 |
2543 | ### mnemonicAccountFromEnvironment
2544 |
2545 | ▸ **mnemonicAccountFromEnvironment**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
2546 |
2547 | #### Parameters
2548 |
2549 | | Name | Type | Description |
2550 | | :------ | :------ | :------ |
2551 | | `account` | `string` \| \{ `fundWith?`: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: * `name`: string: The name identifier of the account * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account |
2552 | | `algod` | `AlgodClient` | An algod client |
2553 | | `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables |
2554 |
2555 | #### Returns
2556 |
2557 | `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\>
2558 |
2559 | The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
2560 |
2561 | **`Deprecated`**
2562 |
2563 | Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
2564 |
2565 | Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
2566 |
2567 | Note: This function expects to run in a Node.js environment.
2568 |
2569 | ## Convention:
2570 | * **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
2571 | never commit it into source control and ideally load it via a secret storage service rather than the file system.
2572 | If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
2573 | * **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you
2574 |
2575 | This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet).
2576 |
2577 | **`Example`**
2578 |
2579 | If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:
2580 | ```typescript
2581 | const account = await mnemonicAccountFromEnvironment('MY_ACCOUNT', algod)
2582 | ```
2583 |
2584 | If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser.
2585 | If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC as the private key and (if present) process.env.MY_ACCOUNT_SENDER as the sender address.
2586 |
2587 | #### Defined in
2588 |
2589 | [src/account/account.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L97)
2590 |
2591 | ___
2592 |
2593 | ### multisigAccount
2594 |
2595 | ▸ **multisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](../classes/types_account.MultisigAccount.md)
2596 |
2597 | #### Parameters
2598 |
2599 | | Name | Type | Description |
2600 | | :------ | :------ | :------ |
2601 | | `multisigParams` | `MultisigMetadata` | The parameters that define the multisig account |
2602 | | `signingAccounts` | (`default` \| [`SigningAccount`](../classes/types_account.SigningAccount.md))[] | The signers that are currently present |
2603 |
2604 | #### Returns
2605 |
2606 | [`MultisigAccount`](../classes/types_account.MultisigAccount.md)
2607 |
2608 | A multisig account wrapper
2609 |
2610 | **`Deprecated`**
2611 |
2612 | Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
2613 |
2614 | Returns an account wrapper that supports partial or full multisig signing.
2615 |
2616 | #### Defined in
2617 |
2618 | [src/account/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L24)
2619 |
2620 | ___
2621 |
2622 | ### performAtomicTransactionComposerSimulate
2623 |
2624 | ▸ **performAtomicTransactionComposerSimulate**(`atc`, `algod`, `options?`): `Promise`\<`SimulateResponse`\>
2625 |
2626 | Performs a simulation of the transactions loaded into the given AtomicTransactionComposer.
2627 | Uses empty transaction signers for all transactions.
2628 |
2629 | #### Parameters
2630 |
2631 | | Name | Type | Description |
2632 | | :------ | :------ | :------ |
2633 | | `atc` | `AtomicTransactionComposer` | The AtomicTransactionComposer with transaction(s) loaded. |
2634 | | `algod` | `AlgodClient` | An Algod client to perform the simulation. |
2635 | | `options?` | `Omit`\<\{ `allowEmptySignatures?`: `boolean` ; `allowMoreLogging?`: `boolean` ; `allowUnnamedResources?`: `boolean` ; `execTraceConfig?`: `SimulateTraceConfig` ; `extraOpcodeBudget?`: `number` \| `bigint` ; `fixSigners?`: `boolean` ; `round?`: `number` \| `bigint` ; `txnGroups`: `SimulateRequestTransactionGroup`[] }, ``"txnGroups"``\> | - |
2636 |
2637 | #### Returns
2638 |
2639 | `Promise`\<`SimulateResponse`\>
2640 |
2641 | The simulation result, which includes various details about how the transactions would be processed.
2642 |
2643 | #### Defined in
2644 |
2645 | [src/transaction/perform-atomic-transaction-composer-simulate.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/perform-atomic-transaction-composer-simulate.ts#L14)
2646 |
2647 | ___
2648 |
2649 | ### performTemplateSubstitution
2650 |
2651 | ▸ **performTemplateSubstitution**(`tealCode`, `templateParams?`): `string`
2652 |
2653 | #### Parameters
2654 |
2655 | | Name | Type | Description |
2656 | | :------ | :------ | :------ |
2657 | | `tealCode` | `string` | The TEAL logic to compile |
2658 | | `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling |
2659 |
2660 | #### Returns
2661 |
2662 | `string`
2663 |
2664 | The TEAL code with replacements
2665 |
2666 | **`Deprecated`**
2667 |
2668 | Use `AppManager.replaceTealTemplateParams` instead
2669 |
2670 | Performs template substitution of a teal file.
2671 |
2672 | Looks for `TMPL_{parameter}` for template replacements.
2673 |
2674 | #### Defined in
2675 |
2676 | [src/app-deploy.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L309)
2677 |
2678 | ___
2679 |
2680 | ### performTemplateSubstitutionAndCompile
2681 |
2682 | ▸ **performTemplateSubstitutionAndCompile**(`tealCode`, `algod`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
2683 |
2684 | #### Parameters
2685 |
2686 | | Name | Type | Description |
2687 | | :------ | :------ | :------ |
2688 | | `tealCode` | `string` | The TEAL logic to compile |
2689 | | `algod` | `AlgodClient` | An algod client |
2690 | | `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling |
2691 | | `deploymentMetadata?` | [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) | The deployment metadata the app will be deployed with |
2692 |
2693 | #### Returns
2694 |
2695 | `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\>
2696 |
2697 | The information about the compiled code
2698 |
2699 | **`Deprecated`**
2700 |
2701 | Use `algorand.appManager.compileTealTemplate` instead.
2702 |
2703 | Performs template substitution of a teal file and compiles it, returning the compiled result.
2704 |
2705 | Looks for `TMPL_{parameter}` for template replacements.
2706 |
2707 | #### Defined in
2708 |
2709 | [src/app-deploy.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L326)
2710 |
2711 | ___
2712 |
2713 | ### persistSourceMaps
2714 |
2715 | ▸ **persistSourceMaps**(`_params`): `Promise`\<`void`\>
2716 |
2717 | #### Parameters
2718 |
2719 | | Name | Type |
2720 | | :------ | :------ |
2721 | | `_params` | `unknown` |
2722 |
2723 | #### Returns
2724 |
2725 | `Promise`\<`void`\>
2726 |
2727 | A promise that resolves when the source maps have been persisted.
2728 |
2729 | **`Deprecated`**
2730 |
2731 | Use latest version of `AlgoKit AVM Debugger` VSCode extension instead. It will automatically manage your sourcemaps.
2732 |
2733 | This function persists the source maps for the given sources.
2734 |
2735 | #### Defined in
2736 |
2737 | [src/debugging/debugging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/debugging/debugging.ts#L8)
2738 |
2739 | ___
2740 |
2741 | ### populateAppCallResources
2742 |
2743 | ▸ **populateAppCallResources**(`atc`, `algod`): `Promise`\<`AtomicTransactionComposer`\>
2744 |
2745 | Take an existing Atomic Transaction Composer and return a new one with the required
2746 | app call resources packed into it
2747 |
2748 | #### Parameters
2749 |
2750 | | Name | Type | Description |
2751 | | :------ | :------ | :------ |
2752 | | `atc` | `AtomicTransactionComposer` | The ATC containing the txn group |
2753 | | `algod` | `AlgodClient` | The algod client to use for the simulation |
2754 |
2755 | #### Returns
2756 |
2757 | `Promise`\<`AtomicTransactionComposer`\>
2758 |
2759 | A new ATC with the resources packed into the transactions
2760 |
2761 | #### Defined in
2762 |
2763 | [src/transaction/transaction.ts:312](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L312)
2764 |
2765 | ___
2766 |
2767 | ### randomAccount
2768 |
2769 | ▸ **randomAccount**(): `Account`
2770 |
2771 | #### Returns
2772 |
2773 | `Account`
2774 |
2775 | **`Deprecated`**
2776 |
2777 | Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
2778 |
2779 | Returns a new, random Algorand account with secret key loaded.
2780 |
2781 | This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name.
2782 |
2783 | #### Defined in
2784 |
2785 | [src/account/account.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L60)
2786 |
2787 | ___
2788 |
2789 | ### rekeyAccount
2790 |
2791 | ▸ **rekeyAccount**(`rekey`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
2792 |
2793 | #### Parameters
2794 |
2795 | | Name | Type | Description |
2796 | | :------ | :------ | :------ |
2797 | | `rekey` | [`AlgoRekeyParams`](../interfaces/types_transfer.AlgoRekeyParams.md) | The rekey definition |
2798 | | `algod` | `AlgodClient` | An algod client |
2799 |
2800 | #### Returns
2801 |
2802 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
2803 |
2804 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
2805 |
2806 | **`Deprecated`**
2807 |
2808 | Use `algorand.account.rekeyAccount()` instead
2809 |
2810 | Rekey an account to a new address.
2811 |
2812 | **Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/).
2813 |
2814 | **`Example`**
2815 |
2816 | ```typescript
2817 | await algokit.rekeyAccount({ from, rekeyTo }, algod)
2818 | ```
2819 |
2820 | #### Defined in
2821 |
2822 | [src/transfer/transfer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L125)
2823 |
2824 | ___
2825 |
2826 | ### rekeyedAccount
2827 |
2828 | ▸ **rekeyedAccount**(`signer`, `sender`): [`SigningAccount`](../classes/types_account.SigningAccount.md)
2829 |
2830 | #### Parameters
2831 |
2832 | | Name | Type | Description |
2833 | | :------ | :------ | :------ |
2834 | | `signer` | `default` | The account, with private key loaded, that is signing |
2835 | | `sender` | `string` | The address of the rekeyed account that will act as a sender |
2836 |
2837 | #### Returns
2838 |
2839 | [`SigningAccount`](../classes/types_account.SigningAccount.md)
2840 |
2841 | The SigningAccount wrapper
2842 |
2843 | **`Deprecated`**
2844 |
2845 | Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
2846 |
2847 | Returns an account wrapper that supports a rekeyed account.
2848 |
2849 | #### Defined in
2850 |
2851 | [src/account/account.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L36)
2852 |
2853 | ___
2854 |
2855 | ### replaceDeployTimeControlParams
2856 |
2857 | ▸ **replaceDeployTimeControlParams**(`tealCode`, `params`): `string`
2858 |
2859 | #### Parameters
2860 |
2861 | | Name | Type | Description |
2862 | | :------ | :------ | :------ |
2863 | | `tealCode` | `string` | The TEAL code to substitute |
2864 | | `params` | `Object` | The deploy-time deployment control parameter value to replace |
2865 | | `params.deletable?` | `boolean` | - |
2866 | | `params.updatable?` | `boolean` | - |
2867 |
2868 | #### Returns
2869 |
2870 | `string`
2871 |
2872 | The replaced TEAL code
2873 |
2874 | **`Deprecated`**
2875 |
2876 | Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead
2877 |
2878 | Replaces deploy-time deployment control parameters within the given teal code.
2879 |
2880 | * `TMPL_UPDATABLE` for updatability / immutability control
2881 | * `TMPL_DELETABLE` for deletability / permanence control
2882 |
2883 | Note: If these values are not undefined, but the corresponding `TMPL_*` value
2884 | isn't in the teal code it will throw an exception.
2885 |
2886 | #### Defined in
2887 |
2888 | [src/app-deploy.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L294)
2889 |
2890 | ___
2891 |
2892 | ### sendAtomicTransactionComposer
2893 |
2894 | ▸ **sendAtomicTransactionComposer**(`atcSend`, `algod`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\>
2895 |
2896 | Signs and sends transactions that have been collected by an `AtomicTransactionComposer`.
2897 |
2898 | #### Parameters
2899 |
2900 | | Name | Type | Description |
2901 | | :------ | :------ | :------ |
2902 | | `atcSend` | [`AtomicTransactionComposerToSend`](../interfaces/types_transaction.AtomicTransactionComposerToSend.md) | The parameters controlling the send, including `atc` The `AtomicTransactionComposer` and params to control send behaviour |
2903 | | `algod` | `AlgodClient` | An algod client |
2904 |
2905 | #### Returns
2906 |
2907 | `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\>
2908 |
2909 | An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
2910 |
2911 | #### Defined in
2912 |
2913 | [src/transaction/transaction.ts:607](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L607)
2914 |
2915 | ___
2916 |
2917 | ### sendGroupOfTransactions
2918 |
2919 | ▸ **sendGroupOfTransactions**(`groupSend`, `algod`): `Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md), ``"returns"``\>\>
2920 |
2921 | #### Parameters
2922 |
2923 | | Name | Type | Description |
2924 | | :------ | :------ | :------ |
2925 | | `groupSend` | [`TransactionGroupToSend`](../interfaces/types_transaction.TransactionGroupToSend.md) | The group details to send, with: * `transactions`: The array of transactions to send along with their signing account * `sendParams`: The parameters to dictate how the group is sent |
2926 | | `algod` | `AlgodClient` | An algod client |
2927 |
2928 | #### Returns
2929 |
2930 | `Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md), ``"returns"``\>\>
2931 |
2932 | An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
2933 |
2934 | **`Deprecated`**
2935 |
2936 | Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead.
2937 |
2938 | Signs and sends a group of [up to 16](https://developer.algorand.org/docs/get-details/atomic_transfers/#create-transactions) transactions to the chain
2939 |
2940 | #### Defined in
2941 |
2942 | [src/transaction/transaction.ts:773](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L773)
2943 |
2944 | ___
2945 |
2946 | ### sendTransaction
2947 |
2948 | ▸ **sendTransaction**(`send`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
2949 |
2950 | #### Parameters
2951 |
2952 | | Name | Type | Description |
2953 | | :------ | :------ | :------ |
2954 | | `send` | `Object` | The details for the transaction to prepare/send, including: * `transaction`: The unsigned transaction * `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account * `config`: The sending configuration for this transaction |
2955 | | `send.from` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | - |
2956 | | `send.sendParams?` | [`SendTransactionParams`](../interfaces/types_transaction.SendTransactionParams.md) | - |
2957 | | `send.transaction` | `Transaction` | - |
2958 | | `algod` | `AlgodClient` | An algod client |
2959 |
2960 | #### Returns
2961 |
2962 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
2963 |
2964 | An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `undefined`) confirmation (`confirmation`)
2965 |
2966 | **`Deprecated`**
2967 |
2968 | Use `AlgorandClient` / `TransactionComposer` to send transactions.
2969 |
2970 | Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.
2971 |
2972 | #### Defined in
2973 |
2974 | [src/transaction/transaction.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L207)
2975 |
2976 | ___
2977 |
2978 | ### signTransaction
2979 |
2980 | ▸ **signTransaction**(`transaction`, `signer`): `Promise`\<`Uint8Array`\>
2981 |
2982 | #### Parameters
2983 |
2984 | | Name | Type | Description |
2985 | | :------ | :------ | :------ |
2986 | | `transaction` | `Transaction` | The transaction to sign |
2987 | | `signer` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The signer to sign |
2988 |
2989 | #### Returns
2990 |
2991 | `Promise`\<`Uint8Array`\>
2992 |
2993 | The signed transaction as a `Uint8Array`
2994 |
2995 | **`Deprecated`**
2996 |
2997 | Use `AlgorandClient` / `TransactionComposer` to sign transactions
2998 | or use the relevant underlying `account.signTxn` / `algosdk.signLogicSigTransactionObject`
2999 | / `multiSigAccount.sign` / `TransactionSigner` methods directly.
3000 |
3001 | Signs a single transaction by the given signer.
3002 |
3003 | #### Defined in
3004 |
3005 | [src/transaction/transaction.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L184)
3006 |
3007 | ___
3008 |
3009 | ### stripTealComments
3010 |
3011 | ▸ **stripTealComments**(`tealCode`): `string`
3012 |
3013 | #### Parameters
3014 |
3015 | | Name | Type | Description |
3016 | | :------ | :------ | :------ |
3017 | | `tealCode` | `string` | The TEAL logic to compile |
3018 |
3019 | #### Returns
3020 |
3021 | `string`
3022 |
3023 | The TEAL without comments
3024 |
3025 | **`Deprecated`**
3026 |
3027 | Use `AppManager.stripTealComments` instead.
3028 |
3029 | Remove comments from TEAL Code
3030 |
3031 | #### Defined in
3032 |
3033 | [src/app-deploy.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L351)
3034 |
3035 | ___
3036 |
3037 | ### transactionFees
3038 |
3039 | ▸ **transactionFees**(`numberOfTransactions`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
3040 |
3041 | Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount
3042 |
3043 | #### Parameters
3044 |
3045 | | Name | Type | Description |
3046 | | :------ | :------ | :------ |
3047 | | `numberOfTransactions` | `number` | The of standard transaction fees to return the amount of Algo |
3048 |
3049 | #### Returns
3050 |
3051 | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
3052 |
3053 | #### Defined in
3054 |
3055 | [src/amount.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L89)
3056 |
3057 | ___
3058 |
3059 | ### transactionSignerAccount
3060 |
3061 | ▸ **transactionSignerAccount**(`signer`, `sender`): [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
3062 |
3063 | #### Parameters
3064 |
3065 | | Name | Type | Description |
3066 | | :------ | :------ | :------ |
3067 | | `signer` | `TransactionSigner` | The transaction signer |
3068 | | `sender` | `string` | The address of sender account |
3069 |
3070 | #### Returns
3071 |
3072 | [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
3073 |
3074 | The SigningAccount wrapper
3075 |
3076 | **`Deprecated`**
3077 |
3078 | Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
3079 |
3080 | Returns an account wrapper that supports a transaction signer with associated sender address.
3081 |
3082 | #### Defined in
3083 |
3084 | [src/account/account.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L48)
3085 |
3086 | ___
3087 |
3088 | ### transferAlgos
3089 |
3090 | ▸ **transferAlgos**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
3091 |
3092 | #### Parameters
3093 |
3094 | | Name | Type | Description |
3095 | | :------ | :------ | :------ |
3096 | | `transfer` | [`AlgoTransferParams`](../interfaces/types_transfer.AlgoTransferParams.md) | The transfer definition |
3097 | | `algod` | `AlgodClient` | An algod client |
3098 |
3099 | #### Returns
3100 |
3101 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
3102 |
3103 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
3104 |
3105 | **`Deprecated`**
3106 |
3107 | Use `algorand.send.payment()` / `algorand.createTransaction.payment()` instead
3108 |
3109 | Transfer Algo between two accounts.
3110 |
3111 | **`Example`**
3112 |
3113 | ```typescript
3114 | await algokit.transferAlgos({ from, to, amount: algokit.algo(1) }, algod)
3115 | ```
3116 |
3117 | #### Defined in
3118 |
3119 | [src/transfer/transfer-algos.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer-algos.ts#L22)
3120 |
3121 | ___
3122 |
3123 | ### transferAsset
3124 |
3125 | ▸ **transferAsset**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
3126 |
3127 | #### Parameters
3128 |
3129 | | Name | Type | Description |
3130 | | :------ | :------ | :------ |
3131 | | `transfer` | [`TransferAssetParams`](../interfaces/types_transfer.TransferAssetParams.md) | The transfer definition |
3132 | | `algod` | `AlgodClient` | An algod client |
3133 |
3134 | #### Returns
3135 |
3136 | `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\>
3137 |
3138 | The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
3139 |
3140 | **`Deprecated`**
3141 |
3142 | Use `algorand.send.assetTransfer()` / `algorand.createTransaction.assetTransfer()` instead
3143 |
3144 | Transfer asset between two accounts.
3145 |
3146 | **`Example`**
3147 |
3148 | ```typescript
3149 | await algokit.transferAsset({ from, to, assetId, amount }, algod)
3150 | ```
3151 |
3152 | #### Defined in
3153 |
3154 | [src/transfer/transfer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L90)
3155 |
3156 | ___
3157 |
3158 | ### updateApp
3159 |
3160 | ▸ **updateApp**(`update`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\>
3161 |
3162 | #### Parameters
3163 |
3164 | | Name | Type | Description |
3165 | | :------ | :------ | :------ |
3166 | | `update` | [`UpdateAppParams`](../interfaces/types_app.UpdateAppParams.md) | The parameters to update the app with |
3167 | | `algod` | `AlgodClient` | An algod client |
3168 |
3169 | #### Returns
3170 |
3171 | `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\>
3172 |
3173 | The transaction send result and the compilation result
3174 |
3175 | **`Deprecated`**
3176 |
3177 | Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()`
3178 | / `algorand.createTransaction.appUpdateMethodCall()` instead
3179 |
3180 | Updates a smart contract app.
3181 |
3182 | #### Defined in
3183 |
3184 | [src/app.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L104)
3185 |
3186 | ___
3187 |
3188 | ### waitForConfirmation
3189 |
3190 | ▸ **waitForConfirmation**(`transactionId`, `maxRoundsToWait`, `algod`): `Promise`\<`PendingTransactionResponse`\>
3191 |
3192 | Wait until the transaction is confirmed or rejected, or until `timeout`
3193 | number of rounds have passed.
3194 |
3195 | #### Parameters
3196 |
3197 | | Name | Type | Description |
3198 | | :------ | :------ | :------ |
3199 | | `transactionId` | `string` | The transaction ID to wait for |
3200 | | `maxRoundsToWait` | `number` \| `bigint` | Maximum number of rounds to wait |
3201 | | `algod` | `AlgodClient` | An algod client |
3202 |
3203 | #### Returns
3204 |
3205 | `Promise`\<`PendingTransactionResponse`\>
3206 |
3207 | Pending transaction information
3208 |
3209 | **`Throws`**
3210 |
3211 | Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds
3212 |
3213 | #### Defined in
3214 |
3215 | [src/transaction/transaction.ts:817](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L817)
3216 |
```