@goplausible/algorand-mcp 3.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +692 -0
- package/dist/algorand-client.d.ts +2 -0
- package/dist/algorand-client.js +2 -0
- package/dist/env.d.ts +1 -0
- package/dist/env.js +4 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +158 -0
- package/dist/networkConfig.d.ts +5 -0
- package/dist/networkConfig.js +57 -0
- package/dist/resources/index.d.ts +16 -0
- package/dist/resources/index.js +37 -0
- package/dist/resources/knowledge/index.d.ts +72 -0
- package/dist/resources/knowledge/index.js +180 -0
- package/dist/resources/knowledge/taxonomy/algokit-cli:README.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:README.md +70 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:algokit.md +52 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md +94 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md +95 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md +412 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_brew_install.md +86 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md +375 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md +164 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md +203 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-13_native_binaries.md +163 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md +211 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md +255 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md +143 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:articles:output_stability.md +8 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:cli:index.md +1517 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:compile.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:completions.md +56 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:config.md +37 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:dispenser.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:doctor.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:explore.md +21 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:generate.md +179 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:goal.md +139 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:init.md +122 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:localnet.md +191 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project.md +95 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:bootstrap.md +128 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:deploy.md +211 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:link.md +67 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:list.md +43 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:run.md +184 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks.md +16 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:analyze.md +33 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:ipfs.md +66 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:mint.md +70 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:nfd.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:opt.md +71 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:send.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:sign.md +94 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:transfer.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:vanity_address.md +56 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:wallet.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:algokit-template.md +220 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:intro.md +171 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:smart-contracts.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:docs:testnet_api.md +157 -0
- package/dist/resources/knowledge/taxonomy/algokit:lora:README.md +61 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:README.md +35 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md +1095 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:account.md +32 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-client.md +154 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-deploy.md +121 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:client.md +29 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:debugger.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:dispenser-client.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:transfer.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:index.md +123 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:account.md +31 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-client.md +157 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-deploy.md +121 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:client.md +29 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:debugger.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:dispenser-client.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:transfer.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:index.md +103 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:README.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:account.md +186 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:algorand-client.md +160 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:amount.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-client.md +422 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-deploy.md +278 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app.md +442 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:asset.md +331 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:client.md +115 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:debugging.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:dispenser-client.md +85 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:event-emitter.md +97 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:indexer.md +83 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:testing.md +207 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction-composer.md +89 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction.md +23 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transfer.md +129 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:typed-app-clients.md +201 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:README.md +53 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TestLogger.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TransactionLogger.md +149 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.MultisigAccount.md +178 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.SigningAccount.md +153 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md +924 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md +200 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md +646 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md +1290 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md +1425 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md +247 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md +259 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.AppClient.md +1350 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md +887 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md +186 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md +780 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_manager.AppManager.md +527 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md +221 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md +244 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md +1072 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md +1281 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md +274 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md +225 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md +182 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_logic_error.LogicError.md +261 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnUpdate.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md +78 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.SignatureType.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md +32 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md +69 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md +102 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md +233 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md +108 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md +72 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md +305 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppLookup.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md +174 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppReference.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppState.md +11 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxName.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxReference.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md +287 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md +148 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md +274 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md +284 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md +145 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md +150 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md +49 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md +80 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md +83 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md +111 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md +239 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md +120 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md +62 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md +65 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md +164 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md +145 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md +156 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md +105 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md +224 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md +268 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md +369 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md +84 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md +39 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_config.Config.md +115 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md +72 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md +79 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md +149 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md +165 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md +65 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md +53 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md +52 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md +88 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md +92 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md +57 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md +135 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md +48 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md +49 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md +222 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md +235 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md +248 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md +261 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.indexer.md +194 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.md +3215 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:testing.md +243 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account.md +100 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_interface.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app.md +279 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_arc56.md +346 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client.md +347 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_deployer.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory.md +124 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_manager.md +36 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_spec.md +160 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset.md +12 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset_manager.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager.md +122 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_composer.md +433 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_config.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_debugging.md +79 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client.md +15 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_expand.md +28 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_indexer.md +611 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_kmd_account_manager.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_lifecycle_events.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logging.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logic_error.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_network_client.md +39 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_testing.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transaction.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transfer.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v7-migration.md +392 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v8-migration.md +102 -0
- package/dist/resources/knowledge/taxonomy/arcs:ARC-template.md +48 -0
- package/dist/resources/knowledge/taxonomy/arcs:README.md +41 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0012:README.md +30 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0034:TemplateForm.md +58 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0062:README.md +16 -0
- package/dist/resources/knowledge/taxonomy/arcs:pages:nfts.md +24 -0
- package/dist/resources/knowledge/taxonomy/arcs:pages:wallets.md +74 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0000.md +298 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0001.md +480 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0002.md +138 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0003.md +469 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0004.md +725 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0005.md +90 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0006.md +202 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0007.md +113 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0008.md +55 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0009.md +63 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0010.md +111 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0011.md +47 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0012.md +158 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0015.md +112 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0016.md +97 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0018.md +616 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0019.md +246 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0020.md +742 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0021.md +98 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0022.md +75 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0023.md +189 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0025.md +241 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0026.md +112 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0028.md +176 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0032.md +286 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0033.md +104 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0034.md +167 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0035.md +151 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0036.md +84 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0042.md +76 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0047.md +171 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0048.md +85 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0049.md +80 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0054.md +217 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0055.md +540 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0056.md +516 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0059.md +726 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0062.md +339 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0065.md +169 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0069.md +183 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0072.md +335 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0073.md +93 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0074.md +128 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0076.md +99 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0078.md +220 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0079.md +109 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0200.md +232 -0
- package/dist/resources/knowledge/taxonomy/clis_index.md +2347 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:about.md +13 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:algokey.md +45 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:generate.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:import.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:append-auth-addr.md +44 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:multisig.md +47 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:info.md +40 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:part.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:reparent.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:sign.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:conduit.md +71 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:init.md +88 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:exporters.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:importers.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:list.md +63 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:processors.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:diagcfg.md +39 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:disable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:enable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:metric.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:status.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:disable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:enable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:endpoint.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:name.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:status.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:telemetry.md +53 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:restart.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:start.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:status.md +62 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:stop.md +52 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:wait.md +62 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:protocols.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:report.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:version.md +54 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:list.md +52 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:new.md +54 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:wallet.md +56 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:api-config.md +50 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:daemon.md +110 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:indexer.md +50 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:util.md +39 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:validator.md +72 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:kmd.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:debug.md +92 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:remote.md +66 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:tealdbg.md +59 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:create.md +741 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:index.md +107 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:rekey.md +462 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:betanet.md +31 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:index.md +23 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:mainnet.md +19 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:testnet.md +25 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand_consensus.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:asa.md +1214 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:atc.md +412 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:atomic_transfers.md +396 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:conduit.md +95 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:crust.md +156 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:index.md +18 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:guidelines.md +3 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:index.md +332 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:jsonspec.md +134 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:index.md +16 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v1.md +401 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v10.md +1748 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v2.md +671 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v3.md +789 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v4.md +1029 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v5.md +1263 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v6.md +1359 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v7.md +1481 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v8.md +1640 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v9.md +1640 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:specification.md +945 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:ABI:index.md +172 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:create.md +398 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:index.md +246 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:innertx.md +514 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:state.md +704 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:txs.md +231 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:debugging.md +897 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:apps.md +1680 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md +492 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:guidelines.md +405 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:index.md +41 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:index.md +15 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:modes.md +34 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md +159 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:beaker.md +341 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:pyteal.md +786 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:python.md +3 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:encoding.md +457 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:ethereum_to_algorand.md +239 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:index.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:indexer.md +472 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:parameter_tables.md +84 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:index.md +61 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:light_client.md +390 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:technical_faq.md +233 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:index.md +746 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:offline_transactions.md +319 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:payment_prompts.md +96 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:signatures.md +484 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:transactions.md +168 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:useful_resources.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:algokit.md +263 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:what_is_blockchain.md +69 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:whats_a_dapp.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:where_to_start.md +43 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:why_algorand.md +119 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:ft.md +24 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:nft.md +41 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:index.md +100 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:algod.md +3163 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:indexer.md +2142 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:kmd.md +1347 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:restendpoints.md +76 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:catchup.md +33 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:switch_networks.md +89 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:generate_keys.md +76 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:index.md +56 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:offline.md +83 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:online.md +170 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:renew.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:artifacts.md +89 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:config.md +190 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:relay.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:telemetry-config.md +31 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:indexer.md +71 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:install.md +618 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:node-troubleshooting.md +190 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:types.md +77 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:go:index.md +189 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:index.md +38 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:java:index.md +164 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:javascript:index.md +168 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:python:index.md +162 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:accounts.md +215 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:arc4_types.md +267 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:assets.md +235 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:box_storage.md +211 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:control_flow.md +162 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:crypto:merkle_tree.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:amm.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:auction.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:htlc_logicsig.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:marketplace.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:events:arc28_events.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:global_storage.md +192 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:governance:simple_voting.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:hello_world.md +133 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:inner_transactions.md +247 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:local_storage.md +227 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:nft:proof_of_attendance.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:privacy:zk_whitelist.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:scratch_storage.md +169 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:self_payment.md +167 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:struct_in_box.md +182 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:subsidize_app_call.md +189 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:transactions.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:utility:calculator.md +0 -0
- package/dist/resources/knowledge/taxonomy/devportal-code-examples:README.md +31 -0
- package/dist/resources/knowledge/taxonomy/devportal-code-examples:projects:python-contract-examples:README.md +155 -0
- package/dist/resources/knowledge/taxonomy/docs:.walletconnect:index.md +133 -0
- package/dist/resources/knowledge/taxonomy/docs:.walletconnect:walletconnect-schema.md +167 -0
- package/dist/resources/knowledge/taxonomy/docs:README.md +12 -0
- package/dist/resources/knowledge/taxonomy/docs:scripts:README.md +90 -0
- package/dist/resources/knowledge/taxonomy/docs:scripts:example_tracker:example_list.md +132 -0
- package/dist/resources/knowledge/taxonomy/index.md +2044 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:ARCHITECTURE.md +241 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:README.md +105 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:SEQUENCE.md +41 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:VISION.md +13 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:1-Service-Authentication.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:2-Bidirectional-Communication.md +42 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:3-Peer-to-Peer-Signaling.md +60 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:4-Fido-Extension.md +51 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:README.md +6 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:README.md +54 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:architecture.md +101 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:authenticate.md +13 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:register.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:authentication.md +107 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:example.md +64 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:introduction.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:environment-variables.md +75 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:integrations.md +168 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:introduction.md +22 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:running-locally.md +88 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md +3 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md +3 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md +1 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md +0 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:sites:express-dapp:README.md +73 -0
- package/dist/resources/knowledge/taxonomy/liquid_auth_index.md +2221 -0
- package/dist/resources/knowledge/taxonomy/puya:README.md +72 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:algopy_testing:index.md +15 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.arc4.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.gtxn.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.itxn.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.op.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:compiler.md +239 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:index.md +63 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:language-guide.md +86 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc28.md +53 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc4.md +225 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-builtins.md +26 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-calling-apps.md +142 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-compile.md +70 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-control.md +87 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-errors.md +36 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-logs.md +46 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-modules.md +90 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-opcode-budget.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-ops.md +40 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-storage.md +222 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-structure.md +283 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-transactions.md +248 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-types.md +319 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-unsupported-python-features.md +52 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:principles.md +196 -0
- package/dist/resources/knowledge/taxonomy/puya:examples:auction:README.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:README.md +66 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:algopy.md +9 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:api.md +41 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:coverage.md +159 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:examples.md +13 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:faq.md +61 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:index.md +182 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:arc4-types.md +96 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:avm-types.md +223 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:concepts.md +58 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:contract-testing.md +225 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:index.md +67 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:opcodes.md +382 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:signature-testing.md +73 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:state-management.md +104 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:subroutines.md +62 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:transactions.md +200 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:examples:README.md +56 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puya:ARCHITECTURE.md +26 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_typeshed:README.md +10 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md +34 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:awst_build:README.md +13 -0
- package/dist/resources/knowledge/taxonomy/puya:stubs:README.md +89 -0
- package/dist/resources/knowledge/taxonomy/puya:tests:test_expected_output:README.md +17 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:README.md +11 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:README.md +35 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md +196 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md +179 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:packages:algo-ts:readme.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya_index.md +2143 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:FAQ.md +21 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:README.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIAddressType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayDynamicType.md +230 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayStaticType.md +236 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIBoolType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIByteType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIContract.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIInterface.md +100 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIMethod.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIStringType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABITupleType.md +230 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIType.md +169 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUfixedType.md +221 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUintType.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Algodv2.md +1321 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:AtomicTransactionComposer.md +385 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:DryrunResult.md +61 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Indexer.md +727 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Kmd.md +642 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSig.md +315 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSigAccount.md +276 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:SourceMap.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Transaction.md +1133 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Account.md +557 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountParticipation.md +195 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountResponse.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountStateDelta.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Application.md +180 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalState.md +195 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogData.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogsResponse.md +163 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationParams.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationResponse.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationStateSchema.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Asset.md +183 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetBalancesResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHolding.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHoldingsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetParams.md +334 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetResponse.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Block.md +390 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockRewards.md +199 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeState.md +181 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeVote.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Box.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxDescriptor.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxesResponse.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ErrorResponse.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDelta.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDeltaKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HashFactory.md +122 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HealthCheck.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.IndexerStateProofMessage.md +178 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MerkleArrayProof.md +148 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MiniAssetHolding.md +188 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ParticipationUpdates.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofFields.md +211 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofParticipant.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofReveal.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSigSlot.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSignature.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofTracking.md +166 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofVerifier.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateSchema.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Transaction.md +629 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionApplication.md +291 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetConfig.md +145 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetFreeze.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetTransfer.md +201 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionKeyreg.md +211 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionPayment.md +170 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionResponse.md +140 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignature.md +157 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureLogicsig.md +171 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisig.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionStateProof.md +157 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Account.md +516 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountApplicationResponse.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetHolding.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetResponse.md +156 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetsInformationResponse.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountParticipation.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountStateDelta.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AppCallLogs.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Application.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationInitialStates.md +167 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationKVStorage.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalState.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationParams.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateOperation.md +182 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateSchema.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Asset.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHolding.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHoldingReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetParams.md +334 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockHashResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockLogsResponse.md +128 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockResponse.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockTxidsResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Box.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxDescriptor.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxesResponse.md +122 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BuildVersion.md +180 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.CompileResponse.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DisassembleResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunRequest.md +204 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunResponse.md +148 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunSource.md +163 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunState.md +176 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunTxnResult.md +253 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ErrorResponse.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDelta.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDeltaKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetSyncRoundResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.KvDelta.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LightBlockHeaderProof.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.NodeStatusResponse.md +480 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionResponse.md +312 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionsResponse.md +140 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PostTransactionsResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ScratchChange.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateInitialStates.md +125 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequest.md +227 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateResponse.md +197 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTraceConfig.md +169 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionGroupResult.md +206 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionResult.md +206 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md +221 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationEvalOverrides.md +198 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md +194 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationTransactionExecTrace.md +241 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProof.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProofMessage.md +182 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SupplyResponse.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md +123 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionParametersResponse.md +200 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionProofResponse.md +183 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Version.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABIReferenceType.md +47 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABITransactionType.md +99 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:AtomicTransactionComposerStatus.md +73 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:IntDecoding.md +65 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:OnApplicationComplete.md +96 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:TransactionType.md +103 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:examples:README.md +9 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworkInfo.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworks.md +7 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractParams.md +63 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIInterfaceParams.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodArgParams.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodParams.md +78 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodReturnParams.md +30 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIResult.md +90 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Account.md +38 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Address.md +32 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:AlgodTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClient.md +98 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientError.md +22 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientResponse.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BoxReference.md +36 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:CustomTokenHeader.md +7 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedAssetParams.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedBoxReference.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedGlobalStateSchema.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLocalStateSchema.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSig.md +52 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSigAccount.md +30 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedMultisig.md +50 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSignedTransaction.md +75 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSubsig.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedTransaction.md +606 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:IndexerTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:KMDTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:MultisigMetadata.md +52 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SignedTransaction.md +75 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SuggestedParams.md +89 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionParams.md +718 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionWithSigner.md +36 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules.md +2993 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:indexerModels.md +69 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:modelsv2.md +79 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:README.md +120 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:algosdk:v2client:harness:README.md +18 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:examples:README.md +11 -0
- package/dist/resources/knowledge/taxonomy/tealscript:FEATURES.md +252 -0
- package/dist/resources/knowledge/taxonomy/tealscript:README.md +54 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_amm_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_auction_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_big_box_README.md +20 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_itxns_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_lsig_with_app_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_reti_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_arrays.md +104 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_numbers.md +49 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_atomic_txn.md +22 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_features.md +256 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_getting_started.md +88 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_inner_transactions.md +43 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_lifecycle.md +88 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_math.md +54 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_methods.md +85 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_multiple_contracts.md +92 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_pyteal.md +35 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_storage.md +110 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tests_test_package_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0001-intro.md +9 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0002-init.md +50 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0003-contract.md +98 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0004-artifacts.md +59 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0005-hello.md +35 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0006-test.md +30 -0
- package/dist/resources/knowledge/taxonomy-categories/algokit-utils.json +148 -0
- package/dist/resources/knowledge/taxonomy-categories/algokit.json +105 -0
- package/dist/resources/knowledge/taxonomy-categories/arcs.json +92 -0
- package/dist/resources/knowledge/taxonomy-categories/clis.json +280 -0
- package/dist/resources/knowledge/taxonomy-categories/details.json +173 -0
- package/dist/resources/knowledge/taxonomy-categories/developers.json +71 -0
- package/dist/resources/knowledge/taxonomy-categories/liquid-auth.json +127 -0
- package/dist/resources/knowledge/taxonomy-categories/nodes.json +50 -0
- package/dist/resources/knowledge/taxonomy-categories/puya.json +76 -0
- package/dist/resources/knowledge/taxonomy-categories/python.json +104 -0
- package/dist/resources/knowledge/taxonomy-categories/sdks.json +152 -0
- package/dist/resources/knowledge/taxonomy-categories/tealscript.json +80 -0
- package/dist/tools/accountManager.d.ts +150 -0
- package/dist/tools/accountManager.js +339 -0
- package/dist/tools/algodManager.d.ts +134 -0
- package/dist/tools/algodManager.js +257 -0
- package/dist/tools/apiManager/algod/account.d.ts +10 -0
- package/dist/tools/apiManager/algod/account.js +135 -0
- package/dist/tools/apiManager/algod/application.d.ts +10 -0
- package/dist/tools/apiManager/algod/application.js +165 -0
- package/dist/tools/apiManager/algod/asset.d.ts +8 -0
- package/dist/tools/apiManager/algod/asset.js +47 -0
- package/dist/tools/apiManager/algod/index.d.ts +6 -0
- package/dist/tools/apiManager/algod/index.js +32 -0
- package/dist/tools/apiManager/algod/transaction.d.ts +14 -0
- package/dist/tools/apiManager/algod/transaction.js +216 -0
- package/dist/tools/apiManager/example/get-balance.d.ts +11 -0
- package/dist/tools/apiManager/example/get-balance.js +32 -0
- package/dist/tools/apiManager/example/index.d.ts +6 -0
- package/dist/tools/apiManager/example/index.js +18 -0
- package/dist/tools/apiManager/index.d.ts +45 -0
- package/dist/tools/apiManager/index.js +53 -0
- package/dist/tools/apiManager/indexer/account.d.ts +24 -0
- package/dist/tools/apiManager/indexer/account.js +248 -0
- package/dist/tools/apiManager/indexer/application.d.ts +24 -0
- package/dist/tools/apiManager/indexer/application.js +290 -0
- package/dist/tools/apiManager/indexer/asset.d.ts +36 -0
- package/dist/tools/apiManager/indexer/asset.js +292 -0
- package/dist/tools/apiManager/indexer/index.d.ts +6 -0
- package/dist/tools/apiManager/indexer/index.js +39 -0
- package/dist/tools/apiManager/indexer/transaction.d.ts +34 -0
- package/dist/tools/apiManager/indexer/transaction.js +276 -0
- package/dist/tools/apiManager/nfd/index.d.ts +6 -0
- package/dist/tools/apiManager/nfd/index.js +476 -0
- package/dist/tools/apiManager/tinyman/analytics.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/analytics.js +80 -0
- package/dist/tools/apiManager/tinyman/bootstrap.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/bootstrap.js +85 -0
- package/dist/tools/apiManager/tinyman/index.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/index.js +60 -0
- package/dist/tools/apiManager/tinyman/liquidity.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/liquidity.js +143 -0
- package/dist/tools/apiManager/tinyman/opt_in.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/opt_in.js +112 -0
- package/dist/tools/apiManager/tinyman/pool.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/pool.js +90 -0
- package/dist/tools/apiManager/tinyman/remove_liquidity.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/remove_liquidity.js +148 -0
- package/dist/tools/apiManager/tinyman/swap.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/swap.js +147 -0
- package/dist/tools/arc26Manager.d.ts +37 -0
- package/dist/tools/arc26Manager.js +131 -0
- package/dist/tools/commonParams.d.ts +18 -0
- package/dist/tools/commonParams.js +28 -0
- package/dist/tools/index.d.ts +8 -0
- package/dist/tools/index.js +8 -0
- package/dist/tools/knowledgeManager.d.ts +28 -0
- package/dist/tools/knowledgeManager.js +73 -0
- package/dist/tools/transactionManager/accountTransactions.d.ts +127 -0
- package/dist/tools/transactionManager/accountTransactions.js +177 -0
- package/dist/tools/transactionManager/appTransactions/callTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/callTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/clearTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/clearTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/closeOutTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/closeOutTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/createTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/createTxn.js +128 -0
- package/dist/tools/transactionManager/appTransactions/deleteTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/deleteTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/index.d.ts +23 -0
- package/dist/tools/transactionManager/appTransactions/index.js +56 -0
- package/dist/tools/transactionManager/appTransactions/optInTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/optInTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/types.d.ts +525 -0
- package/dist/tools/transactionManager/appTransactions/types.js +298 -0
- package/dist/tools/transactionManager/appTransactions/updateTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/updateTxn.js +101 -0
- package/dist/tools/transactionManager/assetTransactions.d.ts +300 -0
- package/dist/tools/transactionManager/assetTransactions.js +351 -0
- package/dist/tools/transactionManager/generalTransaction.d.ts +96 -0
- package/dist/tools/transactionManager/generalTransaction.js +504 -0
- package/dist/tools/transactionManager/index.d.ts +18 -0
- package/dist/tools/transactionManager/index.js +42 -0
- package/dist/tools/utilityManager.d.ts +127 -0
- package/dist/tools/utilityManager.js +422 -0
- package/dist/tools/walletManager.d.ts +46 -0
- package/dist/tools/walletManager.js +781 -0
- package/dist/types.d.ts +123 -0
- package/dist/types.js +42 -0
- package/dist/utils/responseProcessor.d.ts +31 -0
- package/dist/utils/responseProcessor.js +152 -0
- package/package.json +58 -0
|
@@ -0,0 +1,1425 @@
|
|
|
1
|
+
[@algorandfoundation/algokit-utils](../README.md) / [types/algorand-client-transaction-sender](../modules/types_algorand_client_transaction_sender.md) / AlgorandClientTransactionSender
|
|
2
|
+
|
|
3
|
+
# Class: AlgorandClientTransactionSender
|
|
4
|
+
|
|
5
|
+
[types/algorand-client-transaction-sender](../modules/types_algorand_client_transaction_sender.md).AlgorandClientTransactionSender
|
|
6
|
+
|
|
7
|
+
Orchestrates sending transactions for `AlgorandClient`.
|
|
8
|
+
|
|
9
|
+
## Table of contents
|
|
10
|
+
|
|
11
|
+
### Constructors
|
|
12
|
+
|
|
13
|
+
- [constructor](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#constructor)
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
- [\_appManager](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_appmanager)
|
|
18
|
+
- [\_assetManager](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_assetmanager)
|
|
19
|
+
- [\_newGroup](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_newgroup)
|
|
20
|
+
- [appCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcall)
|
|
21
|
+
- [appCallMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcallmethodcall)
|
|
22
|
+
- [appCreate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcreate)
|
|
23
|
+
- [appCreateMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcreatemethodcall)
|
|
24
|
+
- [appDelete](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appdelete)
|
|
25
|
+
- [appDeleteMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appdeletemethodcall)
|
|
26
|
+
- [appUpdate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appupdate)
|
|
27
|
+
- [appUpdateMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appupdatemethodcall)
|
|
28
|
+
- [assetConfig](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetconfig)
|
|
29
|
+
- [assetDestroy](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetdestroy)
|
|
30
|
+
- [assetFreeze](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetfreeze)
|
|
31
|
+
- [assetOptIn](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetoptin)
|
|
32
|
+
- [assetTransfer](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assettransfer)
|
|
33
|
+
- [offlineKeyRegistration](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#offlinekeyregistration)
|
|
34
|
+
- [onlineKeyRegistration](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#onlinekeyregistration)
|
|
35
|
+
- [payment](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#payment)
|
|
36
|
+
|
|
37
|
+
### Methods
|
|
38
|
+
|
|
39
|
+
- [\_send](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_send)
|
|
40
|
+
- [\_sendAppCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappcall)
|
|
41
|
+
- [\_sendAppCreateCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappcreatecall)
|
|
42
|
+
- [\_sendAppUpdateCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappupdatecall)
|
|
43
|
+
- [assetCreate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetcreate)
|
|
44
|
+
- [assetOptOut](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetoptout)
|
|
45
|
+
- [newGroup](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#newgroup)
|
|
46
|
+
|
|
47
|
+
## Constructors
|
|
48
|
+
|
|
49
|
+
### constructor
|
|
50
|
+
|
|
51
|
+
• **new AlgorandClientTransactionSender**(`newGroup`, `assetManager`, `appManager`): [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md)
|
|
52
|
+
|
|
53
|
+
Creates a new `AlgorandClientSender`
|
|
54
|
+
|
|
55
|
+
#### Parameters
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description |
|
|
58
|
+
| :------ | :------ | :------ |
|
|
59
|
+
| `newGroup` | () => [`TransactionComposer`](types_composer.TransactionComposer.md) | A lambda that starts a new `TransactionComposer` transaction group |
|
|
60
|
+
| `assetManager` | [`AssetManager`](types_asset_manager.AssetManager.md) | An `AssetManager` instance |
|
|
61
|
+
| `appManager` | [`AppManager`](types_app_manager.AppManager.md) | - |
|
|
62
|
+
|
|
63
|
+
#### Returns
|
|
64
|
+
|
|
65
|
+
[`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md)
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[src/types/algorand-client-transaction-sender.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L48)
|
|
70
|
+
|
|
71
|
+
## Properties
|
|
72
|
+
|
|
73
|
+
### \_appManager
|
|
74
|
+
|
|
75
|
+
• `Private` **\_appManager**: [`AppManager`](types_app_manager.AppManager.md)
|
|
76
|
+
|
|
77
|
+
#### Defined in
|
|
78
|
+
|
|
79
|
+
[src/types/algorand-client-transaction-sender.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L41)
|
|
80
|
+
|
|
81
|
+
___
|
|
82
|
+
|
|
83
|
+
### \_assetManager
|
|
84
|
+
|
|
85
|
+
• `Private` **\_assetManager**: [`AssetManager`](types_asset_manager.AssetManager.md)
|
|
86
|
+
|
|
87
|
+
#### Defined in
|
|
88
|
+
|
|
89
|
+
[src/types/algorand-client-transaction-sender.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L40)
|
|
90
|
+
|
|
91
|
+
___
|
|
92
|
+
|
|
93
|
+
### \_newGroup
|
|
94
|
+
|
|
95
|
+
• `Private` **\_newGroup**: () => [`TransactionComposer`](types_composer.TransactionComposer.md)
|
|
96
|
+
|
|
97
|
+
#### Type declaration
|
|
98
|
+
|
|
99
|
+
▸ (): [`TransactionComposer`](types_composer.TransactionComposer.md)
|
|
100
|
+
|
|
101
|
+
##### Returns
|
|
102
|
+
|
|
103
|
+
[`TransactionComposer`](types_composer.TransactionComposer.md)
|
|
104
|
+
|
|
105
|
+
#### Defined in
|
|
106
|
+
|
|
107
|
+
[src/types/algorand-client-transaction-sender.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L39)
|
|
108
|
+
|
|
109
|
+
___
|
|
110
|
+
|
|
111
|
+
### appCall
|
|
112
|
+
|
|
113
|
+
• **appCall**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
114
|
+
|
|
115
|
+
Call a smart contract.
|
|
116
|
+
|
|
117
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
118
|
+
|
|
119
|
+
**`Example`**
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
await algorand.send.appCall({ sender: 'CREATORADDRESS' })
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
**`Example`**
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
await algorand.send.appCall({
|
|
129
|
+
sender: 'CREATORADDRESS',
|
|
130
|
+
onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
131
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
132
|
+
accountReferences: ["ACCOUNT_1"]
|
|
133
|
+
appReferences: [123n, 1234n]
|
|
134
|
+
assetReferences: [12345n]
|
|
135
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
136
|
+
lease: 'lease',
|
|
137
|
+
note: 'note',
|
|
138
|
+
// You wouldn't normally set this field
|
|
139
|
+
firstValidRound: 1000n,
|
|
140
|
+
validityWindow: 10,
|
|
141
|
+
extraFee: (1000).microAlgo(),
|
|
142
|
+
staticFee: (1000).microAlgo(),
|
|
143
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
144
|
+
// already specified, but here for completeness
|
|
145
|
+
maxFee: (3000).microAlgo(),
|
|
146
|
+
// Signer only needed if you want to provide one,
|
|
147
|
+
// generally you'd register it with AlgorandClient
|
|
148
|
+
// against the sender and not need to pass it in
|
|
149
|
+
signer: transactionSigner,
|
|
150
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
151
|
+
suppressLog: true,
|
|
152
|
+
})
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
#### Type declaration
|
|
156
|
+
|
|
157
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
158
|
+
|
|
159
|
+
##### Parameters
|
|
160
|
+
|
|
161
|
+
| Name | Type | Description |
|
|
162
|
+
| :------ | :------ | :------ |
|
|
163
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app call transaction |
|
|
164
|
+
|
|
165
|
+
##### Returns
|
|
166
|
+
|
|
167
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
168
|
+
|
|
169
|
+
#### Defined in
|
|
170
|
+
|
|
171
|
+
[src/types/algorand-client-transaction-sender.ts:718](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L718)
|
|
172
|
+
|
|
173
|
+
___
|
|
174
|
+
|
|
175
|
+
### appCallMethodCall
|
|
176
|
+
|
|
177
|
+
• **appCallMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
178
|
+
|
|
179
|
+
Call a smart contract via an ABI method.
|
|
180
|
+
|
|
181
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
182
|
+
|
|
183
|
+
**`Example`**
|
|
184
|
+
|
|
185
|
+
```typescript
|
|
186
|
+
const method = new ABIMethod({
|
|
187
|
+
name: 'method',
|
|
188
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
189
|
+
returns: { type: 'string' },
|
|
190
|
+
})
|
|
191
|
+
await algorand.send.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
**`Example`**
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
const method = new ABIMethod({
|
|
198
|
+
name: 'method',
|
|
199
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
200
|
+
returns: { type: 'string' },
|
|
201
|
+
})
|
|
202
|
+
await algorand.send.appCallMethodCall({
|
|
203
|
+
sender: 'CREATORADDRESS',
|
|
204
|
+
method: method,
|
|
205
|
+
args: ["arg1_value"],
|
|
206
|
+
onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
207
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
208
|
+
accountReferences: ["ACCOUNT_1"]
|
|
209
|
+
appReferences: [123n, 1234n]
|
|
210
|
+
assetReferences: [12345n]
|
|
211
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
212
|
+
lease: 'lease',
|
|
213
|
+
note: 'note',
|
|
214
|
+
// You wouldn't normally set this field
|
|
215
|
+
firstValidRound: 1000n,
|
|
216
|
+
validityWindow: 10,
|
|
217
|
+
extraFee: (1000).microAlgo(),
|
|
218
|
+
staticFee: (1000).microAlgo(),
|
|
219
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
220
|
+
// already specified, but here for completeness
|
|
221
|
+
maxFee: (3000).microAlgo(),
|
|
222
|
+
// Signer only needed if you want to provide one,
|
|
223
|
+
// generally you'd register it with AlgorandClient
|
|
224
|
+
// against the sender and not need to pass it in
|
|
225
|
+
signer: transactionSigner,
|
|
226
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
227
|
+
suppressLog: true,
|
|
228
|
+
})
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
#### Type declaration
|
|
232
|
+
|
|
233
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
234
|
+
|
|
235
|
+
##### Parameters
|
|
236
|
+
|
|
237
|
+
| Name | Type | Description |
|
|
238
|
+
| :------ | :------ | :------ |
|
|
239
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app call transaction |
|
|
240
|
+
|
|
241
|
+
##### Returns
|
|
242
|
+
|
|
243
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
244
|
+
|
|
245
|
+
#### Defined in
|
|
246
|
+
|
|
247
|
+
[src/types/algorand-client-transaction-sender.ts:954](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L954)
|
|
248
|
+
|
|
249
|
+
___
|
|
250
|
+
|
|
251
|
+
### appCreate
|
|
252
|
+
|
|
253
|
+
• **appCreate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
254
|
+
|
|
255
|
+
Create a smart contract.
|
|
256
|
+
|
|
257
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
258
|
+
|
|
259
|
+
**`Example`**
|
|
260
|
+
|
|
261
|
+
```typescript
|
|
262
|
+
const result = await algorand.send.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
|
|
263
|
+
const createdAppId = result.appId
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**`Example`**
|
|
267
|
+
|
|
268
|
+
```typescript
|
|
269
|
+
await algorand.send.appCreate({
|
|
270
|
+
sender: 'CREATORADDRESS',
|
|
271
|
+
approvalProgram: "TEALCODE",
|
|
272
|
+
clearStateProgram: "TEALCODE",
|
|
273
|
+
schema: {
|
|
274
|
+
globalInts: 1,
|
|
275
|
+
globalByteSlices: 2,
|
|
276
|
+
localInts: 3,
|
|
277
|
+
localByteSlices: 4
|
|
278
|
+
},
|
|
279
|
+
extraProgramPages: 1,
|
|
280
|
+
onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
281
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
282
|
+
accountReferences: ["ACCOUNT_1"]
|
|
283
|
+
appReferences: [123n, 1234n]
|
|
284
|
+
assetReferences: [12345n]
|
|
285
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
286
|
+
lease: 'lease',
|
|
287
|
+
note: 'note',
|
|
288
|
+
// You wouldn't normally set this field
|
|
289
|
+
firstValidRound: 1000n,
|
|
290
|
+
validityWindow: 10,
|
|
291
|
+
extraFee: (1000).microAlgo(),
|
|
292
|
+
staticFee: (1000).microAlgo(),
|
|
293
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
294
|
+
// already specified, but here for completeness
|
|
295
|
+
maxFee: (3000).microAlgo(),
|
|
296
|
+
// Signer only needed if you want to provide one,
|
|
297
|
+
// generally you'd register it with AlgorandClient
|
|
298
|
+
// against the sender and not need to pass it in
|
|
299
|
+
signer: transactionSigner,
|
|
300
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
301
|
+
suppressLog: true,
|
|
302
|
+
})
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
#### Type declaration
|
|
306
|
+
|
|
307
|
+
▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
308
|
+
|
|
309
|
+
##### Parameters
|
|
310
|
+
|
|
311
|
+
| Name | Type | Description |
|
|
312
|
+
| :------ | :------ | :------ |
|
|
313
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app creation transaction |
|
|
314
|
+
|
|
315
|
+
##### Returns
|
|
316
|
+
|
|
317
|
+
`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
318
|
+
|
|
319
|
+
#### Defined in
|
|
320
|
+
|
|
321
|
+
[src/types/algorand-client-transaction-sender.ts:584](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L584)
|
|
322
|
+
|
|
323
|
+
___
|
|
324
|
+
|
|
325
|
+
### appCreateMethodCall
|
|
326
|
+
|
|
327
|
+
• **appCreateMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
328
|
+
|
|
329
|
+
Create a smart contract via an ABI method.
|
|
330
|
+
|
|
331
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
332
|
+
|
|
333
|
+
**`Example`**
|
|
334
|
+
|
|
335
|
+
```typescript
|
|
336
|
+
const method = new ABIMethod({
|
|
337
|
+
name: 'method',
|
|
338
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
339
|
+
returns: { type: 'string' },
|
|
340
|
+
})
|
|
341
|
+
const result = await algorand.send.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
|
|
342
|
+
const createdAppId = result.appId
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
**`Example`**
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
const method = new ABIMethod({
|
|
349
|
+
name: 'method',
|
|
350
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
351
|
+
returns: { type: 'string' },
|
|
352
|
+
})
|
|
353
|
+
await algorand.send.appCreate({
|
|
354
|
+
sender: 'CREATORADDRESS',
|
|
355
|
+
method: method,
|
|
356
|
+
args: ["arg1_value"],
|
|
357
|
+
approvalProgram: "TEALCODE",
|
|
358
|
+
clearStateProgram: "TEALCODE",
|
|
359
|
+
schema: {
|
|
360
|
+
globalInts: 1,
|
|
361
|
+
globalByteSlices: 2,
|
|
362
|
+
localInts: 3,
|
|
363
|
+
localByteSlices: 4
|
|
364
|
+
},
|
|
365
|
+
extraProgramPages: 1,
|
|
366
|
+
onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
367
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
368
|
+
accountReferences: ["ACCOUNT_1"]
|
|
369
|
+
appReferences: [123n, 1234n]
|
|
370
|
+
assetReferences: [12345n]
|
|
371
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
372
|
+
lease: 'lease',
|
|
373
|
+
note: 'note',
|
|
374
|
+
// You wouldn't normally set this field
|
|
375
|
+
firstValidRound: 1000n,
|
|
376
|
+
validityWindow: 10,
|
|
377
|
+
extraFee: (1000).microAlgo(),
|
|
378
|
+
staticFee: (1000).microAlgo(),
|
|
379
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
380
|
+
// already specified, but here for completeness
|
|
381
|
+
maxFee: (3000).microAlgo(),
|
|
382
|
+
// Signer only needed if you want to provide one,
|
|
383
|
+
// generally you'd register it with AlgorandClient
|
|
384
|
+
// against the sender and not need to pass it in
|
|
385
|
+
signer: transactionSigner,
|
|
386
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
387
|
+
suppressLog: true,
|
|
388
|
+
})
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
#### Type declaration
|
|
392
|
+
|
|
393
|
+
▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
394
|
+
|
|
395
|
+
##### Parameters
|
|
396
|
+
|
|
397
|
+
| Name | Type | Description |
|
|
398
|
+
| :------ | :------ | :------ |
|
|
399
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app creation transaction |
|
|
400
|
+
|
|
401
|
+
##### Returns
|
|
402
|
+
|
|
403
|
+
`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
404
|
+
|
|
405
|
+
#### Defined in
|
|
406
|
+
|
|
407
|
+
[src/types/algorand-client-transaction-sender.ts:784](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L784)
|
|
408
|
+
|
|
409
|
+
___
|
|
410
|
+
|
|
411
|
+
### appDelete
|
|
412
|
+
|
|
413
|
+
• **appDelete**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
414
|
+
|
|
415
|
+
Delete a smart contract.
|
|
416
|
+
|
|
417
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
418
|
+
|
|
419
|
+
**`Example`**
|
|
420
|
+
|
|
421
|
+
```typescript
|
|
422
|
+
await algorand.send.appDelete({ sender: 'CREATORADDRESS' })
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
**`Example`**
|
|
426
|
+
|
|
427
|
+
```typescript
|
|
428
|
+
await algorand.send.appDelete({
|
|
429
|
+
sender: 'CREATORADDRESS',
|
|
430
|
+
onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
|
|
431
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
432
|
+
accountReferences: ["ACCOUNT_1"]
|
|
433
|
+
appReferences: [123n, 1234n]
|
|
434
|
+
assetReferences: [12345n]
|
|
435
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
436
|
+
lease: 'lease',
|
|
437
|
+
note: 'note',
|
|
438
|
+
// You wouldn't normally set this field
|
|
439
|
+
firstValidRound: 1000n,
|
|
440
|
+
validityWindow: 10,
|
|
441
|
+
extraFee: (1000).microAlgo(),
|
|
442
|
+
staticFee: (1000).microAlgo(),
|
|
443
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
444
|
+
// already specified, but here for completeness
|
|
445
|
+
maxFee: (3000).microAlgo(),
|
|
446
|
+
// Signer only needed if you want to provide one,
|
|
447
|
+
// generally you'd register it with AlgorandClient
|
|
448
|
+
// against the sender and not need to pass it in
|
|
449
|
+
signer: transactionSigner,
|
|
450
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
451
|
+
suppressLog: true,
|
|
452
|
+
})
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
#### Type declaration
|
|
456
|
+
|
|
457
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
458
|
+
|
|
459
|
+
##### Parameters
|
|
460
|
+
|
|
461
|
+
| Name | Type | Description |
|
|
462
|
+
| :------ | :------ | :------ |
|
|
463
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app deletion transaction |
|
|
464
|
+
|
|
465
|
+
##### Returns
|
|
466
|
+
|
|
467
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
468
|
+
|
|
469
|
+
#### Defined in
|
|
470
|
+
|
|
471
|
+
[src/types/algorand-client-transaction-sender.ts:674](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L674)
|
|
472
|
+
|
|
473
|
+
___
|
|
474
|
+
|
|
475
|
+
### appDeleteMethodCall
|
|
476
|
+
|
|
477
|
+
• **appDeleteMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
478
|
+
|
|
479
|
+
Delete a smart contract via an ABI method.
|
|
480
|
+
|
|
481
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
482
|
+
|
|
483
|
+
**`Example`**
|
|
484
|
+
|
|
485
|
+
```typescript
|
|
486
|
+
const method = new ABIMethod({
|
|
487
|
+
name: 'method',
|
|
488
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
489
|
+
returns: { type: 'string' },
|
|
490
|
+
})
|
|
491
|
+
await algorand.send.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
**`Example`**
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
const method = new ABIMethod({
|
|
498
|
+
name: 'method',
|
|
499
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
500
|
+
returns: { type: 'string' },
|
|
501
|
+
})
|
|
502
|
+
await algorand.send.appDeleteMethodCall({
|
|
503
|
+
sender: 'CREATORADDRESS',
|
|
504
|
+
method: method,
|
|
505
|
+
args: ["arg1_value"],
|
|
506
|
+
onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
|
|
507
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
508
|
+
accountReferences: ["ACCOUNT_1"]
|
|
509
|
+
appReferences: [123n, 1234n]
|
|
510
|
+
assetReferences: [12345n]
|
|
511
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
512
|
+
lease: 'lease',
|
|
513
|
+
note: 'note',
|
|
514
|
+
// You wouldn't normally set this field
|
|
515
|
+
firstValidRound: 1000n,
|
|
516
|
+
validityWindow: 10,
|
|
517
|
+
extraFee: (1000).microAlgo(),
|
|
518
|
+
staticFee: (1000).microAlgo(),
|
|
519
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
520
|
+
// already specified, but here for completeness
|
|
521
|
+
maxFee: (3000).microAlgo(),
|
|
522
|
+
// Signer only needed if you want to provide one,
|
|
523
|
+
// generally you'd register it with AlgorandClient
|
|
524
|
+
// against the sender and not need to pass it in
|
|
525
|
+
signer: transactionSigner,
|
|
526
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
527
|
+
suppressLog: true,
|
|
528
|
+
})
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
#### Type declaration
|
|
532
|
+
|
|
533
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
534
|
+
|
|
535
|
+
##### Parameters
|
|
536
|
+
|
|
537
|
+
| Name | Type | Description |
|
|
538
|
+
| :------ | :------ | :------ |
|
|
539
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app deletion transaction |
|
|
540
|
+
|
|
541
|
+
##### Returns
|
|
542
|
+
|
|
543
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
544
|
+
|
|
545
|
+
#### Defined in
|
|
546
|
+
|
|
547
|
+
[src/types/algorand-client-transaction-sender.ts:898](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L898)
|
|
548
|
+
|
|
549
|
+
___
|
|
550
|
+
|
|
551
|
+
### appUpdate
|
|
552
|
+
|
|
553
|
+
• **appUpdate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
554
|
+
|
|
555
|
+
Update a smart contract.
|
|
556
|
+
|
|
557
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
558
|
+
|
|
559
|
+
**`Example`**
|
|
560
|
+
|
|
561
|
+
```typescript
|
|
562
|
+
await algorand.send.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
**`Example`**
|
|
566
|
+
|
|
567
|
+
```typescript
|
|
568
|
+
await algorand.send.appUpdate({
|
|
569
|
+
sender: 'CREATORADDRESS',
|
|
570
|
+
approvalProgram: "TEALCODE",
|
|
571
|
+
clearStateProgram: "TEALCODE",
|
|
572
|
+
onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
|
|
573
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
574
|
+
accountReferences: ["ACCOUNT_1"]
|
|
575
|
+
appReferences: [123n, 1234n]
|
|
576
|
+
assetReferences: [12345n]
|
|
577
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
578
|
+
lease: 'lease',
|
|
579
|
+
note: 'note',
|
|
580
|
+
// You wouldn't normally set this field
|
|
581
|
+
firstValidRound: 1000n,
|
|
582
|
+
validityWindow: 10,
|
|
583
|
+
extraFee: (1000).microAlgo(),
|
|
584
|
+
staticFee: (1000).microAlgo(),
|
|
585
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
586
|
+
// already specified, but here for completeness
|
|
587
|
+
maxFee: (3000).microAlgo(),
|
|
588
|
+
// Signer only needed if you want to provide one,
|
|
589
|
+
// generally you'd register it with AlgorandClient
|
|
590
|
+
// against the sender and not need to pass it in
|
|
591
|
+
signer: transactionSigner,
|
|
592
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
593
|
+
suppressLog: true,
|
|
594
|
+
})
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
#### Type declaration
|
|
598
|
+
|
|
599
|
+
▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
600
|
+
|
|
601
|
+
##### Parameters
|
|
602
|
+
|
|
603
|
+
| Name | Type | Description |
|
|
604
|
+
| :------ | :------ | :------ |
|
|
605
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app update transaction |
|
|
606
|
+
|
|
607
|
+
##### Returns
|
|
608
|
+
|
|
609
|
+
`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
610
|
+
|
|
611
|
+
#### Defined in
|
|
612
|
+
|
|
613
|
+
[src/types/algorand-client-transaction-sender.ts:630](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L630)
|
|
614
|
+
|
|
615
|
+
___
|
|
616
|
+
|
|
617
|
+
### appUpdateMethodCall
|
|
618
|
+
|
|
619
|
+
• **appUpdateMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
620
|
+
|
|
621
|
+
Update a smart contract via an ABI method.
|
|
622
|
+
|
|
623
|
+
Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
624
|
+
|
|
625
|
+
**`Example`**
|
|
626
|
+
|
|
627
|
+
```typescript
|
|
628
|
+
const method = new ABIMethod({
|
|
629
|
+
name: 'method',
|
|
630
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
631
|
+
returns: { type: 'string' },
|
|
632
|
+
})
|
|
633
|
+
await algorand.send.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
**`Example`**
|
|
637
|
+
|
|
638
|
+
```typescript
|
|
639
|
+
const method = new ABIMethod({
|
|
640
|
+
name: 'method',
|
|
641
|
+
args: [{ name: 'arg1', type: 'string' }],
|
|
642
|
+
returns: { type: 'string' },
|
|
643
|
+
})
|
|
644
|
+
await algorand.send.appUpdateMethodCall({
|
|
645
|
+
sender: 'CREATORADDRESS',
|
|
646
|
+
method: method,
|
|
647
|
+
args: ["arg1_value"],
|
|
648
|
+
approvalProgram: "TEALCODE",
|
|
649
|
+
clearStateProgram: "TEALCODE",
|
|
650
|
+
onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
|
|
651
|
+
args: [new Uint8Array(1, 2, 3, 4)]
|
|
652
|
+
accountReferences: ["ACCOUNT_1"]
|
|
653
|
+
appReferences: [123n, 1234n]
|
|
654
|
+
assetReferences: [12345n]
|
|
655
|
+
boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
656
|
+
lease: 'lease',
|
|
657
|
+
note: 'note',
|
|
658
|
+
// You wouldn't normally set this field
|
|
659
|
+
firstValidRound: 1000n,
|
|
660
|
+
validityWindow: 10,
|
|
661
|
+
extraFee: (1000).microAlgo(),
|
|
662
|
+
staticFee: (1000).microAlgo(),
|
|
663
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
664
|
+
// already specified, but here for completeness
|
|
665
|
+
maxFee: (3000).microAlgo(),
|
|
666
|
+
// Signer only needed if you want to provide one,
|
|
667
|
+
// generally you'd register it with AlgorandClient
|
|
668
|
+
// against the sender and not need to pass it in
|
|
669
|
+
signer: transactionSigner,
|
|
670
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
671
|
+
suppressLog: true,
|
|
672
|
+
})
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
#### Type declaration
|
|
676
|
+
|
|
677
|
+
▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
678
|
+
|
|
679
|
+
##### Parameters
|
|
680
|
+
|
|
681
|
+
| Name | Type | Description |
|
|
682
|
+
| :------ | :------ | :------ |
|
|
683
|
+
| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app update transaction |
|
|
684
|
+
|
|
685
|
+
##### Returns
|
|
686
|
+
|
|
687
|
+
`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
688
|
+
|
|
689
|
+
#### Defined in
|
|
690
|
+
|
|
691
|
+
[src/types/algorand-client-transaction-sender.ts:842](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L842)
|
|
692
|
+
|
|
693
|
+
___
|
|
694
|
+
|
|
695
|
+
### assetConfig
|
|
696
|
+
|
|
697
|
+
• **assetConfig**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `clawback?`: `string` \| `Address` ; `freeze?`: `string` \| `Address` ; `manager`: `undefined` \| `string` \| `Address` ; `reserve?`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
698
|
+
|
|
699
|
+
Configure an existing Algorand Standard Asset.
|
|
700
|
+
|
|
701
|
+
**Note:** The manager, reserve, freeze, and clawback addresses
|
|
702
|
+
are immutably empty if they are not set. If manager is not set then
|
|
703
|
+
all fields are immutable from that point forward.
|
|
704
|
+
|
|
705
|
+
**`Example`**
|
|
706
|
+
|
|
707
|
+
```typescript
|
|
708
|
+
await algorand.send.assetConfig({sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" })
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
**`Example`**
|
|
712
|
+
|
|
713
|
+
```typescript
|
|
714
|
+
await algorand.send.assetConfig({
|
|
715
|
+
sender: 'MANAGERADDRESS',
|
|
716
|
+
assetId: 123456n,
|
|
717
|
+
manager: 'MANAGERADDRESS',
|
|
718
|
+
reserve: 'RESERVEADDRESS',
|
|
719
|
+
freeze: 'FREEZEADDRESS',
|
|
720
|
+
clawback: 'CLAWBACKADDRESS',
|
|
721
|
+
lease: 'lease',
|
|
722
|
+
note: 'note',
|
|
723
|
+
// You wouldn't normally set this field
|
|
724
|
+
firstValidRound: 1000n,
|
|
725
|
+
validityWindow: 10,
|
|
726
|
+
extraFee: (1000).microAlgo(),
|
|
727
|
+
staticFee: (1000).microAlgo(),
|
|
728
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
729
|
+
// already specified, but here for completeness
|
|
730
|
+
maxFee: (3000).microAlgo(),
|
|
731
|
+
// Signer only needed if you want to provide one,
|
|
732
|
+
// generally you'd register it with AlgorandClient
|
|
733
|
+
// against the sender and not need to pass it in
|
|
734
|
+
signer: transactionSigner,
|
|
735
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
736
|
+
suppressLog: true,
|
|
737
|
+
})
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
#### Type declaration
|
|
741
|
+
|
|
742
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
743
|
+
|
|
744
|
+
##### Parameters
|
|
745
|
+
|
|
746
|
+
| Name | Type | Description |
|
|
747
|
+
| :------ | :------ | :------ |
|
|
748
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `clawback?`: `string` \| `Address` ; `freeze?`: `string` \| `Address` ; `manager`: `undefined` \| `string` \| `Address` ; `reserve?`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset config transaction |
|
|
749
|
+
|
|
750
|
+
##### Returns
|
|
751
|
+
|
|
752
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
753
|
+
|
|
754
|
+
#### Defined in
|
|
755
|
+
|
|
756
|
+
[src/types/algorand-client-transaction-sender.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L295)
|
|
757
|
+
|
|
758
|
+
___
|
|
759
|
+
|
|
760
|
+
### assetDestroy
|
|
761
|
+
|
|
762
|
+
• **assetDestroy**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
763
|
+
|
|
764
|
+
Destroys an Algorand Standard Asset.
|
|
765
|
+
|
|
766
|
+
Created assets can be destroyed only by the asset manager account.
|
|
767
|
+
All of the assets must be owned by the creator of the asset before
|
|
768
|
+
the asset can be deleted.
|
|
769
|
+
|
|
770
|
+
**`Example`**
|
|
771
|
+
|
|
772
|
+
```typescript
|
|
773
|
+
await algorand.send.assetDestroy({sender: "MANAGERADDRESS", assetId: 123456n })
|
|
774
|
+
```
|
|
775
|
+
|
|
776
|
+
**`Example`**
|
|
777
|
+
|
|
778
|
+
```typescript
|
|
779
|
+
await algorand.send.assetDestroy({
|
|
780
|
+
sender: 'MANAGERADDRESS',
|
|
781
|
+
assetId: 123456n,
|
|
782
|
+
lease: 'lease',
|
|
783
|
+
note: 'note',
|
|
784
|
+
// You wouldn't normally set this field
|
|
785
|
+
firstValidRound: 1000n,
|
|
786
|
+
validityWindow: 10,
|
|
787
|
+
extraFee: (1000).microAlgo(),
|
|
788
|
+
staticFee: (1000).microAlgo(),
|
|
789
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
790
|
+
// already specified, but here for completeness
|
|
791
|
+
maxFee: (3000).microAlgo(),
|
|
792
|
+
// Signer only needed if you want to provide one,
|
|
793
|
+
// generally you'd register it with AlgorandClient
|
|
794
|
+
// against the sender and not need to pass it in
|
|
795
|
+
signer: transactionSigner,
|
|
796
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
797
|
+
suppressLog: true,
|
|
798
|
+
})
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
#### Type declaration
|
|
802
|
+
|
|
803
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
804
|
+
|
|
805
|
+
##### Parameters
|
|
806
|
+
|
|
807
|
+
| Name | Type | Description |
|
|
808
|
+
| :------ | :------ | :------ |
|
|
809
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset destroy transaction |
|
|
810
|
+
|
|
811
|
+
##### Returns
|
|
812
|
+
|
|
813
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
814
|
+
|
|
815
|
+
#### Defined in
|
|
816
|
+
|
|
817
|
+
[src/types/algorand-client-transaction-sender.ts:375](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L375)
|
|
818
|
+
|
|
819
|
+
___
|
|
820
|
+
|
|
821
|
+
### assetFreeze
|
|
822
|
+
|
|
823
|
+
• **assetFreeze**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `account`: `string` \| `Address` ; `assetId`: `bigint` ; `frozen`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
824
|
+
|
|
825
|
+
Freeze or unfreeze an Algorand Standard Asset for an account.
|
|
826
|
+
|
|
827
|
+
**`Example`**
|
|
828
|
+
|
|
829
|
+
```typescript
|
|
830
|
+
await algorand.send.assetFreeze({sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true })
|
|
831
|
+
```
|
|
832
|
+
|
|
833
|
+
**`Example`**
|
|
834
|
+
|
|
835
|
+
```typescript
|
|
836
|
+
await algorand.send.assetFreeze({
|
|
837
|
+
sender: 'MANAGERADDRESS',
|
|
838
|
+
assetId: 123456n,
|
|
839
|
+
account: 'ACCOUNTADDRESS',
|
|
840
|
+
frozen: true,
|
|
841
|
+
lease: 'lease',
|
|
842
|
+
note: 'note',
|
|
843
|
+
// You wouldn't normally set this field
|
|
844
|
+
firstValidRound: 1000n,
|
|
845
|
+
validityWindow: 10,
|
|
846
|
+
extraFee: (1000).microAlgo(),
|
|
847
|
+
staticFee: (1000).microAlgo(),
|
|
848
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
849
|
+
// already specified, but here for completeness
|
|
850
|
+
maxFee: (3000).microAlgo(),
|
|
851
|
+
// Signer only needed if you want to provide one,
|
|
852
|
+
// generally you'd register it with AlgorandClient
|
|
853
|
+
// against the sender and not need to pass it in
|
|
854
|
+
signer: transactionSigner,
|
|
855
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
856
|
+
suppressLog: true,
|
|
857
|
+
})
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
#### Type declaration
|
|
861
|
+
|
|
862
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
863
|
+
|
|
864
|
+
##### Parameters
|
|
865
|
+
|
|
866
|
+
| Name | Type | Description |
|
|
867
|
+
| :------ | :------ | :------ |
|
|
868
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `account`: `string` \| `Address` ; `assetId`: `bigint` ; `frozen`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset freeze transaction |
|
|
869
|
+
|
|
870
|
+
##### Returns
|
|
871
|
+
|
|
872
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
873
|
+
|
|
874
|
+
#### Defined in
|
|
875
|
+
|
|
876
|
+
[src/types/algorand-client-transaction-sender.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L334)
|
|
877
|
+
|
|
878
|
+
___
|
|
879
|
+
|
|
880
|
+
### assetOptIn
|
|
881
|
+
|
|
882
|
+
• **assetOptIn**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
883
|
+
|
|
884
|
+
Opt an account into an Algorand Standard Asset.
|
|
885
|
+
|
|
886
|
+
**`Example`**
|
|
887
|
+
|
|
888
|
+
```typescript
|
|
889
|
+
await algorand.send.assetOptIn({sender: "SENDERADDRESS", assetId: 123456n })
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
**`Example`**
|
|
893
|
+
|
|
894
|
+
```typescript
|
|
895
|
+
await algorand.send.assetOptIn({
|
|
896
|
+
sender: 'SENDERADDRESS',
|
|
897
|
+
assetId: 123456n,
|
|
898
|
+
lease: 'lease',
|
|
899
|
+
note: 'note',
|
|
900
|
+
// You wouldn't normally set this field
|
|
901
|
+
firstValidRound: 1000n,
|
|
902
|
+
validityWindow: 10,
|
|
903
|
+
extraFee: (1000).microAlgo(),
|
|
904
|
+
staticFee: (1000).microAlgo(),
|
|
905
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
906
|
+
// already specified, but here for completeness
|
|
907
|
+
maxFee: (3000).microAlgo(),
|
|
908
|
+
// Signer only needed if you want to provide one,
|
|
909
|
+
// generally you'd register it with AlgorandClient
|
|
910
|
+
// against the sender and not need to pass it in
|
|
911
|
+
signer: transactionSigner,
|
|
912
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
913
|
+
suppressLog: true,
|
|
914
|
+
})
|
|
915
|
+
```
|
|
916
|
+
|
|
917
|
+
#### Type declaration
|
|
918
|
+
|
|
919
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
920
|
+
|
|
921
|
+
##### Parameters
|
|
922
|
+
|
|
923
|
+
| Name | Type | Description |
|
|
924
|
+
| :------ | :------ | :------ |
|
|
925
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset opt-in transaction |
|
|
926
|
+
|
|
927
|
+
##### Returns
|
|
928
|
+
|
|
929
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
930
|
+
|
|
931
|
+
#### Defined in
|
|
932
|
+
|
|
933
|
+
[src/types/algorand-client-transaction-sender.ts:455](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L455)
|
|
934
|
+
|
|
935
|
+
___
|
|
936
|
+
|
|
937
|
+
### assetTransfer
|
|
938
|
+
|
|
939
|
+
• **assetTransfer**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: `bigint` ; `assetId`: `bigint` ; `clawbackTarget?`: `string` \| `Address` ; `closeAssetTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
940
|
+
|
|
941
|
+
Transfer an Algorand Standard Asset.
|
|
942
|
+
|
|
943
|
+
**`Example`**
|
|
944
|
+
|
|
945
|
+
```typescript
|
|
946
|
+
await algorand.send.assetTransfer({sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" })
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
**`Example`**
|
|
950
|
+
|
|
951
|
+
```typescript
|
|
952
|
+
await algorand.send.assetTransfer({
|
|
953
|
+
sender: 'CLAWBACKADDRESS',
|
|
954
|
+
assetId: 123456n,
|
|
955
|
+
amount: 1n,
|
|
956
|
+
receiver: 'RECEIVERADDRESS',
|
|
957
|
+
clawbackTarget: 'HOLDERADDRESS',
|
|
958
|
+
// This field needs to be used with caution
|
|
959
|
+
closeAssetTo: 'ADDRESSTOCLOSETO'
|
|
960
|
+
lease: 'lease',
|
|
961
|
+
note: 'note',
|
|
962
|
+
// You wouldn't normally set this field
|
|
963
|
+
firstValidRound: 1000n,
|
|
964
|
+
validityWindow: 10,
|
|
965
|
+
extraFee: (1000).microAlgo(),
|
|
966
|
+
staticFee: (1000).microAlgo(),
|
|
967
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
968
|
+
// already specified, but here for completeness
|
|
969
|
+
maxFee: (3000).microAlgo(),
|
|
970
|
+
// Signer only needed if you want to provide one,
|
|
971
|
+
// generally you'd register it with AlgorandClient
|
|
972
|
+
// against the sender and not need to pass it in
|
|
973
|
+
signer: transactionSigner,
|
|
974
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
975
|
+
suppressLog: true,
|
|
976
|
+
})
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
#### Type declaration
|
|
980
|
+
|
|
981
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
982
|
+
|
|
983
|
+
##### Parameters
|
|
984
|
+
|
|
985
|
+
| Name | Type | Description |
|
|
986
|
+
| :------ | :------ | :------ |
|
|
987
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: `bigint` ; `assetId`: `bigint` ; `clawbackTarget?`: `string` \| `Address` ; `closeAssetTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset transfer transaction |
|
|
988
|
+
|
|
989
|
+
##### Returns
|
|
990
|
+
|
|
991
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
992
|
+
|
|
993
|
+
#### Defined in
|
|
994
|
+
|
|
995
|
+
[src/types/algorand-client-transaction-sender.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L417)
|
|
996
|
+
|
|
997
|
+
___
|
|
998
|
+
|
|
999
|
+
### offlineKeyRegistration
|
|
1000
|
+
|
|
1001
|
+
• **offlineKeyRegistration**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `preventAccountFromEverParticipatingAgain?`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1002
|
+
|
|
1003
|
+
Register an offline key.
|
|
1004
|
+
|
|
1005
|
+
#### Type declaration
|
|
1006
|
+
|
|
1007
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1008
|
+
|
|
1009
|
+
##### Parameters
|
|
1010
|
+
|
|
1011
|
+
| Name | Type |
|
|
1012
|
+
| :------ | :------ |
|
|
1013
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `preventAccountFromEverParticipatingAgain?`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1014
|
+
|
|
1015
|
+
##### Returns
|
|
1016
|
+
|
|
1017
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1018
|
+
|
|
1019
|
+
#### Defined in
|
|
1020
|
+
|
|
1021
|
+
[src/types/algorand-client-transaction-sender.ts:965](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L965)
|
|
1022
|
+
|
|
1023
|
+
___
|
|
1024
|
+
|
|
1025
|
+
### onlineKeyRegistration
|
|
1026
|
+
|
|
1027
|
+
• **onlineKeyRegistration**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `selectionKey`: `Uint8Array` ; `stateProofKey?`: `Uint8Array` ; `voteFirst`: `bigint` ; `voteKey`: `Uint8Array` ; `voteKeyDilution`: `bigint` ; `voteLast`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1028
|
+
|
|
1029
|
+
Register an online key.
|
|
1030
|
+
|
|
1031
|
+
#### Type declaration
|
|
1032
|
+
|
|
1033
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1034
|
+
|
|
1035
|
+
##### Parameters
|
|
1036
|
+
|
|
1037
|
+
| Name | Type |
|
|
1038
|
+
| :------ | :------ |
|
|
1039
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `selectionKey`: `Uint8Array` ; `stateProofKey?`: `Uint8Array` ; `voteFirst`: `bigint` ; `voteKey`: `Uint8Array` ; `voteKeyDilution`: `bigint` ; `voteLast`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1040
|
+
|
|
1041
|
+
##### Returns
|
|
1042
|
+
|
|
1043
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1044
|
+
|
|
1045
|
+
#### Defined in
|
|
1046
|
+
|
|
1047
|
+
[src/types/algorand-client-transaction-sender.ts:960](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L960)
|
|
1048
|
+
|
|
1049
|
+
___
|
|
1050
|
+
|
|
1051
|
+
### payment
|
|
1052
|
+
|
|
1053
|
+
• **payment**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1054
|
+
|
|
1055
|
+
Send a payment transaction to transfer Algo between accounts.
|
|
1056
|
+
|
|
1057
|
+
**`Example`**
|
|
1058
|
+
|
|
1059
|
+
```typescript
|
|
1060
|
+
const result = await algorand.send.payment({
|
|
1061
|
+
sender: 'SENDERADDRESS',
|
|
1062
|
+
receiver: 'RECEIVERADDRESS',
|
|
1063
|
+
amount: (4).algo(),
|
|
1064
|
+
})
|
|
1065
|
+
```
|
|
1066
|
+
|
|
1067
|
+
**`Example`**
|
|
1068
|
+
|
|
1069
|
+
```typescript
|
|
1070
|
+
const result = await algorand.send.payment({
|
|
1071
|
+
amount: (4).algo(),
|
|
1072
|
+
receiver: 'RECEIVERADDRESS',
|
|
1073
|
+
sender: 'SENDERADDRESS',
|
|
1074
|
+
closeRemainderTo: 'CLOSEREMAINDERTOADDRESS',
|
|
1075
|
+
lease: 'lease',
|
|
1076
|
+
note: 'note',
|
|
1077
|
+
// Use this with caution, it's generally better to use algorand.account.rekeyAccount
|
|
1078
|
+
rekeyTo: 'REKEYTOADDRESS',
|
|
1079
|
+
// You wouldn't normally set this field
|
|
1080
|
+
firstValidRound: 1000n,
|
|
1081
|
+
validityWindow: 10,
|
|
1082
|
+
extraFee: (1000).microAlgo(),
|
|
1083
|
+
staticFee: (1000).microAlgo(),
|
|
1084
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
1085
|
+
// already specified, but here for completeness
|
|
1086
|
+
maxFee: (3000).microAlgo(),
|
|
1087
|
+
// Signer only needed if you want to provide one,
|
|
1088
|
+
// generally you'd register it with AlgorandClient
|
|
1089
|
+
// against the sender and not need to pass it in
|
|
1090
|
+
signer: transactionSigner,
|
|
1091
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
1092
|
+
suppressLog: true,
|
|
1093
|
+
})
|
|
1094
|
+
```
|
|
1095
|
+
|
|
1096
|
+
#### Type declaration
|
|
1097
|
+
|
|
1098
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1099
|
+
|
|
1100
|
+
##### Parameters
|
|
1101
|
+
|
|
1102
|
+
| Name | Type | Description |
|
|
1103
|
+
| :------ | :------ | :------ |
|
|
1104
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the payment transaction |
|
|
1105
|
+
|
|
1106
|
+
##### Returns
|
|
1107
|
+
|
|
1108
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1109
|
+
|
|
1110
|
+
#### Defined in
|
|
1111
|
+
|
|
1112
|
+
[src/types/algorand-client-transaction-sender.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L195)
|
|
1113
|
+
|
|
1114
|
+
## Methods
|
|
1115
|
+
|
|
1116
|
+
### \_send
|
|
1117
|
+
|
|
1118
|
+
▸ **_send**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1119
|
+
|
|
1120
|
+
#### Type parameters
|
|
1121
|
+
|
|
1122
|
+
| Name |
|
|
1123
|
+
| :------ |
|
|
1124
|
+
| `T` |
|
|
1125
|
+
|
|
1126
|
+
#### Parameters
|
|
1127
|
+
|
|
1128
|
+
| Name | Type |
|
|
1129
|
+
| :------ | :------ |
|
|
1130
|
+
| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) |
|
|
1131
|
+
| `log?` | `Object` |
|
|
1132
|
+
| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` |
|
|
1133
|
+
| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` |
|
|
1134
|
+
|
|
1135
|
+
#### Returns
|
|
1136
|
+
|
|
1137
|
+
`fn`
|
|
1138
|
+
|
|
1139
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1140
|
+
|
|
1141
|
+
##### Parameters
|
|
1142
|
+
|
|
1143
|
+
| Name | Type |
|
|
1144
|
+
| :------ | :------ |
|
|
1145
|
+
| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1146
|
+
|
|
1147
|
+
##### Returns
|
|
1148
|
+
|
|
1149
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1150
|
+
|
|
1151
|
+
#### Defined in
|
|
1152
|
+
|
|
1153
|
+
[src/types/algorand-client-transaction-sender.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L58)
|
|
1154
|
+
|
|
1155
|
+
___
|
|
1156
|
+
|
|
1157
|
+
### \_sendAppCall
|
|
1158
|
+
|
|
1159
|
+
▸ **_sendAppCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1160
|
+
|
|
1161
|
+
#### Type parameters
|
|
1162
|
+
|
|
1163
|
+
| Name | Type |
|
|
1164
|
+
| :------ | :------ |
|
|
1165
|
+
| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCallParams`](../modules/types_composer.md#appcallparams) \| [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) \| [`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall) \| [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall) |
|
|
1166
|
+
|
|
1167
|
+
#### Parameters
|
|
1168
|
+
|
|
1169
|
+
| Name | Type |
|
|
1170
|
+
| :------ | :------ |
|
|
1171
|
+
| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) |
|
|
1172
|
+
| `log?` | `Object` |
|
|
1173
|
+
| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` |
|
|
1174
|
+
| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` |
|
|
1175
|
+
|
|
1176
|
+
#### Returns
|
|
1177
|
+
|
|
1178
|
+
`fn`
|
|
1179
|
+
|
|
1180
|
+
▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1181
|
+
|
|
1182
|
+
##### Parameters
|
|
1183
|
+
|
|
1184
|
+
| Name | Type |
|
|
1185
|
+
| :------ | :------ |
|
|
1186
|
+
| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1187
|
+
|
|
1188
|
+
##### Returns
|
|
1189
|
+
|
|
1190
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1191
|
+
|
|
1192
|
+
#### Defined in
|
|
1193
|
+
|
|
1194
|
+
[src/types/algorand-client-transaction-sender.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L93)
|
|
1195
|
+
|
|
1196
|
+
___
|
|
1197
|
+
|
|
1198
|
+
### \_sendAppCreateCall
|
|
1199
|
+
|
|
1200
|
+
▸ **_sendAppCreateCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1201
|
+
|
|
1202
|
+
#### Type parameters
|
|
1203
|
+
|
|
1204
|
+
| Name | Type |
|
|
1205
|
+
| :------ | :------ |
|
|
1206
|
+
| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) |
|
|
1207
|
+
|
|
1208
|
+
#### Parameters
|
|
1209
|
+
|
|
1210
|
+
| Name | Type |
|
|
1211
|
+
| :------ | :------ |
|
|
1212
|
+
| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) |
|
|
1213
|
+
| `log?` | `Object` |
|
|
1214
|
+
| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` |
|
|
1215
|
+
| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` |
|
|
1216
|
+
|
|
1217
|
+
#### Returns
|
|
1218
|
+
|
|
1219
|
+
`fn`
|
|
1220
|
+
|
|
1221
|
+
▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1222
|
+
|
|
1223
|
+
##### Parameters
|
|
1224
|
+
|
|
1225
|
+
| Name | Type |
|
|
1226
|
+
| :------ | :------ |
|
|
1227
|
+
| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1228
|
+
|
|
1229
|
+
##### Returns
|
|
1230
|
+
|
|
1231
|
+
`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1232
|
+
|
|
1233
|
+
#### Defined in
|
|
1234
|
+
|
|
1235
|
+
[src/types/algorand-client-transaction-sender.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L136)
|
|
1236
|
+
|
|
1237
|
+
___
|
|
1238
|
+
|
|
1239
|
+
### \_sendAppUpdateCall
|
|
1240
|
+
|
|
1241
|
+
▸ **_sendAppUpdateCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1242
|
+
|
|
1243
|
+
#### Type parameters
|
|
1244
|
+
|
|
1245
|
+
| Name | Type |
|
|
1246
|
+
| :------ | :------ |
|
|
1247
|
+
| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) |
|
|
1248
|
+
|
|
1249
|
+
#### Parameters
|
|
1250
|
+
|
|
1251
|
+
| Name | Type |
|
|
1252
|
+
| :------ | :------ |
|
|
1253
|
+
| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) |
|
|
1254
|
+
| `log?` | `Object` |
|
|
1255
|
+
| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` |
|
|
1256
|
+
| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` |
|
|
1257
|
+
|
|
1258
|
+
#### Returns
|
|
1259
|
+
|
|
1260
|
+
`fn`
|
|
1261
|
+
|
|
1262
|
+
▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1263
|
+
|
|
1264
|
+
##### Parameters
|
|
1265
|
+
|
|
1266
|
+
| Name | Type |
|
|
1267
|
+
| :------ | :------ |
|
|
1268
|
+
| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) |
|
|
1269
|
+
|
|
1270
|
+
##### Returns
|
|
1271
|
+
|
|
1272
|
+
`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1273
|
+
|
|
1274
|
+
#### Defined in
|
|
1275
|
+
|
|
1276
|
+
[src/types/algorand-client-transaction-sender.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L117)
|
|
1277
|
+
|
|
1278
|
+
___
|
|
1279
|
+
|
|
1280
|
+
### assetCreate
|
|
1281
|
+
|
|
1282
|
+
▸ **assetCreate**(`params`): `Promise`\<\{ `assetId`: `bigint` ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1283
|
+
|
|
1284
|
+
Create a new Algorand Standard Asset.
|
|
1285
|
+
|
|
1286
|
+
The account that sends this transaction will automatically be
|
|
1287
|
+
opted in to the asset and will hold all units after creation.
|
|
1288
|
+
|
|
1289
|
+
#### Parameters
|
|
1290
|
+
|
|
1291
|
+
| Name | Type | Description |
|
|
1292
|
+
| :------ | :------ | :------ |
|
|
1293
|
+
| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetName?`: `string` ; `clawback?`: `string` \| `Address` ; `decimals?`: `number` ; `defaultFrozen?`: `boolean` ; `freeze?`: `string` \| `Address` ; `manager?`: `string` \| `Address` ; `metadataHash?`: `string` \| `Uint8Array` ; `reserve?`: `string` \| `Address` ; `total`: `bigint` ; `unitName?`: `string` ; `url?`: `string` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset creation transaction |
|
|
1294
|
+
|
|
1295
|
+
#### Returns
|
|
1296
|
+
|
|
1297
|
+
`Promise`\<\{ `assetId`: `bigint` ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1298
|
+
|
|
1299
|
+
The result of the transaction and the transaction that was sent
|
|
1300
|
+
|
|
1301
|
+
**`Example`**
|
|
1302
|
+
|
|
1303
|
+
```typescript
|
|
1304
|
+
await algorand.send.assetCreate({sender: "CREATORADDRESS", total: 100n})
|
|
1305
|
+
```
|
|
1306
|
+
|
|
1307
|
+
**`Example`**
|
|
1308
|
+
|
|
1309
|
+
```typescript
|
|
1310
|
+
await algorand.send.assetCreate({
|
|
1311
|
+
sender: 'CREATORADDRESS',
|
|
1312
|
+
total: 100n,
|
|
1313
|
+
decimals: 2,
|
|
1314
|
+
assetName: 'asset',
|
|
1315
|
+
unitName: 'unit',
|
|
1316
|
+
url: 'url',
|
|
1317
|
+
metadataHash: 'metadataHash',
|
|
1318
|
+
defaultFrozen: false,
|
|
1319
|
+
manager: 'MANAGERADDRESS',
|
|
1320
|
+
reserve: 'RESERVEADDRESS',
|
|
1321
|
+
freeze: 'FREEZEADDRESS',
|
|
1322
|
+
clawback: 'CLAWBACKADDRESS',
|
|
1323
|
+
lease: 'lease',
|
|
1324
|
+
note: 'note',
|
|
1325
|
+
// You wouldn't normally set this field
|
|
1326
|
+
firstValidRound: 1000n,
|
|
1327
|
+
validityWindow: 10,
|
|
1328
|
+
extraFee: (1000).microAlgo(),
|
|
1329
|
+
staticFee: (1000).microAlgo(),
|
|
1330
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
1331
|
+
// already specified, but here for completeness
|
|
1332
|
+
maxFee: (3000).microAlgo(),
|
|
1333
|
+
// Signer only needed if you want to provide one,
|
|
1334
|
+
// generally you'd register it with AlgorandClient
|
|
1335
|
+
// against the sender and not need to pass it in
|
|
1336
|
+
signer: transactionSigner,
|
|
1337
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
1338
|
+
suppressLog: true,
|
|
1339
|
+
})
|
|
1340
|
+
```
|
|
1341
|
+
|
|
1342
|
+
#### Defined in
|
|
1343
|
+
|
|
1344
|
+
[src/types/algorand-client-transaction-sender.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L246)
|
|
1345
|
+
|
|
1346
|
+
___
|
|
1347
|
+
|
|
1348
|
+
### assetOptOut
|
|
1349
|
+
|
|
1350
|
+
▸ **assetOptOut**(`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1351
|
+
|
|
1352
|
+
Opt an account out of an Algorand Standard Asset.
|
|
1353
|
+
|
|
1354
|
+
*Note:* If the account has a balance of the asset,
|
|
1355
|
+
it will not be able to opt-out unless `ensureZeroBalance`
|
|
1356
|
+
is set to `false` (but then the account will lose the assets).
|
|
1357
|
+
|
|
1358
|
+
#### Parameters
|
|
1359
|
+
|
|
1360
|
+
| Name | Type | Description |
|
|
1361
|
+
| :------ | :------ | :------ |
|
|
1362
|
+
| `params` | `Omit`\<[`AssetOptOutParams`](../modules/types_composer.md#assetoptoutparams), ``"creator"``\> & \{ `creator?`: `string` \| `Address` ; `ensureZeroBalance`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset opt-out transaction |
|
|
1363
|
+
|
|
1364
|
+
#### Returns
|
|
1365
|
+
|
|
1366
|
+
`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\>
|
|
1367
|
+
|
|
1368
|
+
The result of the transaction and the transaction that was sent
|
|
1369
|
+
|
|
1370
|
+
**`Example`**
|
|
1371
|
+
|
|
1372
|
+
```typescript
|
|
1373
|
+
await algorand.send.assetOptOut({sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
|
|
1374
|
+
```
|
|
1375
|
+
|
|
1376
|
+
**`Example`**
|
|
1377
|
+
|
|
1378
|
+
```typescript
|
|
1379
|
+
await algorand.send.assetOptOut({sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true })
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
**`Example`**
|
|
1383
|
+
|
|
1384
|
+
```typescript
|
|
1385
|
+
await algorand.send.assetOptOut({
|
|
1386
|
+
sender: 'SENDERADDRESS',
|
|
1387
|
+
assetId: 123456n,
|
|
1388
|
+
creator: 'CREATORADDRESS',
|
|
1389
|
+
ensureZeroBalance: true,
|
|
1390
|
+
lease: 'lease',
|
|
1391
|
+
note: 'note',
|
|
1392
|
+
// You wouldn't normally set this field
|
|
1393
|
+
firstValidRound: 1000n,
|
|
1394
|
+
validityWindow: 10,
|
|
1395
|
+
extraFee: (1000).microAlgo(),
|
|
1396
|
+
staticFee: (1000).microAlgo(),
|
|
1397
|
+
// Max fee doesn't make sense with extraFee AND staticFee
|
|
1398
|
+
// already specified, but here for completeness
|
|
1399
|
+
maxFee: (3000).microAlgo(),
|
|
1400
|
+
// Signer only needed if you want to provide one,
|
|
1401
|
+
// generally you'd register it with AlgorandClient
|
|
1402
|
+
// against the sender and not need to pass it in
|
|
1403
|
+
signer: transactionSigner,
|
|
1404
|
+
maxRoundsToWaitForConfirmation: 5,
|
|
1405
|
+
suppressLog: true,
|
|
1406
|
+
})
|
|
1407
|
+
```
|
|
1408
|
+
|
|
1409
|
+
#### Defined in
|
|
1410
|
+
|
|
1411
|
+
[src/types/algorand-client-transaction-sender.ts:502](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L502)
|
|
1412
|
+
|
|
1413
|
+
___
|
|
1414
|
+
|
|
1415
|
+
### newGroup
|
|
1416
|
+
|
|
1417
|
+
▸ **newGroup**(): [`TransactionComposer`](types_composer.TransactionComposer.md)
|
|
1418
|
+
|
|
1419
|
+
#### Returns
|
|
1420
|
+
|
|
1421
|
+
[`TransactionComposer`](types_composer.TransactionComposer.md)
|
|
1422
|
+
|
|
1423
|
+
#### Defined in
|
|
1424
|
+
|
|
1425
|
+
[src/types/algorand-client-transaction-sender.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L54)
|