@goplausible/algorand-mcp 3.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +692 -0
- package/dist/algorand-client.d.ts +2 -0
- package/dist/algorand-client.js +2 -0
- package/dist/env.d.ts +1 -0
- package/dist/env.js +4 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +158 -0
- package/dist/networkConfig.d.ts +5 -0
- package/dist/networkConfig.js +57 -0
- package/dist/resources/index.d.ts +16 -0
- package/dist/resources/index.js +37 -0
- package/dist/resources/knowledge/index.d.ts +72 -0
- package/dist/resources/knowledge/index.js +180 -0
- package/dist/resources/knowledge/taxonomy/algokit-cli:README.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:README.md +70 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:algokit.md +52 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md +94 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md +95 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md +412 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_brew_install.md +86 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md +375 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md +164 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md +203 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-13_native_binaries.md +163 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md +211 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md +255 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md +143 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:articles:output_stability.md +8 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:cli:index.md +1517 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:compile.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:completions.md +56 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:config.md +37 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:dispenser.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:doctor.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:explore.md +21 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:generate.md +179 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:goal.md +139 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:init.md +122 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:localnet.md +191 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project.md +95 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:bootstrap.md +128 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:deploy.md +211 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:link.md +67 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:list.md +43 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:run.md +184 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks.md +16 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:analyze.md +33 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:ipfs.md +66 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:mint.md +70 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:nfd.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:opt.md +71 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:send.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:sign.md +94 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:transfer.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:vanity_address.md +56 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:wallet.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:algokit-template.md +220 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:intro.md +171 -0
- package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:smart-contracts.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:docs:testnet_api.md +157 -0
- package/dist/resources/knowledge/taxonomy/algokit:lora:README.md +61 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:README.md +35 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md +1095 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:account.md +32 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-client.md +154 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-deploy.md +121 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:client.md +29 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:debugger.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:dispenser-client.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:transfer.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:index.md +123 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:account.md +31 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-client.md +157 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-deploy.md +121 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:client.md +29 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:debugger.md +45 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:dispenser-client.md +60 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:transfer.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:index.md +103 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:README.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:account.md +186 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:algorand-client.md +160 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:amount.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-client.md +422 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-deploy.md +278 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app.md +442 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:asset.md +331 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:client.md +115 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:debugging.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:dispenser-client.md +85 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:event-emitter.md +97 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:indexer.md +83 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:testing.md +207 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction-composer.md +89 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction.md +23 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transfer.md +129 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:typed-app-clients.md +201 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:README.md +53 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TestLogger.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TransactionLogger.md +149 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.MultisigAccount.md +178 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.SigningAccount.md +153 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md +924 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md +200 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md +646 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md +1290 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md +1425 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md +247 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md +259 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.AppClient.md +1350 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md +887 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md +186 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md +780 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_manager.AppManager.md +527 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md +221 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md +244 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md +1072 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md +1281 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md +274 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md +225 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md +182 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_logic_error.LogicError.md +261 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnUpdate.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md +78 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.SignatureType.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md +32 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md +69 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md +102 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md +233 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md +108 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md +72 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md +305 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppLookup.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md +174 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppReference.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppState.md +11 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxName.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxReference.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md +287 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md +148 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md +274 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md +284 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md +145 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md +150 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md +49 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md +80 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md +83 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md +111 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md +239 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md +120 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md +62 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md +65 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md +164 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md +145 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md +156 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md +64 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md +58 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md +105 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md +224 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md +268 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md +369 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md +272 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md +84 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md +39 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_config.Config.md +115 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md +25 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md +51 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md +77 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md +72 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md +79 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md +149 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md +165 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md +65 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md +53 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md +98 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md +52 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md +88 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md +92 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md +57 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md +135 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md +48 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md +49 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md +54 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md +222 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md +235 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md +248 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md +38 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md +261 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.indexer.md +194 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.md +3215 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:testing.md +243 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account.md +100 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager.md +42 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_interface.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app.md +279 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_arc56.md +346 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client.md +347 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_deployer.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory.md +124 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_manager.md +36 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_spec.md +160 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset.md +12 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset_manager.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter.md +44 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager.md +122 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_composer.md +433 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_config.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_debugging.md +79 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client.md +15 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client_spec.md +3 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_expand.md +28 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_indexer.md +611 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_kmd_account_manager.md +9 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_lifecycle_events.md +34 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logging.md +93 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logic_error.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_network_client.md +39 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_testing.md +14 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transaction.md +90 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transfer.md +13 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v7-migration.md +392 -0
- package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v8-migration.md +102 -0
- package/dist/resources/knowledge/taxonomy/arcs:ARC-template.md +48 -0
- package/dist/resources/knowledge/taxonomy/arcs:README.md +41 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0012:README.md +30 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0034:TemplateForm.md +58 -0
- package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0062:README.md +16 -0
- package/dist/resources/knowledge/taxonomy/arcs:pages:nfts.md +24 -0
- package/dist/resources/knowledge/taxonomy/arcs:pages:wallets.md +74 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0000.md +298 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0001.md +480 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0002.md +138 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0003.md +469 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0004.md +725 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0005.md +90 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0006.md +202 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0007.md +113 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0008.md +55 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0009.md +63 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0010.md +111 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0011.md +47 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0012.md +158 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0015.md +112 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0016.md +97 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0018.md +616 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0019.md +246 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0020.md +742 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0021.md +98 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0022.md +75 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0023.md +189 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0025.md +241 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0026.md +112 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0028.md +176 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0032.md +286 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0033.md +104 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0034.md +167 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0035.md +151 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0036.md +84 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0042.md +76 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0047.md +171 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0048.md +85 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0049.md +80 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0054.md +217 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0055.md +540 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0056.md +516 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0059.md +726 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0062.md +339 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0065.md +169 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0069.md +183 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0072.md +335 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0073.md +93 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0074.md +128 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0076.md +99 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0078.md +220 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0079.md +109 -0
- package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0200.md +232 -0
- package/dist/resources/knowledge/taxonomy/clis_index.md +2347 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:about.md +13 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:algokey.md +45 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:generate.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:import.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:append-auth-addr.md +44 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:multisig.md +47 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:info.md +40 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:part.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:reparent.md +42 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:sign.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:conduit.md +71 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:init.md +88 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:exporters.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:importers.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:list.md +63 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:processors.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:diagcfg.md +39 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:disable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:enable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:metric.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:status.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:disable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:enable.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:endpoint.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:name.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:status.md +58 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:telemetry.md +53 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:restart.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:start.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:status.md +62 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:stop.md +52 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:wait.md +62 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:protocols.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:report.md +60 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:version.md +54 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:list.md +52 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:new.md +54 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:wallet.md +56 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:api-config.md +50 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:daemon.md +110 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:indexer.md +50 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:util.md +39 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:validator.md +72 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:kmd.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:debug.md +92 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:remote.md +66 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:tealdbg.md +59 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:create.md +741 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:index.md +107 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:rekey.md +462 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:betanet.md +31 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:index.md +23 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:mainnet.md +19 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:testnet.md +25 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand_consensus.md +46 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:asa.md +1214 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:atc.md +412 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:atomic_transfers.md +396 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:conduit.md +95 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:crust.md +156 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:index.md +18 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:guidelines.md +3 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:index.md +332 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:jsonspec.md +134 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:index.md +16 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v1.md +401 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v10.md +1748 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v2.md +671 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v3.md +789 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v4.md +1029 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v5.md +1263 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v6.md +1359 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v7.md +1481 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v8.md +1640 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v9.md +1640 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:specification.md +945 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:ABI:index.md +172 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:create.md +398 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:index.md +246 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:innertx.md +514 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:state.md +704 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:txs.md +231 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:debugging.md +897 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:apps.md +1680 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md +492 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:guidelines.md +405 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:index.md +41 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:index.md +15 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:modes.md +34 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md +159 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:beaker.md +341 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:pyteal.md +786 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:python.md +3 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:encoding.md +457 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:ethereum_to_algorand.md +239 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:index.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:indexer.md +472 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:parameter_tables.md +84 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:index.md +61 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:light_client.md +390 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:technical_faq.md +233 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:index.md +746 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:offline_transactions.md +319 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:payment_prompts.md +96 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:signatures.md +484 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:transactions.md +168 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:details:useful_resources.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:algokit.md +263 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:what_is_blockchain.md +69 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:whats_a_dapp.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:where_to_start.md +43 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:why_algorand.md +119 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:ft.md +24 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:nft.md +41 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:index.md +100 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:algod.md +3163 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:indexer.md +2142 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:kmd.md +1347 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:restendpoints.md +76 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:catchup.md +33 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:switch_networks.md +89 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:generate_keys.md +76 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:index.md +56 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:offline.md +83 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:online.md +170 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:renew.md +29 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:artifacts.md +89 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:config.md +190 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:relay.md +51 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:telemetry-config.md +31 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:indexer.md +71 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:install.md +618 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:node-troubleshooting.md +190 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:types.md +77 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:go:index.md +189 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:index.md +38 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:java:index.md +164 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:javascript:index.md +168 -0
- package/dist/resources/knowledge/taxonomy/developer:docs:sdks:python:index.md +162 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:accounts.md +215 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:arc4_types.md +267 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:assets.md +235 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:box_storage.md +211 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:control_flow.md +162 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:crypto:merkle_tree.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:amm.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:auction.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:htlc_logicsig.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:marketplace.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:events:arc28_events.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:global_storage.md +192 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:governance:simple_voting.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:hello_world.md +133 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:inner_transactions.md +247 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:local_storage.md +227 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:nft:proof_of_attendance.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:privacy:zk_whitelist.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:scratch_storage.md +169 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:self_payment.md +167 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:struct_in_box.md +182 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:subsidize_app_call.md +189 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:transactions.md +0 -0
- package/dist/resources/knowledge/taxonomy/developer:python:code:example:utility:calculator.md +0 -0
- package/dist/resources/knowledge/taxonomy/devportal-code-examples:README.md +31 -0
- package/dist/resources/knowledge/taxonomy/devportal-code-examples:projects:python-contract-examples:README.md +155 -0
- package/dist/resources/knowledge/taxonomy/docs:.walletconnect:index.md +133 -0
- package/dist/resources/knowledge/taxonomy/docs:.walletconnect:walletconnect-schema.md +167 -0
- package/dist/resources/knowledge/taxonomy/docs:README.md +12 -0
- package/dist/resources/knowledge/taxonomy/docs:scripts:README.md +90 -0
- package/dist/resources/knowledge/taxonomy/docs:scripts:example_tracker:example_list.md +132 -0
- package/dist/resources/knowledge/taxonomy/index.md +2044 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:ARCHITECTURE.md +241 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:README.md +105 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:SEQUENCE.md +41 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:VISION.md +13 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:1-Service-Authentication.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:2-Bidirectional-Communication.md +42 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:3-Peer-to-Peer-Signaling.md +60 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:4-Fido-Extension.md +51 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:README.md +6 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:README.md +54 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:architecture.md +101 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:authenticate.md +13 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:register.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:authentication.md +107 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:example.md +64 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:introduction.md +18 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:environment-variables.md +75 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:integrations.md +168 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:introduction.md +22 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:running-locally.md +88 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md +3 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md +3 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md +1 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md +0 -0
- package/dist/resources/knowledge/taxonomy/liquid-auth:sites:express-dapp:README.md +73 -0
- package/dist/resources/knowledge/taxonomy/liquid_auth_index.md +2221 -0
- package/dist/resources/knowledge/taxonomy/puya:README.md +72 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:algopy_testing:index.md +15 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.arc4.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.gtxn.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.itxn.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.op.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:api.md +6 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:compiler.md +239 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:index.md +63 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:language-guide.md +86 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc28.md +53 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc4.md +225 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-builtins.md +26 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-calling-apps.md +142 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-compile.md +70 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-control.md +87 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-errors.md +36 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-logs.md +46 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-modules.md +90 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-opcode-budget.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-ops.md +40 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-storage.md +222 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-structure.md +283 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-transactions.md +248 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-types.md +319 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:lg-unsupported-python-features.md +52 -0
- package/dist/resources/knowledge/taxonomy/puya:docs:principles.md +196 -0
- package/dist/resources/knowledge/taxonomy/puya:examples:auction:README.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:README.md +66 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:algopy.md +9 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:api.md +41 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:coverage.md +159 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:examples.md +13 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:faq.md +61 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:index.md +182 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:arc4-types.md +96 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:avm-types.md +223 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:concepts.md +58 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:contract-testing.md +225 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:index.md +67 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:opcodes.md +382 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:signature-testing.md +73 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:state-management.md +104 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:subroutines.md +62 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:transactions.md +200 -0
- package/dist/resources/knowledge/taxonomy/puya:python:testing:examples:README.md +56 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puya:ARCHITECTURE.md +26 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_typeshed:README.md +10 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md +34 -0
- package/dist/resources/knowledge/taxonomy/puya:src:puyapy:awst_build:README.md +13 -0
- package/dist/resources/knowledge/taxonomy/puya:stubs:README.md +89 -0
- package/dist/resources/knowledge/taxonomy/puya:tests:test_expected_output:README.md +17 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:README.md +11 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:README.md +35 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md +196 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md +179 -0
- package/dist/resources/knowledge/taxonomy/puya:typescript:packages:algo-ts:readme.md +3 -0
- package/dist/resources/knowledge/taxonomy/puya_index.md +2143 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:FAQ.md +21 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:README.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIAddressType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayDynamicType.md +230 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayStaticType.md +236 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIBoolType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIByteType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIContract.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIInterface.md +100 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIMethod.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIStringType.md +185 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABITupleType.md +230 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIType.md +169 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUfixedType.md +221 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUintType.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Algodv2.md +1321 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:AtomicTransactionComposer.md +385 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:DryrunResult.md +61 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Indexer.md +727 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Kmd.md +642 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSig.md +315 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSigAccount.md +276 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:SourceMap.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Transaction.md +1133 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Account.md +557 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountParticipation.md +195 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountResponse.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountStateDelta.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Application.md +180 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalState.md +195 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogData.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogsResponse.md +163 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationParams.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationResponse.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationStateSchema.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Asset.md +183 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetBalancesResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHolding.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHoldingsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetParams.md +334 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetResponse.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Block.md +390 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockRewards.md +199 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeState.md +181 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeVote.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Box.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxDescriptor.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxesResponse.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ErrorResponse.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDelta.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDeltaKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HashFactory.md +122 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HealthCheck.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.IndexerStateProofMessage.md +178 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MerkleArrayProof.md +148 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MiniAssetHolding.md +188 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ParticipationUpdates.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofFields.md +211 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofParticipant.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofReveal.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSigSlot.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSignature.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofTracking.md +166 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofVerifier.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateSchema.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Transaction.md +629 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionApplication.md +291 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetConfig.md +145 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetFreeze.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetTransfer.md +201 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionKeyreg.md +211 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionPayment.md +170 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionResponse.md +140 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignature.md +157 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureLogicsig.md +171 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisig.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionStateProof.md +157 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionsResponse.md +149 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Account.md +516 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountApplicationResponse.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetHolding.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetResponse.md +156 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetsInformationResponse.md +151 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountParticipation.md +196 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountStateDelta.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AppCallLogs.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Application.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationInitialStates.md +167 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationKVStorage.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalState.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationParams.md +209 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateOperation.md +182 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateSchema.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Asset.md +141 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHolding.md +154 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHoldingReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetParams.md +334 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockHashResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockLogsResponse.md +128 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockResponse.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockTxidsResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Box.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxDescriptor.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxReference.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxesResponse.md +122 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BuildVersion.md +180 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.CompileResponse.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DisassembleResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunRequest.md +204 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunResponse.md +148 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunSource.md +163 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunState.md +176 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunTxnResult.md +253 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ErrorResponse.md +134 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDelta.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDeltaKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetSyncRoundResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.KvDelta.md +139 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LightBlockHeaderProof.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.NodeStatusResponse.md +480 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionResponse.md +312 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionsResponse.md +140 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PostTransactionsResponse.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ScratchChange.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateInitialStates.md +125 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequest.md +227 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md +124 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateResponse.md +197 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTraceConfig.md +169 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionGroupResult.md +206 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionResult.md +206 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md +221 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationEvalOverrides.md +198 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md +194 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationTransactionExecTrace.md +241 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProof.md +138 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProofMessage.md +182 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SupplyResponse.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealKeyValue.md +136 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealValue.md +152 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md +123 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionParametersResponse.md +200 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionProofResponse.md +183 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Version.md +158 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABIReferenceType.md +47 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABITransactionType.md +99 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:AtomicTransactionComposerStatus.md +73 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:IntDecoding.md +65 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:OnApplicationComplete.md +96 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:TransactionType.md +103 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:examples:README.md +9 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworkInfo.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworks.md +7 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractParams.md +63 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIInterfaceParams.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodArgParams.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodParams.md +78 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodReturnParams.md +30 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIResult.md +90 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Account.md +38 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Address.md +32 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:AlgodTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClient.md +98 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientError.md +22 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientResponse.md +41 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BoxReference.md +36 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:CustomTokenHeader.md +7 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedAssetParams.md +153 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedBoxReference.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedGlobalStateSchema.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLocalStateSchema.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSig.md +52 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSigAccount.md +30 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedMultisig.md +50 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSignedTransaction.md +75 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSubsig.md +34 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedTransaction.md +606 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:IndexerTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:KMDTokenHeader.md +19 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:MultisigMetadata.md +52 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SignedTransaction.md +75 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SuggestedParams.md +89 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionParams.md +718 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionWithSigner.md +36 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules.md +2993 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:indexerModels.md +69 -0
- package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:modelsv2.md +79 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:README.md +120 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:algosdk:v2client:harness:README.md +18 -0
- package/dist/resources/knowledge/taxonomy/sdks:python:examples:README.md +11 -0
- package/dist/resources/knowledge/taxonomy/tealscript:FEATURES.md +252 -0
- package/dist/resources/knowledge/taxonomy/tealscript:README.md +54 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_amm_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_auction_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_big_box_README.md +20 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_itxns_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_lsig_with_app_README.md +3 -0
- package/dist/resources/knowledge/taxonomy/tealscript:examples_reti_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_arrays.md +104 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_numbers.md +49 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_atomic_txn.md +22 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_features.md +256 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_getting_started.md +88 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_inner_transactions.md +43 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_lifecycle.md +88 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_math.md +54 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_methods.md +85 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_multiple_contracts.md +92 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_pyteal.md +35 -0
- package/dist/resources/knowledge/taxonomy/tealscript:guides_storage.md +110 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tests_test_package_README.md +1 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0001-intro.md +9 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0002-init.md +50 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0003-contract.md +98 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0004-artifacts.md +59 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0005-hello.md +35 -0
- package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0006-test.md +30 -0
- package/dist/resources/knowledge/taxonomy-categories/algokit-utils.json +148 -0
- package/dist/resources/knowledge/taxonomy-categories/algokit.json +105 -0
- package/dist/resources/knowledge/taxonomy-categories/arcs.json +92 -0
- package/dist/resources/knowledge/taxonomy-categories/clis.json +280 -0
- package/dist/resources/knowledge/taxonomy-categories/details.json +173 -0
- package/dist/resources/knowledge/taxonomy-categories/developers.json +71 -0
- package/dist/resources/knowledge/taxonomy-categories/liquid-auth.json +127 -0
- package/dist/resources/knowledge/taxonomy-categories/nodes.json +50 -0
- package/dist/resources/knowledge/taxonomy-categories/puya.json +76 -0
- package/dist/resources/knowledge/taxonomy-categories/python.json +104 -0
- package/dist/resources/knowledge/taxonomy-categories/sdks.json +152 -0
- package/dist/resources/knowledge/taxonomy-categories/tealscript.json +80 -0
- package/dist/tools/accountManager.d.ts +150 -0
- package/dist/tools/accountManager.js +339 -0
- package/dist/tools/algodManager.d.ts +134 -0
- package/dist/tools/algodManager.js +257 -0
- package/dist/tools/apiManager/algod/account.d.ts +10 -0
- package/dist/tools/apiManager/algod/account.js +135 -0
- package/dist/tools/apiManager/algod/application.d.ts +10 -0
- package/dist/tools/apiManager/algod/application.js +165 -0
- package/dist/tools/apiManager/algod/asset.d.ts +8 -0
- package/dist/tools/apiManager/algod/asset.js +47 -0
- package/dist/tools/apiManager/algod/index.d.ts +6 -0
- package/dist/tools/apiManager/algod/index.js +32 -0
- package/dist/tools/apiManager/algod/transaction.d.ts +14 -0
- package/dist/tools/apiManager/algod/transaction.js +216 -0
- package/dist/tools/apiManager/example/get-balance.d.ts +11 -0
- package/dist/tools/apiManager/example/get-balance.js +32 -0
- package/dist/tools/apiManager/example/index.d.ts +6 -0
- package/dist/tools/apiManager/example/index.js +18 -0
- package/dist/tools/apiManager/index.d.ts +45 -0
- package/dist/tools/apiManager/index.js +53 -0
- package/dist/tools/apiManager/indexer/account.d.ts +24 -0
- package/dist/tools/apiManager/indexer/account.js +248 -0
- package/dist/tools/apiManager/indexer/application.d.ts +24 -0
- package/dist/tools/apiManager/indexer/application.js +290 -0
- package/dist/tools/apiManager/indexer/asset.d.ts +36 -0
- package/dist/tools/apiManager/indexer/asset.js +292 -0
- package/dist/tools/apiManager/indexer/index.d.ts +6 -0
- package/dist/tools/apiManager/indexer/index.js +39 -0
- package/dist/tools/apiManager/indexer/transaction.d.ts +34 -0
- package/dist/tools/apiManager/indexer/transaction.js +276 -0
- package/dist/tools/apiManager/nfd/index.d.ts +6 -0
- package/dist/tools/apiManager/nfd/index.js +476 -0
- package/dist/tools/apiManager/tinyman/analytics.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/analytics.js +80 -0
- package/dist/tools/apiManager/tinyman/bootstrap.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/bootstrap.js +85 -0
- package/dist/tools/apiManager/tinyman/index.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/index.js +60 -0
- package/dist/tools/apiManager/tinyman/liquidity.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/liquidity.js +143 -0
- package/dist/tools/apiManager/tinyman/opt_in.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/opt_in.js +112 -0
- package/dist/tools/apiManager/tinyman/pool.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/pool.js +90 -0
- package/dist/tools/apiManager/tinyman/remove_liquidity.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/remove_liquidity.js +148 -0
- package/dist/tools/apiManager/tinyman/swap.d.ts +3 -0
- package/dist/tools/apiManager/tinyman/swap.js +147 -0
- package/dist/tools/arc26Manager.d.ts +37 -0
- package/dist/tools/arc26Manager.js +131 -0
- package/dist/tools/commonParams.d.ts +18 -0
- package/dist/tools/commonParams.js +28 -0
- package/dist/tools/index.d.ts +8 -0
- package/dist/tools/index.js +8 -0
- package/dist/tools/knowledgeManager.d.ts +28 -0
- package/dist/tools/knowledgeManager.js +73 -0
- package/dist/tools/transactionManager/accountTransactions.d.ts +127 -0
- package/dist/tools/transactionManager/accountTransactions.js +177 -0
- package/dist/tools/transactionManager/appTransactions/callTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/callTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/clearTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/clearTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/closeOutTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/closeOutTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/createTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/createTxn.js +128 -0
- package/dist/tools/transactionManager/appTransactions/deleteTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/deleteTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/index.d.ts +23 -0
- package/dist/tools/transactionManager/appTransactions/index.js +56 -0
- package/dist/tools/transactionManager/appTransactions/optInTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/optInTxn.js +95 -0
- package/dist/tools/transactionManager/appTransactions/types.d.ts +525 -0
- package/dist/tools/transactionManager/appTransactions/types.js +298 -0
- package/dist/tools/transactionManager/appTransactions/updateTxn.d.ts +17 -0
- package/dist/tools/transactionManager/appTransactions/updateTxn.js +101 -0
- package/dist/tools/transactionManager/assetTransactions.d.ts +300 -0
- package/dist/tools/transactionManager/assetTransactions.js +351 -0
- package/dist/tools/transactionManager/generalTransaction.d.ts +96 -0
- package/dist/tools/transactionManager/generalTransaction.js +504 -0
- package/dist/tools/transactionManager/index.d.ts +18 -0
- package/dist/tools/transactionManager/index.js +42 -0
- package/dist/tools/utilityManager.d.ts +127 -0
- package/dist/tools/utilityManager.js +422 -0
- package/dist/tools/walletManager.d.ts +46 -0
- package/dist/tools/walletManager.js +781 -0
- package/dist/types.d.ts +123 -0
- package/dist/types.js +42 -0
- package/dist/utils/responseProcessor.d.ts +31 -0
- package/dist/utils/responseProcessor.js +152 -0
- package/package.json +58 -0
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# Advanced `algokit generate` command
|
|
2
|
+
|
|
3
|
+
- **Status**: Approved
|
|
4
|
+
- **Owner:** Altynbek Orumbayev, Inaie Ignacio
|
|
5
|
+
- **Deciders**: Rob Moore, Daniel McGregor, Alessandro Cappellato
|
|
6
|
+
- **Date created**: 2023-07-19
|
|
7
|
+
- **Date decided:** 2023-07-24
|
|
8
|
+
- **Date updated**: 2023-07-24
|
|
9
|
+
|
|
10
|
+
## Context
|
|
11
|
+
|
|
12
|
+
The [Frontend Templates ADR](./2023-06-06_frontend-templates.md) introduced and expanded on AlgoKit's principles of Modularity and Maintainability by introducing a new set of official templates for quickly bootstrapping standalone `react` and `fullstack` projects showcasing best practices and patterns for building frontend and fullstack applications with Algorand. As a logical next step, we want to enable developers to extend existing projects instantiated from official templates with new files and features.
|
|
13
|
+
|
|
14
|
+
## Requirements
|
|
15
|
+
|
|
16
|
+
### 1. AlgoKit user should be able to use generate command to extend existing algokit compliant projects with new `files` of any kind
|
|
17
|
+
|
|
18
|
+
This implies scenarios like:
|
|
19
|
+
|
|
20
|
+
- Adding new contracts into existing algokit compliant projects.
|
|
21
|
+
> Algokit compliant projects are projects that were instantiated from official or community templates and follow the same structure and conventions.
|
|
22
|
+
- Overriding existing files with new ones.
|
|
23
|
+
- Adding new files into existing projects.
|
|
24
|
+
|
|
25
|
+
Overall, we want to introduce a notion of `generators` which can be viewed as a modular self-sufficient template units that are hosted within template repositories and describe how to create or update files within projects instantiated from AlgoKit templates.
|
|
26
|
+
|
|
27
|
+
Ruby on Rails has a similar concept of [generators](https://guides.rubyonrails.org/generators.html) which are used to create or update files within Rails projects. This can be used as a reference for inspiration.
|
|
28
|
+
|
|
29
|
+
### 2. Template builder should be able to access a clear guideline and refer to official templates for examples on how to create `generators`
|
|
30
|
+
|
|
31
|
+
This implies extension of existing starter guidelines available for template builders on [AlgoKit Docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/algokit-template.md) and using one or several official templates as a reference point.
|
|
32
|
+
|
|
33
|
+
## Principles
|
|
34
|
+
|
|
35
|
+
- **Modularity**: Artifacts dependant on `advanced algokit generate` command capabilities embedded into templates should follow guiding AlgoKit principles and expand on approaches already utilized in `react`, `fullstack` and `beaker` templates. This implies that giving developers flexibility to define any extra templating logic, allowing to create or update any files within projects instantiated from algokit templates.
|
|
36
|
+
- **Maintainability**: The `advanced algokit generate` capabilities on `algokit-cli` and related artifacts on respective official templates should be easy to maintain and extend.
|
|
37
|
+
- **Seamless onramp**: Great developer experience for template builders to create their own `generators` and user experience to use them via `advanced algokit generate` command should be a priority.
|
|
38
|
+
|
|
39
|
+
All of the aforementioned requirements should be met in a way that is consistent with the guiding principles of AlgoKit or attempt to find a balanced trade of between the principles that satisfies the requirements. Refer to [AlgoKit Guiding Principles](../../docs/algokit.md#Guiding-Principles) for detailed reference on the principles.
|
|
40
|
+
|
|
41
|
+
## Considered Options
|
|
42
|
+
|
|
43
|
+
Based on preliminary research, all of the options below assume that:
|
|
44
|
+
A `generator` is a self contained copier/jinja template that is hosted within a template repository and describes how to create or update files within projects instantiated from algokit templates. Hosting it along with the template is a necessity given that community based templates can follow different conventions, patterns and structure making it hard to attempt to generalize the logic of `generators` and make them work for all templates.
|
|
45
|
+
|
|
46
|
+
### Option 1: Wrapping generators into self contained copier templates hidden within algokit templates
|
|
47
|
+
|
|
48
|
+
This option implies that `generators` are self contained copier templates that are hidden within algokit templates and are not exposed to the end user. This option is inspired by [Ruby on Rails generators](https://guides.rubyonrails.org/generators.html) and [Yeoman generators](https://yeoman.io/authoring/).
|
|
49
|
+
|
|
50
|
+
The main idea is to rely on `_templates_suffix` in copier.yamls to define 2 separate types of suffixes for `templates` and for `generators`:
|
|
51
|
+
|
|
52
|
+
- Existing templates under all official algokit templates are already prefixed with `.jinja` hence we just need to explicitly prefix it with `.jinja` on root copier
|
|
53
|
+
- The new generators jinja templates can be prefixed (for example) with alternative file extension for jinja files such as `.j2`. Which is also a common convention for jinja templates.
|
|
54
|
+
- - This only works for files though for regular folders and cases like `{% if %}folder_name{% endif %}.j2` we need to wrap them into {% raw %} to that first pass when template initially initialized unwraps the content allowing second pass via generator to then use them as jinja templates. The only downside here is slightly longer file names for folders, but I think it's a reasonable tradeoff considering simplicity of the solution.
|
|
55
|
+
|
|
56
|
+
Overview of the proposal can be summarized via the following diagram:
|
|
57
|
+
|
|
58
|
+
```mermaid
|
|
59
|
+
graph TB
|
|
60
|
+
T["Template Folder"]
|
|
61
|
+
T --> C["copier.yaml"]
|
|
62
|
+
T --> C1["..."]
|
|
63
|
+
T --> G[".algokit/generators"]
|
|
64
|
+
|
|
65
|
+
G --> G1["Generator 1"]
|
|
66
|
+
G1 --> E1["copier.yaml"]
|
|
67
|
+
G1 --> E2["..."]
|
|
68
|
+
|
|
69
|
+
G --> G2["..."]
|
|
70
|
+
G2 --> E3["..."]
|
|
71
|
+
|
|
72
|
+
G --> G3["Generator N"]
|
|
73
|
+
G3 --> E["copier.yaml"]
|
|
74
|
+
G3 --> E4["..."]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
#### Pros
|
|
78
|
+
|
|
79
|
+
- Generators are hidden within algokit templates and are not exposed to the end user. When user runs `algokit generate` command, cli presents a list of available generators to choose from. This makes it easier for user to understand what generators are available and what they do.
|
|
80
|
+
- Generators are self contained copier templates giving template builders flexibility to do any kind of templating logic similar to what they can already do with regular templates.
|
|
81
|
+
- Majority of implementation complexity is reduced by relying on copier as a backbone for generators feature.
|
|
82
|
+
|
|
83
|
+
#### Cons
|
|
84
|
+
|
|
85
|
+
- Generators are somewhat tightly coupled with individual algokit templates, which implies its not necessarily a matter of copy pasting generators from one template to another. This can be a problem for community template builders who want to reuse generators from official templates. However, this can be mitigated by providing clear guidelines on how to create generators and referring to official templates as a reference point. Additionally, it seems like a reasonable tradeoff given that templates can vastly differ in type, structure, conventions and patterns and it's significantly harder to generalize the logic of generators to make them work for all templates.
|
|
86
|
+
|
|
87
|
+
#### Implementation details
|
|
88
|
+
|
|
89
|
+
**1. Adjusting templates structure**
|
|
90
|
+
|
|
91
|
+
For instance, if we assume existing `beaker` template, the new file/folder structure can look as follows:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
template_content/.algokit # alternatively could be just `.algokit-generators`
|
|
95
|
+
└── generators
|
|
96
|
+
└── {generator_name} # generator name can be anything
|
|
97
|
+
├── copier.yaml # copier config for generator
|
|
98
|
+
└── smart_contracts # logic for adding new contracts to beaker template
|
|
99
|
+
└── {% raw %}{{ contract_name }}{% endraw %}
|
|
100
|
+
├── contract.py.j2
|
|
101
|
+
├── {% raw %}{% if language == 'python' %}deploy_config.py{% endif %}{% endraw %}.j2
|
|
102
|
+
└── {% raw %}{% if language == 'typescript' %}deploy-config.ts{% endif %}{% endraw %}.j2
|
|
103
|
+
...rest of the template is left as is
|
|
104
|
+
copier.yml
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The `index.ts` and `config.py` files on beaker template need to be updated to auto import all contracts from sub folders at `smart_contracts` to eliminate the need for developers to manually import them after running the smart contract generator.
|
|
108
|
+
|
|
109
|
+
> Please note, above is just an example that assumes the generator for adding new contracts, but the proposal is generic enough to support any kind of jinja-based templating logic.
|
|
110
|
+
|
|
111
|
+
**2. Adjusting `.algokit.toml`**
|
|
112
|
+
|
|
113
|
+
The proposal for new structure for defining generators in root algokit toml is as follows:
|
|
114
|
+
|
|
115
|
+
```toml
|
|
116
|
+
[generators.create_contract] # [generators.<generator_name>]
|
|
117
|
+
description = "Adds new smart contract to existing project" # description of the generator, can appear in cli for extra info
|
|
118
|
+
path = ".algokit/generators/create_contract" # path that cli should grab to forward to copier copy
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**3. Adjusting `algokit generate` command on cli**
|
|
122
|
+
|
|
123
|
+
Next step in implementation part of the proposal is adjusting the `generator` command on `algokit-cli` to make sure it knows how to look for generators. The available generators can be provided to user via list picker (a.k.a ruby on rails style) by letting algokit scan contents of `algokit.toml` and look for `.generators` folder.
|
|
124
|
+
|
|
125
|
+
a) Has no generators
|
|
126
|
+
If algokit-cli can't find any generator configured then nothing change from current implementation.
|
|
127
|
+
|
|
128
|
+
b) Has generators and user runs `algokit generate` command to see the list of available generators
|
|
129
|
+
A new `click` command per each generator in `.algokit.toml` is added to the list of generate commands, that will list all available generators for the user to choose from.
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
algokit-cli generate
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
Usage: algokit generate [OPTIONS] COMMAND [ARGS]...
|
|
137
|
+
|
|
138
|
+
Generate code for an Algorand project.
|
|
139
|
+
|
|
140
|
+
Options:
|
|
141
|
+
-h, --help Show this message and exit.
|
|
142
|
+
|
|
143
|
+
Commands:
|
|
144
|
+
client Create a typed ApplicationClient from an ARC-32 application.json
|
|
145
|
+
smart-contract Adds new smart contract to existing project
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Then, to invoke the interactive flow via copier user runs:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
algokit-cli generate smart-contract `name of the contract`
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
c) Has generators, user knows what to pick and wants to run it non interactively
|
|
155
|
+
Using the generator configuration the `generator` will automatically add new `click` commands to the existing list of generate commands allowing the user to run them in the command line.
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
algokit-cli generate smart-contract -a contract_name=`name of the contract` -a language=python # passing extra arguments to generator similar to algokit init
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
**4. Testing and documentation**
|
|
162
|
+
|
|
163
|
+
Lastly we need to make sure that the new feature is properly tested and documented. This includes:
|
|
164
|
+
|
|
165
|
+
- Testing the new feature works as expected on all official templates that will host generators. This will imply adding a separate test suite that picks some default template state and run generators on top of them confirming that created artifacts are placed in expected locations and have expected content. Tests should be easy to follow and expand on existing tests suite on templates without introducing extra complexity.
|
|
166
|
+
- Introduce new tutorial sections on [AlgoKit Docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/algokit-template.md) on how to create generators and refer to official templates as a reference point.
|
|
167
|
+
|
|
168
|
+
### Option 2: Wrapping generators into self contained copier templates hosted on separate repositories
|
|
169
|
+
|
|
170
|
+
This option proposes to host `generators` on separate set of repositories and use them as a dependency for algokit templates.
|
|
171
|
+
`algokit.toml` can be extended on template repositories to list generators they depend on.
|
|
172
|
+
|
|
173
|
+
The only distinction between this option and option 1 is that generators are hosted on separate repositories and are not hidden within algokit templates. Implying that they are not tightly coupled with algokit templates and can be reused/forked by community template builders to build their own generators.
|
|
174
|
+
|
|
175
|
+
#### Pros
|
|
176
|
+
|
|
177
|
+
- Generators are not tightly coupled with algokit templates and can be reused/forked by community template builders to build their own generators.
|
|
178
|
+
- Generators can be versioned and updated independently from algokit templates.
|
|
179
|
+
|
|
180
|
+
#### Cons
|
|
181
|
+
|
|
182
|
+
- Developing and maintaining generators is significantly more complex due to the need to maintain separate repositories and versioning.
|
|
183
|
+
- Official maintainers and community template builders need to be put extra effort at keeping generators generic enough to be reused by other templates. Given that templates can vastly differ in type, structure, conventions and patterns, this can be a challenge.
|
|
184
|
+
- Given that copier is being considered as a backbone for generators feature, drawbacks outlined for hosting templates on monorepos in the [previous adr](2023-06-06_frontend-templates.md#option-1-monolithic-template) apply here as well.
|
|
185
|
+
|
|
186
|
+
## Open questions for reviewers
|
|
187
|
+
|
|
188
|
+
1. What kinds of generators other than `add new contract` do we want to support on initial release (if any)?
|
|
189
|
+
2. Are there any other template repositories that we want to integrate with generators other than `beaker` (`fullstack` will contain those as well as it uses `beaker` as a dependency)?
|
|
190
|
+
|
|
191
|
+
> Please note an MVP PoC is already implemented and available to play around on algokit-cli and beaker template repo under `advanced-generate-command` and `generators` branches respectively.
|
|
192
|
+
> To test it out checkout the branche on cli do `pipx install . --force`, navigate to beaker template repo and checkout the branch as well, then navigate to any of the sub folders in `tests_generated`. Lastly do `algokit bootstrap all`, build the contract and execute `algokit generate` from root of that folder to play around with the feature based on the implementation proposal from Option 1.
|
|
193
|
+
|
|
194
|
+
## Final Decision
|
|
195
|
+
|
|
196
|
+
The team approved the proposal for Option 1: Wrapping generators into self contained copier templates hidden within algokit templates.
|
|
197
|
+
|
|
198
|
+
## Next steps
|
|
199
|
+
|
|
200
|
+
1. Polishing the PoC on algokit-cli and adding tests
|
|
201
|
+
2. Polishing the PoC on beaker template and adding tests
|
|
202
|
+
3. Adding documentation for new capabilities of the generate command
|
|
203
|
+
4. Adding documentation for template builders on how to create generators
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# AlgoKit CLI native binaries
|
|
2
|
+
|
|
3
|
+
- **Status**: Approved
|
|
4
|
+
- **Owner:** Altynbek Orumbayev (MakerX), Negar Abbasi (MakerX)
|
|
5
|
+
- **Deciders**: Alessandro (Algorand Foundation), MakerX
|
|
6
|
+
- **Date created**: 2024-01-13
|
|
7
|
+
- **Date decided:** 2024-01-25
|
|
8
|
+
- **Date updated**: 2024-01-16
|
|
9
|
+
|
|
10
|
+
## Context
|
|
11
|
+
|
|
12
|
+
The primary motivation for this decision is to streamline the installation process of AlgoKit CLI and reduce the friction associated with installing it on various operating systems. Currently, users often encounter minor environment-specific bugs during installation, which can be a significant deterrent. By providing native binaries, we aim to speed up the installation time and eliminate these bugs by **removing requirements to install python by the user**, thereby improving the overall user experience.
|
|
13
|
+
|
|
14
|
+
The north star for this decision is to provide a distribution model that can be described as:
|
|
15
|
+
|
|
16
|
+
```mermaid
|
|
17
|
+
graph TD
|
|
18
|
+
A[GitHub Runners] -->|Windows| B[Packaging tool]
|
|
19
|
+
A -->|Mac| C[Packaging tool]
|
|
20
|
+
A -->|Linux| D[Packaging tool]
|
|
21
|
+
B --> E[Windows Binary]
|
|
22
|
+
C --> F[Mac Binary]
|
|
23
|
+
D --> G[Linux Binary]
|
|
24
|
+
E -->|Winget| H[Windows Users]
|
|
25
|
+
F -->|Brew| I[Mac Users]
|
|
26
|
+
G -->|Snap| J[Linux Users]
|
|
27
|
+
A -->|Wheel Build| K[Poetry]
|
|
28
|
+
K --> L[PyPi]
|
|
29
|
+
L -->|pipx| M[Python Users]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
> ⚠️⚠️⚠️ Please note diagram above is a draft and is to be separately discussed in a follow up ADR that will focus on distribution of the binaries.
|
|
33
|
+
|
|
34
|
+
The scope of this ADR only concerns the packaging for the CLI. The distribution via `snap`, `winget` and etc will be handled separately/in-parallel after decision and implementation of this ADR is in place.
|
|
35
|
+
|
|
36
|
+
## Requirements
|
|
37
|
+
|
|
38
|
+
- The native binaries should be easy to maintain and understand from a CI/CD deployment perspective.
|
|
39
|
+
- The solution should support a wide variety of Linux distributions, macOS (both Apple Silicon and Intel architectures), and Windows.
|
|
40
|
+
- The solution should integrate seamlessly with existing installation options, including Homebrew, or provide an easier alternative.
|
|
41
|
+
- The solution should be designed with future scalability in mind, allowing for the addition of support for other variations of architectures or else as needed.
|
|
42
|
+
- The solution should not significantly increase the complexity of the build process.
|
|
43
|
+
- The solution should provide clear error messages and debugging information to assist in troubleshooting any issues that may arise.
|
|
44
|
+
- You don't need to install Python on your system to use AlgoKit if you aren't creating a Python project.
|
|
45
|
+
|
|
46
|
+
## Options
|
|
47
|
+
|
|
48
|
+
### Option 1 - PyInstaller
|
|
49
|
+
|
|
50
|
+
**Pros**
|
|
51
|
+
|
|
52
|
+
- Easy to use and configure
|
|
53
|
+
- Supports multiple platforms and architectures
|
|
54
|
+
- Can handle complex packages and dependencies
|
|
55
|
+
- Generates a single file executable
|
|
56
|
+
- Active development and community support
|
|
57
|
+
- Fairly fast build time via ci - ~3-4 minutes
|
|
58
|
+
- Fairly small executable size (see benchmarking results below)
|
|
59
|
+
- Marginally equal executable load time in `onedir` mode compared to `onefile` mode
|
|
60
|
+
|
|
61
|
+
**Cons**
|
|
62
|
+
|
|
63
|
+
- Occasionally requires manual configuration for more complex packages
|
|
64
|
+
- Requires complex build packaging matrix to support multiple platforms and architectures
|
|
65
|
+
- Requires minor tweaks in algokit cli to account for the fact that features relying on `sys.executable` will point to algokit cli executable instead of python interpreter. This is a minor change and can be done in a backwards compatible way however still a con to consider.
|
|
66
|
+
- Requires minor tweaks in algokit cli to introduce `multiprocessing.freeze_support()` to avoid issues with `vanity-address` task when executing via binary.
|
|
67
|
+
|
|
68
|
+
#### PoC
|
|
69
|
+
|
|
70
|
+
The PoC is available [here](https://github.com/algorandfoundation/algokit-cli/pull/382). It outlines a simple github action with extra setup that compiles algokit cli as a single file executable on latest versions of Windows, Mac and Linux github runners.
|
|
71
|
+
|
|
72
|
+
### Option 2 - Nuitka
|
|
73
|
+
|
|
74
|
+
**Pros**
|
|
75
|
+
|
|
76
|
+
- Nuitka translates Python code into C and then compiles it, which can result in performance improvements.
|
|
77
|
+
- Cross-Platform: Supports multiple platforms including Windows, macOS, and Linux.
|
|
78
|
+
- More cross compilations options than PyInstaller
|
|
79
|
+
- Official github action simplifies the process of building executables for different platforms.
|
|
80
|
+
|
|
81
|
+
**Cons**
|
|
82
|
+
|
|
83
|
+
- Compilation Time: The process of converting Python to C and then compiling can be time-consuming. Up to ~30 minutes on github with 3 parallel jobs.
|
|
84
|
+
- Size of Executable: The resulting executables can be larger due to the inclusion of the Python interpreter and the compiled C code (see benchmarking results below).
|
|
85
|
+
- Does not support Python 3.12.
|
|
86
|
+
- Requires minor tweaks in algokit cli to account for the fact that features relying on `sys.executable` will point to algokit cli executable instead of python interpreter. This is a minor change and can be done in a backwards compatible way however still a con to consider.
|
|
87
|
+
- Requires minor tweaks in algokit cli to introduce `multiprocessing.freeze_support()` to avoid issues with `vanity-address` task when executing via binary.
|
|
88
|
+
|
|
89
|
+
#### PoC
|
|
90
|
+
|
|
91
|
+
The PoC is available [here](https://github.com/algorandfoundation/algokit-cli/pull/393). It outlines a simple github action with extra setup that compiles algokit cli as a single file executable on latest versions of Windows, Mac and Linux github runners.
|
|
92
|
+
|
|
93
|
+
### Benchmarking `pyinstaller` vs `nuitka` vs pipx installed `algokit`
|
|
94
|
+
|
|
95
|
+
#### Methodology
|
|
96
|
+
|
|
97
|
+
`hyperfine` was used to benchmark 5 different executables:
|
|
98
|
+
|
|
99
|
+
- Nuitka Onefile - Nuitka compiled executable with `--onefile` flag, which produces a single file executable.
|
|
100
|
+
- Nuitka Onedir - Nuitka compiled executable with `--onedir` flag, which produces a directory with the executable and other dependencies unzipped.
|
|
101
|
+
- PyInstaller Onedir - PyInstaller compiled executable with `--standalone` flag, which produces a directory with the executable and other dependencies unzipped.
|
|
102
|
+
- PyInstaller Onefile - PyInstaller compiled executable with `--onefile` flag, which produces a single file executable.
|
|
103
|
+
- AlgoKit from `pipx` - AlgoKit CLI installed via `pipx` with all dependencies frozen (current latest stable release).
|
|
104
|
+
|
|
105
|
+
The benchmarking was performed on a MacBook M2 running macOS 14.2.1 and an ARM based Ubuntu 20.04.3 LTS running on a Parallels Desktop on the same machine.
|
|
106
|
+
|
|
107
|
+
#### Results
|
|
108
|
+
|
|
109
|
+
| Method | macOS M2 | Ubuntu 20 ARM Linux VM | Windows 11 ARM |
|
|
110
|
+
| ------------------- | -------- | ---------------------- | -------------- |
|
|
111
|
+
| nuitka_onefile | 3.634 | 1.465 | 3.874 |
|
|
112
|
+
| nuitka_onedir | 0.2515 | 0.6200 | 0.5136 |
|
|
113
|
+
| pyinstaller_onedir | 0.3228 | 0.7927 | 0.6668 |
|
|
114
|
+
| pyinstaller_onefile | 3.031 | 1.466 | 1.875 |
|
|
115
|
+
| algokit | 0.3126 | 0.6111 | 0.7579 |
|
|
116
|
+
|
|
117
|
+

|
|
118
|
+
_Figure: Benchmarking results comparing the performance of Nuitka (onefile, onedir modes), PyInstaller (onefile, onedir modes), and pipx installed Algokit CLI on macOS M2, Windows 11 ARM VM, Ubuntu 20 ARM VM._
|
|
119
|
+
|
|
120
|
+
| Method | Windows (MB) | Ubuntu (MB) | macOS (MB) |
|
|
121
|
+
| ------------------- | ------------ | ----------- | ---------- |
|
|
122
|
+
| nuitka_onedir | 92.10 | 106 | 166 |
|
|
123
|
+
| nuitka_onefile | 22.48 | 23 | 41 |
|
|
124
|
+
| pyinstaller_onedir | 46.07 | 52 | 113 |
|
|
125
|
+
| pyinstaller_onefile | 26.47 | 25 | 45 |
|
|
126
|
+
|
|
127
|
+

|
|
128
|
+
_Figure: Bundle sizes of folders with executables build with Nuitka (onefile, onedir modes), PyInstaller (onefile, onedir modes)._
|
|
129
|
+
|
|
130
|
+
#### Preliminary Observations
|
|
131
|
+
|
|
132
|
+
- Nuitka's warmed up execution time is **fast**
|
|
133
|
+
- Nuitka produces largest executables in `onedir` mode
|
|
134
|
+
- Nuitka is the slowest to build (no charts for build benchmarks, this is observations based on CI build time from PoC, see links above)
|
|
135
|
+
- PyInstaller produces smallest executables in `onedir` mode
|
|
136
|
+
- PyInstaller is the fastest to build (no charts for build benchmarks, this is observations based on CI build time from PoC, see links above)
|
|
137
|
+
|
|
138
|
+
### Honorable Mentions
|
|
139
|
+
|
|
140
|
+
#### cx_Freeze
|
|
141
|
+
|
|
142
|
+
cx_Freeze is a set of scripts and modules for freezing Python scripts into executables. It is similar to PyInstaller in many ways, but PyInstaller is preferred due to its more mature and comprehensive documentation.
|
|
143
|
+
|
|
144
|
+
#### PyOxidizer
|
|
145
|
+
|
|
146
|
+
PyOxidizer is a utility for producing binaries that embed Python. However, it is no longer actively maintained, which makes it a less desirable option for our needs.
|
|
147
|
+
|
|
148
|
+
## Preferred option
|
|
149
|
+
|
|
150
|
+
Based on observations so far we are leaning towards an Option 1. Where we would use PyInstaller to build native binaries for Windows, Mac and Linux.
|
|
151
|
+
|
|
152
|
+
While `nuitka` in `onedir` mode is even faster than pip installed algokit, it generates larger executables, and is the slowest option in terms of build time. Pyinstaller is only marginally slower than `nuitka` or pip installed algokit in terms of execution time, has mature documentation, and is the fastest option to build (in `onedir` mode) and produces smaller executables than `nuitka`. Given that and the fact that `nuitka` does not support Python 3.12 yet and has a lot of `magical` optimizations hidden under the hood, we are leaning towards PyInstaller as the preferred option for building native binaries given its maturity and straightforwardness despite marginally slower execution time (which is not a big deal given that we are talking of deviations of 5-10 milliseconds).
|
|
153
|
+
|
|
154
|
+
## Selected option
|
|
155
|
+
|
|
156
|
+
The team has formally pre-discussed this ADR and has agreed to proceed with Option 1 - PyInstaller.
|
|
157
|
+
|
|
158
|
+
## Next Steps
|
|
159
|
+
|
|
160
|
+
- [ ] Finalize the decision on the preferred option.
|
|
161
|
+
- [ ] Expand PoC and polish the github action to build native binaries for Windows, Mac and Linux for x86, x86-64 and ARM architectures.
|
|
162
|
+
- [ ] Implement portability snapshot tests, expanding existing algokit cli snapshot tests by running against real executable covering main functionality to test and ensure that the native binaries are portable and behave the same way as pip installed algokit cli.
|
|
163
|
+
- [ ] Submit follow up ADR to discuss strategies on how to distribute the binaries in most accessible, user friendly and secure way.
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
# AlgoKit Init Wizard Version 2 and Template Enhancements
|
|
2
|
+
|
|
3
|
+
- **Status:** Proposed (Revision 2)
|
|
4
|
+
- **Owner:** Altynbek Orumbayev
|
|
5
|
+
- **Deciders:** Alessandro (Algorand Foundation), Rob Moore (MakerX), MakerX team
|
|
6
|
+
- **Creation Date:** 2024-01-23
|
|
7
|
+
- **Decision Date:** 2024-02-13
|
|
8
|
+
- **Update Date:** 2024-02-12
|
|
9
|
+
|
|
10
|
+
## Revisions
|
|
11
|
+
|
|
12
|
+
- **Revision 1:** Initial discussions with Alessandro, Michael, Joe, Georgio, and Chris identified key issues with the existing wizards and explored ways to improve templating capabilities. These discussions led to the consideration of a unified 'monorepo' structure to consolidate template repositories into more focused, smaller generators under a single repository. The revision also sought to refine the wizard and enhance command orchestration capabilities, incorporating tools like `npm workspaces`.
|
|
13
|
+
- **Revision 2:** Engaged in multiple brainstorming sessions with Algorand Foundation/DevRel members and MakerX engineers to develop a pragmatic, time-bound, and prerequisite-neutral strategy. This approach resulted in splitting the ADR into two segments: one focusing on the `init` wizard enhancements and the other on template improvements and command orchestration upgrades in algokit-cli.
|
|
14
|
+
|
|
15
|
+
## Background
|
|
16
|
+
|
|
17
|
+
This ADR emerges from various discussions aimed at enhancing the `init` wizard version 2 user experience and aligning it with emerging smart contract languages/frameworks to make it more user-friendly and accessible to beginners. It builds upon prior decisions from the [Advanced algokit generate command](./2023-07-19_advanced_generate_command.md) and [Frontend Templates](./2023-06-06_frontend-templates.md) ADRs, integrating feedback from the Algorand Foundation and DevRel team.
|
|
18
|
+
|
|
19
|
+
### Main Areas for Improvement
|
|
20
|
+
|
|
21
|
+
1. **Enhancements to the `Init` Wizard:**
|
|
22
|
+
|
|
23
|
+
- Improve user experience by making the wizard more intuitive and less reliant on Algorand-specific jargon.
|
|
24
|
+
- Streamline the `presets` concept to minimize user inputs and simplify the process.
|
|
25
|
+
|
|
26
|
+
2. **Template Refinements:**
|
|
27
|
+
|
|
28
|
+
- Address potential complexities in maintaining the `fullstack` template with new `smart-contract` template combinations, including future `.NET` integration alongside `puya` compiler-compatible stacks.
|
|
29
|
+
- Implement `codespaces` configurations for simplified project setup in GitHub Codespaces.
|
|
30
|
+
- Consider unifying `add smart contract` generators in the `puya` and `beaker` templates into a single, generic generator managed by the CLI itself (suggestion added as part of revision 2 based on DevRel feedback). This helps solving the problem of simplifying template building experience (removing duplication of generators that are essentially generic) while still giving an option for template builders to have custom generators within templates.
|
|
31
|
+
|
|
32
|
+
3. **CLI Enhancements:**
|
|
33
|
+
|
|
34
|
+
- Enhance user experience by standardizing the use of `bootstrap`, `algokit.toml`, `.algokit` folder, and `.env` conventions, presenting a unified and intuitive CLI interface.
|
|
35
|
+
|
|
36
|
+
## Detailed Proposals
|
|
37
|
+
|
|
38
|
+
### 1. Improved `Init` Wizard Flow
|
|
39
|
+
|
|
40
|
+
Shift from a detailed, template-specific question format to a more streamlined, interactive process that focuses on the user's intent rather than specific technologies within the Algorand ecosystem.
|
|
41
|
+
|
|
42
|
+
**Current Init Wizard V1:**
|
|
43
|
+
|
|
44
|
+
```mermaid
|
|
45
|
+
graph TD
|
|
46
|
+
A[Start] --> Z[Pick an official template Puya, TealScript, React, Beaker]
|
|
47
|
+
Z --> B[Name for this project.]
|
|
48
|
+
B --> C[Package author name]
|
|
49
|
+
C --> D[Package author email]
|
|
50
|
+
D --> E[Do you want to add VSCode configuration?]
|
|
51
|
+
E -->|yes| F[Do you want to use ESLint and Prettier for code linting and formatting?]
|
|
52
|
+
E -->|no| G[Do you want to add JetBrains configuration - primarily optimized for WebStorm?]
|
|
53
|
+
F --> H[Do you want to use Tailwind CSS? A utility-first CSS framework for rapidly building custom designs.]
|
|
54
|
+
G --> H
|
|
55
|
+
H -->|yes| I[Do you want to use a daisyUI? Framework agnostic CSS component library for building modern websites and web applications fast.]
|
|
56
|
+
H -->|no| J[Do you want to include unit tests via Jest?]
|
|
57
|
+
I --> J
|
|
58
|
+
J --> K[Do you want to include end to end tests via Playwright?]
|
|
59
|
+
K --> L[Do you want to include Github Actions workflows for build validation?]
|
|
60
|
+
L -->|yes| M[Pick your website hosting provider for continuous delivery]
|
|
61
|
+
L -->|no| N[End]
|
|
62
|
+
M --> N
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Proposed Init Wizard V2:**
|
|
66
|
+
|
|
67
|
+
```mermaid
|
|
68
|
+
graph TB
|
|
69
|
+
A[Would you like to build a smart contract or a dapp frontend?]
|
|
70
|
+
B[If smart contract, which language would you like to use?]
|
|
71
|
+
C[If frontend, which framework would you like to use?]
|
|
72
|
+
D[Python, implies puya]
|
|
73
|
+
E[Typescript, implies TealScript]
|
|
74
|
+
F[React]
|
|
75
|
+
G[`production`/`starter`/`custom`]
|
|
76
|
+
I[`production`/`starter`/`custom`]
|
|
77
|
+
J[Would you like to include a frontend component?]
|
|
78
|
+
A --> B
|
|
79
|
+
A --> C
|
|
80
|
+
B --> D
|
|
81
|
+
D --> J
|
|
82
|
+
E --> J
|
|
83
|
+
J --> G
|
|
84
|
+
J --> F
|
|
85
|
+
B --> E
|
|
86
|
+
C --> F
|
|
87
|
+
F --> I
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
The proposal aims to simplify the question process and reduce the overall number of questions, focusing on identifying **what** the user intends to build without the additional complexity of selecting specific Algorand ecosystem tools or languages.
|
|
91
|
+
|
|
92
|
+
As illustrated in the proposed flow diagram, the initiative seeks to:
|
|
93
|
+
|
|
94
|
+
- Simplify the init wizard's questions, avoiding technical jargon and aligning with popular programming languages and frameworks, leveraging direct mappings like `python`, `typescript`, and `.net`.
|
|
95
|
+
- Introduce clear preset options: `starter` for a comprehensive preselection based on the Algorand Foundation's recommendations, `production` for setups aligned with production standards, and `custom` for developers seeking detailed customization through template questions.
|
|
96
|
+
|
|
97
|
+
This proposal presents no significant drawbacks, as it refines the question flow of the algokit init process without altering the command's fundamental behavior, thereby not impacting current users and enhancing the overall `init wizard` experience.
|
|
98
|
+
|
|
99
|
+
### 2. Fullstack Template and CLI Command Orchestration Enhancements
|
|
100
|
+
|
|
101
|
+
This dual-step approach suggests offloading business logic related to linking smart contracts and frontends within fullstack to a self-contained generator within the `react` template. It also introduces the concept of command orchestration in algokit-cli to manage project lifecycles more effectively.
|
|
102
|
+
|
|
103
|
+
#### 2.1 Autonomy of Frontend Template
|
|
104
|
+
|
|
105
|
+
**Fullstack Template Structure**:
|
|
106
|
+
|
|
107
|
+
| Before | After |
|
|
108
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
109
|
+
| The current fullstack is tightly coupled with the frontend template, handling the connection between frontend and backend. This coupling necessitates additional safety checks whenever there are changes in the expected structure of the React template. | The frontend now invokes the `import-contract` generator within the React template, which autonomously manages the linkage with a smart contract project. This adjustment makes the fullstack less reliant on template-specific changes that it should not be concerned with. |
|
|
110
|
+
|
|
111
|
+
The proposal includes changes to the fullstack template's structure, enabling the frontend to autonomously manage its linkage with smart contract projects, thereby simplifying integration and enhancing maintainability.
|
|
112
|
+
|
|
113
|
+
**Benefits:**
|
|
114
|
+
|
|
115
|
+
- Simplifies integration of templates by allowing the frontend template to manage smart contract linkages independently.
|
|
116
|
+
- Generalizes the fullstack template, offering flexibility in choosing backend components.
|
|
117
|
+
|
|
118
|
+
**Suggested Enhancements:**
|
|
119
|
+
|
|
120
|
+
- Further generalize the `AppCalls.tsx` component, removing assumptions on default `hello world` contracts and using `resolveBy: 'id'` by default.
|
|
121
|
+
- Incorporate suggestions from discussions during revision 2, including the potential bundling of `add smart contract` generators directly into `algokit-cli` for reduced redundancy and enhanced template support.
|
|
122
|
+
|
|
123
|
+
#### 2.2 CLI Command Orchestration
|
|
124
|
+
|
|
125
|
+
Aims to utilize `algokit.toml` for organizing project-specific commands, enhancing project management and command execution through a more structured approach.
|
|
126
|
+
|
|
127
|
+
Example workspace root `.algokit.toml`:
|
|
128
|
+
|
|
129
|
+
```toml
|
|
130
|
+
[algokit]
|
|
131
|
+
min_version = "v1.8.0"
|
|
132
|
+
|
|
133
|
+
[project]
|
|
134
|
+
type = 'workspace' # informs algokit-cli that this is a workspace root that hosts multiple projects
|
|
135
|
+
name = 'myworkspace' # included for reference but unique identifier for the workspace can be actually be excluded as it is not required for orchestration to work
|
|
136
|
+
projects = ['src'] # a list of relative/absolute paths directly to folders with independent components of the project that are part of the workspace or roots of folders hosting multiple independent components
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Example workspace of a smart contract project `.algokit.toml`:
|
|
140
|
+
|
|
141
|
+
```toml
|
|
142
|
+
[algokit]
|
|
143
|
+
min_version = "v1.8.0"
|
|
144
|
+
|
|
145
|
+
[generate.smart_contract]
|
|
146
|
+
description = "Adds new smart contract to existing project"
|
|
147
|
+
path = ".algokit/generators/create_contract"
|
|
148
|
+
|
|
149
|
+
[project]
|
|
150
|
+
type = 'backend'
|
|
151
|
+
name = '{ component_name }'
|
|
152
|
+
|
|
153
|
+
# The `deploy` command is categorized separately due to its static nature. Category names align with their root command group, hence `generate` is under [generate], while `deploy` is categorized under [project].
|
|
154
|
+
[project.deploy]
|
|
155
|
+
command = "poetry run python -m smart_contracts deploy"
|
|
156
|
+
environment_secrets = [
|
|
157
|
+
"DEPLOYER_MNEMONIC",
|
|
158
|
+
]
|
|
159
|
+
|
|
160
|
+
[project.deploy.localnet]
|
|
161
|
+
environment_secrets = []
|
|
162
|
+
|
|
163
|
+
# New category for project specific commands that can be defined arbitrarily by the user
|
|
164
|
+
[project.commands]
|
|
165
|
+
test = { command = "poetry run pytest", description = "Run unit tests for the smart contracts" }
|
|
166
|
+
build = { command = "poetry run python -m smart_contracts build", description = "Transpile puya smart contracts into TEAL and ABI specs" }
|
|
167
|
+
# Description is used as `help` text as content gets presented to user via `algokit cli` interface.
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
**Enhancements to `.algokit.toml` enable the cli to:**
|
|
171
|
+
|
|
172
|
+
- Navigate and interpret any project structure compliant with `.algokit.toml`.
|
|
173
|
+
- Simplify interactions with project-specific commands.
|
|
174
|
+
- Dynamically orchestrate command execution based on `.algokit.toml` configurations.
|
|
175
|
+
- For `algokit project {command_name}` executed at the workspace root, it aggregates and executes `{command_name}` from all child components either `sequentially` or `concurrently`, allowing users to choose the execution order per matching command identifier.
|
|
176
|
+
- When executed at a component's root, it runs the component-specific command from its `.algokit.toml`, also integrating it into the `algokit project` command group for visibility.
|
|
177
|
+
|
|
178
|
+
**Suggested Improvements:**
|
|
179
|
+
|
|
180
|
+
- Consider introducing command dependencies to ensure execution order for any command (in addition to current proposal to allow handling execution order for commands with matching 'names/identifiers'), enhancing the orchestration capabilities of the CLI.
|
|
181
|
+
|
|
182
|
+
## Reference: Alternatives Considered
|
|
183
|
+
|
|
184
|
+
### Consolidating AlgoKit Templates into a Monorepo
|
|
185
|
+
|
|
186
|
+
**Overview:** Explores the possibility of merging AlgoKit templates into a single repository, focusing on streamlined project management and orchestration within js-centric environments.
|
|
187
|
+
|
|
188
|
+
**Pros:**
|
|
189
|
+
|
|
190
|
+
- Simplifies monorepo project management and orchestration in npm-based projects.
|
|
191
|
+
|
|
192
|
+
**Cons:**
|
|
193
|
+
|
|
194
|
+
- Increases complexity and potential conflicts with existing CLI capabilities and Copier's recommendations, suggesting that a better alternative might be to consider a shift to where we have a more CLI-centric approach that handles orchestration without introducing extra dependant pre-requisites.
|
|
195
|
+
|
|
196
|
+
## Decision
|
|
197
|
+
|
|
198
|
+
A phased implementation of both proposals, starting with user-facing enhancements to the `init` wizard followed by template and CLI command orchestration improvements. This strategy allows for immediate impact and addresses urgent needs first, with potential for further simplification through subsequent enhancements.
|
|
199
|
+
|
|
200
|
+
## Next Steps
|
|
201
|
+
|
|
202
|
+
1. Break down the selected options into detailed work items.
|
|
203
|
+
2. Implement the proposed changes in the AlgoKit CLI and templates.
|
|
204
|
+
3. Update documentation and onboarding materials to reflect the new changes.
|
|
205
|
+
4. Announce the updates to the community and DevRel, soliciting feedback for future enhancements.
|
|
206
|
+
5. Tackle minor improvements that become feasible following the main proposal implementations.
|
|
207
|
+
|
|
208
|
+
### Open Questions
|
|
209
|
+
|
|
210
|
+
1. Should we implement a bidirectional query mechanism where selecting a smart contract prompts the option to add a frontend, and similarly, choosing a frontend first triggers a query about integrating a smart contract? This approach necessitates a minor modification in the wording of the initial query. In the current workflow, we don't prompt adding smart contracts part since this question is prominently positioned as the initial query in the wizard's sequence.
|
|
211
|
+
2. Alternative suggestions for 'type' categorization for `.algokit.toml` files? Or we are clear to proceed with `workspace` to highlight roots of full-stack/monorepo projects, `backend` to represent anything non webapp related and `frontend` to represent anything related?
|