This is page 11 of 93. Use http://codebase.md/goplausible/algorand-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── llms-install.md
├── llms.txt
├── package.json
├── packages
│ ├── client
│ │ ├── .env.example
│ │ ├── package.json
│ │ ├── README.md
│ │ ├── src
│ │ │ ├── env.ts
│ │ │ ├── index.ts
│ │ │ └── LocalWallet.ts
│ │ └── tsconfig.json
│ └── server
│ ├── .env.example
│ ├── API specs
│ │ ├── algod_api.json
│ │ ├── indexer_api.json
│ │ ├── mcp.json
│ │ ├── nfd_api.json
│ │ ├── ultrade_api.json
│ │ ├── vestige_api.json
│ │ └── vestige_free_api.json
│ ├── Dockerfile
│ ├── jest.config.js
│ ├── package.json
│ ├── README.md
│ ├── smithery.yaml
│ ├── src
│ │ ├── algorand-client.ts
│ │ ├── env.ts
│ │ ├── index.ts
│ │ ├── resources
│ │ │ ├── index.ts
│ │ │ ├── knowledge
│ │ │ │ ├── ARCs.txt
│ │ │ │ ├── developers-algokit-architecture-decisions.txt
│ │ │ │ ├── developers-algokit-cli.txt
│ │ │ │ ├── developers-algokit-utils-python.txt
│ │ │ │ ├── developers-algokit-utils-typescript.txt
│ │ │ │ ├── developers-clis.txt
│ │ │ │ ├── developers-details.txt
│ │ │ │ ├── developers-liquid-auth.txt
│ │ │ │ ├── developers-nodes.txt
│ │ │ │ ├── developers-puya.txt
│ │ │ │ ├── developers-python.txt
│ │ │ │ ├── developers-sdks-js.txt
│ │ │ │ ├── developers-sdks-python.txt
│ │ │ │ ├── developers-tealscript.txt
│ │ │ │ ├── developers.txt
│ │ │ │ ├── index.ts
│ │ │ │ ├── taxonomy
│ │ │ │ │ ├── algokit-cli:README.md
│ │ │ │ │ ├── algokit:cli:algokit.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_brew_install.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-13_native_binaries.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md
│ │ │ │ │ ├── algokit:cli:articles:output_stability.md
│ │ │ │ │ ├── algokit:cli:cli:index.md
│ │ │ │ │ ├── algokit:cli:features:compile.md
│ │ │ │ │ ├── algokit:cli:features:completions.md
│ │ │ │ │ ├── algokit:cli:features:config.md
│ │ │ │ │ ├── algokit:cli:features:dispenser.md
│ │ │ │ │ ├── algokit:cli:features:doctor.md
│ │ │ │ │ ├── algokit:cli:features:explore.md
│ │ │ │ │ ├── algokit:cli:features:generate.md
│ │ │ │ │ ├── algokit:cli:features:goal.md
│ │ │ │ │ ├── algokit:cli:features:init.md
│ │ │ │ │ ├── algokit:cli:features:localnet.md
│ │ │ │ │ ├── algokit:cli:features:project:bootstrap.md
│ │ │ │ │ ├── algokit:cli:features:project:deploy.md
│ │ │ │ │ ├── algokit:cli:features:project:link.md
│ │ │ │ │ ├── algokit:cli:features:project:list.md
│ │ │ │ │ ├── algokit:cli:features:project:run.md
│ │ │ │ │ ├── algokit:cli:features:project.md
│ │ │ │ │ ├── algokit:cli:features:tasks:analyze.md
│ │ │ │ │ ├── algokit:cli:features:tasks:ipfs.md
│ │ │ │ │ ├── algokit:cli:features:tasks:mint.md
│ │ │ │ │ ├── algokit:cli:features:tasks:nfd.md
│ │ │ │ │ ├── algokit:cli:features:tasks:opt.md
│ │ │ │ │ ├── algokit:cli:features:tasks:send.md
│ │ │ │ │ ├── algokit:cli:features:tasks:sign.md
│ │ │ │ │ ├── algokit:cli:features:tasks:transfer.md
│ │ │ │ │ ├── algokit:cli:features:tasks:vanity_address.md
│ │ │ │ │ ├── algokit:cli:features:tasks:wallet.md
│ │ │ │ │ ├── algokit:cli:features:tasks.md
│ │ │ │ │ ├── algokit:cli:tutorials:algokit-template.md
│ │ │ │ │ ├── algokit:cli:tutorials:intro.md
│ │ │ │ │ ├── algokit:cli:tutorials:smart-contracts.md
│ │ │ │ │ ├── algokit:docs:testnet_api.md
│ │ │ │ │ ├── algokit:lora:README.md
│ │ │ │ │ ├── algokit:README.md
│ │ │ │ │ ├── algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:markdown:index.md
│ │ │ │ │ ├── algokit:utils:python:README.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:source:index.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:algorand-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:amount.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:asset.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:event-emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction-composer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:typed-app-clients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TestLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TransactionLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.MultisigAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.SigningAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.AppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_manager.AppManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_logic_error.LogicError.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnUpdate.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.SignatureType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppState.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxName.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_config.Config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_interface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_arc56.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_deployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_composer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_expand.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_kmd_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_lifecycle_events.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logic_error.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_network_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:README.md
│ │ │ │ │ ├── algokit:utils:typescript:README.md
│ │ │ │ │ ├── algokit:utils:typescript:v7-migration.md
│ │ │ │ │ ├── algokit:utils:typescript:v8-migration.md
│ │ │ │ │ ├── ARCs:ARC-template.md
│ │ │ │ │ ├── ARCs:assets:arc-0012:README.md
│ │ │ │ │ ├── ARCs:assets:arc-0034:TemplateForm.md
│ │ │ │ │ ├── ARCs:assets:arc-0062:README.md
│ │ │ │ │ ├── ARCs:pages:nfts.md
│ │ │ │ │ ├── ARCs:pages:wallets.md
│ │ │ │ │ ├── ARCs:README.md
│ │ │ │ │ ├── ARCs:specs:arc-0000.md
│ │ │ │ │ ├── ARCs:specs:arc-0001.md
│ │ │ │ │ ├── ARCs:specs:arc-0002.md
│ │ │ │ │ ├── ARCs:specs:arc-0003.md
│ │ │ │ │ ├── ARCs:specs:arc-0004.md
│ │ │ │ │ ├── ARCs:specs:arc-0005.md
│ │ │ │ │ ├── ARCs:specs:arc-0006.md
│ │ │ │ │ ├── ARCs:specs:arc-0007.md
│ │ │ │ │ ├── ARCs:specs:arc-0008.md
│ │ │ │ │ ├── ARCs:specs:arc-0009.md
│ │ │ │ │ ├── ARCs:specs:arc-0010.md
│ │ │ │ │ ├── ARCs:specs:arc-0011.md
│ │ │ │ │ ├── ARCs:specs:arc-0012.md
│ │ │ │ │ ├── ARCs:specs:arc-0015.md
│ │ │ │ │ ├── ARCs:specs:arc-0016.md
│ │ │ │ │ ├── ARCs:specs:arc-0018.md
│ │ │ │ │ ├── ARCs:specs:arc-0019.md
│ │ │ │ │ ├── ARCs:specs:arc-0020.md
│ │ │ │ │ ├── ARCs:specs:arc-0021.md
│ │ │ │ │ ├── ARCs:specs:arc-0022.md
│ │ │ │ │ ├── ARCs:specs:arc-0023.md
│ │ │ │ │ ├── ARCs:specs:arc-0025.md
│ │ │ │ │ ├── ARCs:specs:arc-0026.md
│ │ │ │ │ ├── ARCs:specs:arc-0028.md
│ │ │ │ │ ├── ARCs:specs:arc-0032.md
│ │ │ │ │ ├── ARCs:specs:arc-0033.md
│ │ │ │ │ ├── ARCs:specs:arc-0034.md
│ │ │ │ │ ├── ARCs:specs:arc-0035.md
│ │ │ │ │ ├── ARCs:specs:arc-0036.md
│ │ │ │ │ ├── ARCs:specs:arc-0042.md
│ │ │ │ │ ├── ARCs:specs:arc-0047.md
│ │ │ │ │ ├── ARCs:specs:arc-0048.md
│ │ │ │ │ ├── ARCs:specs:arc-0049.md
│ │ │ │ │ ├── ARCs:specs:arc-0054.md
│ │ │ │ │ ├── ARCs:specs:arc-0055.md
│ │ │ │ │ ├── ARCs:specs:arc-0056.md
│ │ │ │ │ ├── ARCs:specs:arc-0059.md
│ │ │ │ │ ├── ARCs:specs:arc-0062.md
│ │ │ │ │ ├── ARCs:specs:arc-0065.md
│ │ │ │ │ ├── ARCs:specs:arc-0069.md
│ │ │ │ │ ├── ARCs:specs:arc-0072.md
│ │ │ │ │ ├── ARCs:specs:arc-0073.md
│ │ │ │ │ ├── ARCs:specs:arc-0074.md
│ │ │ │ │ ├── ARCs:specs:arc-0076.md
│ │ │ │ │ ├── ARCs:specs:arc-0078.md
│ │ │ │ │ ├── ARCs:specs:arc-0079.md
│ │ │ │ │ ├── ARCs:specs:arc-0200.md
│ │ │ │ │ ├── clis_index.md
│ │ │ │ │ ├── developer:docs:about.md
│ │ │ │ │ ├── developer:docs:clis:algokey:algokey.md
│ │ │ │ │ ├── developer:docs:clis:algokey:generate.md
│ │ │ │ │ ├── developer:docs:clis:algokey:import.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:append-auth-addr.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:multisig.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:info.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:part.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:reparent.md
│ │ │ │ │ ├── developer:docs:clis:algokey:sign.md
│ │ │ │ │ ├── developer:docs:clis:conduit:conduit.md
│ │ │ │ │ ├── developer:docs:clis:conduit:init.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:exporters.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:importers.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:list.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:processors.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:diagcfg.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:metric.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:endpoint.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:name.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:telemetry.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:restart.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:start.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:status.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:stop.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:wait.md
│ │ │ │ │ ├── developer:docs:clis:goal:protocols.md
│ │ │ │ │ ├── developer:docs:clis:goal:report.md
│ │ │ │ │ ├── developer:docs:clis:goal:version.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:list.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:new.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:wallet.md
│ │ │ │ │ ├── developer:docs:clis:indexer:api-config.md
│ │ │ │ │ ├── developer:docs:clis:indexer:daemon.md
│ │ │ │ │ ├── developer:docs:clis:indexer:indexer.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:util.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:validator.md
│ │ │ │ │ ├── developer:docs:clis:kmd.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:debug.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:remote.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:tealdbg.md
│ │ │ │ │ ├── developer:docs:details:accounts:create.md
│ │ │ │ │ ├── developer:docs:details:accounts:index.md
│ │ │ │ │ ├── developer:docs:details:accounts:rekey.md
│ │ │ │ │ ├── developer:docs:details:algorand_consensus.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:betanet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:index.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:mainnet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:testnet.md
│ │ │ │ │ ├── developer:docs:details:asa.md
│ │ │ │ │ ├── developer:docs:details:atc.md
│ │ │ │ │ ├── developer:docs:details:atomic_transfers.md
│ │ │ │ │ ├── developer:docs:details:conduit.md
│ │ │ │ │ ├── developer:docs:details:crust.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:jsonspec.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v1.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v10.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v2.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v3.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v4.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v5.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v6.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v7.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v8.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v9.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:specification.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:ABI:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:create.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:innertx.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:state.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:txs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:debugging.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:apps.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:modes.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:beaker.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:pyteal.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:python.md
│ │ │ │ │ ├── developer:docs:details:encoding.md
│ │ │ │ │ ├── developer:docs:details:ethereum_to_algorand.md
│ │ │ │ │ ├── developer:docs:details:index.md
│ │ │ │ │ ├── developer:docs:details:indexer.md
│ │ │ │ │ ├── developer:docs:details:parameter_tables.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:index.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:light_client.md
│ │ │ │ │ ├── developer:docs:details:technical_faq.md
│ │ │ │ │ ├── developer:docs:details:transactions:index.md
│ │ │ │ │ ├── developer:docs:details:transactions:offline_transactions.md
│ │ │ │ │ ├── developer:docs:details:transactions:payment_prompts.md
│ │ │ │ │ ├── developer:docs:details:transactions:signatures.md
│ │ │ │ │ ├── developer:docs:details:transactions:transactions.md
│ │ │ │ │ ├── developer:docs:details:useful_resources.md
│ │ │ │ │ ├── developer:docs:get-started:algokit.md
│ │ │ │ │ ├── developer:docs:get-started:basics:what_is_blockchain.md
│ │ │ │ │ ├── developer:docs:get-started:basics:whats_a_dapp.md
│ │ │ │ │ ├── developer:docs:get-started:basics:where_to_start.md
│ │ │ │ │ ├── developer:docs:get-started:basics:why_algorand.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:ft.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:nft.md
│ │ │ │ │ ├── developer:docs:index.md
│ │ │ │ │ ├── developer:docs:rest-apis:algod.md
│ │ │ │ │ ├── developer:docs:rest-apis:indexer.md
│ │ │ │ │ ├── developer:docs:rest-apis:kmd.md
│ │ │ │ │ ├── developer:docs:rest-apis:restendpoints.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:catchup.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:switch_networks.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:generate_keys.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:index.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:offline.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:online.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:renew.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:artifacts.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:config.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:relay.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:telemetry-config.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:indexer.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:install.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:node-troubleshooting.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:types.md
│ │ │ │ │ ├── developer:docs:sdks:go:index.md
│ │ │ │ │ ├── developer:docs:sdks:index.md
│ │ │ │ │ ├── developer:docs:sdks:java:index.md
│ │ │ │ │ ├── developer:docs:sdks:javascript:index.md
│ │ │ │ │ ├── developer:docs:sdks:python:index.md
│ │ │ │ │ ├── developer:python:code:example:accounts.md
│ │ │ │ │ ├── developer:python:code:example:arc4_types.md
│ │ │ │ │ ├── developer:python:code:example:assets.md
│ │ │ │ │ ├── developer:python:code:example:box_storage.md
│ │ │ │ │ ├── developer:python:code:example:control_flow.md
│ │ │ │ │ ├── developer:python:code:example:crypto:merkle_tree.md
│ │ │ │ │ ├── developer:python:code:example:defi:amm.md
│ │ │ │ │ ├── developer:python:code:example:defi:auction.md
│ │ │ │ │ ├── developer:python:code:example:defi:htlc_logicsig.md
│ │ │ │ │ ├── developer:python:code:example:defi:marketplace.md
│ │ │ │ │ ├── developer:python:code:example:events:arc28_events.md
│ │ │ │ │ ├── developer:python:code:example:global_storage.md
│ │ │ │ │ ├── developer:python:code:example:governance:simple_voting.md
│ │ │ │ │ ├── developer:python:code:example:hello_world.md
│ │ │ │ │ ├── developer:python:code:example:inner_transactions.md
│ │ │ │ │ ├── developer:python:code:example:local_storage.md
│ │ │ │ │ ├── developer:python:code:example:nft:proof_of_attendance.md
│ │ │ │ │ ├── developer:python:code:example:privacy:zk_whitelist.md
│ │ │ │ │ ├── developer:python:code:example:scratch_storage.md
│ │ │ │ │ ├── developer:python:code:example:self_payment.md
│ │ │ │ │ ├── developer:python:code:example:struct_in_box.md
│ │ │ │ │ ├── developer:python:code:example:subsidize_app_call.md
│ │ │ │ │ ├── developer:python:code:example:transactions.md
│ │ │ │ │ ├── developer:python:code:example:utility:calculator.md
│ │ │ │ │ ├── devportal-code-examples:projects:python-contract-examples:README.md
│ │ │ │ │ ├── devportal-code-examples:README.md
│ │ │ │ │ ├── docs:.walletconnect:index.md
│ │ │ │ │ ├── docs:.walletconnect:walletconnect-schema.md
│ │ │ │ │ ├── docs:README.md
│ │ │ │ │ ├── docs:scripts:example_tracker:example_list.md
│ │ │ │ │ ├── docs:scripts:README.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── liquid_auth_index.md
│ │ │ │ │ ├── liquid-auth:ARCHITECTURE.md
│ │ │ │ │ ├── liquid-auth:decisions:1-Service-Authentication.md
│ │ │ │ │ ├── liquid-auth:decisions:2-Bidirectional-Communication.md
│ │ │ │ │ ├── liquid-auth:decisions:3-Peer-to-Peer-Signaling.md
│ │ │ │ │ ├── liquid-auth:decisions:4-Fido-Extension.md
│ │ │ │ │ ├── liquid-auth:decisions:README.md
│ │ │ │ │ ├── liquid-auth:docs:architecture.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:authenticate.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:register.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:authentication.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:example.md
│ │ │ │ │ ├── liquid-auth:docs:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:README.md
│ │ │ │ │ ├── liquid-auth:docs:server:environment-variables.md
│ │ │ │ │ ├── liquid-auth:docs:server:integrations.md
│ │ │ │ │ ├── liquid-auth:docs:server:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:server:running-locally.md
│ │ │ │ │ ├── liquid-auth:README.md
│ │ │ │ │ ├── liquid-auth:SEQUENCE.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md
│ │ │ │ │ ├── liquid-auth:sites:express-dapp:README.md
│ │ │ │ │ ├── liquid-auth:VISION.md
│ │ │ │ │ ├── puya_index.md
│ │ │ │ │ ├── puya:docs:algopy_testing:index.md
│ │ │ │ │ ├── puya:docs:api-algopy.arc4.md
│ │ │ │ │ ├── puya:docs:api-algopy.gtxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.itxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.md
│ │ │ │ │ ├── puya:docs:api-algopy.op.md
│ │ │ │ │ ├── puya:docs:api.md
│ │ │ │ │ ├── puya:docs:compiler.md
│ │ │ │ │ ├── puya:docs:index.md
│ │ │ │ │ ├── puya:docs:language-guide.md
│ │ │ │ │ ├── puya:docs:lg-arc28.md
│ │ │ │ │ ├── puya:docs:lg-arc4.md
│ │ │ │ │ ├── puya:docs:lg-builtins.md
│ │ │ │ │ ├── puya:docs:lg-calling-apps.md
│ │ │ │ │ ├── puya:docs:lg-compile.md
│ │ │ │ │ ├── puya:docs:lg-control.md
│ │ │ │ │ ├── puya:docs:lg-errors.md
│ │ │ │ │ ├── puya:docs:lg-logs.md
│ │ │ │ │ ├── puya:docs:lg-modules.md
│ │ │ │ │ ├── puya:docs:lg-opcode-budget.md
│ │ │ │ │ ├── puya:docs:lg-ops.md
│ │ │ │ │ ├── puya:docs:lg-storage.md
│ │ │ │ │ ├── puya:docs:lg-structure.md
│ │ │ │ │ ├── puya:docs:lg-transactions.md
│ │ │ │ │ ├── puya:docs:lg-types.md
│ │ │ │ │ ├── puya:docs:lg-unsupported-python-features.md
│ │ │ │ │ ├── puya:docs:principles.md
│ │ │ │ │ ├── puya:examples:auction:README.md
│ │ │ │ │ ├── puya:python:testing:docs:algopy.md
│ │ │ │ │ ├── puya:python:testing:docs:api.md
│ │ │ │ │ ├── puya:python:testing:docs:coverage.md
│ │ │ │ │ ├── puya:python:testing:docs:examples.md
│ │ │ │ │ ├── puya:python:testing:docs:faq.md
│ │ │ │ │ ├── puya:python:testing:docs:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:arc4-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:avm-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:concepts.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:contract-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:opcodes.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:signature-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:state-management.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:subroutines.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:transactions.md
│ │ │ │ │ ├── puya:python:testing:examples:README.md
│ │ │ │ │ ├── puya:python:testing:README.md
│ │ │ │ │ ├── puya:README.md
│ │ │ │ │ ├── puya:src:puya:ARCHITECTURE.md
│ │ │ │ │ ├── puya:src:puyapy:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:awst_build:README.md
│ │ │ │ │ ├── puya:stubs:README.md
│ │ │ │ │ ├── puya:tests:test_expected_output:README.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md
│ │ │ │ │ ├── puya:typescript:docs:README.md
│ │ │ │ │ ├── puya:typescript:packages:algo-ts:readme.md
│ │ │ │ │ ├── puya:typescript:README.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIAddressType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayDynamicType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayStaticType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIBoolType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIByteType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIContract.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIInterface.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIMethod.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIStringType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABITupleType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUfixedType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUintType.md
│ │ │ │ │ ├── SDKs:javascript:classes:Algodv2.md
│ │ │ │ │ ├── SDKs:javascript:classes:AtomicTransactionComposer.md
│ │ │ │ │ ├── SDKs:javascript:classes:DryrunResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:Indexer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogData.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetBalancesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHoldingsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Block.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockRewards.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeVote.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HashFactory.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HealthCheck.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.IndexerStateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MerkleArrayProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MiniAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ParticipationUpdates.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofFields.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofParticipant.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofReveal.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSigSlot.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofTracking.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofVerifier.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Transaction.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionApplication.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetFreeze.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetTransfer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionKeyreg.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionPayment.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureLogicsig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionStateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:Kmd.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSig.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetsInformationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AppCallLogs.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationKVStorage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateOperation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHoldingReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockHashResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockTxidsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BuildVersion.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.CompileResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DisassembleResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunSource.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunTxnResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetSyncRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.KvDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LightBlockHeaderProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.NodeStatusResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PostTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ScratchChange.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTraceConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionGroupResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationEvalOverrides.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationTransactionExecTrace.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SupplyResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionParametersResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionProofResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Version.md
│ │ │ │ │ ├── SDKs:javascript:classes:SourceMap.md
│ │ │ │ │ ├── SDKs:javascript:classes:Transaction.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABIReferenceType.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABITransactionType.md
│ │ │ │ │ ├── SDKs:javascript:enums:AtomicTransactionComposerStatus.md
│ │ │ │ │ ├── SDKs:javascript:enums:IntDecoding.md
│ │ │ │ │ ├── SDKs:javascript:enums:OnApplicationComplete.md
│ │ │ │ │ ├── SDKs:javascript:enums:TransactionType.md
│ │ │ │ │ ├── SDKs:javascript:examples:README.md
│ │ │ │ │ ├── SDKs:javascript:FAQ.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworkInfo.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworks.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIInterfaceParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodArgParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodReturnParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIResult.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Account.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Address.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:AlgodTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClient.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientError.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientResponse.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:CustomTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedAssetParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedBoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedGlobalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLocalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedMultisig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSubsig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:IndexerTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:KMDTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:MultisigMetadata.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SuggestedParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionWithSigner.md
│ │ │ │ │ ├── SDKs:javascript:modules:indexerModels.md
│ │ │ │ │ ├── SDKs:javascript:modules:modelsv2.md
│ │ │ │ │ ├── SDKs:javascript:modules.md
│ │ │ │ │ ├── SDKs:javascript:README.md
│ │ │ │ │ ├── SDKs:python:algosdk:v2client:harness:README.md
│ │ │ │ │ ├── SDKs:python:examples:README.md
│ │ │ │ │ ├── SDKs:python:README.md
│ │ │ │ │ ├── tealscript:examples_amm_README.md
│ │ │ │ │ ├── tealscript:examples_auction_README.md
│ │ │ │ │ ├── tealscript:examples_big_box_README.md
│ │ │ │ │ ├── tealscript:examples_itxns_README.md
│ │ │ │ │ ├── tealscript:examples_lsig_with_app_README.md
│ │ │ │ │ ├── tealscript:examples_reti_README.md
│ │ │ │ │ ├── tealscript:FEATURES.md
│ │ │ │ │ ├── tealscript:guides_atomic_txn.md
│ │ │ │ │ ├── tealscript:guides_features.md
│ │ │ │ │ ├── tealscript:guides_getting_started.md
│ │ │ │ │ ├── tealscript:guides_inner_transactions.md
│ │ │ │ │ ├── tealscript:guides_lifecycle.md
│ │ │ │ │ ├── tealscript:guides_math.md
│ │ │ │ │ ├── tealscript:guides_methods.md
│ │ │ │ │ ├── tealscript:guides_multiple_contracts.md
│ │ │ │ │ ├── tealscript:guides_pyteal.md
│ │ │ │ │ ├── tealscript:guides_storage.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_arrays.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_numbers.md
│ │ │ │ │ ├── TEALScript:README.md
│ │ │ │ │ ├── tealscript:tests_test_package_README.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0001-intro.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0002-init.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0003-contract.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0004-artifacts.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0005-hello.md
│ │ │ │ │ └── tealscript:tutorials_Hello World_0006-test.md
│ │ │ │ └── taxonomy-categories
│ │ │ │ ├── algokit-utils.json
│ │ │ │ ├── algokit.json
│ │ │ │ ├── arcs.json
│ │ │ │ ├── clis.json
│ │ │ │ ├── details.json
│ │ │ │ ├── developers.json
│ │ │ │ ├── liquid-auth.json
│ │ │ │ ├── nodes.json
│ │ │ │ ├── puya.json
│ │ │ │ ├── python.json
│ │ │ │ ├── sdks.json
│ │ │ │ └── tealscript.json
│ │ │ └── wallet
│ │ │ └── index.ts
│ │ ├── tools
│ │ │ ├── accountManager.ts
│ │ │ ├── algodManager.ts
│ │ │ ├── apiManager
│ │ │ │ ├── algod
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── example
│ │ │ │ │ ├── get-balance.ts
│ │ │ │ │ └── index.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── indexer
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── nfd
│ │ │ │ │ └── index.ts
│ │ │ │ ├── tinyman
│ │ │ │ │ ├── analytics.ts
│ │ │ │ │ ├── bootstrap.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── liquidity.ts
│ │ │ │ │ ├── opt_in.ts
│ │ │ │ │ ├── pool.ts
│ │ │ │ │ ├── remove_liquidity.ts
│ │ │ │ │ └── swap.ts
│ │ │ │ ├── ultrade
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── market.ts
│ │ │ │ │ ├── system.ts
│ │ │ │ │ └── wallet.ts
│ │ │ │ └── vestige
│ │ │ │ ├── assets.ts
│ │ │ │ ├── balances.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── networks.ts
│ │ │ │ ├── notes.ts
│ │ │ │ ├── pools.ts
│ │ │ │ ├── protocols.ts
│ │ │ │ ├── swaps.ts
│ │ │ │ └── vaults.ts
│ │ │ ├── arc26Manager.ts
│ │ │ ├── index.ts
│ │ │ ├── knowledgeManager.ts
│ │ │ ├── transactionManager
│ │ │ │ ├── accountTransactions.ts
│ │ │ │ ├── appTransactions
│ │ │ │ │ ├── callTxn.ts
│ │ │ │ │ ├── clearTxn.ts
│ │ │ │ │ ├── closeOutTxn.ts
│ │ │ │ │ ├── createTxn.ts
│ │ │ │ │ ├── deleteTxn.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── optInTxn.ts
│ │ │ │ │ ├── test
│ │ │ │ │ │ ├── counter_approval.teal
│ │ │ │ │ │ ├── counter_clear.teal
│ │ │ │ │ │ ├── storage_test_approval_v2.teal
│ │ │ │ │ │ ├── storage_test_approval.teal
│ │ │ │ │ │ └── storage_test_clear.teal
│ │ │ │ │ ├── types.ts
│ │ │ │ │ └── updateTxn.ts
│ │ │ │ ├── assetTransactions.ts
│ │ │ │ ├── generalTransaction.ts
│ │ │ │ └── index.ts
│ │ │ └── utilityManager.ts
│ │ ├── types.ts
│ │ └── utils
│ │ └── responseProcessor.ts
│ ├── tests
│ │ ├── resources
│ │ │ ├── algod
│ │ │ │ ├── account.test.ts
│ │ │ │ ├── application.test.ts
│ │ │ │ ├── asset.test.ts
│ │ │ │ └── transaction.test.ts
│ │ │ └── indexer
│ │ │ ├── account.test.ts
│ │ │ ├── application.test.ts
│ │ │ ├── asset.test.ts
│ │ │ └── transaction.test.ts
│ │ └── tools
│ │ ├── accountManager.test.ts
│ │ ├── algodManager.test.ts
│ │ ├── apiManager
│ │ │ └── example
│ │ │ └── get-balance.test.ts
│ │ ├── transactionManager
│ │ │ ├── accountTransactionManager.test.ts
│ │ │ ├── appTransactionManager.test.ts
│ │ │ ├── assetTransactionManager.test.ts
│ │ │ ├── generalTransactionManager.test.ts
│ │ │ └── transactionManager.test.ts
│ │ └── utilityManager.test.ts
│ └── tsconfig.json
├── README.md
├── rename_files.sh
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.SimulateInitialStates.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / SimulateInitialStates
2 |
3 | # Class: SimulateInitialStates
4 |
5 | [modelsv2](../modules/modelsv2.md).SimulateInitialStates
6 |
7 | Initial states of resources that were accessed during simulation.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`SimulateInitialStates`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.SimulateInitialStates.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [appInitialStates](modelsv2.SimulateInitialStates.md#appinitialstates)
24 | - [attribute\_map](modelsv2.SimulateInitialStates.md#attribute_map)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](modelsv2.SimulateInitialStates.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](modelsv2.SimulateInitialStates.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new SimulateInitialStates**(`appInitialStates`)
36 |
37 | Creates a new `SimulateInitialStates` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type | Description |
42 | | :------ | :------ | :------ |
43 | | `appInitialStates` | `Object` | The initial states of accessed application before simulation. The order of this array is arbitrary. |
44 | | `appInitialStates.appInitialStates?` | [`ApplicationInitialStates`](modelsv2.ApplicationInitialStates.md)[] | - |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/algod/models/types.ts:4222
53 |
54 | ## Properties
55 |
56 | ### appInitialStates
57 |
58 | • `Optional` **appInitialStates**: [`ApplicationInitialStates`](modelsv2.ApplicationInitialStates.md)[]
59 |
60 | The initial states of accessed application before simulation. The order of this
61 | array is arbitrary.
62 |
63 | #### Defined in
64 |
65 | client/v2/algod/models/types.ts:4215
66 |
67 | ___
68 |
69 | ### attribute\_map
70 |
71 | • **attribute\_map**: `Record`\<`string`, `string`\>
72 |
73 | #### Inherited from
74 |
75 | BaseModel.attribute\_map
76 |
77 | #### Defined in
78 |
79 | client/v2/basemodel.ts:56
80 |
81 | ## Methods
82 |
83 | ### get\_obj\_for\_encoding
84 |
85 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
86 |
87 | Get an object ready for encoding to either JSON or msgpack.
88 |
89 | #### Parameters
90 |
91 | | Name | Type | Default value | Description |
92 | | :------ | :------ | :------ | :------ |
93 | | `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. |
94 |
95 | #### Returns
96 |
97 | `Record`\<`string`, `any`\>
98 |
99 | #### Inherited from
100 |
101 | BaseModel.get\_obj\_for\_encoding
102 |
103 | #### Defined in
104 |
105 | client/v2/basemodel.ts:65
106 |
107 | ___
108 |
109 | ### from\_obj\_for\_encoding
110 |
111 | ▸ `Static` **from_obj_for_encoding**(`data`): [`SimulateInitialStates`](modelsv2.SimulateInitialStates.md)
112 |
113 | #### Parameters
114 |
115 | | Name | Type |
116 | | :------ | :------ |
117 | | `data` | `Record`\<`string`, `any`\> |
118 |
119 | #### Returns
120 |
121 | [`SimulateInitialStates`](modelsv2.SimulateInitialStates.md)
122 |
123 | #### Defined in
124 |
125 | client/v2/algod/models/types.ts:4236
126 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / LedgerStateDeltaForTransactionGroup
2 |
3 | # Class: LedgerStateDeltaForTransactionGroup
4 |
5 | [modelsv2](../modules/modelsv2.md).LedgerStateDeltaForTransactionGroup
6 |
7 | Contains a ledger delta for a single transaction group
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`LedgerStateDeltaForTransactionGroup`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.LedgerStateDeltaForTransactionGroup.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.LedgerStateDeltaForTransactionGroup.md#attribute_map)
24 | - [delta](modelsv2.LedgerStateDeltaForTransactionGroup.md#delta)
25 | - [ids](modelsv2.LedgerStateDeltaForTransactionGroup.md#ids)
26 |
27 | ### Methods
28 |
29 | - [get\_obj\_for\_encoding](modelsv2.LedgerStateDeltaForTransactionGroup.md#get_obj_for_encoding)
30 | - [from\_obj\_for\_encoding](modelsv2.LedgerStateDeltaForTransactionGroup.md#from_obj_for_encoding)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new LedgerStateDeltaForTransactionGroup**(`«destructured»`)
37 |
38 | Creates a new `LedgerStateDeltaForTransactionGroup` object.
39 |
40 | #### Parameters
41 |
42 | | Name | Type |
43 | | :------ | :------ |
44 | | `«destructured»` | `Object` |
45 | | › `delta` | `Record`\<`string`, `any`\> |
46 | | › `ids` | `string`[] |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/algod/models/types.ts:3384
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 | ### delta
73 |
74 | • **delta**: `Record`\<`string`, `any`\>
75 |
76 | Ledger StateDelta object
77 |
78 | #### Defined in
79 |
80 | client/v2/algod/models/types.ts:3375
81 |
82 | ___
83 |
84 | ### ids
85 |
86 | • **ids**: `string`[]
87 |
88 | #### Defined in
89 |
90 | client/v2/algod/models/types.ts:3377
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`): [`LedgerStateDeltaForTransactionGroup`](modelsv2.LedgerStateDeltaForTransactionGroup.md)
123 |
124 | #### Parameters
125 |
126 | | Name | Type |
127 | | :------ | :------ |
128 | | `data` | `Record`\<`string`, `any`\> |
129 |
130 | #### Returns
131 |
132 | [`LedgerStateDeltaForTransactionGroup`](modelsv2.LedgerStateDeltaForTransactionGroup.md)
133 |
134 | #### Defined in
135 |
136 | client/v2/algod/models/types.ts:3396
137 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.AppCallLogs.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / AppCallLogs
2 |
3 | # Class: AppCallLogs
4 |
5 | [modelsv2](../modules/modelsv2.md).AppCallLogs
6 |
7 | The logged messages from an app call along with the app ID and outer transaction
8 | ID. Logs appear in the same order that they were emitted.
9 |
10 | ## Hierarchy
11 |
12 | - `default`
13 |
14 | ↳ **`AppCallLogs`**
15 |
16 | ## Table of contents
17 |
18 | ### Constructors
19 |
20 | - [constructor](modelsv2.AppCallLogs.md#constructor)
21 |
22 | ### Properties
23 |
24 | - [applicationIndex](modelsv2.AppCallLogs.md#applicationindex)
25 | - [attribute\_map](modelsv2.AppCallLogs.md#attribute_map)
26 | - [logs](modelsv2.AppCallLogs.md#logs)
27 | - [txid](modelsv2.AppCallLogs.md#txid)
28 |
29 | ### Methods
30 |
31 | - [get\_obj\_for\_encoding](modelsv2.AppCallLogs.md#get_obj_for_encoding)
32 | - [from\_obj\_for\_encoding](modelsv2.AppCallLogs.md#from_obj_for_encoding)
33 |
34 | ## Constructors
35 |
36 | ### constructor
37 |
38 | • **new AppCallLogs**(`«destructured»`)
39 |
40 | Creates a new `AppCallLogs` object.
41 |
42 | #### Parameters
43 |
44 | | Name | Type |
45 | | :------ | :------ |
46 | | `«destructured»` | `Object` |
47 | | › `applicationIndex` | `number` \| `bigint` |
48 | | › `logs` | `Uint8Array`[] |
49 | | › `txid` | `string` |
50 |
51 | #### Overrides
52 |
53 | BaseModel.constructor
54 |
55 | #### Defined in
56 |
57 | client/v2/algod/models/types.ts:924
58 |
59 | ## Properties
60 |
61 | ### applicationIndex
62 |
63 | • **applicationIndex**: `number` \| `bigint`
64 |
65 | The application from which the logs were generated
66 |
67 | #### Defined in
68 |
69 | client/v2/algod/models/types.ts:906
70 |
71 | ___
72 |
73 | ### attribute\_map
74 |
75 | • **attribute\_map**: `Record`\<`string`, `string`\>
76 |
77 | #### Inherited from
78 |
79 | BaseModel.attribute\_map
80 |
81 | #### Defined in
82 |
83 | client/v2/basemodel.ts:56
84 |
85 | ___
86 |
87 | ### logs
88 |
89 | • **logs**: `Uint8Array`[]
90 |
91 | An array of logs
92 |
93 | #### Defined in
94 |
95 | client/v2/algod/models/types.ts:911
96 |
97 | ___
98 |
99 | ### txid
100 |
101 | • **txid**: `string`
102 |
103 | The transaction ID of the outer app call that lead to these logs
104 |
105 | #### Defined in
106 |
107 | client/v2/algod/models/types.ts:916
108 |
109 | ## Methods
110 |
111 | ### get\_obj\_for\_encoding
112 |
113 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
114 |
115 | Get an object ready for encoding to either JSON or msgpack.
116 |
117 | #### Parameters
118 |
119 | | Name | Type | Default value | Description |
120 | | :------ | :------ | :------ | :------ |
121 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
122 |
123 | #### Returns
124 |
125 | `Record`\<`string`, `any`\>
126 |
127 | #### Inherited from
128 |
129 | BaseModel.get\_obj\_for\_encoding
130 |
131 | #### Defined in
132 |
133 | client/v2/basemodel.ts:65
134 |
135 | ___
136 |
137 | ### from\_obj\_for\_encoding
138 |
139 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AppCallLogs`](modelsv2.AppCallLogs.md)
140 |
141 | #### Parameters
142 |
143 | | Name | Type |
144 | | :------ | :------ |
145 | | `data` | `Record`\<`string`, `any`\> |
146 |
147 | #### Returns
148 |
149 | [`AppCallLogs`](modelsv2.AppCallLogs.md)
150 |
151 | #### Defined in
152 |
153 | client/v2/algod/models/types.ts:946
154 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.MerkleArrayProof.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / MerkleArrayProof
2 |
3 | # Class: MerkleArrayProof
4 |
5 | [indexerModels](../modules/indexerModels.md).MerkleArrayProof
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`MerkleArrayProof`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.MerkleArrayProof.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.MerkleArrayProof.md#attribute_map)
22 | - [hashFactory](indexerModels.MerkleArrayProof.md#hashfactory)
23 | - [path](indexerModels.MerkleArrayProof.md#path)
24 | - [treeDepth](indexerModels.MerkleArrayProof.md#treedepth)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.MerkleArrayProof.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.MerkleArrayProof.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new MerkleArrayProof**(`«destructured»`)
36 |
37 | Creates a new `MerkleArrayProof` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `hashFactory?` | [`HashFactory`](indexerModels.HashFactory.md) |
45 | | › `path?` | `Uint8Array`[] |
46 | | › `treeDepth?` | `number` \| `bigint` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:3285
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 | ### hashFactory
73 |
74 | • `Optional` **hashFactory**: [`HashFactory`](indexerModels.HashFactory.md)
75 |
76 | #### Defined in
77 |
78 | client/v2/indexer/models/types.ts:3267
79 |
80 | ___
81 |
82 | ### path
83 |
84 | • `Optional` **path**: `Uint8Array`[]
85 |
86 | (pth)
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:3272
91 |
92 | ___
93 |
94 | ### treeDepth
95 |
96 | • `Optional` **treeDepth**: `number` \| `bigint`
97 |
98 | (td)
99 |
100 | #### Defined in
101 |
102 | client/v2/indexer/models/types.ts:3277
103 |
104 | ## Methods
105 |
106 | ### get\_obj\_for\_encoding
107 |
108 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
109 |
110 | Get an object ready for encoding to either JSON or msgpack.
111 |
112 | #### Parameters
113 |
114 | | Name | Type | Default value | Description |
115 | | :------ | :------ | :------ | :------ |
116 | | `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. |
117 |
118 | #### Returns
119 |
120 | `Record`\<`string`, `any`\>
121 |
122 | #### Inherited from
123 |
124 | BaseModel.get\_obj\_for\_encoding
125 |
126 | #### Defined in
127 |
128 | client/v2/basemodel.ts:65
129 |
130 | ___
131 |
132 | ### from\_obj\_for\_encoding
133 |
134 | ▸ `Static` **from_obj_for_encoding**(`data`): [`MerkleArrayProof`](indexerModels.MerkleArrayProof.md)
135 |
136 | #### Parameters
137 |
138 | | Name | Type |
139 | | :------ | :------ |
140 | | `data` | `Record`\<`string`, `any`\> |
141 |
142 | #### Returns
143 |
144 | [`MerkleArrayProof`](indexerModels.MerkleArrayProof.md)
145 |
146 | #### Defined in
147 |
148 | client/v2/indexer/models/types.ts:3307
149 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:ABITupleType.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / ABITupleType
2 |
3 | # Class: ABITupleType
4 |
5 | ## Hierarchy
6 |
7 | - [`ABIType`](ABIType.md)
8 |
9 | ↳ **`ABITupleType`**
10 |
11 | ## Table of contents
12 |
13 | ### Constructors
14 |
15 | - [constructor](ABITupleType.md#constructor)
16 |
17 | ### Properties
18 |
19 | - [childTypes](ABITupleType.md#childtypes)
20 |
21 | ### Methods
22 |
23 | - [byteLen](ABITupleType.md#bytelen)
24 | - [decode](ABITupleType.md#decode)
25 | - [encode](ABITupleType.md#encode)
26 | - [equals](ABITupleType.md#equals)
27 | - [isDynamic](ABITupleType.md#isdynamic)
28 | - [toString](ABITupleType.md#tostring)
29 | - [from](ABITupleType.md#from)
30 | - [parseTupleContent](ABITupleType.md#parsetuplecontent)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new ABITupleType**(`argTypes`)
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `argTypes` | [`ABIType`](ABIType.md)[] |
43 |
44 | #### Overrides
45 |
46 | [ABIType](ABIType.md).[constructor](ABIType.md#constructor)
47 |
48 | #### Defined in
49 |
50 | abi/abi_type.ts:536
51 |
52 | ## Properties
53 |
54 | ### childTypes
55 |
56 | • **childTypes**: [`ABIType`](ABIType.md)[]
57 |
58 | #### Defined in
59 |
60 | abi/abi_type.ts:534
61 |
62 | ## Methods
63 |
64 | ### byteLen
65 |
66 | ▸ **byteLen**(): `number`
67 |
68 | #### Returns
69 |
70 | `number`
71 |
72 | #### Overrides
73 |
74 | [ABIType](ABIType.md).[byteLen](ABIType.md#bytelen)
75 |
76 | #### Defined in
77 |
78 | abi/abi_type.ts:569
79 |
80 | ___
81 |
82 | ### decode
83 |
84 | ▸ **decode**(`byteString`): [`ABIValue`](../modules.md#abivalue)[]
85 |
86 | #### Parameters
87 |
88 | | Name | Type |
89 | | :------ | :------ |
90 | | `byteString` | `Uint8Array` |
91 |
92 | #### Returns
93 |
94 | [`ABIValue`](../modules.md#abivalue)[]
95 |
96 | #### Overrides
97 |
98 | [ABIType](ABIType.md).[decode](ABIType.md#decode)
99 |
100 | #### Defined in
101 |
102 | abi/abi_type.ts:657
103 |
104 | ___
105 |
106 | ### encode
107 |
108 | ▸ **encode**(`value`): `Uint8Array`
109 |
110 | #### Parameters
111 |
112 | | Name | Type |
113 | | :------ | :------ |
114 | | `value` | [`ABIValue`](../modules.md#abivalue) |
115 |
116 | #### Returns
117 |
118 | `Uint8Array`
119 |
120 | #### Overrides
121 |
122 | [ABIType](ABIType.md).[encode](ABIType.md#encode)
123 |
124 | #### Defined in
125 |
126 | abi/abi_type.ts:585
127 |
128 | ___
129 |
130 | ### equals
131 |
132 | ▸ **equals**(`other`): `boolean`
133 |
134 | #### Parameters
135 |
136 | | Name | Type |
137 | | :------ | :------ |
138 | | `other` | [`ABIType`](ABIType.md) |
139 |
140 | #### Returns
141 |
142 | `boolean`
143 |
144 | #### Overrides
145 |
146 | [ABIType](ABIType.md).[equals](ABIType.md#equals)
147 |
148 | #### Defined in
149 |
150 | abi/abi_type.ts:554
151 |
152 | ___
153 |
154 | ### isDynamic
155 |
156 | ▸ **isDynamic**(): `boolean`
157 |
158 | #### Returns
159 |
160 | `boolean`
161 |
162 | #### Overrides
163 |
164 | [ABIType](ABIType.md).[isDynamic](ABIType.md#isdynamic)
165 |
166 | #### Defined in
167 |
168 | abi/abi_type.ts:564
169 |
170 | ___
171 |
172 | ### toString
173 |
174 | ▸ **toString**(): `string`
175 |
176 | #### Returns
177 |
178 | `string`
179 |
180 | #### Overrides
181 |
182 | [ABIType](ABIType.md).[toString](ABIType.md#tostring)
183 |
184 | #### Defined in
185 |
186 | abi/abi_type.ts:546
187 |
188 | ___
189 |
190 | ### from
191 |
192 | ▸ `Static` **from**(`str`): [`ABIType`](ABIType.md)
193 |
194 | #### Parameters
195 |
196 | | Name | Type |
197 | | :------ | :------ |
198 | | `str` | `string` |
199 |
200 | #### Returns
201 |
202 | [`ABIType`](ABIType.md)
203 |
204 | #### Inherited from
205 |
206 | [ABIType](ABIType.md).[from](ABIType.md#from)
207 |
208 | #### Defined in
209 |
210 | abi/abi_type.ts:57
211 |
212 | ___
213 |
214 | ### parseTupleContent
215 |
216 | ▸ `Static` **parseTupleContent**(`str`): `string`[]
217 |
218 | #### Parameters
219 |
220 | | Name | Type |
221 | | :------ | :------ |
222 | | `str` | `string` |
223 |
224 | #### Returns
225 |
226 | `string`[]
227 |
228 | #### Defined in
229 |
230 | abi/abi_type.ts:770
231 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCallTransactionResultOfType
2 |
3 | # Interface: AppCallTransactionResultOfType\<T\>
4 |
5 | [types/app](../modules/types_app.md).AppCallTransactionResultOfType
6 |
7 | The result of preparing and/or sending multiple transactions
8 |
9 | ## Type parameters
10 |
11 | | Name |
12 | | :------ |
13 | | `T` |
14 |
15 | ## Hierarchy
16 |
17 | - [`SendTransactionResults`](types_transaction.SendTransactionResults.md)
18 |
19 | - [`SendTransactionResult`](types_transaction.SendTransactionResult.md)
20 |
21 | ↳ **`AppCallTransactionResultOfType`**
22 |
23 | ## Table of contents
24 |
25 | ### Properties
26 |
27 | - [confirmation](types_app.AppCallTransactionResultOfType.md#confirmation)
28 | - [confirmations](types_app.AppCallTransactionResultOfType.md#confirmations)
29 | - [return](types_app.AppCallTransactionResultOfType.md#return)
30 | - [transaction](types_app.AppCallTransactionResultOfType.md#transaction)
31 | - [transactions](types_app.AppCallTransactionResultOfType.md#transactions)
32 |
33 | ## Properties
34 |
35 | ### confirmation
36 |
37 | • `Optional` **confirmation**: `PendingTransactionResponse`
38 |
39 | The response if the transaction was sent and waited for
40 |
41 | #### Inherited from
42 |
43 | [SendTransactionResult](types_transaction.SendTransactionResult.md).[confirmation](types_transaction.SendTransactionResult.md#confirmation)
44 |
45 | #### Defined in
46 |
47 | [src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57)
48 |
49 | ___
50 |
51 | ### confirmations
52 |
53 | • `Optional` **confirmations**: `PendingTransactionResponse`[]
54 |
55 | The responses if the transactions were sent and waited for,
56 | the index of the confirmation will match the index of the underlying transaction
57 |
58 | #### Inherited from
59 |
60 | [SendTransactionResults](types_transaction.SendTransactionResults.md).[confirmations](types_transaction.SendTransactionResults.md#confirmations)
61 |
62 | #### Defined in
63 |
64 | [src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67)
65 |
66 | ___
67 |
68 | ### return
69 |
70 | • `Optional` **return**: `T`
71 |
72 | If an ABI method was called the processed return value
73 |
74 | #### Defined in
75 |
76 | [src/types/app.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L228)
77 |
78 | ___
79 |
80 | ### transaction
81 |
82 | • **transaction**: `Transaction`
83 |
84 | The transaction
85 |
86 | #### Inherited from
87 |
88 | [SendTransactionResult](types_transaction.SendTransactionResult.md).[transaction](types_transaction.SendTransactionResult.md#transaction)
89 |
90 | #### Defined in
91 |
92 | [src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55)
93 |
94 | ___
95 |
96 | ### transactions
97 |
98 | • **transactions**: `Transaction`[]
99 |
100 | The transactions that have been prepared and/or sent
101 |
102 | #### Inherited from
103 |
104 | [SendTransactionResults](types_transaction.SendTransactionResults.md).[transactions](types_transaction.SendTransactionResults.md#transactions)
105 |
106 | #### Defined in
107 |
108 | [src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63)
109 |
```
--------------------------------------------------------------------------------
/packages/server/src/tools/apiManager/tinyman/pool.ts:
--------------------------------------------------------------------------------
```typescript
1 | import { Tool, ErrorCode, McpError } from '@modelcontextprotocol/sdk/types.js';
2 | import { poolUtils, SupportedNetwork } from '@tinymanorg/tinyman-js-sdk';
3 | import { algodClient } from '../../../algorand-client.js';
4 | import { env } from '../../../env.js';
5 |
6 | export const poolTools: Tool[] = [
7 | {
8 | name: 'api_tinyman_get_pool',
9 | description: 'Get Tinyman pool information by asset pair',
10 | inputSchema: {
11 | type: 'object',
12 | properties: {
13 | asset1Id: {
14 | type: 'integer',
15 | description: 'ID of the first asset in the pool'
16 | },
17 | asset2Id: {
18 | type: 'integer',
19 | description: 'ID of the second asset in the pool'
20 | },
21 | version: {
22 | type: 'string',
23 | enum: ['v1_1', 'v2'],
24 | description: 'Tinyman protocol version',
25 | default: 'v2'
26 | }
27 | },
28 | required: ['asset1Id', 'asset2Id']
29 | }
30 | }
31 | ];
32 |
33 | export async function handlePoolTools(args: any): Promise<any> {
34 | const {
35 | name,
36 | asset1Id,
37 | asset2Id,
38 | version = 'v2'
39 | } = args;
40 |
41 | if (name === 'api_tinyman_get_pool') {
42 | try {
43 | // Get pool information
44 | const poolInfo = await (version === 'v2'
45 | ? poolUtils.v2.getPoolInfo({
46 | client: algodClient,
47 | network: env.algorand_network as SupportedNetwork,
48 | asset1ID: asset1Id,
49 | asset2ID: asset2Id
50 | })
51 | : poolUtils.v1_1.getPoolInfo({
52 | client: algodClient,
53 | network: env.algorand_network as SupportedNetwork,
54 | asset1ID: asset1Id,
55 | asset2ID: asset2Id
56 | }));
57 |
58 | // Get pool reserves
59 | const reserves = await (version === 'v2'
60 | ? poolUtils.v2.getPoolReserves(algodClient, poolInfo)
61 | : poolUtils.v1_1.getPoolReserves(algodClient, poolInfo));
62 |
63 | // Get pool assets
64 | const assets = await (version === 'v2'
65 | ? poolUtils.v2.getPoolAssets({
66 | client: algodClient,
67 | address: poolInfo.account.address(),
68 | network: env.algorand_network as SupportedNetwork
69 | })
70 | : poolUtils.v1_1.getPoolAssets({
71 | client: algodClient,
72 | address: poolInfo.account.address(),
73 | network: env.algorand_network as SupportedNetwork
74 | }));
75 |
76 | const poolData = {
77 | status: poolInfo.status,
78 | validatorAppID: poolInfo.validatorAppID,
79 | poolTokenID: poolInfo.poolTokenID,
80 | assets,
81 | reserves: {
82 | asset1: reserves.asset1.toString(),
83 | asset2: reserves.asset2.toString(),
84 | issuedLiquidity: reserves.issuedLiquidity.toString(),
85 | round: reserves.round
86 | }
87 | };
88 |
89 | return poolData;
90 | } catch (error) {
91 | throw new McpError(
92 | ErrorCode.InternalError,
93 | `Failed to get pool information: ${error instanceof Error ? error.message : String(error)}`
94 | );
95 | }
96 | }
97 |
98 | throw new McpError(
99 | ErrorCode.MethodNotFound,
100 | `Unknown pool tool: ${name}`
101 | );
102 | }
103 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.AssetsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / AssetsResponse
2 |
3 | # Class: AssetsResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).AssetsResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`AssetsResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.AssetsResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [assets](indexerModels.AssetsResponse.md#assets)
22 | - [attribute\_map](indexerModels.AssetsResponse.md#attribute_map)
23 | - [currentRound](indexerModels.AssetsResponse.md#currentround)
24 | - [nextToken](indexerModels.AssetsResponse.md#nexttoken)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.AssetsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.AssetsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new AssetsResponse**(`«destructured»`)
36 |
37 | Creates a new `AssetsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `assets` | [`Asset`](indexerModels.Asset.md)[] |
45 | | › `currentRound` | `number` \| `bigint` |
46 | | › `nextToken?` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:2104
55 |
56 | ## Properties
57 |
58 | ### assets
59 |
60 | • **assets**: [`Asset`](indexerModels.Asset.md)[]
61 |
62 | #### Defined in
63 |
64 | client/v2/indexer/models/types.ts:2084
65 |
66 | ___
67 |
68 | ### attribute\_map
69 |
70 | • **attribute\_map**: `Record`\<`string`, `string`\>
71 |
72 | #### Inherited from
73 |
74 | BaseModel.attribute\_map
75 |
76 | #### Defined in
77 |
78 | client/v2/basemodel.ts:56
79 |
80 | ___
81 |
82 | ### currentRound
83 |
84 | • **currentRound**: `number` \| `bigint`
85 |
86 | Round at which the results were computed.
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:2089
91 |
92 | ___
93 |
94 | ### nextToken
95 |
96 | • `Optional` **nextToken**: `string`
97 |
98 | Used for pagination, when making another request provide this token with the
99 | next parameter.
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:2095
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AssetsResponse`](indexerModels.AssetsResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`AssetsResponse`](indexerModels.AssetsResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:2126
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.SigningAccount.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/account](../modules/types_account.md) / SigningAccount
2 |
3 | # Class: SigningAccount
4 |
5 | [types/account](../modules/types_account.md).SigningAccount
6 |
7 | Account wrapper that supports a rekeyed account
8 |
9 | ## Implements
10 |
11 | - `default`
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](types_account.SigningAccount.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [\_account](types_account.SigningAccount.md#_account)
22 | - [\_sender](types_account.SigningAccount.md#_sender)
23 | - [\_signer](types_account.SigningAccount.md#_signer)
24 |
25 | ### Accessors
26 |
27 | - [addr](types_account.SigningAccount.md#addr)
28 | - [sender](types_account.SigningAccount.md#sender)
29 | - [signer](types_account.SigningAccount.md#signer)
30 | - [sk](types_account.SigningAccount.md#sk)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new SigningAccount**(`account`, `sender`): [`SigningAccount`](types_account.SigningAccount.md)
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `account` | `default` |
43 | | `sender` | `undefined` \| `string` \| `Address` |
44 |
45 | #### Returns
46 |
47 | [`SigningAccount`](types_account.SigningAccount.md)
48 |
49 | #### Defined in
50 |
51 | [src/types/account.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L110)
52 |
53 | ## Properties
54 |
55 | ### \_account
56 |
57 | • `Private` **\_account**: `default`
58 |
59 | #### Defined in
60 |
61 | [src/types/account.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L75)
62 |
63 | ___
64 |
65 | ### \_sender
66 |
67 | • `Private` **\_sender**: `Address`
68 |
69 | #### Defined in
70 |
71 | [src/types/account.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L77)
72 |
73 | ___
74 |
75 | ### \_signer
76 |
77 | • `Private` **\_signer**: `TransactionSigner`
78 |
79 | #### Defined in
80 |
81 | [src/types/account.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L76)
82 |
83 | ## Accessors
84 |
85 | ### addr
86 |
87 | • `get` **addr**(): `Readonly`\<`Address`\>
88 |
89 | Algorand address of the sender
90 |
91 | #### Returns
92 |
93 | `Readonly`\<`Address`\>
94 |
95 | #### Implementation of
96 |
97 | Account.addr
98 |
99 | #### Defined in
100 |
101 | [src/types/account.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L82)
102 |
103 | ___
104 |
105 | ### sender
106 |
107 | • `get` **sender**(): `default`
108 |
109 | Algorand account of the sender address and signer private key
110 |
111 | #### Returns
112 |
113 | `default`
114 |
115 | #### Defined in
116 |
117 | [src/types/account.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L103)
118 |
119 | ___
120 |
121 | ### signer
122 |
123 | • `get` **signer**(): `TransactionSigner`
124 |
125 | Transaction signer for the underlying signing account
126 |
127 | #### Returns
128 |
129 | `TransactionSigner`
130 |
131 | #### Defined in
132 |
133 | [src/types/account.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L96)
134 |
135 | ___
136 |
137 | ### sk
138 |
139 | • `get` **sk**(): `Readonly`\<`Uint8Array`\>
140 |
141 | Secret key belonging to the signer
142 |
143 | #### Returns
144 |
145 | `Readonly`\<`Uint8Array`\>
146 |
147 | #### Implementation of
148 |
149 | Account.sk
150 |
151 | #### Defined in
152 |
153 | [src/types/account.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L89)
154 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/developers-details.txt:
--------------------------------------------------------------------------------
```
1 | developer:docs:details:indexer.md
2 | developer:docs:details:conduit.md
3 | developer:docs:details:atomic_transfers.md
4 | developer:docs:details:stateproofs:light_client.md
5 | developer:docs:details:stateproofs:index.md
6 | developer:docs:details:dapps:avm:teal:specification.md
7 | developer:docs:details:dapps:avm:teal:guidelines.md
8 | developer:docs:details:dapps:avm:teal:index.md
9 | developer:docs:details:dapps:avm:teal:jsonspec.md
10 | developer:docs:details:dapps:avm:teal:opcodes:v9.md
11 | developer:docs:details:dapps:avm:teal:opcodes:v8.md
12 | developer:docs:details:dapps:avm:teal:opcodes:v3.md
13 | developer:docs:details:dapps:avm:teal:opcodes:v7.md
14 | developer:docs:details:dapps:avm:teal:opcodes:v6.md
15 | developer:docs:details:dapps:avm:teal:opcodes:v2.md
16 | developer:docs:details:dapps:avm:teal:opcodes:v5.md
17 | developer:docs:details:dapps:avm:teal:opcodes:v1.md
18 | developer:docs:details:dapps:avm:teal:opcodes:index.md
19 | developer:docs:details:dapps:avm:teal:opcodes:v4.md
20 | developer:docs:details:dapps:avm:teal:opcodes:v10.md
21 | developer:docs:details:dapps:avm:index.md
22 | developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md
23 | developer:docs:details:dapps:smart-contracts:frontend:apps.md
24 | developer:docs:details:dapps:smart-contracts:guidelines.md
25 | developer:docs:details:dapps:smart-contracts:ABI:index.md
26 | developer:docs:details:dapps:smart-contracts:index.md
27 | developer:docs:details:dapps:smart-contracts:smartsigs:index.md
28 | developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md
29 | developer:docs:details:dapps:smart-contracts:smartsigs:modes.md
30 | developer:docs:details:dapps:smart-contracts:debugging.md
31 | developer:docs:details:dapps:smart-contracts:apps:txs.md
32 | developer:docs:details:dapps:smart-contracts:apps:state.md
33 | developer:docs:details:dapps:smart-contracts:apps:innertx.md
34 | developer:docs:details:dapps:smart-contracts:apps:index.md
35 | developer:docs:details:dapps:smart-contracts:apps:create.md
36 | developer:docs:details:dapps:writing-contracts:pyteal.md
37 | developer:docs:details:dapps:writing-contracts:python.md
38 | developer:docs:details:dapps:writing-contracts:beaker.md
39 | developer:docs:details:atc.md
40 | developer:docs:details:algorand_consensus.md
41 | developer:docs:details:encoding.md
42 | developer:docs:details:transactions:signatures.md
43 | developer:docs:details:transactions:payment_prompts.md
44 | developer:docs:details:transactions:index.md
45 | developer:docs:details:transactions:transactions.md
46 | developer:docs:details:transactions:offline_transactions.md
47 | developer:docs:details:technical_faq.md
48 | developer:docs:details:accounts:rekey.md
49 | developer:docs:details:accounts:index.md
50 | developer:docs:details:accounts:create.md
51 | developer:docs:details:index.md
52 | developer:docs:details:asa.md
53 | developer:docs:details:crust.md
54 | developer:docs:details:algorand-networks:betanet.md
55 | developer:docs:details:algorand-networks:mainnet.md
56 | developer:docs:details:algorand-networks:index.md
57 | developer:docs:details:algorand-networks:testnet.md
58 | developer:docs:details:useful_resources.md
59 | developer:docs:details:ethereum_to_algorand.md
60 | developer:docs:details:parameter_tables.md
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.StateSchema.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / StateSchema
2 |
3 | # Class: StateSchema
4 |
5 | [indexerModels](../modules/indexerModels.md).StateSchema
6 |
7 | Represents a (apls) local-state or (apgs) global-state schema. These schemas
8 | determine how much storage may be used in a local-state or global-state for an
9 | application. The more space used, the larger minimum balance must be maintained
10 | in the account holding the data.
11 |
12 | ## Hierarchy
13 |
14 | - `default`
15 |
16 | ↳ **`StateSchema`**
17 |
18 | ## Table of contents
19 |
20 | ### Constructors
21 |
22 | - [constructor](indexerModels.StateSchema.md#constructor)
23 |
24 | ### Properties
25 |
26 | - [attribute\_map](indexerModels.StateSchema.md#attribute_map)
27 | - [numByteSlice](indexerModels.StateSchema.md#numbyteslice)
28 | - [numUint](indexerModels.StateSchema.md#numuint)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](indexerModels.StateSchema.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](indexerModels.StateSchema.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new StateSchema**(`«destructured»`)
40 |
41 | Creates a new `StateSchema` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `numByteSlice` | `number` \| `bigint` |
49 | | › `numUint` | `number` \| `bigint` |
50 |
51 | #### Overrides
52 |
53 | BaseModel.constructor
54 |
55 | #### Defined in
56 |
57 | client/v2/indexer/models/types.ts:3944
58 |
59 | ## Properties
60 |
61 | ### attribute\_map
62 |
63 | • **attribute\_map**: `Record`\<`string`, `string`\>
64 |
65 | #### Inherited from
66 |
67 | BaseModel.attribute\_map
68 |
69 | #### Defined in
70 |
71 | client/v2/basemodel.ts:56
72 |
73 | ___
74 |
75 | ### numByteSlice
76 |
77 | • **numByteSlice**: `number` \| `bigint`
78 |
79 | Maximum number of TEAL byte slices that may be stored in the key/value store.
80 |
81 | #### Defined in
82 |
83 | client/v2/indexer/models/types.ts:3932
84 |
85 | ___
86 |
87 | ### numUint
88 |
89 | • **numUint**: `number` \| `bigint`
90 |
91 | Maximum number of TEAL uints that may be stored in the key/value store.
92 |
93 | #### Defined in
94 |
95 | client/v2/indexer/models/types.ts:3937
96 |
97 | ## Methods
98 |
99 | ### get\_obj\_for\_encoding
100 |
101 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
102 |
103 | Get an object ready for encoding to either JSON or msgpack.
104 |
105 | #### Parameters
106 |
107 | | Name | Type | Default value | Description |
108 | | :------ | :------ | :------ | :------ |
109 | | `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. |
110 |
111 | #### Returns
112 |
113 | `Record`\<`string`, `any`\>
114 |
115 | #### Inherited from
116 |
117 | BaseModel.get\_obj\_for\_encoding
118 |
119 | #### Defined in
120 |
121 | client/v2/basemodel.ts:65
122 |
123 | ___
124 |
125 | ### from\_obj\_for\_encoding
126 |
127 | ▸ `Static` **from_obj_for_encoding**(`data`): [`StateSchema`](indexerModels.StateSchema.md)
128 |
129 | #### Parameters
130 |
131 | | Name | Type |
132 | | :------ | :------ |
133 | | `data` | `Record`\<`string`, `any`\> |
134 |
135 | #### Returns
136 |
137 | [`StateSchema`](indexerModels.StateSchema.md)
138 |
139 | #### Defined in
140 |
141 | client/v2/indexer/models/types.ts:3962
142 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/ARCs:specs:arc-0042.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | arc: 42
3 | title: xGov Pilot - Integration
4 | description: Integration of xGov Process
5 | author: Stéphane Barroso (@SudoWeezy)
6 | discussions-to: https://github.com/algorandfoundation/ARCs/issues/204
7 | status: Deprecated
8 | type: Informational
9 | created: 2023-06-01
10 | ---
11 |
12 | ## Abstract
13 |
14 | This ARC aims to explain how the xGov process can be integrated within dApps.
15 |
16 | ## Motivation
17 |
18 | By leveraging the xGov decentralization, it can improve the overall efficiency of this initiative.
19 |
20 | ## Specification
21 | The keywords "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**", "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**MAY**", and "**OPTIONAL**" in this document are to be interpreted as described in <a href="https://www.ietf.org/rfc/rfc2119.txt">RFC-2119</a>.
22 |
23 | ### How to register
24 |
25 | #### How to find the xGov Escrow address
26 |
27 | The xGov Escrow address can be extracted using this endpoint: `https://governance.algorand.foundation/api/periods/active/`.
28 |
29 | ```json
30 | {
31 | ...
32 | "xgov_escrow_address": "string",
33 | ...
34 | }
35 | ```
36 |
37 | #### Registration
38 | Governors should specify the xGov-related fields. Specifically, governors can sign up to be xGovs by designating as beneficiaries the xGov escrow address (that changes from one governance period to the next). They can also designate an xGov-controller address that would participate on their behalf in xGov votes via the optional parameter "xGv":"aaa". Namely, the Notes field has the form.
39 |
40 | af/gov1:j{"com":nnn,"mmm1":nnn1,"mmm2":nnn2,"bnf":"XYZ","xGv":"ABC"}
41 | Where:
42 |
43 | "com":nnn is the Algo commitment;
44 | "mmm":nnn is a commitment for LP-token with asset-ID mmm;
45 | "bnf":"XYZ" designates the address "XYZ" as the recipient of rewards ("XYZ" must equal the xGov escrow in order to sign up as an xGov);
46 | The optional "xGv":"ABC" designates address "ABC" as the xGov-controller of this xGov account.
47 |
48 | #### Goal example
49 |
50 | goal clerk send -a 0 -f ALDJ4R2L2PNDGQFSP4LZY4HATIFKZVOKTBKHDGI2PKAFZJSWC4L3UY5HN4 -t RFKCBRTPO76KTY7KSJ3HVWCH5HLBPNBHQYDC52QH3VRS2KIM7N56AS44M4 -n
51 |
52 | ‘af/gov1:j{“com”:1000000,“12345":2,“67890”:30,“bnf”:“DRWUX3L5EW7NAYCFL3NWGDXX4YC6Y6NR2XVYIC6UNOZUUU2ERQEAJHOH4M”,“xGv”:“ALDJ4R2L2PNDGQFSP4LZY4HATIFKZVOKTBKHDGI2PKAFZJSWC4L3UY5HN4”}’
53 |
54 |
55 | ### How to Interact with the Voting Application
56 | #### How to get the Application ID
57 | Every vote will be a different ID, but search for all apps created by the used account and look at the global state to see if is_bootstrapped is 1.
58 |
59 | #### ABI
60 |
61 | The ABI is available <a href="https://github.com/algorandfoundation/nft_voting_tool/blob/main/src/algorand/smart_contracts/artifacts/VotingRoundApp/contract.json">here </a>.
62 | A working test example of how to call application's method is here:
63 | https://github.com/algorandfoundation/nft_voting_tool/blob/main/src/algorand/smart_contracts/tests/voting.spec.ts
64 |
65 | ## Rationale
66 | This integration will improve the usage of the process.
67 |
68 | ## Backwards Compatibility
69 | None
70 |
71 |
72 | ## Security Considerations
73 | None
74 |
75 | ## Copyright
76 | Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CCO</a>.
77 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.BoxesResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / BoxesResponse
2 |
3 | # Class: BoxesResponse
4 |
5 | [indexerModels](../modules/indexerModels.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](indexerModels.BoxesResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [applicationId](indexerModels.BoxesResponse.md#applicationid)
24 | - [attribute\_map](indexerModels.BoxesResponse.md#attribute_map)
25 | - [boxes](indexerModels.BoxesResponse.md#boxes)
26 | - [nextToken](indexerModels.BoxesResponse.md#nexttoken)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](indexerModels.BoxesResponse.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](indexerModels.BoxesResponse.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new BoxesResponse**(`«destructured»`)
38 |
39 | Creates a new `BoxesResponse` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `applicationId` | `number` \| `bigint` |
47 | | › `boxes` | [`BoxDescriptor`](indexerModels.BoxDescriptor.md)[] |
48 | | › `nextToken?` | `string` |
49 |
50 | #### Overrides
51 |
52 | BaseModel.constructor
53 |
54 | #### Defined in
55 |
56 | client/v2/indexer/models/types.ts:2868
57 |
58 | ## Properties
59 |
60 | ### applicationId
61 |
62 | • **applicationId**: `number` \| `bigint`
63 |
64 | (appidx) application index.
65 |
66 | #### Defined in
67 |
68 | client/v2/indexer/models/types.ts:2851
69 |
70 | ___
71 |
72 | ### attribute\_map
73 |
74 | • **attribute\_map**: `Record`\<`string`, `string`\>
75 |
76 | #### Inherited from
77 |
78 | BaseModel.attribute\_map
79 |
80 | #### Defined in
81 |
82 | client/v2/basemodel.ts:56
83 |
84 | ___
85 |
86 | ### boxes
87 |
88 | • **boxes**: [`BoxDescriptor`](indexerModels.BoxDescriptor.md)[]
89 |
90 | #### Defined in
91 |
92 | client/v2/indexer/models/types.ts:2853
93 |
94 | ___
95 |
96 | ### nextToken
97 |
98 | • `Optional` **nextToken**: `string`
99 |
100 | Used for pagination, when making another request provide this token with the
101 | next parameter.
102 |
103 | #### Defined in
104 |
105 | client/v2/indexer/models/types.ts:2859
106 |
107 | ## Methods
108 |
109 | ### get\_obj\_for\_encoding
110 |
111 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
112 |
113 | Get an object ready for encoding to either JSON or msgpack.
114 |
115 | #### Parameters
116 |
117 | | Name | Type | Default value | Description |
118 | | :------ | :------ | :------ | :------ |
119 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
120 |
121 | #### Returns
122 |
123 | `Record`\<`string`, `any`\>
124 |
125 | #### Inherited from
126 |
127 | BaseModel.get\_obj\_for\_encoding
128 |
129 | #### Defined in
130 |
131 | client/v2/basemodel.ts:65
132 |
133 | ___
134 |
135 | ### from\_obj\_for\_encoding
136 |
137 | ▸ `Static` **from_obj_for_encoding**(`data`): [`BoxesResponse`](indexerModels.BoxesResponse.md)
138 |
139 | #### Parameters
140 |
141 | | Name | Type |
142 | | :------ | :------ |
143 | | `data` | `Record`\<`string`, `any`\> |
144 |
145 | #### Returns
146 |
147 | [`BoxesResponse`](indexerModels.BoxesResponse.md)
148 |
149 | #### Defined in
150 |
151 | client/v2/indexer/models/types.ts:2890
152 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.AccountsResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / AccountsResponse
2 |
3 | # Class: AccountsResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).AccountsResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`AccountsResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.AccountsResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [accounts](indexerModels.AccountsResponse.md#accounts)
22 | - [attribute\_map](indexerModels.AccountsResponse.md#attribute_map)
23 | - [currentRound](indexerModels.AccountsResponse.md#currentround)
24 | - [nextToken](indexerModels.AccountsResponse.md#nexttoken)
25 |
26 | ### Methods
27 |
28 | - [get\_obj\_for\_encoding](indexerModels.AccountsResponse.md#get_obj_for_encoding)
29 | - [from\_obj\_for\_encoding](indexerModels.AccountsResponse.md#from_obj_for_encoding)
30 |
31 | ## Constructors
32 |
33 | ### constructor
34 |
35 | • **new AccountsResponse**(`«destructured»`)
36 |
37 | Creates a new `AccountsResponse` object.
38 |
39 | #### Parameters
40 |
41 | | Name | Type |
42 | | :------ | :------ |
43 | | `«destructured»` | `Object` |
44 | | › `accounts` | [`Account`](indexerModels.Account.md)[] |
45 | | › `currentRound` | `number` \| `bigint` |
46 | | › `nextToken?` | `string` |
47 |
48 | #### Overrides
49 |
50 | BaseModel.constructor
51 |
52 | #### Defined in
53 |
54 | client/v2/indexer/models/types.ts:738
55 |
56 | ## Properties
57 |
58 | ### accounts
59 |
60 | • **accounts**: [`Account`](indexerModels.Account.md)[]
61 |
62 | #### Defined in
63 |
64 | client/v2/indexer/models/types.ts:718
65 |
66 | ___
67 |
68 | ### attribute\_map
69 |
70 | • **attribute\_map**: `Record`\<`string`, `string`\>
71 |
72 | #### Inherited from
73 |
74 | BaseModel.attribute\_map
75 |
76 | #### Defined in
77 |
78 | client/v2/basemodel.ts:56
79 |
80 | ___
81 |
82 | ### currentRound
83 |
84 | • **currentRound**: `number` \| `bigint`
85 |
86 | Round at which the results were computed.
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:723
91 |
92 | ___
93 |
94 | ### nextToken
95 |
96 | • `Optional` **nextToken**: `string`
97 |
98 | Used for pagination, when making another request provide this token with the
99 | next parameter.
100 |
101 | #### Defined in
102 |
103 | client/v2/indexer/models/types.ts:729
104 |
105 | ## Methods
106 |
107 | ### get\_obj\_for\_encoding
108 |
109 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
110 |
111 | Get an object ready for encoding to either JSON or msgpack.
112 |
113 | #### Parameters
114 |
115 | | Name | Type | Default value | Description |
116 | | :------ | :------ | :------ | :------ |
117 | | `binary` | `boolean` | `false` | Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON. |
118 |
119 | #### Returns
120 |
121 | `Record`\<`string`, `any`\>
122 |
123 | #### Inherited from
124 |
125 | BaseModel.get\_obj\_for\_encoding
126 |
127 | #### Defined in
128 |
129 | client/v2/basemodel.ts:65
130 |
131 | ___
132 |
133 | ### from\_obj\_for\_encoding
134 |
135 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AccountsResponse`](indexerModels.AccountsResponse.md)
136 |
137 | #### Parameters
138 |
139 | | Name | Type |
140 | | :------ | :------ |
141 | | `data` | `Record`\<`string`, `any`\> |
142 |
143 | #### Returns
144 |
145 | [`AccountsResponse`](indexerModels.AccountsResponse.md)
146 |
147 | #### Defined in
148 |
149 | client/v2/indexer/models/types.ts:760
150 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:state-management.md:
--------------------------------------------------------------------------------
```markdown
1 | # State Management
2 |
3 | `algorand-python-testing` provides tools to test state-related abstractions in Algorand smart contracts. This guide covers global state, local state, boxes, and scratch space management.
4 |
5 | ```{testsetup}
6 | import algopy
7 | from algopy_testing import algopy_testing_context
8 |
9 | # Create the context manager for snippets below
10 | ctx_manager = algopy_testing_context()
11 |
12 | # Enter the context
13 | context = ctx_manager.__enter__()
14 | ```
15 |
16 | ## Global State
17 |
18 | Global state is represented as instance attributes on `algopy.Contract` and `algopy.ARC4Contract` classes.
19 |
20 | ```{testcode}
21 | class MyContract(algopy.ARC4Contract):
22 | def __init__(self):
23 | self.state_a = algopy.GlobalState(algopy.UInt64, key="global_uint64")
24 | self.state_b = algopy.UInt64(1)
25 |
26 | # In your test
27 | contract = MyContract()
28 | contract.state_a.value = algopy.UInt64(10)
29 | contract.state_b.value = algopy.UInt64(20)
30 | ```
31 |
32 | ## Local State
33 |
34 | Local state is defined similarly to global state, but accessed using account addresses as keys.
35 |
36 | ```{testcode}
37 | class MyContract(algopy.ARC4Contract):
38 | def __init__(self):
39 | self.local_state_a = algopy.LocalState(algopy.UInt64, key="state_a")
40 |
41 | # In your test
42 | contract = MyContract()
43 | account = context.any.account()
44 | contract.local_state_a[account] = algopy.UInt64(10)
45 | ```
46 |
47 | ## Boxes
48 |
49 | The framework supports various Box abstractions available in `algorand-python`.
50 |
51 | ```{testcode}
52 | class MyContract(algopy.ARC4Contract):
53 | def __init__(self):
54 | self.box_map = algopy.BoxMap(algopy.Bytes, algopy.UInt64)
55 |
56 | @algopy.arc4.abimethod()
57 | def some_method(self, key_a: algopy.Bytes, key_b: algopy.Bytes, key_c: algopy.Bytes) -> None:
58 | self.box = algopy.Box(algopy.UInt64, key=key_a)
59 | self.box.value = algopy.UInt64(1)
60 | self.box_map[key_b] = algopy.UInt64(1)
61 | self.box_map[key_c] = algopy.UInt64(2)
62 |
63 | # In your test
64 | contract = MyContract()
65 | key_a = b"key_a"
66 | key_b = b"key_b"
67 | key_c = b"key_c"
68 |
69 | contract.some_method(algopy.Bytes(key_a), algopy.Bytes(key_b), algopy.Bytes(key_c))
70 |
71 | # Access boxes
72 | box_content = context.ledger.get_box(contract, key_a)
73 | assert context.ledger.box_exists(contract, key_a)
74 |
75 | # Set box content manually
76 | with context.txn.create_group():
77 | context.ledger.set_box(contract, key_a, algopy.op.itob(algopy.UInt64(1)))
78 | ```
79 |
80 | ## Scratch Space
81 |
82 | Scratch space is represented as a list of 256 slots for each transaction.
83 |
84 | ```{testcode}
85 | class MyContract(algopy.Contract, scratch_slots=(1, 2, algopy.urange(3, 20))):
86 | def approval_program(self):
87 | algopy.op.Scratch.store(1, algopy.UInt64(5))
88 | assert algopy.op.Scratch.load_uint64(1) == algopy.UInt64(5)
89 | return True
90 |
91 | # In your test
92 | contract = MyContract()
93 | result = contract.approval_program()
94 |
95 | assert result
96 | scratch_space = context.txn.last_group.get_scratch_space()
97 | assert scratch_space[1] == algopy.UInt64(5)
98 | ```
99 |
100 | For more detailed information, explore the example contracts in the `examples/` directory, the [coverage](../coverage.md) page, and the [API documentation](../api.md).
101 |
102 | ```{testcleanup}
103 | ctx_manager.__exit__(None, None, None)
104 | ```
105 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/puya:docs:index.md:
--------------------------------------------------------------------------------
```markdown
1 | # Algorand Python
2 |
3 | Algorand Python is a partial implementation of the Python programming language that runs on the AVM. It includes a statically typed framework for development of Algorand smart contracts and logic signatures, with Pythonic interfaces to underlying AVM functionality that works with standard Python tooling.
4 |
5 | Algorand Python is compiled for execution on the AVM by PuyaPy, an optimising compiler that ensures the resulting AVM bytecode execution semantics that match the given Python code. PuyaPy produces output that is directly compatible with [AlgoKit typed clients](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md#1-typed-clients) to make deployment and calling easy.
6 |
7 | ## Quick start
8 |
9 | The easiest way to use Algorand Python is to instantiate a template with AlgoKit via `algokit init -t python`. This will give you a full development environment with intellisense, linting, automatic formatting, breakpoint debugging, deployment and CI/CD.
10 |
11 | Alternatively, if you want to start from scratch you can do the following:
12 |
13 | 1. Ensure you have Python 3.12+
14 | 2. Install [AlgoKit CLI](https://github.com/algorandfoundation/algokit-cli?tab=readme-ov-file#install)
15 | 3. Check you can run the compiler:
16 | ```shell
17 | algokit compile py -h
18 | ```
19 | 4. Install Algorand Python into your project `poetry add algorand-python`
20 | 5. Create a contract in a (e.g.) `contract.py` file:
21 | ```python
22 | from algopy import ARC4Contract, arc4
23 | class HelloWorldContract(ARC4Contract):
24 | @arc4.abimethod
25 | def hello(self, name: arc4.String) -> arc4.String:
26 | return "Hello, " + name
27 | ```
28 | 6. Compile the contract:
29 | ```shell
30 | algokit compile py contract.py
31 | ```
32 | 7. You should now have `HelloWorldContract.approval.teal` and `HelloWorldContract.clear.teal` on the file system!
33 | 8. We generally recommend using ARC-32 and [generated typed clients](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md#1-typed-clients) to have the most optimal deployment and consumption experience; to do this you need to ask PuyaPy to output an ARC-32 compatible app spec file:
34 | ```shell
35 | algokit compile py contract.py --output-arc32 --no-output-teal
36 | ```
37 | 9. You should now have `HelloWorldContract.arc32.json`, which can be generated into a client e.g. using AlgoKit CLI:
38 | ```shell
39 | algokit generate client HelloWorldContract.arc32.json --output client.py
40 | ```
41 | 10. From here you can dive into the [examples](https://github.com/algorandfoundation/puya/tree/main/examples) or look at the [documentation](https://algorandfoundation.github.io/puya/).
42 |
43 | ## Programming with Algorand Python
44 |
45 | To get started developing with Algorand Python, please take a look at the [Language Guide](./language-guide.md).
46 |
47 | ## Using the PuyaPy compiler
48 |
49 | To see detailed guidance for using the PuyaPy compiler, please take a look at the [Compiler guide](./compiler.md).
50 |
51 | ```{toctree}
52 | ---
53 | maxdepth: 2
54 | caption: Contents
55 | hidden: true
56 | ---
57 |
58 | language-guide
59 | principles
60 | api
61 | compiler
62 | algopy_testing/index
63 | ```
64 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / TransactionSignatureMultisigSubsignature
2 |
3 | # Class: TransactionSignatureMultisigSubsignature
4 |
5 | [indexerModels](../modules/indexerModels.md).TransactionSignatureMultisigSubsignature
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`TransactionSignatureMultisigSubsignature`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.TransactionSignatureMultisigSubsignature.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.TransactionSignatureMultisigSubsignature.md#attribute_map)
22 | - [publicKey](indexerModels.TransactionSignatureMultisigSubsignature.md#publickey)
23 | - [signature](indexerModels.TransactionSignatureMultisigSubsignature.md#signature)
24 |
25 | ### Methods
26 |
27 | - [get\_obj\_for\_encoding](indexerModels.TransactionSignatureMultisigSubsignature.md#get_obj_for_encoding)
28 | - [from\_obj\_for\_encoding](indexerModels.TransactionSignatureMultisigSubsignature.md#from_obj_for_encoding)
29 |
30 | ## Constructors
31 |
32 | ### constructor
33 |
34 | • **new TransactionSignatureMultisigSubsignature**(`«destructured»`)
35 |
36 | Creates a new `TransactionSignatureMultisigSubsignature` object.
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `«destructured»` | `Object` |
43 | | › `publicKey?` | `string` \| `Uint8Array` |
44 | | › `signature?` | `string` \| `Uint8Array` |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/indexer/models/types.ts:5607
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 | ### publicKey
71 |
72 | • `Optional` **publicKey**: `Uint8Array`
73 |
74 | (pk)
75 |
76 | #### Defined in
77 |
78 | client/v2/indexer/models/types.ts:5595
79 |
80 | ___
81 |
82 | ### signature
83 |
84 | • `Optional` **signature**: `Uint8Array`
85 |
86 | (s)
87 |
88 | #### Defined in
89 |
90 | client/v2/indexer/models/types.ts:5600
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`): [`TransactionSignatureMultisigSubsignature`](indexerModels.TransactionSignatureMultisigSubsignature.md)
123 |
124 | #### Parameters
125 |
126 | | Name | Type |
127 | | :------ | :------ |
128 | | `data` | `Record`\<`string`, `any`\> |
129 |
130 | #### Returns
131 |
132 | [`TransactionSignatureMultisigSubsignature`](indexerModels.TransactionSignatureMultisigSubsignature.md)
133 |
134 | #### Defined in
135 |
136 | client/v2/indexer/models/types.ts:5631
137 |
```
--------------------------------------------------------------------------------
/packages/server/src/tools/apiManager/vestige/protocols.ts:
--------------------------------------------------------------------------------
```typescript
1 | import { Tool, ErrorCode, McpError } from '@modelcontextprotocol/sdk/types.js';
2 | import { ResponseProcessor } from '../../../utils/responseProcessor.js';
3 | import { env } from '../../../env.js';
4 |
5 | export const protocolTools: Tool[] = [
6 | {
7 | name: 'api_vestige_view_protocols',
8 | description: 'Get all protocols',
9 | inputSchema: {
10 | type: 'object',
11 | properties: {
12 | network_id: {
13 | type: 'integer',
14 | description: 'Network ID'
15 | }
16 | },
17 | required: ['network_id']
18 | }
19 | },
20 | {
21 | name: 'api_vestige_view_protocol_by_id',
22 | description: 'Get protocol by id',
23 | inputSchema: {
24 | type: 'object',
25 | properties: {
26 | protocol_id: {
27 | type: 'integer',
28 | description: 'Protocol ID'
29 | },
30 | network_id: {
31 | type: 'integer',
32 | description: 'Network ID'
33 | }
34 | },
35 | required: ['protocol_id', 'network_id']
36 | }
37 | },
38 | {
39 | name: 'api_vestige_view_protocol_volumes',
40 | description: 'Get protocol volumes at specific day. Defaults to current day.',
41 | inputSchema: {
42 | type: 'object',
43 | properties: {
44 | network_id: {
45 | type: 'integer',
46 | description: 'Network ID'
47 | },
48 | timestamp: {
49 | type: 'integer',
50 | description: 'Optional timestamp'
51 | },
52 | denominating_asset_id: {
53 | type: 'integer',
54 | description: 'Optional denominating asset ID',
55 | default: 0
56 | }
57 | },
58 | required: ['network_id']
59 | }
60 | }
61 | ];
62 |
63 | export const handleProtocolTools = ResponseProcessor.wrapResourceHandler(async function handleProtocolTools(args: any): Promise<any> {
64 | const name = args.name;
65 | const baseUrl = env.vestige_api_url;
66 | let endpoint = '';
67 |
68 | switch (name) {
69 | case 'api_vestige_view_protocols':
70 | endpoint = '/protocols';
71 | break;
72 | case 'api_vestige_view_protocol_by_id':
73 | endpoint = `/protocols/${args.protocol_id}`;
74 | break;
75 | case 'api_vestige_view_protocol_volumes':
76 | endpoint = '/protocols/volume';
77 | break;
78 | default:
79 | throw new McpError(
80 | ErrorCode.MethodNotFound,
81 | `Unknown tool: ${name}`
82 | );
83 | }
84 |
85 | try {
86 | // Add query parameters if they exist
87 | const queryParams = new URLSearchParams();
88 | for (const [key, value] of Object.entries(args)) {
89 | if (value !== undefined && !['protocol_id', 'name', 'pageToken'].includes(key)) {
90 | queryParams.append(key, String(value));
91 | }
92 | }
93 | const url = `${baseUrl}${endpoint}${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
94 |
95 | const response = await fetch(url);
96 | if (!response.ok) {
97 | throw new McpError(
98 | ErrorCode.InternalError,
99 | `Vestige API error: ${response.status} ${response.statusText}`
100 | );
101 | }
102 | const data = await response.json();
103 | return data;
104 | } catch (error) {
105 | if (error instanceof McpError) {
106 | throw error;
107 | }
108 | throw new McpError(
109 | ErrorCode.InternalError,
110 | `Failed to fetch protocol data: ${error instanceof Error ? error.message : String(error)}`
111 | );
112 | }
113 | });
114 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.TransactionResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / TransactionResponse
2 |
3 | # Class: TransactionResponse
4 |
5 | [indexerModels](../modules/indexerModels.md).TransactionResponse
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`TransactionResponse`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.TransactionResponse.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.TransactionResponse.md#attribute_map)
22 | - [currentRound](indexerModels.TransactionResponse.md#currentround)
23 | - [transaction](indexerModels.TransactionResponse.md#transaction)
24 |
25 | ### Methods
26 |
27 | - [get\_obj\_for\_encoding](indexerModels.TransactionResponse.md#get_obj_for_encoding)
28 | - [from\_obj\_for\_encoding](indexerModels.TransactionResponse.md#from_obj_for_encoding)
29 |
30 | ## Constructors
31 |
32 | ### constructor
33 |
34 | • **new TransactionResponse**(`«destructured»`)
35 |
36 | Creates a new `TransactionResponse` object.
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `«destructured»` | `Object` |
43 | | › `currentRound` | `number` \| `bigint` |
44 | | › `transaction` | [`Transaction`](indexerModels.Transaction.md) |
45 |
46 | #### Overrides
47 |
48 | BaseModel.constructor
49 |
50 | #### Defined in
51 |
52 | client/v2/indexer/models/types.ts:5318
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 | ### currentRound
71 |
72 | • **currentRound**: `number` \| `bigint`
73 |
74 | Round at which the results were computed.
75 |
76 | #### Defined in
77 |
78 | client/v2/indexer/models/types.ts:5298
79 |
80 | ___
81 |
82 | ### transaction
83 |
84 | • **transaction**: [`Transaction`](indexerModels.Transaction.md)
85 |
86 | Contains all fields common to all transactions and serves as an envelope to all
87 | transactions type. Represents both regular and inner transactions.
88 | Definition:
89 | data/transactions/signedtxn.go : SignedTxn
90 | data/transactions/transaction.go : Transaction
91 |
92 | #### Defined in
93 |
94 | client/v2/indexer/models/types.ts:5307
95 |
96 | ## Methods
97 |
98 | ### get\_obj\_for\_encoding
99 |
100 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
101 |
102 | Get an object ready for encoding to either JSON or msgpack.
103 |
104 | #### Parameters
105 |
106 | | Name | Type | Default value | Description |
107 | | :------ | :------ | :------ | :------ |
108 | | `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. |
109 |
110 | #### Returns
111 |
112 | `Record`\<`string`, `any`\>
113 |
114 | #### Inherited from
115 |
116 | BaseModel.get\_obj\_for\_encoding
117 |
118 | #### Defined in
119 |
120 | client/v2/basemodel.ts:65
121 |
122 | ___
123 |
124 | ### from\_obj\_for\_encoding
125 |
126 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionResponse`](indexerModels.TransactionResponse.md)
127 |
128 | #### Parameters
129 |
130 | | Name | Type |
131 | | :------ | :------ |
132 | | `data` | `Record`\<`string`, `any`\> |
133 |
134 | #### Returns
135 |
136 | [`TransactionResponse`](indexerModels.TransactionResponse.md)
137 |
138 | #### Defined in
139 |
140 | client/v2/indexer/models/types.ts:5336
141 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:telemetry-config.md:
--------------------------------------------------------------------------------
```markdown
1 | title: Telemetry config settings
2 |
3 | #Initialization
4 |
5 | When a node is run using the algod command, before the script starts the server, it configures its telemetry based on the appropriate logging.config file. The algoh command, which hosts algod, configures logging and telemetry before calling algod. Both of these commands can override the config file’s telemetry enable field’s value using the -t flag.
6 | When a node’s telemetry is enabled, a telemetry state (which wraps the node’s hook for the elasticsearch server to which the logs are saved) is added to the node’s logger reflecting the fields contained within the appropriate config file.
7 |
8 | #Configuration
9 |
10 | A node’s telemetry status can be managed using the diagcfg CLI, which modifies the node’s logging.config file. This file instructs the node’s construction of its TelemetryConfig struct, defining the following fields:
11 |
12 | | Key | Data type | Description |
13 | | --- | --------- | ----------- |
14 | | Enable | bool | Determines whether Algorand remote logging is enabled for this node. |
15 | | SendToLog | bool | Determines whether telemetry entries should be logged locally as well. |
16 | | URI | string | The URI for the elastic search server to be logged to. Leave blank for default. |
17 | | Name | string | The name of the machine for remote logging purposes. |
18 | | GUID | string | A unique identifier for the node’s telemetry logging. Except in contrived circumstances, there should exist one GUID across all nodes running on a machine. |
19 | | MinLogLevel | logrus.LogLevel | The lowest event significance that should be logged. |
20 | | ReportHistoryLevel | logrus.LogLevel | The logrus importance level at which the node’s history will be reported. Must be greater than or equal to MinLogLevel. |
21 | | FilePath | string | The location to which the logging.config file instance of the struct will be saved. |
22 | | UserName | string | The username credential for establishing an elastic telemetry hook. |
23 | | Password | string | The password credential for establishing an elastic telemetry hook. |
24 |
25 | An Algorand node host can configure their node’s telemetry before running it by modifying the logging.config file in their node’s data directory, or deleting this file and modifying their ~/.algorand/logging.config file. In addition, the user can alter a running node’s telemetry status using the diagcfg CLI
26 |
27 | #Config File Location
28 |
29 | The file named ‘logging.config’ informs the initial configuration of a node’s telemetry. There will typically be at least two logging.config files on a machine running a node: one for each node the machine is running, stored in that node’s data directory, and a global config file stored in ~/.algorand/. This global file is generally only accessed when a node-specific config file cannot be found.
30 |
31 | However, the “diagcfg telemetry” command tree, which replaces the functionality of “goal logging”, updates or creates both the local and global config files when executing any command that changes the node’s telemetry state, only failing to create the local file if no dataDir is provided, in which case there’s presumably also no node running.
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:ABIArrayDynamicType.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / ABIArrayDynamicType
2 |
3 | # Class: ABIArrayDynamicType
4 |
5 | ## Hierarchy
6 |
7 | - [`ABIType`](ABIType.md)
8 |
9 | ↳ **`ABIArrayDynamicType`**
10 |
11 | ## Table of contents
12 |
13 | ### Constructors
14 |
15 | - [constructor](ABIArrayDynamicType.md#constructor)
16 |
17 | ### Properties
18 |
19 | - [childType](ABIArrayDynamicType.md#childtype)
20 |
21 | ### Methods
22 |
23 | - [byteLen](ABIArrayDynamicType.md#bytelen)
24 | - [decode](ABIArrayDynamicType.md#decode)
25 | - [encode](ABIArrayDynamicType.md#encode)
26 | - [equals](ABIArrayDynamicType.md#equals)
27 | - [isDynamic](ABIArrayDynamicType.md#isdynamic)
28 | - [toABITupleType](ABIArrayDynamicType.md#toabitupletype)
29 | - [toString](ABIArrayDynamicType.md#tostring)
30 | - [from](ABIArrayDynamicType.md#from)
31 |
32 | ## Constructors
33 |
34 | ### constructor
35 |
36 | • **new ABIArrayDynamicType**(`argType`)
37 |
38 | #### Parameters
39 |
40 | | Name | Type |
41 | | :------ | :------ |
42 | | `argType` | [`ABIType`](ABIType.md) |
43 |
44 | #### Overrides
45 |
46 | [ABIType](ABIType.md).[constructor](ABIType.md#constructor)
47 |
48 | #### Defined in
49 |
50 | abi/abi_type.ts:481
51 |
52 | ## Properties
53 |
54 | ### childType
55 |
56 | • **childType**: [`ABIType`](ABIType.md)
57 |
58 | #### Defined in
59 |
60 | abi/abi_type.ts:479
61 |
62 | ## Methods
63 |
64 | ### byteLen
65 |
66 | ▸ **byteLen**(): `never`
67 |
68 | #### Returns
69 |
70 | `never`
71 |
72 | #### Overrides
73 |
74 | [ABIType](ABIType.md).[byteLen](ABIType.md#bytelen)
75 |
76 | #### Defined in
77 |
78 | abi/abi_type.ts:501
79 |
80 | ___
81 |
82 | ### decode
83 |
84 | ▸ **decode**(`byteString`): [`ABIValue`](../modules.md#abivalue)[]
85 |
86 | #### Parameters
87 |
88 | | Name | Type |
89 | | :------ | :------ |
90 | | `byteString` | `Uint8Array` |
91 |
92 | #### Returns
93 |
94 | [`ABIValue`](../modules.md#abivalue)[]
95 |
96 | #### Overrides
97 |
98 | [ABIType](ABIType.md).[decode](ABIType.md#decode)
99 |
100 | #### Defined in
101 |
102 | abi/abi_type.ts:519
103 |
104 | ___
105 |
106 | ### encode
107 |
108 | ▸ **encode**(`value`): `Uint8Array`
109 |
110 | #### Parameters
111 |
112 | | Name | Type |
113 | | :------ | :------ |
114 | | `value` | [`ABIValue`](../modules.md#abivalue) |
115 |
116 | #### Returns
117 |
118 | `Uint8Array`
119 |
120 | #### Overrides
121 |
122 | [ABIType](ABIType.md).[encode](ABIType.md#encode)
123 |
124 | #### Defined in
125 |
126 | abi/abi_type.ts:505
127 |
128 | ___
129 |
130 | ### equals
131 |
132 | ▸ **equals**(`other`): `boolean`
133 |
134 | #### Parameters
135 |
136 | | Name | Type |
137 | | :------ | :------ |
138 | | `other` | [`ABIType`](ABIType.md) |
139 |
140 | #### Returns
141 |
142 | `boolean`
143 |
144 | #### Overrides
145 |
146 | [ABIType](ABIType.md).[equals](ABIType.md#equals)
147 |
148 | #### Defined in
149 |
150 | abi/abi_type.ts:490
151 |
152 | ___
153 |
154 | ### isDynamic
155 |
156 | ▸ **isDynamic**(): `boolean`
157 |
158 | #### Returns
159 |
160 | `boolean`
161 |
162 | #### Overrides
163 |
164 | [ABIType](ABIType.md).[isDynamic](ABIType.md#isdynamic)
165 |
166 | #### Defined in
167 |
168 | abi/abi_type.ts:497
169 |
170 | ___
171 |
172 | ### toABITupleType
173 |
174 | ▸ **toABITupleType**(`length`): [`ABITupleType`](ABITupleType.md)
175 |
176 | #### Parameters
177 |
178 | | Name | Type |
179 | | :------ | :------ |
180 | | `length` | `number` |
181 |
182 | #### Returns
183 |
184 | [`ABITupleType`](ABITupleType.md)
185 |
186 | #### Defined in
187 |
188 | abi/abi_type.ts:528
189 |
190 | ___
191 |
192 | ### toString
193 |
194 | ▸ **toString**(): `string`
195 |
196 | #### Returns
197 |
198 | `string`
199 |
200 | #### Overrides
201 |
202 | [ABIType](ABIType.md).[toString](ABIType.md#tostring)
203 |
204 | #### Defined in
205 |
206 | abi/abi_type.ts:486
207 |
208 | ___
209 |
210 | ### from
211 |
212 | ▸ `Static` **from**(`str`): [`ABIType`](ABIType.md)
213 |
214 | #### Parameters
215 |
216 | | Name | Type |
217 | | :------ | :------ |
218 | | `str` | `string` |
219 |
220 | #### Returns
221 |
222 | [`ABIType`](ABIType.md)
223 |
224 | #### Inherited from
225 |
226 | [ABIType](ABIType.md).[from](ABIType.md#from)
227 |
228 | #### Defined in
229 |
230 | abi/abi_type.ts:57
231 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.AccountAssetHolding.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / AccountAssetHolding
2 |
3 | # Class: AccountAssetHolding
4 |
5 | [modelsv2](../modules/modelsv2.md).AccountAssetHolding
6 |
7 | AccountAssetHolding describes the account's asset holding and asset parameters
8 | (if either exist) for a specific asset ID.
9 |
10 | ## Hierarchy
11 |
12 | - `default`
13 |
14 | ↳ **`AccountAssetHolding`**
15 |
16 | ## Table of contents
17 |
18 | ### Constructors
19 |
20 | - [constructor](modelsv2.AccountAssetHolding.md#constructor)
21 |
22 | ### Properties
23 |
24 | - [assetHolding](modelsv2.AccountAssetHolding.md#assetholding)
25 | - [assetParams](modelsv2.AccountAssetHolding.md#assetparams)
26 | - [attribute\_map](modelsv2.AccountAssetHolding.md#attribute_map)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](modelsv2.AccountAssetHolding.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](modelsv2.AccountAssetHolding.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new AccountAssetHolding**(`«destructured»`)
38 |
39 | Creates a new `AccountAssetHolding` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `assetHolding` | [`AssetHolding`](modelsv2.AssetHolding.md) |
47 | | › `assetParams?` | [`AssetParams`](modelsv2.AssetParams.md) |
48 |
49 | #### Overrides
50 |
51 | BaseModel.constructor
52 |
53 | #### Defined in
54 |
55 | client/v2/algod/models/types.ts:548
56 |
57 | ## Properties
58 |
59 | ### assetHolding
60 |
61 | • **assetHolding**: [`AssetHolding`](modelsv2.AssetHolding.md)
62 |
63 | (asset) Details about the asset held by this account.
64 | The raw account uses `AssetHolding` for this type.
65 |
66 | #### Defined in
67 |
68 | client/v2/algod/models/types.ts:533
69 |
70 | ___
71 |
72 | ### assetParams
73 |
74 | • `Optional` **assetParams**: [`AssetParams`](modelsv2.AssetParams.md)
75 |
76 | (apar) parameters of the asset held by this account.
77 | The raw account uses `AssetParams` for this type.
78 |
79 | #### Defined in
80 |
81 | client/v2/algod/models/types.ts:539
82 |
83 | ___
84 |
85 | ### attribute\_map
86 |
87 | • **attribute\_map**: `Record`\<`string`, `string`\>
88 |
89 | #### Inherited from
90 |
91 | BaseModel.attribute\_map
92 |
93 | #### Defined in
94 |
95 | client/v2/basemodel.ts:56
96 |
97 | ## Methods
98 |
99 | ### get\_obj\_for\_encoding
100 |
101 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
102 |
103 | Get an object ready for encoding to either JSON or msgpack.
104 |
105 | #### Parameters
106 |
107 | | Name | Type | Default value | Description |
108 | | :------ | :------ | :------ | :------ |
109 | | `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. |
110 |
111 | #### Returns
112 |
113 | `Record`\<`string`, `any`\>
114 |
115 | #### Inherited from
116 |
117 | BaseModel.get\_obj\_for\_encoding
118 |
119 | #### Defined in
120 |
121 | client/v2/basemodel.ts:65
122 |
123 | ___
124 |
125 | ### from\_obj\_for\_encoding
126 |
127 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AccountAssetHolding`](modelsv2.AccountAssetHolding.md)
128 |
129 | #### Parameters
130 |
131 | | Name | Type |
132 | | :------ | :------ |
133 | | `data` | `Record`\<`string`, `any`\> |
134 |
135 | #### Returns
136 |
137 | [`AccountAssetHolding`](modelsv2.AccountAssetHolding.md)
138 |
139 | #### Defined in
140 |
141 | client/v2/algod/models/types.ts:566
142 |
```