This is page 15 of 93. Use http://codebase.md/goplausible/algorand-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── llms-install.md
├── llms.txt
├── package.json
├── packages
│ ├── client
│ │ ├── .env.example
│ │ ├── package.json
│ │ ├── README.md
│ │ ├── src
│ │ │ ├── env.ts
│ │ │ ├── index.ts
│ │ │ └── LocalWallet.ts
│ │ └── tsconfig.json
│ └── server
│ ├── .env.example
│ ├── API specs
│ │ ├── algod_api.json
│ │ ├── indexer_api.json
│ │ ├── mcp.json
│ │ ├── nfd_api.json
│ │ ├── ultrade_api.json
│ │ ├── vestige_api.json
│ │ └── vestige_free_api.json
│ ├── Dockerfile
│ ├── jest.config.js
│ ├── package.json
│ ├── README.md
│ ├── smithery.yaml
│ ├── src
│ │ ├── algorand-client.ts
│ │ ├── env.ts
│ │ ├── index.ts
│ │ ├── resources
│ │ │ ├── index.ts
│ │ │ ├── knowledge
│ │ │ │ ├── ARCs.txt
│ │ │ │ ├── developers-algokit-architecture-decisions.txt
│ │ │ │ ├── developers-algokit-cli.txt
│ │ │ │ ├── developers-algokit-utils-python.txt
│ │ │ │ ├── developers-algokit-utils-typescript.txt
│ │ │ │ ├── developers-clis.txt
│ │ │ │ ├── developers-details.txt
│ │ │ │ ├── developers-liquid-auth.txt
│ │ │ │ ├── developers-nodes.txt
│ │ │ │ ├── developers-puya.txt
│ │ │ │ ├── developers-python.txt
│ │ │ │ ├── developers-sdks-js.txt
│ │ │ │ ├── developers-sdks-python.txt
│ │ │ │ ├── developers-tealscript.txt
│ │ │ │ ├── developers.txt
│ │ │ │ ├── index.ts
│ │ │ │ ├── taxonomy
│ │ │ │ │ ├── algokit-cli:README.md
│ │ │ │ │ ├── algokit:cli:algokit.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-11_brew_install.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-13_native_binaries.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md
│ │ │ │ │ ├── algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md
│ │ │ │ │ ├── algokit:cli:articles:output_stability.md
│ │ │ │ │ ├── algokit:cli:cli:index.md
│ │ │ │ │ ├── algokit:cli:features:compile.md
│ │ │ │ │ ├── algokit:cli:features:completions.md
│ │ │ │ │ ├── algokit:cli:features:config.md
│ │ │ │ │ ├── algokit:cli:features:dispenser.md
│ │ │ │ │ ├── algokit:cli:features:doctor.md
│ │ │ │ │ ├── algokit:cli:features:explore.md
│ │ │ │ │ ├── algokit:cli:features:generate.md
│ │ │ │ │ ├── algokit:cli:features:goal.md
│ │ │ │ │ ├── algokit:cli:features:init.md
│ │ │ │ │ ├── algokit:cli:features:localnet.md
│ │ │ │ │ ├── algokit:cli:features:project:bootstrap.md
│ │ │ │ │ ├── algokit:cli:features:project:deploy.md
│ │ │ │ │ ├── algokit:cli:features:project:link.md
│ │ │ │ │ ├── algokit:cli:features:project:list.md
│ │ │ │ │ ├── algokit:cli:features:project:run.md
│ │ │ │ │ ├── algokit:cli:features:project.md
│ │ │ │ │ ├── algokit:cli:features:tasks:analyze.md
│ │ │ │ │ ├── algokit:cli:features:tasks:ipfs.md
│ │ │ │ │ ├── algokit:cli:features:tasks:mint.md
│ │ │ │ │ ├── algokit:cli:features:tasks:nfd.md
│ │ │ │ │ ├── algokit:cli:features:tasks:opt.md
│ │ │ │ │ ├── algokit:cli:features:tasks:send.md
│ │ │ │ │ ├── algokit:cli:features:tasks:sign.md
│ │ │ │ │ ├── algokit:cli:features:tasks:transfer.md
│ │ │ │ │ ├── algokit:cli:features:tasks:vanity_address.md
│ │ │ │ │ ├── algokit:cli:features:tasks:wallet.md
│ │ │ │ │ ├── algokit:cli:features:tasks.md
│ │ │ │ │ ├── algokit:cli:tutorials:algokit-template.md
│ │ │ │ │ ├── algokit:cli:tutorials:intro.md
│ │ │ │ │ ├── algokit:cli:tutorials:smart-contracts.md
│ │ │ │ │ ├── algokit:docs:testnet_api.md
│ │ │ │ │ ├── algokit:lora:README.md
│ │ │ │ │ ├── algokit:README.md
│ │ │ │ │ ├── algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:markdown:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:markdown:index.md
│ │ │ │ │ ├── algokit:utils:python:README.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:debugger.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:python:source:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:python:source:index.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:account.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:algorand-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:amount.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app-deploy.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:app.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:asset.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:dispenser-client.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:event-emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction-composer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:capabilities:typed-app-clients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TestLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:testing.TransactionLogger.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.MultisigAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_account.SigningAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.AppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_app_manager.AppManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:classes:types_logic_error.LogicError.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_app.OnUpdate.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_indexer.SignatureType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppLookup.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppState.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxName.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxReference.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_config.Config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md
│ │ │ │ │ ├── algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:index.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_account.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_interface.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_algorand_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_amount.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_arc56.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_deployer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_factory.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_app.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_asset.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_async_event_emitter.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_client_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_composer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_config.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_debugging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client_spec.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_dispenser_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_expand.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_indexer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_kmd_account_manager.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_lifecycle_events.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logging.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_logic_error.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_network_client.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_testing.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transaction.md
│ │ │ │ │ ├── algokit:utils:typescript:code:modules:types_transfer.md
│ │ │ │ │ ├── algokit:utils:typescript:code:README.md
│ │ │ │ │ ├── algokit:utils:typescript:README.md
│ │ │ │ │ ├── algokit:utils:typescript:v7-migration.md
│ │ │ │ │ ├── algokit:utils:typescript:v8-migration.md
│ │ │ │ │ ├── ARCs:ARC-template.md
│ │ │ │ │ ├── ARCs:assets:arc-0012:README.md
│ │ │ │ │ ├── ARCs:assets:arc-0034:TemplateForm.md
│ │ │ │ │ ├── ARCs:assets:arc-0062:README.md
│ │ │ │ │ ├── ARCs:pages:nfts.md
│ │ │ │ │ ├── ARCs:pages:wallets.md
│ │ │ │ │ ├── ARCs:README.md
│ │ │ │ │ ├── ARCs:specs:arc-0000.md
│ │ │ │ │ ├── ARCs:specs:arc-0001.md
│ │ │ │ │ ├── ARCs:specs:arc-0002.md
│ │ │ │ │ ├── ARCs:specs:arc-0003.md
│ │ │ │ │ ├── ARCs:specs:arc-0004.md
│ │ │ │ │ ├── ARCs:specs:arc-0005.md
│ │ │ │ │ ├── ARCs:specs:arc-0006.md
│ │ │ │ │ ├── ARCs:specs:arc-0007.md
│ │ │ │ │ ├── ARCs:specs:arc-0008.md
│ │ │ │ │ ├── ARCs:specs:arc-0009.md
│ │ │ │ │ ├── ARCs:specs:arc-0010.md
│ │ │ │ │ ├── ARCs:specs:arc-0011.md
│ │ │ │ │ ├── ARCs:specs:arc-0012.md
│ │ │ │ │ ├── ARCs:specs:arc-0015.md
│ │ │ │ │ ├── ARCs:specs:arc-0016.md
│ │ │ │ │ ├── ARCs:specs:arc-0018.md
│ │ │ │ │ ├── ARCs:specs:arc-0019.md
│ │ │ │ │ ├── ARCs:specs:arc-0020.md
│ │ │ │ │ ├── ARCs:specs:arc-0021.md
│ │ │ │ │ ├── ARCs:specs:arc-0022.md
│ │ │ │ │ ├── ARCs:specs:arc-0023.md
│ │ │ │ │ ├── ARCs:specs:arc-0025.md
│ │ │ │ │ ├── ARCs:specs:arc-0026.md
│ │ │ │ │ ├── ARCs:specs:arc-0028.md
│ │ │ │ │ ├── ARCs:specs:arc-0032.md
│ │ │ │ │ ├── ARCs:specs:arc-0033.md
│ │ │ │ │ ├── ARCs:specs:arc-0034.md
│ │ │ │ │ ├── ARCs:specs:arc-0035.md
│ │ │ │ │ ├── ARCs:specs:arc-0036.md
│ │ │ │ │ ├── ARCs:specs:arc-0042.md
│ │ │ │ │ ├── ARCs:specs:arc-0047.md
│ │ │ │ │ ├── ARCs:specs:arc-0048.md
│ │ │ │ │ ├── ARCs:specs:arc-0049.md
│ │ │ │ │ ├── ARCs:specs:arc-0054.md
│ │ │ │ │ ├── ARCs:specs:arc-0055.md
│ │ │ │ │ ├── ARCs:specs:arc-0056.md
│ │ │ │ │ ├── ARCs:specs:arc-0059.md
│ │ │ │ │ ├── ARCs:specs:arc-0062.md
│ │ │ │ │ ├── ARCs:specs:arc-0065.md
│ │ │ │ │ ├── ARCs:specs:arc-0069.md
│ │ │ │ │ ├── ARCs:specs:arc-0072.md
│ │ │ │ │ ├── ARCs:specs:arc-0073.md
│ │ │ │ │ ├── ARCs:specs:arc-0074.md
│ │ │ │ │ ├── ARCs:specs:arc-0076.md
│ │ │ │ │ ├── ARCs:specs:arc-0078.md
│ │ │ │ │ ├── ARCs:specs:arc-0079.md
│ │ │ │ │ ├── ARCs:specs:arc-0200.md
│ │ │ │ │ ├── clis_index.md
│ │ │ │ │ ├── developer:docs:about.md
│ │ │ │ │ ├── developer:docs:clis:algokey:algokey.md
│ │ │ │ │ ├── developer:docs:clis:algokey:generate.md
│ │ │ │ │ ├── developer:docs:clis:algokey:import.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:append-auth-addr.md
│ │ │ │ │ ├── developer:docs:clis:algokey:multisig:multisig.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:info.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:part.md
│ │ │ │ │ ├── developer:docs:clis:algokey:part:reparent.md
│ │ │ │ │ ├── developer:docs:clis:algokey:sign.md
│ │ │ │ │ ├── developer:docs:clis:conduit:conduit.md
│ │ │ │ │ ├── developer:docs:clis:conduit:init.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:exporters.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:importers.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:list.md
│ │ │ │ │ ├── developer:docs:clis:conduit:list:processors.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:diagcfg.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:metric.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:metric:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:disable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:enable.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:endpoint.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:name.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:status.md
│ │ │ │ │ ├── developer:docs:clis:diagcfg:telemetry:telemetry.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:restart.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:start.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:status.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:stop.md
│ │ │ │ │ ├── developer:docs:clis:goal:node:wait.md
│ │ │ │ │ ├── developer:docs:clis:goal:protocols.md
│ │ │ │ │ ├── developer:docs:clis:goal:report.md
│ │ │ │ │ ├── developer:docs:clis:goal:version.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:list.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:new.md
│ │ │ │ │ ├── developer:docs:clis:goal:wallet:wallet.md
│ │ │ │ │ ├── developer:docs:clis:indexer:api-config.md
│ │ │ │ │ ├── developer:docs:clis:indexer:daemon.md
│ │ │ │ │ ├── developer:docs:clis:indexer:indexer.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:util.md
│ │ │ │ │ ├── developer:docs:clis:indexer:util:validator.md
│ │ │ │ │ ├── developer:docs:clis:kmd.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:debug.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:remote.md
│ │ │ │ │ ├── developer:docs:clis:tealdbg:tealdbg.md
│ │ │ │ │ ├── developer:docs:details:accounts:create.md
│ │ │ │ │ ├── developer:docs:details:accounts:index.md
│ │ │ │ │ ├── developer:docs:details:accounts:rekey.md
│ │ │ │ │ ├── developer:docs:details:algorand_consensus.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:betanet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:index.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:mainnet.md
│ │ │ │ │ ├── developer:docs:details:algorand-networks:testnet.md
│ │ │ │ │ ├── developer:docs:details:asa.md
│ │ │ │ │ ├── developer:docs:details:atc.md
│ │ │ │ │ ├── developer:docs:details:atomic_transfers.md
│ │ │ │ │ ├── developer:docs:details:conduit.md
│ │ │ │ │ ├── developer:docs:details:crust.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:jsonspec.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v1.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v10.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v2.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v3.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v4.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v5.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v6.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v7.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v8.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:opcodes:v9.md
│ │ │ │ │ ├── developer:docs:details:dapps:avm:teal:specification.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:ABI:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:create.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:innertx.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:state.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:apps:txs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:debugging.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:apps.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:guidelines.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:index.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:modes.md
│ │ │ │ │ ├── developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:beaker.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:pyteal.md
│ │ │ │ │ ├── developer:docs:details:dapps:writing-contracts:python.md
│ │ │ │ │ ├── developer:docs:details:encoding.md
│ │ │ │ │ ├── developer:docs:details:ethereum_to_algorand.md
│ │ │ │ │ ├── developer:docs:details:index.md
│ │ │ │ │ ├── developer:docs:details:indexer.md
│ │ │ │ │ ├── developer:docs:details:parameter_tables.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:index.md
│ │ │ │ │ ├── developer:docs:details:stateproofs:light_client.md
│ │ │ │ │ ├── developer:docs:details:technical_faq.md
│ │ │ │ │ ├── developer:docs:details:transactions:index.md
│ │ │ │ │ ├── developer:docs:details:transactions:offline_transactions.md
│ │ │ │ │ ├── developer:docs:details:transactions:payment_prompts.md
│ │ │ │ │ ├── developer:docs:details:transactions:signatures.md
│ │ │ │ │ ├── developer:docs:details:transactions:transactions.md
│ │ │ │ │ ├── developer:docs:details:useful_resources.md
│ │ │ │ │ ├── developer:docs:get-started:algokit.md
│ │ │ │ │ ├── developer:docs:get-started:basics:what_is_blockchain.md
│ │ │ │ │ ├── developer:docs:get-started:basics:whats_a_dapp.md
│ │ │ │ │ ├── developer:docs:get-started:basics:where_to_start.md
│ │ │ │ │ ├── developer:docs:get-started:basics:why_algorand.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:ft.md
│ │ │ │ │ ├── developer:docs:get-started:tokenization:nft.md
│ │ │ │ │ ├── developer:docs:index.md
│ │ │ │ │ ├── developer:docs:rest-apis:algod.md
│ │ │ │ │ ├── developer:docs:rest-apis:indexer.md
│ │ │ │ │ ├── developer:docs:rest-apis:kmd.md
│ │ │ │ │ ├── developer:docs:rest-apis:restendpoints.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:catchup.md
│ │ │ │ │ ├── developer:docs:run-a-node:operations:switch_networks.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:generate_keys.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:index.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:offline.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:online.md
│ │ │ │ │ ├── developer:docs:run-a-node:participate:renew.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:artifacts.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:config.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:relay.md
│ │ │ │ │ ├── developer:docs:run-a-node:reference:telemetry-config.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:indexer.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:install.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:node-troubleshooting.md
│ │ │ │ │ ├── developer:docs:run-a-node:setup:types.md
│ │ │ │ │ ├── developer:docs:sdks:go:index.md
│ │ │ │ │ ├── developer:docs:sdks:index.md
│ │ │ │ │ ├── developer:docs:sdks:java:index.md
│ │ │ │ │ ├── developer:docs:sdks:javascript:index.md
│ │ │ │ │ ├── developer:docs:sdks:python:index.md
│ │ │ │ │ ├── developer:python:code:example:accounts.md
│ │ │ │ │ ├── developer:python:code:example:arc4_types.md
│ │ │ │ │ ├── developer:python:code:example:assets.md
│ │ │ │ │ ├── developer:python:code:example:box_storage.md
│ │ │ │ │ ├── developer:python:code:example:control_flow.md
│ │ │ │ │ ├── developer:python:code:example:crypto:merkle_tree.md
│ │ │ │ │ ├── developer:python:code:example:defi:amm.md
│ │ │ │ │ ├── developer:python:code:example:defi:auction.md
│ │ │ │ │ ├── developer:python:code:example:defi:htlc_logicsig.md
│ │ │ │ │ ├── developer:python:code:example:defi:marketplace.md
│ │ │ │ │ ├── developer:python:code:example:events:arc28_events.md
│ │ │ │ │ ├── developer:python:code:example:global_storage.md
│ │ │ │ │ ├── developer:python:code:example:governance:simple_voting.md
│ │ │ │ │ ├── developer:python:code:example:hello_world.md
│ │ │ │ │ ├── developer:python:code:example:inner_transactions.md
│ │ │ │ │ ├── developer:python:code:example:local_storage.md
│ │ │ │ │ ├── developer:python:code:example:nft:proof_of_attendance.md
│ │ │ │ │ ├── developer:python:code:example:privacy:zk_whitelist.md
│ │ │ │ │ ├── developer:python:code:example:scratch_storage.md
│ │ │ │ │ ├── developer:python:code:example:self_payment.md
│ │ │ │ │ ├── developer:python:code:example:struct_in_box.md
│ │ │ │ │ ├── developer:python:code:example:subsidize_app_call.md
│ │ │ │ │ ├── developer:python:code:example:transactions.md
│ │ │ │ │ ├── developer:python:code:example:utility:calculator.md
│ │ │ │ │ ├── devportal-code-examples:projects:python-contract-examples:README.md
│ │ │ │ │ ├── devportal-code-examples:README.md
│ │ │ │ │ ├── docs:.walletconnect:index.md
│ │ │ │ │ ├── docs:.walletconnect:walletconnect-schema.md
│ │ │ │ │ ├── docs:README.md
│ │ │ │ │ ├── docs:scripts:example_tracker:example_list.md
│ │ │ │ │ ├── docs:scripts:README.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── liquid_auth_index.md
│ │ │ │ │ ├── liquid-auth:ARCHITECTURE.md
│ │ │ │ │ ├── liquid-auth:decisions:1-Service-Authentication.md
│ │ │ │ │ ├── liquid-auth:decisions:2-Bidirectional-Communication.md
│ │ │ │ │ ├── liquid-auth:decisions:3-Peer-to-Peer-Signaling.md
│ │ │ │ │ ├── liquid-auth:decisions:4-Fido-Extension.md
│ │ │ │ │ ├── liquid-auth:decisions:README.md
│ │ │ │ │ ├── liquid-auth:docs:architecture.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:authenticate.md
│ │ │ │ │ ├── liquid-auth:docs:clients:android:provider-service:register.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:authentication.md
│ │ │ │ │ ├── liquid-auth:docs:clients:browser:example.md
│ │ │ │ │ ├── liquid-auth:docs:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:README.md
│ │ │ │ │ ├── liquid-auth:docs:server:environment-variables.md
│ │ │ │ │ ├── liquid-auth:docs:server:integrations.md
│ │ │ │ │ ├── liquid-auth:docs:server:introduction.md
│ │ │ │ │ ├── liquid-auth:docs:server:running-locally.md
│ │ │ │ │ ├── liquid-auth:README.md
│ │ │ │ │ ├── liquid-auth:SEQUENCE.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md
│ │ │ │ │ ├── liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md
│ │ │ │ │ ├── liquid-auth:sites:express-dapp:README.md
│ │ │ │ │ ├── liquid-auth:VISION.md
│ │ │ │ │ ├── puya_index.md
│ │ │ │ │ ├── puya:docs:algopy_testing:index.md
│ │ │ │ │ ├── puya:docs:api-algopy.arc4.md
│ │ │ │ │ ├── puya:docs:api-algopy.gtxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.itxn.md
│ │ │ │ │ ├── puya:docs:api-algopy.md
│ │ │ │ │ ├── puya:docs:api-algopy.op.md
│ │ │ │ │ ├── puya:docs:api.md
│ │ │ │ │ ├── puya:docs:compiler.md
│ │ │ │ │ ├── puya:docs:index.md
│ │ │ │ │ ├── puya:docs:language-guide.md
│ │ │ │ │ ├── puya:docs:lg-arc28.md
│ │ │ │ │ ├── puya:docs:lg-arc4.md
│ │ │ │ │ ├── puya:docs:lg-builtins.md
│ │ │ │ │ ├── puya:docs:lg-calling-apps.md
│ │ │ │ │ ├── puya:docs:lg-compile.md
│ │ │ │ │ ├── puya:docs:lg-control.md
│ │ │ │ │ ├── puya:docs:lg-errors.md
│ │ │ │ │ ├── puya:docs:lg-logs.md
│ │ │ │ │ ├── puya:docs:lg-modules.md
│ │ │ │ │ ├── puya:docs:lg-opcode-budget.md
│ │ │ │ │ ├── puya:docs:lg-ops.md
│ │ │ │ │ ├── puya:docs:lg-storage.md
│ │ │ │ │ ├── puya:docs:lg-structure.md
│ │ │ │ │ ├── puya:docs:lg-transactions.md
│ │ │ │ │ ├── puya:docs:lg-types.md
│ │ │ │ │ ├── puya:docs:lg-unsupported-python-features.md
│ │ │ │ │ ├── puya:docs:principles.md
│ │ │ │ │ ├── puya:examples:auction:README.md
│ │ │ │ │ ├── puya:python:testing:docs:algopy.md
│ │ │ │ │ ├── puya:python:testing:docs:api.md
│ │ │ │ │ ├── puya:python:testing:docs:coverage.md
│ │ │ │ │ ├── puya:python:testing:docs:examples.md
│ │ │ │ │ ├── puya:python:testing:docs:faq.md
│ │ │ │ │ ├── puya:python:testing:docs:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:arc4-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:avm-types.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:concepts.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:contract-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:index.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:opcodes.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:signature-testing.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:state-management.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:subroutines.md
│ │ │ │ │ ├── puya:python:testing:docs:testing-guide:transactions.md
│ │ │ │ │ ├── puya:python:testing:examples:README.md
│ │ │ │ │ ├── puya:python:testing:README.md
│ │ │ │ │ ├── puya:README.md
│ │ │ │ │ ├── puya:src:puya:ARCHITECTURE.md
│ │ │ │ │ ├── puya:src:puyapy:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md
│ │ │ │ │ ├── puya:src:puyapy:awst_build:README.md
│ │ │ │ │ ├── puya:stubs:README.md
│ │ │ │ │ ├── puya:tests:test_expected_output:README.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md
│ │ │ │ │ ├── puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md
│ │ │ │ │ ├── puya:typescript:docs:README.md
│ │ │ │ │ ├── puya:typescript:packages:algo-ts:readme.md
│ │ │ │ │ ├── puya:typescript:README.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIAddressType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayDynamicType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIArrayStaticType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIBoolType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIByteType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIContract.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIInterface.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIMethod.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIStringType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABITupleType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUfixedType.md
│ │ │ │ │ ├── SDKs:javascript:classes:ABIUintType.md
│ │ │ │ │ ├── SDKs:javascript:classes:Algodv2.md
│ │ │ │ │ ├── SDKs:javascript:classes:AtomicTransactionComposer.md
│ │ │ │ │ ├── SDKs:javascript:classes:DryrunResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:Indexer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogData.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetBalancesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetHoldingsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.AssetsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Block.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockRewards.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeState.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BlockUpgradeVote.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HashFactory.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.HealthCheck.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.IndexerStateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MerkleArrayProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.MiniAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.ParticipationUpdates.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofFields.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofParticipant.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofReveal.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofSigSlot.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofTracking.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateProofVerifier.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.StateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.Transaction.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionApplication.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetFreeze.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionAssetTransfer.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionKeyreg.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionPayment.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureLogicsig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisig.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:indexerModels.TransactionStateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:Kmd.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSig.md
│ │ │ │ │ ├── SDKs:javascript:classes:LogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Account.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountApplicationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountAssetsInformationResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountParticipation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AccountStateDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AppCallLogs.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Application.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationKVStorage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationLocalState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateOperation.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ApplicationStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Asset.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHolding.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetHoldingReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AssetParams.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.AvmValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockHashResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockLogsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BlockTxidsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Box.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxDescriptor.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxesResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.BuildVersion.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.CompileResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DisassembleResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunSource.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunState.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.DryrunTxnResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ErrorResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.EvalDeltaKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.GetSyncRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.KvDelta.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.LightBlockHeaderProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.NodeStatusResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PendingTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.PostTransactionsResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.ScratchChange.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateInitialStates.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequest.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTraceConfig.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionGroupResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateTransactionResult.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationEvalOverrides.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SimulationTransactionExecTrace.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProof.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.StateProofMessage.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.SupplyResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealKeyValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TealValue.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionParametersResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.TransactionProofResponse.md
│ │ │ │ │ ├── SDKs:javascript:classes:modelsv2.Version.md
│ │ │ │ │ ├── SDKs:javascript:classes:SourceMap.md
│ │ │ │ │ ├── SDKs:javascript:classes:Transaction.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABIReferenceType.md
│ │ │ │ │ ├── SDKs:javascript:enums:ABITransactionType.md
│ │ │ │ │ ├── SDKs:javascript:enums:AtomicTransactionComposerStatus.md
│ │ │ │ │ ├── SDKs:javascript:enums:IntDecoding.md
│ │ │ │ │ ├── SDKs:javascript:enums:OnApplicationComplete.md
│ │ │ │ │ ├── SDKs:javascript:enums:TransactionType.md
│ │ │ │ │ ├── SDKs:javascript:examples:README.md
│ │ │ │ │ ├── SDKs:javascript:FAQ.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworkInfo.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractNetworks.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIContractParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIInterfaceParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodArgParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIMethodReturnParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:ABIResult.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Account.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:Address.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:AlgodTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClient.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientError.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BaseHTTPClientResponse.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:BoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:CustomTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedAssetParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedBoxReference.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedGlobalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLocalStateSchema.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedLogicSigAccount.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedMultisig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedSubsig.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:EncodedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:IndexerTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:KMDTokenHeader.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:MultisigMetadata.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SignedTransaction.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:SuggestedParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionParams.md
│ │ │ │ │ ├── SDKs:javascript:interfaces:TransactionWithSigner.md
│ │ │ │ │ ├── SDKs:javascript:modules:indexerModels.md
│ │ │ │ │ ├── SDKs:javascript:modules:modelsv2.md
│ │ │ │ │ ├── SDKs:javascript:modules.md
│ │ │ │ │ ├── SDKs:javascript:README.md
│ │ │ │ │ ├── SDKs:python:algosdk:v2client:harness:README.md
│ │ │ │ │ ├── SDKs:python:examples:README.md
│ │ │ │ │ ├── SDKs:python:README.md
│ │ │ │ │ ├── tealscript:examples_amm_README.md
│ │ │ │ │ ├── tealscript:examples_auction_README.md
│ │ │ │ │ ├── tealscript:examples_big_box_README.md
│ │ │ │ │ ├── tealscript:examples_itxns_README.md
│ │ │ │ │ ├── tealscript:examples_lsig_with_app_README.md
│ │ │ │ │ ├── tealscript:examples_reti_README.md
│ │ │ │ │ ├── tealscript:FEATURES.md
│ │ │ │ │ ├── tealscript:guides_atomic_txn.md
│ │ │ │ │ ├── tealscript:guides_features.md
│ │ │ │ │ ├── tealscript:guides_getting_started.md
│ │ │ │ │ ├── tealscript:guides_inner_transactions.md
│ │ │ │ │ ├── tealscript:guides_lifecycle.md
│ │ │ │ │ ├── tealscript:guides_math.md
│ │ │ │ │ ├── tealscript:guides_methods.md
│ │ │ │ │ ├── tealscript:guides_multiple_contracts.md
│ │ │ │ │ ├── tealscript:guides_pyteal.md
│ │ │ │ │ ├── tealscript:guides_storage.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_arrays.md
│ │ │ │ │ ├── tealscript:guides_Supported Types_numbers.md
│ │ │ │ │ ├── TEALScript:README.md
│ │ │ │ │ ├── tealscript:tests_test_package_README.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0001-intro.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0002-init.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0003-contract.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0004-artifacts.md
│ │ │ │ │ ├── tealscript:tutorials_Hello World_0005-hello.md
│ │ │ │ │ └── tealscript:tutorials_Hello World_0006-test.md
│ │ │ │ └── taxonomy-categories
│ │ │ │ ├── algokit-utils.json
│ │ │ │ ├── algokit.json
│ │ │ │ ├── arcs.json
│ │ │ │ ├── clis.json
│ │ │ │ ├── details.json
│ │ │ │ ├── developers.json
│ │ │ │ ├── liquid-auth.json
│ │ │ │ ├── nodes.json
│ │ │ │ ├── puya.json
│ │ │ │ ├── python.json
│ │ │ │ ├── sdks.json
│ │ │ │ └── tealscript.json
│ │ │ └── wallet
│ │ │ └── index.ts
│ │ ├── tools
│ │ │ ├── accountManager.ts
│ │ │ ├── algodManager.ts
│ │ │ ├── apiManager
│ │ │ │ ├── algod
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── example
│ │ │ │ │ ├── get-balance.ts
│ │ │ │ │ └── index.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── indexer
│ │ │ │ │ ├── account.ts
│ │ │ │ │ ├── application.ts
│ │ │ │ │ ├── asset.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ └── transaction.ts
│ │ │ │ ├── nfd
│ │ │ │ │ └── index.ts
│ │ │ │ ├── tinyman
│ │ │ │ │ ├── analytics.ts
│ │ │ │ │ ├── bootstrap.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── liquidity.ts
│ │ │ │ │ ├── opt_in.ts
│ │ │ │ │ ├── pool.ts
│ │ │ │ │ ├── remove_liquidity.ts
│ │ │ │ │ └── swap.ts
│ │ │ │ ├── ultrade
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── market.ts
│ │ │ │ │ ├── system.ts
│ │ │ │ │ └── wallet.ts
│ │ │ │ └── vestige
│ │ │ │ ├── assets.ts
│ │ │ │ ├── balances.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── networks.ts
│ │ │ │ ├── notes.ts
│ │ │ │ ├── pools.ts
│ │ │ │ ├── protocols.ts
│ │ │ │ ├── swaps.ts
│ │ │ │ └── vaults.ts
│ │ │ ├── arc26Manager.ts
│ │ │ ├── index.ts
│ │ │ ├── knowledgeManager.ts
│ │ │ ├── transactionManager
│ │ │ │ ├── accountTransactions.ts
│ │ │ │ ├── appTransactions
│ │ │ │ │ ├── callTxn.ts
│ │ │ │ │ ├── clearTxn.ts
│ │ │ │ │ ├── closeOutTxn.ts
│ │ │ │ │ ├── createTxn.ts
│ │ │ │ │ ├── deleteTxn.ts
│ │ │ │ │ ├── index.ts
│ │ │ │ │ ├── optInTxn.ts
│ │ │ │ │ ├── test
│ │ │ │ │ │ ├── counter_approval.teal
│ │ │ │ │ │ ├── counter_clear.teal
│ │ │ │ │ │ ├── storage_test_approval_v2.teal
│ │ │ │ │ │ ├── storage_test_approval.teal
│ │ │ │ │ │ └── storage_test_clear.teal
│ │ │ │ │ ├── types.ts
│ │ │ │ │ └── updateTxn.ts
│ │ │ │ ├── assetTransactions.ts
│ │ │ │ ├── generalTransaction.ts
│ │ │ │ └── index.ts
│ │ │ └── utilityManager.ts
│ │ ├── types.ts
│ │ └── utils
│ │ └── responseProcessor.ts
│ ├── tests
│ │ ├── resources
│ │ │ ├── algod
│ │ │ │ ├── account.test.ts
│ │ │ │ ├── application.test.ts
│ │ │ │ ├── asset.test.ts
│ │ │ │ └── transaction.test.ts
│ │ │ └── indexer
│ │ │ ├── account.test.ts
│ │ │ ├── application.test.ts
│ │ │ ├── asset.test.ts
│ │ │ └── transaction.test.ts
│ │ └── tools
│ │ ├── accountManager.test.ts
│ │ ├── algodManager.test.ts
│ │ ├── apiManager
│ │ │ └── example
│ │ │ └── get-balance.test.ts
│ │ ├── transactionManager
│ │ │ ├── accountTransactionManager.test.ts
│ │ │ ├── appTransactionManager.test.ts
│ │ │ ├── assetTransactionManager.test.ts
│ │ │ ├── generalTransactionManager.test.ts
│ │ │ └── transactionManager.test.ts
│ │ └── utilityManager.test.ts
│ └── tsconfig.json
├── README.md
├── rename_files.sh
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/liquid-auth:docs:architecture.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | title: Architecture
3 | sidebar:
4 | order: 6
5 | prev: false
6 | next: false
7 | ---
8 |
9 | This is a high level overview of the sequence of events that happens while using Liquid Auth.
10 | See the [Getting Started](./guides/getting-started) section for more detailed information on each step.
11 | Diagrams are generated using [Mermaid](https://mermaid-js.github.io/mermaid/#/).
12 |
13 | ## Authentication
14 |
15 | A user can link their device to a website by scanning a QR code.
16 | The website will subscribe to a WebSocket channel to receive the link status.
17 | The wallet will scan the QR code and send a [FIDO2 PublicKeyCredential]() to the server.
18 | The server will validate the FIDO2 credential and send a response to the wallet and website.
19 |
20 | ```mermaid
21 | sequenceDiagram
22 | participant Website as Answer Client
23 | participant Server
24 | participant Wallet as Offer Client
25 | Website->>Server: Subscribe to 'wss:link'
26 | Website-->>Website: Display QR Connect Request ID
27 | Wallet->>Website: Scan QR Code
28 | Server-->>Wallet: Get Challenge/Options
29 | Wallet->>Server: POST FIDO2 Credential + Liquid Auth Extension
30 | Server-->>Server: Validate Signatures
31 | Server-->>Website: HTTPOnly Session
32 | Server->>Wallet: Ok Response + HTTPOnly Session
33 | Server->>Website: Emit to `wss:link` client
34 | ```
35 |
36 | ## Signaling
37 |
38 | The website and wallet can subscribe to an isolated WebSocket channel to broker [Session Description]() answers and offers.
39 | [ICE Candidates]() are discovered when any peer has both an offer and answer.
40 |
41 | ```mermaid
42 | sequenceDiagram
43 | participant Website as Answer Client
44 | participant Server
45 | participant Wallet as Offer Client
46 | Website-->>Server: Subscribe to 'wss:offer-description'
47 | Website-->>Server: Subscribe to 'wss:offer-candidate'
48 | Wallet-->>Server: Subscribe to 'wss:answer-description'
49 | Wallet-->>Server: Subscribe to 'wss:answer-candidate'
50 | ```
51 |
52 | ### Offer
53 |
54 | [Offers]() are created by a peer and sent through the signaling service.
55 | A client with an offer will listen for an answer description.
56 | Answers are only emitted in response to an offer.
57 | Offer clients are responsible for creating the [Data Channel]().
58 |
59 | ```mermaid
60 | sequenceDiagram
61 | participant Website as Answer Client
62 | participant Server
63 | participant Wallet as Offer Client
64 | Wallet-->>Wallet: On answer-description, set Remote SDP
65 | Wallet-->>Wallet: On answer-candidate, add ICE Candidate
66 | Wallet-->>Wallet: Create Peer Offer & DataChannel
67 | Wallet-->>Server: Emit `wss:offer-description`
68 | Wallet-->>Server: Emit `wss:offer-candidate`
69 | ```
70 |
71 | ### Answer
72 |
73 | An [Answer]() is created by a peer in response to an offer.
74 | The answer description and candidates are emitted to the signaling service.
75 |
76 | ```mermaid
77 | sequenceDiagram
78 | participant Website as Answer Client
79 | participant Server
80 | participant Wallet as Offer Client
81 | Website-->>Website: On offer-description, set Remote SDP and create Answer
82 | Website-->>Website: On offer-candidate, add ICE Candidate
83 | Website-->>Server: Emit `wss:answer-description`
84 | Website-->>Server: Emit `wss:answer-candidate`
85 | ```
86 |
87 | ### Data Channel
88 |
89 | Once an Offer and Answer have been exchanged, a [Data Channel]() will be emitted to the peer who created the answer.
90 | This channel is used to send messages between the website and wallet in real-time over the established P2P connection.
91 | ```mermaid
92 | sequenceDiagram
93 | participant Website as Answer Client
94 | participant Server
95 | participant Wallet as Offer Client
96 | Wallet-->>Website: Emit DataChannel
97 | Wallet-->>Wallet: On Message, Handle Message
98 | Website-->>Website: On DataChannel, listen for Messages
99 | Website-->>Wallet: Emit Messages
100 | Wallet-->>Website: Emit Messages
101 | ```
102 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.TransactionProofResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / TransactionProofResponse
2 |
3 | # Class: TransactionProofResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).TransactionProofResponse
6 |
7 | Proof of transaction in a block.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`TransactionProofResponse`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.TransactionProofResponse.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.TransactionProofResponse.md#attribute_map)
24 | - [hashtype](modelsv2.TransactionProofResponse.md#hashtype)
25 | - [idx](modelsv2.TransactionProofResponse.md#idx)
26 | - [proof](modelsv2.TransactionProofResponse.md#proof)
27 | - [stibhash](modelsv2.TransactionProofResponse.md#stibhash)
28 | - [treedepth](modelsv2.TransactionProofResponse.md#treedepth)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](modelsv2.TransactionProofResponse.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](modelsv2.TransactionProofResponse.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new TransactionProofResponse**(`«destructured»`)
40 |
41 | Creates a new `TransactionProofResponse` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `hashtype?` | `string` |
49 | | › `idx` | `number` \| `bigint` |
50 | | › `proof` | `string` \| `Uint8Array` |
51 | | › `stibhash` | `string` \| `Uint8Array` |
52 | | › `treedepth` | `number` \| `bigint` |
53 |
54 | #### Overrides
55 |
56 | BaseModel.constructor
57 |
58 | #### Defined in
59 |
60 | client/v2/algod/models/types.ts:5932
61 |
62 | ## Properties
63 |
64 | ### attribute\_map
65 |
66 | • **attribute\_map**: `Record`\<`string`, `string`\>
67 |
68 | #### Inherited from
69 |
70 | BaseModel.attribute\_map
71 |
72 | #### Defined in
73 |
74 | client/v2/basemodel.ts:56
75 |
76 | ___
77 |
78 | ### hashtype
79 |
80 | • `Optional` **hashtype**: `string`
81 |
82 | The type of hash function used to create the proof, must be one of:
83 | * sha512_256
84 | * sha256
85 |
86 | #### Defined in
87 |
88 | client/v2/algod/models/types.ts:5919
89 |
90 | ___
91 |
92 | ### idx
93 |
94 | • **idx**: `number` \| `bigint`
95 |
96 | Index of the transaction in the block's payset.
97 |
98 | #### Defined in
99 |
100 | client/v2/algod/models/types.ts:5896
101 |
102 | ___
103 |
104 | ### proof
105 |
106 | • **proof**: `Uint8Array`
107 |
108 | Proof of transaction membership.
109 |
110 | #### Defined in
111 |
112 | client/v2/algod/models/types.ts:5901
113 |
114 | ___
115 |
116 | ### stibhash
117 |
118 | • **stibhash**: `Uint8Array`
119 |
120 | Hash of SignedTxnInBlock for verifying proof.
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:5906
125 |
126 | ___
127 |
128 | ### treedepth
129 |
130 | • **treedepth**: `number` \| `bigint`
131 |
132 | Represents the depth of the tree that is being proven, i.e. the number of edges
133 | from a leaf to the root.
134 |
135 | #### Defined in
136 |
137 | client/v2/algod/models/types.ts:5912
138 |
139 | ## Methods
140 |
141 | ### get\_obj\_for\_encoding
142 |
143 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
144 |
145 | Get an object ready for encoding to either JSON or msgpack.
146 |
147 | #### Parameters
148 |
149 | | Name | Type | Default value | Description |
150 | | :------ | :------ | :------ | :------ |
151 | | `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. |
152 |
153 | #### Returns
154 |
155 | `Record`\<`string`, `any`\>
156 |
157 | #### Inherited from
158 |
159 | BaseModel.get\_obj\_for\_encoding
160 |
161 | #### Defined in
162 |
163 | client/v2/basemodel.ts:65
164 |
165 | ___
166 |
167 | ### from\_obj\_for\_encoding
168 |
169 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionProofResponse`](modelsv2.TransactionProofResponse.md)
170 |
171 | #### Parameters
172 |
173 | | Name | Type |
174 | | :------ | :------ |
175 | | `data` | `Record`\<`string`, `any`\> |
176 |
177 | #### Returns
178 |
179 | [`TransactionProofResponse`](modelsv2.TransactionProofResponse.md)
180 |
181 | #### Defined in
182 |
183 | client/v2/algod/models/types.ts:5968
184 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:cli:features:project:link.md:
--------------------------------------------------------------------------------
```markdown
1 | # AlgoKit Project Link Command
2 |
3 | The `algokit project link` command is a powerful feature designed to streamline the integration between `frontend` and `contract` typed projects within the AlgoKit ecosystem. This command facilitates the automatic path resolution and invocation of [`algokit generate client`](../generate.md#1-typed-clients) on `contract` projects available in the workspace, making it easier to integrate smart contracts with frontend applications.
4 |
5 | ## Usage
6 |
7 | To use the `link` command, navigate to the root directory of your standalone frontend project and execute:
8 |
9 | ```sh
10 | $ algokit project link [OPTIONS]
11 | ```
12 |
13 | This command must be invoked from the root of a standalone 'frontend' typed project.
14 |
15 | ## Options
16 |
17 | - `--project-name`, `-p`: Specify one or more contract projects for the command. If not provided, the command defaults to all contract projects in the current workspace. This option can be repeated to specify multiple projects.
18 |
19 | - `--language`, `-l`: Set the programming language of the generated client code. The default is `typescript`, but you can specify other supported languages as well.
20 |
21 | - `--all`, `-a`: Link all contract projects with the frontend project. This option is mutually exclusive with `--project-name`.
22 |
23 | - `--fail-fast`, `-f`: Exit immediately if at least one client generation process fails. This is useful for CI/CD pipelines where you want to ensure all clients are correctly generated before proceeding.
24 |
25 | - `--version`, `-v`: Allows specifying the version of the client generator to use when generating client code for contract projects. This can be particularly useful for ensuring consistency across different environments or when a specific version of the client generator includes features or fixes that are necessary for your project.
26 |
27 | ## How It Works
28 |
29 | Below is a visual representation of the `algokit project link` command in action:
30 |
31 | ```mermaid
32 | graph LR
33 | F[Frontend Project] -->|algokit generate client| C1[Contract Project 1]
34 | F -->|algokit generate client| C2[Contract Project 2]
35 | F -->|algokit generate client| CN[Contract Project N]
36 |
37 | C1 -->|algokit generate client| F
38 | C2 -->|algokit generate client| F
39 | CN -->|algokit generate client| F
40 |
41 | classDef frontend fill:#f9f,stroke:#333,stroke-width:4px;
42 | classDef contract fill:#bbf,stroke:#333,stroke-width:2px;
43 | class F frontend;
44 | class C1,C2,CN contract;
45 | ```
46 |
47 | 1. **Project Type Verification**: The command first verifies that it is being executed within a standalone frontend project by checking the project's type in the `.algokit.toml` configuration file.
48 |
49 | 2. **Contract Project Selection**: Based on the provided options, it selects the contract projects to link. This can be all contract projects within the workspace, a subset specified by name, or a single project selected interactively.
50 |
51 | 3. **Client Code Generation**: For each selected contract project, it generates typed client code using the specified language. The generated code is placed in the frontend project's directory specified for contract clients.
52 |
53 | 4. **Feedback**: The command provides feedback for each contract project it processes, indicating success or failure in generating the client code.
54 |
55 | ## Example
56 |
57 | Linking all contract projects with a frontend project and generating TypeScript clients:
58 |
59 | ```sh
60 | $ algokit project link --all -l typescript
61 | ```
62 |
63 | This command will generate TypeScript clients for all contract projects and place them in the specified directory within the frontend project.
64 |
65 | ## Further Reading
66 |
67 | To learn more about the `algokit project link` command, please refer to [link](../../cli/index.md#link) in the AlgoKit CLI reference documentation.
68 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.AccountApplicationResponse.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / AccountApplicationResponse
2 |
3 | # Class: AccountApplicationResponse
4 |
5 | [modelsv2](../modules/modelsv2.md).AccountApplicationResponse
6 |
7 | AccountApplicationResponse describes the account's application local state and
8 | global state (AppLocalState and AppParams, if either exists) for a specific
9 | application ID. Global state will only be returned if the provided address is
10 | the application's creator.
11 |
12 | ## Hierarchy
13 |
14 | - `default`
15 |
16 | ↳ **`AccountApplicationResponse`**
17 |
18 | ## Table of contents
19 |
20 | ### Constructors
21 |
22 | - [constructor](modelsv2.AccountApplicationResponse.md#constructor)
23 |
24 | ### Properties
25 |
26 | - [appLocalState](modelsv2.AccountApplicationResponse.md#applocalstate)
27 | - [attribute\_map](modelsv2.AccountApplicationResponse.md#attribute_map)
28 | - [createdApp](modelsv2.AccountApplicationResponse.md#createdapp)
29 | - [round](modelsv2.AccountApplicationResponse.md#round)
30 |
31 | ### Methods
32 |
33 | - [get\_obj\_for\_encoding](modelsv2.AccountApplicationResponse.md#get_obj_for_encoding)
34 | - [from\_obj\_for\_encoding](modelsv2.AccountApplicationResponse.md#from_obj_for_encoding)
35 |
36 | ## Constructors
37 |
38 | ### constructor
39 |
40 | • **new AccountApplicationResponse**(`«destructured»`)
41 |
42 | Creates a new `AccountApplicationResponse` object.
43 |
44 | #### Parameters
45 |
46 | | Name | Type |
47 | | :------ | :------ |
48 | | `«destructured»` | `Object` |
49 | | › `appLocalState?` | [`ApplicationLocalState`](modelsv2.ApplicationLocalState.md) |
50 | | › `createdApp?` | [`ApplicationParams`](modelsv2.ApplicationParams.md) |
51 | | › `round` | `number` \| `bigint` |
52 |
53 | #### Overrides
54 |
55 | BaseModel.constructor
56 |
57 | #### Defined in
58 |
59 | client/v2/algod/models/types.ts:481
60 |
61 | ## Properties
62 |
63 | ### appLocalState
64 |
65 | • `Optional` **appLocalState**: [`ApplicationLocalState`](modelsv2.ApplicationLocalState.md)
66 |
67 | (appl) the application local data stored in this account.
68 | The raw account uses `AppLocalState` for this type.
69 |
70 | #### Defined in
71 |
72 | client/v2/algod/models/types.ts:463
73 |
74 | ___
75 |
76 | ### attribute\_map
77 |
78 | • **attribute\_map**: `Record`\<`string`, `string`\>
79 |
80 | #### Inherited from
81 |
82 | BaseModel.attribute\_map
83 |
84 | #### Defined in
85 |
86 | client/v2/basemodel.ts:56
87 |
88 | ___
89 |
90 | ### createdApp
91 |
92 | • `Optional` **createdApp**: [`ApplicationParams`](modelsv2.ApplicationParams.md)
93 |
94 | (appp) parameters of the application created by this account including app
95 | global data.
96 | The raw account uses `AppParams` for this type.
97 |
98 | #### Defined in
99 |
100 | client/v2/algod/models/types.ts:470
101 |
102 | ___
103 |
104 | ### round
105 |
106 | • **round**: `number` \| `bigint`
107 |
108 | The round for which this information is relevant.
109 |
110 | #### Defined in
111 |
112 | client/v2/algod/models/types.ts:457
113 |
114 | ## Methods
115 |
116 | ### get\_obj\_for\_encoding
117 |
118 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
119 |
120 | Get an object ready for encoding to either JSON or msgpack.
121 |
122 | #### Parameters
123 |
124 | | Name | Type | Default value | Description |
125 | | :------ | :------ | :------ | :------ |
126 | | `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. |
127 |
128 | #### Returns
129 |
130 | `Record`\<`string`, `any`\>
131 |
132 | #### Inherited from
133 |
134 | BaseModel.get\_obj\_for\_encoding
135 |
136 | #### Defined in
137 |
138 | client/v2/basemodel.ts:65
139 |
140 | ___
141 |
142 | ### from\_obj\_for\_encoding
143 |
144 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AccountApplicationResponse`](modelsv2.AccountApplicationResponse.md)
145 |
146 | #### Parameters
147 |
148 | | Name | Type |
149 | | :------ | :------ |
150 | | `data` | `Record`\<`string`, `any`\> |
151 |
152 | #### Returns
153 |
154 | [`AccountApplicationResponse`](modelsv2.AccountApplicationResponse.md)
155 |
156 | #### Defined in
157 |
158 | client/v2/algod/models/types.ts:503
159 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:dispenser-client.md:
--------------------------------------------------------------------------------
```markdown
1 | # TestNet Dispenser Client
2 |
3 | The TestNet Dispenser Client is a utility for interacting with the AlgoKit TestNet Dispenser API. It provides methods to fund an account, register a refund for a transaction, and get the current limit for an account.
4 |
5 | ## Creating a Dispenser Client
6 |
7 | To create a Dispenser Client, you need to provide an authorization token. This can be done in two ways:
8 |
9 | 1. Pass the token directly to the client constructor as `authToken`.
10 | 2. Set the token as an environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN` (see [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md#error-handling) on how to obtain the token).
11 |
12 | If both methods are used, the constructor argument takes precedence.
13 |
14 | The recommended way to get a TestNet dispenser API client is [via `ClientManager`](./client.md):
15 |
16 | ```typescript
17 | // With auth token
18 | const dispenserClient = algorand.client.getTestNetDispenser({
19 | authToken: 'your_auth_token',
20 | })
21 |
22 | // With auth token and timeout
23 | const dispenserClient = algorand.client.getTestNetDispenser({
24 | authToken: 'your_auth_token',
25 | requestTimeout: 2 /* seconds */,
26 | })
27 |
28 | // From environment variables
29 | // i.e. process.env['ALGOKIT_DISPENSER_ACCESS_TOKEN'] = 'your_auth_token'
30 | const dispenserClient = algorand.client.getTestNetDispenserFromEnvironment()
31 |
32 | // From environment variables with request timeout
33 | const dispenserClient = algorand.client.getTestNetDispenserFromEnvironment({
34 | requestTimeout: 2 /* seconds */,
35 | })
36 | ```
37 |
38 | Alternatively, you can construct it directly.
39 |
40 | ```ts
41 | import { TestNetDispenserApiClient } from '@algorandfoundation/algokit-utils/types/dispenser-client'
42 |
43 | // Using constructor argument
44 | const client = new TestNetDispenserApiClient({ authToken: 'your_auth_token' })
45 | const clientFromAlgorandClient = algorand.client.getTestNetDispenser({ authToken: 'your_auth_token' })
46 |
47 | // Using environment variable
48 | process.env['ALGOKIT_DISPENSER_ACCESS_TOKEN'] = 'your_auth_token'
49 | const client = new TestNetDispenserApiClient()
50 | const clientFromAlgorandClient = algorand.client.getTestNetDispenserFromEnvironment()
51 | ```
52 |
53 | ## Funding an Account
54 |
55 | To fund an account with Algo from the dispenser API, use the `fund` method. This method requires the receiver's address, the amount to be funded, and the asset ID.
56 |
57 | ```ts
58 | const response = await client.fund('receiver_address', 1000)
59 | ```
60 |
61 | The `fund` method returns a `DispenserFundResponse` object, which contains the transaction ID (`txId`) and the amount funded.
62 |
63 | ## Registering a Refund
64 |
65 | To register a refund for a transaction with the dispenser API, use the `refund` method. This method requires the transaction ID of the refund transaction.
66 |
67 | ```ts
68 | await client.refund('transaction_id')
69 | ```
70 |
71 | > Keep in mind, to perform a refund you need to perform a payment transaction yourself first by sending funds back to TestNet Dispenser, then you can invoke this refund endpoint and pass the txn_id of your refund txn. You can obtain dispenser address by inspecting the sender field of any issued fund transaction initiated via [fund](#funding-an-account).
72 |
73 | ## Getting Current Limit
74 |
75 | To get the current limit for an account with Algo from the dispenser API, use the `getLimit` method. This method requires the account address.
76 |
77 | ```ts
78 | const response = await client.getLimit()
79 | ```
80 |
81 | The `limit` method returns a `DispenserLimitResponse` object, which contains the current limit amount.
82 |
83 | ## Error Handling
84 |
85 | If an error occurs while making a request to the dispenser API, an exception will be raised with a message indicating the type of error. Refer to [Error Handling docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md#error-handling) for details on how you can handle each individual error `code`.
86 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:modes.md:
--------------------------------------------------------------------------------
```markdown
1 | title: Modes of use
2 |
3 | Smart signatures have two basic usage scenarios; as a [**contract account**](#contract-account) or as a [**delegated signature**](#delegated-approval). These modes are used to approve transactions in different ways which are described below. Both modes make use of Logic Signatures. While using smart signatures for contract accounts is possible, it is now possible to create a contract account using a [smart contract](../apps/index.md).
4 |
5 | # Logic signatures
6 | Logic Signatures, referenced as LogicSig, are structures that contain the following four parts.
7 |
8 |
9 | <center></center>
10 | <center>*Logic Signature Structure*</center>
11 |
12 | Before a LogicSig can be used with a transaction, it first must be a valid Logic Signature. The LogicSig is considered valid if one of the following scenarios is true.
13 |
14 | > * Sig contains a valid Signature of the program from the account that is sending the Transaction
15 | > * Msig contains a valid Multi-Signature of the program from the Multi-Signature account sending the Transaction
16 | > * The hash of the program is equal to the Sender's Address
17 |
18 |
19 | The first two cases are examples of delegation. An account owner can declare that on their behalf the signed logic can authorize transactions. These accounts can be either single or multi-signature accounts. Account delegation is described in further detail below.
20 |
21 | The third case is an account wholly governed by the program. The program cannot be changed. Once Algos or assets have been sent to that account, Algos or assets only leave when there is a transaction that approves it. This usage case is considered a contract account which is described below.
22 | # Contract account
23 | For each unique compiled smart signature program there exists a single corresponding Algorand address, output by `goal clerk compile`. To use a TEAL program as a contract account, send Algos to its address to turn it into an account on Algorand with a balance. Outwardly, this account looks no different from any other Algorand account and anyone can send it Algos or Algorand Standard Assets to increase its balance. The account differs in how it authenticates spends _from_ it, in that the logic determines if the transaction is approved. To spend from a contract account, create a transaction that will evaluate to True against the TEAL logic, then add the compiled TEAL code as its logic signature. It is worth noting that anyone can create and submit the transaction that spends from a contract account as long as they have the compiled TEAL contract to add as a logic signature.
24 |
25 | <center></center>
26 | <center>*TEAL Contract Account*</center>
27 |
28 | # Delegated approval
29 | Smart signatures can also be used to delegate signature authority, which means that a private key can sign a TEAL program and the resulting output can be used as a signature in transactions on behalf of the account associated with the private key. The owner of the delegated account can share this logic signature, allowing anyone to spend funds from his or her account according to the logic within the TEAL program.
30 | For example, if Alice wants to set up a recurring payment with her utility company for up to 200 Algos every 50000 rounds, she creates a TEAL contract that encodes this logic, signs it with her private key, and gives it to the utility company. The utility company uses that logic signature in the transaction they submit every 50000 rounds to collect payment from Alice.
31 | The logic signature can be produced from either a single or multi-signature account.
32 |
33 | <center></center>
34 | <center>*TEAL Delegated Signature*</center>
35 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:get-started:basics:whats_a_dapp.md:
--------------------------------------------------------------------------------
```markdown
1 | title: What is a dApp?
2 |
3 | Decentralized Applications, or dApps, are applications that are run in a decentralized computing system, like a blockchain. This guide will introduce what dApps are and how dApps are architected and implemented on the Algorand blockchain.
4 |
5 | <center>
6 | {: style="width:500px" align=center }
7 | <figcaption style="font-size:12px">A segment of the dApp ecosystem.</figcaption>
8 | </center>
9 |
10 | In the previous section, we discovered some of the properties of blockchain and how they offer paths to innovate on use cases that exchange items of value. A payment application, where users can exchange assets with each other, is a very simple dApp. In this use case, the payment transaction primitive is the only on-chain logic required to transfer those assets.
11 |
12 | But how do we implement a more complex scenario, like bidding in an auction? We could build a website, have users log in, send us their bids, then issue the on-chain transfer of the item to the highest bidder. We’d then have to send the highest bid amount to the seller and return the rest of the funds to all the losing bidders. The problem with this is that your users will have to trust that you won’t run off with their bids, that the code you wrote to hold funds is sound (probably without getting to see it), that you implement world-class security practices so that you won’t get hacked, etc.
13 |
14 | This implementation completely misses the mark on what blockchain promises and we are no better off using the blockchain than just using some of the centralized auction sites that exist already. If you’re a reputable company, then people probably trust you, but if you’re an independent developer, who is trying to build their reputation from scratch, then you’ll have a hard time getting users. And in the former scenario, you are still very much at-risk to attackers who may know that you have a large concentration of funds. The moral of this story is that we need a way to implement this bidding logic, securely, on-chain.
15 |
16 | This is where smart contracts come into play.
17 |
18 | # Smart contracts
19 |
20 | Smart contracts are on-chain logic programs that can implement highly customized transfer conditions. They can be composed with all other layer-1 features, (including Algos, NFTs, fungible tokens) to produce powerful and sophisticated decentralized applications.
21 |
22 | Let’s return to the auction bidding scenario and use smart contracts to implement on-chain bidding. What this means is that instead of sending bids to an account controlled by a centralized entity, subject to attacks and single points of failure, we can send those bids to a smart contract, governed by code, that is open and publicly verifiable by anyone. And that code won’t unexpectedly change. That doesn’t mean it can’t change, but if it does, it will be public and evident to users. And if you don’t like the idea that it can change, you can even program it from the start to restrict certain changes or disallow all changes to the contract.
23 |
24 | In summary, you go from trusting an entity and _hoping_ that they will do what they promised, to trusting the code and _knowing_ it will do what it promised, regardless of the different actors involved and the different motivations they might have.
25 |
26 | An important sidebar here is that it is critical for smart contract code to be reviewed and audited for security flaws. Badly written code that does not account for all potential attack vectors of course will not secure anything.
27 |
28 | # What language can I use to write smart contracts?
29 | On Algorand, you can write smart contracts in Python with the PyTeal library. To get started building a dApp, checkout the [Algokit getting started](/docs/get-started/algokit) guide.
30 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.ApplicationStateOperation.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / ApplicationStateOperation
2 |
3 | # Class: ApplicationStateOperation
4 |
5 | [modelsv2](../modules/modelsv2.md).ApplicationStateOperation
6 |
7 | An operation against an application's global/local/box state.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`ApplicationStateOperation`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.ApplicationStateOperation.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [account](modelsv2.ApplicationStateOperation.md#account)
24 | - [appStateType](modelsv2.ApplicationStateOperation.md#appstatetype)
25 | - [attribute\_map](modelsv2.ApplicationStateOperation.md#attribute_map)
26 | - [key](modelsv2.ApplicationStateOperation.md#key)
27 | - [newValue](modelsv2.ApplicationStateOperation.md#newvalue)
28 | - [operation](modelsv2.ApplicationStateOperation.md#operation)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](modelsv2.ApplicationStateOperation.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](modelsv2.ApplicationStateOperation.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new ApplicationStateOperation**(`«destructured»`)
40 |
41 | Creates a new `ApplicationStateOperation` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `account?` | `string` |
49 | | › `appStateType` | `string` |
50 | | › `key` | `string` \| `Uint8Array` |
51 | | › `newValue?` | [`AvmValue`](modelsv2.AvmValue.md) |
52 | | › `operation` | `string` |
53 |
54 | #### Overrides
55 |
56 | BaseModel.constructor
57 |
58 | #### Defined in
59 |
60 | client/v2/algod/models/types.ts:1436
61 |
62 | ## Properties
63 |
64 | ### account
65 |
66 | • `Optional` **account**: `string`
67 |
68 | For local state changes, the address of the account associated with the local
69 | state.
70 |
71 | #### Defined in
72 |
73 | client/v2/algod/models/types.ts:1419
74 |
75 | ___
76 |
77 | ### appStateType
78 |
79 | • **appStateType**: `string`
80 |
81 | Type of application state. Value `g` is **global state**, `l` is **local
82 | state**, `b` is **boxes**.
83 |
84 | #### Defined in
85 |
86 | client/v2/algod/models/types.ts:1403
87 |
88 | ___
89 |
90 | ### attribute\_map
91 |
92 | • **attribute\_map**: `Record`\<`string`, `string`\>
93 |
94 | #### Inherited from
95 |
96 | BaseModel.attribute\_map
97 |
98 | #### Defined in
99 |
100 | client/v2/basemodel.ts:56
101 |
102 | ___
103 |
104 | ### key
105 |
106 | • **key**: `Uint8Array`
107 |
108 | The key (name) of the global/local/box state.
109 |
110 | #### Defined in
111 |
112 | client/v2/algod/models/types.ts:1408
113 |
114 | ___
115 |
116 | ### newValue
117 |
118 | • `Optional` **newValue**: [`AvmValue`](modelsv2.AvmValue.md)
119 |
120 | Represents an AVM value.
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:1424
125 |
126 | ___
127 |
128 | ### operation
129 |
130 | • **operation**: `string`
131 |
132 | Operation type. Value `w` is **write**, `d` is **delete**.
133 |
134 | #### Defined in
135 |
136 | client/v2/algod/models/types.ts:1413
137 |
138 | ## Methods
139 |
140 | ### get\_obj\_for\_encoding
141 |
142 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
143 |
144 | Get an object ready for encoding to either JSON or msgpack.
145 |
146 | #### Parameters
147 |
148 | | Name | Type | Default value | Description |
149 | | :------ | :------ | :------ | :------ |
150 | | `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. |
151 |
152 | #### Returns
153 |
154 | `Record`\<`string`, `any`\>
155 |
156 | #### Inherited from
157 |
158 | BaseModel.get\_obj\_for\_encoding
159 |
160 | #### Defined in
161 |
162 | client/v2/basemodel.ts:65
163 |
164 | ___
165 |
166 | ### from\_obj\_for\_encoding
167 |
168 | ▸ `Static` **from_obj_for_encoding**(`data`): [`ApplicationStateOperation`](modelsv2.ApplicationStateOperation.md)
169 |
170 | #### Parameters
171 |
172 | | Name | Type |
173 | | :------ | :------ |
174 | | `data` | `Record`\<`string`, `any`\> |
175 |
176 | #### Returns
177 |
178 | [`ApplicationStateOperation`](modelsv2.ApplicationStateOperation.md)
179 |
180 | #### Defined in
181 |
182 | client/v2/algod/models/types.ts:1469
183 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/puya:docs:language-guide.md:
--------------------------------------------------------------------------------
```markdown
1 | # Language Guide
2 |
3 | Algorand Python is conceptually two things:
4 |
5 | 1. A partial implementation of the Python programming language that runs on the AVM.
6 | 2. A framework for development of Algorand smart contracts and logic signatures, with Pythonic
7 | interfaces to underlying AVM functionality.
8 |
9 | You can install the Algorand Python types from PyPi:
10 |
11 | > `pip install algorand-python`
12 |
13 | or
14 |
15 | > `poetry add algorand-python`
16 |
17 | ---
18 |
19 | As a partial implementation of the Python programming language, it maintains the syntax and
20 | semantics of Python. The subset of the language that is supported will grow over time, but it will
21 | never be a complete implementation due to the restricted nature of the AVM as an execution
22 | environment. As a trivial example, the `async` and `await` keywords, and all associated features,
23 | do not make sense to implement.
24 |
25 | Being a partial implementation of Python means that existing developer tooling like IDE syntax
26 | highlighting, static type checkers, linters, and auto-formatters, will work out-of-the-box. This is
27 | as opposed to an approach to smart contract development that adds or alters language elements or
28 | semantics, which then requires custom developer tooling support, and more importantly, requires the
29 | developer to learn and understand the potentially non-obvious differences from regular Python.
30 |
31 | The greatest advantage to maintaining semantic and syntactic compatibility, however, is only
32 | realised in combination with the framework approach. Supplying a set of interfaces representing
33 | smart contract development and AVM functionality required allows for the possibility of
34 | implementing those interfaces in pure Python! This will make it possible in the near future for you
35 | to execute tests against your smart contracts without deploying them to Algorand, and even step
36 | into and break-point debug your code from those tests.
37 |
38 | The framework provides interfaces to the underlying AVM types and operations. By virtue of the AVM
39 | being statically typed, these interfaces are also statically typed, and require your code to be as
40 | well.
41 |
42 | The most basic types on the AVM are `uint64` and `bytes[]`, representing unsigned 64-bit integers
43 | and byte arrays respectively. These are represented by [`UInt64`](#algopy.UInt64) and
44 | [`Bytes`](#algopy.Bytes) in Algorand Python. There are further "bounded" types supported by the AVM
45 | which are backed by these two simple primitives. For example, `bigint` represents a variably sized
46 | (up to 512-bits), unsigned integer, but is actually backed by a `bytes[]`. This is represented by
47 | [`BigUInt`](#algopy.BigUInt) in Algorand Python.
48 |
49 | Unfortunately, none of these types map to standard Python primitives. In Python, an `int` is
50 | unsigned, and effectively unbounded. A `bytes` similarly is limited only by the memory available,
51 | whereas an AVM `bytes[]` has a maximum length of 4096. In order to both maintain semantic
52 | compatibility and allow for a framework implementation in plain Python that will fail under the
53 | same conditions as when deployed to the AVM, support for Python primitives is
54 | [limited](lg-types.md#python-built-in-types).
55 |
56 | For more information on the philosophy and design of Algorand Python, please see
57 | ["Principles"](principles.md#principles).
58 |
59 | If you aren't familiar with Python, a good place to start before continuing below is with the
60 | [official tutorial](https://docs.python.org/3/tutorial/index.html). Just beware that as mentioned
61 | above, [not all features are supported](./lg-unsupported-python-features.md).
62 |
63 | ## Table of Contents
64 |
65 | ```{toctree}
66 | ---
67 | maxdepth: 3
68 | ---
69 |
70 | lg-structure
71 | lg-types
72 | lg-control
73 | lg-modules
74 | lg-builtins
75 | lg-errors
76 | lg-storage
77 | lg-logs
78 | lg-transactions
79 | lg-ops
80 | lg-opcode-budget
81 | lg-arc4
82 | lg-arc28
83 | lg-calling-apps
84 | lg-compile
85 | lg-unsupported-python-features
86 | ```
87 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.MiniAssetHolding.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / MiniAssetHolding
2 |
3 | # Class: MiniAssetHolding
4 |
5 | [indexerModels](../modules/indexerModels.md).MiniAssetHolding
6 |
7 | A simplified version of AssetHolding
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`MiniAssetHolding`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](indexerModels.MiniAssetHolding.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [address](indexerModels.MiniAssetHolding.md#address)
24 | - [amount](indexerModels.MiniAssetHolding.md#amount)
25 | - [attribute\_map](indexerModels.MiniAssetHolding.md#attribute_map)
26 | - [deleted](indexerModels.MiniAssetHolding.md#deleted)
27 | - [isFrozen](indexerModels.MiniAssetHolding.md#isfrozen)
28 | - [optedInAtRound](indexerModels.MiniAssetHolding.md#optedinatround)
29 | - [optedOutAtRound](indexerModels.MiniAssetHolding.md#optedoutatround)
30 |
31 | ### Methods
32 |
33 | - [get\_obj\_for\_encoding](indexerModels.MiniAssetHolding.md#get_obj_for_encoding)
34 | - [from\_obj\_for\_encoding](indexerModels.MiniAssetHolding.md#from_obj_for_encoding)
35 |
36 | ## Constructors
37 |
38 | ### constructor
39 |
40 | • **new MiniAssetHolding**(`«destructured»`)
41 |
42 | Creates a new `MiniAssetHolding` object.
43 |
44 | #### Parameters
45 |
46 | | Name | Type |
47 | | :------ | :------ |
48 | | `«destructured»` | `Object` |
49 | | › `address` | `string` |
50 | | › `amount` | `number` \| `bigint` |
51 | | › `deleted?` | `boolean` |
52 | | › `isFrozen` | `boolean` |
53 | | › `optedInAtRound?` | `number` \| `bigint` |
54 | | › `optedOutAtRound?` | `number` \| `bigint` |
55 |
56 | #### Overrides
57 |
58 | BaseModel.constructor
59 |
60 | #### Defined in
61 |
62 | client/v2/indexer/models/types.ts:3355
63 |
64 | ## Properties
65 |
66 | ### address
67 |
68 | • **address**: `string`
69 |
70 | #### Defined in
71 |
72 | client/v2/indexer/models/types.ts:3325
73 |
74 | ___
75 |
76 | ### amount
77 |
78 | • **amount**: `number` \| `bigint`
79 |
80 | #### Defined in
81 |
82 | client/v2/indexer/models/types.ts:3327
83 |
84 | ___
85 |
86 | ### attribute\_map
87 |
88 | • **attribute\_map**: `Record`\<`string`, `string`\>
89 |
90 | #### Inherited from
91 |
92 | BaseModel.attribute\_map
93 |
94 | #### Defined in
95 |
96 | client/v2/basemodel.ts:56
97 |
98 | ___
99 |
100 | ### deleted
101 |
102 | • `Optional` **deleted**: `boolean`
103 |
104 | Whether or not this asset holding is currently deleted from its account.
105 |
106 | #### Defined in
107 |
108 | client/v2/indexer/models/types.ts:3334
109 |
110 | ___
111 |
112 | ### isFrozen
113 |
114 | • **isFrozen**: `boolean`
115 |
116 | #### Defined in
117 |
118 | client/v2/indexer/models/types.ts:3329
119 |
120 | ___
121 |
122 | ### optedInAtRound
123 |
124 | • `Optional` **optedInAtRound**: `number` \| `bigint`
125 |
126 | Round during which the account opted into the asset.
127 |
128 | #### Defined in
129 |
130 | client/v2/indexer/models/types.ts:3339
131 |
132 | ___
133 |
134 | ### optedOutAtRound
135 |
136 | • `Optional` **optedOutAtRound**: `number` \| `bigint`
137 |
138 | Round during which the account opted out of the asset.
139 |
140 | #### Defined in
141 |
142 | client/v2/indexer/models/types.ts:3344
143 |
144 | ## Methods
145 |
146 | ### get\_obj\_for\_encoding
147 |
148 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
149 |
150 | Get an object ready for encoding to either JSON or msgpack.
151 |
152 | #### Parameters
153 |
154 | | Name | Type | Default value | Description |
155 | | :------ | :------ | :------ | :------ |
156 | | `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. |
157 |
158 | #### Returns
159 |
160 | `Record`\<`string`, `any`\>
161 |
162 | #### Inherited from
163 |
164 | BaseModel.get\_obj\_for\_encoding
165 |
166 | #### Defined in
167 |
168 | client/v2/basemodel.ts:65
169 |
170 | ___
171 |
172 | ### from\_obj\_for\_encoding
173 |
174 | ▸ `Static` **from_obj_for_encoding**(`data`): [`MiniAssetHolding`](indexerModels.MiniAssetHolding.md)
175 |
176 | #### Parameters
177 |
178 | | Name | Type |
179 | | :------ | :------ |
180 | | `data` | `Record`\<`string`, `any`\> |
181 |
182 | #### Returns
183 |
184 | [`MiniAssetHolding`](indexerModels.MiniAssetHolding.md)
185 |
186 | #### Defined in
187 |
188 | client/v2/indexer/models/types.ts:3389
189 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/developer:docs:details:transactions:payment_prompts.md:
--------------------------------------------------------------------------------
```markdown
1 | title: URI scheme
2 |
3 | This URI specification represents a standardized way for applications and websites to send requests and information through deeplinks, QR codes, etc. It is heavily based on Bitcoin’s [BIP-0021](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) and should be seen as derivative of it. The decision to base it on BIP-0021 was made to make it easy and compatible as possible for any other applications.
4 |
5 | # Specifications
6 |
7 | ## General format
8 |
9 | Algorand URIs follow the general format for URIs as set forth in RFC 3986. The path component consists of an Algorand address, and the query component provides additional payment options.
10 |
11 | Elements of the query component may contain characters outside the valid range. These must first be encoded according to UTF-8, and then each octet of the corresponding UTF-8 sequence must be percent-encoded as described in RFC 3986.
12 |
13 | ## ABNF Grammar
14 |
15 | ```
16 | algorandurn = "algorand://" algorandaddress [ "?" algorandparams ]
17 | algorandaddress = *base32
18 | algorandparams = algorandparam [ "&" algorandparams ]
19 | algorandparam = [ amountparam / labelparam / noteparam / assetparam / otherparam ]
20 | amountparam = "amount=" *digit
21 | labelparam = "label=" *qchar
22 | assetparam = "asset=" *digit
23 | noteparam = (xnote | note)
24 | xnote = "xnote=" *qchar
25 | note = "note=" *qchar
26 | otherparam = qchar *qchar [ "=" *qchar ]
27 | ```
28 |
29 | Here, "qchar" corresponds to valid characters of an RFC 3986 URI query component, excluding the "=" and "&" characters, which this specification takes as separators.
30 |
31 | The scheme component ("algorand:") is case-insensitive, and implementations must accept any combination of uppercase and lowercase letters. The rest of the URI is case-sensitive, including the query parameter keys.
32 |
33 | !!! Caveat
34 | When it comes to generation of an address' QR, many exchanges and wallets encodes the address w/o the scheme component (“algorand:”). This is not a URI so it is OK.
35 |
36 | ## Query Keys
37 |
38 | - label: Label for that address (e.g. name of receiver)
39 |
40 | - address: Algorand address (if missing, sender address will be used as receiver.)
41 |
42 | - xnote: A URL-encoded notes field value that must not be modifiable by the user when displayed to users.
43 |
44 | - note: A URL-encoded default notes field value that the the user interface may optionally make editable by the user.
45 |
46 | - amount: microAlgos or smallest unit of asset
47 |
48 | - asset: The asset id this request refers to (if Algos, simply omit this parameter)
49 |
50 | - (others): optional, for future extensions
51 |
52 | ## Transfer amount/size
53 |
54 | !!! Note
55 | This is DIFFERENT than Bitcoin’s BIP-0021
56 |
57 | If an amount is provided, it MUST be specified in basic unit of the asset. For example, if it’s Algos (Algorand native unit), the amount should be specified in microAlgos. All amounts MUST NOT contain commas nor a period (.) Strictly non negative integers.
58 |
59 | e.g. for 100 Algos, the amount needs to be 100000000, for 54.1354 Algos the amount needs to be 54135400.
60 |
61 | Algorand Clients should display the amount in whole Algos. Where needed, microAlgos can be used as well. In any case, the units shall be clear for the user.
62 |
63 | # Appendix
64 |
65 | This section contains several examples
66 |
67 | address -
68 |
69 | ```
70 | algorand://TMTAD6N22HCS2LKH7677L2KFLT3PAQWY6M4JFQFXQS32ECBFC23F57RYX4
71 | ```
72 |
73 | address with label -
74 |
75 | ```
76 | algorand://TMTAD6N22HCS2LKH7677L2KFLT3PAQWY6M4JFQFXQS32ECBFC23F57RYX4?label=Silvio
77 | ```
78 |
79 | Request 150.5 Algos from an address
80 |
81 | ```
82 | algorand://TMTAD6N22HCS2LKH7677L2KFLT3PAQWY6M4JFQFXQS32ECBFC23F57RYX4?amount=150500000
83 | ```
84 |
85 | Request 150 units of Asset ID 45 from an address
86 |
87 | ```
88 | algorand://TMTAD6N22HCS2LKH7677L2KFLT3PAQWY6M4JFQFXQS32ECBFC23F57RYX4?amount=150&asset=45
89 | ```
90 |
91 |
92 | Opt-in request for Asset ID 37
93 |
94 | ```
95 | algorand://?amount=0&asset=37
96 | ```
97 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.IndexerStateProofMessage.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / IndexerStateProofMessage
2 |
3 | # Class: IndexerStateProofMessage
4 |
5 | [indexerModels](../modules/indexerModels.md).IndexerStateProofMessage
6 |
7 | ## Hierarchy
8 |
9 | - `default`
10 |
11 | ↳ **`IndexerStateProofMessage`**
12 |
13 | ## Table of contents
14 |
15 | ### Constructors
16 |
17 | - [constructor](indexerModels.IndexerStateProofMessage.md#constructor)
18 |
19 | ### Properties
20 |
21 | - [attribute\_map](indexerModels.IndexerStateProofMessage.md#attribute_map)
22 | - [blockHeadersCommitment](indexerModels.IndexerStateProofMessage.md#blockheaderscommitment)
23 | - [firstAttestedRound](indexerModels.IndexerStateProofMessage.md#firstattestedround)
24 | - [latestAttestedRound](indexerModels.IndexerStateProofMessage.md#latestattestedround)
25 | - [lnProvenWeight](indexerModels.IndexerStateProofMessage.md#lnprovenweight)
26 | - [votersCommitment](indexerModels.IndexerStateProofMessage.md#voterscommitment)
27 |
28 | ### Methods
29 |
30 | - [get\_obj\_for\_encoding](indexerModels.IndexerStateProofMessage.md#get_obj_for_encoding)
31 | - [from\_obj\_for\_encoding](indexerModels.IndexerStateProofMessage.md#from_obj_for_encoding)
32 |
33 | ## Constructors
34 |
35 | ### constructor
36 |
37 | • **new IndexerStateProofMessage**(`«destructured»`)
38 |
39 | Creates a new `IndexerStateProofMessage` object.
40 |
41 | #### Parameters
42 |
43 | | Name | Type |
44 | | :------ | :------ |
45 | | `«destructured»` | `Object` |
46 | | › `blockHeadersCommitment?` | `string` \| `Uint8Array` |
47 | | › `firstAttestedRound?` | `number` \| `bigint` |
48 | | › `latestAttestedRound?` | `number` \| `bigint` |
49 | | › `lnProvenWeight?` | `number` \| `bigint` |
50 | | › `votersCommitment?` | `string` \| `Uint8Array` |
51 |
52 | #### Overrides
53 |
54 | BaseModel.constructor
55 |
56 | #### Defined in
57 |
58 | client/v2/indexer/models/types.ts:3215
59 |
60 | ## Properties
61 |
62 | ### attribute\_map
63 |
64 | • **attribute\_map**: `Record`\<`string`, `string`\>
65 |
66 | #### Inherited from
67 |
68 | BaseModel.attribute\_map
69 |
70 | #### Defined in
71 |
72 | client/v2/basemodel.ts:56
73 |
74 | ___
75 |
76 | ### blockHeadersCommitment
77 |
78 | • `Optional` **blockHeadersCommitment**: `Uint8Array`
79 |
80 | (b)
81 |
82 | #### Defined in
83 |
84 | client/v2/indexer/models/types.ts:3185
85 |
86 | ___
87 |
88 | ### firstAttestedRound
89 |
90 | • `Optional` **firstAttestedRound**: `number` \| `bigint`
91 |
92 | (f)
93 |
94 | #### Defined in
95 |
96 | client/v2/indexer/models/types.ts:3190
97 |
98 | ___
99 |
100 | ### latestAttestedRound
101 |
102 | • `Optional` **latestAttestedRound**: `number` \| `bigint`
103 |
104 | (l)
105 |
106 | #### Defined in
107 |
108 | client/v2/indexer/models/types.ts:3195
109 |
110 | ___
111 |
112 | ### lnProvenWeight
113 |
114 | • `Optional` **lnProvenWeight**: `number` \| `bigint`
115 |
116 | (P)
117 |
118 | #### Defined in
119 |
120 | client/v2/indexer/models/types.ts:3200
121 |
122 | ___
123 |
124 | ### votersCommitment
125 |
126 | • `Optional` **votersCommitment**: `Uint8Array`
127 |
128 | (v)
129 |
130 | #### Defined in
131 |
132 | client/v2/indexer/models/types.ts:3205
133 |
134 | ## Methods
135 |
136 | ### get\_obj\_for\_encoding
137 |
138 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
139 |
140 | Get an object ready for encoding to either JSON or msgpack.
141 |
142 | #### Parameters
143 |
144 | | Name | Type | Default value | Description |
145 | | :------ | :------ | :------ | :------ |
146 | | `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. |
147 |
148 | #### Returns
149 |
150 | `Record`\<`string`, `any`\>
151 |
152 | #### Inherited from
153 |
154 | BaseModel.get\_obj\_for\_encoding
155 |
156 | #### Defined in
157 |
158 | client/v2/basemodel.ts:65
159 |
160 | ___
161 |
162 | ### from\_obj\_for\_encoding
163 |
164 | ▸ `Static` **from_obj_for_encoding**(`data`): [`IndexerStateProofMessage`](indexerModels.IndexerStateProofMessage.md)
165 |
166 | #### Parameters
167 |
168 | | Name | Type |
169 | | :------ | :------ |
170 | | `data` | `Record`\<`string`, `any`\> |
171 |
172 | #### Returns
173 |
174 | [`IndexerStateProofMessage`](indexerModels.IndexerStateProofMessage.md)
175 |
176 | #### Defined in
177 |
178 | client/v2/indexer/models/types.ts:3251
179 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / RawAppCallArgs
2 |
3 | # Interface: RawAppCallArgs
4 |
5 | [types/app](../modules/types_app.md).RawAppCallArgs
6 |
7 | App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)
8 |
9 | ## Hierarchy
10 |
11 | - [`CoreAppCallArgs`](types_app.CoreAppCallArgs.md)
12 |
13 | ↳ **`RawAppCallArgs`**
14 |
15 | ## Table of contents
16 |
17 | ### Properties
18 |
19 | - [accounts](types_app.RawAppCallArgs.md#accounts)
20 | - [appArgs](types_app.RawAppCallArgs.md#appargs)
21 | - [apps](types_app.RawAppCallArgs.md#apps)
22 | - [assets](types_app.RawAppCallArgs.md#assets)
23 | - [boxes](types_app.RawAppCallArgs.md#boxes)
24 | - [lease](types_app.RawAppCallArgs.md#lease)
25 | - [method](types_app.RawAppCallArgs.md#method)
26 | - [rekeyTo](types_app.RawAppCallArgs.md#rekeyto)
27 |
28 | ## Properties
29 |
30 | ### accounts
31 |
32 | • `Optional` **accounts**: (`string` \| `Address`)[]
33 |
34 | The address of any accounts to load in
35 |
36 | #### Inherited from
37 |
38 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[accounts](types_app.CoreAppCallArgs.md#accounts)
39 |
40 | #### Defined in
41 |
42 | [src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79)
43 |
44 | ___
45 |
46 | ### appArgs
47 |
48 | • `Optional` **appArgs**: (`string` \| `Uint8Array`)[]
49 |
50 | Any application arguments to pass through
51 |
52 | #### Defined in
53 |
54 | [src/types/app.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L96)
55 |
56 | ___
57 |
58 | ### apps
59 |
60 | • `Optional` **apps**: `number`[]
61 |
62 | IDs of any apps to load into the foreignApps array
63 |
64 | #### Inherited from
65 |
66 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[apps](types_app.CoreAppCallArgs.md#apps)
67 |
68 | #### Defined in
69 |
70 | [src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81)
71 |
72 | ___
73 |
74 | ### assets
75 |
76 | • `Optional` **assets**: `number`[]
77 |
78 | IDs of any assets to load into the foreignAssets array
79 |
80 | #### Inherited from
81 |
82 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[assets](types_app.CoreAppCallArgs.md#assets)
83 |
84 | #### Defined in
85 |
86 | [src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83)
87 |
88 | ___
89 |
90 | ### boxes
91 |
92 | • `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[]
93 |
94 | Any box references to load
95 |
96 | #### Inherited from
97 |
98 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[boxes](types_app.CoreAppCallArgs.md#boxes)
99 |
100 | #### Defined in
101 |
102 | [src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77)
103 |
104 | ___
105 |
106 | ### lease
107 |
108 | • `Optional` **lease**: `string` \| `Uint8Array`
109 |
110 | The optional lease for the transaction
111 |
112 | #### Inherited from
113 |
114 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[lease](types_app.CoreAppCallArgs.md#lease)
115 |
116 | #### Defined in
117 |
118 | [src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75)
119 |
120 | ___
121 |
122 | ### method
123 |
124 | • `Optional` **method**: `undefined`
125 |
126 | Property to aid intellisense
127 |
128 | #### Defined in
129 |
130 | [src/types/app.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L98)
131 |
132 | ___
133 |
134 | ### rekeyTo
135 |
136 | • `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
137 |
138 | Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.
139 |
140 | **Note:** Use with extreme caution and review the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/) first.
141 |
142 | #### Inherited from
143 |
144 | [CoreAppCallArgs](types_app.CoreAppCallArgs.md).[rekeyTo](types_app.CoreAppCallArgs.md#rekeyto)
145 |
146 | #### Defined in
147 |
148 | [src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88)
149 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / AppInformation
2 |
3 | # Interface: AppInformation
4 |
5 | [types/app-manager](../modules/types_app_manager.md).AppInformation
6 |
7 | Information about an app.
8 |
9 | ## Table of contents
10 |
11 | ### Properties
12 |
13 | - [appAddress](types_app_manager.AppInformation.md#appaddress)
14 | - [appId](types_app_manager.AppInformation.md#appid)
15 | - [approvalProgram](types_app_manager.AppInformation.md#approvalprogram)
16 | - [clearStateProgram](types_app_manager.AppInformation.md#clearstateprogram)
17 | - [creator](types_app_manager.AppInformation.md#creator)
18 | - [extraProgramPages](types_app_manager.AppInformation.md#extraprogrampages)
19 | - [globalByteSlices](types_app_manager.AppInformation.md#globalbyteslices)
20 | - [globalInts](types_app_manager.AppInformation.md#globalints)
21 | - [globalState](types_app_manager.AppInformation.md#globalstate)
22 | - [localByteSlices](types_app_manager.AppInformation.md#localbyteslices)
23 | - [localInts](types_app_manager.AppInformation.md#localints)
24 |
25 | ## Properties
26 |
27 | ### appAddress
28 |
29 | • **appAddress**: `Address`
30 |
31 | The escrow address that the app operates with.
32 |
33 | #### Defined in
34 |
35 | [src/types/app-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L20)
36 |
37 | ___
38 |
39 | ### appId
40 |
41 | • **appId**: `bigint`
42 |
43 | The ID of the app.
44 |
45 | #### Defined in
46 |
47 | [src/types/app-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L18)
48 |
49 | ___
50 |
51 | ### approvalProgram
52 |
53 | • **approvalProgram**: `Uint8Array`
54 |
55 | Approval program.
56 |
57 | #### Defined in
58 |
59 | [src/types/app-manager.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L24)
60 |
61 | ___
62 |
63 | ### clearStateProgram
64 |
65 | • **clearStateProgram**: `Uint8Array`
66 |
67 | Clear state program.
68 |
69 | #### Defined in
70 |
71 | [src/types/app-manager.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L28)
72 |
73 | ___
74 |
75 | ### creator
76 |
77 | • **creator**: `Address`
78 |
79 | The address that created this application. This is the address where the
80 | parameters and global state for this application can be found.
81 |
82 | #### Defined in
83 |
84 | [src/types/app-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L33)
85 |
86 | ___
87 |
88 | ### extraProgramPages
89 |
90 | • `Optional` **extraProgramPages**: `number`
91 |
92 | Any extra pages that are needed for the smart contract.
93 |
94 | #### Defined in
95 |
96 | [src/types/app-manager.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L47)
97 |
98 | ___
99 |
100 | ### globalByteSlices
101 |
102 | • **globalByteSlices**: `number`
103 |
104 | The number of allocated byte slices in global state.
105 |
106 | #### Defined in
107 |
108 | [src/types/app-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L45)
109 |
110 | ___
111 |
112 | ### globalInts
113 |
114 | • **globalInts**: `number`
115 |
116 | The number of allocated ints in global state.
117 |
118 | #### Defined in
119 |
120 | [src/types/app-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L43)
121 |
122 | ___
123 |
124 | ### globalState
125 |
126 | • **globalState**: [`AppState`](types_app.AppState.md)
127 |
128 | Current global state values.
129 |
130 | #### Defined in
131 |
132 | [src/types/app-manager.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L37)
133 |
134 | ___
135 |
136 | ### localByteSlices
137 |
138 | • **localByteSlices**: `number`
139 |
140 | The number of allocated byte slices in per-user local state.
141 |
142 | #### Defined in
143 |
144 | [src/types/app-manager.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L41)
145 |
146 | ___
147 |
148 | ### localInts
149 |
150 | • **localInts**: `number`
151 |
152 | The number of allocated ints in per-user local state.
153 |
154 | #### Defined in
155 |
156 | [src/types/app-manager.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L39)
157 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.TransactionSignatureLogicsig.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / TransactionSignatureLogicsig
2 |
3 | # Class: TransactionSignatureLogicsig
4 |
5 | [indexerModels](../modules/indexerModels.md).TransactionSignatureLogicsig
6 |
7 | (lsig) Programatic transaction signature.
8 | Definition:
9 | data/transactions/logicsig.go
10 |
11 | ## Hierarchy
12 |
13 | - `default`
14 |
15 | ↳ **`TransactionSignatureLogicsig`**
16 |
17 | ## Table of contents
18 |
19 | ### Constructors
20 |
21 | - [constructor](indexerModels.TransactionSignatureLogicsig.md#constructor)
22 |
23 | ### Properties
24 |
25 | - [args](indexerModels.TransactionSignatureLogicsig.md#args)
26 | - [attribute\_map](indexerModels.TransactionSignatureLogicsig.md#attribute_map)
27 | - [logic](indexerModels.TransactionSignatureLogicsig.md#logic)
28 | - [multisigSignature](indexerModels.TransactionSignatureLogicsig.md#multisigsignature)
29 | - [signature](indexerModels.TransactionSignatureLogicsig.md#signature)
30 |
31 | ### Methods
32 |
33 | - [get\_obj\_for\_encoding](indexerModels.TransactionSignatureLogicsig.md#get_obj_for_encoding)
34 | - [from\_obj\_for\_encoding](indexerModels.TransactionSignatureLogicsig.md#from_obj_for_encoding)
35 |
36 | ## Constructors
37 |
38 | ### constructor
39 |
40 | • **new TransactionSignatureLogicsig**(`«destructured»`)
41 |
42 | Creates a new `TransactionSignatureLogicsig` object.
43 |
44 | #### Parameters
45 |
46 | | Name | Type |
47 | | :------ | :------ |
48 | | `«destructured»` | `Object` |
49 | | › `args?` | `Uint8Array`[] |
50 | | › `logic` | `string` \| `Uint8Array` |
51 | | › `multisigSignature?` | [`TransactionSignatureMultisig`](indexerModels.TransactionSignatureMultisig.md) |
52 | | › `signature?` | `string` \| `Uint8Array` |
53 |
54 | #### Overrides
55 |
56 | BaseModel.constructor
57 |
58 | #### Defined in
59 |
60 | client/v2/indexer/models/types.ts:5471
61 |
62 | ## Properties
63 |
64 | ### args
65 |
66 | • `Optional` **args**: `Uint8Array`[]
67 |
68 | (arg) Logic arguments, base64 encoded.
69 |
70 | #### Defined in
71 |
72 | client/v2/indexer/models/types.ts:5447
73 |
74 | ___
75 |
76 | ### attribute\_map
77 |
78 | • **attribute\_map**: `Record`\<`string`, `string`\>
79 |
80 | #### Inherited from
81 |
82 | BaseModel.attribute\_map
83 |
84 | #### Defined in
85 |
86 | client/v2/basemodel.ts:56
87 |
88 | ___
89 |
90 | ### logic
91 |
92 | • **logic**: `Uint8Array`
93 |
94 | (l) Program signed by a signature or multi signature, or hashed to be the
95 | address of ana ccount. Base64 encoded TEAL program.
96 |
97 | #### Defined in
98 |
99 | client/v2/indexer/models/types.ts:5442
100 |
101 | ___
102 |
103 | ### multisigSignature
104 |
105 | • `Optional` **multisigSignature**: [`TransactionSignatureMultisig`](indexerModels.TransactionSignatureMultisig.md)
106 |
107 | (msig) structure holding multiple subsignatures.
108 | Definition:
109 | crypto/multisig.go : MultisigSig
110 |
111 | #### Defined in
112 |
113 | client/v2/indexer/models/types.ts:5454
114 |
115 | ___
116 |
117 | ### signature
118 |
119 | • `Optional` **signature**: `Uint8Array`
120 |
121 | (sig) ed25519 signature.
122 |
123 | #### Defined in
124 |
125 | client/v2/indexer/models/types.ts:5459
126 |
127 | ## Methods
128 |
129 | ### get\_obj\_for\_encoding
130 |
131 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
132 |
133 | Get an object ready for encoding to either JSON or msgpack.
134 |
135 | #### Parameters
136 |
137 | | Name | Type | Default value | Description |
138 | | :------ | :------ | :------ | :------ |
139 | | `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. |
140 |
141 | #### Returns
142 |
143 | `Record`\<`string`, `any`\>
144 |
145 | #### Inherited from
146 |
147 | BaseModel.get\_obj\_for\_encoding
148 |
149 | #### Defined in
150 |
151 | client/v2/basemodel.ts:65
152 |
153 | ___
154 |
155 | ### from\_obj\_for\_encoding
156 |
157 | ▸ `Static` **from_obj_for_encoding**(`data`): [`TransactionSignatureLogicsig`](indexerModels.TransactionSignatureLogicsig.md)
158 |
159 | #### Parameters
160 |
161 | | Name | Type |
162 | | :------ | :------ |
163 | | `data` | `Record`\<`string`, `any`\> |
164 |
165 | #### Returns
166 |
167 | [`TransactionSignatureLogicsig`](indexerModels.TransactionSignatureLogicsig.md)
168 |
169 | #### Defined in
170 |
171 | client/v2/indexer/models/types.ts:5503
172 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:indexerModels.AssetHolding.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [indexerModels](../modules/indexerModels.md) / AssetHolding
2 |
3 | # Class: AssetHolding
4 |
5 | [indexerModels](../modules/indexerModels.md).AssetHolding
6 |
7 | Describes an asset held by an account.
8 | Definition:
9 | data/basics/userBalance.go : AssetHolding
10 |
11 | ## Hierarchy
12 |
13 | - `default`
14 |
15 | ↳ **`AssetHolding`**
16 |
17 | ## Table of contents
18 |
19 | ### Constructors
20 |
21 | - [constructor](indexerModels.AssetHolding.md#constructor)
22 |
23 | ### Properties
24 |
25 | - [amount](indexerModels.AssetHolding.md#amount)
26 | - [assetId](indexerModels.AssetHolding.md#assetid)
27 | - [attribute\_map](indexerModels.AssetHolding.md#attribute_map)
28 | - [deleted](indexerModels.AssetHolding.md#deleted)
29 | - [isFrozen](indexerModels.AssetHolding.md#isfrozen)
30 | - [optedInAtRound](indexerModels.AssetHolding.md#optedinatround)
31 | - [optedOutAtRound](indexerModels.AssetHolding.md#optedoutatround)
32 |
33 | ### Methods
34 |
35 | - [get\_obj\_for\_encoding](indexerModels.AssetHolding.md#get_obj_for_encoding)
36 | - [from\_obj\_for\_encoding](indexerModels.AssetHolding.md#from_obj_for_encoding)
37 |
38 | ## Constructors
39 |
40 | ### constructor
41 |
42 | • **new AssetHolding**(`«destructured»`)
43 |
44 | Creates a new `AssetHolding` object.
45 |
46 | #### Parameters
47 |
48 | | Name | Type |
49 | | :------ | :------ |
50 | | `«destructured»` | `Object` |
51 | | › `amount` | `number` \| `bigint` |
52 | | › `assetId` | `number` \| `bigint` |
53 | | › `deleted?` | `boolean` |
54 | | › `isFrozen` | `boolean` |
55 | | › `optedInAtRound?` | `number` \| `bigint` |
56 | | › `optedOutAtRound?` | `number` \| `bigint` |
57 |
58 | #### Overrides
59 |
60 | BaseModel.constructor
61 |
62 | #### Defined in
63 |
64 | client/v2/indexer/models/types.ts:1671
65 |
66 | ## Properties
67 |
68 | ### amount
69 |
70 | • **amount**: `number` \| `bigint`
71 |
72 | number of units held.
73 |
74 | #### Defined in
75 |
76 | client/v2/indexer/models/types.ts:1635
77 |
78 | ___
79 |
80 | ### assetId
81 |
82 | • **assetId**: `number` \| `bigint`
83 |
84 | Asset ID of the holding.
85 |
86 | #### Defined in
87 |
88 | client/v2/indexer/models/types.ts:1640
89 |
90 | ___
91 |
92 | ### attribute\_map
93 |
94 | • **attribute\_map**: `Record`\<`string`, `string`\>
95 |
96 | #### Inherited from
97 |
98 | BaseModel.attribute\_map
99 |
100 | #### Defined in
101 |
102 | client/v2/basemodel.ts:56
103 |
104 | ___
105 |
106 | ### deleted
107 |
108 | • `Optional` **deleted**: `boolean`
109 |
110 | Whether or not the asset holding is currently deleted from its account.
111 |
112 | #### Defined in
113 |
114 | client/v2/indexer/models/types.ts:1650
115 |
116 | ___
117 |
118 | ### isFrozen
119 |
120 | • **isFrozen**: `boolean`
121 |
122 | whether or not the holding is frozen.
123 |
124 | #### Defined in
125 |
126 | client/v2/indexer/models/types.ts:1645
127 |
128 | ___
129 |
130 | ### optedInAtRound
131 |
132 | • `Optional` **optedInAtRound**: `number` \| `bigint`
133 |
134 | Round during which the account opted into this asset holding.
135 |
136 | #### Defined in
137 |
138 | client/v2/indexer/models/types.ts:1655
139 |
140 | ___
141 |
142 | ### optedOutAtRound
143 |
144 | • `Optional` **optedOutAtRound**: `number` \| `bigint`
145 |
146 | Round during which the account opted out of this asset holding.
147 |
148 | #### Defined in
149 |
150 | client/v2/indexer/models/types.ts:1660
151 |
152 | ## Methods
153 |
154 | ### get\_obj\_for\_encoding
155 |
156 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
157 |
158 | Get an object ready for encoding to either JSON or msgpack.
159 |
160 | #### Parameters
161 |
162 | | Name | Type | Default value | Description |
163 | | :------ | :------ | :------ | :------ |
164 | | `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. |
165 |
166 | #### Returns
167 |
168 | `Record`\<`string`, `any`\>
169 |
170 | #### Inherited from
171 |
172 | BaseModel.get\_obj\_for\_encoding
173 |
174 | #### Defined in
175 |
176 | client/v2/basemodel.ts:65
177 |
178 | ___
179 |
180 | ### from\_obj\_for\_encoding
181 |
182 | ▸ `Static` **from_obj_for_encoding**(`data`): [`AssetHolding`](indexerModels.AssetHolding.md)
183 |
184 | #### Parameters
185 |
186 | | Name | Type |
187 | | :------ | :------ |
188 | | `data` | `Record`\<`string`, `any`\> |
189 |
190 | #### Returns
191 |
192 | [`AssetHolding`](indexerModels.AssetHolding.md)
193 |
194 | #### Defined in
195 |
196 | client/v2/indexer/models/types.ts:1705
197 |
```
--------------------------------------------------------------------------------
/packages/server/smithery.yaml:
--------------------------------------------------------------------------------
```yaml
1 | # Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
2 |
3 | build:
4 | dockerBuildPath: ../..
5 | startCommand:
6 | type: stdio
7 | configSchema:
8 | # JSON Schema defining the configuration options for the MCP.
9 | type: object
10 | properties:
11 | ALGORAND_ALGOD_PORT:
12 | type: string
13 | default: ""
14 | description: Algod node port (optional)
15 | ALGORAND_INDEXER_PORT:
16 | type: string
17 | default: ""
18 | description: Indexer port (optional)
19 | ALGORAND_TOKEN:
20 | type: string
21 | default: ""
22 | description: Algorand API token (optional)
23 | ITEMS_PER_PAGE:
24 | type: string
25 | default: 10
26 | description: Number of items per page for paginated responses
27 | ALGORAND_ALGOD:
28 | type: string
29 | default: https://testnet-api.algonode.cloud
30 | description: Algod node base URL
31 | ALGORAND_INDEXER:
32 | type: string
33 | default: https://testnet-idx.algonode.cloud
34 | description: Indexer base URL
35 | ALGORAND_NETWORK:
36 | type: string
37 | default: testnet
38 | description: Algorand network to connect to, e.g., testnet or mainnet
39 | ALGORAND_ALGOD_API:
40 | type: string
41 | default: https://testnet-api.algonode.cloud/v2
42 | description: Algod API endpoint URL
43 | ALGORAND_INDEXER_API:
44 | type: string
45 | default: https://testnet-idx.algonode.cloud/v2
46 | description: Indexer API endpoint URL
47 | NFD_API_URL:
48 | type: string
49 | default: https://api.nf.domains
50 | description: NFDomains API URL
51 | VESTIGE_ACTIVE:
52 | type: boolean
53 | default: false
54 | description: Vestige is active
55 | ULTRADE_ACTIVE:
56 | type: boolean
57 | default: false
58 | description: UltraDe is active
59 | TINYMAN_ACTIVE:
60 | type: boolean
61 | default: false
62 | description: Tinyman is active
63 | VESTIGE_API_URL:
64 | type: string
65 | default: https://api.vestigelabs.org
66 | description: Vestige API URL
67 | ALGORAND_AGENT_WALLET:
68 | type: string
69 | default: ""
70 | description: Algorand agent active wallet
71 |
72 | exampleConfig:
73 | ALGORAND_ALGOD: https://testnet-api.algonode.cloud
74 | ALGORAND_INDEXER: https://testnet-idx.algonode.cloud
75 | ALGORAND_NETWORK: testnet
76 | ALGORAND_ALGOD_API: https://testnet-api.algonode.cloud/v2
77 | ALGORAND_INDEXER_API: https://testnet-idx.algonode.cloud/v2
78 | ALGORAND_ALGOD_PORT: ""
79 | ALGORAND_INDEXER_PORT: ""
80 | ALGORAND_TOKEN: ""
81 | VESTIGE_ACTIVE: false
82 | ULTRADE_ACTIVE: false
83 | TINYMAN_ACTIVE: false
84 | ITEMS_PER_PAGE: 10
85 | NFD_API_URL: https://api.nf.domains
86 | NFD_API_KEY: ""
87 | VESTIGE_API_URL: https://api.vestigelabs.org
88 | VESTIGE_API_KEY: ""
89 | ALGORAND_AGENT_WALLET: ""
90 | commandFunction:
91 | # A JS function that produces the CLI command based on the given config to start the MCP on stdio.
92 | |-
93 | (config) => ({
94 | command: 'node',
95 | args: ['packages/server/dist/index.js'],
96 | env: {
97 | ALGORAND_NETWORK: config.ALGORAND_NETWORK,
98 | ALGORAND_ALGOD_API: config.ALGORAND_ALGOD_API,
99 | ALGORAND_ALGOD: config.ALGORAND_ALGOD,
100 | ALGORAND_INDEXER_API: config.ALGORAND_INDEXER_API,
101 | ALGORAND_INDEXER: config.ALGORAND_INDEXER,
102 | ALGORAND_ALGOD_PORT: config.ALGORAND_ALGOD_PORT,
103 | ALGORAND_INDEXER_PORT: config.ALGORAND_INDEXER_PORT,
104 | ALGORAND_TOKEN: config.ALGORAND_TOKEN,
105 | ITEMS_PER_PAGE: config.ITEMS_PER_PAGE,
106 | NFD_API_URL: config.NFD_API_URL,
107 | NFD_API_KEY: config.NFD_API_KEY,
108 | VESTIGE_API_URL: config.VESTIGE_API_URL,
109 | VESTIGE_API_KEY: config.VESTIGE_API_KEY,
110 | VESTIGE_ACTIVE: config.VESTIGE_ACTIVE,
111 | ULTRADE_ACTIVE: config.ULTRADE_ACTIVE,
112 | TINYMAN_ACTIVE: config.TINYMAN_ACTIVE,
113 | ALGORAND_AGENT_WALLET: config.ALGORAND_AGENT_WALLET,
114 | }
115 | })
116 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md:
--------------------------------------------------------------------------------
```markdown
1 | [@algorandfoundation/algokit-utils](../README.md) / [types/app-deployer](../modules/types_app_deployer.md) / AppMetadata
2 |
3 | # Interface: AppMetadata
4 |
5 | [types/app-deployer](../modules/types_app_deployer.md).AppMetadata
6 |
7 | The metadata that can be collected about a deployed app
8 |
9 | ## Hierarchy
10 |
11 | - [`AppDeployMetadata`](types_app.AppDeployMetadata.md)
12 |
13 | ↳ **`AppMetadata`**
14 |
15 | ## Table of contents
16 |
17 | ### Properties
18 |
19 | - [appAddress](types_app_deployer.AppMetadata.md#appaddress)
20 | - [appId](types_app_deployer.AppMetadata.md#appid)
21 | - [createdMetadata](types_app_deployer.AppMetadata.md#createdmetadata)
22 | - [createdRound](types_app_deployer.AppMetadata.md#createdround)
23 | - [deletable](types_app_deployer.AppMetadata.md#deletable)
24 | - [deleted](types_app_deployer.AppMetadata.md#deleted)
25 | - [name](types_app_deployer.AppMetadata.md#name)
26 | - [updatable](types_app_deployer.AppMetadata.md#updatable)
27 | - [updatedRound](types_app_deployer.AppMetadata.md#updatedround)
28 | - [version](types_app_deployer.AppMetadata.md#version)
29 |
30 | ## Properties
31 |
32 | ### appAddress
33 |
34 | • **appAddress**: `Address`
35 |
36 | The Algorand address of the account associated with the app
37 |
38 | #### Defined in
39 |
40 | [src/types/app-deployer.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L77)
41 |
42 | ___
43 |
44 | ### appId
45 |
46 | • **appId**: `bigint`
47 |
48 | The id of the app
49 |
50 | #### Defined in
51 |
52 | [src/types/app-deployer.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L75)
53 |
54 | ___
55 |
56 | ### createdMetadata
57 |
58 | • **createdMetadata**: [`AppDeployMetadata`](types_app.AppDeployMetadata.md)
59 |
60 | The metadata when the app was created
61 |
62 | #### Defined in
63 |
64 | [src/types/app-deployer.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L83)
65 |
66 | ___
67 |
68 | ### createdRound
69 |
70 | • **createdRound**: `bigint`
71 |
72 | The round the app was created
73 |
74 | #### Defined in
75 |
76 | [src/types/app-deployer.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L79)
77 |
78 | ___
79 |
80 | ### deletable
81 |
82 | • `Optional` **deletable**: `boolean`
83 |
84 | Whether or not the app is deletable / permanent / unspecified
85 |
86 | #### Inherited from
87 |
88 | [AppDeployMetadata](types_app.AppDeployMetadata.md).[deletable](types_app.AppDeployMetadata.md#deletable)
89 |
90 | #### Defined in
91 |
92 | [src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253)
93 |
94 | ___
95 |
96 | ### deleted
97 |
98 | • **deleted**: `boolean`
99 |
100 | Whether or not the app is deleted
101 |
102 | #### Defined in
103 |
104 | [src/types/app-deployer.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L85)
105 |
106 | ___
107 |
108 | ### name
109 |
110 | • **name**: `string`
111 |
112 | The unique name identifier of the app within the creator account
113 |
114 | #### Inherited from
115 |
116 | [AppDeployMetadata](types_app.AppDeployMetadata.md).[name](types_app.AppDeployMetadata.md#name)
117 |
118 | #### Defined in
119 |
120 | [src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249)
121 |
122 | ___
123 |
124 | ### updatable
125 |
126 | • `Optional` **updatable**: `boolean`
127 |
128 | Whether or not the app is updatable / immutable / unspecified
129 |
130 | #### Inherited from
131 |
132 | [AppDeployMetadata](types_app.AppDeployMetadata.md).[updatable](types_app.AppDeployMetadata.md#updatable)
133 |
134 | #### Defined in
135 |
136 | [src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255)
137 |
138 | ___
139 |
140 | ### updatedRound
141 |
142 | • **updatedRound**: `bigint`
143 |
144 | The last round that the app was updated
145 |
146 | #### Defined in
147 |
148 | [src/types/app-deployer.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L81)
149 |
150 | ___
151 |
152 | ### version
153 |
154 | • **version**: `string`
155 |
156 | The version of app that is / will be deployed
157 |
158 | #### Inherited from
159 |
160 | [AppDeployMetadata](types_app.AppDeployMetadata.md).[version](types_app.AppDeployMetadata.md#version)
161 |
162 | #### Defined in
163 |
164 | [src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251)
165 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/algokit:cli:features:dispenser.md:
--------------------------------------------------------------------------------
```markdown
1 | # AlgoKit TestNet Dispenser
2 |
3 | The AlgoKit Dispenser feature allows you to interact with the AlgoKit TestNet Dispenser. This feature is essential for funding your wallet with TestNet ALGOs, refunding ALGOs back to the dispenser wallet, and getting information about current fund limits on your account.
4 |
5 | ## Usage
6 |
7 | ```zsh
8 | $ algokit dispenser [OPTIONS] COMMAND [ARGS]...
9 | ```
10 |
11 | This command provides a set of subcommands to interact with the AlgoKit TestNet Dispenser.
12 | Subcommands
13 |
14 | - `login`: Login to your Dispenser API account.
15 | - `logout`: Logout of your Dispenser API account.
16 | - `fund`: Fund your wallet address with TestNet ALGOs.
17 | - `refund`: Refund ALGOs back to the dispenser wallet address.
18 | - `limit`: Get information about current fund limits on your account.
19 |
20 | ### API Documentation
21 |
22 | For detailed API documentation, visit the [AlgoKit Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) documentation.
23 |
24 | ### CI Access Token
25 |
26 | All dispenser commands can work in CI mode by using a CI access token that can be generated by passing `--ci` flag to `login` command. Once a token is obtained, setting the value to the following environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN` will enable CI mode for all dispenser commands. If both a user mode and CI mode access token is available, the CI mode will take precedence.
27 |
28 | ## Login
29 |
30 | ```zsh
31 | $ algokit dispenser login [OPTIONS]
32 | ```
33 |
34 | This command logs you into your Dispenser API account if you are not already logged in.
35 | Options
36 |
37 | - `--ci`: Generate an access token for CI. Issued for 30 days.
38 | - `--output`, -o: Output mode where you want to store the generated access token. Defaults to stdout. Only applicable when --ci flag is set.
39 | - `--file`, -f: Output filename where you want to store the generated access token. Defaults to `ci_token.txt`. Only applicable when --ci flag is set and --output mode is `file`.
40 |
41 | > Please note, algokit relies on [keyring](https://pypi.org/project/keyring/) for storing your API credentials. This implies that your credentials are stored in your system's keychain. By default it will prompt for entering your system password unless you have set it up to always allow access for `algokit-cli` to obtain API credentials.
42 |
43 | ## Logout
44 |
45 | ```zsh
46 | $ algokit dispenser logout
47 | ```
48 |
49 | This command logs you out of your Dispenser API account if you are logged in.
50 |
51 | ## Fund
52 |
53 | ```zsh
54 | $ algokit dispenser fund [OPTIONS]
55 | ```
56 |
57 | This command funds your wallet address with TestNet ALGOs.
58 | Options
59 |
60 | - `--receiver`, -r: Receiver [alias](./tasks/wallet.md#add) or address to fund with TestNet ALGOs. This option is required.
61 | - `--amount`, -a: Amount to fund. Defaults to microAlgos. This option is required.
62 | - `--whole-units`: Use whole units (Algos) instead of smallest divisible units (microAlgos). Disabled by default.
63 |
64 | ## Refund
65 |
66 | ```zsh
67 | $ algokit dispenser refund [OPTIONS]
68 | ```
69 |
70 | This command refunds ALGOs back to the dispenser wallet address.
71 | Options
72 |
73 | - `--txID`, -t: Transaction ID of your refund operation. This option is required. The receiver address of the transaction must be the same as the dispenser wallet address that you can obtain by observing a `sender` field of [`fund`](#fund) transaction.
74 |
75 | > Please note, performing a refund operation will not immedately change your daily fund limit. Your daily fund limit is reset daily at midnigth UTC. If you have reached your daily fund limit, you will not be able to perform a refund operation until your daily fund limit is reset.
76 |
77 | ## Limit
78 |
79 | ```zsh
80 | $ algokit dispenser limit [OPTIONS]
81 | ```
82 |
83 | This command gets information about current fund limits on your account. The limits reset daily.
84 | Options
85 |
86 | - `--whole-units`: Use whole units (Algos) instead of smallest divisible units (microAlgos). Disabled by default.
87 |
88 | ## Further Reading
89 |
90 | For in-depth details, visit the [dispenser section](../cli/index.md#dispenser) in the AlgoKit CLI reference documentation.
91 |
```
--------------------------------------------------------------------------------
/packages/server/src/resources/knowledge/taxonomy/SDKs:javascript:classes:modelsv2.StateProofMessage.md:
--------------------------------------------------------------------------------
```markdown
1 | [algosdk](../README.md) / [Exports](../modules.md) / [modelsv2](../modules/modelsv2.md) / StateProofMessage
2 |
3 | # Class: StateProofMessage
4 |
5 | [modelsv2](../modules/modelsv2.md).StateProofMessage
6 |
7 | Represents the message that the state proofs are attesting to.
8 |
9 | ## Hierarchy
10 |
11 | - `default`
12 |
13 | ↳ **`StateProofMessage`**
14 |
15 | ## Table of contents
16 |
17 | ### Constructors
18 |
19 | - [constructor](modelsv2.StateProofMessage.md#constructor)
20 |
21 | ### Properties
22 |
23 | - [attribute\_map](modelsv2.StateProofMessage.md#attribute_map)
24 | - [blockheaderscommitment](modelsv2.StateProofMessage.md#blockheaderscommitment)
25 | - [firstattestedround](modelsv2.StateProofMessage.md#firstattestedround)
26 | - [lastattestedround](modelsv2.StateProofMessage.md#lastattestedround)
27 | - [lnprovenweight](modelsv2.StateProofMessage.md#lnprovenweight)
28 | - [voterscommitment](modelsv2.StateProofMessage.md#voterscommitment)
29 |
30 | ### Methods
31 |
32 | - [get\_obj\_for\_encoding](modelsv2.StateProofMessage.md#get_obj_for_encoding)
33 | - [from\_obj\_for\_encoding](modelsv2.StateProofMessage.md#from_obj_for_encoding)
34 |
35 | ## Constructors
36 |
37 | ### constructor
38 |
39 | • **new StateProofMessage**(`«destructured»`)
40 |
41 | Creates a new `StateProofMessage` object.
42 |
43 | #### Parameters
44 |
45 | | Name | Type |
46 | | :------ | :------ |
47 | | `«destructured»` | `Object` |
48 | | › `blockheaderscommitment` | `string` \| `Uint8Array` |
49 | | › `firstattestedround` | `number` \| `bigint` |
50 | | › `lastattestedround` | `number` \| `bigint` |
51 | | › `lnprovenweight` | `number` \| `bigint` |
52 | | › `voterscommitment` | `string` \| `Uint8Array` |
53 |
54 | #### Overrides
55 |
56 | BaseModel.constructor
57 |
58 | #### Defined in
59 |
60 | client/v2/algod/models/types.ts:5479
61 |
62 | ## Properties
63 |
64 | ### attribute\_map
65 |
66 | • **attribute\_map**: `Record`\<`string`, `string`\>
67 |
68 | #### Inherited from
69 |
70 | BaseModel.attribute\_map
71 |
72 | #### Defined in
73 |
74 | client/v2/basemodel.ts:56
75 |
76 | ___
77 |
78 | ### blockheaderscommitment
79 |
80 | • **blockheaderscommitment**: `Uint8Array`
81 |
82 | The vector commitment root on all light block headers within a state proof
83 | interval.
84 |
85 | #### Defined in
86 |
87 | client/v2/algod/models/types.ts:5446
88 |
89 | ___
90 |
91 | ### firstattestedround
92 |
93 | • **firstattestedround**: `number` \| `bigint`
94 |
95 | The first round the message attests to.
96 |
97 | #### Defined in
98 |
99 | client/v2/algod/models/types.ts:5451
100 |
101 | ___
102 |
103 | ### lastattestedround
104 |
105 | • **lastattestedround**: `number` \| `bigint`
106 |
107 | The last round the message attests to.
108 |
109 | #### Defined in
110 |
111 | client/v2/algod/models/types.ts:5456
112 |
113 | ___
114 |
115 | ### lnprovenweight
116 |
117 | • **lnprovenweight**: `number` \| `bigint`
118 |
119 | An integer value representing the natural log of the proven weight with 16 bits
120 | of precision. This value would be used to verify the next state proof.
121 |
122 | #### Defined in
123 |
124 | client/v2/algod/models/types.ts:5462
125 |
126 | ___
127 |
128 | ### voterscommitment
129 |
130 | • **voterscommitment**: `Uint8Array`
131 |
132 | The vector commitment root of the top N accounts to sign the next StateProof.
133 |
134 | #### Defined in
135 |
136 | client/v2/algod/models/types.ts:5467
137 |
138 | ## Methods
139 |
140 | ### get\_obj\_for\_encoding
141 |
142 | ▸ **get_obj_for_encoding**(`binary?`): `Record`\<`string`, `any`\>
143 |
144 | Get an object ready for encoding to either JSON or msgpack.
145 |
146 | #### Parameters
147 |
148 | | Name | Type | Default value | Description |
149 | | :------ | :------ | :------ | :------ |
150 | | `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. |
151 |
152 | #### Returns
153 |
154 | `Record`\<`string`, `any`\>
155 |
156 | #### Inherited from
157 |
158 | BaseModel.get\_obj\_for\_encoding
159 |
160 | #### Defined in
161 |
162 | client/v2/basemodel.ts:65
163 |
164 | ___
165 |
166 | ### from\_obj\_for\_encoding
167 |
168 | ▸ `Static` **from_obj_for_encoding**(`data`): [`StateProofMessage`](modelsv2.StateProofMessage.md)
169 |
170 | #### Parameters
171 |
172 | | Name | Type |
173 | | :------ | :------ |
174 | | `data` | `Record`\<`string`, `any`\> |
175 |
176 | #### Returns
177 |
178 | [`StateProofMessage`](modelsv2.StateProofMessage.md)
179 |
180 | #### Defined in
181 |
182 | client/v2/algod/models/types.ts:5515
183 |
```