@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.
Files changed (924) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +692 -0
  3. package/dist/algorand-client.d.ts +2 -0
  4. package/dist/algorand-client.js +2 -0
  5. package/dist/env.d.ts +1 -0
  6. package/dist/env.js +4 -0
  7. package/dist/index.d.ts +2 -0
  8. package/dist/index.js +158 -0
  9. package/dist/networkConfig.d.ts +5 -0
  10. package/dist/networkConfig.js +57 -0
  11. package/dist/resources/index.d.ts +16 -0
  12. package/dist/resources/index.js +37 -0
  13. package/dist/resources/knowledge/index.d.ts +72 -0
  14. package/dist/resources/knowledge/index.js +180 -0
  15. package/dist/resources/knowledge/taxonomy/algokit-cli:README.md +272 -0
  16. package/dist/resources/knowledge/taxonomy/algokit:README.md +70 -0
  17. package/dist/resources/knowledge/taxonomy/algokit:cli:algokit.md +52 -0
  18. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-14_sandbox-approach.md +94 -0
  19. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2022-11-22_beaker-testing-strategy.md +95 -0
  20. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_beaker_productionisation_review.md +412 -0
  21. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-11_brew_install.md +86 -0
  22. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-01-12_smart-contract-deployment.md +375 -0
  23. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-06-06_frontend-templates.md +164 -0
  24. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2023-07-19_advanced_generate_command.md +203 -0
  25. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-13_native_binaries.md +163 -0
  26. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-23_init-wizard-v2.md +211 -0
  27. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-01-31_binary_distribution.md +255 -0
  28. package/dist/resources/knowledge/taxonomy/algokit:cli:architecture-decisions:2024-03-06_local_dev_ui_packaging.md +143 -0
  29. package/dist/resources/knowledge/taxonomy/algokit:cli:articles:output_stability.md +8 -0
  30. package/dist/resources/knowledge/taxonomy/algokit:cli:cli:index.md +1517 -0
  31. package/dist/resources/knowledge/taxonomy/algokit:cli:features:compile.md +98 -0
  32. package/dist/resources/knowledge/taxonomy/algokit:cli:features:completions.md +56 -0
  33. package/dist/resources/knowledge/taxonomy/algokit:cli:features:config.md +37 -0
  34. package/dist/resources/knowledge/taxonomy/algokit:cli:features:dispenser.md +90 -0
  35. package/dist/resources/knowledge/taxonomy/algokit:cli:features:doctor.md +51 -0
  36. package/dist/resources/knowledge/taxonomy/algokit:cli:features:explore.md +21 -0
  37. package/dist/resources/knowledge/taxonomy/algokit:cli:features:generate.md +179 -0
  38. package/dist/resources/knowledge/taxonomy/algokit:cli:features:goal.md +139 -0
  39. package/dist/resources/knowledge/taxonomy/algokit:cli:features:init.md +122 -0
  40. package/dist/resources/knowledge/taxonomy/algokit:cli:features:localnet.md +191 -0
  41. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project.md +95 -0
  42. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:bootstrap.md +128 -0
  43. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:deploy.md +211 -0
  44. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:link.md +67 -0
  45. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:list.md +43 -0
  46. package/dist/resources/knowledge/taxonomy/algokit:cli:features:project:run.md +184 -0
  47. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks.md +16 -0
  48. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:analyze.md +33 -0
  49. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:ipfs.md +66 -0
  50. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:mint.md +70 -0
  51. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:nfd.md +45 -0
  52. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:opt.md +71 -0
  53. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:send.md +60 -0
  54. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:sign.md +94 -0
  55. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:transfer.md +54 -0
  56. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:vanity_address.md +56 -0
  57. package/dist/resources/knowledge/taxonomy/algokit:cli:features:tasks:wallet.md +93 -0
  58. package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:algokit-template.md +220 -0
  59. package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:intro.md +171 -0
  60. package/dist/resources/knowledge/taxonomy/algokit:cli:tutorials:smart-contracts.md +14 -0
  61. package/dist/resources/knowledge/taxonomy/algokit:docs:testnet_api.md +157 -0
  62. package/dist/resources/knowledge/taxonomy/algokit:lora:README.md +61 -0
  63. package/dist/resources/knowledge/taxonomy/algokit:utils:python:README.md +35 -0
  64. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:apidocs:algokit_utils:algokit_utils.md +1095 -0
  65. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:account.md +32 -0
  66. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-client.md +154 -0
  67. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:app-deploy.md +121 -0
  68. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:client.md +29 -0
  69. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:debugger.md +45 -0
  70. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:dispenser-client.md +60 -0
  71. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:capabilities:transfer.md +58 -0
  72. package/dist/resources/knowledge/taxonomy/algokit:utils:python:markdown:index.md +123 -0
  73. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:account.md +31 -0
  74. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-client.md +157 -0
  75. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:app-deploy.md +121 -0
  76. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:client.md +29 -0
  77. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:debugger.md +45 -0
  78. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:dispenser-client.md +60 -0
  79. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:capabilities:transfer.md +58 -0
  80. package/dist/resources/knowledge/taxonomy/algokit:utils:python:source:index.md +103 -0
  81. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:README.md +64 -0
  82. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:account.md +186 -0
  83. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:algorand-client.md +160 -0
  84. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:amount.md +51 -0
  85. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-client.md +422 -0
  86. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app-deploy.md +278 -0
  87. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:app.md +442 -0
  88. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:asset.md +331 -0
  89. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:client.md +115 -0
  90. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:debugging.md +54 -0
  91. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:dispenser-client.md +85 -0
  92. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:event-emitter.md +97 -0
  93. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:indexer.md +83 -0
  94. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:testing.md +207 -0
  95. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction-composer.md +89 -0
  96. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transaction.md +23 -0
  97. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:transfer.md +129 -0
  98. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:capabilities:typed-app-clients.md +201 -0
  99. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:README.md +53 -0
  100. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TestLogger.md +272 -0
  101. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:testing.TransactionLogger.md +149 -0
  102. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.MultisigAccount.md +178 -0
  103. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account.SigningAccount.md +153 -0
  104. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_account_manager.AccountManager.md +924 -0
  105. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md +200 -0
  106. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client.AlgorandClient.md +646 -0
  107. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md +1290 -0
  108. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md +1425 -0
  109. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_amount.AlgoAmount.md +247 -0
  110. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_arc56.Arc56Method.md +259 -0
  111. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.AppClient.md +1350 -0
  112. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_client.ApplicationClient.md +887 -0
  113. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_deployer.AppDeployer.md +186 -0
  114. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_factory.AppFactory.md +780 -0
  115. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_app_manager.AppManager.md +527 -0
  116. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_asset_manager.AssetManager.md +221 -0
  117. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_async_event_emitter.AsyncEventEmitter.md +244 -0
  118. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_client_manager.ClientManager.md +1072 -0
  119. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_composer.TransactionComposer.md +1281 -0
  120. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_config.UpdatableConfig.md +274 -0
  121. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_dispenser_client.TestNetDispenserApiClient.md +225 -0
  122. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_kmd_account_manager.KmdAccountManager.md +182 -0
  123. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:classes:types_logic_error.LogicError.md +261 -0
  124. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnSchemaBreak.md +51 -0
  125. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_app.OnUpdate.md +64 -0
  126. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.AccountStatus.md +51 -0
  127. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.ApplicationOnComplete.md +78 -0
  128. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_indexer.SignatureType.md +51 -0
  129. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:enums:types_lifecycle_events.EventType.md +32 -0
  130. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.AccountConfig.md +69 -0
  131. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account.TransactionSignerAccount.md +34 -0
  132. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_account_manager.EnsureFundedResult.md +38 -0
  133. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_algorand_client_interface.AlgorandClientInterface.md +102 -0
  134. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallParams.md +233 -0
  135. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCallTransactionResultOfType.md +108 -0
  136. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppCompilationResult.md +38 -0
  137. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeployMetadata.md +72 -0
  138. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppDeploymentParams.md +305 -0
  139. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppLookup.md +34 -0
  140. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppMetadata.md +174 -0
  141. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppReference.md +44 -0
  142. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppState.md +11 -0
  143. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.AppStorageSchema.md +77 -0
  144. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxName.md +51 -0
  145. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxReference.md +42 -0
  146. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValueRequestParams.md +54 -0
  147. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.BoxValuesRequestParams.md +54 -0
  148. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CompiledTeal.md +77 -0
  149. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CoreAppCallArgs.md +98 -0
  150. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.CreateAppParams.md +287 -0
  151. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.RawAppCallArgs.md +148 -0
  152. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.TealTemplateParams.md +13 -0
  153. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app.UpdateAppParams.md +274 -0
  154. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Arc56Contract.md +284 -0
  155. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Event.md +51 -0
  156. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.Method.md +145 -0
  157. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.ProgramSourceInfo.md +38 -0
  158. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageKey.md +64 -0
  159. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StorageMap.md +64 -0
  160. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_arc56.StructField.md +38 -0
  161. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallABIArgs.md +150 -0
  162. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCallCoreParams.md +51 -0
  163. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationParams.md +49 -0
  164. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientCompilationResult.md +80 -0
  165. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCallInterfaceParams.md +83 -0
  166. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployCoreParams.md +111 -0
  167. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientDeployParams.md +239 -0
  168. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppClientParams.md +120 -0
  169. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.AppSourceMaps.md +38 -0
  170. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.FundAppAccountParams.md +62 -0
  171. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppById.md +65 -0
  172. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.ResolveAppByIdBase.md +44 -0
  173. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_client.SourceMapExport.md +54 -0
  174. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppLookup.md +42 -0
  175. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_deployer.AppMetadata.md +164 -0
  176. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_factory.AppFactoryParams.md +145 -0
  177. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.AppInformation.md +156 -0
  178. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxReference.md +38 -0
  179. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValueRequestParams.md +51 -0
  180. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_manager.BoxValuesRequestParams.md +51 -0
  181. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSources.md +38 -0
  182. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.AppSpec.md +90 -0
  183. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.CallConfig.md +77 -0
  184. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.DeclaredSchemaValueSpec.md +64 -0
  185. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Hint.md +58 -0
  186. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.ReservedSchemaValueSpec.md +51 -0
  187. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Schema.md +38 -0
  188. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.SchemaSpec.md +38 -0
  189. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.StateSchemaSpec.md +38 -0
  190. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_app_spec.Struct.md +38 -0
  191. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetBulkOptInOutParams.md +105 -0
  192. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptInParams.md +224 -0
  193. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.AssetOptOutParams.md +268 -0
  194. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset.CreateAssetParams.md +369 -0
  195. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.AssetInformation.md +272 -0
  196. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_asset_manager.BulkAssetOptInOutResult.md +38 -0
  197. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.AlgoSdkClients.md +51 -0
  198. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppClient.md +84 -0
  199. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_client_manager.TypedAppFactory.md +39 -0
  200. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_composer.BuiltTransactions.md +51 -0
  201. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_config.Config.md +115 -0
  202. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.AVMTracesEventData.md +25 -0
  203. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourceDebugEventData.md +51 -0
  204. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_debugging.TealSourcesDebugEventData.md +25 -0
  205. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserFundResponse.md +38 -0
  206. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.DispenserLimitResponse.md +25 -0
  207. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_dispenser_client.TestNetDispenserApiClientParams.md +38 -0
  208. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_indexer.LookupAssetHoldingsOptions.md +51 -0
  209. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_logic_error.LogicErrorDetails.md +77 -0
  210. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoClientConfig.md +51 -0
  211. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.AlgoConfig.md +51 -0
  212. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_network_client.NetworkDetails.md +77 -0
  213. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgoKitLogCaptureFixture.md +72 -0
  214. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixture.md +79 -0
  215. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandFixtureConfig.md +149 -0
  216. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.AlgorandTestAutomationContext.md +165 -0
  217. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.GetTestAccountParams.md +65 -0
  218. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_testing.LogSnapshotConfig.md +53 -0
  219. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.AtomicTransactionComposerToSend.md +98 -0
  220. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResult.md +52 -0
  221. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.ConfirmedTransactionResults.md +88 -0
  222. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendAtomicTransactionComposerResults.md +92 -0
  223. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendParams.md +57 -0
  224. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionParams.md +135 -0
  225. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResult.md +48 -0
  226. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.SendTransactionResults.md +49 -0
  227. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionGroupToSend.md +54 -0
  228. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transaction.TransactionToSign.md +38 -0
  229. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoRekeyParams.md +222 -0
  230. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.AlgoTransferParams.md +235 -0
  231. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedParams.md +248 -0
  232. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.EnsureFundedReturnType.md +38 -0
  233. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:interfaces:types_transfer.TransferAssetParams.md +261 -0
  234. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.indexer.md +194 -0
  235. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:index.md +3215 -0
  236. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:testing.md +243 -0
  237. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account.md +100 -0
  238. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager.md +42 -0
  239. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_account_manager_spec.md +3 -0
  240. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algo_http_client_with_retry.md +9 -0
  241. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client.md +9 -0
  242. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_asset_spec.md +3 -0
  243. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_interface.md +9 -0
  244. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_spec.md +3 -0
  245. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_creator.md +9 -0
  246. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transaction_sender.md +9 -0
  247. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_algorand_client_transfer_spec.md +3 -0
  248. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount.md +9 -0
  249. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_amount_spec.md +3 -0
  250. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app.md +279 -0
  251. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_arc56.md +346 -0
  252. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client.md +347 -0
  253. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_client_spec.md +3 -0
  254. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_deployer.md +93 -0
  255. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory.md +124 -0
  256. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_factory_and_client_spec.md +3 -0
  257. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_manager.md +36 -0
  258. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_app_spec.md +160 -0
  259. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset.md +12 -0
  260. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_asset_manager.md +14 -0
  261. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter.md +44 -0
  262. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_async_event_emitter_spec.md +3 -0
  263. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager.md +122 -0
  264. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_client_manager_spec.md +3 -0
  265. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_composer.md +433 -0
  266. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_config.md +13 -0
  267. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_debugging.md +79 -0
  268. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client.md +15 -0
  269. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_dispenser_client_spec.md +3 -0
  270. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_expand.md +28 -0
  271. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_indexer.md +611 -0
  272. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_kmd_account_manager.md +9 -0
  273. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_lifecycle_events.md +34 -0
  274. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logging.md +93 -0
  275. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_logic_error.md +13 -0
  276. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_network_client.md +39 -0
  277. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_testing.md +14 -0
  278. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transaction.md +90 -0
  279. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:code:modules:types_transfer.md +13 -0
  280. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v7-migration.md +392 -0
  281. package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v8-migration.md +102 -0
  282. package/dist/resources/knowledge/taxonomy/arcs:ARC-template.md +48 -0
  283. package/dist/resources/knowledge/taxonomy/arcs:README.md +41 -0
  284. package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0012:README.md +30 -0
  285. package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0034:TemplateForm.md +58 -0
  286. package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0062:README.md +16 -0
  287. package/dist/resources/knowledge/taxonomy/arcs:pages:nfts.md +24 -0
  288. package/dist/resources/knowledge/taxonomy/arcs:pages:wallets.md +74 -0
  289. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0000.md +298 -0
  290. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0001.md +480 -0
  291. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0002.md +138 -0
  292. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0003.md +469 -0
  293. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0004.md +725 -0
  294. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0005.md +90 -0
  295. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0006.md +202 -0
  296. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0007.md +113 -0
  297. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0008.md +55 -0
  298. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0009.md +63 -0
  299. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0010.md +111 -0
  300. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0011.md +47 -0
  301. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0012.md +158 -0
  302. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0015.md +112 -0
  303. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0016.md +97 -0
  304. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0018.md +616 -0
  305. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0019.md +246 -0
  306. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0020.md +742 -0
  307. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0021.md +98 -0
  308. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0022.md +75 -0
  309. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0023.md +189 -0
  310. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0025.md +241 -0
  311. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0026.md +112 -0
  312. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0028.md +176 -0
  313. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0032.md +286 -0
  314. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0033.md +104 -0
  315. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0034.md +167 -0
  316. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0035.md +151 -0
  317. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0036.md +84 -0
  318. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0042.md +76 -0
  319. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0047.md +171 -0
  320. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0048.md +85 -0
  321. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0049.md +80 -0
  322. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0054.md +217 -0
  323. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0055.md +540 -0
  324. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0056.md +516 -0
  325. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0059.md +726 -0
  326. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0062.md +339 -0
  327. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0065.md +169 -0
  328. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0069.md +183 -0
  329. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0072.md +335 -0
  330. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0073.md +93 -0
  331. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0074.md +128 -0
  332. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0076.md +99 -0
  333. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0078.md +220 -0
  334. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0079.md +109 -0
  335. package/dist/resources/knowledge/taxonomy/arcs:specs:arc-0200.md +232 -0
  336. package/dist/resources/knowledge/taxonomy/clis_index.md +2347 -0
  337. package/dist/resources/knowledge/taxonomy/developer:docs:about.md +13 -0
  338. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:algokey.md +45 -0
  339. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:generate.md +42 -0
  340. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:import.md +42 -0
  341. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:append-auth-addr.md +44 -0
  342. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:multisig:multisig.md +47 -0
  343. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:info.md +40 -0
  344. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:part.md +42 -0
  345. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:part:reparent.md +42 -0
  346. package/dist/resources/knowledge/taxonomy/developer:docs:clis:algokey:sign.md +46 -0
  347. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:conduit.md +71 -0
  348. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:init.md +88 -0
  349. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:exporters.md +46 -0
  350. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:importers.md +46 -0
  351. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:list.md +63 -0
  352. package/dist/resources/knowledge/taxonomy/developer:docs:clis:conduit:list:processors.md +46 -0
  353. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:diagcfg.md +39 -0
  354. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:disable.md +58 -0
  355. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:enable.md +58 -0
  356. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:metric.md +51 -0
  357. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:metric:status.md +58 -0
  358. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:disable.md +58 -0
  359. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:enable.md +58 -0
  360. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:endpoint.md +60 -0
  361. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:name.md +60 -0
  362. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:status.md +58 -0
  363. package/dist/resources/knowledge/taxonomy/developer:docs:clis:diagcfg:telemetry:telemetry.md +53 -0
  364. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:restart.md +60 -0
  365. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:start.md +60 -0
  366. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:status.md +62 -0
  367. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:stop.md +52 -0
  368. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:node:wait.md +62 -0
  369. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:protocols.md +60 -0
  370. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:report.md +60 -0
  371. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:version.md +54 -0
  372. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:list.md +52 -0
  373. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:new.md +54 -0
  374. package/dist/resources/knowledge/taxonomy/developer:docs:clis:goal:wallet:wallet.md +56 -0
  375. package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:api-config.md +50 -0
  376. package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:daemon.md +110 -0
  377. package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:indexer.md +50 -0
  378. package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:util.md +39 -0
  379. package/dist/resources/knowledge/taxonomy/developer:docs:clis:indexer:util:validator.md +72 -0
  380. package/dist/resources/knowledge/taxonomy/developer:docs:clis:kmd.md +51 -0
  381. package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:debug.md +92 -0
  382. package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:remote.md +66 -0
  383. package/dist/resources/knowledge/taxonomy/developer:docs:clis:tealdbg:tealdbg.md +59 -0
  384. package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:create.md +741 -0
  385. package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:index.md +107 -0
  386. package/dist/resources/knowledge/taxonomy/developer:docs:details:accounts:rekey.md +462 -0
  387. package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:betanet.md +31 -0
  388. package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:index.md +23 -0
  389. package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:mainnet.md +19 -0
  390. package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand-networks:testnet.md +25 -0
  391. package/dist/resources/knowledge/taxonomy/developer:docs:details:algorand_consensus.md +46 -0
  392. package/dist/resources/knowledge/taxonomy/developer:docs:details:asa.md +1214 -0
  393. package/dist/resources/knowledge/taxonomy/developer:docs:details:atc.md +412 -0
  394. package/dist/resources/knowledge/taxonomy/developer:docs:details:atomic_transfers.md +396 -0
  395. package/dist/resources/knowledge/taxonomy/developer:docs:details:conduit.md +95 -0
  396. package/dist/resources/knowledge/taxonomy/developer:docs:details:crust.md +156 -0
  397. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:index.md +18 -0
  398. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:guidelines.md +3 -0
  399. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:index.md +332 -0
  400. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:jsonspec.md +134 -0
  401. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:index.md +16 -0
  402. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v1.md +401 -0
  403. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v10.md +1748 -0
  404. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v2.md +671 -0
  405. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v3.md +789 -0
  406. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v4.md +1029 -0
  407. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v5.md +1263 -0
  408. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v6.md +1359 -0
  409. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v7.md +1481 -0
  410. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v8.md +1640 -0
  411. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:opcodes:v9.md +1640 -0
  412. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:avm:teal:specification.md +945 -0
  413. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:ABI:index.md +172 -0
  414. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:create.md +398 -0
  415. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:index.md +246 -0
  416. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:innertx.md +514 -0
  417. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:state.md +704 -0
  418. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:apps:txs.md +231 -0
  419. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:debugging.md +897 -0
  420. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:apps.md +1680 -0
  421. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:frontend:smartsigs.md +492 -0
  422. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:guidelines.md +405 -0
  423. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:index.md +41 -0
  424. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:index.md +15 -0
  425. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:modes.md +34 -0
  426. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:smart-contracts:smartsigs:walkthrough.md +159 -0
  427. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:beaker.md +341 -0
  428. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:pyteal.md +786 -0
  429. package/dist/resources/knowledge/taxonomy/developer:docs:details:dapps:writing-contracts:python.md +3 -0
  430. package/dist/resources/knowledge/taxonomy/developer:docs:details:encoding.md +457 -0
  431. package/dist/resources/knowledge/taxonomy/developer:docs:details:ethereum_to_algorand.md +239 -0
  432. package/dist/resources/knowledge/taxonomy/developer:docs:details:index.md +29 -0
  433. package/dist/resources/knowledge/taxonomy/developer:docs:details:indexer.md +472 -0
  434. package/dist/resources/knowledge/taxonomy/developer:docs:details:parameter_tables.md +84 -0
  435. package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:index.md +61 -0
  436. package/dist/resources/knowledge/taxonomy/developer:docs:details:stateproofs:light_client.md +390 -0
  437. package/dist/resources/knowledge/taxonomy/developer:docs:details:technical_faq.md +233 -0
  438. package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:index.md +746 -0
  439. package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:offline_transactions.md +319 -0
  440. package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:payment_prompts.md +96 -0
  441. package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:signatures.md +484 -0
  442. package/dist/resources/knowledge/taxonomy/developer:docs:details:transactions:transactions.md +168 -0
  443. package/dist/resources/knowledge/taxonomy/developer:docs:details:useful_resources.md +29 -0
  444. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:algokit.md +263 -0
  445. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:what_is_blockchain.md +69 -0
  446. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:whats_a_dapp.md +29 -0
  447. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:where_to_start.md +43 -0
  448. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:basics:why_algorand.md +119 -0
  449. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:ft.md +24 -0
  450. package/dist/resources/knowledge/taxonomy/developer:docs:get-started:tokenization:nft.md +41 -0
  451. package/dist/resources/knowledge/taxonomy/developer:docs:index.md +100 -0
  452. package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:algod.md +3163 -0
  453. package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:indexer.md +2142 -0
  454. package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:kmd.md +1347 -0
  455. package/dist/resources/knowledge/taxonomy/developer:docs:rest-apis:restendpoints.md +76 -0
  456. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:catchup.md +33 -0
  457. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:operations:switch_networks.md +89 -0
  458. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:generate_keys.md +76 -0
  459. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:index.md +56 -0
  460. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:offline.md +83 -0
  461. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:online.md +170 -0
  462. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:participate:renew.md +29 -0
  463. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:artifacts.md +89 -0
  464. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:config.md +190 -0
  465. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:relay.md +51 -0
  466. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:reference:telemetry-config.md +31 -0
  467. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:indexer.md +71 -0
  468. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:install.md +618 -0
  469. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:node-troubleshooting.md +190 -0
  470. package/dist/resources/knowledge/taxonomy/developer:docs:run-a-node:setup:types.md +77 -0
  471. package/dist/resources/knowledge/taxonomy/developer:docs:sdks:go:index.md +189 -0
  472. package/dist/resources/knowledge/taxonomy/developer:docs:sdks:index.md +38 -0
  473. package/dist/resources/knowledge/taxonomy/developer:docs:sdks:java:index.md +164 -0
  474. package/dist/resources/knowledge/taxonomy/developer:docs:sdks:javascript:index.md +168 -0
  475. package/dist/resources/knowledge/taxonomy/developer:docs:sdks:python:index.md +162 -0
  476. package/dist/resources/knowledge/taxonomy/developer:python:code:example:accounts.md +215 -0
  477. package/dist/resources/knowledge/taxonomy/developer:python:code:example:arc4_types.md +267 -0
  478. package/dist/resources/knowledge/taxonomy/developer:python:code:example:assets.md +235 -0
  479. package/dist/resources/knowledge/taxonomy/developer:python:code:example:box_storage.md +211 -0
  480. package/dist/resources/knowledge/taxonomy/developer:python:code:example:control_flow.md +162 -0
  481. package/dist/resources/knowledge/taxonomy/developer:python:code:example:crypto:merkle_tree.md +0 -0
  482. package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:amm.md +0 -0
  483. package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:auction.md +0 -0
  484. package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:htlc_logicsig.md +0 -0
  485. package/dist/resources/knowledge/taxonomy/developer:python:code:example:defi:marketplace.md +0 -0
  486. package/dist/resources/knowledge/taxonomy/developer:python:code:example:events:arc28_events.md +0 -0
  487. package/dist/resources/knowledge/taxonomy/developer:python:code:example:global_storage.md +192 -0
  488. package/dist/resources/knowledge/taxonomy/developer:python:code:example:governance:simple_voting.md +0 -0
  489. package/dist/resources/knowledge/taxonomy/developer:python:code:example:hello_world.md +133 -0
  490. package/dist/resources/knowledge/taxonomy/developer:python:code:example:inner_transactions.md +247 -0
  491. package/dist/resources/knowledge/taxonomy/developer:python:code:example:local_storage.md +227 -0
  492. package/dist/resources/knowledge/taxonomy/developer:python:code:example:nft:proof_of_attendance.md +0 -0
  493. package/dist/resources/knowledge/taxonomy/developer:python:code:example:privacy:zk_whitelist.md +0 -0
  494. package/dist/resources/knowledge/taxonomy/developer:python:code:example:scratch_storage.md +169 -0
  495. package/dist/resources/knowledge/taxonomy/developer:python:code:example:self_payment.md +167 -0
  496. package/dist/resources/knowledge/taxonomy/developer:python:code:example:struct_in_box.md +182 -0
  497. package/dist/resources/knowledge/taxonomy/developer:python:code:example:subsidize_app_call.md +189 -0
  498. package/dist/resources/knowledge/taxonomy/developer:python:code:example:transactions.md +0 -0
  499. package/dist/resources/knowledge/taxonomy/developer:python:code:example:utility:calculator.md +0 -0
  500. package/dist/resources/knowledge/taxonomy/devportal-code-examples:README.md +31 -0
  501. package/dist/resources/knowledge/taxonomy/devportal-code-examples:projects:python-contract-examples:README.md +155 -0
  502. package/dist/resources/knowledge/taxonomy/docs:.walletconnect:index.md +133 -0
  503. package/dist/resources/knowledge/taxonomy/docs:.walletconnect:walletconnect-schema.md +167 -0
  504. package/dist/resources/knowledge/taxonomy/docs:README.md +12 -0
  505. package/dist/resources/knowledge/taxonomy/docs:scripts:README.md +90 -0
  506. package/dist/resources/knowledge/taxonomy/docs:scripts:example_tracker:example_list.md +132 -0
  507. package/dist/resources/knowledge/taxonomy/index.md +2044 -0
  508. package/dist/resources/knowledge/taxonomy/liquid-auth:ARCHITECTURE.md +241 -0
  509. package/dist/resources/knowledge/taxonomy/liquid-auth:README.md +105 -0
  510. package/dist/resources/knowledge/taxonomy/liquid-auth:SEQUENCE.md +41 -0
  511. package/dist/resources/knowledge/taxonomy/liquid-auth:VISION.md +13 -0
  512. package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:1-Service-Authentication.md +18 -0
  513. package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:2-Bidirectional-Communication.md +42 -0
  514. package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:3-Peer-to-Peer-Signaling.md +60 -0
  515. package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:4-Fido-Extension.md +51 -0
  516. package/dist/resources/knowledge/taxonomy/liquid-auth:decisions:README.md +6 -0
  517. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:README.md +54 -0
  518. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:architecture.md +101 -0
  519. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:authenticate.md +13 -0
  520. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:android:provider-service:register.md +18 -0
  521. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:authentication.md +107 -0
  522. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:clients:browser:example.md +64 -0
  523. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:introduction.md +18 -0
  524. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:environment-variables.md +75 -0
  525. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:integrations.md +168 -0
  526. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:introduction.md +22 -0
  527. package/dist/resources/knowledge/taxonomy/liquid-auth:docs:server:running-locally.md +88 -0
  528. package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.request.md +3 -0
  529. package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:assertion:assertion.controller.post.response.md +3 -0
  530. package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:attestation:attestation.controller.post.request.md +1 -0
  531. package/dist/resources/knowledge/taxonomy/liquid-auth:services:liquid-auth-api-js:src:auth:auth.controller.get.user.md +0 -0
  532. package/dist/resources/knowledge/taxonomy/liquid-auth:sites:express-dapp:README.md +73 -0
  533. package/dist/resources/knowledge/taxonomy/liquid_auth_index.md +2221 -0
  534. package/dist/resources/knowledge/taxonomy/puya:README.md +72 -0
  535. package/dist/resources/knowledge/taxonomy/puya:docs:algopy_testing:index.md +15 -0
  536. package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.arc4.md +6 -0
  537. package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.gtxn.md +6 -0
  538. package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.itxn.md +6 -0
  539. package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.md +6 -0
  540. package/dist/resources/knowledge/taxonomy/puya:docs:api-algopy.op.md +6 -0
  541. package/dist/resources/knowledge/taxonomy/puya:docs:api.md +6 -0
  542. package/dist/resources/knowledge/taxonomy/puya:docs:compiler.md +239 -0
  543. package/dist/resources/knowledge/taxonomy/puya:docs:index.md +63 -0
  544. package/dist/resources/knowledge/taxonomy/puya:docs:language-guide.md +86 -0
  545. package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc28.md +53 -0
  546. package/dist/resources/knowledge/taxonomy/puya:docs:lg-arc4.md +225 -0
  547. package/dist/resources/knowledge/taxonomy/puya:docs:lg-builtins.md +26 -0
  548. package/dist/resources/knowledge/taxonomy/puya:docs:lg-calling-apps.md +142 -0
  549. package/dist/resources/knowledge/taxonomy/puya:docs:lg-compile.md +70 -0
  550. package/dist/resources/knowledge/taxonomy/puya:docs:lg-control.md +87 -0
  551. package/dist/resources/knowledge/taxonomy/puya:docs:lg-errors.md +36 -0
  552. package/dist/resources/knowledge/taxonomy/puya:docs:lg-logs.md +46 -0
  553. package/dist/resources/knowledge/taxonomy/puya:docs:lg-modules.md +90 -0
  554. package/dist/resources/knowledge/taxonomy/puya:docs:lg-opcode-budget.md +3 -0
  555. package/dist/resources/knowledge/taxonomy/puya:docs:lg-ops.md +40 -0
  556. package/dist/resources/knowledge/taxonomy/puya:docs:lg-storage.md +222 -0
  557. package/dist/resources/knowledge/taxonomy/puya:docs:lg-structure.md +283 -0
  558. package/dist/resources/knowledge/taxonomy/puya:docs:lg-transactions.md +248 -0
  559. package/dist/resources/knowledge/taxonomy/puya:docs:lg-types.md +319 -0
  560. package/dist/resources/knowledge/taxonomy/puya:docs:lg-unsupported-python-features.md +52 -0
  561. package/dist/resources/knowledge/taxonomy/puya:docs:principles.md +196 -0
  562. package/dist/resources/knowledge/taxonomy/puya:examples:auction:README.md +3 -0
  563. package/dist/resources/knowledge/taxonomy/puya:python:testing:README.md +66 -0
  564. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:algopy.md +9 -0
  565. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:api.md +41 -0
  566. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:coverage.md +159 -0
  567. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:examples.md +13 -0
  568. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:faq.md +61 -0
  569. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:index.md +182 -0
  570. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:arc4-types.md +96 -0
  571. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:avm-types.md +223 -0
  572. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:concepts.md +58 -0
  573. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:contract-testing.md +225 -0
  574. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:index.md +67 -0
  575. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:opcodes.md +382 -0
  576. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:signature-testing.md +73 -0
  577. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:state-management.md +104 -0
  578. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:subroutines.md +62 -0
  579. package/dist/resources/knowledge/taxonomy/puya:python:testing:docs:testing-guide:transactions.md +200 -0
  580. package/dist/resources/knowledge/taxonomy/puya:python:testing:examples:README.md +56 -0
  581. package/dist/resources/knowledge/taxonomy/puya:src:puya:ARCHITECTURE.md +26 -0
  582. package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_typeshed:README.md +10 -0
  583. package/dist/resources/knowledge/taxonomy/puya:src:puyapy:_vendor:mypy:typeshed:stdlib:_typeshed:README.md +34 -0
  584. package/dist/resources/knowledge/taxonomy/puya:src:puyapy:awst_build:README.md +13 -0
  585. package/dist/resources/knowledge/taxonomy/puya:stubs:README.md +89 -0
  586. package/dist/resources/knowledge/taxonomy/puya:tests:test_expected_output:README.md +17 -0
  587. package/dist/resources/knowledge/taxonomy/puya:typescript:README.md +11 -0
  588. package/dist/resources/knowledge/taxonomy/puya:typescript:docs:README.md +35 -0
  589. package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-bytes-and-strings.md +196 -0
  590. package/dist/resources/knowledge/taxonomy/puya:typescript:docs:architecture-decisions:2024-05-21_primitive-integer-types.md +179 -0
  591. package/dist/resources/knowledge/taxonomy/puya:typescript:packages:algo-ts:readme.md +3 -0
  592. package/dist/resources/knowledge/taxonomy/puya_index.md +2143 -0
  593. package/dist/resources/knowledge/taxonomy/sdks:javascript:FAQ.md +21 -0
  594. package/dist/resources/knowledge/taxonomy/sdks:javascript:README.md +139 -0
  595. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIAddressType.md +185 -0
  596. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayDynamicType.md +230 -0
  597. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIArrayStaticType.md +236 -0
  598. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIBoolType.md +185 -0
  599. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIByteType.md +185 -0
  600. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIContract.md +124 -0
  601. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIInterface.md +100 -0
  602. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIMethod.md +185 -0
  603. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIStringType.md +185 -0
  604. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABITupleType.md +230 -0
  605. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIType.md +169 -0
  606. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUfixedType.md +221 -0
  607. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:ABIUintType.md +209 -0
  608. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Algodv2.md +1321 -0
  609. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:AtomicTransactionComposer.md +385 -0
  610. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:DryrunResult.md +61 -0
  611. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Indexer.md +727 -0
  612. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Kmd.md +642 -0
  613. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSig.md +315 -0
  614. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:LogicSigAccount.md +276 -0
  615. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:SourceMap.md +151 -0
  616. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:Transaction.md +1133 -0
  617. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Account.md +557 -0
  618. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountParticipation.md +195 -0
  619. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountResponse.md +138 -0
  620. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountStateDelta.md +136 -0
  621. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AccountsResponse.md +149 -0
  622. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Application.md +180 -0
  623. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalState.md +195 -0
  624. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLocalStatesResponse.md +149 -0
  625. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogData.md +138 -0
  626. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationLogsResponse.md +163 -0
  627. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationParams.md +209 -0
  628. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationResponse.md +136 -0
  629. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationStateSchema.md +138 -0
  630. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ApplicationsResponse.md +149 -0
  631. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Asset.md +183 -0
  632. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetBalancesResponse.md +149 -0
  633. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHolding.md +196 -0
  634. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetHoldingsResponse.md +149 -0
  635. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetParams.md +334 -0
  636. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetResponse.md +136 -0
  637. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.AssetsResponse.md +149 -0
  638. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Block.md +390 -0
  639. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockRewards.md +199 -0
  640. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeState.md +181 -0
  641. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BlockUpgradeVote.md +152 -0
  642. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Box.md +152 -0
  643. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxDescriptor.md +124 -0
  644. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.BoxesResponse.md +151 -0
  645. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ErrorResponse.md +134 -0
  646. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDelta.md +152 -0
  647. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.EvalDeltaKeyValue.md +136 -0
  648. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HashFactory.md +122 -0
  649. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.HealthCheck.md +196 -0
  650. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.IndexerStateProofMessage.md +178 -0
  651. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MerkleArrayProof.md +148 -0
  652. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.MiniAssetHolding.md +188 -0
  653. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.ParticipationUpdates.md +139 -0
  654. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofFields.md +211 -0
  655. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofParticipant.md +136 -0
  656. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofReveal.md +151 -0
  657. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSigSlot.md +134 -0
  658. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofSignature.md +158 -0
  659. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofTracking.md +166 -0
  660. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateProofVerifier.md +136 -0
  661. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.StateSchema.md +141 -0
  662. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealKeyValue.md +136 -0
  663. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TealValue.md +152 -0
  664. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.Transaction.md +629 -0
  665. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionApplication.md +291 -0
  666. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetConfig.md +145 -0
  667. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetFreeze.md +154 -0
  668. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionAssetTransfer.md +201 -0
  669. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionKeyreg.md +211 -0
  670. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionPayment.md +170 -0
  671. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionResponse.md +140 -0
  672. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignature.md +157 -0
  673. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureLogicsig.md +171 -0
  674. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisig.md +154 -0
  675. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionSignatureMultisigSubsignature.md +136 -0
  676. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionStateProof.md +157 -0
  677. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:indexerModels.TransactionsResponse.md +149 -0
  678. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Account.md +516 -0
  679. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountApplicationResponse.md +158 -0
  680. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetHolding.md +141 -0
  681. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetResponse.md +156 -0
  682. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountAssetsInformationResponse.md +151 -0
  683. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountParticipation.md +196 -0
  684. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AccountStateDelta.md +136 -0
  685. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AppCallLogs.md +153 -0
  686. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Application.md +138 -0
  687. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationInitialStates.md +167 -0
  688. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationKVStorage.md +138 -0
  689. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalReference.md +138 -0
  690. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationLocalState.md +152 -0
  691. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationParams.md +209 -0
  692. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateOperation.md +182 -0
  693. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ApplicationStateSchema.md +138 -0
  694. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Asset.md +141 -0
  695. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHolding.md +154 -0
  696. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetHoldingReference.md +138 -0
  697. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AssetParams.md +334 -0
  698. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmKeyValue.md +136 -0
  699. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.AvmValue.md +152 -0
  700. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockHashResponse.md +124 -0
  701. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockLogsResponse.md +128 -0
  702. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockResponse.md +139 -0
  703. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BlockTxidsResponse.md +124 -0
  704. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Box.md +152 -0
  705. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxDescriptor.md +124 -0
  706. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxReference.md +138 -0
  707. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BoxesResponse.md +122 -0
  708. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.BuildVersion.md +180 -0
  709. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.CompileResponse.md +152 -0
  710. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DisassembleResponse.md +124 -0
  711. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunRequest.md +204 -0
  712. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunResponse.md +148 -0
  713. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunSource.md +163 -0
  714. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunState.md +176 -0
  715. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.DryrunTxnResult.md +253 -0
  716. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ErrorResponse.md +134 -0
  717. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDelta.md +152 -0
  718. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.EvalDeltaKeyValue.md +136 -0
  719. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetBlockTimeStampOffsetResponse.md +124 -0
  720. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.GetSyncRoundResponse.md +124 -0
  721. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.KvDelta.md +139 -0
  722. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LedgerStateDeltaForTransactionGroup.md +136 -0
  723. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.LightBlockHeaderProof.md +153 -0
  724. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.NodeStatusResponse.md +480 -0
  725. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionResponse.md +312 -0
  726. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PendingTransactionsResponse.md +140 -0
  727. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.PostTransactionsResponse.md +124 -0
  728. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.ScratchChange.md +138 -0
  729. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateInitialStates.md +125 -0
  730. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequest.md +227 -0
  731. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateRequestTransactionGroup.md +124 -0
  732. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateResponse.md +197 -0
  733. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTraceConfig.md +169 -0
  734. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionGroupResult.md +206 -0
  735. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateTransactionResult.md +206 -0
  736. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulateUnnamedResourcesAccessed.md +221 -0
  737. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationEvalOverrides.md +198 -0
  738. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationOpcodeTraceUnit.md +194 -0
  739. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SimulationTransactionExecTrace.md +241 -0
  740. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProof.md +138 -0
  741. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.StateProofMessage.md +182 -0
  742. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.SupplyResponse.md +152 -0
  743. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealKeyValue.md +136 -0
  744. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TealValue.md +152 -0
  745. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionGroupLedgerStateDeltasForRoundResponse.md +123 -0
  746. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionParametersResponse.md +200 -0
  747. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.TransactionProofResponse.md +183 -0
  748. package/dist/resources/knowledge/taxonomy/sdks:javascript:classes:modelsv2.Version.md +158 -0
  749. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABIReferenceType.md +47 -0
  750. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:ABITransactionType.md +99 -0
  751. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:AtomicTransactionComposerStatus.md +73 -0
  752. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:IntDecoding.md +65 -0
  753. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:OnApplicationComplete.md +96 -0
  754. package/dist/resources/knowledge/taxonomy/sdks:javascript:enums:TransactionType.md +103 -0
  755. package/dist/resources/knowledge/taxonomy/sdks:javascript:examples:README.md +9 -0
  756. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworkInfo.md +19 -0
  757. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractNetworks.md +7 -0
  758. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIContractParams.md +63 -0
  759. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIInterfaceParams.md +41 -0
  760. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodArgParams.md +41 -0
  761. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodParams.md +78 -0
  762. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIMethodReturnParams.md +30 -0
  763. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:ABIResult.md +90 -0
  764. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Account.md +38 -0
  765. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:Address.md +32 -0
  766. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:AlgodTokenHeader.md +19 -0
  767. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClient.md +98 -0
  768. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientError.md +22 -0
  769. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BaseHTTPClientResponse.md +41 -0
  770. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:BoxReference.md +36 -0
  771. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:CustomTokenHeader.md +7 -0
  772. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedAssetParams.md +153 -0
  773. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedBoxReference.md +34 -0
  774. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedGlobalStateSchema.md +34 -0
  775. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLocalStateSchema.md +34 -0
  776. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSig.md +52 -0
  777. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedLogicSigAccount.md +30 -0
  778. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedMultisig.md +50 -0
  779. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSignedTransaction.md +75 -0
  780. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedSubsig.md +34 -0
  781. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:EncodedTransaction.md +606 -0
  782. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:IndexerTokenHeader.md +19 -0
  783. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:KMDTokenHeader.md +19 -0
  784. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:MultisigMetadata.md +52 -0
  785. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SignedTransaction.md +75 -0
  786. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:SuggestedParams.md +89 -0
  787. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionParams.md +718 -0
  788. package/dist/resources/knowledge/taxonomy/sdks:javascript:interfaces:TransactionWithSigner.md +36 -0
  789. package/dist/resources/knowledge/taxonomy/sdks:javascript:modules.md +2993 -0
  790. package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:indexerModels.md +69 -0
  791. package/dist/resources/knowledge/taxonomy/sdks:javascript:modules:modelsv2.md +79 -0
  792. package/dist/resources/knowledge/taxonomy/sdks:python:README.md +120 -0
  793. package/dist/resources/knowledge/taxonomy/sdks:python:algosdk:v2client:harness:README.md +18 -0
  794. package/dist/resources/knowledge/taxonomy/sdks:python:examples:README.md +11 -0
  795. package/dist/resources/knowledge/taxonomy/tealscript:FEATURES.md +252 -0
  796. package/dist/resources/knowledge/taxonomy/tealscript:README.md +54 -0
  797. package/dist/resources/knowledge/taxonomy/tealscript:examples_amm_README.md +3 -0
  798. package/dist/resources/knowledge/taxonomy/tealscript:examples_auction_README.md +3 -0
  799. package/dist/resources/knowledge/taxonomy/tealscript:examples_big_box_README.md +20 -0
  800. package/dist/resources/knowledge/taxonomy/tealscript:examples_itxns_README.md +1 -0
  801. package/dist/resources/knowledge/taxonomy/tealscript:examples_lsig_with_app_README.md +3 -0
  802. package/dist/resources/knowledge/taxonomy/tealscript:examples_reti_README.md +1 -0
  803. package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_arrays.md +104 -0
  804. package/dist/resources/knowledge/taxonomy/tealscript:guides_Supported Types_numbers.md +49 -0
  805. package/dist/resources/knowledge/taxonomy/tealscript:guides_atomic_txn.md +22 -0
  806. package/dist/resources/knowledge/taxonomy/tealscript:guides_features.md +256 -0
  807. package/dist/resources/knowledge/taxonomy/tealscript:guides_getting_started.md +88 -0
  808. package/dist/resources/knowledge/taxonomy/tealscript:guides_inner_transactions.md +43 -0
  809. package/dist/resources/knowledge/taxonomy/tealscript:guides_lifecycle.md +88 -0
  810. package/dist/resources/knowledge/taxonomy/tealscript:guides_math.md +54 -0
  811. package/dist/resources/knowledge/taxonomy/tealscript:guides_methods.md +85 -0
  812. package/dist/resources/knowledge/taxonomy/tealscript:guides_multiple_contracts.md +92 -0
  813. package/dist/resources/knowledge/taxonomy/tealscript:guides_pyteal.md +35 -0
  814. package/dist/resources/knowledge/taxonomy/tealscript:guides_storage.md +110 -0
  815. package/dist/resources/knowledge/taxonomy/tealscript:tests_test_package_README.md +1 -0
  816. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0001-intro.md +9 -0
  817. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0002-init.md +50 -0
  818. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0003-contract.md +98 -0
  819. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0004-artifacts.md +59 -0
  820. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0005-hello.md +35 -0
  821. package/dist/resources/knowledge/taxonomy/tealscript:tutorials_Hello World_0006-test.md +30 -0
  822. package/dist/resources/knowledge/taxonomy-categories/algokit-utils.json +148 -0
  823. package/dist/resources/knowledge/taxonomy-categories/algokit.json +105 -0
  824. package/dist/resources/knowledge/taxonomy-categories/arcs.json +92 -0
  825. package/dist/resources/knowledge/taxonomy-categories/clis.json +280 -0
  826. package/dist/resources/knowledge/taxonomy-categories/details.json +173 -0
  827. package/dist/resources/knowledge/taxonomy-categories/developers.json +71 -0
  828. package/dist/resources/knowledge/taxonomy-categories/liquid-auth.json +127 -0
  829. package/dist/resources/knowledge/taxonomy-categories/nodes.json +50 -0
  830. package/dist/resources/knowledge/taxonomy-categories/puya.json +76 -0
  831. package/dist/resources/knowledge/taxonomy-categories/python.json +104 -0
  832. package/dist/resources/knowledge/taxonomy-categories/sdks.json +152 -0
  833. package/dist/resources/knowledge/taxonomy-categories/tealscript.json +80 -0
  834. package/dist/tools/accountManager.d.ts +150 -0
  835. package/dist/tools/accountManager.js +339 -0
  836. package/dist/tools/algodManager.d.ts +134 -0
  837. package/dist/tools/algodManager.js +257 -0
  838. package/dist/tools/apiManager/algod/account.d.ts +10 -0
  839. package/dist/tools/apiManager/algod/account.js +135 -0
  840. package/dist/tools/apiManager/algod/application.d.ts +10 -0
  841. package/dist/tools/apiManager/algod/application.js +165 -0
  842. package/dist/tools/apiManager/algod/asset.d.ts +8 -0
  843. package/dist/tools/apiManager/algod/asset.js +47 -0
  844. package/dist/tools/apiManager/algod/index.d.ts +6 -0
  845. package/dist/tools/apiManager/algod/index.js +32 -0
  846. package/dist/tools/apiManager/algod/transaction.d.ts +14 -0
  847. package/dist/tools/apiManager/algod/transaction.js +216 -0
  848. package/dist/tools/apiManager/example/get-balance.d.ts +11 -0
  849. package/dist/tools/apiManager/example/get-balance.js +32 -0
  850. package/dist/tools/apiManager/example/index.d.ts +6 -0
  851. package/dist/tools/apiManager/example/index.js +18 -0
  852. package/dist/tools/apiManager/index.d.ts +45 -0
  853. package/dist/tools/apiManager/index.js +53 -0
  854. package/dist/tools/apiManager/indexer/account.d.ts +24 -0
  855. package/dist/tools/apiManager/indexer/account.js +248 -0
  856. package/dist/tools/apiManager/indexer/application.d.ts +24 -0
  857. package/dist/tools/apiManager/indexer/application.js +290 -0
  858. package/dist/tools/apiManager/indexer/asset.d.ts +36 -0
  859. package/dist/tools/apiManager/indexer/asset.js +292 -0
  860. package/dist/tools/apiManager/indexer/index.d.ts +6 -0
  861. package/dist/tools/apiManager/indexer/index.js +39 -0
  862. package/dist/tools/apiManager/indexer/transaction.d.ts +34 -0
  863. package/dist/tools/apiManager/indexer/transaction.js +276 -0
  864. package/dist/tools/apiManager/nfd/index.d.ts +6 -0
  865. package/dist/tools/apiManager/nfd/index.js +476 -0
  866. package/dist/tools/apiManager/tinyman/analytics.d.ts +3 -0
  867. package/dist/tools/apiManager/tinyman/analytics.js +80 -0
  868. package/dist/tools/apiManager/tinyman/bootstrap.d.ts +3 -0
  869. package/dist/tools/apiManager/tinyman/bootstrap.js +85 -0
  870. package/dist/tools/apiManager/tinyman/index.d.ts +3 -0
  871. package/dist/tools/apiManager/tinyman/index.js +60 -0
  872. package/dist/tools/apiManager/tinyman/liquidity.d.ts +3 -0
  873. package/dist/tools/apiManager/tinyman/liquidity.js +143 -0
  874. package/dist/tools/apiManager/tinyman/opt_in.d.ts +3 -0
  875. package/dist/tools/apiManager/tinyman/opt_in.js +112 -0
  876. package/dist/tools/apiManager/tinyman/pool.d.ts +3 -0
  877. package/dist/tools/apiManager/tinyman/pool.js +90 -0
  878. package/dist/tools/apiManager/tinyman/remove_liquidity.d.ts +3 -0
  879. package/dist/tools/apiManager/tinyman/remove_liquidity.js +148 -0
  880. package/dist/tools/apiManager/tinyman/swap.d.ts +3 -0
  881. package/dist/tools/apiManager/tinyman/swap.js +147 -0
  882. package/dist/tools/arc26Manager.d.ts +37 -0
  883. package/dist/tools/arc26Manager.js +131 -0
  884. package/dist/tools/commonParams.d.ts +18 -0
  885. package/dist/tools/commonParams.js +28 -0
  886. package/dist/tools/index.d.ts +8 -0
  887. package/dist/tools/index.js +8 -0
  888. package/dist/tools/knowledgeManager.d.ts +28 -0
  889. package/dist/tools/knowledgeManager.js +73 -0
  890. package/dist/tools/transactionManager/accountTransactions.d.ts +127 -0
  891. package/dist/tools/transactionManager/accountTransactions.js +177 -0
  892. package/dist/tools/transactionManager/appTransactions/callTxn.d.ts +17 -0
  893. package/dist/tools/transactionManager/appTransactions/callTxn.js +95 -0
  894. package/dist/tools/transactionManager/appTransactions/clearTxn.d.ts +17 -0
  895. package/dist/tools/transactionManager/appTransactions/clearTxn.js +95 -0
  896. package/dist/tools/transactionManager/appTransactions/closeOutTxn.d.ts +17 -0
  897. package/dist/tools/transactionManager/appTransactions/closeOutTxn.js +95 -0
  898. package/dist/tools/transactionManager/appTransactions/createTxn.d.ts +17 -0
  899. package/dist/tools/transactionManager/appTransactions/createTxn.js +128 -0
  900. package/dist/tools/transactionManager/appTransactions/deleteTxn.d.ts +17 -0
  901. package/dist/tools/transactionManager/appTransactions/deleteTxn.js +95 -0
  902. package/dist/tools/transactionManager/appTransactions/index.d.ts +23 -0
  903. package/dist/tools/transactionManager/appTransactions/index.js +56 -0
  904. package/dist/tools/transactionManager/appTransactions/optInTxn.d.ts +17 -0
  905. package/dist/tools/transactionManager/appTransactions/optInTxn.js +95 -0
  906. package/dist/tools/transactionManager/appTransactions/types.d.ts +525 -0
  907. package/dist/tools/transactionManager/appTransactions/types.js +298 -0
  908. package/dist/tools/transactionManager/appTransactions/updateTxn.d.ts +17 -0
  909. package/dist/tools/transactionManager/appTransactions/updateTxn.js +101 -0
  910. package/dist/tools/transactionManager/assetTransactions.d.ts +300 -0
  911. package/dist/tools/transactionManager/assetTransactions.js +351 -0
  912. package/dist/tools/transactionManager/generalTransaction.d.ts +96 -0
  913. package/dist/tools/transactionManager/generalTransaction.js +504 -0
  914. package/dist/tools/transactionManager/index.d.ts +18 -0
  915. package/dist/tools/transactionManager/index.js +42 -0
  916. package/dist/tools/utilityManager.d.ts +127 -0
  917. package/dist/tools/utilityManager.js +422 -0
  918. package/dist/tools/walletManager.d.ts +46 -0
  919. package/dist/tools/walletManager.js +781 -0
  920. package/dist/types.d.ts +123 -0
  921. package/dist/types.js +42 -0
  922. package/dist/utils/responseProcessor.d.ts +31 -0
  923. package/dist/utils/responseProcessor.js +152 -0
  924. package/package.json +58 -0
