This is page 59 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:cli:cli:index.md:
--------------------------------------------------------------------------------
```markdown
1 | # AlgoKit CLI Reference Documentation
2 |
3 |
4 | - [algokit](#algokit)
5 | - [Options](#options)
6 | - [--version](#--version)
7 | - [-v, --verbose](#-v---verbose)
8 | - [--color, --no-color](#--color---no-color)
9 | - [--skip-version-check](#--skip-version-check)
10 | - [compile](#compile)
11 | - [Options](#options-1)
12 | - [-v, --version ](#-v---version-)
13 | - [py](#py)
14 | - [Arguments](#arguments)
15 | - [PUYAPY_ARGS](#puyapy_args)
16 | - [python](#python)
17 | - [Arguments](#arguments-1)
18 | - [PUYAPY_ARGS](#puyapy_args-1)
19 | - [completions](#completions)
20 | - [install](#install)
21 | - [Options](#options-2)
22 | - [--shell ](#--shell-)
23 | - [uninstall](#uninstall)
24 | - [Options](#options-3)
25 | - [--shell ](#--shell--1)
26 | - [config](#config)
27 | - [container-engine](#container-engine)
28 | - [Options](#options-4)
29 | - [-f, --force](#-f---force)
30 | - [Arguments](#arguments-2)
31 | - [ENGINE](#engine)
32 | - [version-prompt](#version-prompt)
33 | - [Arguments](#arguments-3)
34 | - [ENABLE](#enable)
35 | - [dispenser](#dispenser)
36 | - [fund](#fund)
37 | - [Options](#options-5)
38 | - [-r, --receiver ](#-r---receiver-)
39 | - [-a, --amount ](#-a---amount-)
40 | - [--whole-units](#--whole-units)
41 | - [limit](#limit)
42 | - [Options](#options-6)
43 | - [--whole-units](#--whole-units-1)
44 | - [login](#login)
45 | - [Options](#options-7)
46 | - [--ci](#--ci)
47 | - [-o, --output ](#-o---output-)
48 | - [-f, --file ](#-f---file-)
49 | - [logout](#logout)
50 | - [refund](#refund)
51 | - [Options](#options-8)
52 | - [-t, --txID ](#-t---txid-)
53 | - [doctor](#doctor)
54 | - [Options](#options-9)
55 | - [-c, --copy-to-clipboard](#-c---copy-to-clipboard)
56 | - [explore](#explore)
57 | - [Arguments](#arguments-4)
58 | - [NETWORK](#network)
59 | - [generate](#generate)
60 | - [client](#client)
61 | - [Options](#options-10)
62 | - [-o, --output ](#-o---output--1)
63 | - [-l, --language ](#-l---language-)
64 | - [-v, --version ](#-v---version--1)
65 | - [Arguments](#arguments-5)
66 | - [APP_SPEC_PATH_OR_DIR](#app_spec_path_or_dir)
67 | - [goal](#goal)
68 | - [Options](#options-11)
69 | - [--console](#--console)
70 | - [--interactive](#--interactive)
71 | - [Arguments](#arguments-6)
72 | - [GOAL_ARGS](#goal_args)
73 | - [init](#init)
74 | - [Options](#options-12)
75 | - [-n, --name ](#-n---name-)
76 | - [-t, --template ](#-t---template-)
77 | - [--template-url ](#--template-url-)
78 | - [--template-url-ref ](#--template-url-ref-)
79 | - [--UNSAFE-SECURITY-accept-template-url](#--unsafe-security-accept-template-url)
80 | - [--git, --no-git](#--git---no-git)
81 | - [--defaults](#--defaults)
82 | - [--bootstrap, --no-bootstrap](#--bootstrap---no-bootstrap)
83 | - [--ide, --no-ide](#--ide---no-ide)
84 | - [--workspace, --no-workspace](#--workspace---no-workspace)
85 | - [-a, --answer ](#-a---answer--)
86 | - [localnet](#localnet)
87 | - [codespace](#codespace)
88 | - [Options](#options-13)
89 | - [-m, --machine ](#-m---machine-)
90 | - [-a, --algod-port ](#-a---algod-port-)
91 | - [-i, --indexer-port ](#-i---indexer-port-)
92 | - [-k, --kmd-port ](#-k---kmd-port-)
93 | - [-n, --codespace-name ](#-n---codespace-name-)
94 | - [-r, --repo-url ](#-r---repo-url-)
95 | - [-t, --timeout ](#-t---timeout-)
96 | - [-f, --force](#-f---force-1)
97 | - [config](#config-1)
98 | - [Options](#options-14)
99 | - [-f, --force](#-f---force-2)
100 | - [Arguments](#arguments-7)
101 | - [ENGINE](#engine-1)
102 | - [console](#console)
103 | - [explore](#explore-1)
104 | - [logs](#logs)
105 | - [Options](#options-15)
106 | - [--follow, -f](#--follow--f)
107 | - [--tail ](#--tail-)
108 | - [reset](#reset)
109 | - [Options](#options-16)
110 | - [--update, --no-update](#--update---no-update)
111 | - [-P, --config-dir ](#-p---config-dir-)
112 | - [start](#start)
113 | - [Options](#options-17)
114 | - [-n, --name ](#-n---name--1)
115 | - [-P, --config-dir ](#-p---config-dir--1)
116 | - [-d, --dev, --no-dev](#-d---dev---no-dev)
117 | - [--force](#--force)
118 | - [status](#status)
119 | - [stop](#stop)
120 | - [project](#project)
121 | - [bootstrap](#bootstrap)
122 | - [Options](#options-18)
123 | - [--force](#--force-1)
124 | - [Options](#options-19)
125 | - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci)
126 | - [-p, --project-name ](#-p---project-name-)
127 | - [-t, --type ](#-t---type-)
128 | - [Options](#options-20)
129 | - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-1)
130 | - [deploy](#deploy)
131 | - [Options](#options-21)
132 | - [-C, -c, --command ](#-c--c---command-)
133 | - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-2)
134 | - [-P, --path ](#-p---path-)
135 | - [--deployer ](#--deployer-)
136 | - [--dispenser ](#--dispenser-)
137 | - [-p, --project-name ](#-p---project-name--1)
138 | - [Arguments](#arguments-8)
139 | - [ENVIRONMENT_NAME](#environment_name)
140 | - [EXTRA_ARGS](#extra_args)
141 | - [link](#link)
142 | - [Options](#options-22)
143 | - [-p, --project-name ](#-p---project-name--2)
144 | - [-l, --language ](#-l---language--1)
145 | - [-a, --all](#-a---all)
146 | - [-f, --fail-fast](#-f---fail-fast)
147 | - [-v, --version ](#-v---version--2)
148 | - [list](#list)
149 | - [Arguments](#arguments-9)
150 | - [WORKSPACE_PATH](#workspace_path)
151 | - [run](#run)
152 | - [task](#task)
153 | - [analyze](#analyze)
154 | - [Options](#options-23)
155 | - [-r, --recursive](#-r---recursive)
156 | - [--force](#--force-2)
157 | - [--diff](#--diff)
158 | - [-o, --output ](#-o---output--2)
159 | - [-e, --exclude ](#-e---exclude-)
160 | - [Arguments](#arguments-10)
161 | - [INPUT_PATHS](#input_paths)
162 | - [ipfs](#ipfs)
163 | - [Options](#options-24)
164 | - [-f, --file ](#-f---file--1)
165 | - [-n, --name ](#-n---name--2)
166 | - [mint](#mint)
167 | - [Options](#options-25)
168 | - [--creator ](#--creator-)
169 | - [--name ](#--name-)
170 | - [-u, --unit ](#-u---unit-)
171 | - [-t, --total ](#-t---total-)
172 | - [-d, --decimals ](#-d---decimals-)
173 | - [--nft, --ft](#--nft---ft)
174 | - [-i, --image ](#-i---image-)
175 | - [-m, --metadata ](#-m---metadata-)
176 | - [--mutable, --immutable](#--mutable---immutable)
177 | - [-n, --network ](#-n---network-)
178 | - [nfd-lookup](#nfd-lookup)
179 | - [Options](#options-26)
180 | - [-o, --output ](#-o---output--3)
181 | - [Arguments](#arguments-11)
182 | - [VALUE](#value)
183 | - [opt-in](#opt-in)
184 | - [Options](#options-27)
185 | - [-a, --account ](#-a---account-)
186 | - [-n, --network ](#-n---network--1)
187 | - [Arguments](#arguments-12)
188 | - [ASSET_IDS](#asset_ids)
189 | - [opt-out](#opt-out)
190 | - [Options](#options-28)
191 | - [-a, --account ](#-a---account--1)
192 | - [--all](#--all)
193 | - [-n, --network ](#-n---network--2)
194 | - [Arguments](#arguments-13)
195 | - [ASSET_IDS](#asset_ids-1)
196 | - [send](#send)
197 | - [Options](#options-29)
198 | - [-f, --file ](#-f---file--2)
199 | - [-t, --transaction ](#-t---transaction-)
200 | - [-n, --network ](#-n---network--3)
201 | - [sign](#sign)
202 | - [Options](#options-30)
203 | - [-a, --account ](#-a---account--2)
204 | - [-f, --file ](#-f---file--3)
205 | - [-t, --transaction ](#-t---transaction--1)
206 | - [-o, --output ](#-o---output--4)
207 | - [--force](#--force-3)
208 | - [transfer](#transfer)
209 | - [Options](#options-31)
210 | - [-s, --sender ](#-s---sender-)
211 | - [-r, --receiver ](#-r---receiver--1)
212 | - [--asset, --id ](#--asset---id-)
213 | - [-a, --amount ](#-a---amount--1)
214 | - [--whole-units](#--whole-units-2)
215 | - [-n, --network ](#-n---network--4)
216 | - [vanity-address](#vanity-address)
217 | - [Options](#options-32)
218 | - [-m, --match ](#-m---match-)
219 | - [-o, --output ](#-o---output--5)
220 | - [-a, --alias ](#-a---alias-)
221 | - [--file-path ](#--file-path-)
222 | - [-f, --force](#-f---force-3)
223 | - [Arguments](#arguments-14)
224 | - [KEYWORD](#keyword)
225 | - [wallet](#wallet)
226 | - [Options](#options-33)
227 | - [-a, --address ](#-a---address-)
228 | - [-m, --mnemonic](#-m---mnemonic)
229 | - [-f, --force](#-f---force-4)
230 | - [Arguments](#arguments-15)
231 | - [ALIAS_NAME](#alias_name)
232 | - [Arguments](#arguments-16)
233 | - [ALIAS](#alias)
234 | - [Options](#options-34)
235 | - [-f, --force](#-f---force-5)
236 | - [Arguments](#arguments-17)
237 | - [ALIAS](#alias-1)
238 | - [Options](#options-35)
239 | - [-f, --force](#-f---force-6)
240 |
241 | # algokit
242 |
243 | AlgoKit is your one-stop shop to develop applications on the Algorand blockchain.
244 |
245 | If you are getting started, please see the quick start tutorial: [https://bit.ly/algokit-intro-tutorial](https://bit.ly/algokit-intro-tutorial).
246 |
247 | ```shell
248 | algokit [OPTIONS] COMMAND [ARGS]...
249 | ```
250 |
251 | ### Options
252 |
253 |
254 | ### --version
255 | Show the version and exit.
256 |
257 |
258 | ### -v, --verbose
259 | Enable logging of DEBUG messages to the console.
260 |
261 |
262 | ### --color, --no-color
263 | Force enable or disable of console output styling.
264 |
265 |
266 | ### --skip-version-check
267 | Skip version checking and prompting.
268 |
269 | ## compile
270 |
271 | Compile smart contracts and smart signatures written in a supported high-level language
272 | to a format deployable on the Algorand Virtual Machine (AVM).
273 |
274 | ```shell
275 | algokit compile [OPTIONS] COMMAND [ARGS]...
276 | ```
277 |
278 | ### Options
279 |
280 |
281 | ### -v, --version <version>
282 | The compiler version to pin to, for example, 1.0.0. If no version is specified, AlgoKit checks if the compiler is installed and runs the installed version. If the compiler is not installed, AlgoKit runs the latest version. If a version is specified, AlgoKit checks if an installed version matches and runs the installed version. Otherwise, AlgoKit runs the specified version.
283 |
284 | ### py
285 |
286 | Compile Algorand Python contract(s) using the PuyaPy compiler.
287 |
288 | ```shell
289 | algokit compile py [OPTIONS] [PUYAPY_ARGS]...
290 | ```
291 |
292 | ### Arguments
293 |
294 |
295 | ### PUYAPY_ARGS
296 | Optional argument(s)
297 |
298 | ### python
299 |
300 | Compile Algorand Python contract(s) using the PuyaPy compiler.
301 |
302 | ```shell
303 | algokit compile python [OPTIONS] [PUYAPY_ARGS]...
304 | ```
305 |
306 | ### Arguments
307 |
308 |
309 | ### PUYAPY_ARGS
310 | Optional argument(s)
311 |
312 | ## completions
313 |
314 | Install and Uninstall AlgoKit shell integrations.
315 |
316 | ```shell
317 | algokit completions [OPTIONS] COMMAND [ARGS]...
318 | ```
319 |
320 | ### install
321 |
322 | Install shell completions, this command will attempt to update the interactive profile script
323 | for the current shell to support algokit completions. To specify a specific shell use --shell.
324 |
325 | ```shell
326 | algokit completions install [OPTIONS]
327 | ```
328 |
329 | ### Options
330 |
331 |
332 | ### --shell <shell>
333 | Specify shell to install algokit completions for.
334 |
335 |
336 | * **Options**
337 |
338 | bash | zsh
339 |
340 |
341 | ### uninstall
342 |
343 | Uninstall shell completions, this command will attempt to update the interactive profile script
344 | for the current shell to remove any algokit completions that have been added.
345 | To specify a specific shell use --shell.
346 |
347 | ```shell
348 | algokit completions uninstall [OPTIONS]
349 | ```
350 |
351 | ### Options
352 |
353 |
354 | ### --shell <shell>
355 | Specify shell to install algokit completions for.
356 |
357 |
358 | * **Options**
359 |
360 | bash | zsh
361 |
362 |
363 | ## config
364 |
365 | Configure settings used by AlgoKit
366 |
367 | ```shell
368 | algokit config [OPTIONS] COMMAND [ARGS]...
369 | ```
370 |
371 | ### container-engine
372 |
373 | Set the default container engine for use by AlgoKit CLI to run LocalNet images.
374 |
375 | ```shell
376 | algokit config container-engine [OPTIONS] [[docker|podman]]
377 | ```
378 |
379 | ### Options
380 |
381 |
382 | ### -f, --force
383 | Skip confirmation prompts. Defaults to 'yes' to all prompts.
384 |
385 | ### Arguments
386 |
387 |
388 | ### ENGINE
389 | Optional argument
390 |
391 | ### version-prompt
392 |
393 | Controls whether AlgoKit checks and prompts for new versions.
394 | Set to [disable] to prevent AlgoKit performing this check permanently, or [enable] to resume checking.
395 | If no argument is provided then outputs current setting.
396 |
397 | Also see --skip-version-check which can be used to disable check for a single command.
398 |
399 | ```shell
400 | algokit config version-prompt [OPTIONS] [[enable|disable]]
401 | ```
402 |
403 | ### Arguments
404 |
405 |
406 | ### ENABLE
407 | Optional argument
408 |
409 | ## dispenser
410 |
411 | Interact with the AlgoKit TestNet Dispenser.
412 |
413 | ```shell
414 | algokit dispenser [OPTIONS] COMMAND [ARGS]...
415 | ```
416 |
417 | ### fund
418 |
419 | Fund your wallet address with TestNet ALGOs.
420 |
421 | ```shell
422 | algokit dispenser fund [OPTIONS]
423 | ```
424 |
425 | ### Options
426 |
427 |
428 | ### -r, --receiver <receiver>
429 | **Required** Address or alias of the receiver to fund with TestNet ALGOs.
430 |
431 |
432 | ### -a, --amount <amount>
433 | **Required** Amount to fund. Defaults to microAlgos.
434 |
435 |
436 | ### --whole-units
437 | Use whole units (Algos) instead of smallest divisible units (microAlgos). Disabled by default.
438 |
439 | ### limit
440 |
441 | Get information about current fund limit on your account. Resets daily.
442 |
443 | ```shell
444 | algokit dispenser limit [OPTIONS]
445 | ```
446 |
447 | ### Options
448 |
449 |
450 | ### --whole-units
451 | Use whole units (Algos) instead of smallest divisible units (microAlgos). Disabled by default.
452 |
453 | ### login
454 |
455 | Login to your Dispenser API account.
456 |
457 | ```shell
458 | algokit dispenser login [OPTIONS]
459 | ```
460 |
461 | ### Options
462 |
463 |
464 | ### --ci
465 | Generate an access token for CI. Issued for 30 days.
466 |
467 |
468 | ### -o, --output <output_mode>
469 | Choose the output method for the access token. Defaults to stdout. Only applicable when --ci flag is set.
470 |
471 |
472 | * **Options**
473 |
474 | stdout | file
475 |
476 |
477 |
478 | ### -f, --file <output_filename>
479 | Output filename where you want to store the generated access token.Defaults to algokit_ci_token.txt. Only applicable when --ci flag is set and --output mode is file.
480 |
481 | ### logout
482 |
483 | Logout of your Dispenser API account.
484 |
485 | ```shell
486 | algokit dispenser logout [OPTIONS]
487 | ```
488 |
489 | ### refund
490 |
491 | Refund ALGOs back to the dispenser wallet address.
492 |
493 | ```shell
494 | algokit dispenser refund [OPTIONS]
495 | ```
496 |
497 | ### Options
498 |
499 |
500 | ### -t, --txID <tx_id>
501 | **Required** Transaction ID of your refund operation.
502 |
503 | ## doctor
504 |
505 | Diagnose potential environment issues that may affect AlgoKit.
506 |
507 | Will search the system for AlgoKit dependencies and show their versions, as well as identifying any
508 | potential issues.
509 |
510 | ```shell
511 | algokit doctor [OPTIONS]
512 | ```
513 |
514 | ### Options
515 |
516 |
517 | ### -c, --copy-to-clipboard
518 | Copy the contents of the doctor message (in Markdown format) in your clipboard.
519 |
520 | ## explore
521 |
522 | Explore the specified network using lora.
523 |
524 | ```shell
525 | algokit explore [OPTIONS] [[localnet|testnet|mainnet]]
526 | ```
527 |
528 | ### Arguments
529 |
530 |
531 | ### NETWORK
532 | Optional argument
533 |
534 | ## generate
535 |
536 | Generate code for an Algorand project.
537 |
538 | ```shell
539 | algokit generate [OPTIONS] COMMAND [ARGS]...
540 | ```
541 |
542 | ### client
543 |
544 | Create a typed ApplicationClient from an ARC-32/56 application.json
545 |
546 | Supply the path to an application specification file or a directory to recursively search
547 | for "application.json" files
548 |
549 | ```shell
550 | algokit generate client [OPTIONS] APP_SPEC_PATH_OR_DIR
551 | ```
552 |
553 | ### Options
554 |
555 |
556 | ### -o, --output <output_path_pattern>
557 | Path to the output file. The following tokens can be used to substitute into the output path: {contract_name}, {app_spec_dir}
558 |
559 |
560 | ### -l, --language <language>
561 | Programming language of the generated client code
562 |
563 |
564 | * **Options**
565 |
566 | python | typescript
567 |
568 |
569 |
570 | ### -v, --version <version>
571 | The client generator version to pin to, for example, 1.0.0. If no version is specified, AlgoKit checks if the client generator is installed and runs the installed version. If the client generator is not installed, AlgoKit runs the latest version. If a version is specified, AlgoKit checks if an installed version matches and runs the installed version. Otherwise, AlgoKit runs the specified version.
572 |
573 | ### Arguments
574 |
575 |
576 | ### APP_SPEC_PATH_OR_DIR
577 | Required argument
578 |
579 | ## goal
580 |
581 | Run the Algorand goal CLI against the AlgoKit LocalNet.
582 |
583 | Look at [https://developer.algorand.org/docs/clis/goal/goal/](https://developer.algorand.org/docs/clis/goal/goal/) for more information.
584 |
585 | ```shell
586 | algokit goal [OPTIONS] [GOAL_ARGS]...
587 | ```
588 |
589 | ### Options
590 |
591 |
592 | ### --console
593 | Open a Bash console so you can execute multiple goal commands and/or interact with a filesystem.
594 |
595 |
596 | ### --interactive
597 | Force running the goal command in interactive mode.
598 |
599 | ### Arguments
600 |
601 |
602 | ### GOAL_ARGS
603 | Optional argument(s)
604 |
605 | ## init
606 |
607 | Initializes a new project from a template, including prompting
608 | for template specific questions to be used in template rendering.
609 |
610 | Templates can be default templates shipped with AlgoKit, or custom
611 | templates in public Git repositories.
612 |
613 | Includes ability to initialise Git repository, run algokit project bootstrap and
614 | automatically open Visual Studio Code.
615 |
616 | This should be run in the parent directory that you want the project folder
617 | created in.
618 |
619 | By default, the --workspace flag creates projects within a workspace structure or integrates them into an existing
620 | one, promoting organized management of multiple projects. Alternatively,
621 | to disable this behavior use the --no-workspace flag, which ensures
622 | the new project is created in a standalone target directory. This is
623 | suitable for isolated projects or when workspace integration is unnecessary.
624 |
625 | ```shell
626 | algokit init [OPTIONS]
627 | ```
628 |
629 | ### Options
630 |
631 |
632 | ### -n, --name <directory_name>
633 | Name of the project / directory / repository to create.
634 |
635 |
636 | ### -t, --template <template_name>
637 | Name of an official template to use. To choose interactively, run this command with no arguments.
638 |
639 |
640 | * **Options**
641 |
642 | tealscript | python | react | fullstack | base | playground
643 |
644 |
645 |
646 | ### --template-url <URL>
647 | URL to a git repo with a custom project template.
648 |
649 |
650 | ### --template-url-ref <URL>
651 | Specific tag, branch or commit to use on git repo specified with --template-url. Defaults to latest.
652 |
653 |
654 | ### --UNSAFE-SECURITY-accept-template-url
655 | Accept the specified template URL, acknowledging the security implications of arbitrary code execution trusting an unofficial template.
656 |
657 |
658 | ### --git, --no-git
659 | Initialise git repository in directory after creation.
660 |
661 |
662 | ### --defaults
663 | Automatically choose default answers without asking when creating this template.
664 |
665 |
666 | ### --bootstrap, --no-bootstrap
667 | Whether to run algokit project bootstrap to install and configure the new project's dependencies locally.
668 |
669 |
670 | ### --ide, --no-ide
671 | Whether to open an IDE for you if the IDE and IDE config are detected. Supported IDEs: VS Code.
672 |
673 |
674 | ### --workspace, --no-workspace
675 | Whether to prefer structuring standalone projects as part of a workspace. An AlgoKit workspace is a conventional project structure that allows managing multiple standalone projects in a monorepo.
676 |
677 |
678 | ### -a, --answer <key> <value>
679 | Answers key/value pairs to pass to the template.
680 |
681 | ## localnet
682 |
683 | Manage the AlgoKit LocalNet.
684 |
685 | ```shell
686 | algokit localnet [OPTIONS] COMMAND [ARGS]...
687 | ```
688 |
689 | ### codespace
690 |
691 | Manage the AlgoKit LocalNet in GitHub Codespaces.
692 |
693 | ```shell
694 | algokit localnet codespace [OPTIONS]
695 | ```
696 |
697 | ### Options
698 |
699 |
700 | ### -m, --machine <machine>
701 | The GitHub Codespace machine type to use. Defaults to base tier.
702 |
703 |
704 | * **Options**
705 |
706 | basicLinux32gb | standardLinux32gb | premiumLinux | largePremiumLinux
707 |
708 |
709 |
710 | ### -a, --algod-port <algod_port>
711 | The port for the Algorand daemon. Defaults to 4001.
712 |
713 |
714 | ### -i, --indexer-port <indexer_port>
715 | The port for the Algorand indexer. Defaults to 8980.
716 |
717 |
718 | ### -k, --kmd-port <kmd_port>
719 | The port for the Algorand kmd. Defaults to 4002.
720 |
721 |
722 | ### -n, --codespace-name <codespace_name>
723 | The name of the codespace. Defaults to 'algokit-localnet_timestamp'.
724 |
725 |
726 | ### -r, --repo-url <repo_url>
727 | The URL of the repository. Defaults to algokit base template repo.
728 |
729 |
730 | ### -t, --timeout <timeout_minutes>
731 | Default max runtime timeout in minutes. Upon hitting the timeout a codespace will be shutdown to prevent accidental spending over GitHub Codespaces quota. Defaults to 4 hours.
732 |
733 |
734 | ### -f, --force
735 | Force delete previously used codespaces with {CODESPACE_NAME_PREFIX}\* name prefix and skip prompts. Defaults to explicitly prompting for confirmation.
736 |
737 | ### config
738 |
739 | Set the default container engine for use by AlgoKit CLI to run LocalNet images.
740 |
741 | ```shell
742 | algokit localnet config [OPTIONS] [[docker|podman]]
743 | ```
744 |
745 | ### Options
746 |
747 |
748 | ### -f, --force
749 | Skip confirmation prompts. Defaults to 'yes' to all prompts.
750 |
751 | ### Arguments
752 |
753 |
754 | ### ENGINE
755 | Optional argument
756 |
757 | ### console
758 |
759 | Run the Algorand goal CLI against the AlgoKit LocalNet via a Bash console so you can execute multiple goal commands and/or interact with a filesystem.
760 |
761 | ```shell
762 | algokit localnet console [OPTIONS]
763 | ```
764 |
765 | ### explore
766 |
767 | Explore the AlgoKit LocalNet using lora.
768 |
769 | ```shell
770 | algokit localnet explore [OPTIONS]
771 | ```
772 |
773 | ### logs
774 |
775 | See the output of the Docker containers.
776 |
777 | ```shell
778 | algokit localnet logs [OPTIONS]
779 | ```
780 |
781 | ### Options
782 |
783 |
784 | ### --follow, -f
785 | Follow log output.
786 |
787 |
788 | ### --tail <tail>
789 | Number of lines to show from the end of the logs for each container.
790 |
791 |
792 | * **Default**
793 |
794 | `all`
795 |
796 |
797 | ### reset
798 |
799 | Reset the AlgoKit LocalNet.
800 |
801 | ```shell
802 | algokit localnet reset [OPTIONS]
803 | ```
804 |
805 | ### Options
806 |
807 |
808 | ### --update, --no-update
809 | Enable or disable updating to the latest available LocalNet version, default: don't update
810 |
811 |
812 | ### -P, --config-dir <config_path>
813 | Specify the custom localnet configuration directory.
814 |
815 | ### start
816 |
817 | Start the AlgoKit LocalNet.
818 |
819 | ```shell
820 | algokit localnet start [OPTIONS]
821 | ```
822 |
823 | ### Options
824 |
825 |
826 | ### -n, --name <name>
827 | Specify a name for a custom LocalNet instance. AlgoKit will not manage the configuration of named LocalNet instances, allowing developers to configure it in any way they need. Defaults to 'sandbox'.
828 |
829 |
830 | ### -P, --config-dir <config_path>
831 | Specify the custom localnet configuration directory. Defaults to '~/.config' on UNIX and 'C:\\Users\\USERNAME\\AppData\\Roaming' on Windows.
832 |
833 |
834 | ### -d, --dev, --no-dev
835 | Control whether to launch 'algod' in developer mode or not. Defaults to 'yes'.
836 |
837 |
838 | ### --force
839 | Ignore the prompt to stop the LocalNet if it's already running.
840 |
841 | ### status
842 |
843 | Check the status of the AlgoKit LocalNet.
844 |
845 | ```shell
846 | algokit localnet status [OPTIONS]
847 | ```
848 |
849 | ### stop
850 |
851 | Stop the AlgoKit LocalNet.
852 |
853 | ```shell
854 | algokit localnet stop [OPTIONS]
855 | ```
856 |
857 | ## project
858 |
859 | Provides a suite of commands for managing your AlgoKit project.
860 | This includes initializing project dependencies, deploying smart contracts,
861 | and executing predefined or custom commands within your project environment.
862 |
863 | ```shell
864 | algokit project [OPTIONS] COMMAND [ARGS]...
865 | ```
866 |
867 | ### bootstrap
868 |
869 | Expedited initial setup for any developer by installing and configuring dependencies and other
870 | key development environment setup activities.
871 |
872 | ```shell
873 | algokit project bootstrap [OPTIONS] COMMAND [ARGS]...
874 | ```
875 |
876 | ### Options
877 |
878 |
879 | ### --force
880 | Continue even if minimum AlgoKit version is not met
881 |
882 | #### all
883 |
884 | Runs all bootstrap sub-commands in the current directory and immediate sub directories.
885 |
886 | ```shell
887 | algokit project bootstrap all [OPTIONS]
888 | ```
889 |
890 | ### Options
891 |
892 |
893 | ### --interactive, --non-interactive, --ci
894 | Enable/disable interactive prompts. If the CI environment variable is set, defaults to non-interactive
895 |
896 |
897 | ### -p, --project-name <value>
898 | (Optional) Projects to execute the command on. Defaults to all projects found in the current directory.
899 |
900 |
901 | ### -t, --type <project_type>
902 | (Optional) Limit execution to specific project types if executing from workspace.
903 |
904 |
905 | * **Options**
906 |
907 | ProjectType.FRONTEND | ProjectType.CONTRACT | ProjectType.BACKEND
908 |
909 |
910 | #### env
911 |
912 | Copies .env.template file to .env in the current working directory and prompts for any unspecified values.
913 |
914 | ```shell
915 | algokit project bootstrap env [OPTIONS]
916 | ```
917 |
918 | ### Options
919 |
920 |
921 | ### --interactive, --non-interactive, --ci
922 | Enable/disable interactive prompts. If the CI environment variable is set, defaults to non-interactive
923 |
924 | #### npm
925 |
926 | Runs npm install in the current working directory to install Node.js dependencies.
927 |
928 | ```shell
929 | algokit project bootstrap npm [OPTIONS]
930 | ```
931 |
932 | #### poetry
933 |
934 | Installs Python Poetry (if not present) and runs poetry install in the current working directory to install Python dependencies.
935 |
936 | ```shell
937 | algokit project bootstrap poetry [OPTIONS]
938 | ```
939 |
940 | ### deploy
941 |
942 | Deploy smart contracts from AlgoKit compliant repository.
943 |
944 | ```shell
945 | algokit project deploy [OPTIONS] [ENVIRONMENT_NAME] [EXTRA_ARGS]...
946 | ```
947 |
948 | ### Options
949 |
950 |
951 | ### -C, -c, --command <command>
952 | Custom deploy command. If not provided, will load the deploy command from .algokit.toml file.
953 |
954 |
955 | ### --interactive, --non-interactive, --ci
956 | Enable/disable interactive prompts. Defaults to non-interactive if the CI environment variable is set. Interactive MainNet deployments prompt for confirmation.
957 |
958 |
959 | ### -P, --path <path>
960 | Specify the project directory. If not provided, current working directory will be used.
961 |
962 |
963 | ### --deployer <deployer_alias>
964 | (Optional) Alias of the deployer account. Otherwise, will prompt the deployer mnemonic if specified in .algokit.toml file.
965 |
966 |
967 | ### --dispenser <dispenser_alias>
968 | (Optional) Alias of the dispenser account. Otherwise, will prompt the dispenser mnemonic if specified in .algokit.toml file.
969 |
970 |
971 | ### -p, --project-name <value>
972 | (Optional) Projects to execute the command on. Defaults to all projects found in the current directory. Option is mutually exclusive with command.
973 |
974 | ### Arguments
975 |
976 |
977 | ### ENVIRONMENT_NAME
978 | Optional argument
979 |
980 |
981 | ### EXTRA_ARGS
982 | Optional argument(s)
983 |
984 | ### link
985 |
986 | Automatically invoke 'algokit generate client' on contract projects available in the workspace.
987 | Must be invoked from the root of a standalone 'frontend' typed project.
988 |
989 | ```shell
990 | algokit project link [OPTIONS]
991 | ```
992 |
993 | ### Options
994 |
995 |
996 | ### -p, --project-name <value>
997 | Specify contract projects for the command. Defaults to all in the current workspace.
998 |
999 |
1000 | ### -l, --language <language>
1001 | Programming language of the generated client code
1002 |
1003 |
1004 | * **Options**
1005 |
1006 | python | typescript
1007 |
1008 |
1009 |
1010 | ### -a, --all
1011 | Link all contract projects with the frontend project Option is mutually exclusive with project_name.
1012 |
1013 |
1014 | ### -f, --fail-fast
1015 | Exit immediately if at least one client generation process fails
1016 |
1017 |
1018 | ### -v, --version <version>
1019 | The client generator version to pin to, for example, 1.0.0. If no version is specified, AlgoKit checks if the client generator is installed and runs the installed version. If the client generator is not installed, AlgoKit runs the latest version. If a version is specified, AlgoKit checks if an installed version matches and runs the installed version. Otherwise, AlgoKit runs the specified version.
1020 |
1021 | ### list
1022 |
1023 | List all projects in the workspace
1024 |
1025 | ```shell
1026 | algokit project list [OPTIONS] [WORKSPACE_PATH]
1027 | ```
1028 |
1029 | ### Arguments
1030 |
1031 |
1032 | ### WORKSPACE_PATH
1033 | Optional argument
1034 |
1035 | ### run
1036 |
1037 | Define custom commands and manage their execution in you projects.
1038 |
1039 | ```shell
1040 | algokit project run [OPTIONS] COMMAND [ARGS]...
1041 | ```
1042 |
1043 | ## task
1044 |
1045 | Collection of useful tasks to help you develop on Algorand.
1046 |
1047 | ```shell
1048 | algokit task [OPTIONS] COMMAND [ARGS]...
1049 | ```
1050 |
1051 | ### analyze
1052 |
1053 | Analyze TEAL programs for common vulnerabilities using Tealer. This task uses a third party tool to suggest improvements for your TEAL programs, but remember to always test your smart contracts code, follow modern software engineering practices and use the guidelines for smart contract development. This should not be used as a substitute for an actual audit. For full list of available detectors, please refer to [https://github.com/crytic/tealer?tab=readme-ov-file#detectors](https://github.com/crytic/tealer?tab=readme-ov-file#detectors)
1054 |
1055 | ```shell
1056 | algokit task analyze [OPTIONS] INPUT_PATHS...
1057 | ```
1058 |
1059 | ### Options
1060 |
1061 |
1062 | ### -r, --recursive
1063 | Recursively search for all TEAL files within the provided directory.
1064 |
1065 |
1066 | ### --force
1067 | Force verification without the disclaimer confirmation prompt.
1068 |
1069 |
1070 | ### --diff
1071 | Exit with a non-zero code if differences are found between current and last reports. Reports are generated each run, but with this flag execution fails if the current report doesn't match the last report. Reports are stored in the .algokit/static-analysis/snapshots folder by default. Use --output for a custom path.
1072 |
1073 |
1074 | ### -o, --output <output_path>
1075 | Directory path where to store the results of the static analysis. Defaults to .algokit/static-analysis/snapshots.
1076 |
1077 |
1078 | ### -e, --exclude <detectors_to_exclude>
1079 | Exclude specific vulnerabilities from the analysis. Supports multiple exclusions in a single run.
1080 |
1081 | ### Arguments
1082 |
1083 |
1084 | ### INPUT_PATHS
1085 | Required argument(s)
1086 |
1087 | ### ipfs
1088 |
1089 | Upload files to IPFS using Pinata provider.
1090 |
1091 | ```shell
1092 | algokit task ipfs [OPTIONS] COMMAND [ARGS]...
1093 | ```
1094 |
1095 | #### login
1096 |
1097 | Login to Pinata ipfs provider. You will be prompted for your JWT.
1098 |
1099 | ```shell
1100 | algokit task ipfs login [OPTIONS]
1101 | ```
1102 |
1103 | #### logout
1104 |
1105 | Logout of Pinata ipfs provider.
1106 |
1107 | ```shell
1108 | algokit task ipfs logout [OPTIONS]
1109 | ```
1110 |
1111 | #### upload
1112 |
1113 | Upload a file to Pinata ipfs provider. Please note, max file size is 100MB.
1114 |
1115 | ```shell
1116 | algokit task ipfs upload [OPTIONS]
1117 | ```
1118 |
1119 | ### Options
1120 |
1121 |
1122 | ### -f, --file <file_path>
1123 | **Required** Path to the file to upload.
1124 |
1125 |
1126 | ### -n, --name <name>
1127 | Human readable name for this upload, for use in file listings.
1128 |
1129 | ### mint
1130 |
1131 | Mint new fungible or non-fungible assets on Algorand.
1132 |
1133 | ```shell
1134 | algokit task mint [OPTIONS]
1135 | ```
1136 |
1137 | ### Options
1138 |
1139 |
1140 | ### --creator <creator>
1141 | **Required** Address or alias of the asset creator.
1142 |
1143 |
1144 | ### --name <asset_name>
1145 | Asset name.
1146 |
1147 |
1148 | ### -u, --unit <unit_name>
1149 | **Required** Unit name of the asset.
1150 |
1151 |
1152 | ### -t, --total <total>
1153 | Total supply of the asset. Defaults to 1.
1154 |
1155 |
1156 | ### -d, --decimals <decimals>
1157 | Number of decimals. Defaults to 0.
1158 |
1159 |
1160 | ### --nft, --ft
1161 | Whether the asset should be validated as NFT or FT. Refers to NFT by default and validates canonical
1162 | definitions of pure or fractional NFTs as per ARC3 standard.
1163 |
1164 |
1165 | ### -i, --image <image_path>
1166 | **Required** Path to the asset image file to be uploaded to IPFS.
1167 |
1168 |
1169 | ### -m, --metadata <token_metadata_path>
1170 | Path to the ARC19 compliant asset metadata file to be uploaded to IPFS. If not provided,
1171 | a default metadata object will be generated automatically based on asset-name, decimals and image.
1172 | For more details refer to [https://arc.algorand.foundation/ARCs/arc-0003#json-metadata-file-schema](https://arc.algorand.foundation/ARCs/arc-0003#json-metadata-file-schema).
1173 |
1174 |
1175 | ### --mutable, --immutable
1176 | Whether the asset should be mutable or immutable. Refers to ARC19 by default.
1177 |
1178 |
1179 | ### -n, --network <network>
1180 | Network to use. Refers to localnet by default.
1181 |
1182 |
1183 | * **Options**
1184 |
1185 | localnet | testnet | mainnet
1186 |
1187 |
1188 | ### nfd-lookup
1189 |
1190 | Perform a lookup via NFD domain or address, returning the associated address or domain respectively.
1191 |
1192 | ```shell
1193 | algokit task nfd-lookup [OPTIONS] VALUE
1194 | ```
1195 |
1196 | ### Options
1197 |
1198 |
1199 | ### -o, --output <output>
1200 | Output format for NFD API response. Defaults to address|domain resolved.
1201 |
1202 |
1203 | * **Options**
1204 |
1205 | full | tiny | address
1206 |
1207 |
1208 | ### Arguments
1209 |
1210 |
1211 | ### VALUE
1212 | Required argument
1213 |
1214 | ### opt-in
1215 |
1216 | Opt-in to an asset(s). This is required before you can receive an asset. Use -n to specify localnet, testnet, or mainnet. To supply multiple asset IDs, separate them with a whitespace.
1217 |
1218 | ```shell
1219 | algokit task opt-in [OPTIONS] ASSET_IDS...
1220 | ```
1221 |
1222 | ### Options
1223 |
1224 |
1225 | ### -a, --account <account>
1226 | **Required** Address or alias of the signer account.
1227 |
1228 |
1229 | ### -n, --network <network>
1230 | Network to use. Refers to localnet by default.
1231 |
1232 |
1233 | * **Options**
1234 |
1235 | localnet | testnet | mainnet
1236 |
1237 |
1238 | ### Arguments
1239 |
1240 |
1241 | ### ASSET_IDS
1242 | Required argument(s)
1243 |
1244 | ### opt-out
1245 |
1246 | opt-out of an asset(s). You can only opt out of an asset with a zero balance. Use -n to specify localnet, testnet, or mainnet. To supply multiple asset IDs, separate them with a whitespace.
1247 |
1248 | ```shell
1249 | algokit task opt-out [OPTIONS] [ASSET_IDS]...
1250 | ```
1251 |
1252 | ### Options
1253 |
1254 |
1255 | ### -a, --account <account>
1256 | **Required** Address or alias of the signer account.
1257 |
1258 |
1259 | ### --all
1260 | Opt-out of all assets with zero balance.
1261 |
1262 |
1263 | ### -n, --network <network>
1264 | Network to use. Refers to localnet by default.
1265 |
1266 |
1267 | * **Options**
1268 |
1269 | localnet | testnet | mainnet
1270 |
1271 |
1272 | ### Arguments
1273 |
1274 |
1275 | ### ASSET_IDS
1276 | Optional argument(s)
1277 |
1278 | ### send
1279 |
1280 | Send a signed transaction to the given network.
1281 |
1282 | ```shell
1283 | algokit task send [OPTIONS]
1284 | ```
1285 |
1286 | ### Options
1287 |
1288 |
1289 | ### -f, --file <file>
1290 | Single or multiple message pack encoded signed transactions from binary file to send. Option is mutually exclusive with transaction.
1291 |
1292 |
1293 | ### -t, --transaction <transaction>
1294 | Base64 encoded signed transaction to send. Option is mutually exclusive with file.
1295 |
1296 |
1297 | ### -n, --network <network>
1298 | Network to use. Refers to localnet by default.
1299 |
1300 |
1301 | * **Options**
1302 |
1303 | localnet | testnet | mainnet
1304 |
1305 |
1306 | ### sign
1307 |
1308 | Sign goal clerk compatible Algorand transaction(s).
1309 |
1310 | ```shell
1311 | algokit task sign [OPTIONS]
1312 | ```
1313 |
1314 | ### Options
1315 |
1316 |
1317 | ### -a, --account <account>
1318 | **Required** Address or alias of the signer account.
1319 |
1320 |
1321 | ### -f, --file <file>
1322 | Single or multiple message pack encoded transactions from binary file to sign. Option is mutually exclusive with transaction.
1323 |
1324 |
1325 | ### -t, --transaction <transaction>
1326 | Single base64 encoded transaction object to sign. Option is mutually exclusive with file.
1327 |
1328 |
1329 | ### -o, --output <output>
1330 | The output file path to store signed transaction(s).
1331 |
1332 |
1333 | ### --force
1334 | Force signing without confirmation.
1335 |
1336 | ### transfer
1337 |
1338 | Transfer algos or assets from one account to another.
1339 |
1340 | ```shell
1341 | algokit task transfer [OPTIONS]
1342 | ```
1343 |
1344 | ### Options
1345 |
1346 |
1347 | ### -s, --sender <sender>
1348 | **Required** Address or alias of the sender account.
1349 |
1350 |
1351 | ### -r, --receiver <receiver>
1352 | **Required** Address or alias to an account that will receive the asset(s).
1353 |
1354 |
1355 | ### --asset, --id <asset_id>
1356 | Asset ID to transfer. Defaults to 0 (Algo).
1357 |
1358 |
1359 | ### -a, --amount <amount>
1360 | **Required** Amount to transfer.
1361 |
1362 |
1363 | ### --whole-units
1364 | Use whole units (Algos | ASAs) instead of smallest divisible units (for example, microAlgos). Disabled by default.
1365 |
1366 |
1367 | ### -n, --network <network>
1368 | Network to use. Refers to localnet by default.
1369 |
1370 |
1371 | * **Options**
1372 |
1373 | localnet | testnet | mainnet
1374 |
1375 |
1376 | ### vanity-address
1377 |
1378 | Generate a vanity Algorand address. Your KEYWORD can only include letters A - Z and numbers 2 - 7.
1379 | Keeping your KEYWORD under 5 characters will usually result in faster generation.
1380 | Note: The longer the KEYWORD, the longer it may take to generate a matching address.
1381 | Please be patient if you choose a long keyword.
1382 |
1383 | ```shell
1384 | algokit task vanity-address [OPTIONS] KEYWORD
1385 | ```
1386 |
1387 | ### Options
1388 |
1389 |
1390 | ### -m, --match <match>
1391 | Location where the keyword will be included. Default is start.
1392 |
1393 |
1394 | * **Options**
1395 |
1396 | start | anywhere | end
1397 |
1398 |
1399 |
1400 | ### -o, --output <output>
1401 | How the output will be presented.
1402 |
1403 |
1404 | * **Options**
1405 |
1406 | stdout | alias | file
1407 |
1408 |
1409 |
1410 | ### -a, --alias <alias>
1411 | Alias for the address. Required if output is "alias".
1412 |
1413 |
1414 | ### --file-path <output_file_path>
1415 | File path where to dump the output. Required if output is "file".
1416 |
1417 |
1418 | ### -f, --force
1419 | Allow overwriting an aliases without confirmation, if output option is 'alias'.
1420 |
1421 | ### Arguments
1422 |
1423 |
1424 | ### KEYWORD
1425 | Required argument
1426 |
1427 | ### wallet
1428 |
1429 | Create short aliases for your addresses and accounts on AlgoKit CLI.
1430 |
1431 | ```shell
1432 | algokit task wallet [OPTIONS] COMMAND [ARGS]...
1433 | ```
1434 |
1435 | #### add
1436 |
1437 | Add an address or account to be stored against a named alias (at most 50 aliases).
1438 |
1439 | ```shell
1440 | algokit task wallet add [OPTIONS] ALIAS_NAME
1441 | ```
1442 |
1443 | ### Options
1444 |
1445 |
1446 | ### -a, --address <address>
1447 | **Required** The address of the account.
1448 |
1449 |
1450 | ### -m, --mnemonic
1451 | If specified then prompt the user for a mnemonic phrase interactively using masked input.
1452 |
1453 |
1454 | ### -f, --force
1455 | Allow overwriting an existing alias.
1456 |
1457 | ### Arguments
1458 |
1459 |
1460 | ### ALIAS_NAME
1461 | Required argument
1462 |
1463 | #### get
1464 |
1465 | Get an address or account stored against a named alias.
1466 |
1467 | ```shell
1468 | algokit task wallet get [OPTIONS] ALIAS
1469 | ```
1470 |
1471 | ### Arguments
1472 |
1473 |
1474 | ### ALIAS
1475 | Required argument
1476 |
1477 | #### list
1478 |
1479 | List all addresses and accounts stored against a named alias.
1480 |
1481 | ```shell
1482 | algokit task wallet list [OPTIONS]
1483 | ```
1484 |
1485 | #### remove
1486 |
1487 | Remove an address or account stored against a named alias.
1488 |
1489 | ```shell
1490 | algokit task wallet remove [OPTIONS] ALIAS
1491 | ```
1492 |
1493 | ### Options
1494 |
1495 |
1496 | ### -f, --force
1497 | Allow removing an alias without confirmation.
1498 |
1499 | ### Arguments
1500 |
1501 |
1502 | ### ALIAS
1503 | Required argument
1504 |
1505 | #### reset
1506 |
1507 | Remove all aliases.
1508 |
1509 | ```shell
1510 | algokit task wallet reset [OPTIONS]
1511 | ```
1512 |
1513 | ### Options
1514 |
1515 |
1516 | ### -f, --force
1517 | Allow removing all aliases without confirmation.
1518 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/account-manager](../modules/types_account_manager.md) / AccountManager
2 |
3 | # Class: AccountManager
4 |
5 | [types/account-manager](../modules/types_account_manager.md).AccountManager
6 |
7 | Creates and keeps track of signing accounts that can sign transactions for a sending address.
8 |
9 | ## Table of contents
10 |
11 | ### Constructors
12 |
13 | - [constructor](types_account_manager.AccountManager.md#constructor)
14 |
15 | ### Properties
16 |
17 | - [\_accounts](types_account_manager.AccountManager.md#_accounts)
18 | - [\_clientManager](types_account_manager.AccountManager.md#_clientmanager)
19 | - [\_defaultSigner](types_account_manager.AccountManager.md#_defaultsigner)
20 | - [\_kmdAccountManager](types_account_manager.AccountManager.md#_kmdaccountmanager)
21 |
22 | ### Accessors
23 |
24 | - [kmd](types_account_manager.AccountManager.md#kmd)
25 |
26 | ### Methods
27 |
28 | - [\_getComposer](types_account_manager.AccountManager.md#_getcomposer)
29 | - [\_getEnsureFundedAmount](types_account_manager.AccountManager.md#_getensurefundedamount)
30 | - [dispenserFromEnvironment](types_account_manager.AccountManager.md#dispenserfromenvironment)
31 | - [ensureFunded](types_account_manager.AccountManager.md#ensurefunded)
32 | - [ensureFundedFromEnvironment](types_account_manager.AccountManager.md#ensurefundedfromenvironment)
33 | - [ensureFundedFromTestNetDispenserApi](types_account_manager.AccountManager.md#ensurefundedfromtestnetdispenserapi)
34 | - [fromEnvironment](types_account_manager.AccountManager.md#fromenvironment)
35 | - [fromKmd](types_account_manager.AccountManager.md#fromkmd)
36 | - [fromMnemonic](types_account_manager.AccountManager.md#frommnemonic)
37 | - [getAccount](types_account_manager.AccountManager.md#getaccount)
38 | - [getInformation](types_account_manager.AccountManager.md#getinformation)
39 | - [getSigner](types_account_manager.AccountManager.md#getsigner)
40 | - [localNetDispenser](types_account_manager.AccountManager.md#localnetdispenser)
41 | - [logicsig](types_account_manager.AccountManager.md#logicsig)
42 | - [multisig](types_account_manager.AccountManager.md#multisig)
43 | - [random](types_account_manager.AccountManager.md#random)
44 | - [rekeyAccount](types_account_manager.AccountManager.md#rekeyaccount)
45 | - [rekeyed](types_account_manager.AccountManager.md#rekeyed)
46 | - [setDefaultSigner](types_account_manager.AccountManager.md#setdefaultsigner)
47 | - [setSigner](types_account_manager.AccountManager.md#setsigner)
48 | - [setSignerFromAccount](types_account_manager.AccountManager.md#setsignerfromaccount)
49 | - [setSigners](types_account_manager.AccountManager.md#setsigners)
50 | - [signerAccount](types_account_manager.AccountManager.md#signeraccount)
51 |
52 | ## Constructors
53 |
54 | ### constructor
55 |
56 | • **new AccountManager**(`clientManager`): [`AccountManager`](types_account_manager.AccountManager.md)
57 |
58 | Create a new account manager.
59 |
60 | #### Parameters
61 |
62 | | Name | Type | Description |
63 | | :------ | :------ | :------ |
64 | | `clientManager` | [`ClientManager`](types_client_manager.ClientManager.md) | The ClientManager client to use for algod and kmd clients |
65 |
66 | #### Returns
67 |
68 | [`AccountManager`](types_account_manager.AccountManager.md)
69 |
70 | **`Example`**
71 |
72 | ```typescript
73 | const accountManager = new AccountManager(clientManager)
74 | ```
75 |
76 | #### Defined in
77 |
78 | [src/types/account-manager.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L56)
79 |
80 | ## Properties
81 |
82 | ### \_accounts
83 |
84 | • `Private` **\_accounts**: `Object` = `{}`
85 |
86 | #### Index signature
87 |
88 | ▪ [address: `string`]: [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
89 |
90 | #### Defined in
91 |
92 | [src/types/account-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L45)
93 |
94 | ___
95 |
96 | ### \_clientManager
97 |
98 | • `Private` **\_clientManager**: [`ClientManager`](types_client_manager.ClientManager.md)
99 |
100 | #### Defined in
101 |
102 | [src/types/account-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L43)
103 |
104 | ___
105 |
106 | ### \_defaultSigner
107 |
108 | • `Private` `Optional` **\_defaultSigner**: `TransactionSigner`
109 |
110 | #### Defined in
111 |
112 | [src/types/account-manager.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L46)
113 |
114 | ___
115 |
116 | ### \_kmdAccountManager
117 |
118 | • `Private` **\_kmdAccountManager**: [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md)
119 |
120 | #### Defined in
121 |
122 | [src/types/account-manager.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L44)
123 |
124 | ## Accessors
125 |
126 | ### kmd
127 |
128 | • `get` **kmd**(): [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md)
129 |
130 | KMD account manager that allows you to easily get and create accounts using KMD.
131 |
132 | #### Returns
133 |
134 | [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md)
135 |
136 | #### Defined in
137 |
138 | [src/types/account-manager.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L70)
139 |
140 | ## Methods
141 |
142 | ### \_getComposer
143 |
144 | ▸ **_getComposer**(`getSuggestedParams?`): [`TransactionComposer`](types_composer.TransactionComposer.md)
145 |
146 | #### Parameters
147 |
148 | | Name | Type |
149 | | :------ | :------ |
150 | | `getSuggestedParams?` | () => `Promise`\<`SuggestedParams`\> |
151 |
152 | #### Returns
153 |
154 | [`TransactionComposer`](types_composer.TransactionComposer.md)
155 |
156 | #### Defined in
157 |
158 | [src/types/account-manager.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L61)
159 |
160 | ___
161 |
162 | ### \_getEnsureFundedAmount
163 |
164 | ▸ **_getEnsureFundedAmount**(`sender`, `minSpendingBalance`, `minFundingIncrement?`): `Promise`\<`undefined` \| [`AlgoAmount`](types_amount.AlgoAmount.md)\>
165 |
166 | #### Parameters
167 |
168 | | Name | Type |
169 | | :------ | :------ |
170 | | `sender` | `Address` |
171 | | `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) |
172 | | `minFundingIncrement?` | [`AlgoAmount`](types_amount.AlgoAmount.md) |
173 |
174 | #### Returns
175 |
176 | `Promise`\<`undefined` \| [`AlgoAmount`](types_amount.AlgoAmount.md)\>
177 |
178 | #### Defined in
179 |
180 | [src/types/account-manager.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L513)
181 |
182 | ___
183 |
184 | ### dispenserFromEnvironment
185 |
186 | ▸ **dispenserFromEnvironment**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
187 |
188 | Returns an account (with private key loaded) that can act as a dispenser from
189 | environment variables, or against default LocalNet if no environment variables present.
190 |
191 | Note: requires a Node.js environment to execute.
192 |
193 | If present, it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC and optionally
194 | process.env.DISPENSER_SENDER if it's a rekeyed account.
195 |
196 | #### Returns
197 |
198 | `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
199 |
200 | The account
201 |
202 | **`Example`**
203 |
204 | ```typescript
205 | const account = await account.dispenserFromEnvironment()
206 | ```
207 |
208 | #### Defined in
209 |
210 | [src/types/account-manager.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L426)
211 |
212 | ___
213 |
214 | ### ensureFunded
215 |
216 | ▸ **ensureFunded**(`accountToFund`, `dispenserAccount`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
217 |
218 | Funds a given account using a dispenser account as a funding source such that
219 | the given account has a certain amount of Algo free to spend (accounting for
220 | Algo locked in minimum balance requirement).
221 |
222 | https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
223 |
224 | #### Parameters
225 |
226 | | Name | Type | Description |
227 | | :------ | :------ | :------ |
228 | | `accountToFund` | `string` \| `Address` | The account to fund |
229 | | `dispenserAccount` | `string` \| `Address` | The account to use as a dispenser funding source |
230 | | `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) |
231 | | `options?` | \{ `minFundingIncrement?`: [`AlgoAmount`](types_amount.AlgoAmount.md) } & [`SendParams`](../interfaces/types_transaction.SendParams.md) & `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> | Optional parameters to control the funding increment, transaction or execution of the transaction |
232 |
233 | #### Returns
234 |
235 | `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
236 |
237 | - The result of executing the dispensing transaction and the `amountFunded` if funds were needed.
238 | - `undefined` if no funds were needed.
239 |
240 | **`Example`**
241 |
242 | ```typescript
243 | // Basic example
244 | await algorand.account.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1))
245 | // With configuration
246 | await algorand.account.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1),
247 | { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true }
248 | )
249 | ```
250 |
251 | #### Defined in
252 |
253 | [src/types/account-manager.ts:546](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L546)
254 |
255 | ___
256 |
257 | ### ensureFundedFromEnvironment
258 |
259 | ▸ **ensureFundedFromEnvironment**(`accountToFund`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
260 |
261 | Funds a given account using a dispenser account retrieved from the environment,
262 | per the `dispenserFromEnvironment` method, as a funding source such that
263 | the given account has a certain amount of Algo free to spend (accounting for
264 | Algo locked in minimum balance requirement).
265 |
266 | **Note:** requires a Node.js environment to execute.
267 |
268 | The dispenser account is retrieved from the account mnemonic stored in
269 | process.env.DISPENSER_MNEMONIC and optionally process.env.DISPENSER_SENDER
270 | if it's a rekeyed account, or against default LocalNet if no environment variables present.
271 |
272 | https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
273 |
274 | #### Parameters
275 |
276 | | Name | Type | Description |
277 | | :------ | :------ | :------ |
278 | | `accountToFund` | `string` \| `Address` | The account to fund |
279 | | `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) |
280 | | `options?` | \{ `minFundingIncrement?`: [`AlgoAmount`](types_amount.AlgoAmount.md) } & [`SendParams`](../interfaces/types_transaction.SendParams.md) & `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> | Optional parameters to control the funding increment, transaction or execution of the transaction |
281 |
282 | #### Returns
283 |
284 | `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
285 |
286 | - The result of executing the dispensing transaction and the `amountFunded` if funds were needed.
287 | - `undefined` if no funds were needed.
288 |
289 | **`Example`**
290 |
291 | ```typescript
292 | // Basic example
293 | await algorand.account.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1))
294 | // With configuration
295 | await algorand.account.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1),
296 | { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true }
297 | )
298 | ```
299 |
300 | #### Defined in
301 |
302 | [src/types/account-manager.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L608)
303 |
304 | ___
305 |
306 | ### ensureFundedFromTestNetDispenserApi
307 |
308 | ▸ **ensureFundedFromTestNetDispenserApi**(`accountToFund`, `dispenserClient`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
309 |
310 | Funds a given account using the TestNet Dispenser API as a funding source such that
311 | the account has a certain amount of Algo free to spend (accounting for Algo locked
312 | in minimum balance requirement).
313 |
314 | https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
315 |
316 | #### Parameters
317 |
318 | | Name | Type | Description |
319 | | :------ | :------ | :------ |
320 | | `accountToFund` | `string` \| `Address` | The account to fund |
321 | | `dispenserClient` | [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) | The TestNet dispenser funding client |
322 | | `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) |
323 | | `options?` | `Object` | Optional parameters to control the funding increment, transaction or execution of the transaction |
324 | | `options.minFundingIncrement?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | - |
325 |
326 | #### Returns
327 |
328 | `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
329 |
330 | - The result of executing the dispensing transaction and the `amountFunded` if funds were needed.
331 | - `undefined` if no funds were needed.
332 |
333 | **`Example`**
334 |
335 | ```typescript
336 | // Basic example
337 | await algorand.account.ensureFundedUsingDispenserAPI("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1))
338 | // With configuration
339 | await algorand.account.ensureFundedUsingDispenserAPI("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1),
340 | { minFundingIncrement: algokit.algo(2) }
341 | )
342 | ```
343 |
344 | #### Defined in
345 |
346 | [src/types/account-manager.ts:664](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L664)
347 |
348 | ___
349 |
350 | ### fromEnvironment
351 |
352 | ▸ **fromEnvironment**(`name`, `fundWith?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
353 |
354 | Tracks and returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
355 |
356 | Note: This function expects to run in a Node.js environment.
357 |
358 | ## Convention:
359 | * **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
360 | never commit it into source control and ideally load it via a secret storage service rather than the file system.
361 | If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
362 | * **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
363 |
364 | 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).
365 |
366 | #### Parameters
367 |
368 | | Name | Type | Description |
369 | | :------ | :------ | :------ |
370 | | `name` | `string` | The name identifier of the account |
371 | | `fundWith?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The optional 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 |
372 |
373 | #### Returns
374 |
375 | `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
376 |
377 | The account
378 |
379 | **`Example`**
380 |
381 | 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:
382 | ```typescript
383 | const account = await accountManager.fromEnvironment('MY_ACCOUNT')
384 | ```
385 |
386 | 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.
387 | 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.
388 |
389 | #### Defined in
390 |
391 | [src/types/account-manager.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L319)
392 |
393 | ___
394 |
395 | ### fromKmd
396 |
397 | ▸ **fromKmd**(`name`, `predicate?`, `sender?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
398 |
399 | Tracks and returns an Algorand account with private key loaded from the given KMD wallet (identified by name).
400 |
401 | #### Parameters
402 |
403 | | Name | Type | Description |
404 | | :------ | :------ | :------ |
405 | | `name` | `string` | The name of the wallet to retrieve an account from |
406 | | `predicate?` | (`account`: `Record`\<`string`, `any`\>) => `boolean` | An optional filter to use to find the account (otherwise it will return a random account from the wallet) |
407 | | `sender?` | `string` \| `Address` | The optional sender address to use this signer for (aka a rekeyed account) |
408 |
409 | #### Returns
410 |
411 | `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
412 |
413 | The account
414 |
415 | **`Example`**
416 |
417 | ```typescript
418 | const defaultDispenserAccount = await account.fromKmd('unencrypted-default-wallet',
419 | a => a.status !== 'Offline' && a.amount > 1_000_000_000
420 | )
421 | ```
422 |
423 | #### Defined in
424 |
425 | [src/types/account-manager.ts:355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L355)
426 |
427 | ___
428 |
429 | ### fromMnemonic
430 |
431 | ▸ **fromMnemonic**(`mnemonicSecret`, `sender?`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }
432 |
433 | Tracks and returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
434 |
435 | #### Parameters
436 |
437 | | Name | Type | Description |
438 | | :------ | :------ | :------ |
439 | | `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. |
440 | | `sender?` | `string` \| `Address` | The optional sender address to use this signer for (aka a rekeyed account) |
441 |
442 | #### Returns
443 |
444 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }
445 |
446 | The account
447 |
448 | **`Example`**
449 |
450 | ```typescript
451 | const account = accountManager.fromMnemonic("mnemonic secret ...")
452 | const rekeyedAccount = accountManager.fromMnemonic("mnemonic secret ...", "SENDERADDRESS...")
453 | ```
454 |
455 | #### Defined in
456 |
457 | [src/types/account-manager.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L271)
458 |
459 | ___
460 |
461 | ### getAccount
462 |
463 | ▸ **getAccount**(`sender`): [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
464 |
465 | Returns the `TransactionSignerAccount` for the given sender address.
466 |
467 | If no signer has been registered for that address then an error is thrown.
468 |
469 | #### Parameters
470 |
471 | | Name | Type | Description |
472 | | :------ | :------ | :------ |
473 | | `sender` | `string` \| `Address` | The sender address |
474 |
475 | #### Returns
476 |
477 | [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
478 |
479 | The `TransactionSignerAccount` or throws an error if not found
480 |
481 | **`Example`**
482 |
483 | ```typescript
484 | const sender = accountManager.random()
485 | // ...
486 | // Returns the `TransactionSignerAccount` for `sender` that has previously been registered
487 | const account = accountManager.getAccount(sender)
488 | ```
489 |
490 | #### Defined in
491 |
492 | [src/types/account-manager.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L207)
493 |
494 | ___
495 |
496 | ### getInformation
497 |
498 | ▸ **getInformation**(`sender`): `Promise`\<[`AccountInformation`](../modules/types_account.md#accountinformation)\>
499 |
500 | Returns the given sender account's current status, balance and spendable amounts.
501 |
502 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
503 |
504 | #### Parameters
505 |
506 | | Name | Type | Description |
507 | | :------ | :------ | :------ |
508 | | `sender` | `string` \| `Address` | The account / address to look up |
509 |
510 | #### Returns
511 |
512 | `Promise`\<[`AccountInformation`](../modules/types_account.md#accountinformation)\>
513 |
514 | The account information
515 |
516 | **`Example`**
517 |
518 | ```typescript
519 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
520 | const accountInfo = await accountManager.getInformation(address);
521 | ```
522 |
523 | #### Defined in
524 |
525 | [src/types/account-manager.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L226)
526 |
527 | ___
528 |
529 | ### getSigner
530 |
531 | ▸ **getSigner**(`sender`): `TransactionSigner`
532 |
533 | Returns the `TransactionSigner` for the given sender address, ready to sign a transaction for that sender.
534 |
535 | If no signer has been registered for that address then the default signer is used if registered and
536 | if not then an error is thrown.
537 |
538 | #### Parameters
539 |
540 | | Name | Type | Description |
541 | | :------ | :------ | :------ |
542 | | `sender` | `string` \| `Address` | The sender address |
543 |
544 | #### Returns
545 |
546 | `TransactionSigner`
547 |
548 | The `TransactionSigner` or throws an error if not found and no default signer is set
549 |
550 | **`Example`**
551 |
552 | ```typescript
553 | const signer = accountManager.getSigner("SENDERADDRESS")
554 | ```
555 |
556 | #### Defined in
557 |
558 | [src/types/account-manager.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L187)
559 |
560 | ___
561 |
562 | ### localNetDispenser
563 |
564 | ▸ **localNetDispenser**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
565 |
566 | Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).
567 |
568 | #### Returns
569 |
570 | `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
571 |
572 | The account
573 |
574 | **`Example`**
575 |
576 | ```typescript
577 | const account = await account.localNetDispenser()
578 | ```
579 |
580 | #### Defined in
581 |
582 | [src/types/account-manager.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L445)
583 |
584 | ___
585 |
586 | ### logicsig
587 |
588 | ▸ **logicsig**(`program`, `args?`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `LogicSigAccount` }
589 |
590 | Tracks and returns an account that represents a logic signature.
591 |
592 | #### Parameters
593 |
594 | | Name | Type | Description |
595 | | :------ | :------ | :------ |
596 | | `program` | `Uint8Array` | The bytes that make up the compiled logic signature |
597 | | `args?` | `Uint8Array`[] | The (binary) arguments to pass into the logic signature |
598 |
599 | #### Returns
600 |
601 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `LogicSigAccount` }
602 |
603 | A logic signature account wrapper
604 |
605 | **`Example`**
606 |
607 | ```typescript
608 | const account = account.logicsig(program, [new Uint8Array(3, ...)])
609 | ```
610 |
611 | #### Defined in
612 |
613 | [src/types/account-manager.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L393)
614 |
615 | ___
616 |
617 | ### multisig
618 |
619 | ▸ **multisig**(`multisigParams`, `signingAccounts`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`MultisigAccount`](types_account.MultisigAccount.md) }
620 |
621 | Tracks and returns an account that supports partial or full multisig signing.
622 |
623 | #### Parameters
624 |
625 | | Name | Type | Description |
626 | | :------ | :------ | :------ |
627 | | `multisigParams` | `MultisigMetadata` | The parameters that define the multisig account |
628 | | `signingAccounts` | (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] | The signers that are currently present |
629 |
630 | #### Returns
631 |
632 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`MultisigAccount`](types_account.MultisigAccount.md) }
633 |
634 | A multisig account wrapper
635 |
636 | **`Example`**
637 |
638 | ```typescript
639 | const account = accountManager.multisig({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]},
640 | [(await accountManager.fromEnvironment('ACCOUNT1')).account])
641 | ```
642 |
643 | #### Defined in
644 |
645 | [src/types/account-manager.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L378)
646 |
647 | ___
648 |
649 | ### random
650 |
651 | ▸ **random**(): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `default` }
652 |
653 | Tracks and returns a new, random Algorand account with secret key loaded.
654 |
655 | #### Returns
656 |
657 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `default` }
658 |
659 | The account
660 |
661 | **`Example`**
662 |
663 | ```typescript
664 | const account = account.random()
665 | ```
666 |
667 | #### Defined in
668 |
669 | [src/types/account-manager.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L406)
670 |
671 | ___
672 |
673 | ### rekeyAccount
674 |
675 | ▸ **rekeyAccount**(`account`, `rekeyTo`, `options?`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
676 |
677 | Rekey an account to a new address.
678 |
679 | **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/).
680 |
681 | #### Parameters
682 |
683 | | Name | Type | Description |
684 | | :------ | :------ | :------ |
685 | | `account` | `string` \| `Address` | The account to rekey |
686 | | `rekeyTo` | `string` \| `Address` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The account address or signing account of the account that will be used to authorise transactions for the rekeyed account going forward. If a signing account is provided that will now be tracked as the signer for `account` in this `AccountManager` |
687 | | `options?` | `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> & [`SendParams`](../interfaces/types_transaction.SendParams.md) | Any parameters to control the transaction or execution of the transaction |
688 |
689 | #### Returns
690 |
691 | `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
692 |
693 | The result of the transaction and the transaction that was sent
694 |
695 | **`Example`**
696 |
697 | ```typescript
698 | await algorand.account.rekeyAccount({account: "ACCOUNTADDRESS", rekeyTo: "NEWADDRESS"})
699 | ```
700 |
701 | **`Example`**
702 |
703 | ```typescript
704 | await algorand.account.rekeyAccount({account: account1, rekeyTo: newSignerAccount})
705 | ```
706 |
707 | **`Example`**
708 |
709 | ```typescript
710 | await algorand.account.rekeyAccount({
711 | account: "ACCOUNTADDRESS",
712 | rekeyTo: "NEWADDRESS",
713 | lease: 'lease',
714 | note: 'note',
715 | firstValidRound: 1000n,
716 | validityWindow: 10,
717 | extraFee: (1000).microAlgo(),
718 | staticFee: (1000).microAlgo(),
719 | // Max fee doesn't make sense with extraFee AND staticFee
720 | // already specified, but here for completeness
721 | maxFee: (3000).microAlgo(),
722 | maxRoundsToWaitForConfirmation: 5,
723 | suppressLog: true,
724 | })
725 | ```
726 |
727 | #### Defined in
728 |
729 | [src/types/account-manager.ts:488](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L488)
730 |
731 | ___
732 |
733 | ### rekeyed
734 |
735 | ▸ **rekeyed**(`sender`, `account`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: \{ `addr`: `Address` ; `signer`: `TransactionSigner` = account.signer } }
736 |
737 | Tracks and returns an Algorand account that is a rekeyed version of the given account to a new sender.
738 |
739 | #### Parameters
740 |
741 | | Name | Type | Description |
742 | | :------ | :------ | :------ |
743 | | `sender` | `string` \| `Address` | The sender address to use as the new sender |
744 | | `account` | [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The account to use as the signer for this new rekeyed account |
745 |
746 | #### Returns
747 |
748 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: \{ `addr`: `Address` ; `signer`: `TransactionSigner` = account.signer } }
749 |
750 | The account
751 |
752 | **`Example`**
753 |
754 | ```typescript
755 | const account = account.fromMnemonic("mnemonic secret ...")
756 | const rekeyedAccount = accountManager.rekeyed(account, "SENDERADDRESS...")
757 | ```
758 |
759 | #### Defined in
760 |
761 | [src/types/account-manager.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L288)
762 |
763 | ___
764 |
765 | ### setDefaultSigner
766 |
767 | ▸ **setDefaultSigner**(`signer`): [`AccountManager`](types_account_manager.AccountManager.md)
768 |
769 | Sets the default signer to use if no other signer is specified.
770 |
771 | If this isn't set an a transaction needs signing for a given sender
772 | then an error will be thrown from `getSigner` / `getAccount`.
773 |
774 | #### Parameters
775 |
776 | | Name | Type | Description |
777 | | :------ | :------ | :------ |
778 | | `signer` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The signer to use, either a `TransactionSigner` or a `TransactionSignerAccount` |
779 |
780 | #### Returns
781 |
782 | [`AccountManager`](types_account_manager.AccountManager.md)
783 |
784 | The `AccountManager` so method calls can be chained
785 |
786 | **`Example`**
787 |
788 | ```typescript
789 | const signer = accountManager.random() // Can be anything that returns a `algosdk.TransactionSigner` or `TransactionSignerAccount`
790 | accountManager.setDefaultSigner(signer)
791 |
792 | // When signing a transaction, if there is no signer registered for the sender then the default signer will be used
793 | const signer = accountManager.getSigner("{SENDERADDRESS}")
794 | ```
795 |
796 | #### Defined in
797 |
798 | [src/types/account-manager.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L90)
799 |
800 | ___
801 |
802 | ### setSigner
803 |
804 | ▸ **setSigner**(`sender`, `signer`): [`AccountManager`](types_account_manager.AccountManager.md)
805 |
806 | Tracks the given `algosdk.TransactionSigner` against the given sender address for later signing.
807 |
808 | #### Parameters
809 |
810 | | Name | Type | Description |
811 | | :------ | :------ | :------ |
812 | | `sender` | `string` \| `Address` | The sender address to use this signer for |
813 | | `signer` | `TransactionSigner` | The `algosdk.TransactionSigner` to sign transactions with for the given sender |
814 |
815 | #### Returns
816 |
817 | [`AccountManager`](types_account_manager.AccountManager.md)
818 |
819 | The `AccountManager` instance for method chaining
820 |
821 | **`Example`**
822 |
823 | ```typescript
824 | const accountManager = new AccountManager(clientManager)
825 | .setSigner("SENDERADDRESS", transactionSigner)
826 | ```
827 |
828 | #### Defined in
829 |
830 | [src/types/account-manager.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L154)
831 |
832 | ___
833 |
834 | ### setSignerFromAccount
835 |
836 | ▸ **setSignerFromAccount**(`account`): [`AccountManager`](types_account_manager.AccountManager.md)
837 |
838 | Tracks the given account for later signing.
839 |
840 | Note: If you are generating accounts via the various methods on `AccountManager`
841 | (like `random`, `fromMnemonic`, `logicsig`, etc.) then they automatically get tracked.
842 |
843 | #### Parameters
844 |
845 | | Name | Type | Description |
846 | | :------ | :------ | :------ |
847 | | `account` | [`MultisigAccount`](types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` | The account to register, which can be a `TransactionSignerAccount` or a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` |
848 |
849 | #### Returns
850 |
851 | [`AccountManager`](types_account_manager.AccountManager.md)
852 |
853 | The `AccountManager` instance for method chaining
854 |
855 | **`Example`**
856 |
857 | ```typescript
858 | const accountManager = new AccountManager(clientManager)
859 | .setSignerFromAccount(algosdk.generateAccount())
860 | .setSignerFromAccount(new algosdk.LogicSigAccount(program, args))
861 | .setSignerFromAccount(new SigningAccount(mnemonic, sender))
862 | .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2]))
863 | .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner})
864 | ```
865 |
866 | #### Defined in
867 |
868 | [src/types/account-manager.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L138)
869 |
870 | ___
871 |
872 | ### setSigners
873 |
874 | ▸ **setSigners**(`anotherAccountManager`, `overwriteExisting?`): `void`
875 |
876 | Takes all registered signers from the given `AccountManager` and adds them to this `AccountManager`.
877 |
878 | This is useful for situations where you have multiple contexts you are building accounts in such as unit tests.
879 |
880 | #### Parameters
881 |
882 | | Name | Type | Default value | Description |
883 | | :------ | :------ | :------ | :------ |
884 | | `anotherAccountManager` | [`AccountManager`](types_account_manager.AccountManager.md) | `undefined` | Another account manager with signers registered |
885 | | `overwriteExisting` | `boolean` | `true` | Whether or not to overwrite any signers that have the same sender address with the ones in the other account manager or not (default: true) |
886 |
887 | #### Returns
888 |
889 | `void`
890 |
891 | The `AccountManager` instance for method chaining
892 |
893 | #### Defined in
894 |
895 | [src/types/account-manager.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L167)
896 |
897 | ___
898 |
899 | ### signerAccount
900 |
901 | ▸ **signerAccount**\<`T`\>(`account`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `T` }
902 |
903 | Records the given account (that can sign) against the address of the provided account for later
904 | retrieval and returns a `TransactionSignerAccount` along with the original account in an `account` property.
905 |
906 | #### Type parameters
907 |
908 | | Name | Type |
909 | | :------ | :------ |
910 | | `T` | extends [`MultisigAccount`](types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` |
911 |
912 | #### Parameters
913 |
914 | | Name | Type |
915 | | :------ | :------ |
916 | | `account` | `T` |
917 |
918 | #### Returns
919 |
920 | `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `T` }
921 |
922 | #### Defined in
923 |
924 | [src/types/account-manager.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L100)
925 |
```