This is page 7 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/liquid-auth:docs:README.md:
--------------------------------------------------------------------------------
```markdown
1 | # Starlight Starter Kit: Basics
2 |
3 | [](https://starlight.astro.build)
4 |
5 | ```
6 | npm create astro@latest -- --template starlight
7 | ```
8 |
9 | [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10 | [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11 | [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
12 |
13 | > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
14 |
15 | ## 🚀 Project Structure
16 |
17 | Inside of your Astro + Starlight project, you'll see the following folders and files:
18 |
19 | ```
20 | .
21 | ├── public/
22 | ├── src/
23 | │ ├── assets/
24 | │ ├── content/
25 | │ │ ├── docs/
26 | │ │ └── config.ts
27 | │ └── env.d.ts
28 | ├── astro.config.mjs
29 | ├── package.json
30 | └── tsconfig.json
31 | ```
32 |
33 | Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
34 |
35 | Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36 |
37 | Static assets, like favicons, can be placed in the `public/` directory.
38 |
39 | ## 🧞 Commands
40 |
41 | All commands are run from the root of the project, from a terminal:
42 |
43 | | Command | Action |
44 | | :------------------------ | :----------------------------------------------- |
45 | | `npm install` | Installs dependencies |
46 | | `npm run dev` | Starts local dev server at `localhost:4321` |
47 | | `npm run build` | Build your production site to `./dist/` |
48 | | `npm run preview` | Preview your build locally, before deploying |
49 | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50 | | `npm run astro -- --help` | Get help using the Astro CLI |
51 |
52 | ## 👀 Want to learn more?
53 |
54 | Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
55 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/TEALScript:README.md:
--------------------------------------------------------------------------------
```markdown
1 | # Starlight Starter Kit: Basics
2 |
3 | [](https://starlight.astro.build)
4 |
5 | ```
6 | npm create astro@latest -- --template starlight
7 | ```
8 |
9 | [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10 | [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11 | [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
12 |
13 | > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
14 |
15 | ## 🚀 Project Structure
16 |
17 | Inside of your Astro + Starlight project, you'll see the following folders and files:
18 |
19 | ```
20 | .
21 | ├── public/
22 | ├── src/
23 | │ ├── assets/
24 | │ ├── content/
25 | │ │ ├── docs/
26 | │ │ └── config.ts
27 | │ └── env.d.ts
28 | ├── astro.config.mjs
29 | ├── package.json
30 | └── tsconfig.json
31 | ```
32 |
33 | Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
34 |
35 | Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36 |
37 | Static assets, like favicons, can be placed in the `public/` directory.
38 |
39 | ## 🧞 Commands
40 |
41 | All commands are run from the root of the project, from a terminal:
42 |
43 | | Command | Action |
44 | | :------------------------ | :----------------------------------------------- |
45 | | `npm install` | Installs dependencies |
46 | | `npm run dev` | Starts local dev server at `localhost:4321` |
47 | | `npm run build` | Build your production site to `./dist/` |
48 | | `npm run preview` | Preview your build locally, before deploying |
49 | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50 | | `npm run astro -- --help` | Get help using the Astro CLI |
51 |
52 | ## 👀 Want to learn more?
53 |
54 | Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
55 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.BoxesResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / BoxesResponse
2 |
3 | # Class: BoxesResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).BoxesResponse
6 |
7 | Box names of an application
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BoxesResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.BoxesResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.BoxesResponse.md#attribute_map)
24 | - [boxes](modelsv2.BoxesResponse.md#boxes)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.BoxesResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.BoxesResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new BoxesResponse**(`boxes`)
36 |
37 | Creates a new `BoxesResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `boxes` | `Object` |
44 | | `boxes.boxes` | [`BoxDescriptor`](modelsv2.BoxDescriptor.md)[] |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:2398
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### boxes
71 |
72 | • **boxes**: [`BoxDescriptor`](modelsv2.BoxDescriptor.md)[]
73 |
74 | #### Defined in
75 |
76 | client/v2/algod/models/types.ts:2392
77 |
78 | ## Methods
79 |
80 | ### get\_obj\_for\_encoding
81 |
82 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
83 |
84 | Get an object ready for encoding to either JSON or msgpack.
85 |
86 | #### Parameters
87 |
88 | | Name | Type | Default value | Description |
89 | | :------ | :------ | :------ | :------ |
90 | | `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. |
91 |
92 | #### Returns
93 |
94 | `Record`\<`string`, `any`\>
95 |
96 | #### Inherited from
97 |
98 | BaseModel.get\_obj\_for\_encoding
99 |
100 | #### Defined in
101 |
102 | client/v2/basemodel.ts:65
103 |
104 | ___
105 |
106 | ### from\_obj\_for\_encoding
107 |
108 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BoxesResponse`](modelsv2.BoxesResponse.md)
109 |
110 | #### Parameters
111 |
112 | | Name | Type |
113 | | :------ | :------ |
114 | | `data` | `Record`\<`string`, `any`\> |
115 |
116 | #### Returns
117 |
118 | [`BoxesResponse`](modelsv2.BoxesResponse.md)
119 |
120 | #### Defined in
121 |
122 | client/v2/algod/models/types.ts:2408
123 |
```
--------------------------------------------------------------------------------
/packages/server/tests/tools/apiManager/example/get-balance.test.ts:
--------------------------------------------------------------------------------
```typescript
1 | import { McpError, ErrorCode } from '@modelcontextprotocol/sdk/types';
2 | import { getBalanceTool } from '../../../../src/tools/apiManager/example/get-balance';
3 | import { algodClient } from '../../../../src/algorand-client';
4 |
5 | jest.mock('../../../../src/algorand-client', () => ({
6 | algodClient: {
7 | accountInformation: jest.fn()
8 | }
9 | }));
10 |
11 | describe('Example Get Balance Tool', () => {
12 | beforeEach(() => {
13 | jest.clearAllMocks();
14 | });
15 |
16 | it('should handle valid address', async () => {
17 | const validAddress = 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
18 | const mockAccountInfo = {
19 | amount: 1000000,
20 | assets: []
21 | };
22 |
23 | // Mock the Algorand client response
24 | (algodClient.accountInformation as jest.Mock).mockReturnValue({
25 | do: jest.fn().mockResolvedValue(mockAccountInfo)
26 | });
27 |
28 | const result = await getBalanceTool({ address: validAddress });
29 |
30 | expect(result).toBeDefined();
31 | expect(result.content).toHaveLength(1);
32 | expect(result.content[0].type).toBe('text');
33 |
34 | const parsed = JSON.parse(result.content[0].text);
35 | expect(parsed.data).toBeDefined();
36 | expect(parsed.data.address).toBe(validAddress);
37 | expect(parsed.data.amount).toBe(mockAccountInfo.amount);
38 | expect(Array.isArray(parsed.data.assets)).toBe(true);
39 | expect(parsed.data.status).toBe('success');
40 | });
41 |
42 | it('should reject invalid address format', async () => {
43 | await expect(getBalanceTool({
44 | address: 'invalid-address'
45 | })).rejects.toThrow(new McpError(
46 | ErrorCode.InvalidParams,
47 | 'Invalid Algorand address format'
48 | ));
49 | });
50 |
51 | it('should reject missing address', async () => {
52 | await expect(getBalanceTool({
53 | address: ''
54 | })).rejects.toThrow(new McpError(
55 | ErrorCode.InvalidParams,
56 | 'Missing required parameter: address'
57 | ));
58 | });
59 |
60 | it('should handle Algorand API errors', async () => {
61 | const validAddress = 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
62 | const mockError = new Error('API Error');
63 |
64 | // Mock the Algorand client to throw an error
65 | (algodClient.accountInformation as jest.Mock).mockReturnValue({
66 | do: jest.fn().mockRejectedValue(mockError)
67 | });
68 |
69 | await expect(getBalanceTool({
70 | address: validAddress
71 | })).rejects.toThrow(new McpError(
72 | ErrorCode.InternalError,
73 | `Failed to get account balance: ${mockError.message}`
74 | ));
75 | });
76 | });
77 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.BoxDescriptor.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / BoxDescriptor
2 |
3 | # Class: BoxDescriptor
4 |
5 | [modelsv2](../modules/modelsv2.md).BoxDescriptor
6 |
7 | Box descriptor describes a Box.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BoxDescriptor`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.BoxDescriptor.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.BoxDescriptor.md#attribute_map)
24 | - [name](modelsv2.BoxDescriptor.md#name)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.BoxDescriptor.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.BoxDescriptor.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new BoxDescriptor**(`name`)
36 |
37 | Creates a new `BoxDescriptor` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `name` | `Object` | Base64 encoded box name |
44 | | `name.name` | `string` \| `Uint8Array` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:2310
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### name
71 |
72 | • **name**: `Uint8Array`
73 |
74 | Base64 encoded box name
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:2304
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BoxDescriptor`](modelsv2.BoxDescriptor.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`BoxDescriptor`](modelsv2.BoxDescriptor.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:2323
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.HashFactory.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / HashFactory
2 |
3 | # Class: HashFactory
4 |
5 | [indexerModels](../modules/indexerModels.md).HashFactory
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`HashFactory`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.HashFactory.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.HashFactory.md#attribute_map)
22 | - [hashType](indexerModels.HashFactory.md#hashtype)
23 |
24 | ### Methods
25 |
26 | - [get\_obj\_for\_encoding](indexerModels.HashFactory.md#get_obj_for_encoding)
27 | - [from\_obj\_for\_encoding](indexerModels.HashFactory.md#from_obj_for_encoding)
28 |
29 | ## Constructors
30 |
31 | ### constructor
32 |
33 | • **new HashFactory**(`hashType`)
34 |
35 | Creates a new `HashFactory` object.
36 |
37 | #### Parameters
38 |
39 | | Name | Type | Description |
40 | | :------ | :------ | :------ |
41 | | `hashType` | `Object` | (t) |
42 | | `hashType.hashType?` | `number` \| `bigint` | - |
43 |
44 | #### Overrides
45 |
46 | BaseModel.constructor
47 |
48 | #### Defined in
49 |
50 | client/v2/indexer/models/types.ts:3064
51 |
52 | ## Properties
53 |
54 | ### attribute\_map
55 |
56 | • **attribute\_map**: `Record`\<`string`, `string`\>
57 |
58 | #### Inherited from
59 |
60 | BaseModel.attribute\_map
61 |
62 | #### Defined in
63 |
64 | client/v2/basemodel.ts:56
65 |
66 | ___
67 |
68 | ### hashType
69 |
70 | • `Optional` **hashType**: `number` \| `bigint`
71 |
72 | (t)
73 |
74 | #### Defined in
75 |
76 | client/v2/indexer/models/types.ts:3058
77 |
78 | ## Methods
79 |
80 | ### get\_obj\_for\_encoding
81 |
82 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
83 |
84 | Get an object ready for encoding to either JSON or msgpack.
85 |
86 | #### Parameters
87 |
88 | | Name | Type | Default value | Description |
89 | | :------ | :------ | :------ | :------ |
90 | | `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. |
91 |
92 | #### Returns
93 |
94 | `Record`\<`string`, `any`\>
95 |
96 | #### Inherited from
97 |
98 | BaseModel.get\_obj\_for\_encoding
99 |
100 | #### Defined in
101 |
102 | client/v2/basemodel.ts:65
103 |
104 | ___
105 |
106 | ### from\_obj\_for\_encoding
107 |
108 | ▸ `Static` **from_obj_for_encoding**(`data`): [`HashFactory`](indexerModels.HashFactory.md)
109 |
110 | #### Parameters
111 |
112 | | Name | Type |
113 | | :------ | :------ |
114 | | `data` | `Record`\<`string`, `any`\> |
115 |
116 | #### Returns
117 |
118 | [`HashFactory`](indexerModels.HashFactory.md)
119 |
120 | #### Defined in
121 |
122 | client/v2/indexer/models/types.ts:3074
123 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logging.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / types/logging
2 |
3 | # Module: types/logging
4 |
5 | ## Table of contents
6 |
7 | ### Type Aliases
8 |
9 | - [Logger](types_logging.md#logger)
10 |
11 | ### Variables
12 |
13 | - [consoleLogger](types_logging.md#consolelogger)
14 | - [infoConsoleLogger](types_logging.md#infoconsolelogger)
15 | - [nullLogger](types_logging.md#nulllogger)
16 | - [verboseConsoleLogger](types_logging.md#verboseconsolelogger)
17 | - [warningConsoleLogger](types_logging.md#warningconsolelogger)
18 |
19 | ## Type Aliases
20 |
21 | ### Logger
22 |
23 | Ƭ **Logger**: `Object`
24 |
25 | General purpose logger type, compatible with Winston and others.
26 |
27 | #### Type declaration
28 |
29 | | Name | Type |
30 | | :------ | :------ |
31 | | `debug` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` |
32 | | `error` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` |
33 | | `info` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` |
34 | | `verbose` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` |
35 | | `warn` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` |
36 |
37 | #### Defined in
38 |
39 | [src/types/logging.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L5)
40 |
41 | ## Variables
42 |
43 | ### consoleLogger
44 |
45 | • `Const` **consoleLogger**: [`Logger`](types_logging.md#logger)
46 |
47 | A logger implementation that writes to console
48 |
49 | #### Defined in
50 |
51 | [src/types/logging.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L14)
52 |
53 | ___
54 |
55 | ### infoConsoleLogger
56 |
57 | • `Const` **infoConsoleLogger**: [`Logger`](types_logging.md#logger)
58 |
59 | #### Defined in
60 |
61 | [src/types/logging.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L22)
62 |
63 | ___
64 |
65 | ### nullLogger
66 |
67 | • `Const` **nullLogger**: [`Logger`](types_logging.md#logger)
68 |
69 | A logger implementation that does nothing
70 |
71 | #### Defined in
72 |
73 | [src/types/logging.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L47)
74 |
75 | ___
76 |
77 | ### verboseConsoleLogger
78 |
79 | • `Const` **verboseConsoleLogger**: [`Logger`](types_logging.md#logger)
80 |
81 | #### Defined in
82 |
83 | [src/types/logging.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L30)
84 |
85 | ___
86 |
87 | ### warningConsoleLogger
88 |
89 | • `Const` **warningConsoleLogger**: [`Logger`](types_logging.md#logger)
90 |
91 | #### Defined in
92 |
93 | [src/types/logging.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L38)
94 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/client-manager](../modules/types_client_manager.md) / TypedAppClient
2 |
3 | # Interface: TypedAppClient\<TClient\>
4 |
5 | [types/client-manager](../modules/types_client_manager.md).TypedAppClient
6 |
7 | Interface to identify a typed client that can be used to interact with an application.
8 |
9 | ## Type parameters
10 |
11 | | Name |
12 | | :------ |
13 | | `TClient` |
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](types_client_manager.TypedAppClient.md#constructor)
20 |
21 | ### Methods
22 |
23 | - [fromCreatorAndName](types_client_manager.TypedAppClient.md#fromcreatorandname)
24 | - [fromNetwork](types_client_manager.TypedAppClient.md#fromnetwork)
25 |
26 | ## Constructors
27 |
28 | ### constructor
29 |
30 | • **new TypedAppClient**(`params`): `TClient`
31 |
32 | #### Parameters
33 |
34 | | Name | Type |
35 | | :------ | :------ |
36 | | `params` | `Omit`\<[`AppClientParams`](types_app_client.AppClientParams.md), ``"appSpec"``\> |
37 |
38 | #### Returns
39 |
40 | `TClient`
41 |
42 | #### Defined in
43 |
44 | [src/types/client-manager.ts:633](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L633)
45 |
46 | ## Methods
47 |
48 | ### fromCreatorAndName
49 |
50 | ▸ **fromCreatorAndName**(`params`): `Promise`\<`TClient`\>
51 |
52 | #### Parameters
53 |
54 | | Name | Type |
55 | | :------ | :------ |
56 | | `params` | `Omit`\<\{ `algorand`: [`AlgorandClientInterface`](types_algorand_client_interface.AlgorandClientInterface.md) ; `appLookupCache?`: [`AppLookup`](types_app_deployer.AppLookup.md) ; `appName?`: `string` ; `appSpec`: `string` \| [`Arc56Contract`](types_app_arc56.Arc56Contract.md) \| [`AppSpec`](types_app_spec.AppSpec.md) ; `approvalSourceMap?`: `ProgramSourceMap` ; `clearSourceMap?`: `ProgramSourceMap` ; `creatorAddress`: `string` \| `Address` ; `defaultSender?`: `string` \| `Address` ; `defaultSigner?`: `TransactionSigner` ; `ignoreCache?`: `boolean` }, ``"appSpec"``\> |
57 |
58 | #### Returns
59 |
60 | `Promise`\<`TClient`\>
61 |
62 | #### Defined in
63 |
64 | [src/types/client-manager.ts:635](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L635)
65 |
66 | ___
67 |
68 | ### fromNetwork
69 |
70 | ▸ **fromNetwork**(`params`): `Promise`\<`TClient`\>
71 |
72 | #### Parameters
73 |
74 | | Name | Type |
75 | | :------ | :------ |
76 | | `params` | `Omit`\<[`AppClientParams`](types_app_client.AppClientParams.md), ``"appId"`` \| ``"appSpec"``\> |
77 |
78 | #### Returns
79 |
80 | `Promise`\<`TClient`\>
81 |
82 | #### Defined in
83 |
84 | [src/types/client-manager.ts:634](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L634)
85 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:cli:features:tasks:opt.md:
--------------------------------------------------------------------------------
```markdown
1 | # AlgoKit Task Asset opt-(in|out)
2 |
3 | AlgoKit Task Asset opt-(in|out) allows you to opt-in or opt-out of Algorand Asset(s). This task supports single or multiple assets.
4 |
5 | ## Usage
6 |
7 | Available commands and possible usage as follows:
8 |
9 | ### Opt-in
10 |
11 | ```bash
12 | Usage: algokit task opt-in [OPTIONS] ASSET_IDS...
13 |
14 | Opt-in to an asset(s). This is required before you can receive an asset.
15 | Use -n to specify localnet, testnet, or mainnet. To supply multiple asset IDs, separate them with a whitespace.
16 |
17 | Options:
18 | --account, -a TEXT Address or alias of the signer account. [required]
19 | -n, --network [localnet|testnet|mainnet]
20 | Network to use. Refers to `localnet` by default.
21 | ```
22 |
23 | ### Opt-out
24 |
25 | ```bash
26 | Usage: algokit task opt-out [OPTIONS] [ASSET_IDS]...
27 |
28 | Opt-out of an asset(s). You can only opt out of an asset with a zero balance.
29 | Use -n to specify localnet, testnet, or mainnet. To supply multiple asset IDs, separate them with a whitespace.
30 |
31 | Options:
32 | --account, -a TEXT Address or alias of the signer account. [required]
33 | --all Opt-out of all assets with zero balance.
34 | -n, --network [localnet|testnet|mainnet]
35 | Network to use. Refers to `localnet` by default.
36 | ```
37 |
38 | ## Options
39 |
40 | - `ASSET_IDS`: Specifies the asset IDs to opt-in or opt-out. To supply multiple asset IDs, separate them with a whitespace.
41 | - `--account`, `-a` TEXT: Specifies the address or alias of the signer account. This option is required.
42 | - `--all`: Specifies to opt-out of all assets with zero balance.
43 | - `-n`, `--network` [localnet|testnet|mainnet]: Specifies the network to use. Refers to localnet by default.
44 |
45 | ## Example
46 |
47 | Example
48 |
49 | To opt-in to an asset(s), you can use the opt-in command as follows:
50 |
51 | ```bash
52 | $ algokit task opt-in --account {YOUR_ACCOUNT} {ASSET_ID_1} {ASSET_ID_2} {ASSET_ID_3} ...
53 | ```
54 |
55 | To opt-out of an asset(s), you can use the opt-out command as follows:
56 |
57 | ```bash
58 | $ algokit task opt-out --account {YOUR_ACCOUNT} {ASSET_ID_1} {ASSET_ID_2} ...
59 | ```
60 |
61 | To opt-out of all assets with zero balance, you can use the opt-out command with the `--all` flag:
62 |
63 | ```bash
64 | $ algokit task opt-out --account {YOUR_ACCOUNT} --all
65 | ```
66 |
67 | > Please note, the account must have sufficient balance to cover the transaction fees.
68 |
69 | ## Further Reading
70 |
71 | For in-depth details, visit the [opt-in](../../cli/index.md#opt-in) and [opt-out](../../cli/index#opt-out) sections in the AlgoKit CLI reference documentation.
72 |
```
--------------------------------------------------------------------------------
/packages/server/src/tools/apiManager/tinyman/index.ts:
--------------------------------------------------------------------------------
```typescript
1 | import { Tool, ErrorCode, McpError } from '@modelcontextprotocol/sdk/types.js';
2 | import { poolTools, handlePoolTools } from './pool.js';
3 | import { liquidityTools, handleLiquidityTools } from './liquidity.js';
4 | import { swapTools, handleSwapTools } from './swap.js';
5 | import { analyticsTools, handleAnalyticsTools } from './analytics.js';
6 | import { bootstrapTools, handleBootstrapTools } from './bootstrap.js';
7 | import { removeLiquidityTools, handleRemoveLiquidityTools } from './remove_liquidity.js';
8 | import { optInTools, handleOptInTools } from './opt_in.js';
9 |
10 | // Combine all Tinyman tools
11 | export const tinymanTools: Tool[] = [
12 | ...poolTools,
13 | ...liquidityTools,
14 | ...swapTools,
15 | ...analyticsTools,
16 | ...bootstrapTools,
17 | ...removeLiquidityTools,
18 | ...optInTools
19 | ];
20 |
21 | // Handle all Tinyman tools
22 | export async function handleTinymanTools(name: string, args: any): Promise<any> {
23 | try {
24 | const combinedArgs = { name, ...args };
25 | // Pool analytics tools (must come before pool tools due to prefix matching)
26 | if (name.startsWith('api_tinyman_get_pool_analytics')) {
27 | return handleAnalyticsTools(combinedArgs);
28 | }
29 |
30 | // Pool creation tools (must come before pool tools due to prefix matching)
31 | if (name.startsWith('api_tinyman_get_pool_creation')) {
32 | return handleBootstrapTools(combinedArgs);
33 | }
34 |
35 | // Pool tools
36 | if (name.startsWith('api_tinyman_get_pool')) {
37 | return handlePoolTools(combinedArgs);
38 | }
39 |
40 | // Remove liquidity tools (must come before liquidity tools due to prefix matching)
41 | if (name.startsWith('api_tinyman_get_remove_liquidity')) {
42 | return handleRemoveLiquidityTools(combinedArgs);
43 | }
44 |
45 | // Liquidity tools
46 | if (name.startsWith('api_tinyman_get_liquidity')) {
47 | return handleLiquidityTools(combinedArgs);
48 | }
49 |
50 | // Swap tools
51 | if (name.startsWith('api_tinyman_get_swap')) {
52 | return handleSwapTools(combinedArgs);
53 | }
54 |
55 | // Opt-in tools
56 | if (name.startsWith('api_tinyman_get_asset_optin') ||
57 | name.startsWith('api_tinyman_get_validator_opt')) {
58 | return handleOptInTools(combinedArgs);
59 | }
60 |
61 | throw new McpError(
62 | ErrorCode.MethodNotFound,
63 | `Unknown tool: ${name}`
64 | );
65 | } catch (error) {
66 | if (error instanceof McpError) {
67 | throw error;
68 | }
69 | throw new McpError(
70 | ErrorCode.InternalError,
71 | `Failed to handle Tinyman tool: ${error instanceof Error ? error.message : String(error)}`
72 | );
73 | }
74 | }
75 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:details:useful_resources.md:
--------------------------------------------------------------------------------
```markdown
1 | title: Useful Resources
2 |
3 | This page contains resources that don't necessarily have their own page or we don't provide comprehensive details on how to use them, but are interesting enough that we encourage you to check them out.
4 |
5 | # AlgoDevs YouTube Channel
6 |
7 | The [@AlgoDevs YouTube channel](https://www.youtube.com/@algodevs) is focused on short-form developer content that provides a quick way to get up to speed on all things Algorand. These 5-10 minute videos cover topics, like writing PyTeal smart contracts, the Algorand Virtual Machine(AVM), asset creation, transactions, and much more. These videos are actively maintained to be up to date with the current release of Algorand. Make sure to check them out and subscribe.
8 |
9 | # Algorand Developer Discord
10 |
11 | Join the Algorand developer [Discord](https://discord.gg/algorand) to keep up to date, ask questions, get code examples, comment on new features, and discuss Algorand standards.
12 |
13 | # Smart Contract Bootcamps using AlgoKit
14 |
15 | The AlgoDevs provide instructor lead bootcamps on a rotating basis ([registration required](https://developer.algorand.org/bootcamp)). Content ranges from beginner, to intermediate, thru advanced. Video recordings follow each session to catch up on delivered content within the [Algorand Developer Bootcamps on GitHub](https://github.com/algorand-bootcamp) repository.
16 |
17 | # ARCs: Algorand Requests for Comments
18 |
19 | When it comes to standardising practises this is the place the be. Whether it's proposing a new data structure for common actions, or introducing a new process to achieve uniformity across platforms, this is the place to keep up to date and participate in discussions.
20 |
21 | - [GitHub Repository](https://github.com/algorandfoundation/ARCs)
22 | - [GitHub Discussions](https://github.com/algorandfoundation/ARCs/issues)
23 |
24 | # Services for Startups Building on Algorand
25 |
26 | | **Partner Service** | **How to Apply** | What You Get |
27 | |----------------------------|---------------------------|------------------------------------|
28 | | [AWS Credits](https://tinyurl.com/algoawscredits) | Key in code `1cf01` and the Foundation team will do a quick verification of your project before enabling the free credits | 5000 credits for AWS cloud services |
29 | | [Google Cloud Credits](https://cloud.google.com/startup/apply?hl=en#application-form) | Complete the application form | Up to $200K in cloud credits over 2 years |
30 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:ABIMethod.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / ABIMethod
2 |
3 | # Class: ABIMethod
4 |
5 | ## Table of contents
6 |
7 | ### Constructors
8 |
9 | - [constructor](ABIMethod.md#constructor)
10 |
11 | ### Properties
12 |
13 | - [args](ABIMethod.md#args)
14 | - [description](ABIMethod.md#description)
15 | - [events](ABIMethod.md#events)
16 | - [name](ABIMethod.md#name)
17 | - [readonly](ABIMethod.md#readonly)
18 | - [returns](ABIMethod.md#returns)
19 |
20 | ### Methods
21 |
22 | - [getSelector](ABIMethod.md#getselector)
23 | - [getSignature](ABIMethod.md#getsignature)
24 | - [toJSON](ABIMethod.md#tojson)
25 | - [txnCount](ABIMethod.md#txncount)
26 | - [fromSignature](ABIMethod.md#fromsignature)
27 |
28 | ## Constructors
29 |
30 | ### constructor
31 |
32 | • **new ABIMethod**(`params`)
33 |
34 | #### Parameters
35 |
36 | | Name | Type |
37 | | :------ | :------ |
38 | | `params` | [`ABIMethodParams`](../interfaces/ABIMethodParams.md) |
39 |
40 | #### Defined in
41 |
42 | abi/method.ts:88
43 |
44 | ## Properties
45 |
46 | ### args
47 |
48 | • `Readonly` **args**: \{ `description?`: `string` ; `name?`: `string` ; `type`: [`ABIArgumentType`](../modules.md#abiargumenttype) }[]
49 |
50 | #### Defined in
51 |
52 | abi/method.ts:78
53 |
54 | ___
55 |
56 | ### description
57 |
58 | • `Optional` `Readonly` **description**: `string`
59 |
60 | #### Defined in
61 |
62 | abi/method.ts:77
63 |
64 | ___
65 |
66 | ### events
67 |
68 | • `Optional` `Readonly` **events**: `ARC28Event`[]
69 |
70 | #### Defined in
71 |
72 | abi/method.ts:85
73 |
74 | ___
75 |
76 | ### name
77 |
78 | • `Readonly` **name**: `string`
79 |
80 | #### Defined in
81 |
82 | abi/method.ts:76
83 |
84 | ___
85 |
86 | ### readonly
87 |
88 | • `Optional` `Readonly` **readonly**: `boolean`
89 |
90 | #### Defined in
91 |
92 | abi/method.ts:86
93 |
94 | ___
95 |
96 | ### returns
97 |
98 | • `Readonly` **returns**: `Object`
99 |
100 | #### Type declaration
101 |
102 | | Name | Type |
103 | | :------ | :------ |
104 | | `description?` | `string` |
105 | | `type` | [`ABIReturnType`](../modules.md#abireturntype) |
106 |
107 | #### Defined in
108 |
109 | abi/method.ts:84
110 |
111 | ## Methods
112 |
113 | ### getSelector
114 |
115 | ▸ **getSelector**(): `Uint8Array`
116 |
117 | #### Returns
118 |
119 | `Uint8Array`
120 |
121 | #### Defined in
122 |
123 | abi/method.ts:132
124 |
125 | ___
126 |
127 | ### getSignature
128 |
129 | ▸ **getSignature**(): `string`
130 |
131 | #### Returns
132 |
133 | `string`
134 |
135 | #### Defined in
136 |
137 | abi/method.ts:126
138 |
139 | ___
140 |
141 | ### toJSON
142 |
143 | ▸ **toJSON**(): [`ABIMethodParams`](../interfaces/ABIMethodParams.md)
144 |
145 | #### Returns
146 |
147 | [`ABIMethodParams`](../interfaces/ABIMethodParams.md)
148 |
149 | #### Defined in
150 |
151 | abi/method.ts:147
152 |
153 | ___
154 |
155 | ### txnCount
156 |
157 | ▸ **txnCount**(): `number`
158 |
159 | #### Returns
160 |
161 | `number`
162 |
163 | #### Defined in
164 |
165 | abi/method.ts:137
166 |
167 | ___
168 |
169 | ### fromSignature
170 |
171 | ▸ `Static` **fromSignature**(`signature`): [`ABIMethod`](ABIMethod.md)
172 |
173 | #### Parameters
174 |
175 | | Name | Type |
176 | | :------ | :------ |
177 | | `signature` | `string` |
178 |
179 | #### Returns
180 |
181 | [`ABIMethod`](ABIMethod.md)
182 |
183 | #### Defined in
184 |
185 | abi/method.ts:165
186 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.BlockHashResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / BlockHashResponse
2 |
3 | # Class: BlockHashResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).BlockHashResponse
6 |
7 | Hash of a block header.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BlockHashResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.BlockHashResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.BlockHashResponse.md#attribute_map)
24 | - [blockhash](modelsv2.BlockHashResponse.md#blockhash)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.BlockHashResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.BlockHashResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new BlockHashResponse**(`blockhash`)
36 |
37 | Creates a new `BlockHashResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `blockhash` | `Object` | Block header hash. |
44 | | `blockhash.blockhash` | `string` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:2078
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### blockhash
71 |
72 | • **blockhash**: `string`
73 |
74 | Block header hash.
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:2072
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BlockHashResponse`](modelsv2.BlockHashResponse.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`BlockHashResponse`](modelsv2.BlockHashResponse.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:2088
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.DisassembleResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / DisassembleResponse
2 |
3 | # Class: DisassembleResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).DisassembleResponse
6 |
7 | Teal disassembly Result
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`DisassembleResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.DisassembleResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.DisassembleResponse.md#attribute_map)
24 | - [result](modelsv2.DisassembleResponse.md#result)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.DisassembleResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.DisassembleResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new DisassembleResponse**(`result`)
36 |
37 | Creates a new `DisassembleResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `result` | `Object` | disassembled Teal code |
44 | | `result.result` | `string` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:2582
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### result
71 |
72 | • **result**: `string`
73 |
74 | disassembled Teal code
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:2576
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`DisassembleResponse`](modelsv2.DisassembleResponse.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`DisassembleResponse`](modelsv2.DisassembleResponse.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:2592
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / CoreAppCallArgs
2 |
3 | # Interface: CoreAppCallArgs
4 |
5 | [types/app](../modules/types_app.md).CoreAppCallArgs
6 |
7 | Common app call arguments for ABI and non-ABI (raw) calls
8 |
9 | ## Hierarchy
10 |
11 | - **`CoreAppCallArgs`**
12 |
13 | ↳ [`RawAppCallArgs`](types_app.RawAppCallArgs.md)
14 |
15 | ## Table of contents
16 |
17 | ### Properties
18 |
19 | - [accounts](types_app.CoreAppCallArgs.md#accounts)
20 | - [apps](types_app.CoreAppCallArgs.md#apps)
21 | - [assets](types_app.CoreAppCallArgs.md#assets)
22 | - [boxes](types_app.CoreAppCallArgs.md#boxes)
23 | - [lease](types_app.CoreAppCallArgs.md#lease)
24 | - [rekeyTo](types_app.CoreAppCallArgs.md#rekeyto)
25 |
26 | ## Properties
27 |
28 | ### accounts
29 |
30 | • `Optional` **accounts**: (`string` \| `Address`)[]
31 |
32 | The address of any accounts to load in
33 |
34 | #### Defined in
35 |
36 | [src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79)
37 |
38 | ___
39 |
40 | ### apps
41 |
42 | • `Optional` **apps**: `number`[]
43 |
44 | IDs of any apps to load into the foreignApps array
45 |
46 | #### Defined in
47 |
48 | [src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81)
49 |
50 | ___
51 |
52 | ### assets
53 |
54 | • `Optional` **assets**: `number`[]
55 |
56 | IDs of any assets to load into the foreignAssets array
57 |
58 | #### Defined in
59 |
60 | [src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83)
61 |
62 | ___
63 |
64 | ### boxes
65 |
66 | • `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[]
67 |
68 | Any box references to load
69 |
70 | #### Defined in
71 |
72 | [src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77)
73 |
74 | ___
75 |
76 | ### lease
77 |
78 | • `Optional` **lease**: `string` \| `Uint8Array`
79 |
80 | The optional lease for the transaction
81 |
82 | #### Defined in
83 |
84 | [src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75)
85 |
86 | ___
87 |
88 | ### rekeyTo
89 |
90 | • `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
91 |
92 | Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.
93 |
94 | **Note:** Use with extreme caution and review the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/) first.
95 |
96 | #### Defined in
97 |
98 | [src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88)
99 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.BoxDescriptor.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / BoxDescriptor
2 |
3 | # Class: BoxDescriptor
4 |
5 | [indexerModels](../modules/indexerModels.md).BoxDescriptor
6 |
7 | Box descriptor describes an app box without a value.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BoxDescriptor`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](indexerModels.BoxDescriptor.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](indexerModels.BoxDescriptor.md#attribute_map)
24 | - [name](indexerModels.BoxDescriptor.md#name)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.BoxDescriptor.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.BoxDescriptor.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new BoxDescriptor**(`name`)
36 |
37 | Creates a new `BoxDescriptor` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `name` | `Object` | Base64 encoded box name |
44 | | `name.name` | `string` \| `Uint8Array` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/indexer/models/types.ts:2820
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### name
71 |
72 | • **name**: `Uint8Array`
73 |
74 | Base64 encoded box name
75 |
76 | #### Defined in
77 |
78 | client/v2/indexer/models/types.ts:2814
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BoxDescriptor`](indexerModels.BoxDescriptor.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`BoxDescriptor`](indexerModels.BoxDescriptor.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/indexer/models/types.ts:2833
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:interfaces:BaseHTTPClient.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / BaseHTTPClient
2 |
3 | # Interface: BaseHTTPClient
4 |
5 | BaseHTTPClient is an interface abstracting the queries that can be
6 | made to an algod/indexer endpoint.
7 | The SDK normally uses the URLTokenBaseHTTPClient implementation.
8 | But when used via wallets, the wallet may provide a different object
9 | satisfying the HTTPClient interface. This is useful to allow
10 | wallets to provide access to paid API services without leaking
11 | the secret tokens/URLs.
12 |
13 | Note that post and delete also have an optional query parameter
14 | This is to allow future extension where post and delete may have queries
15 | Currently however HTTPClient does not make use of it
16 |
17 | Compared to HTTPClient, BaseHTTPClient does not deal with serialization/deserialization
18 | Everything is already string/Uint8Array
19 | and all the headers (including Accept/Content-Type) are assumed to be provided
20 |
21 | In case of non-200 status, all methods must throw an error of type
22 | BaseHTTPClientError
23 |
24 | ## Table of contents
25 |
26 | ### Methods
27 |
28 | - [delete](BaseHTTPClient.md#delete)
29 | - [get](BaseHTTPClient.md#get)
30 | - [post](BaseHTTPClient.md#post)
31 |
32 | ## Methods
33 |
34 | ### delete
35 |
36 | ▸ **delete**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `relativePath` | `string` |
43 | | `data` | `Uint8Array` |
44 | | `query?` | `Query`\<`string`\> |
45 | | `requestHeaders?` | `Record`\<`string`, `string`\> |
46 |
47 | #### Returns
48 |
49 | `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
50 |
51 | #### Defined in
52 |
53 | client/baseHTTPClient.ts:52
54 |
55 | ___
56 |
57 | ### get
58 |
59 | ▸ **get**(`relativePath`, `query?`, `requestHeaders?`): `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
60 |
61 | #### Parameters
62 |
63 | | Name | Type |
64 | | :------ | :------ |
65 | | `relativePath` | `string` |
66 | | `query?` | `Query`\<`string`\> |
67 | | `requestHeaders?` | `Record`\<`string`, `string`\> |
68 |
69 | #### Returns
70 |
71 | `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
72 |
73 | #### Defined in
74 |
75 | client/baseHTTPClient.ts:41
76 |
77 | ___
78 |
79 | ### post
80 |
81 | ▸ **post**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
82 |
83 | #### Parameters
84 |
85 | | Name | Type |
86 | | :------ | :------ |
87 | | `relativePath` | `string` |
88 | | `data` | `Uint8Array` |
89 | | `query?` | `Query`\<`string`\> |
90 | | `requestHeaders?` | `Record`\<`string`, `string`\> |
91 |
92 | #### Returns
93 |
94 | `Promise`\<[`BaseHTTPClientResponse`](BaseHTTPClientResponse.md)\>
95 |
96 | #### Defined in
97 |
98 | client/baseHTTPClient.ts:46
99 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.BlockTxidsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / BlockTxidsResponse
2 |
3 | # Class: BlockTxidsResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).BlockTxidsResponse
6 |
7 | Top level transaction IDs in a block.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BlockTxidsResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.BlockTxidsResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.BlockTxidsResponse.md#attribute_map)
24 | - [blocktxids](modelsv2.BlockTxidsResponse.md#blocktxids)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.BlockTxidsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.BlockTxidsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new BlockTxidsResponse**(`blocktxids`)
36 |
37 | Creates a new `BlockTxidsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `blocktxids` | `Object` | Block transaction IDs. |
44 | | `blocktxids.blocktxids` | `string`[] | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:2204
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### blocktxids
71 |
72 | • **blocktxids**: `string`[]
73 |
74 | Block transaction IDs.
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:2198
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BlockTxidsResponse`](modelsv2.BlockTxidsResponse.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`BlockTxidsResponse`](modelsv2.BlockTxidsResponse.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:2214
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:cli:features:doctor.md:
--------------------------------------------------------------------------------
```markdown
1 | # AlgoKit Doctor
2 |
3 | The AlgoKit Doctor feature allows you to check your AlgoKit installation along with its dependencies. This is useful for diagnosing potential issues with using AlgoKit.
4 |
5 | ## Functionality
6 |
7 | The AlgoKit Doctor allows you to make sure that your system has the correct dependencies installed and that they satisfy the minimum required versions. All passed checks will appear in your command line natural color while warnings will be in yellow (warning) and errors or missing critical services will be in red (error). The critical services that AlgoKit will check for (since they are [directly used by certain commands](../../README.md#prerequisites)): Docker, docker compose and git.
8 |
9 | Please run this command to if you are facing an issue running AlgoKit. It is recommended to run it before [submitting an issue to AlgoKit](https://github.com/algorandfoundation/algokit-cli/issues/new). You can copy the contents of the Doctor command message (in Markdown format) to your clipboard by providing the `-c` flag to the command as follows `algokit doctor -c`.
10 |
11 | # Examples
12 |
13 | For example, running `algokit doctor` with all prerequisites installed will result in output similar to the following:
14 |
15 | ```
16 | $ ~ algokit doctor
17 | timestamp: 2023-03-29T03:58:05+00:00
18 | AlgoKit: 0.6.0
19 | AlgoKit Python: 3.11.2 (main, Mar 24 2023, 00:16:47) [Clang 14.0.0 (clang-1400.0.29.202)] (location: /Users/algokit/.local/pipx/venvs/algokit)
20 | OS: macOS-13.2.1-arm64-arm-64bit
21 | docker: 20.10.22
22 | docker compose: 2.15.1
23 | git: 2.39.1
24 | python: 3.10.9 (location: /Users/algokit/.asdf/shims/python)
25 | python3: 3.10.9 (location: /Users/algokit/.asdf/shims/python3)
26 | pipx: 1.2.0
27 | poetry: 1.3.2
28 | node: 18.12.1
29 | npm: 8.19.2
30 | brew: 4.0.10-34-gb753315
31 |
32 | If you are experiencing a problem with AlgoKit, feel free to submit an issue via:
33 | https://github.com/algorandfoundation/algokit-cli/issues/new
34 | Please include this output, if you want to populate this message in your clipboard, run `algokit doctor -c`
35 | ```
36 |
37 | The doctor command will indicate if there is any issues to address, for example:
38 |
39 | If AlgoKit detects a newer version, this will be indicated next to the AlgoKit version
40 | ```
41 | AlgoKit: 1.2.3 (latest: 4.5.6)
42 | ```
43 |
44 | If the detected version of docker compose is unsupported, this will be shown:
45 | ```
46 | docker compose: 2.1.3
47 | Docker Compose 2.5.0 required to run `algokit localnet command`;
48 | install via https://docs.docker.com/compose/install/
49 | ```
50 |
51 | For more details about the `AlgoKit doctor` command, please refer to the [AlgoKit CLI reference documentation](../cli/index.md#doctor).
52 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction.md:
--------------------------------------------------------------------------------
```markdown
1 | # Transaction management
2 |
3 | Transaction management is one of the core capabilities provided by AlgoKit Utils. It allows you to construct, simulate and send single, or grouped transactions with consistent and highly configurable semantics, including configurable control of transaction notes, logging, fees, multiple sender account types, and sending behaviour.
4 |
5 | ## `ConfirmedTransactionResult`
6 |
7 | All AlgoKit Utils functions that send a transaction will generally return a variant of the [`ConfirmedTransactionResult` interface](../code/interfaces/types_transaction.ConfirmedTransactionResult.md) or some superset of that. This provides a consistent mechanism to interpret the results of a transaction send.
8 |
9 | It consists of two properties:
10 |
11 | - `transaction`: An `algosdk.Transaction` object that is either ready to send or represents the transaction that was sent
12 | - `confirmation`: An `algosdk.modelsv2.PendingTransactionResponse` object, which is a type-safe wrapper of the return from the algod pending transaction API noting that it will only be returned if the transaction was able to be confirmed (so won't represent a "pending" transaction)
13 |
14 | There are various variations of the `ConfirmedTransactionResult` that are exposed by various functions within AlgoKit Utils, including:
15 |
16 | - [`ConfirmedTransactionResults`](../code/interfaces/types_transaction.ConfirmedTransactionResults.md) - Where it's both guaranteed that a confirmation will be returned, there is a primary driving transaction, but multiple transactions may be sent (e.g. when making an ABI app call which has dependant transactions)
17 | - [`SendTransactionResults`](../code/interfaces/types_transaction.SendTransactionResults.md) - Where multiple transactions are being sent (`transactions` and `confirmations` are arrays that replace the singular `transaction` and `confirmation`)
18 | - [`SendAtomicTransactionComposerResults`](../code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md) - The result from sending the transactions within an `AtomicTransactionComposer`, it extends `SendTransactionResults` and adds a few other useful properties
19 | - [`AppCallTransactionResult`](../code/interfaces/types_app.AppCallTransactionResult.md) - Result from calling a single app call (which potentially may result in multiple other transaction calls if it was an ABI method with dependant transactions)
20 |
21 | ## Further reading
22 |
23 | To understand how to create, simulate and send transactions consult the [`AlgorandClient`](./algorand-client.md) and [`AlgorandClient`](./algokit-composer.md) documentation.
24 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.ErrorResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / ErrorResponse
2 |
3 | # Class: ErrorResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).ErrorResponse
6 |
7 | An error response with optional data field.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`ErrorResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.ErrorResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.ErrorResponse.md#attribute_map)
24 | - [data](modelsv2.ErrorResponse.md#data)
25 | - [message](modelsv2.ErrorResponse.md#message)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.ErrorResponse.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.ErrorResponse.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new ErrorResponse**(`«destructured»`)
37 |
38 | Creates a new `ErrorResponse` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `data?` | `Record`\<`string`, `any`\> |
46 | | › `message` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/algod/models/types.ts:3110
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 | ### data
73 |
74 | • `Optional` **data**: `Record`\<`string`, `any`\>
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:3103
79 |
80 | ___
81 |
82 | ### message
83 |
84 | • **message**: `string`
85 |
86 | #### Defined in
87 |
88 | client/v2/algod/models/types.ts:3101
89 |
90 | ## Methods
91 |
92 | ### get\_obj\_for\_encoding
93 |
94 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
95 |
96 | Get an object ready for encoding to either JSON or msgpack.
97 |
98 | #### Parameters
99 |
100 | | Name | Type | Default value | Description |
101 | | :------ | :------ | :------ | :------ |
102 | | `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. |
103 |
104 | #### Returns
105 |
106 | `Record`\<`string`, `any`\>
107 |
108 | #### Inherited from
109 |
110 | BaseModel.get\_obj\_for\_encoding
111 |
112 | #### Defined in
113 |
114 | client/v2/basemodel.ts:65
115 |
116 | ___
117 |
118 | ### from\_obj\_for\_encoding
119 |
120 | ▸ `Static` **from_obj_for_encoding**(`data`): [`ErrorResponse`](modelsv2.ErrorResponse.md)
121 |
122 | #### Parameters
123 |
124 | | Name | Type |
125 | | :------ | :------ |
126 | | `data` | `Record`\<`string`, `any`\> |
127 |
128 | #### Returns
129 |
130 | [`ErrorResponse`](modelsv2.ErrorResponse.md)
131 |
132 | #### Defined in
133 |
134 | client/v2/algod/models/types.ts:3128
135 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:ABIUintType.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / ABIUintType
2 |
3 | # Class: ABIUintType
4 |
5 | ## Hierarchy
6 |
7 | - [`ABIType`](ABIType.md)
8 |
9 | ↳ **`ABIUintType`**
10 |
11 | ## Table of contents
12 |
13 | ### Constructors
14 |
15 | - [constructor](ABIUintType.md#constructor)
16 |
17 | ### Properties
18 |
19 | - [bitSize](ABIUintType.md#bitsize)
20 |
21 | ### Methods
22 |
23 | - [byteLen](ABIUintType.md#bytelen)
24 | - [decode](ABIUintType.md#decode)
25 | - [encode](ABIUintType.md#encode)
26 | - [equals](ABIUintType.md#equals)
27 | - [isDynamic](ABIUintType.md#isdynamic)
28 | - [toString](ABIUintType.md#tostring)
29 | - [from](ABIUintType.md#from)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new ABIUintType**(`size`)
36 |
37 | #### Parameters
38 |
39 | | Name | Type |
40 | | :------ | :------ |
41 | | `size` | `number` |
42 |
43 | #### Overrides
44 |
45 | [ABIType](ABIType.md).[constructor](ABIType.md#constructor)
46 |
47 | #### Defined in
48 |
49 | abi/abi_type.ts:131
50 |
51 | ## Properties
52 |
53 | ### bitSize
54 |
55 | • **bitSize**: `number`
56 |
57 | #### Defined in
58 |
59 | abi/abi_type.ts:129
60 |
61 | ## Methods
62 |
63 | ### byteLen
64 |
65 | ▸ **byteLen**(): `number`
66 |
67 | #### Returns
68 |
69 | `number`
70 |
71 | #### Overrides
72 |
73 | [ABIType](ABIType.md).[byteLen](ABIType.md#bytelen)
74 |
75 | #### Defined in
76 |
77 | abi/abi_type.ts:151
78 |
79 | ___
80 |
81 | ### decode
82 |
83 | ▸ **decode**(`byteString`): `bigint`
84 |
85 | #### Parameters
86 |
87 | | Name | Type |
88 | | :------ | :------ |
89 | | `byteString` | `Uint8Array` |
90 |
91 | #### Returns
92 |
93 | `bigint`
94 |
95 | #### Overrides
96 |
97 | [ABIType](ABIType.md).[decode](ABIType.md#decode)
98 |
99 | #### Defined in
100 |
101 | abi/abi_type.ts:172
102 |
103 | ___
104 |
105 | ### encode
106 |
107 | ▸ **encode**(`value`): `Uint8Array`
108 |
109 | #### Parameters
110 |
111 | | Name | Type |
112 | | :------ | :------ |
113 | | `value` | [`ABIValue`](../modules.md#abivalue) |
114 |
115 | #### Returns
116 |
117 | `Uint8Array`
118 |
119 | #### Overrides
120 |
121 | [ABIType](ABIType.md).[encode](ABIType.md#encode)
122 |
123 | #### Defined in
124 |
125 | abi/abi_type.ts:155
126 |
127 | ___
128 |
129 | ### equals
130 |
131 | ▸ **equals**(`other`): `boolean`
132 |
133 | #### Parameters
134 |
135 | | Name | Type |
136 | | :------ | :------ |
137 | | `other` | [`ABIType`](ABIType.md) |
138 |
139 | #### Returns
140 |
141 | `boolean`
142 |
143 | #### Overrides
144 |
145 | [ABIType](ABIType.md).[equals](ABIType.md#equals)
146 |
147 | #### Defined in
148 |
149 | abi/abi_type.ts:143
150 |
151 | ___
152 |
153 | ### isDynamic
154 |
155 | ▸ **isDynamic**(): `boolean`
156 |
157 | #### Returns
158 |
159 | `boolean`
160 |
161 | #### Overrides
162 |
163 | [ABIType](ABIType.md).[isDynamic](ABIType.md#isdynamic)
164 |
165 | #### Defined in
166 |
167 | abi/abi_type.ts:147
168 |
169 | ___
170 |
171 | ### toString
172 |
173 | ▸ **toString**(): `string`
174 |
175 | #### Returns
176 |
177 | `string`
178 |
179 | #### Overrides
180 |
181 | [ABIType](ABIType.md).[toString](ABIType.md#tostring)
182 |
183 | #### Defined in
184 |
185 | abi/abi_type.ts:139
186 |
187 | ___
188 |
189 | ### from
190 |
191 | ▸ `Static` **from**(`str`): [`ABIType`](ABIType.md)
192 |
193 | #### Parameters
194 |
195 | | Name | Type |
196 | | :------ | :------ |
197 | | `str` | `string` |
198 |
199 | #### Returns
200 |
201 | [`ABIType`](ABIType.md)
202 |
203 | #### Inherited from
204 |
205 | [ABIType](ABIType.md).[from](ABIType.md#from)
206 |
207 | #### Defined in
208 |
209 | abi/abi_type.ts:57
210 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.TealKeyValue.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / TealKeyValue
2 |
3 | # Class: TealKeyValue
4 |
5 | [modelsv2](../modules/modelsv2.md).TealKeyValue
6 |
7 | Represents a key-value pair in an application store.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`TealKeyValue`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.TealKeyValue.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.TealKeyValue.md#attribute_map)
24 | - [key](modelsv2.TealKeyValue.md#key)
25 | - [value](modelsv2.TealKeyValue.md#value)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.TealKeyValue.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.TealKeyValue.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new TealKeyValue**(`«destructured»`)
37 |
38 | Creates a new `TealKeyValue` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `key` | `string` |
46 | | › `value` | [`TealValue`](modelsv2.TealValue.md) |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/algod/models/types.ts:5634
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 | ### key
73 |
74 | • **key**: `string`
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:5622
79 |
80 | ___
81 |
82 | ### value
83 |
84 | • **value**: [`TealValue`](modelsv2.TealValue.md)
85 |
86 | Represents a TEAL value.
87 |
88 | #### Defined in
89 |
90 | client/v2/algod/models/types.ts:5627
91 |
92 | ## Methods
93 |
94 | ### get\_obj\_for\_encoding
95 |
96 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
97 |
98 | Get an object ready for encoding to either JSON or msgpack.
99 |
100 | #### Parameters
101 |
102 | | Name | Type | Default value | Description |
103 | | :------ | :------ | :------ | :------ |
104 | | `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. |
105 |
106 | #### Returns
107 |
108 | `Record`\<`string`, `any`\>
109 |
110 | #### Inherited from
111 |
112 | BaseModel.get\_obj\_for\_encoding
113 |
114 | #### Defined in
115 |
116 | client/v2/basemodel.ts:65
117 |
118 | ___
119 |
120 | ### from\_obj\_for\_encoding
121 |
122 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TealKeyValue`](modelsv2.TealKeyValue.md)
123 |
124 | #### Parameters
125 |
126 | | Name | Type |
127 | | :------ | :------ |
128 | | `data` | `Record`\<`string`, `any`\> |
129 |
130 | #### Returns
131 |
132 | [`TealKeyValue`](modelsv2.TealKeyValue.md)
133 |
134 | #### Defined in
135 |
136 | client/v2/algod/models/types.ts:5646
137 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.AvmKeyValue.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / AvmKeyValue
2 |
3 | # Class: AvmKeyValue
4 |
5 | [modelsv2](../modules/modelsv2.md).AvmKeyValue
6 |
7 | Represents an AVM key-value pair in an application store.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`AvmKeyValue`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.AvmKeyValue.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.AvmKeyValue.md#attribute_map)
24 | - [key](modelsv2.AvmKeyValue.md#key)
25 | - [value](modelsv2.AvmKeyValue.md#value)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.AvmKeyValue.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.AvmKeyValue.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new AvmKeyValue**(`«destructured»`)
37 |
38 | Creates a new `AvmKeyValue` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `key` | `string` \| `Uint8Array` |
46 | | › `value` | [`AvmValue`](modelsv2.AvmValue.md) |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/algod/models/types.ts:1973
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 | ### key
73 |
74 | • **key**: `Uint8Array`
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:1961
79 |
80 | ___
81 |
82 | ### value
83 |
84 | • **value**: [`AvmValue`](modelsv2.AvmValue.md)
85 |
86 | Represents an AVM value.
87 |
88 | #### Defined in
89 |
90 | client/v2/algod/models/types.ts:1966
91 |
92 | ## Methods
93 |
94 | ### get\_obj\_for\_encoding
95 |
96 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
97 |
98 | Get an object ready for encoding to either JSON or msgpack.
99 |
100 | #### Parameters
101 |
102 | | Name | Type | Default value | Description |
103 | | :------ | :------ | :------ | :------ |
104 | | `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. |
105 |
106 | #### Returns
107 |
108 | `Record`\<`string`, `any`\>
109 |
110 | #### Inherited from
111 |
112 | BaseModel.get\_obj\_for\_encoding
113 |
114 | #### Defined in
115 |
116 | client/v2/basemodel.ts:65
117 |
118 | ___
119 |
120 | ### from\_obj\_for\_encoding
121 |
122 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AvmKeyValue`](modelsv2.AvmKeyValue.md)
123 |
124 | #### Parameters
125 |
126 | | Name | Type |
127 | | :------ | :------ |
128 | | `data` | `Record`\<`string`, `any`\> |
129 |
130 | #### Returns
131 |
132 | [`AvmKeyValue`](modelsv2.AvmKeyValue.md)
133 |
134 | #### Defined in
135 |
136 | client/v2/algod/models/types.ts:1988
137 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.GetSyncRoundResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / GetSyncRoundResponse
2 |
3 | # Class: GetSyncRoundResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).GetSyncRoundResponse
6 |
7 | Response containing the ledger's minimum sync round
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`GetSyncRoundResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.GetSyncRoundResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.GetSyncRoundResponse.md#attribute_map)
24 | - [round](modelsv2.GetSyncRoundResponse.md#round)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.GetSyncRoundResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.GetSyncRoundResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new GetSyncRoundResponse**(`round`)
36 |
37 | Creates a new `GetSyncRoundResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `round` | `Object` | The minimum sync round for the ledger. |
44 | | `round.round` | `number` \| `bigint` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:3291
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### round
71 |
72 | • **round**: `number` \| `bigint`
73 |
74 | The minimum sync round for the ledger.
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:3285
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`GetSyncRoundResponse`](modelsv2.GetSyncRoundResponse.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`GetSyncRoundResponse`](modelsv2.GetSyncRoundResponse.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:3301
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.PostTransactionsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / PostTransactionsResponse
2 |
3 | # Class: PostTransactionsResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).PostTransactionsResponse
6 |
7 | Transaction ID of the submission.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`PostTransactionsResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.PostTransactionsResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.PostTransactionsResponse.md#attribute_map)
24 | - [txid](modelsv2.PostTransactionsResponse.md#txid)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.PostTransactionsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.PostTransactionsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new PostTransactionsResponse**(`txid`)
36 |
37 | Creates a new `PostTransactionsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `txid` | `Object` | encoding of the transaction hash. |
44 | | `txid.txid` | `string` | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:4131
53 |
54 | ## Properties
55 |
56 | ### attribute\_map
57 |
58 | • **attribute\_map**: `Record`\<`string`, `string`\>
59 |
60 | #### Inherited from
61 |
62 | BaseModel.attribute\_map
63 |
64 | #### Defined in
65 |
66 | client/v2/basemodel.ts:56
67 |
68 | ___
69 |
70 | ### txid
71 |
72 | • **txid**: `string`
73 |
74 | encoding of the transaction hash.
75 |
76 | #### Defined in
77 |
78 | client/v2/algod/models/types.ts:4125
79 |
80 | ## Methods
81 |
82 | ### get\_obj\_for\_encoding
83 |
84 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
85 |
86 | Get an object ready for encoding to either JSON or msgpack.
87 |
88 | #### Parameters
89 |
90 | | Name | Type | Default value | Description |
91 | | :------ | :------ | :------ | :------ |
92 | | `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. |
93 |
94 | #### Returns
95 |
96 | `Record`\<`string`, `any`\>
97 |
98 | #### Inherited from
99 |
100 | BaseModel.get\_obj\_for\_encoding
101 |
102 | #### Defined in
103 |
104 | client/v2/basemodel.ts:65
105 |
106 | ___
107 |
108 | ### from\_obj\_for\_encoding
109 |
110 | ▸ `Static` **from_obj_for_encoding**(`data`): [`PostTransactionsResponse`](modelsv2.PostTransactionsResponse.md)
111 |
112 | #### Parameters
113 |
114 | | Name | Type |
115 | | :------ | :------ |
116 | | `data` | `Record`\<`string`, `any`\> |
117 |
118 | #### Returns
119 |
120 | [`PostTransactionsResponse`](modelsv2.PostTransactionsResponse.md)
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:4141
125 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.BoxReference.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / BoxReference
2 |
3 | # Class: BoxReference
4 |
5 | [modelsv2](../modules/modelsv2.md).BoxReference
6 |
7 | References a box of an application.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`BoxReference`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.BoxReference.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [app](modelsv2.BoxReference.md#app)
24 | - [attribute\_map](modelsv2.BoxReference.md#attribute_map)
25 | - [name](modelsv2.BoxReference.md#name)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.BoxReference.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.BoxReference.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new BoxReference**(`«destructured»`)
37 |
38 | Creates a new `BoxReference` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `app` | `number` \| `bigint` |
46 | | › `name` | `string` \| `Uint8Array` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/algod/models/types.ts:2353
55 |
56 | ## Properties
57 |
58 | ### app
59 |
60 | • **app**: `number` \| `bigint`
61 |
62 | Application ID which this box belongs to
63 |
64 | #### Defined in
65 |
66 | client/v2/algod/models/types.ts:2341
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 | ### name
85 |
86 | • **name**: `Uint8Array`
87 |
88 | Base64 encoded box name
89 |
90 | #### Defined in
91 |
92 | client/v2/algod/models/types.ts:2346
93 |
94 | ## Methods
95 |
96 | ### get\_obj\_for\_encoding
97 |
98 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
99 |
100 | Get an object ready for encoding to either JSON or msgpack.
101 |
102 | #### Parameters
103 |
104 | | Name | Type | Default value | Description |
105 | | :------ | :------ | :------ | :------ |
106 | | `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. |
107 |
108 | #### Returns
109 |
110 | `Record`\<`string`, `any`\>
111 |
112 | #### Inherited from
113 |
114 | BaseModel.get\_obj\_for\_encoding
115 |
116 | #### Defined in
117 |
118 | client/v2/basemodel.ts:65
119 |
120 | ___
121 |
122 | ### from\_obj\_for\_encoding
123 |
124 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BoxReference`](modelsv2.BoxReference.md)
125 |
126 | #### Parameters
127 |
128 | | Name | Type |
129 | | :------ | :------ |
130 | | `data` | `Record`\<`string`, `any`\> |
131 |
132 | #### Returns
133 |
134 | [`BoxReference`](modelsv2.BoxReference.md)
135 |
136 | #### Defined in
137 |
138 | client/v2/algod/models/types.ts:2374
139 |
```