This is page 12 of 93. Use http://codebase.md/goplausible/algorand-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── llms-install.md
├── llms.txt
├── package.json
├── packages
│ ├── client
│ │ ├── .env.example
│ │ ├── package.json
│ │ ├── README.md
│ │ ├── src
│ │ │ ├── env.ts
│ │ │ ├── index.ts
│ │ │ └── LocalWallet.ts
│ │ └── tsconfig.json
│ └── server
│ ├── .env.example
│ ├── API specs
│ │ ├── algod_api.json
│ │ ├── indexer_api.json
│ │ ├── mcp.json
│ │ ├── nfd_api.json
│ │ ├── ultrade_api.json
│ │ ├── vestige_api.json
│ │ └── vestige_free_api.json
│ ├── Dockerfile
│ ├── jest.config.js
│ ├── package.json
│ ├── README.md
│ ├── smithery.yaml
│ ├── src
│ │ ├── algorand-client.ts
│ │ ├── env.ts
│ │ ├── index.ts
│ │ ├── resources
│ │ │ ├── index.ts
│ │ │ ├── knowledge
│ │ │ │ ├── ARCs.txt
│ │ │ │ ├── developers-algokit-architecture-decisions.txt
│ │ │ │ ├── developers-algokit-cli.txt
│ │ │ │ ├── developers-algokit-utils-python.txt
│ │ │ │ ├── developers-algokit-utils-typescript.txt
│ │ │ │ ├── developers-clis.txt
│ │ │ │ ├── developers-details.txt
│ │ │ │ ├── developers-liquid-auth.txt
│ │ │ │ ├── developers-nodes.txt
│ │ │ │ ├── developers-puya.txt
│ │ │ │ ├── developers-python.txt
│ │ │ │ ├── developers-sdks-js.txt
│ │ │ │ ├── developers-sdks-python.txt
│ │ │ │ ├── developers-tealscript.txt
│ │ │ │ ├── developers.txt
│ │ │ │ ├── index.ts
│ │ │ │ ├── taxonomy
│ │ │ │ │ ├── algokit-cli:README.md
│ │ │ │ │ ├── algokit:cli:algokit.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_brew_install.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-13_native_binaries.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md
│ │ │ │ │ ├── algokit:cli:articles:output_stability.md
│ │ │ │ │ ├── algokit:cli:cli:index.md
│ │ │ │ │ ├── algokit:cli:features:compile.md
│ │ │ │ │ ├── algokit:cli:features:completions.md
│ │ │ │ │ ├── algokit:cli:features:config.md
│ │ │ │ │ ├── algokit:cli:features:dispenser.md
│ │ │ │ │ ├── algokit:cli:features:doctor.md
│ │ │ │ │ ├── algokit:cli:features:explore.md
│ │ │ │ │ ├── algokit:cli:features:generate.md
│ │ │ │ │ ├── algokit:cli:features:goal.md
│ │ │ │ │ ├── algokit:cli:features:init.md
│ │ │ │ │ ├── algokit:cli:features:localnet.md
│ │ │ │ │ ├── algokit:cli:features:project:bootstrap.md
│ │ │ │ │ ├── algokit:cli:features:project:deploy.md
│ │ │ │ │ ├── algokit:cli:features:project:link.md
│ │ │ │ │ ├── algokit:cli:features:project:list.md
│ │ │ │ │ ├── algokit:cli:features:project:run.md
│ │ │ │ │ ├── algokit:cli:features:project.md
│ │ │ │ │ ├── algokit:cli:features:tasks:analyze.md
│ │ │ │ │ ├── algokit:cli:features:tasks:ipfs.md
│ │ │ │ │ ├── algokit:cli:features:tasks:mint.md
│ │ │ │ │ ├── algokit:cli:features:tasks:nfd.md
│ │ │ │ │ ├── algokit:cli:features:tasks:opt.md
│ │ │ │ │ ├── algokit:cli:features:tasks:send.md
│ │ │ │ │ ├── algokit:cli:features:tasks:sign.md
│ │ │ │ │ ├── algokit:cli:features:tasks:transfer.md
│ │ │ │ │ ├── algokit:cli:features:tasks:vanity_address.md
│ │ │ │ │ ├── algokit:cli:features:tasks:wallet.md
│ │ │ │ │ ├── algokit:cli:features:tasks.md
│ │ │ │ │ ├── algokit:cli:tutorials:algokit-template.md
│ │ │ │ │ ├── algokit:cli:tutorials:intro.md
│ │ │ │ │ ├── algokit:cli:tutorials:smart-contracts.md
│ │ │ │ │ ├── algokit:docs:testnet_api.md
│ │ │ │ │ ├── algokit:lora:README.md
│ │ │ │ │ ├── algokit:README.md
│ │ │ │ │ ├── algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:markdown:index.md
│ │ │ │ │ ├── algokit:utils:python:README.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:source:index.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:algorand-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:amount.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:asset.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:event-emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction-composer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:typed-app-clients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TestLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TransactionLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.MultisigAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.SigningAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.AppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_manager.AppManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_logic_error.LogicError.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnUpdate.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.SignatureType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppState.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxName.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_config.Config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_interface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_arc56.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_deployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_composer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_expand.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_kmd_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_lifecycle_events.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logic_error.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_network_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:README.md
│ │ │ │ │ ├── algokit:utils:typescript:README.md
│ │ │ │ │ ├── algokit:utils:typescript:v7-migration.md
│ │ │ │ │ ├── algokit:utils:typescript:v8-migration.md
│ │ │ │ │ ├── ARCs:ARC-template.md
│ │ │ │ │ ├── ARCs:assets:arc-0012:README.md
│ │ │ │ │ ├── ARCs:assets:arc-0034:TemplateForm.md
│ │ │ │ │ ├── ARCs:assets:arc-0062:README.md
│ │ │ │ │ ├── ARCs:pages:nfts.md
│ │ │ │ │ ├── ARCs:pages:wallets.md
│ │ │ │ │ ├── ARCs:README.md
│ │ │ │ │ ├── ARCs:specs:arc-0000.md
│ │ │ │ │ ├── ARCs:specs:arc-0001.md
│ │ │ │ │ ├── ARCs:specs:arc-0002.md
│ │ │ │ │ ├── ARCs:specs:arc-0003.md
│ │ │ │ │ ├── ARCs:specs:arc-0004.md
│ │ │ │ │ ├── ARCs:specs:arc-0005.md
│ │ │ │ │ ├── ARCs:specs:arc-0006.md
│ │ │ │ │ ├── ARCs:specs:arc-0007.md
│ │ │ │ │ ├── ARCs:specs:arc-0008.md
│ │ │ │ │ ├── ARCs:specs:arc-0009.md
│ │ │ │ │ ├── ARCs:specs:arc-0010.md
│ │ │ │ │ ├── ARCs:specs:arc-0011.md
│ │ │ │ │ ├── ARCs:specs:arc-0012.md
│ │ │ │ │ ├── ARCs:specs:arc-0015.md
│ │ │ │ │ ├── ARCs:specs:arc-0016.md
│ │ │ │ │ ├── ARCs:specs:arc-0018.md
│ │ │ │ │ ├── ARCs:specs:arc-0019.md
│ │ │ │ │ ├── ARCs:specs:arc-0020.md
│ │ │ │ │ ├── ARCs:specs:arc-0021.md
│ │ │ │ │ ├── ARCs:specs:arc-0022.md
│ │ │ │ │ ├── ARCs:specs:arc-0023.md
│ │ │ │ │ ├── ARCs:specs:arc-0025.md
│ │ │ │ │ ├── ARCs:specs:arc-0026.md
│ │ │ │ │ ├── ARCs:specs:arc-0028.md
│ │ │ │ │ ├── ARCs:specs:arc-0032.md
│ │ │ │ │ ├── ARCs:specs:arc-0033.md
│ │ │ │ │ ├── ARCs:specs:arc-0034.md
│ │ │ │ │ ├── ARCs:specs:arc-0035.md
│ │ │ │ │ ├── ARCs:specs:arc-0036.md
│ │ │ │ │ ├── ARCs:specs:arc-0042.md
│ │ │ │ │ ├── ARCs:specs:arc-0047.md
│ │ │ │ │ ├── ARCs:specs:arc-0048.md
│ │ │ │ │ ├── ARCs:specs:arc-0049.md
│ │ │ │ │ ├── ARCs:specs:arc-0054.md
│ │ │ │ │ ├── ARCs:specs:arc-0055.md
│ │ │ │ │ ├── ARCs:specs:arc-0056.md
│ │ │ │ │ ├── ARCs:specs:arc-0059.md
│ │ │ │ │ ├── ARCs:specs:arc-0062.md
│ │ │ │ │ ├── ARCs:specs:arc-0065.md
│ │ │ │ │ ├── ARCs:specs:arc-0069.md
│ │ │ │ │ ├── ARCs:specs:arc-0072.md
│ │ │ │ │ ├── ARCs:specs:arc-0073.md
│ │ │ │ │ ├── ARCs:specs:arc-0074.md
│ │ │ │ │ ├── ARCs:specs:arc-0076.md
│ │ │ │ │ ├── ARCs:specs:arc-0078.md
│ │ │ │ │ ├── ARCs:specs:arc-0079.md
│ │ │ │ │ ├── ARCs:specs:arc-0200.md
│ │ │ │ │ ├── clis_index.md
│ │ │ │ │ ├── developer:docs:about.md
│ │ │ │ │ ├── developer:docs:clis:algokey:algokey.md
│ │ │ │ │ ├── developer:docs:clis:algokey:generate.md
│ │ │ │ │ ├── developer:docs:clis:algokey:import.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:append-auth-addr.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:multisig.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:info.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:part.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:reparent.md
│ │ │ │ │ ├── developer:docs:clis:algokey:sign.md
│ │ │ │ │ ├── developer:docs:clis:conduit:conduit.md
│ │ │ │ │ ├── developer:docs:clis:conduit:init.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:exporters.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:importers.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:list.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:processors.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:diagcfg.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:metric.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:endpoint.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:name.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:telemetry.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:restart.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:start.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:status.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:stop.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:wait.md
│ │ │ │ │ ├── developer:docs:clis:goal:protocols.md
│ │ │ │ │ ├── developer:docs:clis:goal:report.md
│ │ │ │ │ ├── developer:docs:clis:goal:version.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:list.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:new.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:wallet.md
│ │ │ │ │ ├── developer:docs:clis:indexer:api-config.md
│ │ │ │ │ ├── developer:docs:clis:indexer:daemon.md
│ │ │ │ │ ├── developer:docs:clis:indexer:indexer.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:util.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:validator.md
│ │ │ │ │ ├── developer:docs:clis:kmd.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:debug.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:remote.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:tealdbg.md
│ │ │ │ │ ├── developer:docs:details:accounts:create.md
│ │ │ │ │ ├── developer:docs:details:accounts:index.md
│ │ │ │ │ ├── developer:docs:details:accounts:rekey.md
│ │ │ │ │ ├── developer:docs:details:algorand_consensus.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:betanet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:index.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:mainnet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:testnet.md
│ │ │ │ │ ├── developer:docs:details:asa.md
│ │ │ │ │ ├── developer:docs:details:atc.md
│ │ │ │ │ ├── developer:docs:details:atomic_transfers.md
│ │ │ │ │ ├── developer:docs:details:conduit.md
│ │ │ │ │ ├── developer:docs:details:crust.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:jsonspec.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v1.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v10.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v2.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v3.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v4.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v5.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v6.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v7.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v8.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v9.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:specification.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:ABI:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:create.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:innertx.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:state.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:txs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:debugging.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:apps.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:modes.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:beaker.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:pyteal.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:python.md
│ │ │ │ │ ├── developer:docs:details:encoding.md
│ │ │ │ │ ├── developer:docs:details:ethereum_to_algorand.md
│ │ │ │ │ ├── developer:docs:details:index.md
│ │ │ │ │ ├── developer:docs:details:indexer.md
│ │ │ │ │ ├── developer:docs:details:parameter_tables.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:index.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:light_client.md
│ │ │ │ │ ├── developer:docs:details:technical_faq.md
│ │ │ │ │ ├── developer:docs:details:transactions:index.md
│ │ │ │ │ ├── developer:docs:details:transactions:offline_transactions.md
│ │ │ │ │ ├── developer:docs:details:transactions:payment_prompts.md
│ │ │ │ │ ├── developer:docs:details:transactions:signatures.md
│ │ │ │ │ ├── developer:docs:details:transactions:transactions.md
│ │ │ │ │ ├── developer:docs:details:useful_resources.md
│ │ │ │ │ ├── developer:docs:get-started:algokit.md
│ │ │ │ │ ├── developer:docs:get-started:basics:what_is_blockchain.md
│ │ │ │ │ ├── developer:docs:get-started:basics:whats_a_dapp.md
│ │ │ │ │ ├── developer:docs:get-started:basics:where_to_start.md
│ │ │ │ │ ├── developer:docs:get-started:basics:why_algorand.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:ft.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:nft.md
│ │ │ │ │ ├── developer:docs:index.md
│ │ │ │ │ ├── developer:docs:rest-apis:algod.md
│ │ │ │ │ ├── developer:docs:rest-apis:indexer.md
│ │ │ │ │ ├── developer:docs:rest-apis:kmd.md
│ │ │ │ │ ├── developer:docs:rest-apis:restendpoints.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:catchup.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:switch_networks.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:generate_keys.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:index.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:offline.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:online.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:renew.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:artifacts.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:config.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:relay.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:telemetry-config.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:indexer.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:install.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:node-troubleshooting.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:types.md
│ │ │ │ │ ├── developer:docs:sdks:go:index.md
│ │ │ │ │ ├── developer:docs:sdks:index.md
│ │ │ │ │ ├── developer:docs:sdks:java:index.md
│ │ │ │ │ ├── developer:docs:sdks:javascript:index.md
│ │ │ │ │ ├── developer:docs:sdks:python:index.md
│ │ │ │ │ ├── developer:python:code:example:accounts.md
│ │ │ │ │ ├── developer:python:code:example:arc4_types.md
│ │ │ │ │ ├── developer:python:code:example:assets.md
│ │ │ │ │ ├── developer:python:code:example:box_storage.md
│ │ │ │ │ ├── developer:python:code:example:control_flow.md
│ │ │ │ │ ├── developer:python:code:example:crypto:merkle_tree.md
│ │ │ │ │ ├── developer:python:code:example:defi:amm.md
│ │ │ │ │ ├── developer:python:code:example:defi:auction.md
│ │ │ │ │ ├── developer:python:code:example:defi:htlc_logicsig.md
│ │ │ │ │ ├── developer:python:code:example:defi:marketplace.md
│ │ │ │ │ ├── developer:python:code:example:events:arc28_events.md
│ │ │ │ │ ├── developer:python:code:example:global_storage.md
│ │ │ │ │ ├── developer:python:code:example:governance:simple_voting.md
│ │ │ │ │ ├── developer:python:code:example:hello_world.md
│ │ │ │ │ ├── developer:python:code:example:inner_transactions.md
│ │ │ │ │ ├── developer:python:code:example:local_storage.md
│ │ │ │ │ ├── developer:python:code:example:nft:proof_of_attendance.md
│ │ │ │ │ ├── developer:python:code:example:privacy:zk_whitelist.md
│ │ │ │ │ ├── developer:python:code:example:scratch_storage.md
│ │ │ │ │ ├── developer:python:code:example:self_payment.md
│ │ │ │ │ ├── developer:python:code:example:struct_in_box.md
│ │ │ │ │ ├── developer:python:code:example:subsidize_app_call.md
│ │ │ │ │ ├── developer:python:code:example:transactions.md
│ │ │ │ │ ├── developer:python:code:example:utility:calculator.md
│ │ │ │ │ ├── devportal-code-examples:projects:python-contract-examples:README.md
│ │ │ │ │ ├── devportal-code-examples:README.md
│ │ │ │ │ ├── docs:.walletconnect:index.md
│ │ │ │ │ ├── docs:.walletconnect:walletconnect-schema.md
│ │ │ │ │ ├── docs:README.md
│ │ │ │ │ ├── docs:scripts:example_tracker:example_list.md
│ │ │ │ │ ├── docs:scripts:README.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── liquid_auth_index.md
│ │ │ │ │ ├── liquid-auth:ARCHITECTURE.md
│ │ │ │ │ ├── liquid-auth:decisions:1-Service-Authentication.md
│ │ │ │ │ ├── liquid-auth:decisions:2-Bidirectional-Communication.md
│ │ │ │ │ ├── liquid-auth:decisions:3-Peer-to-Peer-Signaling.md
│ │ │ │ │ ├── liquid-auth:decisions:4-Fido-Extension.md
│ │ │ │ │ ├── liquid-auth:decisions:README.md
│ │ │ │ │ ├── liquid-auth:docs:architecture.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:authenticate.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:register.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:authentication.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:example.md
│ │ │ │ │ ├── liquid-auth:docs:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:README.md
│ │ │ │ │ ├── liquid-auth:docs:server:environment-variables.md
│ │ │ │ │ ├── liquid-auth:docs:server:integrations.md
│ │ │ │ │ ├── liquid-auth:docs:server:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:server:running-locally.md
│ │ │ │ │ ├── liquid-auth:README.md
│ │ │ │ │ ├── liquid-auth:SEQUENCE.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md
│ │ │ │ │ ├── liquid-auth:sites:express-dapp:README.md
│ │ │ │ │ ├── liquid-auth:VISION.md
│ │ │ │ │ ├── puya_index.md
│ │ │ │ │ ├── puya:docs:algopy_testing:index.md
│ │ │ │ │ ├── puya:docs:api-algopy.arc4.md
│ │ │ │ │ ├── puya:docs:api-algopy.gtxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.itxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.md
│ │ │ │ │ ├── puya:docs:api-algopy.op.md
│ │ │ │ │ ├── puya:docs:api.md
│ │ │ │ │ ├── puya:docs:compiler.md
│ │ │ │ │ ├── puya:docs:index.md
│ │ │ │ │ ├── puya:docs:language-guide.md
│ │ │ │ │ ├── puya:docs:lg-arc28.md
│ │ │ │ │ ├── puya:docs:lg-arc4.md
│ │ │ │ │ ├── puya:docs:lg-builtins.md
│ │ │ │ │ ├── puya:docs:lg-calling-apps.md
│ │ │ │ │ ├── puya:docs:lg-compile.md
│ │ │ │ │ ├── puya:docs:lg-control.md
│ │ │ │ │ ├── puya:docs:lg-errors.md
│ │ │ │ │ ├── puya:docs:lg-logs.md
│ │ │ │ │ ├── puya:docs:lg-modules.md
│ │ │ │ │ ├── puya:docs:lg-opcode-budget.md
│ │ │ │ │ ├── puya:docs:lg-ops.md
│ │ │ │ │ ├── puya:docs:lg-storage.md
│ │ │ │ │ ├── puya:docs:lg-structure.md
│ │ │ │ │ ├── puya:docs:lg-transactions.md
│ │ │ │ │ ├── puya:docs:lg-types.md
│ │ │ │ │ ├── puya:docs:lg-unsupported-python-features.md
│ │ │ │ │ ├── puya:docs:principles.md
│ │ │ │ │ ├── puya:examples:auction:README.md
│ │ │ │ │ ├── puya:python:testing:docs:algopy.md
│ │ │ │ │ ├── puya:python:testing:docs:api.md
│ │ │ │ │ ├── puya:python:testing:docs:coverage.md
│ │ │ │ │ ├── puya:python:testing:docs:examples.md
│ │ │ │ │ ├── puya:python:testing:docs:faq.md
│ │ │ │ │ ├── puya:python:testing:docs:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:arc4-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:avm-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:concepts.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:contract-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:opcodes.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:signature-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:state-management.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:subroutines.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:transactions.md
│ │ │ │ │ ├── puya:python:testing:examples:README.md
│ │ │ │ │ ├── puya:python:testing:README.md
│ │ │ │ │ ├── puya:README.md
│ │ │ │ │ ├── puya:src:puya:ARCHITECTURE.md
│ │ │ │ │ ├── puya:src:puyapy:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:awst_build:README.md
│ │ │ │ │ ├── puya:stubs:README.md
│ │ │ │ │ ├── puya:tests:test_expected_output:README.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md
│ │ │ │ │ ├── puya:typescript:docs:README.md
│ │ │ │ │ ├── puya:typescript:packages:algo-ts:readme.md
│ │ │ │ │ ├── puya:typescript:README.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIAddressType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayDynamicType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayStaticType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIBoolType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIByteType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIContract.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIInterface.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIMethod.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIStringType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABITupleType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUfixedType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUintType.md
│ │ │ │ │ ├── SDKs:javascript:classes:Algodv2.md
│ │ │ │ │ ├── SDKs:javascript:classes:AtomicTransactionComposer.md
│ │ │ │ │ ├── SDKs:javascript:classes:DryrunResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:Indexer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogData.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetBalancesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHoldingsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Block.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockRewards.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeVote.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HashFactory.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HealthCheck.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.IndexerStateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MerkleArrayProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MiniAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ParticipationUpdates.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofFields.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofParticipant.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofReveal.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSigSlot.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofTracking.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofVerifier.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Transaction.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionApplication.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetFreeze.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetTransfer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionKeyreg.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionPayment.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureLogicsig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionStateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:Kmd.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSig.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetsInformationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AppCallLogs.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationKVStorage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateOperation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHoldingReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockHashResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockTxidsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BuildVersion.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.CompileResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DisassembleResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunSource.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunTxnResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetSyncRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.KvDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LightBlockHeaderProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.NodeStatusResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PostTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ScratchChange.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTraceConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionGroupResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationEvalOverrides.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationTransactionExecTrace.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SupplyResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionParametersResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionProofResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Version.md
│ │ │ │ │ ├── SDKs:javascript:classes:SourceMap.md
│ │ │ │ │ ├── SDKs:javascript:classes:Transaction.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABIReferenceType.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABITransactionType.md
│ │ │ │ │ ├── SDKs:javascript:enums:AtomicTransactionComposerStatus.md
│ │ │ │ │ ├── SDKs:javascript:enums:IntDecoding.md
│ │ │ │ │ ├── SDKs:javascript:enums:OnApplicationComplete.md
│ │ │ │ │ ├── SDKs:javascript:enums:TransactionType.md
│ │ │ │ │ ├── SDKs:javascript:examples:README.md
│ │ │ │ │ ├── SDKs:javascript:FAQ.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworkInfo.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworks.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIInterfaceParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodArgParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodReturnParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIResult.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Account.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Address.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:AlgodTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClient.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientError.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientResponse.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:CustomTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedAssetParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedBoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedGlobalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLocalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedMultisig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSubsig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:IndexerTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:KMDTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:MultisigMetadata.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SuggestedParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionWithSigner.md
│ │ │ │ │ ├── SDKs:javascript:modules:indexerModels.md
│ │ │ │ │ ├── SDKs:javascript:modules:modelsv2.md
│ │ │ │ │ ├── SDKs:javascript:modules.md
│ │ │ │ │ ├── SDKs:javascript:README.md
│ │ │ │ │ ├── SDKs:python:algosdk:v2client:harness:README.md
│ │ │ │ │ ├── SDKs:python:examples:README.md
│ │ │ │ │ ├── SDKs:python:README.md
│ │ │ │ │ ├── tealscript:examples_amm_README.md
│ │ │ │ │ ├── tealscript:examples_auction_README.md
│ │ │ │ │ ├── tealscript:examples_big_box_README.md
│ │ │ │ │ ├── tealscript:examples_itxns_README.md
│ │ │ │ │ ├── tealscript:examples_lsig_with_app_README.md
│ │ │ │ │ ├── tealscript:examples_reti_README.md
│ │ │ │ │ ├── tealscript:FEATURES.md
│ │ │ │ │ ├── tealscript:guides_atomic_txn.md
│ │ │ │ │ ├── tealscript:guides_features.md
│ │ │ │ │ ├── tealscript:guides_getting_started.md
│ │ │ │ │ ├── tealscript:guides_inner_transactions.md
│ │ │ │ │ ├── tealscript:guides_lifecycle.md
│ │ │ │ │ ├── tealscript:guides_math.md
│ │ │ │ │ ├── tealscript:guides_methods.md
│ │ │ │ │ ├── tealscript:guides_multiple_contracts.md
│ │ │ │ │ ├── tealscript:guides_pyteal.md
│ │ │ │ │ ├── tealscript:guides_storage.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_arrays.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_numbers.md
│ │ │ │ │ ├── TEALScript:README.md
│ │ │ │ │ ├── tealscript:tests_test_package_README.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0001-intro.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0002-init.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0003-contract.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0004-artifacts.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0005-hello.md
│ │ │ │ │ └── tealscript:tutorials_Hello World_0006-test.md
│ │ │ │ └── taxonomy-categories
│ │ │ │ ├── algokit-utils.json
│ │ │ │ ├── algokit.json
│ │ │ │ ├── arcs.json
│ │ │ │ ├── clis.json
│ │ │ │ ├── details.json
│ │ │ │ ├── developers.json
│ │ │ │ ├── liquid-auth.json
│ │ │ │ ├── nodes.json
│ │ │ │ ├── puya.json
│ │ │ │ ├── python.json
│ │ │ │ ├── sdks.json
│ │ │ │ └── tealscript.json
│ │ │ └── wallet
│ │ │ └── index.ts
│ │ ├── tools
│ │ │ ├── accountManager.ts
│ │ │ ├── algodManager.ts
│ │ │ ├── apiManager
│ │ │ │ ├── algod
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── example
│ │ │ │ │ ├── get-balance.ts
│ │ │ │ │ └── index.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── indexer
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── nfd
│ │ │ │ │ └── index.ts
│ │ │ │ ├── tinyman
│ │ │ │ │ ├── analytics.ts
│ │ │ │ │ ├── bootstrap.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── liquidity.ts
│ │ │ │ │ ├── opt_in.ts
│ │ │ │ │ ├── pool.ts
│ │ │ │ │ ├── remove_liquidity.ts
│ │ │ │ │ └── swap.ts
│ │ │ │ ├── ultrade
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── market.ts
│ │ │ │ │ ├── system.ts
│ │ │ │ │ └── wallet.ts
│ │ │ │ └── vestige
│ │ │ │ ├── assets.ts
│ │ │ │ ├── balances.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── networks.ts
│ │ │ │ ├── notes.ts
│ │ │ │ ├── pools.ts
│ │ │ │ ├── protocols.ts
│ │ │ │ ├── swaps.ts
│ │ │ │ └── vaults.ts
│ │ │ ├── arc26Manager.ts
│ │ │ ├── index.ts
│ │ │ ├── knowledgeManager.ts
│ │ │ ├── transactionManager
│ │ │ │ ├── accountTransactions.ts
│ │ │ │ ├── appTransactions
│ │ │ │ │ ├── callTxn.ts
│ │ │ │ │ ├── clearTxn.ts
│ │ │ │ │ ├── closeOutTxn.ts
│ │ │ │ │ ├── createTxn.ts
│ │ │ │ │ ├── deleteTxn.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── optInTxn.ts
│ │ │ │ │ ├── test
│ │ │ │ │ │ ├── counter_approval.teal
│ │ │ │ │ │ ├── counter_clear.teal
│ │ │ │ │ │ ├── storage_test_approval_v2.teal
│ │ │ │ │ │ ├── storage_test_approval.teal
│ │ │ │ │ │ └── storage_test_clear.teal
│ │ │ │ │ ├── types.ts
│ │ │ │ │ └── updateTxn.ts
│ │ │ │ ├── assetTransactions.ts
│ │ │ │ ├── generalTransaction.ts
│ │ │ │ └── index.ts
│ │ │ └── utilityManager.ts
│ │ ├── types.ts
│ │ └── utils
│ │ └── responseProcessor.ts
│ ├── tests
│ │ ├── resources
│ │ │ ├── algod
│ │ │ │ ├── account.test.ts
│ │ │ │ ├── application.test.ts
│ │ │ │ ├── asset.test.ts
│ │ │ │ └── transaction.test.ts
│ │ │ └── indexer
│ │ │ ├── account.test.ts
│ │ │ ├── application.test.ts
│ │ │ ├── asset.test.ts
│ │ │ └── transaction.test.ts
│ │ └── tools
│ │ ├── accountManager.test.ts
│ │ ├── algodManager.test.ts
│ │ ├── apiManager
│ │ │ └── example
│ │ │ └── get-balance.test.ts
│ │ ├── transactionManager
│ │ │ ├── accountTransactionManager.test.ts
│ │ │ ├── appTransactionManager.test.ts
│ │ │ ├── assetTransactionManager.test.ts
│ │ │ ├── generalTransactionManager.test.ts
│ │ │ └── transactionManager.test.ts
│ │ └── utilityManager.test.ts
│ └── tsconfig.json
├── README.md
├── rename_files.sh
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.LightBlockHeaderProof.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / LightBlockHeaderProof
2 |
3 | # Class: LightBlockHeaderProof
4 |
5 | [modelsv2](../modules/modelsv2.md).LightBlockHeaderProof
6 |
7 | Proof of membership and position of a light block header.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`LightBlockHeaderProof`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.LightBlockHeaderProof.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.LightBlockHeaderProof.md#attribute_map)
24 | - [index](modelsv2.LightBlockHeaderProof.md#index)
25 | - [proof](modelsv2.LightBlockHeaderProof.md#proof)
26 | - [treedepth](modelsv2.LightBlockHeaderProof.md#treedepth)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](modelsv2.LightBlockHeaderProof.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](modelsv2.LightBlockHeaderProof.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new LightBlockHeaderProof**(`«destructured»`)
38 |
39 | Creates a new `LightBlockHeaderProof` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `index` | `number` \| `bigint` |
47 | | › `proof` | `string` \| `Uint8Array` |
48 | | › `treedepth` | `number` \| `bigint` |
49 |
50 | #### Overrides
51 |
52 | BaseModel.constructor
53 |
54 | #### Defined in
55 |
56 | client/v2/algod/models/types.ts:3441
57 |
58 | ## Properties
59 |
60 | ### attribute\_map
61 |
62 | • **attribute\_map**: `Record`\<`string`, `string`\>
63 |
64 | #### Inherited from
65 |
66 | BaseModel.attribute\_map
67 |
68 | #### Defined in
69 |
70 | client/v2/basemodel.ts:56
71 |
72 | ___
73 |
74 | ### index
75 |
76 | • **index**: `number` \| `bigint`
77 |
78 | The index of the light block header in the vector commitment tree
79 |
80 | #### Defined in
81 |
82 | client/v2/algod/models/types.ts:3421
83 |
84 | ___
85 |
86 | ### proof
87 |
88 | • **proof**: `Uint8Array`
89 |
90 | The encoded proof.
91 |
92 | #### Defined in
93 |
94 | client/v2/algod/models/types.ts:3426
95 |
96 | ___
97 |
98 | ### treedepth
99 |
100 | • **treedepth**: `number` \| `bigint`
101 |
102 | Represents the depth of the tree that is being proven, i.e. the number of edges
103 | from a leaf to the root.
104 |
105 | #### Defined in
106 |
107 | client/v2/algod/models/types.ts:3432
108 |
109 | ## Methods
110 |
111 | ### get\_obj\_for\_encoding
112 |
113 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
114 |
115 | Get an object ready for encoding to either JSON or msgpack.
116 |
117 | #### Parameters
118 |
119 | | Name | Type | Default value | Description |
120 | | :------ | :------ | :------ | :------ |
121 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
122 |
123 | #### Returns
124 |
125 | `Record`\<`string`, `any`\>
126 |
127 | #### Inherited from
128 |
129 | BaseModel.get\_obj\_for\_encoding
130 |
131 | #### Defined in
132 |
133 | client/v2/basemodel.ts:65
134 |
135 | ___
136 |
137 | ### from\_obj\_for\_encoding
138 |
139 | ▸ `Static` **from_obj_for_encoding**(`data`): [`LightBlockHeaderProof`](modelsv2.LightBlockHeaderProof.md)
140 |
141 | #### Parameters
142 |
143 | | Name | Type |
144 | | :------ | :------ |
145 | | `data` | `Record`\<`string`, `any`\> |
146 |
147 | #### Returns
148 |
149 | [`LightBlockHeaderProof`](modelsv2.LightBlockHeaderProof.md)
150 |
151 | #### Defined in
152 |
153 | client/v2/algod/models/types.ts:3466
154 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:index.md:
--------------------------------------------------------------------------------
```markdown
1 | title: AVM
2 |
3 | The Algorand virtual machine (AVM) runs on every node in the Algorand blockchain. This virtual machine contains a stack engine that evaluates smart contracts and smart signatures against the transactions they're called with. These programs either fail and reject the transaction or succeed and apply changes according to the logic and contents of the transactions.
4 |
5 |
6 | # Quick start videos
7 |
8 | If you prefer videos, take a look at this playlist to learn about AVM. Most of the videos in the list are under 5 minutes each.
9 |
10 | <iframe width="100%" style="aspect-ratio:16/9" src="https://www.youtube-nocookie.com/embed/96pwBo5jqnk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
11 |
12 | Smart contracts, also referred to as stateful smart contracts, contain logic that is deployed and can be remotely called from any node on the Algorand blockchain. These contracts are called by issuing an Application Call transaction. The AVM evaluates the contract logic against this transaction and ultimately results in success or failure. If a call to a smart contract fails, any changes produced by that call will not be committed to the blockchain. If the call is successful, the changes will be recorded to the blockchain when the block is committed. In addition to changes to balances, the logic within a smart contract can modify key/value data associated with the contract on a global or per-account basis.
13 |
14 | Smart signatures, also referred to as stateless contracts, contain logic that is used to sign transactions, commonly for signature delegation. The logic of the smart signature is submitted with the transaction. While the logic in the smart signature is stored on the chain as part of the transaction approval process, the logic is not remotely callable. Any new transaction that relies on the same smart signature would resubmit the logic. When the logic is submitted to a node the AVM evaluates the logic and results in success or failure. If a smart signature’s logic fails when executed by the AVM, the associated transaction will not be applied.
15 |
16 | The AVM interprets an assembler-like language called [Transaction Execution Approval Language (TEAL)](teal/index.md). TEAL can be thought of as syntactic sugar for AVM bytecode and the [full specification](teal/specification.md) of the TEAL language is available in the developer documentation. In addition, a simple [overview guide](teal/index.md) explains many of the features of the language. TEAL programs are comprised of a set of operation codes (opcodes). These opcodes are used to implement the logic of smart contracts and smart signatures. The full list of [opcodes](teal/opcodes) is available in the developer documentation.
17 |
18 | While it is possible to write TEAL directly, a developer may prefer to use the PyTeal Python library, which provides a more familiar syntax. For more information on using PyTeal to write smart signatures and smart contracts see [Build with Python](/docs/get-details/dapps/writing-contracts/pyteal).
19 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.ApplicationLocalState.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / ApplicationLocalState
2 |
3 | # Class: ApplicationLocalState
4 |
5 | [modelsv2](../modules/modelsv2.md).ApplicationLocalState
6 |
7 | Stores local state associated with an application.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`ApplicationLocalState`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.ApplicationLocalState.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.ApplicationLocalState.md#attribute_map)
24 | - [id](modelsv2.ApplicationLocalState.md#id)
25 | - [keyValue](modelsv2.ApplicationLocalState.md#keyvalue)
26 | - [schema](modelsv2.ApplicationLocalState.md#schema)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](modelsv2.ApplicationLocalState.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](modelsv2.ApplicationLocalState.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new ApplicationLocalState**(`«destructured»`)
38 |
39 | Creates a new `ApplicationLocalState` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `id` | `number` \| `bigint` |
47 | | › `keyValue?` | [`TealKeyValue`](modelsv2.TealKeyValue.md)[] |
48 | | › `schema` | [`ApplicationStateSchema`](modelsv2.ApplicationStateSchema.md) |
49 |
50 | #### Overrides
51 |
52 | BaseModel.constructor
53 |
54 | #### Defined in
55 |
56 | client/v2/algod/models/types.ts:1220
57 |
58 | ## Properties
59 |
60 | ### attribute\_map
61 |
62 | • **attribute\_map**: `Record`\<`string`, `string`\>
63 |
64 | #### Inherited from
65 |
66 | BaseModel.attribute\_map
67 |
68 | #### Defined in
69 |
70 | client/v2/basemodel.ts:56
71 |
72 | ___
73 |
74 | ### id
75 |
76 | • **id**: `number` \| `bigint`
77 |
78 | The application which this local state is for.
79 |
80 | #### Defined in
81 |
82 | client/v2/algod/models/types.ts:1202
83 |
84 | ___
85 |
86 | ### keyValue
87 |
88 | • `Optional` **keyValue**: [`TealKeyValue`](modelsv2.TealKeyValue.md)[]
89 |
90 | (tkv) storage.
91 |
92 | #### Defined in
93 |
94 | client/v2/algod/models/types.ts:1212
95 |
96 | ___
97 |
98 | ### schema
99 |
100 | • **schema**: [`ApplicationStateSchema`](modelsv2.ApplicationStateSchema.md)
101 |
102 | (hsch) schema.
103 |
104 | #### Defined in
105 |
106 | client/v2/algod/models/types.ts:1207
107 |
108 | ## Methods
109 |
110 | ### get\_obj\_for\_encoding
111 |
112 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
113 |
114 | Get an object ready for encoding to either JSON or msgpack.
115 |
116 | #### Parameters
117 |
118 | | Name | Type | Default value | Description |
119 | | :------ | :------ | :------ | :------ |
120 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
121 |
122 | #### Returns
123 |
124 | `Record`\<`string`, `any`\>
125 |
126 | #### Inherited from
127 |
128 | BaseModel.get\_obj\_for\_encoding
129 |
130 | #### Defined in
131 |
132 | client/v2/basemodel.ts:65
133 |
134 | ___
135 |
136 | ### from\_obj\_for\_encoding
137 |
138 | ▸ `Static` **from_obj_for_encoding**(`data`): [`ApplicationLocalState`](modelsv2.ApplicationLocalState.md)
139 |
140 | #### Parameters
141 |
142 | | Name | Type |
143 | | :------ | :------ |
144 | | `data` | `Record`\<`string`, `any`\> |
145 |
146 | #### Returns
147 |
148 | [`ApplicationLocalState`](modelsv2.ApplicationLocalState.md)
149 |
150 | #### Defined in
151 |
152 | client/v2/algod/models/types.ts:1242
153 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / TransactionGroupLedgerStateDeltasForRoundResponse
2 |
3 | # Class: TransactionGroupLedgerStateDeltasForRoundResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).TransactionGroupLedgerStateDeltasForRoundResponse
6 |
7 | Response containing all ledger state deltas for transaction groups, with their
8 | associated Ids, in a single round.
9 |
10 | ## Hierarchy
11 |
12 | - `default`
13 |
14 | ↳ **`TransactionGroupLedgerStateDeltasForRoundResponse`**
15 |
16 | ## Table of contents
17 |
18 | ### Constructors
19 |
20 | - [constructor](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md#constructor)
21 |
22 | ### Properties
23 |
24 | - [attribute\_map](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md#attribute_map)
25 | - [deltas](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md#deltas)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new TransactionGroupLedgerStateDeltasForRoundResponse**(`deltas`)
37 |
38 | Creates a new `TransactionGroupLedgerStateDeltasForRoundResponse` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `deltas` | `Object` |
45 | | `deltas.deltas` | [`LedgerStateDeltaForTransactionGroup`](modelsv2.LedgerStateDeltaForTransactionGroup.md)[] |
46 |
47 | #### Overrides
48 |
49 | BaseModel.constructor
50 |
51 | #### Defined in
52 |
53 | client/v2/algod/models/types.ts:5735
54 |
55 | ## Properties
56 |
57 | ### attribute\_map
58 |
59 | • **attribute\_map**: `Record`\<`string`, `string`\>
60 |
61 | #### Inherited from
62 |
63 | BaseModel.attribute\_map
64 |
65 | #### Defined in
66 |
67 | client/v2/basemodel.ts:56
68 |
69 | ___
70 |
71 | ### deltas
72 |
73 | • **deltas**: [`LedgerStateDeltaForTransactionGroup`](modelsv2.LedgerStateDeltaForTransactionGroup.md)[]
74 |
75 | #### Defined in
76 |
77 | client/v2/algod/models/types.ts:5729
78 |
79 | ## Methods
80 |
81 | ### get\_obj\_for\_encoding
82 |
83 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
84 |
85 | Get an object ready for encoding to either JSON or msgpack.
86 |
87 | #### Parameters
88 |
89 | | Name | Type | Default value | Description |
90 | | :------ | :------ | :------ | :------ |
91 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
92 |
93 | #### Returns
94 |
95 | `Record`\<`string`, `any`\>
96 |
97 | #### Inherited from
98 |
99 | BaseModel.get\_obj\_for\_encoding
100 |
101 | #### Defined in
102 |
103 | client/v2/basemodel.ts:65
104 |
105 | ___
106 |
107 | ### from\_obj\_for\_encoding
108 |
109 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionGroupLedgerStateDeltasForRoundResponse`](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md)
110 |
111 | #### Parameters
112 |
113 | | Name | Type |
114 | | :------ | :------ |
115 | | `data` | `Record`\<`string`, `any`\> |
116 |
117 | #### Returns
118 |
119 | [`TransactionGroupLedgerStateDeltasForRoundResponse`](modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md)
120 |
121 | #### Defined in
122 |
123 | client/v2/algod/models/types.ts:5745
124 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / AtomicTransactionComposerToSend
2 |
3 | # Interface: AtomicTransactionComposerToSend
4 |
5 | [types/transaction](../modules/types_transaction.md).AtomicTransactionComposerToSend
6 |
7 | An `AtomicTransactionComposer` with transactions to send.
8 |
9 | ## Hierarchy
10 |
11 | - [`SendParams`](types_transaction.SendParams.md)
12 |
13 | ↳ **`AtomicTransactionComposerToSend`**
14 |
15 | ## Table of contents
16 |
17 | ### Properties
18 |
19 | - [atc](types_transaction.AtomicTransactionComposerToSend.md#atc)
20 | - [maxRoundsToWaitForConfirmation](types_transaction.AtomicTransactionComposerToSend.md#maxroundstowaitforconfirmation)
21 | - [populateAppCallResources](types_transaction.AtomicTransactionComposerToSend.md#populateappcallresources)
22 | - [sendParams](types_transaction.AtomicTransactionComposerToSend.md#sendparams)
23 | - [suppressLog](types_transaction.AtomicTransactionComposerToSend.md#suppresslog)
24 |
25 | ## Properties
26 |
27 | ### atc
28 |
29 | • **atc**: `AtomicTransactionComposer`
30 |
31 | The `AtomicTransactionComposer` with transactions loaded to send
32 |
33 | #### Defined in
34 |
35 | [src/types/transaction.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L146)
36 |
37 | ___
38 |
39 | ### maxRoundsToWaitForConfirmation
40 |
41 | • `Optional` **maxRoundsToWaitForConfirmation**: `number`
42 |
43 | The number of rounds to wait for confirmation. By default until the latest lastValid has past.
44 |
45 | #### Inherited from
46 |
47 | [SendParams](types_transaction.SendParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendParams.md#maxroundstowaitforconfirmation)
48 |
49 | #### Defined in
50 |
51 | [src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136)
52 |
53 | ___
54 |
55 | ### populateAppCallResources
56 |
57 | • `Optional` **populateAppCallResources**: `boolean`
58 |
59 | Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`.
60 |
61 | #### Inherited from
62 |
63 | [SendParams](types_transaction.SendParams.md).[populateAppCallResources](types_transaction.SendParams.md#populateappcallresources)
64 |
65 | #### Defined in
66 |
67 | [src/types/transaction.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L140)
68 |
69 | ___
70 |
71 | ### sendParams
72 |
73 | • `Optional` **sendParams**: `Omit`\<[`SendTransactionParams`](types_transaction.SendTransactionParams.md), ``"fee"`` \| ``"maxFee"`` \| ``"skipSending"`` \| ``"atc"``\>
74 |
75 | **`Deprecated`**
76 |
77 | - set the parameters at the top level instead
78 | Any parameters to control the semantics of the send to the network
79 |
80 | #### Defined in
81 |
82 | [src/types/transaction.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L150)
83 |
84 | ___
85 |
86 | ### suppressLog
87 |
88 | • `Optional` **suppressLog**: `boolean`
89 |
90 | Whether to suppress log messages from transaction send, default: do not suppress.
91 |
92 | #### Inherited from
93 |
94 | [SendParams](types_transaction.SendParams.md).[suppressLog](types_transaction.SendParams.md#suppresslog)
95 |
96 | #### Defined in
97 |
98 | [src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138)
99 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:event-emitter.md:
--------------------------------------------------------------------------------
```markdown
1 | # Event Emitter
2 |
3 | The Event Emitter is a capability provided by AlgoKit Utils that allows for asynchronous event handling of lifecycle events. It provides a flexible mechanism for emitting and listening to custom events, which can be particularly useful for debugging and extending functionality not available in the `algokit-utils-ts` package.
4 |
5 | ## `AsyncEventEmitter`
6 |
7 | The [`AsyncEventEmitter`](../code/classes/types_async_event_emitter.AsyncEventEmitter.md) is a class that manages asynchronous event emission and subscription.
8 |
9 | To use the `AsyncEventEmitter`, you can import it directly:
10 |
11 | ```typescript
12 | import { AsyncEventEmitter } from '@algorandfoundation/algokit-utils/types/async-event-emitter'
13 |
14 | const emitter = new AsyncEventEmitter()
15 | ```
16 |
17 | ## Event Types
18 |
19 | The `EventType` enum defines the built-in event types:
20 |
21 | ```typescript
22 | enum EventType {
23 | TxnGroupSimulated = 'TxnGroupSimulated',
24 | AppCompiled = 'AppCompiled',
25 | }
26 | ```
27 |
28 | ## Emitting Events
29 |
30 | To emit an event, use the `emitAsync` method:
31 |
32 | ```typescript
33 | await emitter.emitAsync(EventType.AppCompiled, compilationData)
34 | ```
35 |
36 | ## Listening to Events
37 |
38 | There are two ways to listen to events:
39 |
40 | ### Using `on`
41 |
42 | The `on` method adds a listener that will be called every time the specified event is emitted:
43 |
44 | ```typescript
45 | emitter.on(EventType.AppCompiled, async (data) => {
46 | console.log('App compiled:', data)
47 | })
48 | ```
49 |
50 | ### Using `once`
51 |
52 | The `once` method adds a listener that will be called only once for the specified event:
53 |
54 | ```typescript
55 | emitter.once(EventType.TxnGroupSimulated, async (data) => {
56 | console.log('Transaction group simulated:', data)
57 | })
58 | ```
59 |
60 | ## Removing Listeners
61 |
62 | To remove a listener, use the `removeListener` or `off` method:
63 |
64 | ```typescript
65 | const listener = async (data) => {
66 | console.log('Event received:', data)
67 | }
68 |
69 | emitter.on(EventType.AppCompiled, listener)
70 |
71 | // Later, when you want to remove the listener:
72 | emitter.removeListener(EventType.AppCompiled, listener)
73 | // or
74 | emitter.off(EventType.AppCompiled, listener)
75 | ```
76 |
77 | ## Custom Events
78 |
79 | While the current implementation primarily focuses on debugging events, the `AsyncEventEmitter` is designed to be extensible. You can emit and listen to custom events by using string keys:
80 |
81 | ```typescript
82 | emitter.on('customEvent', async (data) => {
83 | console.log('Custom event received:', data)
84 | })
85 |
86 | await emitter.emitAsync('customEvent', { foo: 'bar' })
87 | ```
88 |
89 | ## Integration with `algokit-utils-ts-debug`
90 |
91 | The events emitted by `AsyncEventEmitter` are particularly useful when used in conjunction with the `algokit-utils-ts-debug` package. This package listens for these events and persists relevant debugging information to the user's AlgoKit project filesystem, facilitating integration with the AVM debugger extension.
92 |
93 | ## Extending Functionality
94 |
95 | The `AsyncEventEmitter` can serve as a foundation for building custom AlgoKit Utils extensions. By listening to the activity events emitted by the utils-ts package, you can create additional functionality tailored to your specific needs.
96 |
97 | If you have suggestions for new event types or additional functionality, please open a PR or submit an issue on the AlgoKit Utils GitHub repository.
98 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.AssetHoldingsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / AssetHoldingsResponse
2 |
3 | # Class: AssetHoldingsResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).AssetHoldingsResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`AssetHoldingsResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.AssetHoldingsResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [assets](indexerModels.AssetHoldingsResponse.md#assets)
22 | - [attribute\_map](indexerModels.AssetHoldingsResponse.md#attribute_map)
23 | - [currentRound](indexerModels.AssetHoldingsResponse.md#currentround)
24 | - [nextToken](indexerModels.AssetHoldingsResponse.md#nexttoken)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.AssetHoldingsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.AssetHoldingsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new AssetHoldingsResponse**(`«destructured»`)
36 |
37 | Creates a new `AssetHoldingsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `assets` | [`AssetHolding`](indexerModels.AssetHolding.md)[] |
45 | | › `currentRound` | `number` \| `bigint` |
46 | | › `nextToken?` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:1751
55 |
56 | ## Properties
57 |
58 | ### assets
59 |
60 | • **assets**: [`AssetHolding`](indexerModels.AssetHolding.md)[]
61 |
62 | #### Defined in
63 |
64 | client/v2/indexer/models/types.ts:1731
65 |
66 | ___
67 |
68 | ### attribute\_map
69 |
70 | • **attribute\_map**: `Record`\<`string`, `string`\>
71 |
72 | #### Inherited from
73 |
74 | BaseModel.attribute\_map
75 |
76 | #### Defined in
77 |
78 | client/v2/basemodel.ts:56
79 |
80 | ___
81 |
82 | ### currentRound
83 |
84 | • **currentRound**: `number` \| `bigint`
85 |
86 | Round at which the results were computed.
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:1736
91 |
92 | ___
93 |
94 | ### nextToken
95 |
96 | • `Optional` **nextToken**: `string`
97 |
98 | Used for pagination, when making another request provide this token with the
99 | next parameter.
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:1742
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AssetHoldingsResponse`](indexerModels.AssetHoldingsResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`AssetHoldingsResponse`](indexerModels.AssetHoldingsResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:1773
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.ApplicationsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / ApplicationsResponse
2 |
3 | # Class: ApplicationsResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).ApplicationsResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`ApplicationsResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.ApplicationsResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [applications](indexerModels.ApplicationsResponse.md#applications)
22 | - [attribute\_map](indexerModels.ApplicationsResponse.md#attribute_map)
23 | - [currentRound](indexerModels.ApplicationsResponse.md#currentround)
24 | - [nextToken](indexerModels.ApplicationsResponse.md#nexttoken)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.ApplicationsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.ApplicationsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new ApplicationsResponse**(`«destructured»`)
36 |
37 | Creates a new `ApplicationsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `applications` | [`Application`](indexerModels.Application.md)[] |
45 | | › `currentRound` | `number` \| `bigint` |
46 | | › `nextToken?` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:1426
55 |
56 | ## Properties
57 |
58 | ### applications
59 |
60 | • **applications**: [`Application`](indexerModels.Application.md)[]
61 |
62 | #### Defined in
63 |
64 | client/v2/indexer/models/types.ts:1406
65 |
66 | ___
67 |
68 | ### attribute\_map
69 |
70 | • **attribute\_map**: `Record`\<`string`, `string`\>
71 |
72 | #### Inherited from
73 |
74 | BaseModel.attribute\_map
75 |
76 | #### Defined in
77 |
78 | client/v2/basemodel.ts:56
79 |
80 | ___
81 |
82 | ### currentRound
83 |
84 | • **currentRound**: `number` \| `bigint`
85 |
86 | Round at which the results were computed.
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:1411
91 |
92 | ___
93 |
94 | ### nextToken
95 |
96 | • `Optional` **nextToken**: `string`
97 |
98 | Used for pagination, when making another request provide this token with the
99 | next parameter.
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:1417
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`ApplicationsResponse`](indexerModels.ApplicationsResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`ApplicationsResponse`](indexerModels.ApplicationsResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:1448
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.TransactionsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / TransactionsResponse
2 |
3 | # Class: TransactionsResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).TransactionsResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`TransactionsResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.TransactionsResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.TransactionsResponse.md#attribute_map)
22 | - [currentRound](indexerModels.TransactionsResponse.md#currentround)
23 | - [nextToken](indexerModels.TransactionsResponse.md#nexttoken)
24 | - [transactions](indexerModels.TransactionsResponse.md#transactions)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.TransactionsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.TransactionsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new TransactionsResponse**(`«destructured»`)
36 |
37 | Creates a new `TransactionsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `currentRound` | `number` \| `bigint` |
45 | | › `nextToken?` | `string` |
46 | | › `transactions` | [`Transaction`](indexerModels.Transaction.md)[] |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:5741
55 |
56 | ## Properties
57 |
58 | ### attribute\_map
59 |
60 | • **attribute\_map**: `Record`\<`string`, `string`\>
61 |
62 | #### Inherited from
63 |
64 | BaseModel.attribute\_map
65 |
66 | #### Defined in
67 |
68 | client/v2/basemodel.ts:56
69 |
70 | ___
71 |
72 | ### currentRound
73 |
74 | • **currentRound**: `number` \| `bigint`
75 |
76 | Round at which the results were computed.
77 |
78 | #### Defined in
79 |
80 | client/v2/indexer/models/types.ts:5724
81 |
82 | ___
83 |
84 | ### nextToken
85 |
86 | • `Optional` **nextToken**: `string`
87 |
88 | Used for pagination, when making another request provide this token with the
89 | next parameter.
90 |
91 | #### Defined in
92 |
93 | client/v2/indexer/models/types.ts:5732
94 |
95 | ___
96 |
97 | ### transactions
98 |
99 | • **transactions**: [`Transaction`](indexerModels.Transaction.md)[]
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:5726
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionsResponse`](indexerModels.TransactionsResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`TransactionsResponse`](indexerModels.TransactionsResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:5763
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.ParticipationUpdates.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / ParticipationUpdates
2 |
3 | # Class: ParticipationUpdates
4 |
5 | [indexerModels](../modules/indexerModels.md).ParticipationUpdates
6 |
7 | Participation account data that needs to be checked/acted on by the network.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`ParticipationUpdates`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](indexerModels.ParticipationUpdates.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [absentParticipationAccounts](indexerModels.ParticipationUpdates.md#absentparticipationaccounts)
24 | - [attribute\_map](indexerModels.ParticipationUpdates.md#attribute_map)
25 | - [expiredParticipationAccounts](indexerModels.ParticipationUpdates.md#expiredparticipationaccounts)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](indexerModels.ParticipationUpdates.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](indexerModels.ParticipationUpdates.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new ParticipationUpdates**(`«destructured»`)
37 |
38 | Creates a new `ParticipationUpdates` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `absentParticipationAccounts?` | `string`[] |
46 | | › `expiredParticipationAccounts?` | `string`[] |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:3432
55 |
56 | ## Properties
57 |
58 | ### absentParticipationAccounts
59 |
60 | • `Optional` **absentParticipationAccounts**: `string`[]
61 |
62 | (partupabs) a list of online accounts that need to be suspended.
63 |
64 | #### Defined in
65 |
66 | client/v2/indexer/models/types.ts:3418
67 |
68 | ___
69 |
70 | ### attribute\_map
71 |
72 | • **attribute\_map**: `Record`\<`string`, `string`\>
73 |
74 | #### Inherited from
75 |
76 | BaseModel.attribute\_map
77 |
78 | #### Defined in
79 |
80 | client/v2/basemodel.ts:56
81 |
82 | ___
83 |
84 | ### expiredParticipationAccounts
85 |
86 | • `Optional` **expiredParticipationAccounts**: `string`[]
87 |
88 | (partupdrmv) a list of online accounts that needs to be converted to offline
89 | since their participation key expired.
90 |
91 | #### Defined in
92 |
93 | client/v2/indexer/models/types.ts:3424
94 |
95 | ## Methods
96 |
97 | ### get\_obj\_for\_encoding
98 |
99 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
100 |
101 | Get an object ready for encoding to either JSON or msgpack.
102 |
103 | #### Parameters
104 |
105 | | Name | Type | Default value | Description |
106 | | :------ | :------ | :------ | :------ |
107 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
108 |
109 | #### Returns
110 |
111 | `Record`\<`string`, `any`\>
112 |
113 | #### Inherited from
114 |
115 | BaseModel.get\_obj\_for\_encoding
116 |
117 | #### Defined in
118 |
119 | client/v2/basemodel.ts:65
120 |
121 | ___
122 |
123 | ### from\_obj\_for\_encoding
124 |
125 | ▸ `Static` **from_obj_for_encoding**(`data`): [`ParticipationUpdates`](indexerModels.ParticipationUpdates.md)
126 |
127 | #### Parameters
128 |
129 | | Name | Type |
130 | | :------ | :------ |
131 | | `data` | `Record`\<`string`, `any`\> |
132 |
133 | #### Returns
134 |
135 | [`ParticipationUpdates`](indexerModels.ParticipationUpdates.md)
136 |
137 | #### Defined in
138 |
139 | client/v2/indexer/models/types.ts:3450
140 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.BlockUpgradeVote.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / BlockUpgradeVote
2 |
3 | # Class: BlockUpgradeVote
4 |
5 | [indexerModels](../modules/indexerModels.md).BlockUpgradeVote
6 |
7 | Fields relating to voting for a protocol upgrade.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BlockUpgradeVote`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](indexerModels.BlockUpgradeVote.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](indexerModels.BlockUpgradeVote.md#attribute_map)
24 | - [upgradeApprove](indexerModels.BlockUpgradeVote.md#upgradeapprove)
25 | - [upgradeDelay](indexerModels.BlockUpgradeVote.md#upgradedelay)
26 | - [upgradePropose](indexerModels.BlockUpgradeVote.md#upgradepropose)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](indexerModels.BlockUpgradeVote.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](indexerModels.BlockUpgradeVote.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new BlockUpgradeVote**(`«destructured»`)
38 |
39 | Creates a new `BlockUpgradeVote` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `upgradeApprove?` | `boolean` |
47 | | › `upgradeDelay?` | `number` \| `bigint` |
48 | | › `upgradePropose?` | `string` |
49 |
50 | #### Overrides
51 |
52 | BaseModel.constructor
53 |
54 | #### Defined in
55 |
56 | client/v2/indexer/models/types.ts:2704
57 |
58 | ## Properties
59 |
60 | ### attribute\_map
61 |
62 | • **attribute\_map**: `Record`\<`string`, `string`\>
63 |
64 | #### Inherited from
65 |
66 | BaseModel.attribute\_map
67 |
68 | #### Defined in
69 |
70 | client/v2/basemodel.ts:56
71 |
72 | ___
73 |
74 | ### upgradeApprove
75 |
76 | • `Optional` **upgradeApprove**: `boolean`
77 |
78 | (upgradeyes) Indicates a yes vote for the current proposal.
79 |
80 | #### Defined in
81 |
82 | client/v2/indexer/models/types.ts:2686
83 |
84 | ___
85 |
86 | ### upgradeDelay
87 |
88 | • `Optional` **upgradeDelay**: `number` \| `bigint`
89 |
90 | (upgradedelay) Indicates the time between acceptance and execution.
91 |
92 | #### Defined in
93 |
94 | client/v2/indexer/models/types.ts:2691
95 |
96 | ___
97 |
98 | ### upgradePropose
99 |
100 | • `Optional` **upgradePropose**: `string`
101 |
102 | (upgradeprop) Indicates a proposed upgrade.
103 |
104 | #### Defined in
105 |
106 | client/v2/indexer/models/types.ts:2696
107 |
108 | ## Methods
109 |
110 | ### get\_obj\_for\_encoding
111 |
112 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
113 |
114 | Get an object ready for encoding to either JSON or msgpack.
115 |
116 | #### Parameters
117 |
118 | | Name | Type | Default value | Description |
119 | | :------ | :------ | :------ | :------ |
120 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
121 |
122 | #### Returns
123 |
124 | `Record`\<`string`, `any`\>
125 |
126 | #### Inherited from
127 |
128 | BaseModel.get\_obj\_for\_encoding
129 |
130 | #### Defined in
131 |
132 | client/v2/basemodel.ts:65
133 |
134 | ___
135 |
136 | ### from\_obj\_for\_encoding
137 |
138 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BlockUpgradeVote`](indexerModels.BlockUpgradeVote.md)
139 |
140 | #### Parameters
141 |
142 | | Name | Type |
143 | | :------ | :------ |
144 | | `data` | `Record`\<`string`, `any`\> |
145 |
146 | #### Returns
147 |
148 | [`BlockUpgradeVote`](indexerModels.BlockUpgradeVote.md)
149 |
150 | #### Defined in
151 |
152 | client/v2/indexer/models/types.ts:2726
153 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.StateProofReveal.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / StateProofReveal
2 |
3 | # Class: StateProofReveal
4 |
5 | [indexerModels](../modules/indexerModels.md).StateProofReveal
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`StateProofReveal`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.StateProofReveal.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.StateProofReveal.md#attribute_map)
22 | - [participant](indexerModels.StateProofReveal.md#participant)
23 | - [position](indexerModels.StateProofReveal.md#position)
24 | - [sigSlot](indexerModels.StateProofReveal.md#sigslot)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.StateProofReveal.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.StateProofReveal.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new StateProofReveal**(`«destructured»`)
36 |
37 | Creates a new `StateProofReveal` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `participant?` | [`StateProofParticipant`](indexerModels.StateProofParticipant.md) |
45 | | › `position?` | `number` \| `bigint` |
46 | | › `sigSlot?` | [`StateProofSigSlot`](indexerModels.StateProofSigSlot.md) |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:3653
55 |
56 | ## Properties
57 |
58 | ### attribute\_map
59 |
60 | • **attribute\_map**: `Record`\<`string`, `string`\>
61 |
62 | #### Inherited from
63 |
64 | BaseModel.attribute\_map
65 |
66 | #### Defined in
67 |
68 | client/v2/basemodel.ts:56
69 |
70 | ___
71 |
72 | ### participant
73 |
74 | • `Optional` **participant**: [`StateProofParticipant`](indexerModels.StateProofParticipant.md)
75 |
76 | (p)
77 |
78 | #### Defined in
79 |
80 | client/v2/indexer/models/types.ts:3633
81 |
82 | ___
83 |
84 | ### position
85 |
86 | • `Optional` **position**: `number` \| `bigint`
87 |
88 | The position in the signature and participants arrays corresponding to this
89 | entry.
90 |
91 | #### Defined in
92 |
93 | client/v2/indexer/models/types.ts:3639
94 |
95 | ___
96 |
97 | ### sigSlot
98 |
99 | • `Optional` **sigSlot**: [`StateProofSigSlot`](indexerModels.StateProofSigSlot.md)
100 |
101 | (s)
102 |
103 | #### Defined in
104 |
105 | client/v2/indexer/models/types.ts:3644
106 |
107 | ## Methods
108 |
109 | ### get\_obj\_for\_encoding
110 |
111 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
112 |
113 | Get an object ready for encoding to either JSON or msgpack.
114 |
115 | #### Parameters
116 |
117 | | Name | Type | Default value | Description |
118 | | :------ | :------ | :------ | :------ |
119 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
120 |
121 | #### Returns
122 |
123 | `Record`\<`string`, `any`\>
124 |
125 | #### Inherited from
126 |
127 | BaseModel.get\_obj\_for\_encoding
128 |
129 | #### Defined in
130 |
131 | client/v2/basemodel.ts:65
132 |
133 | ___
134 |
135 | ### from\_obj\_for\_encoding
136 |
137 | ▸ `Static` **from_obj_for_encoding**(`data`): [`StateProofReveal`](indexerModels.StateProofReveal.md)
138 |
139 | #### Parameters
140 |
141 | | Name | Type |
142 | | :------ | :------ |
143 | | `data` | `Record`\<`string`, `any`\> |
144 |
145 | #### Returns
146 |
147 | [`StateProofReveal`](indexerModels.StateProofReveal.md)
148 |
149 | #### Defined in
150 |
151 | client/v2/indexer/models/types.ts:3675
152 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.AssetBalancesResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / AssetBalancesResponse
2 |
3 | # Class: AssetBalancesResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).AssetBalancesResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`AssetBalancesResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.AssetBalancesResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.AssetBalancesResponse.md#attribute_map)
22 | - [balances](indexerModels.AssetBalancesResponse.md#balances)
23 | - [currentRound](indexerModels.AssetBalancesResponse.md#currentround)
24 | - [nextToken](indexerModels.AssetBalancesResponse.md#nexttoken)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.AssetBalancesResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.AssetBalancesResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new AssetBalancesResponse**(`«destructured»`)
36 |
37 | Creates a new `AssetBalancesResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `balances` | [`MiniAssetHolding`](indexerModels.MiniAssetHolding.md)[] |
45 | | › `currentRound` | `number` \| `bigint` |
46 | | › `nextToken?` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:1583
55 |
56 | ## Properties
57 |
58 | ### attribute\_map
59 |
60 | • **attribute\_map**: `Record`\<`string`, `string`\>
61 |
62 | #### Inherited from
63 |
64 | BaseModel.attribute\_map
65 |
66 | #### Defined in
67 |
68 | client/v2/basemodel.ts:56
69 |
70 | ___
71 |
72 | ### balances
73 |
74 | • **balances**: [`MiniAssetHolding`](indexerModels.MiniAssetHolding.md)[]
75 |
76 | #### Defined in
77 |
78 | client/v2/indexer/models/types.ts:1563
79 |
80 | ___
81 |
82 | ### currentRound
83 |
84 | • **currentRound**: `number` \| `bigint`
85 |
86 | Round at which the results were computed.
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:1568
91 |
92 | ___
93 |
94 | ### nextToken
95 |
96 | • `Optional` **nextToken**: `string`
97 |
98 | Used for pagination, when making another request provide this token with the
99 | next parameter.
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:1574
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AssetBalancesResponse`](indexerModels.AssetBalancesResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`AssetBalancesResponse`](indexerModels.AssetBalancesResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:1605
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:ABIArrayStaticType.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / ABIArrayStaticType
2 |
3 | # Class: ABIArrayStaticType
4 |
5 | ## Hierarchy
6 |
7 | - [`ABIType`](ABIType.md)
8 |
9 | ↳ **`ABIArrayStaticType`**
10 |
11 | ## Table of contents
12 |
13 | ### Constructors
14 |
15 | - [constructor](ABIArrayStaticType.md#constructor)
16 |
17 | ### Properties
18 |
19 | - [childType](ABIArrayStaticType.md#childtype)
20 | - [staticLength](ABIArrayStaticType.md#staticlength)
21 |
22 | ### Methods
23 |
24 | - [byteLen](ABIArrayStaticType.md#bytelen)
25 | - [decode](ABIArrayStaticType.md#decode)
26 | - [encode](ABIArrayStaticType.md#encode)
27 | - [equals](ABIArrayStaticType.md#equals)
28 | - [isDynamic](ABIArrayStaticType.md#isdynamic)
29 | - [toABITupleType](ABIArrayStaticType.md#toabitupletype)
30 | - [toString](ABIArrayStaticType.md#tostring)
31 | - [from](ABIArrayStaticType.md#from)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new ABIArrayStaticType**(`argType`, `arrayLength`)
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `argType` | [`ABIType`](ABIType.md) |
44 | | `arrayLength` | `number` |
45 |
46 | #### Overrides
47 |
48 | [ABIType](ABIType.md).[constructor](ABIType.md#constructor)
49 |
50 | #### Defined in
51 |
52 | abi/abi_type.ts:421
53 |
54 | ## Properties
55 |
56 | ### childType
57 |
58 | • **childType**: [`ABIType`](ABIType.md)
59 |
60 | #### Defined in
61 |
62 | abi/abi_type.ts:418
63 |
64 | ___
65 |
66 | ### staticLength
67 |
68 | • **staticLength**: `number`
69 |
70 | #### Defined in
71 |
72 | abi/abi_type.ts:419
73 |
74 | ## Methods
75 |
76 | ### byteLen
77 |
78 | ▸ **byteLen**(): `number`
79 |
80 | #### Returns
81 |
82 | `number`
83 |
84 | #### Overrides
85 |
86 | [ABIType](ABIType.md).[byteLen](ABIType.md#bytelen)
87 |
88 | #### Defined in
89 |
90 | abi/abi_type.ts:448
91 |
92 | ___
93 |
94 | ### decode
95 |
96 | ▸ **decode**(`byteString`): [`ABIValue`](../modules.md#abivalue)[]
97 |
98 | #### Parameters
99 |
100 | | Name | Type |
101 | | :------ | :------ |
102 | | `byteString` | `Uint8Array` |
103 |
104 | #### Returns
105 |
106 | [`ABIValue`](../modules.md#abivalue)[]
107 |
108 | #### Overrides
109 |
110 | [ABIType](ABIType.md).[decode](ABIType.md#decode)
111 |
112 | #### Defined in
113 |
114 | abi/abi_type.ts:468
115 |
116 | ___
117 |
118 | ### encode
119 |
120 | ▸ **encode**(`value`): `Uint8Array`
121 |
122 | #### Parameters
123 |
124 | | Name | Type |
125 | | :------ | :------ |
126 | | `value` | [`ABIValue`](../modules.md#abivalue) |
127 |
128 | #### Returns
129 |
130 | `Uint8Array`
131 |
132 | #### Overrides
133 |
134 | [ABIType](ABIType.md).[encode](ABIType.md#encode)
135 |
136 | #### Defined in
137 |
138 | abi/abi_type.ts:455
139 |
140 | ___
141 |
142 | ### equals
143 |
144 | ▸ **equals**(`other`): `boolean`
145 |
146 | #### Parameters
147 |
148 | | Name | Type |
149 | | :------ | :------ |
150 | | `other` | [`ABIType`](ABIType.md) |
151 |
152 | #### Returns
153 |
154 | `boolean`
155 |
156 | #### Overrides
157 |
158 | [ABIType](ABIType.md).[equals](ABIType.md#equals)
159 |
160 | #### Defined in
161 |
162 | abi/abi_type.ts:436
163 |
164 | ___
165 |
166 | ### isDynamic
167 |
168 | ▸ **isDynamic**(): `boolean`
169 |
170 | #### Returns
171 |
172 | `boolean`
173 |
174 | #### Overrides
175 |
176 | [ABIType](ABIType.md).[isDynamic](ABIType.md#isdynamic)
177 |
178 | #### Defined in
179 |
180 | abi/abi_type.ts:444
181 |
182 | ___
183 |
184 | ### toABITupleType
185 |
186 | ▸ **toABITupleType**(): [`ABITupleType`](ABITupleType.md)
187 |
188 | #### Returns
189 |
190 | [`ABITupleType`](ABITupleType.md)
191 |
192 | #### Defined in
193 |
194 | abi/abi_type.ts:473
195 |
196 | ___
197 |
198 | ### toString
199 |
200 | ▸ **toString**(): `string`
201 |
202 | #### Returns
203 |
204 | `string`
205 |
206 | #### Overrides
207 |
208 | [ABIType](ABIType.md).[toString](ABIType.md#tostring)
209 |
210 | #### Defined in
211 |
212 | abi/abi_type.ts:432
213 |
214 | ___
215 |
216 | ### from
217 |
218 | ▸ `Static` **from**(`str`): [`ABIType`](ABIType.md)
219 |
220 | #### Parameters
221 |
222 | | Name | Type |
223 | | :------ | :------ |
224 | | `str` | `string` |
225 |
226 | #### Returns
227 |
228 | [`ABIType`](ABIType.md)
229 |
230 | #### Inherited from
231 |
232 | [ABIType](ABIType.md).[from](ABIType.md#from)
233 |
234 | #### Defined in
235 |
236 | abi/abi_type.ts:57
237 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.DryrunState.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / DryrunState
2 |
3 | # Class: DryrunState
4 |
5 | [modelsv2](../modules/modelsv2.md).DryrunState
6 |
7 | Stores the TEAL eval step data
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`DryrunState`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.DryrunState.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.DryrunState.md#attribute_map)
24 | - [error](modelsv2.DryrunState.md#error)
25 | - [line](modelsv2.DryrunState.md#line)
26 | - [pc](modelsv2.DryrunState.md#pc)
27 | - [scratch](modelsv2.DryrunState.md#scratch)
28 | - [stack](modelsv2.DryrunState.md#stack)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](modelsv2.DryrunState.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](modelsv2.DryrunState.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new DryrunState**(`«destructured»`)
40 |
41 | Creates a new `DryrunState` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `error?` | `string` |
49 | | › `line` | `number` \| `bigint` |
50 | | › `pc` | `number` \| `bigint` |
51 | | › `scratch?` | [`TealValue`](modelsv2.TealValue.md)[] |
52 | | › `stack` | [`TealValue`](modelsv2.TealValue.md)[] |
53 |
54 | #### Overrides
55 |
56 | BaseModel.constructor
57 |
58 | #### Defined in
59 |
60 | client/v2/algod/models/types.ts:2898
61 |
62 | ## Properties
63 |
64 | ### attribute\_map
65 |
66 | • **attribute\_map**: `Record`\<`string`, `string`\>
67 |
68 | #### Inherited from
69 |
70 | BaseModel.attribute\_map
71 |
72 | #### Defined in
73 |
74 | client/v2/basemodel.ts:56
75 |
76 | ___
77 |
78 | ### error
79 |
80 | • `Optional` **error**: `string`
81 |
82 | Evaluation error if any
83 |
84 | #### Defined in
85 |
86 | client/v2/algod/models/types.ts:2886
87 |
88 | ___
89 |
90 | ### line
91 |
92 | • **line**: `number` \| `bigint`
93 |
94 | Line number
95 |
96 | #### Defined in
97 |
98 | client/v2/algod/models/types.ts:2874
99 |
100 | ___
101 |
102 | ### pc
103 |
104 | • **pc**: `number` \| `bigint`
105 |
106 | Program counter
107 |
108 | #### Defined in
109 |
110 | client/v2/algod/models/types.ts:2879
111 |
112 | ___
113 |
114 | ### scratch
115 |
116 | • `Optional` **scratch**: [`TealValue`](modelsv2.TealValue.md)[]
117 |
118 | #### Defined in
119 |
120 | client/v2/algod/models/types.ts:2888
121 |
122 | ___
123 |
124 | ### stack
125 |
126 | • **stack**: [`TealValue`](modelsv2.TealValue.md)[]
127 |
128 | #### Defined in
129 |
130 | client/v2/algod/models/types.ts:2881
131 |
132 | ## Methods
133 |
134 | ### get\_obj\_for\_encoding
135 |
136 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
137 |
138 | Get an object ready for encoding to either JSON or msgpack.
139 |
140 | #### Parameters
141 |
142 | | Name | Type | Default value | Description |
143 | | :------ | :------ | :------ | :------ |
144 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
145 |
146 | #### Returns
147 |
148 | `Record`\<`string`, `any`\>
149 |
150 | #### Inherited from
151 |
152 | BaseModel.get\_obj\_for\_encoding
153 |
154 | #### Defined in
155 |
156 | client/v2/basemodel.ts:65
157 |
158 | ___
159 |
160 | ### from\_obj\_for\_encoding
161 |
162 | ▸ `Static` **from_obj_for_encoding**(`data`): [`DryrunState`](modelsv2.DryrunState.md)
163 |
164 | #### Parameters
165 |
166 | | Name | Type |
167 | | :------ | :------ |
168 | | `data` | `Record`\<`string`, `any`\> |
169 |
170 | #### Returns
171 |
172 | [`DryrunState`](modelsv2.DryrunState.md)
173 |
174 | #### Defined in
175 |
176 | client/v2/algod/models/types.ts:2928
177 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/tealscript:guides_getting_started.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | title: Getting Started
3 | ---
4 |
5 | ## Using Algokit
6 |
7 | The recommended way to get started with TEALScript is to use the Algokit template:
8 |
9 | ```
10 | algokit init -t tealscript
11 | ```
12 |
13 | This will set up a project repository with TEALScript, ESLint, algokit generate, and some tests.
14 |
15 | More information about how to use the template is provided in the template's [README](https://github.com/algorandfoundation/tealscript-algokit-template/blob/master/template_content/README.md).
16 |
17 |
18 | ## Manual Installation
19 |
20 | If you do not wish to use the above Algokit template, you can manually add TEALScript to any project with npm.
21 |
22 | ### Installing TEALScript
23 |
24 | TEALScript can be installed from npm via `npm install @algorandfoundation/tealscript`.
25 |
26 | ### Writing First Contract
27 |
28 | To write your first smart contract, import the `Contract` class and create a new class that extends `Contract`.
29 |
30 | ```ts
31 | import { Contract } from '@algorandfoundation/tealscript';
32 |
33 | class FirstContract extends Contract {
34 | ```
35 |
36 | This is where all of the method definitions will go. You can then write a method that is typed and written like a regular TypeScript method:
37 |
38 | ```ts
39 | import { Contract } from '@algorandfoundation/tealscript';
40 |
41 | class FirstContract extends Contract {
42 | add(a: uint64, b: uint64): uint64 {
43 | return a + b
44 | }
45 | }
46 | ```
47 |
48 | ### Compiling
49 |
50 | To compile a TEALScript smart contract, run `npx tealscript <file> [artifact directory]`
51 |
52 | * `<file>` is the .ts file containing your TEALScript source code
53 | * `[artifact directory]` is an optional directory to output the artifacts generated by TEALScript. If a directory isn't given, the current working directory will be used.
54 |
55 | To learn more about method definitions and decorators for specific smart contract actions (such as creating, updating, or deleting the contract) see [methods](./methods.md).
56 |
57 | ### ESLint
58 |
59 | **Note:** This is assuming you are extending the `airbnb-base`. Other standards might have additional rules that need to be disabled or modified.
60 |
61 | If you are using ESLint, the following rules must be disabled:
62 |
63 | | ESLint Rule | Reason |
64 | | ------------------------ | ----------------------------------------------------------------- |
65 | | `object-shorthand` | Object shorthand is not yet supported by TEALScript |
66 | | `no-undef` | The global TEALScript functions are not actually defined anywhere |
67 | | `class-methods-use-this` | Not all methods will actually use `this` |
68 | | `max-classes-per-file` | Multiple contracts can be defined in a single file |
69 | | `no-bitwise` | Bitwise operations are supported by TEALScript |
70 |
71 | #### .eslintrc.js
72 |
73 | Rather than disabling these directly in the file, you can also create some rule overrides in your `.eslintrc.js`. For example, if you end all of your TEALScript contracts with `.algo.ts` you can add this to your config:
74 |
75 | ```js
76 | overrides: [
77 | {
78 | files: ['*.algo.ts'],
79 | rules: {
80 | 'object-shorthand': 'off',
81 | 'class-methods-use-this': 'off',
82 | 'no-undef': 'off',
83 | 'max-classes-per-file': 'off',
84 | 'no-bitwise': 'off',
85 | },
86 | }
87 | ],
88 | ```
89 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.TransactionAssetFreeze.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / TransactionAssetFreeze
2 |
3 | # Class: TransactionAssetFreeze
4 |
5 | [indexerModels](../modules/indexerModels.md).TransactionAssetFreeze
6 |
7 | Fields for an asset freeze transaction.
8 | Definition:
9 | data/transactions/asset.go : AssetFreezeTxnFields
10 |
11 | ## Hierarchy
12 |
13 | - `default`
14 |
15 | ↳ **`TransactionAssetFreeze`**
16 |
17 | ## Table of contents
18 |
19 | ### Constructors
20 |
21 | - [constructor](indexerModels.TransactionAssetFreeze.md#constructor)
22 |
23 | ### Properties
24 |
25 | - [address](indexerModels.TransactionAssetFreeze.md#address)
26 | - [assetId](indexerModels.TransactionAssetFreeze.md#assetid)
27 | - [attribute\_map](indexerModels.TransactionAssetFreeze.md#attribute_map)
28 | - [newFreezeStatus](indexerModels.TransactionAssetFreeze.md#newfreezestatus)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](indexerModels.TransactionAssetFreeze.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](indexerModels.TransactionAssetFreeze.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new TransactionAssetFreeze**(`«destructured»`)
40 |
41 | Creates a new `TransactionAssetFreeze` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `address` | `string` |
49 | | › `assetId` | `number` \| `bigint` |
50 | | › `newFreezeStatus` | `boolean` |
51 |
52 | #### Overrides
53 |
54 | BaseModel.constructor
55 |
56 | #### Defined in
57 |
58 | client/v2/indexer/models/types.ts:4943
59 |
60 | ## Properties
61 |
62 | ### address
63 |
64 | • **address**: `string`
65 |
66 | (fadd) Address of the account whose asset is being frozen or thawed.
67 |
68 | #### Defined in
69 |
70 | client/v2/indexer/models/types.ts:4925
71 |
72 | ___
73 |
74 | ### assetId
75 |
76 | • **assetId**: `number` \| `bigint`
77 |
78 | (faid) ID of the asset being frozen or thawed.
79 |
80 | #### Defined in
81 |
82 | client/v2/indexer/models/types.ts:4930
83 |
84 | ___
85 |
86 | ### attribute\_map
87 |
88 | • **attribute\_map**: `Record`\<`string`, `string`\>
89 |
90 | #### Inherited from
91 |
92 | BaseModel.attribute\_map
93 |
94 | #### Defined in
95 |
96 | client/v2/basemodel.ts:56
97 |
98 | ___
99 |
100 | ### newFreezeStatus
101 |
102 | • **newFreezeStatus**: `boolean`
103 |
104 | (afrz) The new freeze status.
105 |
106 | #### Defined in
107 |
108 | client/v2/indexer/models/types.ts:4935
109 |
110 | ## Methods
111 |
112 | ### get\_obj\_for\_encoding
113 |
114 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
115 |
116 | Get an object ready for encoding to either JSON or msgpack.
117 |
118 | #### Parameters
119 |
120 | | Name | Type | Default value | Description |
121 | | :------ | :------ | :------ | :------ |
122 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
123 |
124 | #### Returns
125 |
126 | `Record`\<`string`, `any`\>
127 |
128 | #### Inherited from
129 |
130 | BaseModel.get\_obj\_for\_encoding
131 |
132 | #### Defined in
133 |
134 | client/v2/basemodel.ts:65
135 |
136 | ___
137 |
138 | ### from\_obj\_for\_encoding
139 |
140 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionAssetFreeze`](indexerModels.TransactionAssetFreeze.md)
141 |
142 | #### Parameters
143 |
144 | | Name | Type |
145 | | :------ | :------ |
146 | | `data` | `Record`\<`string`, `any`\> |
147 |
148 | #### Returns
149 |
150 | [`TransactionAssetFreeze`](indexerModels.TransactionAssetFreeze.md)
151 |
152 | #### Defined in
153 |
154 | client/v2/indexer/models/types.ts:4965
155 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.DryrunSource.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / DryrunSource
2 |
3 | # Class: DryrunSource
4 |
5 | [modelsv2](../modules/modelsv2.md).DryrunSource
6 |
7 | DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into
8 | transactions or application state.
9 |
10 | ## Hierarchy
11 |
12 | - `default`
13 |
14 | ↳ **`DryrunSource`**
15 |
16 | ## Table of contents
17 |
18 | ### Constructors
19 |
20 | - [constructor](modelsv2.DryrunSource.md#constructor)
21 |
22 | ### Properties
23 |
24 | - [appIndex](modelsv2.DryrunSource.md#appindex)
25 | - [attribute\_map](modelsv2.DryrunSource.md#attribute_map)
26 | - [fieldName](modelsv2.DryrunSource.md#fieldname)
27 | - [source](modelsv2.DryrunSource.md#source)
28 | - [txnIndex](modelsv2.DryrunSource.md#txnindex)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](modelsv2.DryrunSource.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](modelsv2.DryrunSource.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new DryrunSource**(`«destructured»`)
40 |
41 | Creates a new `DryrunSource` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `appIndex` | `number` \| `bigint` |
49 | | › `fieldName` | `string` |
50 | | › `source` | `string` |
51 | | › `txnIndex` | `number` \| `bigint` |
52 |
53 | #### Overrides
54 |
55 | BaseModel.constructor
56 |
57 | #### Defined in
58 |
59 | client/v2/algod/models/types.ts:2815
60 |
61 | ## Properties
62 |
63 | ### appIndex
64 |
65 | • **appIndex**: `number` \| `bigint`
66 |
67 | #### Defined in
68 |
69 | client/v2/algod/models/types.ts:2804
70 |
71 | ___
72 |
73 | ### attribute\_map
74 |
75 | • **attribute\_map**: `Record`\<`string`, `string`\>
76 |
77 | #### Inherited from
78 |
79 | BaseModel.attribute\_map
80 |
81 | #### Defined in
82 |
83 | client/v2/basemodel.ts:56
84 |
85 | ___
86 |
87 | ### fieldName
88 |
89 | • **fieldName**: `string`
90 |
91 | FieldName is what kind of sources this is. If lsig then it goes into the
92 | transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
93 | Approval Program or Clear State Program of application[this.AppIndex].
94 |
95 | #### Defined in
96 |
97 | client/v2/algod/models/types.ts:2798
98 |
99 | ___
100 |
101 | ### source
102 |
103 | • **source**: `string`
104 |
105 | #### Defined in
106 |
107 | client/v2/algod/models/types.ts:2800
108 |
109 | ___
110 |
111 | ### txnIndex
112 |
113 | • **txnIndex**: `number` \| `bigint`
114 |
115 | #### Defined in
116 |
117 | client/v2/algod/models/types.ts:2802
118 |
119 | ## Methods
120 |
121 | ### get\_obj\_for\_encoding
122 |
123 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
124 |
125 | Get an object ready for encoding to either JSON or msgpack.
126 |
127 | #### Parameters
128 |
129 | | Name | Type | Default value | Description |
130 | | :------ | :------ | :------ | :------ |
131 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
132 |
133 | #### Returns
134 |
135 | `Record`\<`string`, `any`\>
136 |
137 | #### Inherited from
138 |
139 | BaseModel.get\_obj\_for\_encoding
140 |
141 | #### Defined in
142 |
143 | client/v2/basemodel.ts:65
144 |
145 | ___
146 |
147 | ### from\_obj\_for\_encoding
148 |
149 | ▸ `Static` **from_obj_for_encoding**(`data`): [`DryrunSource`](modelsv2.DryrunSource.md)
150 |
151 | #### Parameters
152 |
153 | | Name | Type |
154 | | :------ | :------ |
155 | | `data` | `Record`\<`string`, `any`\> |
156 |
157 | #### Returns
158 |
159 | [`DryrunSource`](modelsv2.DryrunSource.md)
160 |
161 | #### Defined in
162 |
163 | client/v2/algod/models/types.ts:2841
164 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:amount.md:
--------------------------------------------------------------------------------
```markdown
1 | # Algo amount handling
2 |
3 | Algo amount handling is one of the core capabilities provided by AlgoKit Utils. It allows you to reliably and tersely specify amounts of microAlgo and Algo and safely convert between them.
4 |
5 | Any AlgoKit Utils function that needs an Algo amount will take an `AlgoAmount` object, which ensures that there is never any confusion about what value is being passed around. Whenever an AlgoKit Utils function calls into an underlying algosdk function, or if you need to take an `AlgoAmount` and pass it into an underlying algosdk function (per the [modularity principle](../README.md#core-principles)) you can safely and explicitly convert to microAlgo or Algo.
6 |
7 | To see some usage examples check out the [automated tests](../../src/types/amount.spec.ts). Alternatively, you see the [reference documentation](../code/classes/types_amount.AlgoAmount.md) for `AlgoAmount`.
8 |
9 | ## `AlgoAmount`
10 |
11 | The `AlgoAmount` class provides a safe wrapper around an underlying `number` amount of microAlgo where any value entering or existing the `AlgoAmount` class must be explicitly stated to be in microAlgo or Algo. This makes it much safer to handle Algo amounts rather than passing them around as raw `number`'s where it's easy to make a (potentially costly!) mistake and not perform a conversion when one is needed (or perform one when it shouldn't be!).
12 |
13 | To import the AlgoAmount class you can access it via:
14 |
15 | ```typescript
16 | import { AlgoAmount } from '@algorandfoundation/algokit-utils/types/amount'
17 | ```
18 |
19 | You may not need to import this type to use it though since there are also special methods that are exposed from the root AlgoKit Utils export and also others that extend the `number` protoype per below.
20 |
21 | ### Creating an `AlgoAmount`
22 |
23 | There are a few ways to create an `AlgoAmount`:
24 |
25 | - Algo
26 | - Constructor: `new AlgoAmount({algo: 10})`
27 | - Static helper: `AlgoAmount.algo(10)`
28 | - AlgoKit Helper: `algo(10)`
29 | - Number coersion: `(10).algo()` (note: you have to wrap the number in brackets or have it in a variable or function return, a raw number value can't have a method called on it)
30 | - microAlgo
31 | - Constructor: `new AlgoAmount({microAlgos: 10_000})`
32 | - Static helper: `AlgoAmount.algo(10)`
33 | - AlgoKit Helper: `microAlgo(10_000)`
34 | - Number coersion: `(10_000).microAlgo()` (note: you have to wrap the number in brackets or have it in a variable or function return, a raw number value can't have a method called on it)
35 |
36 | Note: per above, to use any of the versions that reference `AlgoAmount` type itself you need to import it:
37 |
38 | ```typescript
39 | import { AlgoAmount } from '@algorandfoundation/algokit-utils/types/amount'
40 | ```
41 |
42 | ### Extracting a value from `AlgoAmount`
43 |
44 | The `AlgoAmount` class has properties to return Algo and microAlgo:
45 |
46 | - `amount.algo` - Returns the value in Algo
47 | - `amount.microAlgo` - Returns the value in microAlgo
48 |
49 | `AlgoAmount` will coerce to a `number` automatically (in microAlgo), which is not recommended to be used outside of allowing you to use `AlgoAmount` objects in comparison operations such as `<` and `>=` etc.
50 |
51 | You can also call `.toString()` or use an `AlgoAmount` directly in string interpolation to convert it to a nice user-facing formatted amount expressed in microAlgo.
52 |
```
--------------------------------------------------------------------------------
/packages/server/src/tools/apiManager/ultrade/system.ts:
--------------------------------------------------------------------------------
```typescript
1 | import { Tool, ErrorCode, McpError } from '@modelcontextprotocol/sdk/types.js';
2 | import { ResponseProcessor } from '../../../utils/responseProcessor.js';
3 | import { env } from '../../../env.js';
4 |
5 | export const systemTools: Tool[] = [
6 | {
7 | name: 'api_ultrade_system_time',
8 | description: 'Get current system time',
9 | inputSchema: {
10 | type: 'object',
11 | properties: {}
12 | }
13 | },
14 | {
15 | name: 'api_ultrade_system_maintenance',
16 | description: 'Get system maintenance status',
17 | inputSchema: {
18 | type: 'object',
19 | properties: {}
20 | }
21 | },
22 | {
23 | name: 'api_ultrade_system_version',
24 | description: 'Get system version',
25 | inputSchema: {
26 | type: 'object',
27 | properties: {}
28 | }
29 | }
30 | ];
31 |
32 | async function getSystemTime(): Promise<any> {
33 | try {
34 | const response = await fetch(`${env.ultrade_api_url}/system/time`, {
35 | method: 'GET',
36 | headers: {
37 | 'Content-Type': 'application/json'
38 | }
39 | });
40 |
41 | if (!response.ok) {
42 | throw new McpError(
43 | ErrorCode.InternalError,
44 | `Ultrade API error: ${response.status} ${response.statusText}`
45 | );
46 | }
47 |
48 | return await response.json();
49 | } catch (error) {
50 | if (error instanceof McpError) {
51 | throw error;
52 | }
53 | throw new McpError(
54 | ErrorCode.InternalError,
55 | `Failed to get system time: ${error instanceof Error ? error.message : String(error)}`
56 | );
57 | }
58 | }
59 |
60 | async function getSystemMaintenance(): Promise<any> {
61 | try {
62 | const response = await fetch(`${env.ultrade_api_url}/system/maintenance`, {
63 | method: 'GET',
64 | headers: {
65 | 'Content-Type': 'application/json'
66 | }
67 | });
68 |
69 | if (!response.ok) {
70 | throw new McpError(
71 | ErrorCode.InternalError,
72 | `Ultrade API error: ${response.status} ${response.statusText}`
73 | );
74 | }
75 |
76 | return await response.json();
77 | } catch (error) {
78 | if (error instanceof McpError) {
79 | throw error;
80 | }
81 | throw new McpError(
82 | ErrorCode.InternalError,
83 | `Failed to get system maintenance status: ${error instanceof Error ? error.message : String(error)}`
84 | );
85 | }
86 | }
87 |
88 | async function getSystemVersion(): Promise<any> {
89 | try {
90 | const response = await fetch(`${env.ultrade_api_url}/system/version`, {
91 | method: 'GET',
92 | headers: {
93 | 'Content-Type': 'application/json'
94 | }
95 | });
96 |
97 | if (!response.ok) {
98 | throw new McpError(
99 | ErrorCode.InternalError,
100 | `Ultrade API error: ${response.status} ${response.statusText}`
101 | );
102 | }
103 |
104 | return await response.json();
105 | } catch (error) {
106 | if (error instanceof McpError) {
107 | throw error;
108 | }
109 | throw new McpError(
110 | ErrorCode.InternalError,
111 | `Failed to get system version: ${error instanceof Error ? error.message : String(error)}`
112 | );
113 | }
114 | }
115 |
116 | export async function handleSystemTools(args: any): Promise<any> {
117 | switch (args.name) {
118 | case 'api_ultrade_system_time':
119 | return await getSystemTime();
120 | case 'api_ultrade_system_maintenance':
121 | return await getSystemMaintenance();
122 | case 'api_ultrade_system_version':
123 | return await getSystemVersion();
124 | default:
125 | throw new McpError(
126 | ErrorCode.MethodNotFound,
127 | `Unknown tool: ${args.name}`
128 | );
129 | }
130 | }
131 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:debugging.md:
--------------------------------------------------------------------------------
```markdown
1 | # Debugger
2 |
3 | The AlgoKit TypeScript Utilities package provides a set of debugging tools that can be used to simulate and trace transactions on the Algorand blockchain. These tools and methods are optimized for developers who are building applications on Algorand and need to test and debug their smart contracts via [AlgoKit AVM Debugger extension](https://github.com/algorandfoundation/algokit-avm-vscode-debugger).
4 |
5 | ## Configuration
6 |
7 | The `config.ts` file contains the `UpdatableConfig` class which manages and updates configuration settings for the AlgoKit project.
8 |
9 | To enable debug mode in your project you can configure it as follows:
10 |
11 | ```ts
12 | import { Config } from '@algorandfoundation/algokit-utils'
13 | Config.configure({
14 | debug: true,
15 | })
16 | ```
17 |
18 | ## Debugging in `node` environment (recommended)
19 |
20 | Refer to the [algokit-utils-ts-debug](https://github.com/algorandfoundation/algokit-utils-ts-debug) for more details on how to activate the addon package with `algokit-utils` in your project.
21 |
22 | > Note: Config also contains a set of flags that affect behaviour of [algokit-utils-ts-debug](https://github.com/algorandfoundation/algokit-utils-ts-debug). Those include `projectRoot`, `traceAll`, `traceBufferSizeMb`, and `maxSearchDepth`. Refer to addon package documentation for details.
23 |
24 | ### Why are the debug utilities in a separate package?
25 |
26 | To keep the `algokit-utils-ts` package lean and isomporphic, the debugging utilities are located in a separate package. This eliminates various error cases with bundlers (e.g. `webpack`, `esbuild`) when building for the browser.
27 |
28 | ## Debugging in `browser` environment
29 |
30 | Note: `algokit-utils-ts-debug` cannot be used in browser environments. However, you can still obtain and persist simulation traces from the browser's `Console` tab when submitting transactions using the algokit-utils-ts package. To enable this functionality, activate debug mode in the algokit-utils-ts config as described in the [getting started](./docs/code/getting-started.md) guide.
31 |
32 | ### Subscribe to the `simulate` response event
33 |
34 | After setting the `debug` flag to true in the [configuration](#configuration) section, subscribe to the `TxnGroupSimulated` event as follows:
35 |
36 | ```ts
37 | import { AVMTracesEventData, Config, EventType } from '@algorandfoundation/algokit-utils'
38 |
39 | Config.events.on(EventType.TxnGroupSimulated, (eventData: AVMTracesEventData) => {
40 | Config.logger.info(JSON.stringify(eventData.simulateResponse.get_obj_for_encoding(), null, 2))
41 | })
42 | ```
43 |
44 | This will output any simulation traces that have been emitted whilst calling your app. Place this code immediately after the `Config.configure` call to ensure it executes before any transactions are submitted for simulation.
45 |
46 | ### Save simulation trace responses from the browser
47 |
48 | With the event handler configured, follow these steps to save simulation trace responses:
49 |
50 | 1. Open your browser's `Console` tab
51 | 2. Submit the transaction
52 | 3. Copy the simulation request `JSON` and save it to a file with the extension `.trace.avm.json`
53 | 4. Place the file in the `debug_traces` folder of your AlgoKit contract project
54 | - Note: If you're not using an AlgoKit project structure, the extension will present a file picker as long as the trace file is within your VSCode workspace
55 |
```