This is page 55 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/SDKs:javascript:classes:Algodv2.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / Algodv2
2 |
3 | # Class: Algodv2
4 |
5 | Algod client connects an application to the Algorand blockchain. The algod client requires a valid algod REST endpoint IP address and algod token from an Algorand node that is connected to the network you plan to interact with.
6 |
7 | Algod is the main Algorand process for handling the blockchain. Messages between nodes are processed, the protocol steps are executed, and the blocks are written to disk. The algod process also exposes a REST API server that developers can use to communicate with the node and the network. Algod uses the data directory for storage and configuration information.
8 |
9 | #### Relevant Information
10 | [How do I obtain an algod address and token?](https://developer.algorand.org/docs/archive/build-apps/setup/?from_query=algod#how-do-i-obtain-an-algod-address-and-token)
11 |
12 | [Run Algod in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/?from_query=algod#algod-indexer-and-kmd-rest-endpoints)
13 |
14 | ## Hierarchy
15 |
16 | - `default`
17 |
18 | ↳ **`Algodv2`**
19 |
20 | ## Table of contents
21 |
22 | ### Constructors
23 |
24 | - [constructor](Algodv2.md#constructor)
25 |
26 | ### DELETE Methods
27 |
28 | - [unsetSyncRound](Algodv2.md#unsetsyncround)
29 |
30 | ### GET Methods
31 |
32 | - [accountApplicationInformation](Algodv2.md#accountapplicationinformation)
33 | - [accountAssetInformation](Algodv2.md#accountassetinformation)
34 | - [accountInformation](Algodv2.md#accountinformation)
35 | - [block](Algodv2.md#block)
36 | - [genesis](Algodv2.md#genesis)
37 | - [getApplicationBoxByName](Algodv2.md#getapplicationboxbyname)
38 | - [getApplicationBoxes](Algodv2.md#getapplicationboxes)
39 | - [getApplicationByID](Algodv2.md#getapplicationbyid)
40 | - [getAssetByID](Algodv2.md#getassetbyid)
41 | - [getBlockHash](Algodv2.md#getblockhash)
42 | - [getBlockOffsetTimestamp](Algodv2.md#getblockoffsettimestamp)
43 | - [getBlockTxids](Algodv2.md#getblocktxids)
44 | - [getLedgerStateDelta](Algodv2.md#getledgerstatedelta)
45 | - [getLedgerStateDeltaForTransactionGroup](Algodv2.md#getledgerstatedeltafortransactiongroup)
46 | - [getSyncRound](Algodv2.md#getsyncround)
47 | - [getTransactionGroupLedgerStateDeltasForRound](Algodv2.md#gettransactiongroupledgerstatedeltasforround)
48 | - [getTransactionParams](Algodv2.md#gettransactionparams)
49 | - [getTransactionProof](Algodv2.md#gettransactionproof)
50 | - [healthCheck](Algodv2.md#healthcheck)
51 | - [pendingTransactionByAddress](Algodv2.md#pendingtransactionbyaddress)
52 | - [pendingTransactionInformation](Algodv2.md#pendingtransactioninformation)
53 | - [pendingTransactionsInformation](Algodv2.md#pendingtransactionsinformation)
54 | - [ready](Algodv2.md#ready)
55 | - [status](Algodv2.md#status)
56 | - [statusAfterBlock](Algodv2.md#statusafterblock)
57 | - [supply](Algodv2.md#supply)
58 | - [versionsCheck](Algodv2.md#versionscheck)
59 |
60 | ### Other Methods
61 |
62 | - [disassemble](Algodv2.md#disassemble)
63 | - [getIntEncoding](Algodv2.md#getintencoding)
64 | - [getLightBlockHeaderProof](Algodv2.md#getlightblockheaderproof)
65 | - [getStateProof](Algodv2.md#getstateproof)
66 | - [setIntEncoding](Algodv2.md#setintencoding)
67 |
68 | ### POST Methods
69 |
70 | - [compile](Algodv2.md#compile)
71 | - [dryrun](Algodv2.md#dryrun)
72 | - [sendRawTransaction](Algodv2.md#sendrawtransaction)
73 | - [setBlockOffsetTimestamp](Algodv2.md#setblockoffsettimestamp)
74 | - [setSyncRound](Algodv2.md#setsyncround)
75 | - [simulateRawTransactions](Algodv2.md#simulaterawtransactions)
76 | - [simulateTransactions](Algodv2.md#simulatetransactions)
77 |
78 | ## Constructors
79 |
80 | ### constructor
81 |
82 | • **new Algodv2**(`tokenOrBaseClient`, `baseServer`, `port?`, `headers?`)
83 |
84 | Create an AlgodClient from
85 | * either a token, baseServer, port, and optional headers
86 | * or a base client server for interoperability with external dApp wallets
87 |
88 | #### Example
89 | ```typescript
90 | const token = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
91 | const server = "http://localhost";
92 | const port = 4001;
93 | const algodClient = new algosdk.Algodv2(token, server, port);
94 | ```
95 |
96 | #### Parameters
97 |
98 | | Name | Type | Description |
99 | | :------ | :------ | :------ |
100 | | `tokenOrBaseClient` | `string` \| [`BaseHTTPClient`](../interfaces/BaseHTTPClient.md) \| [`AlgodTokenHeader`](../interfaces/AlgodTokenHeader.md) \| [`CustomTokenHeader`](../interfaces/CustomTokenHeader.md) | The algod token from the Algorand node you are interacting with |
101 | | `baseServer` | `string` | REST endpoint |
102 | | `port?` | `string` \| `number` | Port number if specifically configured by the server |
103 | | `headers` | `Record`\<`string`, `string`\> | Optional headers |
104 |
105 | **`Remarks`**
106 |
107 | The above configuration is for a sandbox private network.
108 | For applications on production, you are encouraged to run your own node, or use an Algorand REST API provider with a dedicated API key.
109 |
110 | #### Overrides
111 |
112 | ServiceClient.constructor
113 |
114 | #### Defined in
115 |
116 | client/v2/algod/algod.ts:80
117 |
118 | ## DELETE Methods
119 |
120 | ### unsetSyncRound
121 |
122 | ▸ **unsetSyncRound**(): `default`
123 |
124 | Un-Set the sync round on the ledger (algod must have EnableFollowMode: true), removing the restriction on catchup.
125 |
126 | #### Example
127 | ```typesecript
128 | await client.unsetSyncRound().do();
129 | ```
130 |
131 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#delete-v2ledgersync)
132 |
133 | #### Returns
134 |
135 | `default`
136 |
137 | #### Defined in
138 |
139 | client/v2/algod/algod.ts:742
140 |
141 | ___
142 |
143 | ## GET Methods
144 |
145 | ### accountApplicationInformation
146 |
147 | ▸ **accountApplicationInformation**(`account`, `index`): `default`
148 |
149 | Returns the given account's application information for a specific application.
150 |
151 | #### Example
152 | ```typescript
153 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
154 | const index = 60553466;
155 | const accountInfo = await algodClient.accountApplicationInformation(address, index).do();
156 | ```
157 |
158 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
159 |
160 | #### Parameters
161 |
162 | | Name | Type | Description |
163 | | :------ | :------ | :------ |
164 | | `account` | `string` | The address of the account to look up. |
165 | | `index` | `number` | The application ID to look up. |
166 |
167 | #### Returns
168 |
169 | `default`
170 |
171 | #### Defined in
172 |
173 | client/v2/algod/algod.ts:199
174 |
175 | ___
176 |
177 | ### accountAssetInformation
178 |
179 | ▸ **accountAssetInformation**(`account`, `index`): `default`
180 |
181 | Returns the given account's asset information for a specific asset.
182 |
183 | #### Example
184 | ```typescript
185 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
186 | const index = 60553466;
187 | const accountAssetInfo = await algodClient.accountAssetInformation(address, index).do();
188 | ```
189 |
190 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
191 |
192 | #### Parameters
193 |
194 | | Name | Type | Description |
195 | | :------ | :------ | :------ |
196 | | `account` | `string` | The address of the account to look up. |
197 | | `index` | `number` | The asset ID to look up. |
198 |
199 | #### Returns
200 |
201 | `default`
202 |
203 | #### Defined in
204 |
205 | client/v2/algod/algod.ts:175
206 |
207 | ___
208 |
209 | ### accountInformation
210 |
211 | ▸ **accountInformation**(`account`): `default`
212 |
213 | Returns the given account's status, balance and spendable amounts.
214 |
215 | #### Example
216 | ```typescript
217 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
218 | const accountInfo = await algodClient.accountInformation(address).do();
219 | ```
220 |
221 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
222 |
223 | #### Parameters
224 |
225 | | Name | Type | Description |
226 | | :------ | :------ | :------ |
227 | | `account` | `string` | The address of the account to look up. |
228 |
229 | #### Returns
230 |
231 | `default`
232 |
233 | #### Defined in
234 |
235 | client/v2/algod/algod.ts:156
236 |
237 | ___
238 |
239 | ### block
240 |
241 | ▸ **block**(`roundNumber`): `default`
242 |
243 | Gets the block info for the given round.
244 |
245 | #### Example
246 | ```typescript
247 | const roundNumber = 18038133;
248 | const block = await algodClient.block(roundNumber).do();
249 | ```
250 |
251 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksround)
252 |
253 | #### Parameters
254 |
255 | | Name | Type | Description |
256 | | :------ | :------ | :------ |
257 | | `roundNumber` | `number` | The round number of the block to get. |
258 |
259 | #### Returns
260 |
261 | `default`
262 |
263 | #### Defined in
264 |
265 | client/v2/algod/algod.ts:221
266 |
267 | ___
268 |
269 | ### genesis
270 |
271 | ▸ **genesis**(): `default`
272 |
273 | Returns the entire genesis file.
274 |
275 | #### Example
276 | ```typescript
277 | const genesis = await algodClient.genesis().do();
278 | ```
279 |
280 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-genesis)
281 |
282 | #### Returns
283 |
284 | `default`
285 |
286 | #### Defined in
287 |
288 | client/v2/algod/algod.ts:554
289 |
290 | ___
291 |
292 | ### getApplicationBoxByName
293 |
294 | ▸ **getApplicationBoxByName**(`index`, `boxName`): `default`
295 |
296 | Given an application ID and the box name (key), return the value stored in the box.
297 |
298 | #### Example
299 | ```typescript
300 | const index = 60553466;
301 | const boxName = Buffer.from("foo");
302 | const boxResponse = await algodClient.getApplicationBoxByName(index, boxName).do();
303 | const boxValue = boxResponse.value;
304 | ```
305 |
306 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idbox)
307 |
308 | #### Parameters
309 |
310 | | Name | Type | Description |
311 | | :------ | :------ | :------ |
312 | | `index` | `number` | The application ID to look up. |
313 | | `boxName` | `Uint8Array` | - |
314 |
315 | #### Returns
316 |
317 | `default`
318 |
319 | #### Defined in
320 |
321 | client/v2/algod/algod.ts:516
322 |
323 | ___
324 |
325 | ### getApplicationBoxes
326 |
327 | ▸ **getApplicationBoxes**(`index`): `default`
328 |
329 | Given an application ID, return all the box names associated with the app.
330 |
331 | #### Example
332 | ```typescript
333 | const index = 60553466;
334 | const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
335 | const boxNames = boxesResponse.boxes.map(box => box.name);
336 | ```
337 |
338 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
339 |
340 | #### Parameters
341 |
342 | | Name | Type | Description |
343 | | :------ | :------ | :------ |
344 | | `index` | `number` | The application ID to look up. |
345 |
346 | #### Returns
347 |
348 | `default`
349 |
350 | #### Defined in
351 |
352 | client/v2/algod/algod.ts:539
353 |
354 | ___
355 |
356 | ### getApplicationByID
357 |
358 | ▸ **getApplicationByID**(`index`): `default`
359 |
360 | Given an application ID, return the application information including creator, approval
361 | and clear programs, global and local schemas, and global state.
362 |
363 | #### Example
364 | ```typescript
365 | const index = 60553466;
366 | const app = await algodClient.getApplicationByID(index).do();
367 | ```
368 |
369 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-id)
370 |
371 | #### Parameters
372 |
373 | | Name | Type | Description |
374 | | :------ | :------ | :------ |
375 | | `index` | `number` | The application ID to look up. |
376 |
377 | #### Returns
378 |
379 | `default`
380 |
381 | #### Defined in
382 |
383 | client/v2/algod/algod.ts:497
384 |
385 | ___
386 |
387 | ### getAssetByID
388 |
389 | ▸ **getAssetByID**(`index`): `default`
390 |
391 | Given an asset ID, return asset information including creator, name, total supply and
392 | special addresses.
393 |
394 | #### Example
395 | ```typescript
396 | const asset_id = 163650;
397 | const asset = await algodClient.getAssetByID(asset_id).do();
398 | ```
399 |
400 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2assetsasset-id)
401 |
402 | #### Parameters
403 |
404 | | Name | Type | Description |
405 | | :------ | :------ | :------ |
406 | | `index` | `number` | The asset ID to look up. |
407 |
408 | #### Returns
409 |
410 | `default`
411 |
412 | #### Defined in
413 |
414 | client/v2/algod/algod.ts:479
415 |
416 | ___
417 |
418 | ### getBlockHash
419 |
420 | ▸ **getBlockHash**(`roundNumber`): `default`
421 |
422 | Get the block hash for the block on the given round.
423 |
424 | #### Example
425 | ```typescript
426 | const roundNumber = 18038133;
427 | const block = await algodClient.getBlockHash(roundNumber).do();
428 | ```
429 |
430 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksroundhash)
431 |
432 | #### Parameters
433 |
434 | | Name | Type | Description |
435 | | :------ | :------ | :------ |
436 | | `roundNumber` | `number` | The round number of the block to get. |
437 |
438 | #### Returns
439 |
440 | `default`
441 |
442 | #### Defined in
443 |
444 | client/v2/algod/algod.ts:238
445 |
446 | ___
447 |
448 | ### getBlockOffsetTimestamp
449 |
450 | ▸ **getBlockOffsetTimestamp**(): `default`
451 |
452 | Get the offset (in seconds) applied to the block timestamp when creating new blocks in devmode.
453 |
454 | #### Example
455 | ```typesecript
456 | const currentOffset = await client.getBlockOffsetTimestamp().do();
457 | ```
458 |
459 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2devmodeblocksoffset)
460 |
461 | #### Returns
462 |
463 | `default`
464 |
465 | #### Defined in
466 |
467 | client/v2/algod/algod.ts:710
468 |
469 | ___
470 |
471 | ### getBlockTxids
472 |
473 | ▸ **getBlockTxids**(`roundNumber`): `default`
474 |
475 | Get the top level transaction IDs for the block on the given round.
476 |
477 | #### Example
478 | ```typescript
479 | const roundNumber = 18038133;
480 | const block = await algodClient.getBlockTxids(roundNumber).do();
481 | ```
482 |
483 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksroundtxids)
484 |
485 | #### Parameters
486 |
487 | | Name | Type | Description |
488 | | :------ | :------ | :------ |
489 | | `roundNumber` | `number` | The round number of the block to get. |
490 |
491 | #### Returns
492 |
493 | `default`
494 |
495 | #### Defined in
496 |
497 | client/v2/algod/algod.ts:255
498 |
499 | ___
500 |
501 | ### getLedgerStateDelta
502 |
503 | ▸ **getLedgerStateDelta**(`round`): `default`
504 |
505 | GetLedgerStateDelta returns the ledger delta for the entire round
506 |
507 | #### Example
508 | ```typescript
509 | const round = 12345;
510 | await client.getLedgerStateDelta(round).do();
511 | ```
512 |
513 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasround)
514 |
515 | #### Parameters
516 |
517 | | Name | Type | Description |
518 | | :------ | :------ | :------ |
519 | | `round` | `bigint` | the round number to be searched for |
520 |
521 | #### Returns
522 |
523 | `default`
524 |
525 | #### Defined in
526 |
527 | client/v2/algod/algod.ts:810
528 |
529 | ___
530 |
531 | ### getLedgerStateDeltaForTransactionGroup
532 |
533 | ▸ **getLedgerStateDeltaForTransactionGroup**(`id`): `default`
534 |
535 | GetLedgerStateDeltaForTransactionGroup returns the ledger delta for the txn group identified by id
536 |
537 | #### Example
538 | ```typescript
539 | const id = "ABC123";
540 | await client.getLedgerStateDeltaForTransactionGroup(id).do();
541 | ```
542 |
543 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltastxngroupid)
544 |
545 | #### Parameters
546 |
547 | | Name | Type | Description |
548 | | :------ | :------ | :------ |
549 | | `id` | `string` | txn ID or group ID to be searched for |
550 |
551 | #### Returns
552 |
553 | `default`
554 |
555 | #### Defined in
556 |
557 | client/v2/algod/algod.ts:789
558 |
559 | ___
560 |
561 | ### getSyncRound
562 |
563 | ▸ **getSyncRound**(): `default`
564 |
565 | Get the current sync round on the ledger (algod must have EnableFollowMode: true).
566 |
567 | #### Example
568 | ```typesecript
569 | const currentSyncRound = await client.getSyncRound().do();
570 | ```
571 |
572 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2ledgersync)
573 |
574 | #### Returns
575 |
576 | `default`
577 |
578 | #### Defined in
579 |
580 | client/v2/algod/algod.ts:757
581 |
582 | ___
583 |
584 | ### getTransactionGroupLedgerStateDeltasForRound
585 |
586 | ▸ **getTransactionGroupLedgerStateDeltasForRound**(`round`): `default`
587 |
588 | GetTransactionGroupLedgerStateDeltasForRound returns all ledger deltas for txn groups in the provided round
589 |
590 | #### Example
591 | ```typescript
592 | const round = 12345;
593 | await client.getTransactionGroupLedgerStateDeltasForRound(round).do();
594 | ```
595 |
596 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasroundtxngroup)
597 |
598 | #### Parameters
599 |
600 | | Name | Type | Description |
601 | | :------ | :------ | :------ |
602 | | `round` | `bigint` | the round number to be searched for |
603 |
604 | #### Returns
605 |
606 | `default`
607 |
608 | #### Defined in
609 |
610 | client/v2/algod/algod.ts:827
611 |
612 | ___
613 |
614 | ### getTransactionParams
615 |
616 | ▸ **getTransactionParams**(): `default`
617 |
618 | Returns the common needed parameters for a new transaction.
619 |
620 | #### Example
621 | ```typescript
622 | const suggestedParams = await algodClient.getTransactionParams().do();
623 | const amountInMicroAlgos = algosdk.algosToMicroalgos(2); // 2 Algos
624 | const unsignedTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
625 | from: senderAddress,
626 | to: receiverAddress,
627 | amount: amountInMicroAlgos,
628 | suggestedParams: suggestedParams,
629 | });
630 | ```
631 |
632 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionsparams)
633 |
634 | #### Returns
635 |
636 | `default`
637 |
638 | **`Remarks`**
639 |
640 | Often used with
641 | [`makePaymentTxnWithSuggestedParamsFromObject`](../modules.md#makepaymenttxnwithsuggestedparamsfromobject), [`algosToMicroalgos`](../modules.md#algostomicroalgos)
642 |
643 | #### Defined in
644 |
645 | client/v2/algod/algod.ts:393
646 |
647 | ___
648 |
649 | ### getTransactionProof
650 |
651 | ▸ **getTransactionProof**(`round`, `txID`): `default`
652 |
653 | Returns a Merkle proof for a given transaction in a block.
654 |
655 | #### Example
656 | ```typescript
657 | const round = 18038133;
658 | const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
659 | const proof = await algodClient.getTransactionProof(round, txId).do();
660 | ```
661 |
662 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksroundtransactionstxidproof)
663 |
664 | #### Parameters
665 |
666 | | Name | Type | Description |
667 | | :------ | :------ | :------ |
668 | | `round` | `number` | The round in which the transaction appears. |
669 | | `txID` | `string` | The transaction ID for which to generate a proof. |
670 |
671 | #### Returns
672 |
673 | `default`
674 |
675 | #### Defined in
676 |
677 | client/v2/algod/algod.ts:573
678 |
679 | ___
680 |
681 | ### healthCheck
682 |
683 | ▸ **healthCheck**(): `default`
684 |
685 | Returns OK if healthy.
686 |
687 | #### Example
688 | ```typescript
689 | const health = await algodClient.healthCheck().do();
690 | ```
691 |
692 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-health)
693 |
694 | #### Returns
695 |
696 | `default`
697 |
698 | #### Defined in
699 |
700 | client/v2/algod/algod.ts:104
701 |
702 | ___
703 |
704 | ### pendingTransactionByAddress
705 |
706 | ▸ **pendingTransactionByAddress**(`address`): `default`
707 |
708 | Returns the list of pending transactions sent by the address, sorted by priority, in decreasing order, truncated at the end at MAX.
709 | If MAX = 0, returns all pending transactions.
710 |
711 | #### Example 1
712 | ```typescript
713 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
714 | const pendingTxnsByAddr = await algodClient.pendingTransactionByAddress(address).do();
715 | ```
716 |
717 | #### Example 2
718 | ```typescript
719 | const maxTxns = 5;
720 | const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
721 | const pendingTxns = await algodClient
722 | .pendingTransactionByAddress(address)
723 | .max(maxTxns)
724 | .do();
725 | ```
726 |
727 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddresstransactionspending)
728 |
729 | #### Parameters
730 |
731 | | Name | Type | Description |
732 | | :------ | :------ | :------ |
733 | | `address` | `string` | The address of the sender. |
734 |
735 | #### Returns
736 |
737 | `default`
738 |
739 | #### Defined in
740 |
741 | client/v2/algod/algod.ts:335
742 |
743 | ___
744 |
745 | ### pendingTransactionInformation
746 |
747 | ▸ **pendingTransactionInformation**(`txid`): `default`
748 |
749 | Returns the transaction information for a specific pending transaction.
750 |
751 | #### Example
752 | ```typescript
753 | const txId = "DRJS6R745A7GFVMXEXWP4TGVDGKW7VILFTA7HC2BR2GRLHNY5CTA";
754 | const pending = await algodClient.pendingTransactionInformation(txId).do();
755 | ```
756 |
757 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionspendingtxid)
758 |
759 | #### Parameters
760 |
761 | | Name | Type | Description |
762 | | :------ | :------ | :------ |
763 | | `txid` | `string` | The TxID string of the pending transaction to look up. |
764 |
765 | #### Returns
766 |
767 | `default`
768 |
769 | **`Remarks`**
770 |
771 | <br><br>
772 | There are several cases when this might succeed:
773 | - transaction committed (committed round > 0)
774 | - transaction still in the pool (committed round = 0, pool error = "")
775 | - transaction removed from pool due to error (committed round = 0, pool error != "")
776 |
777 | Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
778 |
779 | #### Defined in
780 |
781 | client/v2/algod/algod.ts:282
782 |
783 | ___
784 |
785 | ### pendingTransactionsInformation
786 |
787 | ▸ **pendingTransactionsInformation**(): `default`
788 |
789 | Returns the list of pending transactions in the pool, sorted by priority, in decreasing order, truncated at the end at MAX.
790 | If MAX = 0, returns all pending transactions.
791 |
792 | #### Example 1
793 | ```typescript
794 | const pendingTxns = await algodClient.pendingTransactionsInformation().do();
795 | ```
796 |
797 | #### Example 2
798 | ```typescript
799 | const maxTxns = 5;
800 | const pendingTxns = await algodClient
801 | .pendingTransactionsInformation()
802 | .max(maxTxns)
803 | .do();
804 | ```
805 |
806 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionspending)
807 |
808 | #### Returns
809 |
810 | `default`
811 |
812 | #### Defined in
813 |
814 | client/v2/algod/algod.ts:307
815 |
816 | ___
817 |
818 | ### ready
819 |
820 | ▸ **ready**(): `default`
821 |
822 | Ready check which returns 200 OK if algod is healthy and caught up
823 |
824 | #### Example
825 | ```typesecript
826 | await client.ready().do();
827 | ```
828 |
829 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-ready)
830 |
831 | #### Returns
832 |
833 | `default`
834 |
835 | #### Defined in
836 |
837 | client/v2/algod/algod.ts:772
838 |
839 | ___
840 |
841 | ### status
842 |
843 | ▸ **status**(): `default`
844 |
845 | Retrieves the StatusResponse from the running node.
846 |
847 | #### Example
848 | ```typescript
849 | const status = await algodClient.status().do();
850 | ```
851 |
852 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2status)
853 |
854 | #### Returns
855 |
856 | `default`
857 |
858 | #### Defined in
859 |
860 | client/v2/algod/algod.ts:350
861 |
862 | ___
863 |
864 | ### statusAfterBlock
865 |
866 | ▸ **statusAfterBlock**(`round`): `default`
867 |
868 | Waits for a specific round to occur then returns the `StatusResponse` for that round.
869 |
870 | #### Example
871 | ```typescript
872 | const round = 18038133;
873 | const statusAfterBlock = await algodClient.statusAfterBlock(round).do();
874 | ```
875 |
876 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2statuswait-for-block-afterround)
877 |
878 | #### Parameters
879 |
880 | | Name | Type | Description |
881 | | :------ | :------ | :------ |
882 | | `round` | `number` | The number of the round to wait for. |
883 |
884 | #### Returns
885 |
886 | `default`
887 |
888 | #### Defined in
889 |
890 | client/v2/algod/algod.ts:367
891 |
892 | ___
893 |
894 | ### supply
895 |
896 | ▸ **supply**(): `default`
897 |
898 | Returns the supply details for the specified node's ledger.
899 |
900 | #### Example
901 | ```typescript
902 | const supplyDetails = await algodClient.supply().do();
903 | ```
904 |
905 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2ledgersupply)
906 |
907 | #### Returns
908 |
909 | `default`
910 |
911 | #### Defined in
912 |
913 | client/v2/algod/algod.ts:408
914 |
915 | ___
916 |
917 | ### versionsCheck
918 |
919 | ▸ **versionsCheck**(): `default`
920 |
921 | Retrieves the supported API versions, binary build versions, and genesis information.
922 |
923 | #### Example
924 | ```typescript
925 | const versionsDetails = await algodClient.versionsCheck().do();
926 | ```
927 |
928 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-versions)
929 |
930 | #### Returns
931 |
932 | `default`
933 |
934 | #### Defined in
935 |
936 | client/v2/algod/algod.ts:119
937 |
938 | ___
939 |
940 | ## Other Methods
941 |
942 | ### disassemble
943 |
944 | ▸ **disassemble**(`source`): `default`
945 |
946 | Given the program bytes, return the TEAL source code in plain text.
947 |
948 | #### Example
949 | ```typescript
950 | const bytecode = "TEAL bytecode";
951 | const disassembledSource = await algodClient.disassemble(bytecode).do();
952 | ```
953 |
954 | #### Parameters
955 |
956 | | Name | Type |
957 | | :------ | :------ |
958 | | `source` | `string` \| `Uint8Array` |
959 |
960 | #### Returns
961 |
962 | `default`
963 |
964 | **`Remarks`**
965 |
966 | This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
967 |
968 | #### Defined in
969 |
970 | client/v2/algod/algod.ts:443
971 |
972 | ___
973 |
974 | ### getIntEncoding
975 |
976 | ▸ **getIntEncoding**(): [`IntDecoding`](../enums/IntDecoding.md)
977 |
978 | Get the default int decoding method for all JSON requests this client creates.
979 |
980 | #### Returns
981 |
982 | [`IntDecoding`](../enums/IntDecoding.md)
983 |
984 | #### Inherited from
985 |
986 | ServiceClient.getIntEncoding
987 |
988 | #### Defined in
989 |
990 | client/v2/serviceClient.ts:86
991 |
992 | ___
993 |
994 | ### getLightBlockHeaderProof
995 |
996 | ▸ **getLightBlockHeaderProof**(`round`): `default`
997 |
998 | Gets a proof for a given light block header inside a state proof commitment.
999 |
1000 | #### Example
1001 | ```typescript
1002 | const round = 11111111;
1003 | const lightBlockHeaderProof = await algodClient.getLightBlockHeaderProof(round).do();
1004 | ```
1005 |
1006 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2#get-v2blocksroundlightheaderproof)
1007 |
1008 | #### Parameters
1009 |
1010 | | Name | Type |
1011 | | :------ | :------ |
1012 | | `round` | `number` |
1013 |
1014 | #### Returns
1015 |
1016 | `default`
1017 |
1018 | #### Defined in
1019 |
1020 | client/v2/algod/algod.ts:589
1021 |
1022 | ___
1023 |
1024 | ### getStateProof
1025 |
1026 | ▸ **getStateProof**(`round`): `default`
1027 |
1028 | Gets a state proof that covers a given round.
1029 |
1030 | #### Example
1031 | ```typescript
1032 | const round = 11111111;
1033 | const stateProof = await algodClient.getStateProof(round).do();
1034 | ```
1035 |
1036 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2#get-v2stateproofsround)
1037 |
1038 | #### Parameters
1039 |
1040 | | Name | Type |
1041 | | :------ | :------ |
1042 | | `round` | `number` |
1043 |
1044 | #### Returns
1045 |
1046 | `default`
1047 |
1048 | #### Defined in
1049 |
1050 | client/v2/algod/algod.ts:605
1051 |
1052 | ___
1053 |
1054 | ### setIntEncoding
1055 |
1056 | ▸ **setIntEncoding**(`method`): `void`
1057 |
1058 | Set the default int decoding method for all JSON requests this client creates.
1059 |
1060 | #### Parameters
1061 |
1062 | | Name | Type | Description |
1063 | | :------ | :------ | :------ |
1064 | | `method` | [`IntDecoding`](../enums/IntDecoding.md) | {"default" \| "safe" \| "mixed" \| "bigint"} method The method to use when parsing the response for request. Must be one of "default", "safe", "mixed", or "bigint". See JSONRequest.setIntDecoding for more details about what each method does. |
1065 |
1066 | #### Returns
1067 |
1068 | `void`
1069 |
1070 | #### Inherited from
1071 |
1072 | ServiceClient.setIntEncoding
1073 |
1074 | #### Defined in
1075 |
1076 | client/v2/serviceClient.ts:79
1077 |
1078 | ___
1079 |
1080 | ## POST Methods
1081 |
1082 | ### compile
1083 |
1084 | ▸ **compile**(`source`): `default`
1085 |
1086 | Compiles TEAL source code to binary, returns base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
1087 |
1088 | #### Example
1089 | ```typescript
1090 | const source = "TEAL SOURCE CODE";
1091 | const compiledSmartContract = await algodClient.compile(source).do();
1092 | ```
1093 |
1094 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2tealcompile)
1095 |
1096 | #### Parameters
1097 |
1098 | | Name | Type |
1099 | | :------ | :------ |
1100 | | `source` | `string` \| `Uint8Array` |
1101 |
1102 | #### Returns
1103 |
1104 | `default`
1105 |
1106 | **`Remarks`**
1107 |
1108 | This endpoint is only enabled when a node's configuration file sets `EnableDeveloperAPI` to true.
1109 |
1110 | #### Defined in
1111 |
1112 | client/v2/algod/algod.ts:427
1113 |
1114 | ___
1115 |
1116 | ### dryrun
1117 |
1118 | ▸ **dryrun**(`dr`): `default`
1119 |
1120 | Provides debugging information for a transaction (or group).
1121 |
1122 | Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configureation file sets `EnableDeveloperAPI` to true.
1123 |
1124 | #### Example
1125 | ```typescript
1126 | const dryRunResult = await algodClient.dryrun(dr).do();
1127 | ```
1128 |
1129 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2tealdryrun)
1130 |
1131 | #### Parameters
1132 |
1133 | | Name | Type |
1134 | | :------ | :------ |
1135 | | `dr` | [`DryrunRequest`](modelsv2.DryrunRequest.md) |
1136 |
1137 | #### Returns
1138 |
1139 | `default`
1140 |
1141 | #### Defined in
1142 |
1143 | client/v2/algod/algod.ts:461
1144 |
1145 | ___
1146 |
1147 | ### sendRawTransaction
1148 |
1149 | ▸ **sendRawTransaction**(`stxOrStxs`): `default`
1150 |
1151 | Broadcasts a raw transaction to the network.
1152 |
1153 | #### Example
1154 | ```typescript
1155 | const { txId } = await algodClient.sendRawTransaction(signedTxns).do();
1156 | const result = await waitForConfirmation(algodClient, txid, 3);
1157 | ```
1158 |
1159 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactions)
1160 |
1161 | #### Parameters
1162 |
1163 | | Name | Type | Description |
1164 | | :------ | :------ | :------ |
1165 | | `stxOrStxs` | `Uint8Array` \| `Uint8Array`[] | Signed transactions |
1166 |
1167 | #### Returns
1168 |
1169 | `default`
1170 |
1171 | **`Remarks`**
1172 |
1173 | Often used with [`waitForConfirmation`](../modules.md#waitforconfirmation)
1174 |
1175 | #### Defined in
1176 |
1177 | client/v2/algod/algod.ts:139
1178 |
1179 | ___
1180 |
1181 | ### setBlockOffsetTimestamp
1182 |
1183 | ▸ **setBlockOffsetTimestamp**(`offset`): `default`
1184 |
1185 | Set the offset (in seconds) applied to the block timestamp when creating new blocks in devmode.
1186 |
1187 | #### Example
1188 | ```typesecript
1189 | const offset = 60
1190 | await client.setBlockOffsetTimestamp(offset).do();
1191 | ```
1192 |
1193 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2devmodeblocksoffsetoffset)
1194 |
1195 | #### Parameters
1196 |
1197 | | Name | Type |
1198 | | :------ | :------ |
1199 | | `offset` | `number` |
1200 |
1201 | #### Returns
1202 |
1203 | `default`
1204 |
1205 | #### Defined in
1206 |
1207 | client/v2/algod/algod.ts:695
1208 |
1209 | ___
1210 |
1211 | ### setSyncRound
1212 |
1213 | ▸ **setSyncRound**(`round`): `default`
1214 |
1215 | Set the sync round on the ledger (algod must have EnableFollowMode: true), restricting catchup.
1216 |
1217 | #### Example
1218 | ```typesecript
1219 | const round = 10000
1220 | await client.setSyncRound(round).do();
1221 | ```
1222 |
1223 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2ledgersyncround)
1224 |
1225 | #### Parameters
1226 |
1227 | | Name | Type |
1228 | | :------ | :------ |
1229 | | `round` | `number` |
1230 |
1231 | #### Returns
1232 |
1233 | `default`
1234 |
1235 | #### Defined in
1236 |
1237 | client/v2/algod/algod.ts:727
1238 |
1239 | ___
1240 |
1241 | ### simulateRawTransactions
1242 |
1243 | ▸ **simulateRawTransactions**(`stxOrStxs`): `default`
1244 |
1245 | Simulate a list of a signed transaction objects being sent to the network.
1246 |
1247 | #### Example
1248 | ```typescript
1249 | const txn1 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn1Params);
1250 | const txn2 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn2Params);
1251 | const txgroup = algosdk.assignGroupID([txn1, txn2]);
1252 |
1253 | // Actually sign the first transaction
1254 | const signedTxn1 = txgroup[0].signTxn(senderSk).blob;
1255 | // Simulate does not require signed transactions -- use this method to encode an unsigned transaction
1256 | const signedTxn2 = algosdk.encodeUnsignedSimulateTransaction(txgroup[1]);
1257 |
1258 | const resp = await client.simulateRawTransactions([signedTxn1, signedTxn2]).do();
1259 | ```
1260 |
1261 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactionssimulate)
1262 |
1263 | #### Parameters
1264 |
1265 | | Name | Type |
1266 | | :------ | :------ |
1267 | | `stxOrStxs` | `Uint8Array` \| `Uint8Array`[] |
1268 |
1269 | #### Returns
1270 |
1271 | `default`
1272 |
1273 | #### Defined in
1274 |
1275 | client/v2/algod/algod.ts:630
1276 |
1277 | ___
1278 |
1279 | ### simulateTransactions
1280 |
1281 | ▸ **simulateTransactions**(`request`): `default`
1282 |
1283 | Simulate transactions being sent to the network.
1284 |
1285 | #### Example
1286 | ```typescript
1287 | const txn1 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn1Params);
1288 | const txn2 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn2Params);
1289 | const txgroup = algosdk.assignGroupID([txn1, txn2]);
1290 |
1291 | // Actually sign the first transaction
1292 | const signedTxn1 = txgroup[0].signTxn(senderSk).blob;
1293 | // Simulate does not require signed transactions -- use this method to encode an unsigned transaction
1294 | const signedTxn2 = algosdk.encodeUnsignedSimulateTransaction(txgroup[1]);
1295 |
1296 | const request = new modelsv2.SimulateRequest({
1297 | txnGroups: [
1298 | new modelsv2.SimulateRequestTransactionGroup({
1299 | // Must decode the signed txn bytes into an object
1300 | txns: [algosdk.decodeObj(signedTxn1), algosdk.decodeObj(signedTxn2)]
1301 | }),
1302 | ],
1303 | });
1304 | const resp = await client.simulateRawTransactions(request).do();
1305 | ```
1306 |
1307 | [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactionssimulate)
1308 |
1309 | #### Parameters
1310 |
1311 | | Name | Type |
1312 | | :------ | :------ |
1313 | | `request` | [`SimulateRequest`](modelsv2.SimulateRequest.md) |
1314 |
1315 | #### Returns
1316 |
1317 | `default`
1318 |
1319 | #### Defined in
1320 |
1321 | client/v2/algod/algod.ts:678
1322 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:rest-apis:kmd.md:
--------------------------------------------------------------------------------
```markdown
1 | title: kmd
2 | ---
3 |
4 | <a name="paths"></a>
5 | ## Paths
6 |
7 | <a name="swaggerhandler"></a>
8 | ### GET /swagger.json
9 | Gets the current swagger spec.
10 | ```
11 | GET /swagger.json
12 | ```
13 |
14 |
15 | **Description**
16 | Returns the entire swagger spec in json.
17 |
18 |
19 | **Responses**
20 |
21 | |HTTP Code|Description|Schema|
22 | |---|---|---|
23 | |**200**|The current swagger spec|string|
24 | |**default**|Unknown Error|No Content|
25 |
26 |
27 | **Produces**
28 |
29 | * `application/json`
30 |
31 |
32 | <a name="generatekey"></a>
33 | ### POST /v1/key
34 | Generate a key
35 | ```
36 | POST /v1/key
37 | ```
38 |
39 |
40 | **Description**
41 | Generates the next key in the deterministic key sequence (as determined by the master derivation key) and adds it to the wallet, returning the public key.
42 |
43 |
44 | **Parameters**
45 |
46 | |Type|Name|Schema|
47 | |---|---|---|
48 | |**Body**|**Generate Key Request** <br>*required*|[GenerateKeyRequest](#generatekeyrequest)|
49 |
50 |
51 | **Responses**
52 |
53 | |HTTP Code|Description|Schema|
54 | |---|---|---|
55 | |**200**|Response to `POST /v1/key`|[APIV1POSTKeyResponse](#apiv1postkeyresponse)|
56 |
57 |
58 | **Produces**
59 |
60 | * `application/json`
61 |
62 |
63 | <a name="deletekey"></a>
64 | ### DELETE /v1/key
65 | Delete a key
66 | ```
67 | DELETE /v1/key
68 | ```
69 |
70 |
71 | **Description**
72 | Deletes the key with the passed public key from the wallet.
73 |
74 |
75 | **Parameters**
76 |
77 | |Type|Name|Schema|
78 | |---|---|---|
79 | |**Body**|**Delete Key Request** <br>*required*|[DeleteKeyRequest](#deletekeyrequest)|
80 |
81 |
82 | **Responses**
83 |
84 | |HTTP Code|Description|Schema|
85 | |---|---|---|
86 | |**200**|Response to `DELETE /v1/key`|[APIV1DELETEKeyResponse](#apiv1deletekeyresponse)|
87 |
88 |
89 | **Produces**
90 |
91 | * `application/json`
92 |
93 |
94 | <a name="exportkey"></a>
95 | ### POST /v1/key/export
96 | Export a key
97 | ```
98 | POST /v1/key/export
99 | ```
100 |
101 |
102 | **Description**
103 | Export the secret key associated with the passed public key.
104 |
105 |
106 | **Parameters**
107 |
108 | |Type|Name|Schema|
109 | |---|---|---|
110 | |**Body**|**Export Key Request** <br>*required*|[ExportKeyRequest](#exportkeyrequest)|
111 |
112 |
113 | **Responses**
114 |
115 | |HTTP Code|Description|Schema|
116 | |---|---|---|
117 | |**200**|Response to `POST /v1/key/export`|[APIV1POSTKeyExportResponse](#apiv1postkeyexportresponse)|
118 |
119 |
120 | **Produces**
121 |
122 | * `application/json`
123 |
124 |
125 | <a name="importkey"></a>
126 | ### POST /v1/key/import
127 | Import a key
128 | ```
129 | POST /v1/key/import
130 | ```
131 |
132 |
133 | **Description**
134 | Import an externally generated key into the wallet. Note that if you wish to back up the imported key, you must do so by backing up the entire wallet database, because imported keys were not derived from the wallet's master derivation key.
135 |
136 |
137 | **Parameters**
138 |
139 | |Type|Name|Schema|
140 | |---|---|---|
141 | |**Body**|**Import Key Request** <br>*required*|[ImportKeyRequest](#importkeyrequest)|
142 |
143 |
144 | **Responses**
145 |
146 | |HTTP Code|Description|Schema|
147 | |---|---|---|
148 | |**200**|Response to `POST /v1/key/import`|[APIV1POSTKeyImportResponse](#apiv1postkeyimportresponse)|
149 |
150 |
151 | **Produces**
152 |
153 | * `application/json`
154 |
155 |
156 | <a name="listkeysinwallet"></a>
157 | ### POST /v1/key/list
158 | List keys in wallet
159 | ```
160 | POST /v1/key/list
161 | ```
162 |
163 |
164 | **Description**
165 | Lists all of the public keys in this wallet. All of them have a stored private key.
166 |
167 |
168 | **Parameters**
169 |
170 | |Type|Name|Schema|
171 | |---|---|---|
172 | |**Body**|**List Keys Request** <br>*required*|[ListKeysRequest](#listkeysrequest)|
173 |
174 |
175 | **Responses**
176 |
177 | |HTTP Code|Description|Schema|
178 | |---|---|---|
179 | |**200**|Response to `POST /v1/key/list`|[APIV1POSTKeyListResponse](#apiv1postkeylistresponse)|
180 |
181 |
182 | **Produces**
183 |
184 | * `application/json`
185 |
186 |
187 | <a name="exportmasterkey"></a>
188 | ### POST /v1/master-key/export
189 | Export the master derivation key from a wallet
190 | ```
191 | POST /v1/master-key/export
192 | ```
193 |
194 |
195 | **Description**
196 | Export the master derivation key from the wallet. This key is a master "backup" key for the underlying wallet. With it, you can regenerate all of the wallets that have been generated with this wallet's `POST /v1/key` endpoint. This key will not allow you to recover keys imported from other wallets, however.
197 |
198 |
199 | **Parameters**
200 |
201 | |Type|Name|Schema|
202 | |---|---|---|
203 | |**Body**|**Export Master Key Request** <br>*required*|[ExportMasterKeyRequest](#exportmasterkeyrequest)|
204 |
205 |
206 | **Responses**
207 |
208 | |HTTP Code|Description|Schema|
209 | |---|---|---|
210 | |**200**|Response to `POST /v1/master-key/export`|[APIV1POSTMasterKeyExportResponse](#apiv1postmasterkeyexportresponse)|
211 |
212 |
213 | **Produces**
214 |
215 | * `application/json`
216 |
217 |
218 | <a name="deletemultisig"></a>
219 | ### DELETE /v1/multisig
220 | Delete a multisig
221 | ```
222 | DELETE /v1/multisig
223 | ```
224 |
225 |
226 | **Description**
227 | Deletes multisig preimage information for the passed address from the wallet.
228 |
229 |
230 | **Parameters**
231 |
232 | |Type|Name|Schema|
233 | |---|---|---|
234 | |**Body**|**Delete Multisig Request** <br>*required*|[DeleteMultisigRequest](#deletemultisigrequest)|
235 |
236 |
237 | **Responses**
238 |
239 | |HTTP Code|Description|Schema|
240 | |---|---|---|
241 | |**200**|Response to POST /v1/multisig/delete|[APIV1DELETEMultisigResponse](#apiv1deletemultisigresponse)|
242 |
243 |
244 | **Produces**
245 |
246 | * `application/json`
247 |
248 |
249 | <a name="exportmultisig"></a>
250 | ### POST /v1/multisig/export
251 | Export multisig address metadata
252 | ```
253 | POST /v1/multisig/export
254 | ```
255 |
256 |
257 | **Description**
258 | Given a multisig address whose preimage this wallet stores, returns the information used to generate the address, including public keys, threshold, and multisig version.
259 |
260 |
261 | **Parameters**
262 |
263 | |Type|Name|Schema|
264 | |---|---|---|
265 | |**Body**|**Export Multisig Request** <br>*required*|[ExportMultisigRequest](#exportmultisigrequest)|
266 |
267 |
268 | **Responses**
269 |
270 | |HTTP Code|Description|Schema|
271 | |---|---|---|
272 | |**200**|Response to `POST /v1/multisig/export`|[APIV1POSTMultisigExportResponse](#apiv1postmultisigexportresponse)|
273 |
274 |
275 | **Produces**
276 |
277 | * `application/json`
278 |
279 |
280 | <a name="importmultisig"></a>
281 | ### POST /v1/multisig/import
282 | Import a multisig account
283 | ```
284 | POST /v1/multisig/import
285 | ```
286 |
287 |
288 | **Description**
289 | Generates a multisig account from the passed public keys array and multisig metadata, and stores all of this in the wallet.
290 |
291 |
292 | **Parameters**
293 |
294 | |Type|Name|Schema|
295 | |---|---|---|
296 | |**Body**|**Import Multisig Request** <br>*required*|[ImportMultisigRequest](#importmultisigrequest)|
297 |
298 |
299 | **Responses**
300 |
301 | |HTTP Code|Description|Schema|
302 | |---|---|---|
303 | |**200**|Response to `POST /v1/multisig/import`|[APIV1POSTMultisigImportResponse](#apiv1postmultisigimportresponse)|
304 |
305 |
306 | **Produces**
307 |
308 | * `application/json`
309 |
310 |
311 | <a name="listmultisg"></a>
312 | ### POST /v1/multisig/list
313 | List multisig accounts
314 | ```
315 | POST /v1/multisig/list
316 | ```
317 |
318 |
319 | **Description**
320 | Lists all of the multisig accounts whose preimages this wallet stores
321 |
322 |
323 | **Parameters**
324 |
325 | |Type|Name|Schema|
326 | |---|---|---|
327 | |**Body**|**List Multisig Request** <br>*required*|[ListMultisigRequest](#listmultisigrequest)|
328 |
329 |
330 | **Responses**
331 |
332 | |HTTP Code|Description|Schema|
333 | |---|---|---|
334 | |**200**|Response to `POST /v1/multisig/list`|[APIV1POSTMultisigListResponse](#apiv1postmultisiglistresponse)|
335 |
336 |
337 | **Produces**
338 |
339 | * `application/json`
340 |
341 |
342 | <a name="signmultisigtransaction"></a>
343 | ### POST /v1/multisig/sign
344 | Sign a multisig transaction
345 | ```
346 | POST /v1/multisig/sign
347 | ```
348 |
349 |
350 | **Description**
351 | Start a multisig signature, or add a signature to a partially completed multisig signature object.
352 |
353 |
354 | **Parameters**
355 |
356 | |Type|Name|Schema|
357 | |---|---|---|
358 | |**Body**|**Sign Multisig Transaction Request** <br>*required*|[SignMultisigRequest](#signmultisigrequest)|
359 |
360 |
361 | **Responses**
362 |
363 | |HTTP Code|Description|Schema|
364 | |---|---|---|
365 | |**200**|Response to `POST /v1/multisig/sign`|[APIV1POSTMultisigTransactionSignResponse](#apiv1postmultisigtransactionsignresponse)|
366 |
367 |
368 | **Produces**
369 |
370 | * `application/json`
371 |
372 |
373 | <a name="signmultisigprogram"></a>
374 | ### POST /v1/multisig/signprogram
375 | Sign a program for a multisig account
376 | ```
377 | POST /v1/multisig/signprogram
378 | ```
379 |
380 |
381 | **Description**
382 | Start a multisig signature, or add a signature to a partially completed multisig signature object.
383 |
384 |
385 | **Parameters**
386 |
387 | |Type|Name|Schema|
388 | |---|---|---|
389 | |**Body**|**Sign Multisig Program Request** <br>*required*|[SignProgramMultisigRequest](#signprogrammultisigrequest)|
390 |
391 |
392 | **Responses**
393 |
394 | |HTTP Code|Description|Schema|
395 | |---|---|---|
396 | |**200**|Response to `POST /v1/multisig/signdata`|[APIV1POSTMultisigProgramSignResponse](#apiv1postmultisigprogramsignresponse)|
397 |
398 |
399 | **Produces**
400 |
401 | * `application/json`
402 |
403 |
404 | <a name="signprogram"></a>
405 | ### POST /v1/program/sign
406 | Sign program
407 | ```
408 | POST /v1/program/sign
409 | ```
410 |
411 |
412 | **Description**
413 | Signs the passed program with a key from the wallet, determined by the account named in the request.
414 |
415 |
416 | **Parameters**
417 |
418 | |Type|Name|Schema|
419 | |---|---|---|
420 | |**Body**|**Sign Program Request** <br>*required*|[SignProgramRequest](#signprogramrequest)|
421 |
422 |
423 | **Responses**
424 |
425 | |HTTP Code|Description|Schema|
426 | |---|---|---|
427 | |**200**|Response to `POST /v1/data/sign`|[APIV1POSTProgramSignResponse](#apiv1postprogramsignresponse)|
428 |
429 |
430 | **Produces**
431 |
432 | * `application/json`
433 |
434 |
435 | <a name="signtransaction"></a>
436 | ### POST /v1/transaction/sign
437 | Sign a transaction
438 | ```
439 | POST /v1/transaction/sign
440 | ```
441 |
442 |
443 | **Description**
444 | Signs the passed transaction with a key from the wallet, determined by the sender encoded in the transaction.
445 |
446 |
447 | **Parameters**
448 |
449 | |Type|Name|Schema|
450 | |---|---|---|
451 | |**Body**|**Sign Transaction Request** <br>*required*|[SignTransactionRequest](#signtransactionrequest)|
452 |
453 |
454 | **Responses**
455 |
456 | |HTTP Code|Description|Schema|
457 | |---|---|---|
458 | |**200**|Response to `POST /v1/transaction/sign`|[APIV1POSTTransactionSignResponse](#apiv1posttransactionsignresponse)|
459 |
460 |
461 | **Produces**
462 |
463 | * `application/json`
464 |
465 |
466 | <a name="createwallet"></a>
467 | ### POST /v1/wallet
468 | Create a wallet
469 | ```
470 | POST /v1/wallet
471 | ```
472 |
473 |
474 | **Description**
475 | Create a new wallet (collection of keys) with the given parameters.
476 |
477 |
478 | **Parameters**
479 |
480 | |Type|Name|Schema|
481 | |---|---|---|
482 | |**Body**|**Create Wallet Request** <br>*required*|[CreateWalletRequest](#createwalletrequest)|
483 |
484 |
485 | **Responses**
486 |
487 | |HTTP Code|Description|Schema|
488 | |---|---|---|
489 | |**200**|Response to `POST /v1/wallet`|[APIV1POSTWalletResponse](#apiv1postwalletresponse)|
490 |
491 |
492 | **Produces**
493 |
494 | * `application/json`
495 |
496 |
497 | <a name="getwalletinfo"></a>
498 | ### POST /v1/wallet/info
499 | Get wallet info
500 | ```
501 | POST /v1/wallet/info
502 | ```
503 |
504 |
505 | **Description**
506 | Returns information about the wallet associated with the passed wallet handle token. Additionally returns expiration information about the token itself.
507 |
508 |
509 | **Parameters**
510 |
511 | |Type|Name|Schema|
512 | |---|---|---|
513 | |**Body**|**Get Wallet Info Request** <br>*required*|[WalletInfoRequest](#walletinforequest)|
514 |
515 |
516 | **Responses**
517 |
518 | |HTTP Code|Description|Schema|
519 | |---|---|---|
520 | |**200**|Response to `POST /v1/wallet/info`|[APIV1POSTWalletInfoResponse](#apiv1postwalletinforesponse)|
521 |
522 |
523 | **Produces**
524 |
525 | * `application/json`
526 |
527 |
528 | <a name="initwallethandletoken"></a>
529 | ### POST /v1/wallet/init
530 | Initialize a wallet handle token
531 | ```
532 | POST /v1/wallet/init
533 | ```
534 |
535 |
536 | **Description**
537 | Unlock the wallet and return a wallet handle token that can be used for subsequent operations. These tokens expire periodically and must be renewed. You can `POST` the token to `/v1/wallet/info` to see how much time remains until expiration, and renew it with `/v1/wallet/renew`. When you're done, you can invalidate the token with `/v1/wallet/release`.
538 |
539 |
540 | **Parameters**
541 |
542 | |Type|Name|Schema|
543 | |---|---|---|
544 | |**Body**|**Initialize Wallet Handle Token Request** <br>*required*|[InitWalletHandleTokenRequest](#initwallethandletokenrequest)|
545 |
546 |
547 | **Responses**
548 |
549 | |HTTP Code|Description|Schema|
550 | |---|---|---|
551 | |**200**|Response to `POST /v1/wallet/init`|[APIV1POSTWalletInitResponse](#apiv1postwalletinitresponse)|
552 |
553 |
554 | **Produces**
555 |
556 | * `application/json`
557 |
558 |
559 | <a name="releasewallethandletoken"></a>
560 | ### POST /v1/wallet/release
561 | Release a wallet handle token
562 | ```
563 | POST /v1/wallet/release
564 | ```
565 |
566 |
567 | **Description**
568 | Invalidate the passed wallet handle token, making it invalid for use in subsequent requests.
569 |
570 |
571 | **Parameters**
572 |
573 | |Type|Name|Schema|
574 | |---|---|---|
575 | |**Body**|**Release Wallet Handle Token Request** <br>*required*|[ReleaseWalletHandleTokenRequest](#releasewallethandletokenrequest)|
576 |
577 |
578 | **Responses**
579 |
580 | |HTTP Code|Description|Schema|
581 | |---|---|---|
582 | |**200**|Response to `POST /v1/wallet/release`|[APIV1POSTWalletReleaseResponse](#apiv1postwalletreleaseresponse)|
583 |
584 |
585 | **Produces**
586 |
587 | * `application/json`
588 |
589 |
590 | <a name="renamewallet"></a>
591 | ### POST /v1/wallet/rename
592 | Rename a wallet
593 | ```
594 | POST /v1/wallet/rename
595 | ```
596 |
597 |
598 | **Description**
599 | Rename the underlying wallet to something else
600 |
601 |
602 | **Parameters**
603 |
604 | |Type|Name|Schema|
605 | |---|---|---|
606 | |**Body**|**Rename Wallet Request** <br>*required*|[RenameWalletRequest](#renamewalletrequest)|
607 |
608 |
609 | **Responses**
610 |
611 | |HTTP Code|Description|Schema|
612 | |---|---|---|
613 | |**200**|Response to `POST /v1/wallet/rename`|[APIV1POSTWalletRenameResponse](#apiv1postwalletrenameresponse)|
614 |
615 |
616 | **Produces**
617 |
618 | * `application/json`
619 |
620 |
621 | <a name="renewwallethandletoken"></a>
622 | ### POST /v1/wallet/renew
623 | Renew a wallet handle token
624 | ```
625 | POST /v1/wallet/renew
626 | ```
627 |
628 |
629 | **Description**
630 | Renew a wallet handle token, increasing its expiration duration to its initial value
631 |
632 |
633 | **Parameters**
634 |
635 | |Type|Name|Schema|
636 | |---|---|---|
637 | |**Body**|**Renew Wallet Handle Token Request** <br>*required*|[RenewWalletHandleTokenRequest](#renewwallethandletokenrequest)|
638 |
639 |
640 | **Responses**
641 |
642 | |HTTP Code|Description|Schema|
643 | |---|---|---|
644 | |**200**|Response `POST /v1/wallet/renew`|[APIV1POSTWalletRenewResponse](#apiv1postwalletrenewresponse)|
645 |
646 |
647 | **Produces**
648 |
649 | * `application/json`
650 |
651 |
652 | <a name="listwallets"></a>
653 | ### GET /v1/wallets
654 | List wallets
655 | ```
656 | GET /v1/wallets
657 | ```
658 |
659 |
660 | **Description**
661 | Lists all of the wallets that kmd is aware of.
662 |
663 |
664 | **Parameters**
665 |
666 | |Type|Name|Schema|
667 | |---|---|---|
668 | |**Body**|**List Wallet Request** <br>*optional*|[ListWalletsRequest](#listwalletsrequest)|
669 |
670 |
671 | **Responses**
672 |
673 | |HTTP Code|Description|Schema|
674 | |---|---|---|
675 | |**200**|Response to `GET /v1/wallets`|[APIV1GETWalletsResponse](#apiv1getwalletsresponse)|
676 |
677 |
678 | **Produces**
679 |
680 | * `application/json`
681 |
682 |
683 | <a name="getversion"></a>
684 | ### GET /versions
685 | Retrieves the current version
686 | ```
687 | GET /versions
688 | ```
689 |
690 |
691 | **Parameters**
692 |
693 | |Type|Name|Schema|
694 | |---|---|---|
695 | |**Body**|**Versions Request** <br>*optional*|[VersionsRequest](#versionsrequest)|
696 |
697 |
698 | **Responses**
699 |
700 | |HTTP Code|Description|Schema|
701 | |---|---|---|
702 | |**200**|Response to `GET /versions`|[VersionsResponse](#versionsresponse)|
703 |
704 |
705 | **Produces**
706 |
707 | * `application/json`
708 |
709 |
710 |
711 |
712 | <a name="definitions"></a>
713 | ## Definitions
714 |
715 | <a name="apiv1deletekeyresponse"></a>
716 | ### APIV1DELETEKeyResponse
717 | APIV1DELETEKeyResponse is the response to `DELETE /v1/key`
718 | friendly:DeleteKeyResponse
719 |
720 |
721 | |Name|Schema|
722 | |---|---|
723 | |**error** <br>*optional*|boolean|
724 | |**message** <br>*optional*|string|
725 |
726 |
727 | <a name="apiv1deletemultisigresponse"></a>
728 | ### APIV1DELETEMultisigResponse
729 | APIV1DELETEMultisigResponse is the response to POST /v1/multisig/delete`
730 | friendly:DeleteMultisigResponse
731 |
732 |
733 | |Name|Schema|
734 | |---|---|
735 | |**error** <br>*optional*|boolean|
736 | |**message** <br>*optional*|string|
737 |
738 |
739 | <a name="apiv1getwalletsresponse"></a>
740 | ### APIV1GETWalletsResponse
741 | APIV1GETWalletsResponse is the response to `GET /v1/wallets`
742 | friendly:ListWalletsResponse
743 |
744 |
745 | |Name|Schema|
746 | |---|---|
747 | |**error** <br>*optional*|boolean|
748 | |**message** <br>*optional*|string|
749 | |**wallets** <br>*optional*|< [APIV1Wallet](#apiv1wallet) > array|
750 |
751 |
752 | <a name="apiv1postkeyexportresponse"></a>
753 | ### APIV1POSTKeyExportResponse
754 | APIV1POSTKeyExportResponse is the response to `POST /v1/key/export`
755 | friendly:ExportKeyResponse
756 |
757 |
758 | |Name|Schema|
759 | |---|---|
760 | |**error** <br>*optional*|boolean|
761 | |**message** <br>*optional*|string|
762 | |**private_key** <br>*optional*|[PrivateKey](#privatekey)|
763 |
764 |
765 | <a name="apiv1postkeyimportresponse"></a>
766 | ### APIV1POSTKeyImportResponse
767 | APIV1POSTKeyImportResponse is the response to `POST /v1/key/import`
768 | friendly:ImportKeyResponse
769 |
770 |
771 | |Name|Schema|
772 | |---|---|
773 | |**address** <br>*optional*|string|
774 | |**error** <br>*optional*|boolean|
775 | |**message** <br>*optional*|string|
776 |
777 |
778 | <a name="apiv1postkeylistresponse"></a>
779 | ### APIV1POSTKeyListResponse
780 | APIV1POSTKeyListResponse is the response to `POST /v1/key/list`
781 | friendly:ListKeysResponse
782 |
783 |
784 | |Name|Schema|
785 | |---|---|
786 | |**addresses** <br>*optional*|< string > array|
787 | |**error** <br>*optional*|boolean|
788 | |**message** <br>*optional*|string|
789 |
790 |
791 | <a name="apiv1postkeyresponse"></a>
792 | ### APIV1POSTKeyResponse
793 | APIV1POSTKeyResponse is the response to `POST /v1/key`
794 | friendly:GenerateKeyResponse
795 |
796 |
797 | |Name|Schema|
798 | |---|---|
799 | |**address** <br>*optional*|string|
800 | |**error** <br>*optional*|boolean|
801 | |**message** <br>*optional*|string|
802 |
803 |
804 | <a name="apiv1postmasterkeyexportresponse"></a>
805 | ### APIV1POSTMasterKeyExportResponse
806 | APIV1POSTMasterKeyExportResponse is the response to `POST /v1/master-key/export`
807 | friendly:ExportMasterKeyResponse
808 |
809 |
810 | |Name|Schema|
811 | |---|---|
812 | |**error** <br>*optional*|boolean|
813 | |**master_derivation_key** <br>*optional*|[MasterDerivationKey](#masterderivationkey)|
814 | |**message** <br>*optional*|string|
815 |
816 |
817 | <a name="apiv1postmultisigexportresponse"></a>
818 | ### APIV1POSTMultisigExportResponse
819 | APIV1POSTMultisigExportResponse is the response to `POST /v1/multisig/export`
820 | friendly:ExportMultisigResponse
821 |
822 |
823 | |Name|Schema|
824 | |---|---|
825 | |**error** <br>*optional*|boolean|
826 | |**message** <br>*optional*|string|
827 | |**multisig_version** <br>*optional*|integer (uint8)|
828 | |**pks** <br>*optional*|< [PublicKey](#publickey) > array|
829 | |**threshold** <br>*optional*|integer (uint8)|
830 |
831 |
832 | <a name="apiv1postmultisigimportresponse"></a>
833 | ### APIV1POSTMultisigImportResponse
834 | APIV1POSTMultisigImportResponse is the response to `POST /v1/multisig/import`
835 | friendly:ImportMultisigResponse
836 |
837 |
838 | |Name|Schema|
839 | |---|---|
840 | |**address** <br>*optional*|string|
841 | |**error** <br>*optional*|boolean|
842 | |**message** <br>*optional*|string|
843 |
844 |
845 | <a name="apiv1postmultisiglistresponse"></a>
846 | ### APIV1POSTMultisigListResponse
847 | APIV1POSTMultisigListResponse is the response to `POST /v1/multisig/list`
848 | friendly:ListMultisigResponse
849 |
850 |
851 | |Name|Schema|
852 | |---|---|
853 | |**addresses** <br>*optional*|< string > array|
854 | |**error** <br>*optional*|boolean|
855 | |**message** <br>*optional*|string|
856 |
857 |
858 | <a name="apiv1postmultisigprogramsignresponse"></a>
859 | ### APIV1POSTMultisigProgramSignResponse
860 | APIV1POSTMultisigProgramSignResponse is the response to `POST /v1/multisig/signdata`
861 | friendly:SignProgramMultisigResponse
862 |
863 |
864 | |Name|Description|Schema|
865 | |---|---|---|
866 | |**error** <br>*optional*||boolean|
867 | |**message** <br>*optional*||string|
868 | |**multisig** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
869 |
870 |
871 | <a name="apiv1postmultisigtransactionsignresponse"></a>
872 | ### APIV1POSTMultisigTransactionSignResponse
873 | APIV1POSTMultisigTransactionSignResponse is the response to `POST /v1/multisig/sign`
874 | friendly:SignMultisigResponse
875 |
876 |
877 | |Name|Description|Schema|
878 | |---|---|---|
879 | |**error** <br>*optional*||boolean|
880 | |**message** <br>*optional*||string|
881 | |**multisig** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
882 |
883 |
884 | <a name="apiv1postprogramsignresponse"></a>
885 | ### APIV1POSTProgramSignResponse
886 | APIV1POSTProgramSignResponse is the response to `POST /v1/data/sign`
887 | friendly:SignProgramResponse
888 |
889 |
890 | |Name|Description|Schema|
891 | |---|---|---|
892 | |**error** <br>*optional*||boolean|
893 | |**message** <br>*optional*||string|
894 | |**sig** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
895 |
896 |
897 | <a name="apiv1posttransactionsignresponse"></a>
898 | ### APIV1POSTTransactionSignResponse
899 | APIV1POSTTransactionSignResponse is the response to `POST /v1/transaction/sign`
900 | friendly:SignTransactionResponse
901 |
902 |
903 | |Name|Description|Schema|
904 | |---|---|---|
905 | |**error** <br>*optional*||boolean|
906 | |**message** <br>*optional*||string|
907 | |**signed_transaction** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
908 |
909 |
910 | <a name="apiv1postwalletinforesponse"></a>
911 | ### APIV1POSTWalletInfoResponse
912 | APIV1POSTWalletInfoResponse is the response to `POST /v1/wallet/info`
913 | friendly:WalletInfoResponse
914 |
915 |
916 | |Name|Schema|
917 | |---|---|
918 | |**error** <br>*optional*|boolean|
919 | |**message** <br>*optional*|string|
920 | |**wallet_handle** <br>*optional*|[APIV1WalletHandle](#apiv1wallethandle)|
921 |
922 |
923 | <a name="apiv1postwalletinitresponse"></a>
924 | ### APIV1POSTWalletInitResponse
925 | APIV1POSTWalletInitResponse is the response to `POST /v1/wallet/init`
926 | friendly:InitWalletHandleTokenResponse
927 |
928 |
929 | |Name|Schema|
930 | |---|---|
931 | |**error** <br>*optional*|boolean|
932 | |**message** <br>*optional*|string|
933 | |**wallet_handle_token** <br>*optional*|string|
934 |
935 |
936 | <a name="apiv1postwalletreleaseresponse"></a>
937 | ### APIV1POSTWalletReleaseResponse
938 | APIV1POSTWalletReleaseResponse is the response to `POST /v1/wallet/release`
939 | friendly:ReleaseWalletHandleTokenResponse
940 |
941 |
942 | |Name|Schema|
943 | |---|---|
944 | |**error** <br>*optional*|boolean|
945 | |**message** <br>*optional*|string|
946 |
947 |
948 | <a name="apiv1postwalletrenameresponse"></a>
949 | ### APIV1POSTWalletRenameResponse
950 | APIV1POSTWalletRenameResponse is the response to `POST /v1/wallet/rename`
951 | friendly:RenameWalletResponse
952 |
953 |
954 | |Name|Schema|
955 | |---|---|
956 | |**error** <br>*optional*|boolean|
957 | |**message** <br>*optional*|string|
958 | |**wallet** <br>*optional*|[APIV1Wallet](#apiv1wallet)|
959 |
960 |
961 | <a name="apiv1postwalletrenewresponse"></a>
962 | ### APIV1POSTWalletRenewResponse
963 | APIV1POSTWalletRenewResponse is the response to `POST /v1/wallet/renew`
964 | friendly:RenewWalletHandleTokenResponse
965 |
966 |
967 | |Name|Schema|
968 | |---|---|
969 | |**error** <br>*optional*|boolean|
970 | |**message** <br>*optional*|string|
971 | |**wallet_handle** <br>*optional*|[APIV1WalletHandle](#apiv1wallethandle)|
972 |
973 |
974 | <a name="apiv1postwalletresponse"></a>
975 | ### APIV1POSTWalletResponse
976 | APIV1POSTWalletResponse is the response to `POST /v1/wallet`
977 | friendly:CreateWalletResponse
978 |
979 |
980 | |Name|Schema|
981 | |---|---|
982 | |**error** <br>*optional*|boolean|
983 | |**message** <br>*optional*|string|
984 | |**wallet** <br>*optional*|[APIV1Wallet](#apiv1wallet)|
985 |
986 |
987 | <a name="apiv1wallet"></a>
988 | ### APIV1Wallet
989 | APIV1Wallet is the API's representation of a wallet
990 |
991 |
992 | |Name|Schema|
993 | |---|---|
994 | |**driver_name** <br>*optional*|string|
995 | |**driver_version** <br>*optional*|integer (uint32)|
996 | |**id** <br>*optional*|string|
997 | |**mnemonic_ux** <br>*optional*|boolean|
998 | |**name** <br>*optional*|string|
999 | |**supported_txs** <br>*optional*|< [TxType](#txtype) > array|
1000 |
1001 |
1002 | <a name="apiv1wallethandle"></a>
1003 | ### APIV1WalletHandle
1004 | APIV1WalletHandle includes the wallet the handle corresponds to
1005 | and the number of number of seconds to expiration
1006 |
1007 |
1008 | |Name|Schema|
1009 | |---|---|
1010 | |**expires_seconds** <br>*optional*|integer (int64)|
1011 | |**wallet** <br>*optional*|[APIV1Wallet](#apiv1wallet)|
1012 |
1013 |
1014 | <a name="createwalletrequest"></a>
1015 | ### CreateWalletRequest
1016 | APIV1POSTWalletRequest is the request for `POST /v1/wallet`
1017 |
1018 |
1019 | |Name|Schema|
1020 | |---|---|
1021 | |**master_derivation_key** <br>*optional*|[MasterDerivationKey](#masterderivationkey)|
1022 | |**wallet_driver_name** <br>*optional*|string|
1023 | |**wallet_name** <br>*optional*|string|
1024 | |**wallet_password** <br>*optional*|string|
1025 |
1026 |
1027 | <a name="deletekeyrequest"></a>
1028 | ### DeleteKeyRequest
1029 | APIV1DELETEKeyRequest is the request for `DELETE /v1/key`
1030 |
1031 |
1032 | |Name|Schema|
1033 | |---|---|
1034 | |**address** <br>*optional*|string|
1035 | |**wallet_handle_token** <br>*optional*|string|
1036 | |**wallet_password** <br>*optional*|string|
1037 |
1038 |
1039 | <a name="deletemultisigrequest"></a>
1040 | ### DeleteMultisigRequest
1041 | APIV1DELETEMultisigRequest is the request for `DELETE /v1/multisig`
1042 |
1043 |
1044 | |Name|Schema|
1045 | |---|---|
1046 | |**address** <br>*optional*|string|
1047 | |**wallet_handle_token** <br>*optional*|string|
1048 | |**wallet_password** <br>*optional*|string|
1049 |
1050 |
1051 | <a name="digest"></a>
1052 | ### Digest
1053 | *Type* : < integer (uint8) > array
1054 |
1055 |
1056 | <a name="exportkeyrequest"></a>
1057 | ### ExportKeyRequest
1058 | APIV1POSTKeyExportRequest is the request for `POST /v1/key/export`
1059 |
1060 |
1061 | |Name|Schema|
1062 | |---|---|
1063 | |**address** <br>*optional*|string|
1064 | |**wallet_handle_token** <br>*optional*|string|
1065 | |**wallet_password** <br>*optional*|string|
1066 |
1067 |
1068 | <a name="exportmasterkeyrequest"></a>
1069 | ### ExportMasterKeyRequest
1070 | APIV1POSTMasterKeyExportRequest is the request for `POST /v1/master-key/export`
1071 |
1072 |
1073 | |Name|Schema|
1074 | |---|---|
1075 | |**wallet_handle_token** <br>*optional*|string|
1076 | |**wallet_password** <br>*optional*|string|
1077 |
1078 |
1079 | <a name="exportmultisigrequest"></a>
1080 | ### ExportMultisigRequest
1081 | APIV1POSTMultisigExportRequest is the request for `POST /v1/multisig/export`
1082 |
1083 |
1084 | |Name|Schema|
1085 | |---|---|
1086 | |**address** <br>*optional*|string|
1087 | |**wallet_handle_token** <br>*optional*|string|
1088 |
1089 |
1090 | <a name="generatekeyrequest"></a>
1091 | ### GenerateKeyRequest
1092 | APIV1POSTKeyRequest is the request for `POST /v1/key`
1093 |
1094 |
1095 | |Name|Schema|
1096 | |---|---|
1097 | |**display_mnemonic** <br>*optional*|boolean|
1098 | |**wallet_handle_token** <br>*optional*|string|
1099 |
1100 |
1101 | <a name="importkeyrequest"></a>
1102 | ### ImportKeyRequest
1103 | APIV1POSTKeyImportRequest is the request for `POST /v1/key/import`
1104 |
1105 |
1106 | |Name|Schema|
1107 | |---|---|
1108 | |**private_key** <br>*optional*|[PrivateKey](#privatekey)|
1109 | |**wallet_handle_token** <br>*optional*|string|
1110 |
1111 |
1112 | <a name="importmultisigrequest"></a>
1113 | ### ImportMultisigRequest
1114 | APIV1POSTMultisigImportRequest is the request for `POST /v1/multisig/import`
1115 |
1116 |
1117 | |Name|Schema|
1118 | |---|---|
1119 | |**multisig_version** <br>*optional*|integer (uint8)|
1120 | |**pks** <br>*optional*|< [PublicKey](#publickey) > array|
1121 | |**threshold** <br>*optional*|integer (uint8)|
1122 | |**wallet_handle_token** <br>*optional*|string|
1123 |
1124 |
1125 | <a name="initwallethandletokenrequest"></a>
1126 | ### InitWalletHandleTokenRequest
1127 | APIV1POSTWalletInitRequest is the request for `POST /v1/wallet/init`
1128 |
1129 |
1130 | |Name|Schema|
1131 | |---|---|
1132 | |**wallet_id** <br>*optional*|string|
1133 | |**wallet_password** <br>*optional*|string|
1134 |
1135 |
1136 | <a name="listkeysrequest"></a>
1137 | ### ListKeysRequest
1138 | APIV1POSTKeyListRequest is the request for `POST /v1/key/list`
1139 |
1140 |
1141 | |Name|Schema|
1142 | |---|---|
1143 | |**wallet_handle_token** <br>*optional*|string|
1144 |
1145 |
1146 | <a name="listmultisigrequest"></a>
1147 | ### ListMultisigRequest
1148 | APIV1POSTMultisigListRequest is the request for `POST /v1/multisig/list`
1149 |
1150 |
1151 | |Name|Schema|
1152 | |---|---|
1153 | |**wallet_handle_token** <br>*optional*|string|
1154 |
1155 |
1156 | <a name="listwalletsrequest"></a>
1157 | ### ListWalletsRequest
1158 | APIV1GETWalletsRequest is the request for `GET /v1/wallets`
1159 |
1160 | *Type* : object
1161 |
1162 |
1163 | <a name="masterderivationkey"></a>
1164 | ### MasterDerivationKey
1165 | MasterDerivationKey is used to derive ed25519 keys for use in wallets
1166 |
1167 | *Type* : < integer (uint8) > array
1168 |
1169 |
1170 | <a name="multisigsig"></a>
1171 | ### MultisigSig
1172 | MultisigSig is the structure that holds multiple Subsigs
1173 |
1174 |
1175 | |Name|Schema|
1176 | |---|---|
1177 | |**Subsigs** <br>*optional*|< [MultisigSubsig](#multisigsubsig) > array|
1178 | |**Threshold** <br>*optional*|integer (uint8)|
1179 | |**Version** <br>*optional*|integer (uint8)|
1180 |
1181 |
1182 | <a name="multisigsubsig"></a>
1183 | ### MultisigSubsig
1184 | MultisigSubsig is a struct that holds a pair of public key and signatures
1185 | signatures may be empty
1186 |
1187 |
1188 | |Name|Schema|
1189 | |---|---|
1190 | |**Key** <br>*optional*|[PublicKey](#publickey)|
1191 | |**Sig** <br>*optional*|[Signature](#signature)|
1192 |
1193 |
1194 | <a name="privatekey"></a>
1195 | ### PrivateKey
1196 | *Type* : < integer (uint8) > array
1197 |
1198 |
1199 | <a name="publickey"></a>
1200 | ### PublicKey
1201 | *Type* : < integer (uint8) > array
1202 |
1203 |
1204 | <a name="releasewallethandletokenrequest"></a>
1205 | ### ReleaseWalletHandleTokenRequest
1206 | APIV1POSTWalletReleaseRequest is the request for `POST /v1/wallet/release`
1207 |
1208 |
1209 | |Name|Schema|
1210 | |---|---|
1211 | |**wallet_handle_token** <br>*optional*|string|
1212 |
1213 |
1214 | <a name="renamewalletrequest"></a>
1215 | ### RenameWalletRequest
1216 | APIV1POSTWalletRenameRequest is the request for `POST /v1/wallet/rename`
1217 |
1218 |
1219 | |Name|Schema|
1220 | |---|---|
1221 | |**wallet_id** <br>*optional*|string|
1222 | |**wallet_name** <br>*optional*|string|
1223 | |**wallet_password** <br>*optional*|string|
1224 |
1225 |
1226 | <a name="renewwallethandletokenrequest"></a>
1227 | ### RenewWalletHandleTokenRequest
1228 | APIV1POSTWalletRenewRequest is the request for `POST /v1/wallet/renew`
1229 |
1230 |
1231 | |Name|Schema|
1232 | |---|---|
1233 | |**wallet_handle_token** <br>*optional*|string|
1234 |
1235 |
1236 | <a name="signmultisigrequest"></a>
1237 | ### SignMultisigRequest
1238 | APIV1POSTMultisigTransactionSignRequest is the request for `POST /v1/multisig/sign`
1239 |
1240 |
1241 | |Name|Description|Schema|
1242 | |---|---|---|
1243 | |**partial_multisig** <br>*optional*||[MultisigSig](#multisigsig)|
1244 | |**public_key** <br>*optional*||[PublicKey](#publickey)|
1245 | |**signer** <br>*optional*||[Digest](#digest)|
1246 | |**transaction** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
1247 | |**wallet_handle_token** <br>*optional*||string|
1248 | |**wallet_password** <br>*optional*||string|
1249 |
1250 |
1251 | <a name="signprogrammultisigrequest"></a>
1252 | ### SignProgramMultisigRequest
1253 | APIV1POSTMultisigProgramSignRequest is the request for `POST /v1/multisig/signprogram`
1254 |
1255 |
1256 | |Name|Description|Schema|
1257 | |---|---|---|
1258 | |**address** <br>*optional*||string|
1259 | |**data** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
1260 | |**partial_multisig** <br>*optional*||[MultisigSig](#multisigsig)|
1261 | |**public_key** <br>*optional*||[PublicKey](#publickey)|
1262 | |**wallet_handle_token** <br>*optional*||string|
1263 | |**wallet_password** <br>*optional*||string|
1264 |
1265 |
1266 | <a name="signprogramrequest"></a>
1267 | ### SignProgramRequest
1268 | APIV1POSTProgramSignRequest is the request for `POST /v1/program/sign`
1269 |
1270 |
1271 | |Name|Description|Schema|
1272 | |---|---|---|
1273 | |**address** <br>*optional*||string|
1274 | |**data** <br>*optional*|**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
1275 | |**wallet_handle_token** <br>*optional*||string|
1276 | |**wallet_password** <br>*optional*||string|
1277 |
1278 |
1279 | <a name="signtransactionrequest"></a>
1280 | ### SignTransactionRequest
1281 | APIV1POSTTransactionSignRequest is the request for `POST /v1/transaction/sign`
1282 |
1283 |
1284 | |Name|Description|Schema|
1285 | |---|---|---|
1286 | |**public_key** <br>*optional*||[PublicKey](#publickey)|
1287 | |**transaction** <br>*optional*|Base64 encoding of msgpack encoding of a `Transaction` object<br>Note: SDK and goal usually generate `SignedTxn` objects<br>in that case, the field `txn` / `Transaction` of the<br>generated `SignedTxn` object needs to be used <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
1288 | |**wallet_handle_token** <br>*optional*||string|
1289 | |**wallet_password** <br>*optional*||string|
1290 |
1291 |
1292 | <a name="signature"></a>
1293 | ### Signature
1294 | *Type* : < integer (uint8) > array
1295 |
1296 |
1297 | <a name="txtype"></a>
1298 | ### TxType
1299 | TxType is the type of the transaction written to the ledger
1300 |
1301 | *Type* : string
1302 |
1303 |
1304 | <a name="versionsrequest"></a>
1305 | ### VersionsRequest
1306 | VersionsRequest is the request for `GET /versions`
1307 |
1308 | *Type* : object
1309 |
1310 |
1311 | <a name="versionsresponse"></a>
1312 | ### VersionsResponse
1313 | VersionsResponse is the response to `GET /versions`
1314 | friendly:VersionsResponse
1315 |
1316 |
1317 | |Name|Schema|
1318 | |---|---|
1319 | |**versions** <br>*optional*|< string > array|
1320 |
1321 |
1322 | <a name="walletinforequest"></a>
1323 | ### WalletInfoRequest
1324 | APIV1POSTWalletInfoRequest is the request for `POST /v1/wallet/info`
1325 |
1326 |
1327 | |Name|Schema|
1328 | |---|---|
1329 | |**wallet_handle_token** <br>*optional*|string|
1330 |
1331 |
1332 | <a name="ed25519privatekey"></a>
1333 | ### ed25519PrivateKey
1334 | *Type* : < integer (uint8) > array
1335 |
1336 |
1337 | <a name="ed25519publickey"></a>
1338 | ### ed25519PublicKey
1339 | *Type* : < integer (uint8) > array
1340 |
1341 |
1342 | <a name="ed25519signature"></a>
1343 | ### ed25519Signature
1344 | *Type* : < integer (uint8) > array
1345 |
1346 |
1347 |
1348 |
```