This is page 78 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:modules.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](README.md) / Exports
2 |
3 | # algosdk
4 |
5 | ## Table of contents
6 |
7 | ### Namespaces
8 |
9 | - [indexerModels](modules/indexerModels.md)
10 | - [modelsv2](modules/modelsv2.md)
11 |
12 | ### Enumerations
13 |
14 | - [ABIReferenceType](enums/ABIReferenceType.md)
15 | - [ABITransactionType](enums/ABITransactionType.md)
16 | - [AtomicTransactionComposerStatus](enums/AtomicTransactionComposerStatus.md)
17 | - [IntDecoding](enums/IntDecoding.md)
18 | - [OnApplicationComplete](enums/OnApplicationComplete.md)
19 | - [TransactionType](enums/TransactionType.md)
20 |
21 | ### Classes
22 |
23 | - [ABIAddressType](classes/ABIAddressType.md)
24 | - [ABIArrayDynamicType](classes/ABIArrayDynamicType.md)
25 | - [ABIArrayStaticType](classes/ABIArrayStaticType.md)
26 | - [ABIBoolType](classes/ABIBoolType.md)
27 | - [ABIByteType](classes/ABIByteType.md)
28 | - [ABIContract](classes/ABIContract.md)
29 | - [ABIInterface](classes/ABIInterface.md)
30 | - [ABIMethod](classes/ABIMethod.md)
31 | - [ABIStringType](classes/ABIStringType.md)
32 | - [ABITupleType](classes/ABITupleType.md)
33 | - [ABIType](classes/ABIType.md)
34 | - [ABIUfixedType](classes/ABIUfixedType.md)
35 | - [ABIUintType](classes/ABIUintType.md)
36 | - [Algodv2](classes/Algodv2.md)
37 | - [AtomicTransactionComposer](classes/AtomicTransactionComposer.md)
38 | - [DryrunResult](classes/DryrunResult.md)
39 | - [Indexer](classes/Indexer.md)
40 | - [Kmd](classes/Kmd.md)
41 | - [LogicSig](classes/LogicSig.md)
42 | - [LogicSigAccount](classes/LogicSigAccount.md)
43 | - [SourceMap](classes/SourceMap.md)
44 | - [Transaction](classes/Transaction.md)
45 |
46 | ### Interfaces
47 |
48 | - [ABIContractNetworkInfo](interfaces/ABIContractNetworkInfo.md)
49 | - [ABIContractNetworks](interfaces/ABIContractNetworks.md)
50 | - [ABIContractParams](interfaces/ABIContractParams.md)
51 | - [ABIInterfaceParams](interfaces/ABIInterfaceParams.md)
52 | - [ABIMethodArgParams](interfaces/ABIMethodArgParams.md)
53 | - [ABIMethodParams](interfaces/ABIMethodParams.md)
54 | - [ABIMethodReturnParams](interfaces/ABIMethodReturnParams.md)
55 | - [ABIResult](interfaces/ABIResult.md)
56 | - [Account](interfaces/Account.md)
57 | - [Address](interfaces/Address.md)
58 | - [AlgodTokenHeader](interfaces/AlgodTokenHeader.md)
59 | - [BaseHTTPClient](interfaces/BaseHTTPClient.md)
60 | - [BaseHTTPClientError](interfaces/BaseHTTPClientError.md)
61 | - [BaseHTTPClientResponse](interfaces/BaseHTTPClientResponse.md)
62 | - [BoxReference](interfaces/BoxReference.md)
63 | - [CustomTokenHeader](interfaces/CustomTokenHeader.md)
64 | - [EncodedAssetParams](interfaces/EncodedAssetParams.md)
65 | - [EncodedBoxReference](interfaces/EncodedBoxReference.md)
66 | - [EncodedGlobalStateSchema](interfaces/EncodedGlobalStateSchema.md)
67 | - [EncodedLocalStateSchema](interfaces/EncodedLocalStateSchema.md)
68 | - [EncodedLogicSig](interfaces/EncodedLogicSig.md)
69 | - [EncodedLogicSigAccount](interfaces/EncodedLogicSigAccount.md)
70 | - [EncodedMultisig](interfaces/EncodedMultisig.md)
71 | - [EncodedSignedTransaction](interfaces/EncodedSignedTransaction.md)
72 | - [EncodedSubsig](interfaces/EncodedSubsig.md)
73 | - [EncodedTransaction](interfaces/EncodedTransaction.md)
74 | - [IndexerTokenHeader](interfaces/IndexerTokenHeader.md)
75 | - [KMDTokenHeader](interfaces/KMDTokenHeader.md)
76 | - [MultisigMetadata](interfaces/MultisigMetadata.md)
77 | - [SignedTransaction](interfaces/SignedTransaction.md)
78 | - [SuggestedParams](interfaces/SuggestedParams.md)
79 | - [TransactionParams](interfaces/TransactionParams.md)
80 | - [TransactionWithSigner](interfaces/TransactionWithSigner.md)
81 |
82 | ### Type Aliases
83 |
84 | - [ABIArgument](modules.md#abiargument)
85 | - [ABIArgumentType](modules.md#abiargumenttype)
86 | - [ABIReturnType](modules.md#abireturntype)
87 | - [ABIValue](modules.md#abivalue)
88 | - [AppClearStateTxn](modules.md#appclearstatetxn)
89 | - [AppCloseOutTxn](modules.md#appcloseouttxn)
90 | - [AppCreateTxn](modules.md#appcreatetxn)
91 | - [AppDeleteTxn](modules.md#appdeletetxn)
92 | - [AppNoOpTxn](modules.md#appnooptxn)
93 | - [AppOptInTxn](modules.md#appoptintxn)
94 | - [AppUpdateTxn](modules.md#appupdatetxn)
95 | - [AssetConfigTxn](modules.md#assetconfigtxn)
96 | - [AssetCreateTxn](modules.md#assetcreatetxn)
97 | - [AssetDestroyTxn](modules.md#assetdestroytxn)
98 | - [AssetFreezeTxn](modules.md#assetfreezetxn)
99 | - [AssetTransferTxn](modules.md#assettransfertxn)
100 | - [KeyRegistrationTxn](modules.md#keyregistrationtxn)
101 | - [MustHaveSuggestedParams](modules.md#musthavesuggestedparams)
102 | - [MustHaveSuggestedParamsInline](modules.md#musthavesuggestedparamsinline)
103 | - [PaymentTxn](modules.md#paymenttxn)
104 | - [StateProofTxn](modules.md#stateprooftxn)
105 | - [TokenHeader](modules.md#tokenheader)
106 | - [TransactionLike](modules.md#transactionlike)
107 | - [TransactionSigner](modules.md#transactionsigner)
108 |
109 | ### Variables
110 |
111 | - [ADDR\_BYTE\_SIZE](modules.md#addr_byte_size)
112 | - [ALGORAND\_MIN\_TX\_FEE](modules.md#algorand_min_tx_fee)
113 | - [ERROR\_INVALID\_MICROALGOS](modules.md#error_invalid_microalgos)
114 | - [ERROR\_MULTISIG\_BAD\_SENDER](modules.md#error_multisig_bad_sender)
115 | - [INVALID\_MICROALGOS\_ERROR\_MSG](modules.md#invalid_microalgos_error_msg)
116 | - [LENGTH\_ENCODE\_BYTE\_SIZE](modules.md#length_encode_byte_size)
117 | - [MAX\_LEN](modules.md#max_len)
118 | - [MULTISIG\_BAD\_SENDER\_ERROR\_MSG](modules.md#multisig_bad_sender_error_msg)
119 | - [SINGLE\_BOOL\_SIZE](modules.md#single_bool_size)
120 | - [SINGLE\_BYTE\_SIZE](modules.md#single_byte_size)
121 |
122 | ### Functions
123 |
124 | - [abiCheckTransactionType](modules.md#abichecktransactiontype)
125 | - [abiTypeIsReference](modules.md#abitypeisreference)
126 | - [abiTypeIsTransaction](modules.md#abitypeistransaction)
127 | - [algosToMicroalgos](modules.md#algostomicroalgos)
128 | - [appendSignMultisigTransaction](modules.md#appendsignmultisigtransaction)
129 | - [appendSignRawMultisigSignature](modules.md#appendsignrawmultisigsignature)
130 | - [assignGroupID](modules.md#assigngroupid)
131 | - [bigIntToBytes](modules.md#biginttobytes)
132 | - [bytesToBigInt](modules.md#bytestobigint)
133 | - [computeGroupID](modules.md#computegroupid)
134 | - [createDryrun](modules.md#createdryrun)
135 | - [createMultisigTransaction](modules.md#createmultisigtransaction)
136 | - [decodeAddress](modules.md#decodeaddress)
137 | - [decodeObj](modules.md#decodeobj)
138 | - [decodeSignedTransaction](modules.md#decodesignedtransaction)
139 | - [decodeUint64](modules.md#decodeuint64)
140 | - [decodeUnsignedTransaction](modules.md#decodeunsignedtransaction)
141 | - [encodeAddress](modules.md#encodeaddress)
142 | - [encodeObj](modules.md#encodeobj)
143 | - [encodeUint64](modules.md#encodeuint64)
144 | - [encodeUnsignedSimulateTransaction](modules.md#encodeunsignedsimulatetransaction)
145 | - [encodeUnsignedTransaction](modules.md#encodeunsignedtransaction)
146 | - [generateAccount](modules.md#generateaccount)
147 | - [getApplicationAddress](modules.md#getapplicationaddress)
148 | - [getMethodByName](modules.md#getmethodbyname)
149 | - [instantiateTxnIfNeeded](modules.md#instantiatetxnifneeded)
150 | - [isTransactionWithSigner](modules.md#istransactionwithsigner)
151 | - [isValidAddress](modules.md#isvalidaddress)
152 | - [logicSigFromByte](modules.md#logicsigfrombyte)
153 | - [makeApplicationCallTxnFromObject](modules.md#makeapplicationcalltxnfromobject)
154 | - [makeApplicationClearStateTxn](modules.md#makeapplicationclearstatetxn)
155 | - [makeApplicationClearStateTxnFromObject](modules.md#makeapplicationclearstatetxnfromobject)
156 | - [makeApplicationCloseOutTxn](modules.md#makeapplicationcloseouttxn)
157 | - [makeApplicationCloseOutTxnFromObject](modules.md#makeapplicationcloseouttxnfromobject)
158 | - [makeApplicationCreateTxn](modules.md#makeapplicationcreatetxn)
159 | - [makeApplicationCreateTxnFromObject](modules.md#makeapplicationcreatetxnfromobject)
160 | - [makeApplicationDeleteTxn](modules.md#makeapplicationdeletetxn)
161 | - [makeApplicationDeleteTxnFromObject](modules.md#makeapplicationdeletetxnfromobject)
162 | - [makeApplicationNoOpTxn](modules.md#makeapplicationnooptxn)
163 | - [makeApplicationNoOpTxnFromObject](modules.md#makeapplicationnooptxnfromobject)
164 | - [makeApplicationOptInTxn](modules.md#makeapplicationoptintxn)
165 | - [makeApplicationOptInTxnFromObject](modules.md#makeapplicationoptintxnfromobject)
166 | - [makeApplicationUpdateTxn](modules.md#makeapplicationupdatetxn)
167 | - [makeApplicationUpdateTxnFromObject](modules.md#makeapplicationupdatetxnfromobject)
168 | - [makeAssetConfigTxnWithSuggestedParams](modules.md#makeassetconfigtxnwithsuggestedparams)
169 | - [makeAssetConfigTxnWithSuggestedParamsFromObject](modules.md#makeassetconfigtxnwithsuggestedparamsfromobject)
170 | - [makeAssetCreateTxnWithSuggestedParams](modules.md#makeassetcreatetxnwithsuggestedparams)
171 | - [makeAssetCreateTxnWithSuggestedParamsFromObject](modules.md#makeassetcreatetxnwithsuggestedparamsfromobject)
172 | - [makeAssetDestroyTxnWithSuggestedParams](modules.md#makeassetdestroytxnwithsuggestedparams)
173 | - [makeAssetDestroyTxnWithSuggestedParamsFromObject](modules.md#makeassetdestroytxnwithsuggestedparamsfromobject)
174 | - [makeAssetFreezeTxnWithSuggestedParams](modules.md#makeassetfreezetxnwithsuggestedparams)
175 | - [makeAssetFreezeTxnWithSuggestedParamsFromObject](modules.md#makeassetfreezetxnwithsuggestedparamsfromobject)
176 | - [makeAssetTransferTxnWithSuggestedParams](modules.md#makeassettransfertxnwithsuggestedparams)
177 | - [makeAssetTransferTxnWithSuggestedParamsFromObject](modules.md#makeassettransfertxnwithsuggestedparamsfromobject)
178 | - [makeBasicAccountTransactionSigner](modules.md#makebasicaccounttransactionsigner)
179 | - [makeEmptyTransactionSigner](modules.md#makeemptytransactionsigner)
180 | - [makeKeyRegistrationTxnWithSuggestedParams](modules.md#makekeyregistrationtxnwithsuggestedparams)
181 | - [makeKeyRegistrationTxnWithSuggestedParamsFromObject](modules.md#makekeyregistrationtxnwithsuggestedparamsfromobject)
182 | - [makeLogicSigAccountTransactionSigner](modules.md#makelogicsigaccounttransactionsigner)
183 | - [makeMultiSigAccountTransactionSigner](modules.md#makemultisigaccounttransactionsigner)
184 | - [makePaymentTxnWithSuggestedParams](modules.md#makepaymenttxnwithsuggestedparams)
185 | - [makePaymentTxnWithSuggestedParamsFromObject](modules.md#makepaymenttxnwithsuggestedparamsfromobject)
186 | - [masterDerivationKeyToMnemonic](modules.md#masterderivationkeytomnemonic)
187 | - [mergeMultisigTransactions](modules.md#mergemultisigtransactions)
188 | - [microalgosToAlgos](modules.md#microalgostoalgos)
189 | - [mnemonicFromSeed](modules.md#mnemonicfromseed)
190 | - [mnemonicToMasterDerivationKey](modules.md#mnemonictomasterderivationkey)
191 | - [mnemonicToSecretKey](modules.md#mnemonictosecretkey)
192 | - [multisigAddress](modules.md#multisigaddress)
193 | - [secretKeyToMnemonic](modules.md#secretkeytomnemonic)
194 | - [seedFromMnemonic](modules.md#seedfrommnemonic)
195 | - [signBid](modules.md#signbid)
196 | - [signBytes](modules.md#signbytes)
197 | - [signLogicSigTransaction](modules.md#signlogicsigtransaction)
198 | - [signLogicSigTransactionObject](modules.md#signlogicsigtransactionobject)
199 | - [signMultisigTransaction](modules.md#signmultisigtransaction)
200 | - [signTransaction](modules.md#signtransaction)
201 | - [tealSign](modules.md#tealsign)
202 | - [tealSignFromProgram](modules.md#tealsignfromprogram)
203 | - [verifyBytes](modules.md#verifybytes)
204 | - [verifyMultisig](modules.md#verifymultisig)
205 | - [verifyTealSign](modules.md#verifytealsign)
206 | - [waitForConfirmation](modules.md#waitforconfirmation)
207 |
208 | ## Type Aliases
209 |
210 | ### ABIArgument
211 |
212 | Ƭ **ABIArgument**: [`ABIValue`](modules.md#abivalue) \| [`TransactionWithSigner`](interfaces/TransactionWithSigner.md)
213 |
214 | #### Defined in
215 |
216 | composer.ts:43
217 |
218 | ___
219 |
220 | ### ABIArgumentType
221 |
222 | Ƭ **ABIArgumentType**: [`ABIType`](classes/ABIType.md) \| [`ABITransactionType`](enums/ABITransactionType.md) \| [`ABIReferenceType`](enums/ABIReferenceType.md)
223 |
224 | #### Defined in
225 |
226 | abi/method.ts:71
227 |
228 | ___
229 |
230 | ### ABIReturnType
231 |
232 | Ƭ **ABIReturnType**: [`ABIType`](classes/ABIType.md) \| ``"void"``
233 |
234 | #### Defined in
235 |
236 | abi/method.ts:73
237 |
238 | ___
239 |
240 | ### ABIValue
241 |
242 | Ƭ **ABIValue**: `boolean` \| `number` \| `bigint` \| `string` \| `Uint8Array` \| [`ABIValue`](modules.md#abivalue)[]
243 |
244 | #### Defined in
245 |
246 | abi/abi_type.ts:35
247 |
248 | ___
249 |
250 | ### AppClearStateTxn
251 |
252 | Ƭ **AppClearStateTxn**: [`AppDeleteTxn`](modules.md#appdeletetxn)
253 |
254 | #### Defined in
255 |
256 | types/transactions/application.ts:104
257 |
258 | ___
259 |
260 | ### AppCloseOutTxn
261 |
262 | Ƭ **AppCloseOutTxn**: [`AppDeleteTxn`](modules.md#appdeletetxn)
263 |
264 | #### Defined in
265 |
266 | types/transactions/application.ts:97
267 |
268 | ___
269 |
270 | ### AppCreateTxn
271 |
272 | Ƭ **AppCreateTxn**: `ConstructTransaction`\<`SpecificParametersForCreate`, `OverwritesForCreate`\>
273 |
274 | #### Defined in
275 |
276 | types/transactions/application.ts:30
277 |
278 | ___
279 |
280 | ### AppDeleteTxn
281 |
282 | Ƭ **AppDeleteTxn**: `ConstructTransaction`\<`SpecificParametersForDelete`, `OverwritesForDelete`\>
283 |
284 | #### Defined in
285 |
286 | types/transactions/application.ts:80
287 |
288 | ___
289 |
290 | ### AppNoOpTxn
291 |
292 | Ƭ **AppNoOpTxn**: [`AppDeleteTxn`](modules.md#appdeletetxn)
293 |
294 | #### Defined in
295 |
296 | types/transactions/application.ts:111
297 |
298 | ___
299 |
300 | ### AppOptInTxn
301 |
302 | Ƭ **AppOptInTxn**: [`AppDeleteTxn`](modules.md#appdeletetxn)
303 |
304 | #### Defined in
305 |
306 | types/transactions/application.ts:90
307 |
308 | ___
309 |
310 | ### AppUpdateTxn
311 |
312 | Ƭ **AppUpdateTxn**: `ConstructTransaction`\<`SpecificParametersForUpdate`, `OverwritesForUpdate`\>
313 |
314 | #### Defined in
315 |
316 | types/transactions/application.ts:56
317 |
318 | ___
319 |
320 | ### AssetConfigTxn
321 |
322 | Ƭ **AssetConfigTxn**: `ConstructTransaction`\<`SpecificParametersForConfig`, `OverwritesForConfig`\>
323 |
324 | #### Defined in
325 |
326 | types/transactions/asset.ts:49
327 |
328 | ___
329 |
330 | ### AssetCreateTxn
331 |
332 | Ƭ **AssetCreateTxn**: `ConstructTransaction`\<`SpecificParametersForCreate`, `OverwritesForCreate`\>
333 |
334 | #### Defined in
335 |
336 | types/transactions/asset.ts:27
337 |
338 | ___
339 |
340 | ### AssetDestroyTxn
341 |
342 | Ƭ **AssetDestroyTxn**: `ConstructTransaction`\<`SpecificParametersForDestroy`, `OverwritesForDestroy`\>
343 |
344 | #### Defined in
345 |
346 | types/transactions/asset.ts:64
347 |
348 | ___
349 |
350 | ### AssetFreezeTxn
351 |
352 | Ƭ **AssetFreezeTxn**: `ConstructTransaction`\<`SpecificParametersForFreeze`, `OverwritesForFreeze`\>
353 |
354 | #### Defined in
355 |
356 | types/transactions/asset.ts:82
357 |
358 | ___
359 |
360 | ### AssetTransferTxn
361 |
362 | Ƭ **AssetTransferTxn**: `ConstructTransaction`\<`SpecificParametersForTransfer`, `OverwritesForTransfer`\>
363 |
364 | #### Defined in
365 |
366 | types/transactions/asset.ts:105
367 |
368 | ___
369 |
370 | ### KeyRegistrationTxn
371 |
372 | Ƭ **KeyRegistrationTxn**: `ConstructTransaction`\<`SpecificParameters`, `Overwrites`\>
373 |
374 | #### Defined in
375 |
376 | types/transactions/keyreg.ts:19
377 |
378 | ___
379 |
380 | ### MustHaveSuggestedParams
381 |
382 | Ƭ **MustHaveSuggestedParams**\<`T`\>: `Extract`\<`T`, \{ `suggestedParams`: [`SuggestedParams`](interfaces/SuggestedParams.md) }\>
383 |
384 | Only accept transaction objects that include suggestedParams as an object
385 |
386 | #### Type parameters
387 |
388 | | Name | Type |
389 | | :------ | :------ |
390 | | `T` | extends `ConstructTransaction` |
391 |
392 | #### Defined in
393 |
394 | types/transactions/builder.ts:56
395 |
396 | ___
397 |
398 | ### MustHaveSuggestedParamsInline
399 |
400 | Ƭ **MustHaveSuggestedParamsInline**\<`T`\>: `Extract`\<`T`, [`SuggestedParams`](interfaces/SuggestedParams.md)\>
401 |
402 | Only accept transaction objects that include suggestedParams inline instead of being
403 | enclosed in its own property
404 |
405 | #### Type parameters
406 |
407 | | Name | Type |
408 | | :------ | :------ |
409 | | `T` | extends `ConstructTransaction` |
410 |
411 | #### Defined in
412 |
413 | types/transactions/builder.ts:65
414 |
415 | ___
416 |
417 | ### PaymentTxn
418 |
419 | Ƭ **PaymentTxn**: `ConstructTransaction`\<`SpecificParameters`, `Overwrites`\>
420 |
421 | #### Defined in
422 |
423 | types/transactions/payment.ts:13
424 |
425 | ___
426 |
427 | ### StateProofTxn
428 |
429 | Ƭ **StateProofTxn**: `ConstructTransaction`\<`SpecificParameters`, `Overwrites`\>
430 |
431 | #### Defined in
432 |
433 | types/transactions/stateproof.ts:13
434 |
435 | ___
436 |
437 | ### TokenHeader
438 |
439 | Ƭ **TokenHeader**: [`AlgodTokenHeader`](interfaces/AlgodTokenHeader.md) \| [`IndexerTokenHeader`](interfaces/IndexerTokenHeader.md) \| [`KMDTokenHeader`](interfaces/KMDTokenHeader.md) \| [`CustomTokenHeader`](interfaces/CustomTokenHeader.md)
440 |
441 | #### Defined in
442 |
443 | client/urlTokenBaseHTTPClient.ts:33
444 |
445 | ___
446 |
447 | ### TransactionLike
448 |
449 | Ƭ **TransactionLike**: `AnyTransaction` \| [`Transaction`](classes/Transaction.md)
450 |
451 | Either a valid transaction object or an instance of the Transaction class
452 |
453 | #### Defined in
454 |
455 | transaction.ts:1373
456 |
457 | ___
458 |
459 | ### TransactionSigner
460 |
461 | Ƭ **TransactionSigner**: (`txnGroup`: [`Transaction`](classes/Transaction.md)[], `indexesToSign`: `number`[]) => `Promise`\<`Uint8Array`[]\>
462 |
463 | #### Type declaration
464 |
465 | ▸ (`txnGroup`, `indexesToSign`): `Promise`\<`Uint8Array`[]\>
466 |
467 | This type represents a function which can sign transactions from an atomic transaction group.
468 |
469 | ##### Parameters
470 |
471 | | Name | Type | Description |
472 | | :------ | :------ | :------ |
473 | | `txnGroup` | [`Transaction`](classes/Transaction.md)[] | The atomic group containing transactions to be signed |
474 | | `indexesToSign` | `number`[] | An array of indexes in the atomic transaction group that should be signed |
475 |
476 | ##### Returns
477 |
478 | `Promise`\<`Uint8Array`[]\>
479 |
480 | A promise which resolves an array of encoded signed transactions. The length of the
481 | array will be the same as the length of indexesToSign, and each index i in the array
482 | corresponds to the signed transaction from txnGroup[indexesToSign[i]]
483 |
484 | #### Defined in
485 |
486 | signer.ts:15
487 |
488 | ## Variables
489 |
490 | ### ADDR\_BYTE\_SIZE
491 |
492 | • `Const` **ADDR\_BYTE\_SIZE**: ``32``
493 |
494 | #### Defined in
495 |
496 | abi/abi_type.ts:22
497 |
498 | ___
499 |
500 | ### ALGORAND\_MIN\_TX\_FEE
501 |
502 | • `Const` **ALGORAND\_MIN\_TX\_FEE**: ``1000``
503 |
504 | #### Defined in
505 |
506 | transaction.ts:26
507 |
508 | ___
509 |
510 | ### ERROR\_INVALID\_MICROALGOS
511 |
512 | • `Const` **ERROR\_INVALID\_MICROALGOS**: `Error`
513 |
514 | #### Defined in
515 |
516 | main.ts:116
517 |
518 | ___
519 |
520 | ### ERROR\_MULTISIG\_BAD\_SENDER
521 |
522 | • `Const` **ERROR\_MULTISIG\_BAD\_SENDER**: `Error`
523 |
524 | #### Defined in
525 |
526 | main.ts:113
527 |
528 | ___
529 |
530 | ### INVALID\_MICROALGOS\_ERROR\_MSG
531 |
532 | • `Const` **INVALID\_MICROALGOS\_ERROR\_MSG**: ``"Microalgos should be positive and less than 2^53 - 1."``
533 |
534 | #### Defined in
535 |
536 | convert.ts:2
537 |
538 | ___
539 |
540 | ### LENGTH\_ENCODE\_BYTE\_SIZE
541 |
542 | • `Const` **LENGTH\_ENCODE\_BYTE\_SIZE**: ``2``
543 |
544 | #### Defined in
545 |
546 | abi/abi_type.ts:25
547 |
548 | ___
549 |
550 | ### MAX\_LEN
551 |
552 | • `Const` **MAX\_LEN**: `number`
553 |
554 | #### Defined in
555 |
556 | abi/abi_type.ts:21
557 |
558 | ___
559 |
560 | ### MULTISIG\_BAD\_SENDER\_ERROR\_MSG
561 |
562 | • `Const` **MULTISIG\_BAD\_SENDER\_ERROR\_MSG**: ``"The transaction sender address and multisig preimage do not match."``
563 |
564 | #### Defined in
565 |
566 | main.ts:13
567 |
568 | ___
569 |
570 | ### SINGLE\_BOOL\_SIZE
571 |
572 | • `Const` **SINGLE\_BOOL\_SIZE**: ``1``
573 |
574 | #### Defined in
575 |
576 | abi/abi_type.ts:24
577 |
578 | ___
579 |
580 | ### SINGLE\_BYTE\_SIZE
581 |
582 | • `Const` **SINGLE\_BYTE\_SIZE**: ``1``
583 |
584 | #### Defined in
585 |
586 | abi/abi_type.ts:23
587 |
588 | ## Functions
589 |
590 | ### abiCheckTransactionType
591 |
592 | ▸ **abiCheckTransactionType**(`type`, `txn`): `boolean`
593 |
594 | #### Parameters
595 |
596 | | Name | Type |
597 | | :------ | :------ |
598 | | `type` | [`ABITransactionType`](enums/ABITransactionType.md) |
599 | | `txn` | [`Transaction`](classes/Transaction.md) |
600 |
601 | #### Returns
602 |
603 | `boolean`
604 |
605 | #### Defined in
606 |
607 | abi/transaction.ts:52
608 |
609 | ___
610 |
611 | ### abiTypeIsReference
612 |
613 | ▸ **abiTypeIsReference**(`type`): type is ABIReferenceType
614 |
615 | #### Parameters
616 |
617 | | Name | Type |
618 | | :------ | :------ |
619 | | `type` | `any` |
620 |
621 | #### Returns
622 |
623 | type is ABIReferenceType
624 |
625 | #### Defined in
626 |
627 | abi/reference.ts:18
628 |
629 | ___
630 |
631 | ### abiTypeIsTransaction
632 |
633 | ▸ **abiTypeIsTransaction**(`type`): type is ABITransactionType
634 |
635 | #### Parameters
636 |
637 | | Name | Type |
638 | | :------ | :------ |
639 | | `type` | `any` |
640 |
641 | #### Returns
642 |
643 | type is ABITransactionType
644 |
645 | #### Defined in
646 |
647 | abi/transaction.ts:40
648 |
649 | ___
650 |
651 | ### algosToMicroalgos
652 |
653 | ▸ **algosToMicroalgos**(`algos`): `number`
654 |
655 | algosToMicroalgos converts algos to microalgos
656 |
657 | #### Parameters
658 |
659 | | Name | Type | Description |
660 | | :------ | :------ | :------ |
661 | | `algos` | `number` | number |
662 |
663 | #### Returns
664 |
665 | `number`
666 |
667 | number
668 |
669 | #### Defined in
670 |
671 | convert.ts:22
672 |
673 | ___
674 |
675 | ### appendSignMultisigTransaction
676 |
677 | ▸ **appendSignMultisigTransaction**(`multisigTxnBlob`, `«destructured»`, `sk`): `Object`
678 |
679 | appendSignMultisigTransaction takes a multisig transaction blob, and appends our signature to it.
680 | While we could derive public key preimagery from the partially-signed multisig transaction,
681 | we ask the caller to pass it back in, to ensure they know what they are signing.
682 |
683 | #### Parameters
684 |
685 | | Name | Type | Description |
686 | | :------ | :------ | :------ |
687 | | `multisigTxnBlob` | `Uint8Array` | an encoded multisig txn. Supports non-payment txn types. |
688 | | `«destructured»` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) | - |
689 | | `sk` | `Uint8Array` | Algorand secret key |
690 |
691 | #### Returns
692 |
693 | `Object`
694 |
695 | object containing txID, and blob representing encoded multisig txn
696 |
697 | | Name | Type |
698 | | :------ | :------ |
699 | | `blob` | `Uint8Array` |
700 | | `txID` | `string` |
701 |
702 | #### Defined in
703 |
704 | multisig.ts:429
705 |
706 | ___
707 |
708 | ### appendSignRawMultisigSignature
709 |
710 | ▸ **appendSignRawMultisigSignature**(`multisigTxnBlob`, `«destructured»`, `signerAddr`, `signature`): `Object`
711 |
712 | appendMultisigTransactionSignature takes a multisig transaction blob, and appends a given raw signature to it.
713 | This makes it possible to compile a multisig signature using only raw signatures from external methods.
714 |
715 | #### Parameters
716 |
717 | | Name | Type | Description |
718 | | :------ | :------ | :------ |
719 | | `multisigTxnBlob` | `Uint8Array` | an encoded multisig txn. Supports non-payment txn types. |
720 | | `«destructured»` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) | - |
721 | | `signerAddr` | `string` | address of the signer |
722 | | `signature` | `Uint8Array` | raw multisig signature |
723 |
724 | #### Returns
725 |
726 | `Object`
727 |
728 | object containing txID, and blob representing encoded multisig txn
729 |
730 | | Name | Type |
731 | | :------ | :------ |
732 | | `blob` | `Uint8Array` |
733 | | `txID` | `string` |
734 |
735 | #### Defined in
736 |
737 | multisig.ts:461
738 |
739 | ___
740 |
741 | ### assignGroupID
742 |
743 | ▸ **assignGroupID**(`txns`, `from?`): [`Transaction`](classes/Transaction.md)[]
744 |
745 | assignGroupID assigns group id to a given list of unsigned transactions
746 |
747 | #### Parameters
748 |
749 | | Name | Type | Description |
750 | | :------ | :------ | :------ |
751 | | `txns` | [`TransactionLike`](modules.md#transactionlike)[] | array of transactions (every element is a dict or Transaction) |
752 | | `from?` | `string` | optional sender address specifying which transaction return |
753 |
754 | #### Returns
755 |
756 | [`Transaction`](classes/Transaction.md)[]
757 |
758 | possible list of matching transactions
759 |
760 | #### Defined in
761 |
762 | group.ts:82
763 |
764 | ___
765 |
766 | ### bigIntToBytes
767 |
768 | ▸ **bigIntToBytes**(`bi`, `size`): `Uint8Array`
769 |
770 | bigIntToBytes converts a BigInt to a big-endian Uint8Array for encoding.
771 |
772 | #### Parameters
773 |
774 | | Name | Type | Description |
775 | | :------ | :------ | :------ |
776 | | `bi` | `number` \| `bigint` | The bigint to convert. |
777 | | `size` | `number` | The size of the resulting byte array. |
778 |
779 | #### Returns
780 |
781 | `Uint8Array`
782 |
783 | A byte array containing the big-endian encoding of the input bigint
784 |
785 | #### Defined in
786 |
787 | encoding/bigint.ts:9
788 |
789 | ___
790 |
791 | ### bytesToBigInt
792 |
793 | ▸ **bytesToBigInt**(`bytes`): `bigint`
794 |
795 | bytesToBigInt produces a bigint from a binary representation.
796 |
797 | #### Parameters
798 |
799 | | Name | Type | Description |
800 | | :------ | :------ | :------ |
801 | | `bytes` | `Uint8Array` | The Uint8Array to convert. |
802 |
803 | #### Returns
804 |
805 | `bigint`
806 |
807 | The bigint that was encoded in the input data.
808 |
809 | #### Defined in
810 |
811 | encoding/bigint.ts:28
812 |
813 | ___
814 |
815 | ### computeGroupID
816 |
817 | ▸ **computeGroupID**(`txns`): `Buffer`
818 |
819 | computeGroupID returns group ID for a group of transactions
820 |
821 | #### Parameters
822 |
823 | | Name | Type | Description |
824 | | :------ | :------ | :------ |
825 | | `txns` | [`TransactionLike`](modules.md#transactionlike)[] | array of transactions (every element is a dict or Transaction) |
826 |
827 | #### Returns
828 |
829 | `Buffer`
830 |
831 | Buffer
832 |
833 | #### Defined in
834 |
835 | group.ts:61
836 |
837 | ___
838 |
839 | ### createDryrun
840 |
841 | ▸ **createDryrun**(`«destructured»`): `Promise`\<[`DryrunRequest`](classes/modelsv2.DryrunRequest.md)\>
842 |
843 | createDryrun takes an Algod Client (from algod.AlgodV2Client) and an array of Signed Transactions
844 | from (transaction.SignedTransaction) and creates a DryrunRequest object with relevant balances
845 |
846 | #### Parameters
847 |
848 | | Name | Type |
849 | | :------ | :------ |
850 | | `«destructured»` | `Object` |
851 | | › `client` | [`Algodv2`](classes/Algodv2.md) |
852 | | › `latestTimestamp?` | `number` \| `bigint` |
853 | | › `protocolVersion?` | `string` |
854 | | › `round?` | `number` \| `bigint` |
855 | | › `sources?` | [`DryrunSource`](classes/modelsv2.DryrunSource.md)[] |
856 | | › `txns` | [`SignedTransaction`](interfaces/SignedTransaction.md)[] |
857 |
858 | #### Returns
859 |
860 | `Promise`\<[`DryrunRequest`](classes/modelsv2.DryrunRequest.md)\>
861 |
862 | the DryrunRequest object constructed from the SignedTransactions passed
863 |
864 | #### Defined in
865 |
866 | dryrun.ts:55
867 |
868 | ___
869 |
870 | ### createMultisigTransaction
871 |
872 | ▸ **createMultisigTransaction**(`txn`, `«destructured»`): `Uint8Array`
873 |
874 | createMultisigTransaction creates a raw, unsigned multisig transaction blob.
875 |
876 | #### Parameters
877 |
878 | | Name | Type | Description |
879 | | :------ | :------ | :------ |
880 | | `txn` | [`Transaction`](classes/Transaction.md) | the actual transaction. |
881 | | `«destructured»` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) | - |
882 |
883 | #### Returns
884 |
885 | `Uint8Array`
886 |
887 | encoded multisig blob
888 |
889 | #### Defined in
890 |
891 | multisig.ts:53
892 |
893 | ___
894 |
895 | ### decodeAddress
896 |
897 | ▸ **decodeAddress**(`address`): [`Address`](interfaces/Address.md)
898 |
899 | decodeAddress takes an Algorand address in string form and decodes it into a Uint8Array.
900 |
901 | #### Parameters
902 |
903 | | Name | Type | Description |
904 | | :------ | :------ | :------ |
905 | | `address` | `string` | an Algorand address with checksum. |
906 |
907 | #### Returns
908 |
909 | [`Address`](interfaces/Address.md)
910 |
911 | the decoded form of the address's public key and checksum
912 |
913 | #### Defined in
914 |
915 | encoding/address.ts:47
916 |
917 | ___
918 |
919 | ### decodeObj
920 |
921 | ▸ **decodeObj**(`o`): `unknown`
922 |
923 | decodeObj takes a Uint8Array and returns its javascript obj
924 |
925 | #### Parameters
926 |
927 | | Name | Type | Description |
928 | | :------ | :------ | :------ |
929 | | `o` | `ArrayLike`\<`number`\> | Uint8Array to decode |
930 |
931 | #### Returns
932 |
933 | `unknown`
934 |
935 | object
936 |
937 | #### Defined in
938 |
939 | main.ts:109
940 |
941 | ___
942 |
943 | ### decodeSignedTransaction
944 |
945 | ▸ **decodeSignedTransaction**(`transactionBuffer`): [`SignedTransaction`](interfaces/SignedTransaction.md)
946 |
947 | decodeSignedTransaction takes a Buffer (from transaction.signTxn) and converts it to an object
948 | containing the Transaction (txn), the signature (sig), and the auth-addr field if applicable (sgnr)
949 |
950 | #### Parameters
951 |
952 | | Name | Type | Description |
953 | | :------ | :------ | :------ |
954 | | `transactionBuffer` | `Uint8Array` | the Uint8Array containing a transaction |
955 |
956 | #### Returns
957 |
958 | [`SignedTransaction`](interfaces/SignedTransaction.md)
959 |
960 | containing a Transaction, the signature, and possibly an auth-addr field
961 |
962 | #### Defined in
963 |
964 | transaction.ts:1357
965 |
966 | ___
967 |
968 | ### decodeUint64
969 |
970 | ▸ **decodeUint64**(`data`, `decodingMode`): `number`
971 |
972 | decodeUint64 produces an integer from a binary representation.
973 |
974 | #### Parameters
975 |
976 | | Name | Type | Description |
977 | | :------ | :------ | :------ |
978 | | `data` | `Uint8Array` | An typed array containing the big-endian encoding of an unsigned integer less than 2^64. This array must be at most 8 bytes long. |
979 | | `decodingMode` | ``"safe"`` | Configure how the integer will be decoded. The options are: * "safe": The integer will be decoded as a Number, but if it is greater than Number.MAX_SAFE_INTEGER an error will be thrown. * "mixed": The integer will be decoded as a Number if it is less than or equal to Number.MAX_SAFE_INTEGER, otherwise it will be decoded as a BigInt. * "bigint": The integer will always be decoded as a BigInt. Defaults to "safe" if not included. |
980 |
981 | #### Returns
982 |
983 | `number`
984 |
985 | The integer that was encoded in the input data. The return type will
986 | be determined by the parameter decodingMode.
987 |
988 | #### Defined in
989 |
990 | encoding/uint64.ts:47
991 |
992 | ▸ **decodeUint64**(`data`, `decodingMode`): `number` \| `bigint`
993 |
994 | #### Parameters
995 |
996 | | Name | Type |
997 | | :------ | :------ |
998 | | `data` | `Uint8Array` |
999 | | `decodingMode` | ``"mixed"`` |
1000 |
1001 | #### Returns
1002 |
1003 | `number` \| `bigint`
1004 |
1005 | #### Defined in
1006 |
1007 | encoding/uint64.ts:48
1008 |
1009 | ▸ **decodeUint64**(`data`, `decodingMode`): `bigint`
1010 |
1011 | #### Parameters
1012 |
1013 | | Name | Type |
1014 | | :------ | :------ |
1015 | | `data` | `Uint8Array` |
1016 | | `decodingMode` | ``"bigint"`` |
1017 |
1018 | #### Returns
1019 |
1020 | `bigint`
1021 |
1022 | #### Defined in
1023 |
1024 | encoding/uint64.ts:52
1025 |
1026 | ___
1027 |
1028 | ### decodeUnsignedTransaction
1029 |
1030 | ▸ **decodeUnsignedTransaction**(`transactionBuffer`): [`Transaction`](classes/Transaction.md)
1031 |
1032 | decodeUnsignedTransaction takes a Buffer (as if from encodeUnsignedTransaction) and converts it to a txnBuilder.Transaction object
1033 |
1034 | #### Parameters
1035 |
1036 | | Name | Type | Description |
1037 | | :------ | :------ | :------ |
1038 | | `transactionBuffer` | `ArrayLike`\<`number`\> | the Uint8Array containing a transaction |
1039 |
1040 | #### Returns
1041 |
1042 | [`Transaction`](classes/Transaction.md)
1043 |
1044 | #### Defined in
1045 |
1046 | transaction.ts:1312
1047 |
1048 | ___
1049 |
1050 | ### encodeAddress
1051 |
1052 | ▸ **encodeAddress**(`address`): `string`
1053 |
1054 | encodeAddress takes an Algorand address as a Uint8Array and encodes it into a string with checksum.
1055 |
1056 | #### Parameters
1057 |
1058 | | Name | Type | Description |
1059 | | :------ | :------ | :------ |
1060 | | `address` | `Uint8Array` | a raw Algorand address |
1061 |
1062 | #### Returns
1063 |
1064 | `string`
1065 |
1066 | the address and checksum encoded as a string.
1067 |
1068 | #### Defined in
1069 |
1070 | encoding/address.ts:103
1071 |
1072 | ___
1073 |
1074 | ### encodeObj
1075 |
1076 | ▸ **encodeObj**(`o`): `Uint8Array`
1077 |
1078 | encodeObj takes a javascript object and returns its msgpack encoding
1079 | Note that the encoding sorts the fields alphabetically
1080 |
1081 | #### Parameters
1082 |
1083 | | Name | Type | Description |
1084 | | :------ | :------ | :------ |
1085 | | `o` | `Record`\<`string` \| `number` \| `symbol`, `any`\> | js obj |
1086 |
1087 | #### Returns
1088 |
1089 | `Uint8Array`
1090 |
1091 | Uint8Array binary representation
1092 |
1093 | #### Defined in
1094 |
1095 | main.ts:100
1096 |
1097 | ___
1098 |
1099 | ### encodeUint64
1100 |
1101 | ▸ **encodeUint64**(`num`): `Uint8Array`
1102 |
1103 | encodeUint64 converts an integer to its binary representation.
1104 |
1105 | #### Parameters
1106 |
1107 | | Name | Type | Description |
1108 | | :------ | :------ | :------ |
1109 | | `num` | `number` \| `bigint` | The number to convert. This must be an unsigned integer less than 2^64. |
1110 |
1111 | #### Returns
1112 |
1113 | `Uint8Array`
1114 |
1115 | An 8-byte typed array containing the big-endian encoding of the input
1116 | integer.
1117 |
1118 | #### Defined in
1119 |
1120 | encoding/uint64.ts:15
1121 |
1122 | ___
1123 |
1124 | ### encodeUnsignedSimulateTransaction
1125 |
1126 | ▸ **encodeUnsignedSimulateTransaction**(`transactionObject`): `Uint8Array`
1127 |
1128 | encodeUnsignedSimulateTransaction takes a txnBuilder.Transaction object,
1129 | converts it into a SignedTransaction-like object, and converts it to a Buffer.
1130 |
1131 | Note: this function should only be used to simulate unsigned transactions.
1132 |
1133 | #### Parameters
1134 |
1135 | | Name | Type | Description |
1136 | | :------ | :------ | :------ |
1137 | | `transactionObject` | [`Transaction`](classes/Transaction.md) | Transaction object to simulate. |
1138 |
1139 | #### Returns
1140 |
1141 | `Uint8Array`
1142 |
1143 | #### Defined in
1144 |
1145 | transaction.ts:1289
1146 |
1147 | ___
1148 |
1149 | ### encodeUnsignedTransaction
1150 |
1151 | ▸ **encodeUnsignedTransaction**(`transactionObject`): `Uint8Array`
1152 |
1153 | encodeUnsignedTransaction takes a completed txnBuilder.Transaction object, such as from the makeFoo
1154 | family of transactions, and converts it to a Buffer
1155 |
1156 | #### Parameters
1157 |
1158 | | Name | Type | Description |
1159 | | :------ | :------ | :------ |
1160 | | `transactionObject` | [`Transaction`](classes/Transaction.md) | the completed Transaction object |
1161 |
1162 | #### Returns
1163 |
1164 | `Uint8Array`
1165 |
1166 | #### Defined in
1167 |
1168 | transaction.ts:1303
1169 |
1170 | ___
1171 |
1172 | ### generateAccount
1173 |
1174 | ▸ **generateAccount**(): [`Account`](interfaces/Account.md)
1175 |
1176 | generateAccount returns a new Algorand address and its corresponding secret key
1177 |
1178 | #### Returns
1179 |
1180 | [`Account`](interfaces/Account.md)
1181 |
1182 | #### Defined in
1183 |
1184 | account.ts:8
1185 |
1186 | ___
1187 |
1188 | ### getApplicationAddress
1189 |
1190 | ▸ **getApplicationAddress**(`appID`): `string`
1191 |
1192 | Get the escrow address of an application.
1193 |
1194 | #### Parameters
1195 |
1196 | | Name | Type | Description |
1197 | | :------ | :------ | :------ |
1198 | | `appID` | `number` \| `bigint` | The ID of the application. |
1199 |
1200 | #### Returns
1201 |
1202 | `string`
1203 |
1204 | The address corresponding to that application's escrow account.
1205 |
1206 | #### Defined in
1207 |
1208 | encoding/address.ts:188
1209 |
1210 | ___
1211 |
1212 | ### getMethodByName
1213 |
1214 | ▸ **getMethodByName**(`methods`, `name`): [`ABIMethod`](classes/ABIMethod.md)
1215 |
1216 | #### Parameters
1217 |
1218 | | Name | Type |
1219 | | :------ | :------ |
1220 | | `methods` | [`ABIMethod`](classes/ABIMethod.md)[] |
1221 | | `name` | `string` |
1222 |
1223 | #### Returns
1224 |
1225 | [`ABIMethod`](classes/ABIMethod.md)
1226 |
1227 | #### Defined in
1228 |
1229 | abi/method.ts:176
1230 |
1231 | ___
1232 |
1233 | ### instantiateTxnIfNeeded
1234 |
1235 | ▸ **instantiateTxnIfNeeded**(`transactionLike`): [`Transaction`](classes/Transaction.md)
1236 |
1237 | #### Parameters
1238 |
1239 | | Name | Type |
1240 | | :------ | :------ |
1241 | | `transactionLike` | [`TransactionLike`](modules.md#transactionlike) |
1242 |
1243 | #### Returns
1244 |
1245 | [`Transaction`](classes/Transaction.md)
1246 |
1247 | #### Defined in
1248 |
1249 | transaction.ts:1375
1250 |
1251 | ___
1252 |
1253 | ### isTransactionWithSigner
1254 |
1255 | ▸ **isTransactionWithSigner**(`value`): value is TransactionWithSigner
1256 |
1257 | Check if a value conforms to the TransactionWithSigner structure.
1258 |
1259 | #### Parameters
1260 |
1261 | | Name | Type | Description |
1262 | | :------ | :------ | :------ |
1263 | | `value` | `any` | The value to check. |
1264 |
1265 | #### Returns
1266 |
1267 | value is TransactionWithSigner
1268 |
1269 | True if an only if the value has the structure of a TransactionWithSigner.
1270 |
1271 | #### Defined in
1272 |
1273 | signer.ts:117
1274 |
1275 | ___
1276 |
1277 | ### isValidAddress
1278 |
1279 | ▸ **isValidAddress**(`address`): `boolean`
1280 |
1281 | isValidAddress checks if a string is a valid Algorand address.
1282 |
1283 | #### Parameters
1284 |
1285 | | Name | Type | Description |
1286 | | :------ | :------ | :------ |
1287 | | `address` | `string` | an Algorand address with checksum. |
1288 |
1289 | #### Returns
1290 |
1291 | `boolean`
1292 |
1293 | true if valid, false otherwise
1294 |
1295 | #### Defined in
1296 |
1297 | encoding/address.ts:88
1298 |
1299 | ___
1300 |
1301 | ### logicSigFromByte
1302 |
1303 | ▸ **logicSigFromByte**(`encoded`): [`LogicSig`](classes/LogicSig.md)
1304 |
1305 | logicSigFromByte accepts encoded logic sig bytes and attempts to call logicsig.fromByte on it,
1306 | returning the result
1307 |
1308 | #### Parameters
1309 |
1310 | | Name | Type |
1311 | | :------ | :------ |
1312 | | `encoded` | `Uint8Array` |
1313 |
1314 | #### Returns
1315 |
1316 | [`LogicSig`](classes/LogicSig.md)
1317 |
1318 | #### Defined in
1319 |
1320 | logicsig.ts:472
1321 |
1322 | ___
1323 |
1324 | ### makeApplicationCallTxnFromObject
1325 |
1326 | ▸ **makeApplicationCallTxnFromObject**(`options`): [`Transaction`](classes/Transaction.md)
1327 |
1328 | Generic function for creating any application call transaction.
1329 |
1330 | #### Parameters
1331 |
1332 | | Name | Type |
1333 | | :------ | :------ |
1334 | | `options` | `Object` |
1335 | | `options.accounts` | `string`[] |
1336 | | `options.appArgs` | `Uint8Array`[] |
1337 | | `options.appIndex` | `number` |
1338 | | `options.approvalProgram` | `Uint8Array` |
1339 | | `options.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1340 | | `options.clearProgram` | `Uint8Array` |
1341 | | `options.extraPages` | `number` |
1342 | | `options.foreignApps` | `number`[] |
1343 | | `options.foreignAssets` | `number`[] |
1344 | | `options.from` | `string` |
1345 | | `options.lease` | `Uint8Array` |
1346 | | `options.note` | `Uint8Array` |
1347 | | `options.numGlobalByteSlices` | `number` |
1348 | | `options.numGlobalInts` | `number` |
1349 | | `options.numLocalByteSlices` | `number` |
1350 | | `options.numLocalInts` | `number` |
1351 | | `options.onComplete` | [`OnApplicationComplete`](enums/OnApplicationComplete.md) |
1352 | | `options.rekeyTo` | `string` |
1353 | | `options.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1354 |
1355 | #### Returns
1356 |
1357 | [`Transaction`](classes/Transaction.md)
1358 |
1359 | #### Defined in
1360 |
1361 | makeTxn.ts:1403
1362 |
1363 | ___
1364 |
1365 | ### makeApplicationClearStateTxn
1366 |
1367 | ▸ **makeApplicationClearStateTxn**(`from`, `suggestedParams`, `appIndex`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1368 |
1369 | Make a transaction that clears a user's state in an application
1370 |
1371 | #### Parameters
1372 |
1373 | | Name | Type | Description |
1374 | | :------ | :------ | :------ |
1375 | | `from` | `string` | address of sender |
1376 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1377 | | `appIndex` | `number` | the ID of the app to use |
1378 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1379 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1380 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1381 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1382 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1383 | | `lease?` | `Uint8Array` | Lease a transaction |
1384 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1385 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1386 |
1387 | #### Returns
1388 |
1389 | [`Transaction`](classes/Transaction.md)
1390 |
1391 | **`Deprecated`**
1392 |
1393 | This function will be removed in v3 in favor of [makeApplicationClearStateTxnFromObject](modules.md#makeapplicationclearstatetxnfromobject)
1394 |
1395 | #### Defined in
1396 |
1397 | makeTxn.ts:1229
1398 |
1399 | ___
1400 |
1401 | ### makeApplicationClearStateTxnFromObject
1402 |
1403 | ▸ **makeApplicationClearStateTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1404 |
1405 | #### Parameters
1406 |
1407 | | Name | Type |
1408 | | :------ | :------ |
1409 | | `o` | `Object` |
1410 | | `o.accounts` | `string`[] |
1411 | | `o.appArgs` | `Uint8Array`[] |
1412 | | `o.appIndex` | `number` |
1413 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1414 | | `o.foreignApps` | `number`[] |
1415 | | `o.foreignAssets` | `number`[] |
1416 | | `o.from` | `string` |
1417 | | `o.lease` | `Uint8Array` |
1418 | | `o.note` | `Uint8Array` |
1419 | | `o.rekeyTo` | `string` |
1420 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1421 |
1422 | #### Returns
1423 |
1424 | [`Transaction`](classes/Transaction.md)
1425 |
1426 | #### Defined in
1427 |
1428 | makeTxn.ts:1261
1429 |
1430 | ___
1431 |
1432 | ### makeApplicationCloseOutTxn
1433 |
1434 | ▸ **makeApplicationCloseOutTxn**(`from`, `suggestedParams`, `appIndex`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1435 |
1436 | Make a transaction that closes out a user's state in an application
1437 |
1438 | #### Parameters
1439 |
1440 | | Name | Type | Description |
1441 | | :------ | :------ | :------ |
1442 | | `from` | `string` | address of sender |
1443 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1444 | | `appIndex` | `number` | the ID of the app to use |
1445 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1446 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1447 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1448 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1449 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1450 | | `lease?` | `Uint8Array` | Lease a transaction |
1451 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1452 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1453 |
1454 | #### Returns
1455 |
1456 | [`Transaction`](classes/Transaction.md)
1457 |
1458 | **`Deprecated`**
1459 |
1460 | This function will be removed in v3 in favor of [makeApplicationCloseOutTxnFromObject](modules.md#makeapplicationcloseouttxnfromobject)
1461 |
1462 | #### Defined in
1463 |
1464 | makeTxn.ts:1133
1465 |
1466 | ___
1467 |
1468 | ### makeApplicationCloseOutTxnFromObject
1469 |
1470 | ▸ **makeApplicationCloseOutTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1471 |
1472 | #### Parameters
1473 |
1474 | | Name | Type |
1475 | | :------ | :------ |
1476 | | `o` | `Object` |
1477 | | `o.accounts` | `string`[] |
1478 | | `o.appArgs` | `Uint8Array`[] |
1479 | | `o.appIndex` | `number` |
1480 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1481 | | `o.foreignApps` | `number`[] |
1482 | | `o.foreignAssets` | `number`[] |
1483 | | `o.from` | `string` |
1484 | | `o.lease` | `Uint8Array` |
1485 | | `o.note` | `Uint8Array` |
1486 | | `o.rekeyTo` | `string` |
1487 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1488 |
1489 | #### Returns
1490 |
1491 | [`Transaction`](classes/Transaction.md)
1492 |
1493 | #### Defined in
1494 |
1495 | makeTxn.ts:1165
1496 |
1497 | ___
1498 |
1499 | ### makeApplicationCreateTxn
1500 |
1501 | ▸ **makeApplicationCreateTxn**(`from`, `suggestedParams`, `onComplete`, `approvalProgram`, `clearProgram`, `numLocalInts`, `numLocalByteSlices`, `numGlobalInts`, `numGlobalByteSlices`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `extraPages?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1502 |
1503 | Make a transaction that will create an application.
1504 |
1505 | #### Parameters
1506 |
1507 | | Name | Type | Description |
1508 | | :------ | :------ | :------ |
1509 | | `from` | `string` | address of sender |
1510 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1511 | | `onComplete` | [`OnApplicationComplete`](enums/OnApplicationComplete.md) | algosdk.OnApplicationComplete, what application should do once the program is done being run |
1512 | | `approvalProgram` | `Uint8Array` | Uint8Array, the compiled TEAL that approves a transaction |
1513 | | `clearProgram` | `Uint8Array` | Uint8Array, the compiled TEAL that runs when clearing state |
1514 | | `numLocalInts` | `number` | restricts number of ints in per-user local state |
1515 | | `numLocalByteSlices` | `number` | restricts number of byte slices in per-user local state |
1516 | | `numGlobalInts` | `number` | restricts number of ints in global state |
1517 | | `numGlobalByteSlices` | `number` | restricts number of byte slices in global state |
1518 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1519 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1520 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1521 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1522 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1523 | | `lease?` | `Uint8Array` | Lease a transaction |
1524 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1525 | | `extraPages?` | `number` | integer extra pages of memory to rent on creation of application |
1526 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1527 |
1528 | #### Returns
1529 |
1530 | [`Transaction`](classes/Transaction.md)
1531 |
1532 | **`Deprecated`**
1533 |
1534 | This function will be removed in v3 in favor of [makeApplicationCreateTxnFromObject](modules.md#makeapplicationcreatetxnfromobject)
1535 |
1536 | #### Defined in
1537 |
1538 | makeTxn.ts:702
1539 |
1540 | ___
1541 |
1542 | ### makeApplicationCreateTxnFromObject
1543 |
1544 | ▸ **makeApplicationCreateTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1545 |
1546 | #### Parameters
1547 |
1548 | | Name | Type |
1549 | | :------ | :------ |
1550 | | `o` | `Object` |
1551 | | `o.accounts` | `string`[] |
1552 | | `o.appArgs` | `Uint8Array`[] |
1553 | | `o.approvalProgram` | `Uint8Array` |
1554 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1555 | | `o.clearProgram` | `Uint8Array` |
1556 | | `o.extraPages` | `number` |
1557 | | `o.foreignApps` | `number`[] |
1558 | | `o.foreignAssets` | `number`[] |
1559 | | `o.from` | `string` |
1560 | | `o.lease` | `Uint8Array` |
1561 | | `o.note` | `Uint8Array` |
1562 | | `o.numGlobalByteSlices` | `number` |
1563 | | `o.numGlobalInts` | `number` |
1564 | | `o.numLocalByteSlices` | `number` |
1565 | | `o.numLocalInts` | `number` |
1566 | | `o.onComplete` | [`OnApplicationComplete`](enums/OnApplicationComplete.md) |
1567 | | `o.rekeyTo` | `string` |
1568 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1569 |
1570 | #### Returns
1571 |
1572 | [`Transaction`](classes/Transaction.md)
1573 |
1574 | #### Defined in
1575 |
1576 | makeTxn.ts:748
1577 |
1578 | ___
1579 |
1580 | ### makeApplicationDeleteTxn
1581 |
1582 | ▸ **makeApplicationDeleteTxn**(`from`, `suggestedParams`, `appIndex`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1583 |
1584 | Make a transaction that deletes an application
1585 |
1586 | #### Parameters
1587 |
1588 | | Name | Type | Description |
1589 | | :------ | :------ | :------ |
1590 | | `from` | `string` | address of sender |
1591 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1592 | | `appIndex` | `number` | the ID of the app to be deleted |
1593 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1594 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1595 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1596 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1597 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1598 | | `lease?` | `Uint8Array` | Lease a transaction |
1599 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1600 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1601 |
1602 | #### Returns
1603 |
1604 | [`Transaction`](classes/Transaction.md)
1605 |
1606 | **`Deprecated`**
1607 |
1608 | This function will be removed in v3 in favor of [makeApplicationDeleteTxnFromObject](modules.md#makeapplicationdeletetxnfromobject)
1609 |
1610 | #### Defined in
1611 |
1612 | makeTxn.ts:941
1613 |
1614 | ___
1615 |
1616 | ### makeApplicationDeleteTxnFromObject
1617 |
1618 | ▸ **makeApplicationDeleteTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1619 |
1620 | #### Parameters
1621 |
1622 | | Name | Type |
1623 | | :------ | :------ |
1624 | | `o` | `Object` |
1625 | | `o.accounts` | `string`[] |
1626 | | `o.appArgs` | `Uint8Array`[] |
1627 | | `o.appIndex` | `number` |
1628 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1629 | | `o.foreignApps` | `number`[] |
1630 | | `o.foreignAssets` | `number`[] |
1631 | | `o.from` | `string` |
1632 | | `o.lease` | `Uint8Array` |
1633 | | `o.note` | `Uint8Array` |
1634 | | `o.rekeyTo` | `string` |
1635 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1636 |
1637 | #### Returns
1638 |
1639 | [`Transaction`](classes/Transaction.md)
1640 |
1641 | #### Defined in
1642 |
1643 | makeTxn.ts:973
1644 |
1645 | ___
1646 |
1647 | ### makeApplicationNoOpTxn
1648 |
1649 | ▸ **makeApplicationNoOpTxn**(`from`, `suggestedParams`, `appIndex`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1650 |
1651 | Make a transaction that just calls an application, doing nothing on completion
1652 |
1653 | #### Parameters
1654 |
1655 | | Name | Type | Description |
1656 | | :------ | :------ | :------ |
1657 | | `from` | `string` | address of sender |
1658 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1659 | | `appIndex` | `number` | the ID of the app to use |
1660 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1661 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1662 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1663 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1664 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1665 | | `lease?` | `Uint8Array` | Lease a transaction |
1666 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1667 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1668 |
1669 | #### Returns
1670 |
1671 | [`Transaction`](classes/Transaction.md)
1672 |
1673 | **`Deprecated`**
1674 |
1675 | This function will be removed in v3 in favor of [makeApplicationNoOpTxnFromObject](modules.md#makeapplicationnooptxnfromobject)
1676 |
1677 | #### Defined in
1678 |
1679 | makeTxn.ts:1325
1680 |
1681 | ___
1682 |
1683 | ### makeApplicationNoOpTxnFromObject
1684 |
1685 | ▸ **makeApplicationNoOpTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1686 |
1687 | #### Parameters
1688 |
1689 | | Name | Type |
1690 | | :------ | :------ |
1691 | | `o` | `Object` |
1692 | | `o.accounts` | `string`[] |
1693 | | `o.appArgs` | `Uint8Array`[] |
1694 | | `o.appIndex` | `number` |
1695 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1696 | | `o.foreignApps` | `number`[] |
1697 | | `o.foreignAssets` | `number`[] |
1698 | | `o.from` | `string` |
1699 | | `o.lease` | `Uint8Array` |
1700 | | `o.note` | `Uint8Array` |
1701 | | `o.rekeyTo` | `string` |
1702 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1703 |
1704 | #### Returns
1705 |
1706 | [`Transaction`](classes/Transaction.md)
1707 |
1708 | #### Defined in
1709 |
1710 | makeTxn.ts:1357
1711 |
1712 | ___
1713 |
1714 | ### makeApplicationOptInTxn
1715 |
1716 | ▸ **makeApplicationOptInTxn**(`from`, `suggestedParams`, `appIndex`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1717 |
1718 | Make a transaction that opts in to use an application
1719 |
1720 | #### Parameters
1721 |
1722 | | Name | Type | Description |
1723 | | :------ | :------ | :------ |
1724 | | `from` | `string` | address of sender |
1725 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1726 | | `appIndex` | `number` | the ID of the app to join |
1727 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1728 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1729 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1730 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1731 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1732 | | `lease?` | `Uint8Array` | Lease a transaction |
1733 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1734 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1735 |
1736 | #### Returns
1737 |
1738 | [`Transaction`](classes/Transaction.md)
1739 |
1740 | **`Deprecated`**
1741 |
1742 | This function will be removed in v3 in favor of [makeApplicationOptInTxnFromObject](modules.md#makeapplicationoptintxnfromobject)
1743 |
1744 | #### Defined in
1745 |
1746 | makeTxn.ts:1037
1747 |
1748 | ___
1749 |
1750 | ### makeApplicationOptInTxnFromObject
1751 |
1752 | ▸ **makeApplicationOptInTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1753 |
1754 | #### Parameters
1755 |
1756 | | Name | Type |
1757 | | :------ | :------ |
1758 | | `o` | `Object` |
1759 | | `o.accounts` | `string`[] |
1760 | | `o.appArgs` | `Uint8Array`[] |
1761 | | `o.appIndex` | `number` |
1762 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1763 | | `o.foreignApps` | `number`[] |
1764 | | `o.foreignAssets` | `number`[] |
1765 | | `o.from` | `string` |
1766 | | `o.lease` | `Uint8Array` |
1767 | | `o.note` | `Uint8Array` |
1768 | | `o.rekeyTo` | `string` |
1769 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1770 |
1771 | #### Returns
1772 |
1773 | [`Transaction`](classes/Transaction.md)
1774 |
1775 | #### Defined in
1776 |
1777 | makeTxn.ts:1069
1778 |
1779 | ___
1780 |
1781 | ### makeApplicationUpdateTxn
1782 |
1783 | ▸ **makeApplicationUpdateTxn**(`from`, `suggestedParams`, `appIndex`, `approvalProgram`, `clearProgram`, `appArgs?`, `accounts?`, `foreignApps?`, `foreignAssets?`, `note?`, `lease?`, `rekeyTo?`, `boxes?`): [`Transaction`](classes/Transaction.md)
1784 |
1785 | Make a transaction that changes an application's approval and clear programs
1786 |
1787 | #### Parameters
1788 |
1789 | | Name | Type | Description |
1790 | | :------ | :------ | :------ |
1791 | | `from` | `string` | address of sender |
1792 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1793 | | `appIndex` | `number` | the ID of the app to be updated |
1794 | | `approvalProgram` | `Uint8Array` | Uint8Array, the compiled TEAL that approves a transaction |
1795 | | `clearProgram` | `Uint8Array` | Uint8Array, the compiled TEAL that runs when clearing state |
1796 | | `appArgs?` | `Uint8Array`[] | Array of Uint8Array, any additional arguments to the application |
1797 | | `accounts?` | `string`[] | Array of Address strings, any additional accounts to supply to the application |
1798 | | `foreignApps?` | `number`[] | Array of int, any other apps used by the application, identified by index |
1799 | | `foreignAssets?` | `number`[] | Array of int, any assets used by the application, identified by index |
1800 | | `note?` | `Uint8Array` | Arbitrary data for sender to store |
1801 | | `lease?` | `Uint8Array` | Lease a transaction |
1802 | | `rekeyTo?` | `string` | String representation of the Algorand address that will be used to authorize all future transactions |
1803 | | `boxes?` | [`BoxReference`](interfaces/BoxReference.md)[] | Array of BoxReference, app ID and name of box to be accessed |
1804 |
1805 | #### Returns
1806 |
1807 | [`Transaction`](classes/Transaction.md)
1808 |
1809 | **`Deprecated`**
1810 |
1811 | This function will be removed in v3 in favor of [makeApplicationUpdateTxnFromObject](modules.md#makeapplicationupdatetxnfromobject)
1812 |
1813 | #### Defined in
1814 |
1815 | makeTxn.ts:835
1816 |
1817 | ___
1818 |
1819 | ### makeApplicationUpdateTxnFromObject
1820 |
1821 | ▸ **makeApplicationUpdateTxnFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1822 |
1823 | #### Parameters
1824 |
1825 | | Name | Type |
1826 | | :------ | :------ |
1827 | | `o` | `Object` |
1828 | | `o.accounts` | `string`[] |
1829 | | `o.appArgs` | `Uint8Array`[] |
1830 | | `o.appIndex` | `number` |
1831 | | `o.approvalProgram` | `Uint8Array` |
1832 | | `o.boxes` | [`BoxReference`](interfaces/BoxReference.md)[] |
1833 | | `o.clearProgram` | `Uint8Array` |
1834 | | `o.foreignApps` | `number`[] |
1835 | | `o.foreignAssets` | `number`[] |
1836 | | `o.from` | `string` |
1837 | | `o.lease` | `Uint8Array` |
1838 | | `o.note` | `Uint8Array` |
1839 | | `o.rekeyTo` | `string` |
1840 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1841 |
1842 | #### Returns
1843 |
1844 | [`Transaction`](classes/Transaction.md)
1845 |
1846 | #### Defined in
1847 |
1848 | makeTxn.ts:871
1849 |
1850 | ___
1851 |
1852 | ### makeAssetConfigTxnWithSuggestedParams
1853 |
1854 | ▸ **makeAssetConfigTxnWithSuggestedParams**(`from`, `note`, `assetIndex`, `manager`, `reserve`, `freeze`, `clawback`, `suggestedParams`, `strictEmptyAddressChecking?`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
1855 |
1856 | makeAssetConfigTxnWithSuggestedParams can be issued by the asset manager to change the manager, reserve, freeze, or clawback
1857 | you must respecify existing addresses to keep them the same; leaving a field blank is the same as turning
1858 | that feature off for this asset
1859 |
1860 | #### Parameters
1861 |
1862 | | Name | Type | Default value | Description |
1863 | | :------ | :------ | :------ | :------ |
1864 | | `from` | `string` | `undefined` | string representation of Algorand address of sender |
1865 | | `note` | `Uint8Array` | `undefined` | uint8array of arbitrary data for sender to store |
1866 | | `assetIndex` | `number` | `undefined` | int asset index uniquely specifying the asset |
1867 | | `manager` | `string` | `undefined` | string representation of new asset manager Algorand address |
1868 | | `reserve` | `string` | `undefined` | string representation of new reserve Algorand address |
1869 | | `freeze` | `string` | `undefined` | string representation of new freeze manager Algorand address |
1870 | | `clawback` | `string` | `undefined` | string representation of new revocation manager Algorand address |
1871 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | `undefined` | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1872 | | `strictEmptyAddressChecking` | `boolean` | `true` | boolean - throw an error if any of manager, reserve, freeze, or clawback are undefined. optional, defaults to true. |
1873 | | `rekeyTo?` | `string` | `undefined` | rekeyTo address, optional |
1874 |
1875 | #### Returns
1876 |
1877 | [`Transaction`](classes/Transaction.md)
1878 |
1879 | **`Deprecated`**
1880 |
1881 | This function will be removed in v3 in favor of [makeAssetConfigTxnWithSuggestedParamsFromObject](modules.md#makeassetconfigtxnwithsuggestedparamsfromobject)
1882 |
1883 | #### Defined in
1884 |
1885 | makeTxn.ts:372
1886 |
1887 | ___
1888 |
1889 | ### makeAssetConfigTxnWithSuggestedParamsFromObject
1890 |
1891 | ▸ **makeAssetConfigTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1892 |
1893 | #### Parameters
1894 |
1895 | | Name | Type |
1896 | | :------ | :------ |
1897 | | `o` | `Object` |
1898 | | `o.assetIndex` | `number` |
1899 | | `o.clawback` | `string` |
1900 | | `o.freeze` | `string` |
1901 | | `o.from` | `string` |
1902 | | `o.manager` | `string` |
1903 | | `o.note` | `Uint8Array` |
1904 | | `o.rekeyTo` | `string` |
1905 | | `o.reserve` | `string` |
1906 | | `o.strictEmptyAddressChecking` | `boolean` |
1907 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1908 |
1909 | #### Returns
1910 |
1911 | [`Transaction`](classes/Transaction.md)
1912 |
1913 | #### Defined in
1914 |
1915 | makeTxn.ts:411
1916 |
1917 | ___
1918 |
1919 | ### makeAssetCreateTxnWithSuggestedParams
1920 |
1921 | ▸ **makeAssetCreateTxnWithSuggestedParams**(`from`, `note`, `total`, `decimals`, `defaultFrozen`, `manager`, `reserve`, `freeze`, `clawback`, `unitName`, `assetName`, `assetURL`, `assetMetadataHash`, `suggestedParams`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
1922 |
1923 | makeAssetCreateTxnWithSuggestedParams takes asset creation arguments and returns a Transaction object
1924 | for creating that asset
1925 |
1926 | #### Parameters
1927 |
1928 | | Name | Type | Description |
1929 | | :------ | :------ | :------ |
1930 | | `from` | `string` | string representation of Algorand address of sender |
1931 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
1932 | | `total` | `number` \| `bigint` | integer total supply of the asset |
1933 | | `decimals` | `number` | integer number of decimals for asset unit calculation |
1934 | | `defaultFrozen` | `boolean` | boolean whether asset accounts should default to being frozen |
1935 | | `manager` | `string` | string representation of Algorand address in charge of reserve, freeze, clawback, destruction, etc |
1936 | | `reserve` | `string` | string representation of Algorand address representing asset reserve |
1937 | | `freeze` | `string` | string representation of Algorand address with power to freeze/unfreeze asset holdings |
1938 | | `clawback` | `string` | string representation of Algorand address with power to revoke asset holdings |
1939 | | `unitName` | `string` | string units name for this asset |
1940 | | `assetName` | `string` | string name for this asset |
1941 | | `assetURL` | `string` | string URL relating to this asset |
1942 | | `assetMetadataHash` | `string` \| `Uint8Array` | Uint8Array or UTF-8 string representation of a hash commitment with respect to the asset. Must be exactly 32 bytes long. |
1943 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
1944 | | `rekeyTo?` | `string` | rekeyTo address, optional |
1945 |
1946 | #### Returns
1947 |
1948 | [`Transaction`](classes/Transaction.md)
1949 |
1950 | **`Deprecated`**
1951 |
1952 | This function will be removed in v3 in favor of [makeAssetCreateTxnWithSuggestedParamsFromObject](modules.md#makeassetcreatetxnwithsuggestedparamsfromobject)
1953 |
1954 | #### Defined in
1955 |
1956 | makeTxn.ts:255
1957 |
1958 | ___
1959 |
1960 | ### makeAssetCreateTxnWithSuggestedParamsFromObject
1961 |
1962 | ▸ **makeAssetCreateTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
1963 |
1964 | #### Parameters
1965 |
1966 | | Name | Type |
1967 | | :------ | :------ |
1968 | | `o` | `Object` |
1969 | | `o.assetMetadataHash` | `string` \| `Uint8Array` |
1970 | | `o.assetName` | `string` |
1971 | | `o.assetURL` | `string` |
1972 | | `o.clawback` | `string` |
1973 | | `o.decimals` | `number` |
1974 | | `o.defaultFrozen` | `boolean` |
1975 | | `o.freeze` | `string` |
1976 | | `o.from` | `string` |
1977 | | `o.manager` | `string` |
1978 | | `o.note` | `Uint8Array` |
1979 | | `o.rekeyTo` | `string` |
1980 | | `o.reserve` | `string` |
1981 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
1982 | | `o.total` | `number` \| `bigint` |
1983 | | `o.unitName` | `string` |
1984 |
1985 | #### Returns
1986 |
1987 | [`Transaction`](classes/Transaction.md)
1988 |
1989 | #### Defined in
1990 |
1991 | makeTxn.ts:294
1992 |
1993 | ___
1994 |
1995 | ### makeAssetDestroyTxnWithSuggestedParams
1996 |
1997 | ▸ **makeAssetDestroyTxnWithSuggestedParams**(`from`, `note`, `assetIndex`, `suggestedParams`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
1998 |
1999 | makeAssetDestroyTxnWithSuggestedParams will allow the asset's manager to remove this asset from the ledger, so long
2000 | as all outstanding assets are held by the creator.
2001 |
2002 | #### Parameters
2003 |
2004 | | Name | Type | Description |
2005 | | :------ | :------ | :------ |
2006 | | `from` | `string` | string representation of Algorand address of sender |
2007 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
2008 | | `assetIndex` | `number` | int asset index uniquely specifying the asset |
2009 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
2010 | | `rekeyTo?` | `string` | rekeyTo address, optional |
2011 |
2012 | #### Returns
2013 |
2014 | [`Transaction`](classes/Transaction.md)
2015 |
2016 | **`Deprecated`**
2017 |
2018 | This function will be removed in v3 in favor of [makeAssetDestroyTxnWithSuggestedParamsFromObject](modules.md#makeassetdestroytxnwithsuggestedparamsfromobject)
2019 |
2020 | #### Defined in
2021 |
2022 | makeTxn.ts:470
2023 |
2024 | ___
2025 |
2026 | ### makeAssetDestroyTxnWithSuggestedParamsFromObject
2027 |
2028 | ▸ **makeAssetDestroyTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2029 |
2030 | #### Parameters
2031 |
2032 | | Name | Type |
2033 | | :------ | :------ |
2034 | | `o` | `Object` |
2035 | | `o.assetIndex` | `number` |
2036 | | `o.from` | `string` |
2037 | | `o.note` | `Uint8Array` |
2038 | | `o.rekeyTo` | `string` |
2039 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2040 |
2041 | #### Returns
2042 |
2043 | [`Transaction`](classes/Transaction.md)
2044 |
2045 | #### Defined in
2046 |
2047 | makeTxn.ts:489
2048 |
2049 | ___
2050 |
2051 | ### makeAssetFreezeTxnWithSuggestedParams
2052 |
2053 | ▸ **makeAssetFreezeTxnWithSuggestedParams**(`from`, `note`, `assetIndex`, `freezeTarget`, `freezeState`, `suggestedParams`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
2054 |
2055 | makeAssetFreezeTxnWithSuggestedParams will allow the asset's freeze manager to freeze or un-freeze an account,
2056 | blocking or allowing asset transfers to and from the targeted account.
2057 |
2058 | #### Parameters
2059 |
2060 | | Name | Type | Description |
2061 | | :------ | :------ | :------ |
2062 | | `from` | `string` | string representation of Algorand address of sender |
2063 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
2064 | | `assetIndex` | `number` | int asset index uniquely specifying the asset |
2065 | | `freezeTarget` | `string` | string representation of Algorand address being frozen or unfrozen |
2066 | | `freezeState` | `boolean` | true if freezeTarget should be frozen, false if freezeTarget should be allowed to transact |
2067 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
2068 | | `rekeyTo?` | `string` | rekeyTo address, optional |
2069 |
2070 | #### Returns
2071 |
2072 | [`Transaction`](classes/Transaction.md)
2073 |
2074 | **`Deprecated`**
2075 |
2076 | This function will be removed in v3 in favor of [makeAssetFreezeTxnWithSuggestedParamsFromObject](modules.md#makeassetfreezetxnwithsuggestedparamsfromobject)
2077 |
2078 | #### Defined in
2079 |
2080 | makeTxn.ts:530
2081 |
2082 | ___
2083 |
2084 | ### makeAssetFreezeTxnWithSuggestedParamsFromObject
2085 |
2086 | ▸ **makeAssetFreezeTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2087 |
2088 | #### Parameters
2089 |
2090 | | Name | Type |
2091 | | :------ | :------ |
2092 | | `o` | `Object` |
2093 | | `o.assetIndex` | `number` |
2094 | | `o.freezeState` | `boolean` |
2095 | | `o.freezeTarget` | `string` |
2096 | | `o.from` | `string` |
2097 | | `o.note` | `Uint8Array` |
2098 | | `o.rekeyTo` | `string` |
2099 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2100 |
2101 | #### Returns
2102 |
2103 | [`Transaction`](classes/Transaction.md)
2104 |
2105 | #### Defined in
2106 |
2107 | makeTxn.ts:553
2108 |
2109 | ___
2110 |
2111 | ### makeAssetTransferTxnWithSuggestedParams
2112 |
2113 | ▸ **makeAssetTransferTxnWithSuggestedParams**(`from`, `to`, `closeRemainderTo`, `revocationTarget`, `amount`, `note`, `assetIndex`, `suggestedParams`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
2114 |
2115 | makeAssetTransferTxnWithSuggestedParams allows for the creation of an asset transfer transaction.
2116 | Special case: to begin accepting assets, set amount=0 and from=to.
2117 |
2118 | #### Parameters
2119 |
2120 | | Name | Type | Description |
2121 | | :------ | :------ | :------ |
2122 | | `from` | `string` | string representation of Algorand address of sender |
2123 | | `to` | `string` | string representation of Algorand address of asset recipient |
2124 | | `closeRemainderTo` | `string` | optional - string representation of Algorand address - if provided, send all remaining assets after transfer to the "closeRemainderTo" address and close "from"'s asset holdings |
2125 | | `revocationTarget` | `string` | optional - string representation of Algorand address - if provided, and if "from" is the asset's revocation manager, then deduct from "revocationTarget" rather than "from" |
2126 | | `amount` | `number` \| `bigint` | integer amount of assets to send |
2127 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
2128 | | `assetIndex` | `number` | int asset index uniquely specifying the asset |
2129 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
2130 | | `rekeyTo?` | `string` | rekeyTo address, optional |
2131 |
2132 | #### Returns
2133 |
2134 | [`Transaction`](classes/Transaction.md)
2135 |
2136 | **`Deprecated`**
2137 |
2138 | This function will be removed in v3 in favor of [makeAssetTransferTxnWithSuggestedParamsFromObject](modules.md#makeassettransfertxnwithsuggestedparamsfromobject)
2139 |
2140 | #### Defined in
2141 |
2142 | makeTxn.ts:610
2143 |
2144 | ___
2145 |
2146 | ### makeAssetTransferTxnWithSuggestedParamsFromObject
2147 |
2148 | ▸ **makeAssetTransferTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2149 |
2150 | #### Parameters
2151 |
2152 | | Name | Type |
2153 | | :------ | :------ |
2154 | | `o` | `Object` |
2155 | | `o.amount` | `number` \| `bigint` |
2156 | | `o.assetIndex` | `number` |
2157 | | `o.closeRemainderTo` | `string` |
2158 | | `o.from` | `string` |
2159 | | `o.note` | `Uint8Array` |
2160 | | `o.rekeyTo` | `string` |
2161 | | `o.revocationTarget` | `string` |
2162 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2163 | | `o.to` | `string` |
2164 |
2165 | #### Returns
2166 |
2167 | [`Transaction`](classes/Transaction.md)
2168 |
2169 | #### Defined in
2170 |
2171 | makeTxn.ts:637
2172 |
2173 | ___
2174 |
2175 | ### makeBasicAccountTransactionSigner
2176 |
2177 | ▸ **makeBasicAccountTransactionSigner**(`account`): [`TransactionSigner`](modules.md#transactionsigner)
2178 |
2179 | Create a TransactionSigner that can sign transactions for the provided basic Account.
2180 |
2181 | #### Parameters
2182 |
2183 | | Name | Type |
2184 | | :------ | :------ |
2185 | | `account` | [`Account`](interfaces/Account.md) |
2186 |
2187 | #### Returns
2188 |
2189 | [`TransactionSigner`](modules.md#transactionsigner)
2190 |
2191 | #### Defined in
2192 |
2193 | signer.ts:23
2194 |
2195 | ___
2196 |
2197 | ### makeEmptyTransactionSigner
2198 |
2199 | ▸ **makeEmptyTransactionSigner**(): [`TransactionSigner`](modules.md#transactionsigner)
2200 |
2201 | Create a makeEmptyTransactionSigner that does not specify any signer or
2202 | signing capabilities. This should only be used to simulate transactions.
2203 |
2204 | #### Returns
2205 |
2206 | [`TransactionSigner`](modules.md#transactionsigner)
2207 |
2208 | #### Defined in
2209 |
2210 | signer.ts:91
2211 |
2212 | ___
2213 |
2214 | ### makeKeyRegistrationTxnWithSuggestedParams
2215 |
2216 | ▸ **makeKeyRegistrationTxnWithSuggestedParams**(`from`, `note`, `voteKey`, `selectionKey`, `voteFirst`, `voteLast`, `voteKeyDilution`, `suggestedParams`, `rekeyTo?`, `nonParticipation?`, `stateProofKey?`): [`Transaction`](classes/Transaction.md)
2217 |
2218 | makeKeyRegistrationTxnWithSuggestedParams takes key registration arguments and returns a Transaction object for
2219 | that key registration operation
2220 |
2221 | #### Parameters
2222 |
2223 | | Name | Type | Description |
2224 | | :------ | :------ | :------ |
2225 | | `from` | `string` | string representation of Algorand address of sender |
2226 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
2227 | | `voteKey` | `string` \| `Uint8Array` | voting key. for key deregistration, leave undefined |
2228 | | `selectionKey` | `string` \| `Uint8Array` | selection key. for key deregistration, leave undefined |
2229 | | `voteFirst` | `number` | first round on which voteKey is valid |
2230 | | `voteLast` | `number` | last round on which voteKey is valid |
2231 | | `voteKeyDilution` | `number` | integer |
2232 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
2233 | | `rekeyTo?` | `string` | rekeyTo address, optional |
2234 | | `nonParticipation?` | ``false`` | configure whether the address wants to stop participating. If true, voteKey, selectionKey, voteFirst, voteLast, and voteKeyDilution must be undefined. |
2235 | | `stateProofKey?` | `string` \| `Uint8Array` | state proof key. for key deregistration, leave undefined |
2236 |
2237 | #### Returns
2238 |
2239 | [`Transaction`](classes/Transaction.md)
2240 |
2241 | **`Deprecated`**
2242 |
2243 | This function will be removed in v3 in favor of [makeKeyRegistrationTxnWithSuggestedParamsFromObject](modules.md#makekeyregistrationtxnwithsuggestedparamsfromobject)
2244 |
2245 | #### Defined in
2246 |
2247 | makeTxn.ts:119
2248 |
2249 | ▸ **makeKeyRegistrationTxnWithSuggestedParams**(`from`, `note`, `voteKey`, `selectionKey`, `voteFirst`, `voteLast`, `voteKeyDilution`, `suggestedParams`, `rekeyTo?`, `nonParticipation?`, `stateProofKey?`): [`Transaction`](classes/Transaction.md)
2250 |
2251 | #### Parameters
2252 |
2253 | | Name | Type |
2254 | | :------ | :------ |
2255 | | `from` | `string` |
2256 | | `note` | `Uint8Array` |
2257 | | `voteKey` | `undefined` |
2258 | | `selectionKey` | `undefined` |
2259 | | `voteFirst` | `undefined` |
2260 | | `voteLast` | `undefined` |
2261 | | `voteKeyDilution` | `undefined` |
2262 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2263 | | `rekeyTo?` | `string` |
2264 | | `nonParticipation?` | `boolean` |
2265 | | `stateProofKey?` | `undefined` |
2266 |
2267 | #### Returns
2268 |
2269 | [`Transaction`](classes/Transaction.md)
2270 |
2271 | #### Defined in
2272 |
2273 | makeTxn.ts:132
2274 |
2275 | ___
2276 |
2277 | ### makeKeyRegistrationTxnWithSuggestedParamsFromObject
2278 |
2279 | ▸ **makeKeyRegistrationTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2280 |
2281 | #### Parameters
2282 |
2283 | | Name | Type |
2284 | | :------ | :------ |
2285 | | `o` | `Object` |
2286 | | `o.from` | `string` |
2287 | | `o.nonParticipation?` | ``false`` |
2288 | | `o.note` | `Uint8Array` |
2289 | | `o.rekeyTo` | `string` |
2290 | | `o.selectionKey` | `string` \| `Uint8Array` |
2291 | | `o.stateProofKey` | `string` \| `Uint8Array` |
2292 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2293 | | `o.voteFirst` | `number` |
2294 | | `o.voteKey` | `string` \| `Uint8Array` |
2295 | | `o.voteKeyDilution` | `number` |
2296 | | `o.voteLast` | `number` |
2297 |
2298 | #### Returns
2299 |
2300 | [`Transaction`](classes/Transaction.md)
2301 |
2302 | #### Defined in
2303 |
2304 | makeTxn.ts:176
2305 |
2306 | ▸ **makeKeyRegistrationTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2307 |
2308 | #### Parameters
2309 |
2310 | | Name | Type |
2311 | | :------ | :------ |
2312 | | `o` | `Object` |
2313 | | `o.from` | `string` |
2314 | | `o.nonParticipation` | `boolean` |
2315 | | `o.note` | `Uint8Array` |
2316 | | `o.rekeyTo` | `string` |
2317 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2318 |
2319 | #### Returns
2320 |
2321 | [`Transaction`](classes/Transaction.md)
2322 |
2323 | #### Defined in
2324 |
2325 | makeTxn.ts:199
2326 |
2327 | ___
2328 |
2329 | ### makeLogicSigAccountTransactionSigner
2330 |
2331 | ▸ **makeLogicSigAccountTransactionSigner**(`account`): [`TransactionSigner`](modules.md#transactionsigner)
2332 |
2333 | Create a TransactionSigner that can sign transactions for the provided LogicSigAccount.
2334 |
2335 | #### Parameters
2336 |
2337 | | Name | Type |
2338 | | :------ | :------ |
2339 | | `account` | [`LogicSigAccount`](classes/LogicSigAccount.md) |
2340 |
2341 | #### Returns
2342 |
2343 | [`TransactionSigner`](modules.md#transactionsigner)
2344 |
2345 | #### Defined in
2346 |
2347 | signer.ts:40
2348 |
2349 | ___
2350 |
2351 | ### makeMultiSigAccountTransactionSigner
2352 |
2353 | ▸ **makeMultiSigAccountTransactionSigner**(`msig`, `sks`): [`TransactionSigner`](modules.md#transactionsigner)
2354 |
2355 | Create a TransactionSigner that can sign transactions for the provided Multisig account.
2356 |
2357 | #### Parameters
2358 |
2359 | | Name | Type | Description |
2360 | | :------ | :------ | :------ |
2361 | | `msig` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) | The Multisig account metadata |
2362 | | `sks` | `Uint8Array`[] | An array of private keys belonging to the msig which should sign the transactions. |
2363 |
2364 | #### Returns
2365 |
2366 | [`TransactionSigner`](modules.md#transactionsigner)
2367 |
2368 | #### Defined in
2369 |
2370 | signer.ts:60
2371 |
2372 | ___
2373 |
2374 | ### makePaymentTxnWithSuggestedParams
2375 |
2376 | ▸ **makePaymentTxnWithSuggestedParams**(`from`, `to`, `amount`, `closeRemainderTo`, `note`, `suggestedParams`, `rekeyTo?`): [`Transaction`](classes/Transaction.md)
2377 |
2378 | makePaymentTxnWithSuggestedParams takes payment arguments and returns a Transaction object
2379 |
2380 | #### Parameters
2381 |
2382 | | Name | Type | Description |
2383 | | :------ | :------ | :------ |
2384 | | `from` | `string` | string representation of Algorand address of sender |
2385 | | `to` | `string` | string representation of Algorand address of recipient |
2386 | | `amount` | `number` \| `bigint` | integer amount to send, in microAlgos |
2387 | | `closeRemainderTo` | `string` | optionally close out remaining account balance to this account, represented as string rep of Algorand address |
2388 | | `note` | `Uint8Array` | uint8array of arbitrary data for sender to store |
2389 | | `suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) | a dict holding common-to-all-txns args: fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true flatFee - bool optionally set this to true to specify fee as microalgos-per-txn If true, txn fee may fall below the ALGORAND_MIN_TX_FEE firstRound - integer first protocol round on which this txn is valid lastRound - integer last protocol round on which this txn is valid genesisHash - string specifies hash genesis block of network in use genesisID - string specifies genesis ID of network in use |
2390 | | `rekeyTo?` | `string` | rekeyTo address, optional |
2391 |
2392 | #### Returns
2393 |
2394 | [`Transaction`](classes/Transaction.md)
2395 |
2396 | **`Deprecated`**
2397 |
2398 | This function will be removed in v3 in favor of [makePaymentTxnWithSuggestedParamsFromObject](modules.md#makepaymenttxnwithsuggestedparamsfromobject)
2399 |
2400 | #### Defined in
2401 |
2402 | makeTxn.ts:45
2403 |
2404 | ___
2405 |
2406 | ### makePaymentTxnWithSuggestedParamsFromObject
2407 |
2408 | ▸ **makePaymentTxnWithSuggestedParamsFromObject**(`o`): [`Transaction`](classes/Transaction.md)
2409 |
2410 | #### Parameters
2411 |
2412 | | Name | Type |
2413 | | :------ | :------ |
2414 | | `o` | `Object` |
2415 | | `o.amount` | `number` \| `bigint` |
2416 | | `o.closeRemainderTo` | `string` |
2417 | | `o.from` | `string` |
2418 | | `o.note` | `Uint8Array` |
2419 | | `o.rekeyTo` | `string` |
2420 | | `o.suggestedParams` | [`SuggestedParams`](interfaces/SuggestedParams.md) |
2421 | | `o.to` | `string` |
2422 |
2423 | #### Returns
2424 |
2425 | [`Transaction`](classes/Transaction.md)
2426 |
2427 | #### Defined in
2428 |
2429 | makeTxn.ts:68
2430 |
2431 | ___
2432 |
2433 | ### masterDerivationKeyToMnemonic
2434 |
2435 | ▸ **masterDerivationKeyToMnemonic**(`mdk`): `string`
2436 |
2437 | masterDerivationKeyToMnemonic takes a master derivation key and returns the corresponding mnemonic.
2438 |
2439 | #### Parameters
2440 |
2441 | | Name | Type | Description |
2442 | | :------ | :------ | :------ |
2443 | | `mdk` | `Uint8Array` | Uint8Array |
2444 |
2445 | #### Returns
2446 |
2447 | `string`
2448 |
2449 | string mnemonic
2450 |
2451 | #### Defined in
2452 |
2453 | mnemonic/mnemonic.ts:179
2454 |
2455 | ___
2456 |
2457 | ### mergeMultisigTransactions
2458 |
2459 | ▸ **mergeMultisigTransactions**(`multisigTxnBlobs`): `Uint8Array`
2460 |
2461 | mergeMultisigTransactions takes a list of multisig transaction blobs, and merges them.
2462 |
2463 | #### Parameters
2464 |
2465 | | Name | Type | Description |
2466 | | :------ | :------ | :------ |
2467 | | `multisigTxnBlobs` | `Uint8Array`[] | a list of blobs representing encoded multisig txns |
2468 |
2469 | #### Returns
2470 |
2471 | `Uint8Array`
2472 |
2473 | typed array msg-pack encoded multisig txn
2474 |
2475 | #### Defined in
2476 |
2477 | multisig.ts:230
2478 |
2479 | ___
2480 |
2481 | ### microalgosToAlgos
2482 |
2483 | ▸ **microalgosToAlgos**(`microalgos`): `number`
2484 |
2485 | microalgosToAlgos converts microalgos to algos
2486 |
2487 | #### Parameters
2488 |
2489 | | Name | Type | Description |
2490 | | :------ | :------ | :------ |
2491 | | `microalgos` | `number` | number |
2492 |
2493 | #### Returns
2494 |
2495 | `number`
2496 |
2497 | number
2498 |
2499 | #### Defined in
2500 |
2501 | convert.ts:10
2502 |
2503 | ___
2504 |
2505 | ### mnemonicFromSeed
2506 |
2507 | ▸ **mnemonicFromSeed**(`seed`): `string`
2508 |
2509 | mnemonicFromSeed converts a 32-byte key into a 25 word mnemonic. The generated mnemonic includes a checksum.
2510 | Each word in the mnemonic represents 11 bits of data, and the last 11 bits are reserved for the checksum.
2511 |
2512 | #### Parameters
2513 |
2514 | | Name | Type | Description |
2515 | | :------ | :------ | :------ |
2516 | | `seed` | `Uint8Array` | 32 bytes long seed |
2517 |
2518 | #### Returns
2519 |
2520 | `string`
2521 |
2522 | 25 words mnemonic
2523 |
2524 | #### Defined in
2525 |
2526 | mnemonic/mnemonic.ts:54
2527 |
2528 | ___
2529 |
2530 | ### mnemonicToMasterDerivationKey
2531 |
2532 | ▸ **mnemonicToMasterDerivationKey**(`mn`): `Uint8Array`
2533 |
2534 | mnemonicToMasterDerivationKey takes a mnemonic string and returns the corresponding master derivation key.
2535 |
2536 | #### Parameters
2537 |
2538 | | Name | Type | Description |
2539 | | :------ | :------ | :------ |
2540 | | `mn` | `string` | 25 words Algorand mnemonic |
2541 |
2542 | #### Returns
2543 |
2544 | `Uint8Array`
2545 |
2546 | Uint8Array
2547 |
2548 | **`Throws`**
2549 |
2550 | error if fails to decode the mnemonic
2551 |
2552 | #### Defined in
2553 |
2554 | mnemonic/mnemonic.ts:170
2555 |
2556 | ___
2557 |
2558 | ### mnemonicToSecretKey
2559 |
2560 | ▸ **mnemonicToSecretKey**(`mn`): [`Account`](interfaces/Account.md)
2561 |
2562 | mnemonicToSecretKey takes a mnemonic string and returns the corresponding Algorand address and its secret key.
2563 |
2564 | #### Parameters
2565 |
2566 | | Name | Type | Description |
2567 | | :------ | :------ | :------ |
2568 | | `mn` | `string` | 25 words Algorand mnemonic |
2569 |
2570 | #### Returns
2571 |
2572 | [`Account`](interfaces/Account.md)
2573 |
2574 | **`Throws`**
2575 |
2576 | error if fails to decode the mnemonic
2577 |
2578 | #### Defined in
2579 |
2580 | mnemonic/mnemonic.ts:146
2581 |
2582 | ___
2583 |
2584 | ### multisigAddress
2585 |
2586 | ▸ **multisigAddress**(`«destructured»`): `string`
2587 |
2588 | multisigAddress takes multisig metadata (preimage) and returns the corresponding human readable Algorand address.
2589 |
2590 | #### Parameters
2591 |
2592 | | Name | Type |
2593 | | :------ | :------ |
2594 | | `«destructured»` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) |
2595 |
2596 | #### Returns
2597 |
2598 | `string`
2599 |
2600 | #### Defined in
2601 |
2602 | multisig.ts:490
2603 |
2604 | ___
2605 |
2606 | ### secretKeyToMnemonic
2607 |
2608 | ▸ **secretKeyToMnemonic**(`sk`): `string`
2609 |
2610 | secretKeyToMnemonic takes an Algorand secret key and returns the corresponding mnemonic.
2611 |
2612 | #### Parameters
2613 |
2614 | | Name | Type | Description |
2615 | | :------ | :------ | :------ |
2616 | | `sk` | `Uint8Array` | Algorand secret key |
2617 |
2618 | #### Returns
2619 |
2620 | `string`
2621 |
2622 | Secret key's associated mnemonic
2623 |
2624 | #### Defined in
2625 |
2626 | mnemonic/mnemonic.ts:158
2627 |
2628 | ___
2629 |
2630 | ### seedFromMnemonic
2631 |
2632 | ▸ **seedFromMnemonic**(`mnemonic`): `Uint8Array`
2633 |
2634 | seedFromMnemonic converts a mnemonic generated using this library into the source key used to create it.
2635 | It returns an error if the passed mnemonic has an incorrect checksum, if the number of words is unexpected, or if one
2636 | of the passed words is not found in the words list.
2637 |
2638 | #### Parameters
2639 |
2640 | | Name | Type | Description |
2641 | | :------ | :------ | :------ |
2642 | | `mnemonic` | `string` | 25 words mnemonic |
2643 |
2644 | #### Returns
2645 |
2646 | `Uint8Array`
2647 |
2648 | 32 bytes long seed
2649 |
2650 | #### Defined in
2651 |
2652 | mnemonic/mnemonic.ts:100
2653 |
2654 | ___
2655 |
2656 | ### signBid
2657 |
2658 | ▸ **signBid**(`bid`, `sk`): `Uint8Array`
2659 |
2660 | signBid takes an object with the following fields: bidder key, bid amount, max price, bid ID, auctionKey, auction ID,
2661 | and a secret key and returns a signed blob to be inserted into a transaction Algorand note field.
2662 |
2663 | #### Parameters
2664 |
2665 | | Name | Type | Description |
2666 | | :------ | :------ | :------ |
2667 | | `bid` | `BidOptions` | Algorand Bid |
2668 | | `sk` | `Uint8Array` | Algorand secret key |
2669 |
2670 | #### Returns
2671 |
2672 | `Uint8Array`
2673 |
2674 | Uint8Array binary signed bid
2675 |
2676 | #### Defined in
2677 |
2678 | main.ts:56
2679 |
2680 | ___
2681 |
2682 | ### signBytes
2683 |
2684 | ▸ **signBytes**(`bytes`, `sk`): `Uint8Array`
2685 |
2686 | signBytes takes arbitrary bytes and a secret key, prepends the bytes with "MX" for domain separation, signs the bytes
2687 | with the private key, and returns the signature.
2688 |
2689 | #### Parameters
2690 |
2691 | | Name | Type | Description |
2692 | | :------ | :------ | :------ |
2693 | | `bytes` | `Uint8Array` | Uint8array |
2694 | | `sk` | `Uint8Array` | Algorand secret key |
2695 |
2696 | #### Returns
2697 |
2698 | `Uint8Array`
2699 |
2700 | binary signature
2701 |
2702 | #### Defined in
2703 |
2704 | main.ts:68
2705 |
2706 | ___
2707 |
2708 | ### signLogicSigTransaction
2709 |
2710 | ▸ **signLogicSigTransaction**(`txn`, `lsigObject`): `Object`
2711 |
2712 | signLogicSigTransaction takes a transaction and a LogicSig object and returns
2713 | a signed transaction.
2714 |
2715 | #### Parameters
2716 |
2717 | | Name | Type | Description |
2718 | | :------ | :------ | :------ |
2719 | | `txn` | [`TransactionLike`](modules.md#transactionlike) | The transaction to sign. |
2720 | | `lsigObject` | [`LogicSig`](classes/LogicSig.md) \| [`LogicSigAccount`](classes/LogicSigAccount.md) | The LogicSig object that will sign the transaction. |
2721 |
2722 | #### Returns
2723 |
2724 | `Object`
2725 |
2726 | Object containing txID and blob representing signed transaction.
2727 |
2728 | | Name | Type |
2729 | | :------ | :------ |
2730 | | `blob` | `Uint8Array` |
2731 | | `txID` | `string` |
2732 |
2733 | **`Throws`**
2734 |
2735 | error on failure
2736 |
2737 | #### Defined in
2738 |
2739 | logicsig.ts:460
2740 |
2741 | ___
2742 |
2743 | ### signLogicSigTransactionObject
2744 |
2745 | ▸ **signLogicSigTransactionObject**(`txn`, `lsigObject`): `Object`
2746 |
2747 | signLogicSigTransactionObject takes a transaction and a LogicSig object and
2748 | returns a signed transaction.
2749 |
2750 | #### Parameters
2751 |
2752 | | Name | Type | Description |
2753 | | :------ | :------ | :------ |
2754 | | `txn` | [`Transaction`](classes/Transaction.md) | The transaction to sign. |
2755 | | `lsigObject` | [`LogicSig`](classes/LogicSig.md) \| [`LogicSigAccount`](classes/LogicSigAccount.md) | The LogicSig object that will sign the transaction. |
2756 |
2757 | #### Returns
2758 |
2759 | `Object`
2760 |
2761 | Object containing txID and blob representing signed transaction.
2762 |
2763 | | Name | Type |
2764 | | :------ | :------ |
2765 | | `blob` | `Uint8Array` |
2766 | | `txID` | `string` |
2767 |
2768 | #### Defined in
2769 |
2770 | logicsig.ts:416
2771 |
2772 | ___
2773 |
2774 | ### signMultisigTransaction
2775 |
2776 | ▸ **signMultisigTransaction**(`txn`, `«destructured»`, `sk`): `Object`
2777 |
2778 | signMultisigTransaction takes a raw transaction (see signTransaction), a multisig preimage, a secret key, and returns
2779 | a multisig transaction, which is a blob representing a transaction and multisignature account preimage. The returned
2780 | multisig txn can accumulate additional signatures through mergeMultisigTransactions or appendSignMultisigTransaction.
2781 |
2782 | #### Parameters
2783 |
2784 | | Name | Type | Description |
2785 | | :------ | :------ | :------ |
2786 | | `txn` | [`TransactionLike`](modules.md#transactionlike) | object with either payment or key registration fields |
2787 | | `«destructured»` | [`MultisigMetadata`](interfaces/MultisigMetadata.md) | - |
2788 | | `sk` | `Uint8Array` | Algorand secret key. The corresponding pk should be in the pre image. |
2789 |
2790 | #### Returns
2791 |
2792 | `Object`
2793 |
2794 | object containing txID, and blob of partially signed multisig transaction (with multisig preimage information)
2795 | If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
2796 |
2797 | | Name | Type |
2798 | | :------ | :------ |
2799 | | `blob` | `Uint8Array` |
2800 | | `txID` | `string` |
2801 |
2802 | #### Defined in
2803 |
2804 | multisig.ts:380
2805 |
2806 | ___
2807 |
2808 | ### signTransaction
2809 |
2810 | ▸ **signTransaction**(`txn`, `sk`): `Object`
2811 |
2812 | signTransaction takes an object with either payment or key registration fields and
2813 | a secret key and returns a signed blob.
2814 |
2815 | Payment transaction fields: from, to, amount, fee, firstRound, lastRound, genesisHash,
2816 | note(optional), GenesisID(optional), closeRemainderTo(optional)
2817 |
2818 | Key registration fields: fee, firstRound, lastRound, voteKey, selectionKey, voteFirst,
2819 | voteLast, voteKeyDilution, genesisHash, note(optional), GenesisID(optional)
2820 |
2821 | If flatFee is not set and the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
2822 |
2823 | #### Parameters
2824 |
2825 | | Name | Type | Description |
2826 | | :------ | :------ | :------ |
2827 | | `txn` | [`TransactionLike`](modules.md#transactionlike) | object with either payment or key registration fields |
2828 | | `sk` | `Uint8Array` | Algorand Secret Key |
2829 |
2830 | #### Returns
2831 |
2832 | `Object`
2833 |
2834 | object contains the binary signed transaction and its txID
2835 |
2836 | | Name | Type |
2837 | | :------ | :------ |
2838 | | `blob` | `Uint8Array` |
2839 | | `txID` | `string` |
2840 |
2841 | #### Defined in
2842 |
2843 | main.ts:31
2844 |
2845 | ___
2846 |
2847 | ### tealSign
2848 |
2849 | ▸ **tealSign**(`sk`, `data`, `programHash`): `Uint8Array`
2850 |
2851 | tealSign creates a signature compatible with ed25519verify opcode from program hash
2852 |
2853 | #### Parameters
2854 |
2855 | | Name | Type | Description |
2856 | | :------ | :------ | :------ |
2857 | | `sk` | `Uint8Array` | uint8array with secret key |
2858 | | `data` | `Uint8Array` \| `Buffer` | buffer with data to sign |
2859 | | `programHash` | `string` | string representation of teal program hash (= contract address for LogicSigs) |
2860 |
2861 | #### Returns
2862 |
2863 | `Uint8Array`
2864 |
2865 | #### Defined in
2866 |
2867 | logicsig.ts:484
2868 |
2869 | ___
2870 |
2871 | ### tealSignFromProgram
2872 |
2873 | ▸ **tealSignFromProgram**(`sk`, `data`, `program`): `Uint8Array`
2874 |
2875 | tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
2876 |
2877 | #### Parameters
2878 |
2879 | | Name | Type | Description |
2880 | | :------ | :------ | :------ |
2881 | | `sk` | `Uint8Array` | uint8array with secret key |
2882 | | `data` | `Uint8Array` \| `Buffer` | buffer with data to sign |
2883 | | `program` | `Uint8Array` | buffer with teal program |
2884 |
2885 | #### Returns
2886 |
2887 | `Uint8Array`
2888 |
2889 | #### Defined in
2890 |
2891 | logicsig.ts:528
2892 |
2893 | ___
2894 |
2895 | ### verifyBytes
2896 |
2897 | ▸ **verifyBytes**(`bytes`, `signature`, `addr`): `boolean`
2898 |
2899 | verifyBytes takes array of bytes, an address, and a signature and verifies if the signature is correct for the public
2900 | key and the bytes (the bytes should have been signed with "MX" prepended for domain separation).
2901 |
2902 | #### Parameters
2903 |
2904 | | Name | Type | Description |
2905 | | :------ | :------ | :------ |
2906 | | `bytes` | `Uint8Array` | Uint8Array |
2907 | | `signature` | `Uint8Array` | binary signature |
2908 | | `addr` | `string` | string address |
2909 |
2910 | #### Returns
2911 |
2912 | `boolean`
2913 |
2914 | bool
2915 |
2916 | #### Defined in
2917 |
2918 | main.ts:82
2919 |
2920 | ___
2921 |
2922 | ### verifyMultisig
2923 |
2924 | ▸ **verifyMultisig**(`toBeVerified`, `msig`, `publicKey`): `boolean`
2925 |
2926 | #### Parameters
2927 |
2928 | | Name | Type |
2929 | | :------ | :------ |
2930 | | `toBeVerified` | `Uint8Array` |
2931 | | `msig` | [`EncodedMultisig`](interfaces/EncodedMultisig.md) |
2932 | | `publicKey` | `Uint8Array` |
2933 |
2934 | #### Returns
2935 |
2936 | `boolean`
2937 |
2938 | #### Defined in
2939 |
2940 | multisig.ts:317
2941 |
2942 | ___
2943 |
2944 | ### verifyTealSign
2945 |
2946 | ▸ **verifyTealSign**(`data`, `programHash`, `sig`, `pk`): `boolean`
2947 |
2948 | verifyTealSign verifies a signature as would the ed25519verify opcode
2949 |
2950 | #### Parameters
2951 |
2952 | | Name | Type | Description |
2953 | | :------ | :------ | :------ |
2954 | | `data` | `Uint8Array` \| `Buffer` | buffer with original signed data |
2955 | | `programHash` | `string` | string representation of teal program hash (= contract address for LogicSigs) |
2956 | | `sig` | `Uint8Array` | uint8array with the signature to verify (produced by tealSign/tealSignFromProgram) |
2957 | | `pk` | `Uint8Array` | uint8array with public key to verify against |
2958 |
2959 | #### Returns
2960 |
2961 | `boolean`
2962 |
2963 | #### Defined in
2964 |
2965 | logicsig.ts:506
2966 |
2967 | ___
2968 |
2969 | ### waitForConfirmation
2970 |
2971 | ▸ **waitForConfirmation**(`client`, `txid`, `waitRounds`): `Promise`\<`Record`\<`string`, `any`\>\>
2972 |
2973 | Wait until a transaction has been confirmed or rejected by the network, or
2974 | until 'waitRounds' number of rounds have passed.
2975 |
2976 | #### Parameters
2977 |
2978 | | Name | Type | Description |
2979 | | :------ | :------ | :------ |
2980 | | `client` | [`Algodv2`](classes/Algodv2.md) | An Algodv2 client |
2981 | | `txid` | `string` | The ID of the transaction to wait for. |
2982 | | `waitRounds` | `number` | The maximum number of rounds to wait for. |
2983 |
2984 | #### Returns
2985 |
2986 | `Promise`\<`Record`\<`string`, `any`\>\>
2987 |
2988 | A promise that, upon success, will resolve to the output of the
2989 | `pendingTransactionInformation` call for the confirmed transaction.
2990 |
2991 | #### Defined in
2992 |
2993 | wait.ts:12
2994 |
```