@@ -0,0 +1,339 @@
1
+ ---
2
+ arc: 62
3
+ title: ASA Circulating Supply
4
+ description: Getter method for ASA circulating supply
5
+ author: Cosimo Bassi (@cusma)
6
+ discussions-to: https://github.com/algorandfoundation/ARCs/issues/302
7
+ status: Final
8
+ type: Standards Track
9
+ category: Interface
10
+ sub-category: Asa
11
+ created: 2024-06-12
12
+ requires: 2, 4, 22
13
+ ---
14
+
15
+ ## Abstract
16
+
17
+ This ARC introduces a standard for the definition of circulating supply for Algorand
18
+ Standard Assets (ASA) and its client-side retrieval. A reference implementation is
19
+ suggested.
20
+
21
+ ## Motivation
22
+
23
+ Algorand Standard Asset (ASA) `total` supply is _defined_ upon ASA creation.
24
+
25
+ Creating an ASA on the ledger _does not_ imply its `total` supply is immediately
26
+ “minted” or “circulating”. In fact, the semantic of token “minting” on Algorand is
27
+ slightly different from other blockchains: it is not coincident with the token units
28
+ creation on the ledger.
29
+
30
+ The Reserve Address, one of the 4 addresses of ASA Role-Based-Access-Control (RBAC),
31
+ is conventionally used to identify the portion of `total` supply not yet in circulation.
32
+ The Reserve Address has no “privilege” over the token: it is just a “logical” label
33
+ used (client-side) to classify an existing amount of ASA as “not in circulation”.
34
+
35
+ According to this convention, “minting” an amount of ASA units is equivalent to
36
+ _moving that amount out of the Reserve Address_.
37
+
38
+ > ASA may have the Reserve Address assigned to a Smart Contract to enforce specific
39
+ > “minting” policies, if needed.
40
+
41
+ This convention led to a simple and unsophisticated semantic of ASA circulating
42
+ supply, widely adopted by clients (wallets, explorers, etc.) to provide standard
43
+ information:
44
+
45
+ ```text
46
+ circulating_supply = total - reserve_balance
47
+ ```
48
+
49
+ Where `reserve_balance` is the ASA balance hold by the Reserve Address.
50
+
51
+ However, the simplicity of such convention, who fostered adoption across the Algorand
52
+ ecosystem, poses some limitations. Complex and sophisticated use-cases of ASA, such
53
+ as regulated stable-coins and tokenized securities among others, require more
54
+ detailed and expressive definitions of circulating supply.
55
+
56
+ As an example, an ASA could have “burned”, “locked” or “pre-minted” amounts of token,
57
+ not held in the Reserve Address, which _should not_ be considered as “circulating”
58
+ supply. This is not possible with the basic ASA protocol convention.
59
+
60
+ This ARC proposes a standard ABI _read-only_ method (getter) to provide the circulating
61
+ supply of an ASA.
62
+
63
+ ## Specification
64
+
65
+ The keywords "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**",
66
+ "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**MAY**", and "**OPTIONAL**"
67
+ in this document are to be interpreted as described in <a href="https://datatracker.ietf.org/doc/html/rfc2119">RFC 2119</a>.
68
+
69
+ > Notes like this are non-normative.
70
+
71
+ ### ABI Method
72
+
73
+ A compliant ASA, whose circulating supply definition conforms to this ARC, **MUST**
74
+ implement the following method on an Application (referred as _Circulating Supply
75
+ App_ in this specification):
76
+
77
+ ```json
78
+ {
79
+ "name": "arc62_get_circulating_supply",
80
+ "readonly": true,
81
+ "args": [
82
+ {
83
+ "type": "uint64",
84
+ "name": "asset_id",
85
+ "desc": "ASA ID of the circulating supply"
86
+ }
87
+ ],
88
+ "returns": {
89
+ "type": "uint64",
90
+ "desc": "ASA circulating supply"
91
+ },
92
+ "desc": "Get ASA circulating supply"
93
+ }
94
+ ```
95
+
96
+ The `arc62_get_circulating_supply` **MUST** be a _read-only_ ([ARC-22](./arc-0022.md))
97
+ method (getter).
98
+
99
+ ### Usage
100
+
101
+ Getter calls **SHOULD** be _simulated_.
102
+
103
+ Any external resources used by the implementation **SHOULD** be discovered and
104
+ auto-populated by the simulated getter call.
105
+
106
+ #### Example 1
107
+
108
+ > Let the ASA have `total` supply and a Reserve Address (i.e. not set to `ZeroAddress`).
109
+ >
110
+ > Let the Reserve Address be assigned to an account different from the Circulating
111
+ > Supply App Account.
112
+ >
113
+ > Let `burned` be an external Burned Address dedicated to ASA burned supply.
114
+ >
115
+ > Let `locked` be an external Locked Address dedicated to ASA locked supply.
116
+ >
117
+ > The ASA issuer defines the _circulating supply_ as:
118
+ >
119
+ > ```text
120
+ > circulating_supply = total - reserve_balance - burned_balance - locked_balance
121
+ > ```
122
+ >
123
+ > In this case the simulated read-only method call would auto-populate 1 external
124
+ > reference for the ASA and 3 external reference accounts (Reserve, Burned and Locked).
125
+
126
+ #### Example 2
127
+
128
+ > Let the ASA have `total` supply and _no_ Reserve Address (i.e. set to `ZeroAddress`).
129
+ >
130
+ > Let `non_circulating_amount` be a UInt64 Global Var defined by the implementation
131
+ > of the Circulating Supply App.
132
+ >
133
+ > The ASA issuer defines the _circulating supply_ as:
134
+ >
135
+ > ```text
136
+ > circulating_supply = total - non_circulating_amount
137
+ > ```
138
+ >
139
+ > In this case the simulated read-only method call would auto-populate just 1 external
140
+ > reference for the ASA.
141
+
142
+ ### Circulating Supply Application discovery
143
+
144
+ > Given an ASA ID, clients (wallet, explorer, etc.) need to discover the related
145
+ > Circulating Supply App.
146
+
147
+ An ASA conforming to this ARC **MUST** specify the Circulating Supply App ID.
148
+
149
+ > To avoid ecosystem fragmentation this ARC does not propose any new method to specify
150
+ > the metadata of an ASA. Instead, it only extends already existing standards.
151
+
152
+ If the ASA also conforms to any ARC that supports additional `properties` ([ARC-3](./arc-0003.md),
153
+ [ARC-19](./arc-0019.md), [ARC-69](./arc-0069.md)),
154
+ then it **MUST** include a `arc-62` key and set the corresponding value to a map,
155
+ including the ID of the Circulating Supply App as a value for the key `application-id`.
156
+
157
+ #### Example
158
+
159
+ ```json
160
+ {
161
+ //...
162
+ "properties": {
163
+ //...
164
+ "arc-62": {
165
+ "application-id": 123
166
+ }
167
+ }
168
+ //...
169
+ }
170
+ ```
171
+
172
+ ## Rationale
173
+
174
+ The definition of _circulating supply_ for sophisticated use-cases is usually ASA-specific.
175
+ It could involve, for example, complex math or external accounts’ balances, variables
176
+ stored in boxes or in global state, etc..
177
+
178
+ For this reason, the proposed method’s signature does not require any reference
179
+ to external resources, a part form the `asset_id` of the ASA for which the circulating
180
+ supply is defined.
181
+
182
+ Eventual external resources can be discovered and auto-populated directly by the
183
+ simulated method call.
184
+
185
+ The rational of this design choice is avoiding fragmentation and integration overhead
186
+ for clients (wallets, explorers, etc.).
187
+
188
+ Clients just need to know:
189
+
190
+ 1. The ASA ID;
191
+ 1. The Circulating Supply App ID implementing the `arc62_get_circulating_supply`
192
+ method for that ASA.
193
+
194
+ ## Backwards Compatibility
195
+
196
+ Existing ASA willing to conform to this ARC **MUST** specify the Circulating Supply
197
+ App ID as [ARC-2](./arc-0002.md) `AssetConfig` transaction note field, as follows:
198
+
199
+ - The `<arc-number>` **MUST** be equal to `62`;
200
+ - The **RECOMMENDED** `<data-format>` are <a href="https://msgpack.org/">MsgPack</a>
201
+ (`m`) or <a href="https://www.json.org/json-en.html">JSON</a> (`j`);
202
+ - The `<data>` **MUST** specify `application-id` equal to the Circulating Supply
203
+ App ID.
204
+
205
+ > **WARNING**: To preserve the existing ASA RBAC (e.g. Manager Address, Freeze Address,
206
+ > etc.) it is necessary to **include all the existing role addresses** in the `AssetConfig`.
207
+ > Not doing so would irreversibly disable the RBAC roles!
208
+
209
+ ### Example - JSON without version
210
+
211
+ ```text
212
+ arc62:j{"application-id":123}
213
+ ```
214
+
215
+ ## Reference Implementation
216
+
217
+ > This section is non-normative.
218
+
219
+ This section suggests a reference implementation of the Circulating Supply App.
220
+
221
+ An Algorand-Python example is available [here](../assets/arc-0062).
222
+
223
+ ### Recommendations
224
+
225
+ An ASA using the reference implementation **SHOULD NOT** assign the Reserve Address
226
+ to the Circulating Supply App Account.
227
+
228
+ A reference implementation **SHOULD** target a version of the AVM that supports
229
+ foreign resources pooling (version 9 or greater).
230
+
231
+ A reference implementation **SHOULD** use 3 external addresses, in addition to the
232
+ Reserve Address, to define the not circulating supply.
233
+
234
+ The **RECOMMENDED** labels for not-circulating balances are: `burned`, `locked`
235
+ and `generic`.
236
+
237
+ > To change the labels of not circulating addresses is sufficient to rename the
238
+ > following constants just in `smart_contracts/circulating_supply/config.py`:
239
+ > ```python
240
+ > NOT_CIRCULATING_LABEL_1: Final[str] = "burned"
241
+ > NOT_CIRCULATING_LABEL_2: Final[str] = "locked"
242
+ > NOT_CIRCULATING_LABEL_3: Final[str] = "generic"
243
+ > ```
244
+
245
+ ### State Schema
246
+
247
+ A reference implementation **SHOULD** allocate, at least, the following Global State
248
+ variables:
249
+
250
+ - `asset_id` as UInt64, initialized to `0` and set **only once** by the ASA Manager
251
+ Address;
252
+ - Not circulating address 1 (`burned`) as Bytes, initialized to the Global `Zero Address`
253
+ and set by the ASA Manager Address;
254
+ - Not circulating address 2 (`locked`) as Bytes, initialized to the Global `Zero Address`
255
+ and set by the ASA Manager Address;
256
+ - Not circulating address 3 (`generic`) as Bytes, initialized to the Global `Zero Address`
257
+ and set by the ASA Manager Address.
258
+
259
+ A reference implementation **SHOULD** enforce that, upon setting `burned`, `locked`
260
+ and `generic` addresses, the latter already opted-in the `asset_id`.
261
+
262
+ ```json
263
+ "state": {
264
+ "global": {
265
+ "num_byte_slices": 3,
266
+ "num_uints": 1
267
+ },
268
+ "local": {
269
+ "num_byte_slices": 0,
270
+ "num_uints": 0
271
+ }
272
+ },
273
+ "schema": {
274
+ "global": {
275
+ "declared": {
276
+ "asset_id": {
277
+ "type": "uint64",
278
+ "key": "asset_id"
279
+ },
280
+ "not_circulating_label_1": {
281
+ "type": "bytes",
282
+ "key": "burned"
283
+ },
284
+ "not_circulating_label_2": {
285
+ "type": "bytes",
286
+ "key": "locked"
287
+ },
288
+ "not_circulating_label_3": {
289
+ "type": "bytes",
290
+ "key": "generic"
291
+ }
292
+ },
293
+ "reserved": {}
294
+ },
295
+ "local": {
296
+ "declared": {},
297
+ "reserved": {}
298
+ }
299
+ },
300
+ ```
301
+
302
+ ### Circulating Supply Getter
303
+
304
+ A reference implementation **SHOULD** enforce that the `asset_id` Global Variable
305
+ is equal to the `asset_id` argument of the `arc62_get_circulating_supply` getter
306
+ method.
307
+
308
+ > Alternatively the reference implementation could ignore the `asset_id` argument
309
+ > and use directly the `asset_id` Global Variable.
310
+
311
+ A reference implementation **SHOULD** return the ASA _circulating supply_ as:
312
+
313
+ ```text
314
+ circulating_supply = total - reserve_balance - burned_balance - locked_balance - generic_balance
315
+ ```
316
+
317
+ Where:
318
+
319
+ - `total` is the total supply of the ASA (`asset_id`);
320
+ - `reserve_balance` is the ASA balance hold by the Reserve Address or `0` if the
321
+ address is set to the Global `ZeroAddress` or not opted-in `asset_id`;
322
+ - `burned_balance` is the ASA balance hold by the Burned Address or `0` if the address
323
+ is set to the Global `ZeroAddress` or is not opted-in `asset_id`;
324
+ - `locked_balance` is the ASA balance hold by the Locked Address or `0` if the address
325
+ is set to the Global `ZeroAddress` or not opted-in `asset_id`;
326
+ - `generic_balance` is the ASA balance hold by a Generic Address or `0` if the address
327
+ is set to the Global `ZeroAddress` or not opted-in `asset_id`.
328
+
329
+ ## Security Considerations
330
+
331
+ Permissions over the Circulating Supply App setting and update **SHOULD** be granted
332
+ to the ASA Manager Address.
333
+
334
+ > The ASA trust-model (i.e. who sets the Reserve Address) is extended to the generalized
335
+ > ASA circulating supply definition.
336
+
337
+ ## Copyright
338
+
339
+ Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CCO</a>.
@@ -0,0 +1,169 @@
1
+ ---
2
+ arc: 65
3
+ title: AVM Run Time Errors In Program
4
+ description: Informative AVM run time errors based on program bytecode
5
+ author: Cosimo Bassi (@cusma), Tasos Bitsios (@tasosbit), Steve Ferrigno (@nullun)
6
+ discussions-to: https://github.com/algorandfoundation/ARCs/issues/315
7
+ status: Final
8
+ type: Standards Track
9
+ category: ARC
10
+ created: 2024-10-09
11
+ ---
12
+
13
+ ## Abstract
14
+
15
+ This document introduces a convention for rising informative run time errors on
16
+ the Algorand Virtual Machine (AVM) directly from the program bytecode.
17
+
18
+ ## Motivation
19
+
20
+ The AVM does not offer native opcodes to catch and raise run time errors.
21
+
22
+ The lack of native error handling semantics could lead to fragmentation of tooling
23
+ and frictions for AVM clients, who are unable to retrieve informative and useful
24
+ hints about the occurred run time failures.
25
+
26
+ This ARC formalizes a convention to rise AVM run time errors based just on the program
27
+ bytecode.
28
+
29
+ ## Specification
30
+
31
+ The keywords "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**",
32
+ "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**MAY**", and "**OPTIONAL**"
33
+ in this document are to be interpreted as described in <a href="https://datatracker.ietf.org/doc/html/rfc2119">RFC 2119</a>.
34
+
35
+ > Notes like this are non-normative.
36
+
37
+ ### Error format
38
+
39
+ > The AVM programs bytecode have limited sized. In this convention, the errors are
40
+ > part of the bytecode, therefore it is good to mind errors' formatting and sizing.
41
+
42
+ > Errors consist of a _code_ and an optional _short message_.
43
+
44
+ Errors **MUST** be prefixed either with:
45
+
46
+ - `ERR:` for custom errors;
47
+ - `AER:` reserved for future ARC standard errors.
48
+
49
+ Errors **MUST** use `:` as domain separator.
50
+
51
+ It is **RECOMMENDED** to use `UTF-8` for the error bytes string encoding.
52
+
53
+ It is **RECOMMENDED** to use _short_ error messages.
54
+
55
+ It is **RECOMMENDED** to use <a href="https://en.wikipedia.org/wiki/Camel_case/">camel case</a>
56
+ for alphanumeric error codes.
57
+
58
+ It is **RECOMMENDED** to avoid error byte strings of _exactly_ 8 or 32 bytes.
59
+
60
+ ### In Program Errors
61
+
62
+ When a program wants to emit informative run time errors, directly from the bytecode,
63
+ it **MUST**:
64
+
65
+ 1. Push to the stack the bytes string containing the error;
66
+ 1. Execute the `log` opcode to use the bytes from the top of the stack;
67
+ 1. Execute the `err` opcode to immediately terminate the program.
68
+
69
+ Upon a program run time failure, the Algod API response contains both the failed
70
+ _program counter_ (`pc`) and the `logs` array with the _errors_.
71
+
72
+ The program **MAY** return multiple errors in the same failed execution.
73
+
74
+ The errors **MUST** be retrieved by:
75
+
76
+ 1. Decoding the `base64` elements of the `logs` array;
77
+ 1. Validating the decoded elements against the error regexp.
78
+
79
+ ### Error examples
80
+
81
+ > Error conforming this specification are always prefixed with `ERR:`.
82
+
83
+ Error with a _numeric code_: `ERR:042`.
84
+
85
+ Error with an _alphanumeric code_: `ERR:BadRequest`.
86
+
87
+ Error with a _numeric code_ and _short message_: `ERR:042:AFunnyError`.
88
+
89
+ ### Program example
90
+
91
+ The following program example raises the error `ERR:001:Invalid Method` for any
92
+ application call to methods different from `m1()void`.
93
+
94
+ ```teal
95
+ #pragma version 10
96
+
97
+ txn ApplicationID
98
+ bz end
99
+
100
+ method "m1()void"
101
+ txn ApplicationArgs 0
102
+ match method1
103
+ byte "ERR:001:Invalid Method"
104
+ log
105
+ err
106
+
107
+ method1:
108
+ b end
109
+
110
+ end:
111
+ int 1
112
+ ```
113
+
114
+ Full Algod API response of a failed execution:
115
+
116
+ ```json
117
+ {
118
+ "data": {
119
+ "app-index":1004,
120
+ "eval-states": [
121
+ {
122
+ "logs": ["RVJSOjAwMTpJbnZhbGlkIE1ldGhvZA=="]
123
+ }
124
+ ],
125
+ "group-index":0,
126
+ "pc":41
127
+ },
128
+ "message":"TransactionPool.Remember: transaction ESI4GHAZY46MCUCLPBSB5HBRZPGO6V7DDUM5XKMNVPIRJK6DDAGQ: logic eval error: err opcode executed. Details: app=1004, pc=41"
129
+ }
130
+ ```
131
+
132
+ The `logs` array contains the `base64` encoded error `ERR:001:Invalid Method`.
133
+
134
+ The `logs` array **MAY** contain elements that are not errors (as specified by the
135
+ regexp).
136
+
137
+ It is **NOT RECOMMENDED** to use the `message` field to retrieve errors.
138
+
139
+ ### AVM Compilers
140
+
141
+ AVM compilers (and related tools) **SHOULD** provide two error compiling options:
142
+
143
+ 1. The one specified in this ARC as **default**;
144
+ 1. The one specified in [ARC-56](./arc-0056.md) as fallback, if compiled bytecode
145
+ size exceeds the AVM limits.
146
+
147
+ > Compilers **MAY** optimize for program bytecode size by storing the error prefixes
148
+ in the `bytecblock` and concatenating the error message at the cost of some extra
149
+ opcodes.
150
+
151
+ ## Rationale
152
+
153
+ This convention for AVM run time errors presents the following PROS and CONS.
154
+
155
+ **PROS:**
156
+ - No additional artifacts required to return informative run time errors;
157
+ - Errors are directly returned in the Algod API response, which can be filtered
158
+ with the specified error regexp.
159
+
160
+ **CONS:**
161
+ - Errors consume program bytecode size.
162
+
163
+ ## Security Considerations
164
+
165
+ > Not applicable.
166
+
167
+ ## Copyright
168
+
169
+ Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CCO</a>.
@@ -0,0 +1,183 @@
1
+ ---
2
+ arc: 69
3
+ title: ASA Parameters Conventions, Digital Media
4
+ description: Alternatives conventions for ASAs containing digital media.
5
+ author: Chris Antaki (@ChrisAntaki), AlgoKittens (@algokittens), TommyAlex79 (@TommyAlex79)
6
+ discussions-to: https://github.com/algorandfoundation/ARCs/issues/64
7
+ status: Final
8
+ type: Standards Track
9
+ category: ARC
10
+ sub-category: Asa
11
+ created: 2021-08-07
12
+ ---
13
+
14
+ # Community Algorand Standard Asset Parameters Conventions for Digital Media Tokens
15
+
16
+ We introduce community conventions for the parameters of Algorand Standard Assets (ASAs) containing digital media.
17
+
18
+ ## Abstract
19
+
20
+ The goal of these conventions is to make it simpler to display the properties of a given ASA. This ARC differs from [ARC-3](./arc-0003.md) by focusing on optimization for fetching of digital media, as well as the use of onchain metadata. Furthermore, since asset configuration transactions are used to store the metadata, this ARC can be applied to existing ASAs.
21
+
22
+ While mutability helps with backwards compatibility and other use cases, like leveling up an RPG character, some use cases call for immutability. In these cases, the ASA manager MAY remove the manager address, after which point the Algorand network won't allow anyone to send asset configuration transactions for the ASA. This effectively makes the latest valid [ARC-69](./arc-0069.md) metadata immutable.
23
+
24
+
25
+ ## Specification
26
+
27
+ The key words "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**", "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**MAY**", and "**OPTIONAL**" in this document are to be interpreted as described in <a href="https://www.ietf.org/rfc/rfc2119.txt">RFC-2119</a>.
28
+
29
+ An ARC-69 ASA has an associated JSON Metadata file, formatted as specified below, that is stored on-chain in the note field of the most recent asset configuration transaction (that contains a note field with a valid ARC-69 JSON metadata).
30
+
31
+ ### ASA Parameters Conventions
32
+
33
+ The ASA parameters should follow the following conventions:
34
+
35
+ * *Unit Name* (`un`): no restriction.
36
+ * *Asset Name* (`an`): no restriction.
37
+ * *Asset URL* (`au`): a URI pointing to digital media file. This URI:
38
+ * **SHOULD** be persistent.
39
+ * **SHOULD** link to a file small enough to fetch quickly in a gallery view.
40
+ * **MUST** follow <a href="https://www.ietf.org/rfc/rfc3986.txt">RFC-3986</a> and **MUST NOT** contain any whitespace character.
41
+ * **SHOULD** specify media type with `#` fragment identifier at end of URL. This format **MUST** follow: `#i` for images, `#v` for videos, `#a` for audio, `#p` for PDF, or `#h` for HTML/interactive digital media. If unspecified, assume Image.
42
+ * **SHOULD** use one of the following URI schemes (for compatibility and security): *https* and *ipfs*:
43
+ * When the file is stored on IPFS, the `ipfs://...` URI **SHOULD** be used. IPFS Gateway URI (such as `https://ipfs.io/ipfs/...`) **SHOULD NOT** be used.
44
+ * **SHOULD NOT** use the following URI scheme: *http* (due to security concerns).
45
+ * *Asset Metadata Hash* (`am`): the SHA-256 digest of the full resolution media file as a 32-byte string (as defined in <a href="https://doi.org/10.6028/NIST.FIPS.180-4">NIST FIPS 180-4</a> )
46
+ * **OPTIONAL**
47
+ * *Freeze Address* (`f`):
48
+ * **SHOULD** be empty, unless needed for royalties or other use cases
49
+ * *Clawback Address* (`c`):
50
+ * **SHOULD** be empty, unless needed for royalties or other use cases
51
+
52
+
53
+ There are no requirements regarding the manager account of the ASA, or the reserve account. However, if immutability is required the manager address **MUST** be removed.
54
+
55
+ Furthermore, the manager address, if present, **SHOULD** be under the control of the ASA creator, as the manager address can unilaterally change the metadata. Some advanced use cases **MAY** use a logicsig as ASA manager, if the logicsig only allows to set the note fields by the ASA creator.
56
+
57
+ ### JSON Metadata File Schema
58
+
59
+ ```json
60
+ {
61
+ "title": "Token Metadata",
62
+ "type": "object",
63
+ "properties": {
64
+ "standard": {
65
+ "type": "string",
66
+ "value": "arc69",
67
+ "description": "(Required) Describes the standard used."
68
+ },
69
+ "description": {
70
+ "type": "string",
71
+ "description": "Describes the asset to which this token represents."
72
+ },
73
+ "external_url": {
74
+ "type": "string",
75
+ "description": "A URI pointing to an external website. Borrowed from Open Sea's metadata format (https://docs.opensea.io/docs/metadata-standards)."
76
+ },
77
+ "media_url": {
78
+ "type": "string",
79
+ "description": "A URI pointing to a high resolution version of the asset's media."
80
+ },
81
+ "properties": {
82
+ "type": "object",
83
+ "description": "Properties following the EIP-1155 'simple properties' format. (https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md#erc-1155-metadata-uri-json-schema)"
84
+ },
85
+ "mime_type": {
86
+ "type": "string",
87
+ "description": "Describes the MIME type of the ASA's URL (`au` field)."
88
+ },
89
+ "attributes": {
90
+ "type": "array",
91
+ "description": "(Deprecated. New NFTs should define attributes with the simple `properties` object. Marketplaces should support both the `properties` object and the `attributes` array). The `attributes` array follows Open Sea's format: https://docs.opensea.io/docs/metadata-standards#attributes"
92
+ }
93
+ },
94
+ "required":[
95
+ "standard"
96
+ ]
97
+ }
98
+ ```
99
+ The `standard` field is **REQUIRED** and **MUST** equal `arc69`. All other fields are **OPTIONAL**. If provided, the other fields **MUST** match the description in the JSON schema.
100
+
101
+ The URI field (`external_url`) is defined similarly to the Asset URL parameter `au`.
102
+ However, contrary to the Asset URL, the `external_url` does not need to link to the digital media file.
103
+
104
+ #### MIME Type
105
+
106
+ In addition to specifying a data type in the ASA's URL (`au` field) with a URI fragment (ex: `#v` for video), the JSON Metadata schema also allows indication of the URL's MIME type (ex: `video/mp4`) via the `mime_type` field.
107
+
108
+ #### Examples
109
+
110
+ ##### Basic Example
111
+
112
+ An example of an ARC-69 JSON Metadata file for a song follows. The properties array proposes some **SUGGESTED** formatting for token-specific display properties and metadata.
113
+
114
+ ```json
115
+ {
116
+ "standard": "arc69",
117
+ "description": "arc69 theme song",
118
+ "external_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
119
+ "mime_type": "video/mp4",
120
+ "properties": {
121
+ "Bass":"Groovy",
122
+ "Vibes":"Funky",
123
+ "Overall":"Good stuff"
124
+ }
125
+ }
126
+ ```
127
+
128
+ An example of possible ASA parameters would be:
129
+
130
+ * *Asset Name*: `ARC-69 theme song` for example.
131
+ * *Unit Name*: `69TS` for example.
132
+ * *Asset URL*: `ipfs://QmWS1VAdMD353A6SDk9wNyvkT14kyCiZrNDYAad4w1tKqT#v`
133
+ * *Metadata Hash*: the 32 bytes of the SHA-256 digest of the high resolution media file.
134
+ * *Total Number of Units*: 1
135
+ * *Number of Digits after the Decimal Point*: 0
136
+
137
+ #### Mutability
138
+
139
+ ##### Rendering
140
+
141
+ Clients **SHOULD** render an ASA's latest ARC-69 metadata. Clients **MAY** render an ASA's previous ARC-69 metadata for changelogs or other historical features.
142
+
143
+ ##### Updating ARC-69 metadata
144
+
145
+ If an ASA has a manager address, then the manager **MAY** update an ASA's ARC-69 metadata. To do so, the manager sends a new `acfg` transaction with the entire metadata represented as JSON in the transaction's `note` field.
146
+
147
+ ##### Making ARC-69 metadata immutable
148
+
149
+ Managers MAY make an ASA's ARC-69 immutable. To do so, they MUST remove the ASA's manager address with an `acfg` transaction.
150
+
151
+ ##### ARC-69 attribute deprecation
152
+
153
+ The initial version of ARC-69 followed the Open Sea attributes format https://docs.opensea.io/docs/metadata-standards#attributes. As illustrated below:
154
+ ```
155
+ "attributes": {
156
+ "type": "array",
157
+ "description": "Attributes following Open Sea's attributes format (https://docs.opensea.io/docs/metadata-standards#attributes)."
158
+ }
159
+ ```
160
+ This format is now deprecated. New NFTs **SHOULD** use the simple `properties` format, since it significantly reduces the metadata size.
161
+
162
+ To be fully compliant with the ARC-69 standard, both the `properties` object and the `attributes` array **SHOULD** be supported.
163
+
164
+ ## Rationale
165
+
166
+ These conventions take inspiration from <a href="https://docs.opensea.io/docs/metadata-standards">Open Sea's metadata standards</a> and <a href="https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md#erc-1155-metadata-uri-json-schema">EIP-1155</a>
167
+
168
+ to facilitate interoperobility.
169
+
170
+ The main differences are highlighted below:
171
+
172
+ * Asset Name, Unit Name, and URL are specified in the ASA parameters. This allows applications to efficiently display meaningful information, even if they aren't aware of ARC-69 metadata.
173
+ * MIME types help clients more effectively fetch and render media.
174
+ * All asset metadata is stored onchain.
175
+ * Metadata can be either mutable or immutable.
176
+
177
+ ## Security Considerations
178
+
179
+ None.
180
+
181
+ ## Copyright
182
+
183
+ Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CCO</a>.