├── scripts ├── tmp3gygigg3 ├── algod_specfile_processors ├── contains_doc_changes.sh └── example_tracker │ └── list_examples.sh ├── .indexer.version ├── .go-algorand-beta.version ├── .go-algorand-stable.version ├── docs ├── clis │ ├── goal │ │ ├── .pages │ │ ├── app │ │ │ ├── .pages │ │ │ ├── box │ │ │ │ └── .pages │ │ │ └── interact │ │ │ │ └── .pages │ │ ├── kmd │ │ │ ├── .pages │ │ │ ├── stop.md │ │ │ ├── start.md │ │ │ └── kmd.md │ │ ├── asset │ │ │ ├── .pages │ │ │ ├── asset.md │ │ │ └── info.md │ │ ├── clerk │ │ │ ├── .pages │ │ │ ├── multisig │ │ │ │ ├── .pages │ │ │ │ ├── merge.md │ │ │ │ ├── multisig.md │ │ │ │ └── sign.md │ │ │ ├── inspect.md │ │ │ ├── dryrun-remote.md │ │ │ ├── split.md │ │ │ └── rawsend.md │ │ ├── node │ │ │ ├── .pages │ │ │ ├── stop.md │ │ │ ├── generatetoken.md │ │ │ ├── lastround.md │ │ │ ├── generate-p2pid.md │ │ │ ├── status.md │ │ │ ├── wait.md │ │ │ ├── start.md │ │ │ ├── pendingtxns.md │ │ │ ├── restart.md │ │ │ ├── clone.md │ │ │ └── create.md │ │ ├── ledger │ │ │ ├── .pages │ │ │ ├── ledger.md │ │ │ ├── supply.md │ │ │ └── block.md │ │ ├── wallet │ │ │ ├── .pages │ │ │ ├── list.md │ │ │ ├── rename.md │ │ │ ├── wallet.md │ │ │ └── new.md │ │ ├── account │ │ │ ├── .pages │ │ │ ├── multisig │ │ │ │ ├── .pages │ │ │ │ ├── multisig.md │ │ │ │ ├── new.md │ │ │ │ ├── delete.md │ │ │ │ └── info.md │ │ │ ├── rename.md │ │ │ ├── deletepartkey.md │ │ │ ├── partkeyinfo.md │ │ │ ├── listpartkeys.md │ │ │ ├── balance.md │ │ │ ├── delete.md │ │ │ ├── rewards.md │ │ │ ├── new.md │ │ │ ├── export.md │ │ │ ├── dump.md │ │ │ ├── list.md │ │ │ ├── info.md │ │ │ ├── import.md │ │ │ ├── assetdetails.md │ │ │ └── importrootkey.md │ │ ├── logging │ │ │ ├── .pages │ │ │ ├── disable.md │ │ │ ├── send.md │ │ │ ├── enable.md │ │ │ └── logging.md │ │ ├── network │ │ │ ├── .pages │ │ │ ├── stop.md │ │ │ ├── restart.md │ │ │ ├── status.md │ │ │ ├── delete.md │ │ │ ├── start.md │ │ │ └── pregen.md │ │ ├── completion │ │ │ ├── .pages │ │ │ ├── zsh.md │ │ │ ├── bash.md │ │ │ └── completion.md │ │ ├── license.md │ │ ├── report.md │ │ ├── version.md │ │ └── protocols.md │ ├── algokey │ │ ├── .pages │ │ ├── part │ │ │ ├── .pages │ │ │ ├── info.md │ │ │ ├── reparent.md │ │ │ ├── part.md │ │ │ └── generate.md │ │ ├── multisig │ │ │ ├── .pages │ │ │ ├── multisig.md │ │ │ └── append-auth-addr.md │ │ ├── generate.md │ │ ├── import.md │ │ ├── export.md │ │ ├── sign.md │ │ └── algokey.md │ ├── conduit │ │ ├── .pages │ │ └── list │ │ │ ├── .pages │ │ │ ├── exporters.md │ │ │ ├── importers.md │ │ │ ├── processors.md │ │ │ └── list.md │ ├── diagcfg │ │ ├── .pages │ │ ├── metric │ │ │ ├── .pages │ │ │ ├── status.md │ │ │ ├── enable.md │ │ │ ├── disable.md │ │ │ └── metric.md │ │ ├── telemetry │ │ │ ├── .pages │ │ │ ├── enable.md │ │ │ ├── disable.md │ │ │ ├── status.md │ │ │ ├── endpoint.md │ │ │ ├── name.md │ │ │ └── telemetry.md │ │ └── diagcfg.md │ ├── indexer │ │ ├── .pages │ │ ├── util │ │ │ ├── .pages │ │ │ └── util.md │ │ ├── api-config.md │ │ └── indexer.md │ ├── tealdbg │ │ ├── .pages │ │ ├── tealdbg.md │ │ └── remote.md │ ├── .pages │ └── kmd.md ├── get-details │ ├── algokit │ │ ├── utils │ │ │ ├── ts │ │ │ │ ├── code │ │ │ │ │ ├── .pages │ │ │ │ │ ├── modules │ │ │ │ │ │ ├── types_amount_spec.md │ │ │ │ │ │ ├── types_app_client_spec.md │ │ │ │ │ │ ├── types_dispenser_client_spec.md │ │ │ │ │ │ ├── types_amount.md │ │ │ │ │ │ ├── types_config.md │ │ │ │ │ │ ├── types_algo_http_client_with_retry.md │ │ │ │ │ │ ├── types_network_client.md │ │ │ │ │ │ ├── types_logic_error.md │ │ │ │ │ │ ├── types_asset.md │ │ │ │ │ │ ├── types_transfer.md │ │ │ │ │ │ ├── types_dispenser_client.md │ │ │ │ │ │ ├── types_testing.md │ │ │ │ │ │ ├── types_debugging.md │ │ │ │ │ │ └── types_account.md │ │ │ │ │ ├── interfaces │ │ │ │ │ │ ├── types_urlTokenBaseHTTPClient.CustomTokenHeader.md │ │ │ │ │ │ ├── types_app.AppState.md │ │ │ │ │ │ ├── types_app.TealTemplateParams.md │ │ │ │ │ │ ├── types_dispenser_client.DispenserLimitResponse.md │ │ │ │ │ │ ├── types_urlTokenBaseHTTPClient.KMDTokenHeader.md │ │ │ │ │ │ ├── types_urlTokenBaseHTTPClient.AlgodTokenHeader.md │ │ │ │ │ │ ├── types_urlTokenBaseHTTPClient.IndexerTokenHeader.md │ │ │ │ │ │ ├── types_debugging.AVMDebuggerSourceMapDict.md │ │ │ │ │ │ ├── types_app.AppLookup.md │ │ │ │ │ │ ├── types_app_spec.AppSources.md │ │ │ │ │ │ ├── types_dispenser_client.DispenserFundResponse.md │ │ │ │ │ │ ├── types_app.BoxReference.md │ │ │ │ │ │ ├── types_account.TransactionSignerAccount.md │ │ │ │ │ │ ├── types_app_spec.Struct.md │ │ │ │ │ │ ├── types_app_spec.SchemaSpec.md │ │ │ │ │ │ ├── types_transfer.EnsureFundedReturnType.md │ │ │ │ │ │ ├── types_app.AppReference.md │ │ │ │ │ │ ├── types_app_spec.StateSchemaSpec.md │ │ │ │ │ │ ├── types_dispenser_client.TestNetDispenserApiClientParams.md │ │ │ │ │ │ ├── types_app_spec.Schema.md │ │ │ │ │ │ ├── types_indexer.AssetLookupResult.md │ │ │ │ │ │ ├── types_app.AppCompilationResult.md │ │ │ │ │ │ ├── types_indexer.AccountLookupResult.md │ │ │ │ │ │ ├── types_app.BoxName.md │ │ │ │ │ │ ├── types_app_client.AppSourceMaps.md │ │ │ │ │ │ ├── types_testing.GetTestAccountParams.md │ │ │ │ │ │ ├── types_indexer.TransactionLookupResult.md │ │ │ │ │ │ ├── types_indexer.ApplicationLookupResult.md │ │ │ │ │ │ ├── types_indexer.EvalDelta.md │ │ │ │ │ │ └── types_transaction.TransactionToSign.md │ │ │ │ │ ├── enums │ │ │ │ │ │ └── types_indexer.SignatureType.md │ │ │ │ │ └── index.md │ │ │ │ ├── images │ │ │ │ │ └── lifecycle.jpg │ │ │ │ └── .pages │ │ │ └── py │ │ │ │ └── .pages │ │ ├── imgs │ │ │ ├── lora1.png │ │ │ ├── lora2.png │ │ │ ├── lora3.png │ │ │ ├── lora4.png │ │ │ ├── lora5.png │ │ │ ├── lora6.png │ │ │ ├── lora7.png │ │ │ ├── lora8.png │ │ │ ├── lora9.png │ │ │ ├── localnet.png │ │ │ ├── lora10.png │ │ │ ├── lora11.png │ │ │ ├── lora12.png │ │ │ ├── lora13.png │ │ │ ├── lora14.png │ │ │ ├── lora15.png │ │ │ ├── lora16.png │ │ │ ├── lora17.png │ │ │ ├── algokit-map.png │ │ │ ├── algokitdemo.png │ │ │ ├── lora-wallet.png │ │ │ ├── algokit_v2_demo.png │ │ │ ├── algokitv2_json.png │ │ │ ├── algokitartifacts.png │ │ │ ├── algokitplayground.png │ │ │ ├── algokitv2_starter.png │ │ │ ├── dappflow_transaction.png │ │ │ └── algokit-intro-video-thumbnail.jpg │ │ ├── architecture-decisions │ │ │ ├── lifecycle.jpg │ │ │ └── assets │ │ │ │ ├── 2024-01-13_native_binaries │ │ │ │ ├── image_1.png │ │ │ │ └── image_2.png │ │ │ │ └── 2023-06-06_frontend-templates │ │ │ │ ├── scenario_1.jpg │ │ │ │ ├── scenario_2.jpg │ │ │ │ └── modular_templates.jpg │ │ ├── .pages │ │ ├── features │ │ │ └── explore.md │ │ └── articles │ │ │ └── output_stability.md │ ├── dapps │ │ ├── smart-contracts │ │ │ ├── frontend │ │ │ │ └── .pages │ │ │ ├── smartsigs │ │ │ │ └── .pages │ │ │ ├── apps │ │ │ │ └── .pages │ │ │ └── .pages │ │ ├── avm │ │ │ ├── .pages │ │ │ └── teal │ │ │ │ ├── .pages │ │ │ │ ├── guidelines.md │ │ │ │ └── opcodes │ │ │ │ ├── .pages │ │ │ │ └── index.md │ │ ├── .pages │ │ └── writing-contracts │ │ │ ├── .pages │ │ │ └── python.md │ ├── accounts │ │ └── .pages │ ├── stateproofs │ │ └── .pages │ ├── algorand-networks │ │ ├── .pages │ │ ├── mainnet.md │ │ ├── testnet.md │ │ └── betanet.md │ ├── transactions │ │ └── .pages │ └── .pages ├── imgs │ ├── go.png │ ├── js.png │ ├── yt.png │ ├── aikon.png │ ├── app-1.jpg │ ├── app-2.jpg │ ├── app-3.jpg │ ├── app-4.jpg │ ├── app-5.jpg │ ├── app-6.jpg │ ├── app-7.jpg │ ├── app-8.jpg │ ├── app-9.jpg │ ├── dapps.png │ ├── java.png │ ├── lora1.png │ ├── lora2.png │ ├── lora3.png │ ├── lora4.png │ ├── lora5.png │ ├── lora6.png │ ├── lora7.png │ ├── lora8.png │ ├── lora9.png │ ├── accounts.png │ ├── algoicon.png │ ├── app-10.jpg │ ├── dapp-bid.png │ ├── discord.png │ ├── localnet.png │ ├── lora10.png │ ├── lora11.png │ ├── lora12.png │ ├── lora13.png │ ├── lora14.png │ ├── lora15.png │ ├── lora16.png │ ├── lora17.png │ ├── modes-0.png │ ├── modes-1.png │ ├── modes-2.png │ ├── myalgo.png │ ├── network.png │ ├── python.png │ ├── renew-0.png │ ├── accounts-0.png │ ├── accounts-1.png │ ├── accounts-2.png │ ├── accounts-3.png │ ├── accounts-4.png │ ├── algosigner.png │ ├── basics-pos.png │ ├── basics-pow.png │ ├── dapp-close.png │ ├── dapp-setup.png │ ├── indexerv2.png │ ├── refarray_1.png │ ├── refarray_2.png │ ├── refarray_3.png │ ├── refarray_4.png │ ├── refarray_5.png │ ├── refarray_6.png │ ├── replit-512.png │ ├── stateful-1.png │ ├── stateful-2.png │ ├── tealdbg-1.png │ ├── tealdbg-2.png │ ├── tealdbg-3.png │ ├── algoexplorer.png │ ├── algokitdemo.png │ ├── conduitarch.png │ ├── dapp-create.png │ ├── lora-wallet.png │ ├── purestakelogo.png │ ├── sccalltypes.png │ ├── vertices-logo.png │ ├── algo_dev_stack.png │ ├── algokit_v2_demo.png │ ├── algokitv2_json.png │ ├── algotides-logo.png │ ├── goalseekericon.png │ ├── teal_overview-0.png │ ├── teal_overview-1.png │ ├── teal_overview-2.png │ ├── teal_overview-3.png │ ├── teal_overview-4.png │ ├── teal_overview-5.png │ ├── teal_overview-6.png │ ├── teal_overview-7.png │ ├── uneconomia-logo.png │ ├── AlgoExplorerLogo.png │ ├── algokitartifacts.png │ ├── algokitplayground.png │ ├── algokitv2_starter.png │ ├── asc1_sdk_usage-1.png │ ├── asc1_sdk_usage-2.png │ ├── atomic_transfers-1.png │ ├── atomic_transfers-2.png │ ├── basics-alicebob-1.png │ ├── basics-alicebob-2.png │ ├── basics-immutable.png │ ├── blockchain-diagram.png │ ├── light_client_arch.png │ ├── sandbox-node-guy.png │ ├── tokenization-nfts.png │ ├── algorand_consensus-1.png │ ├── algorand_consensus-2.png │ ├── algorand_consensus-3.png │ ├── algorand_consensus-4.png │ ├── integration-indexer.png │ ├── rekey-single-single.png │ ├── walletconnect-header.png │ ├── blockchain-properties.png │ ├── integrations-algos-asas.png │ ├── rekey-single-multisig.png │ ├── tokenization-fungible-1.png │ ├── tokenization-fungible-2.png │ ├── transaction_commitment.png │ ├── basics-traditional-error.png │ ├── block_interval_commitment.png │ ├── basics-woman-bid-blockchain.png │ ├── basics-woman-bid-traditional.png │ ├── tokenization-alice-bob-nft.png │ ├── algokit-intro-video-thumbnail.jpg │ ├── block_interval_commitment_arch.png │ ├── basics-blockchain-vs-traditional.png │ └── walletconnect-establishing-connection.png ├── get-started │ ├── tokenization │ │ └── .pages │ ├── .pages │ └── basics │ │ └── .pages ├── run-a-node │ ├── .pages │ ├── operations │ │ └── .pages │ ├── reference │ │ └── .pages │ ├── setup │ │ └── .pages │ └── participate │ │ └── .pages ├── sdks │ └── .pages ├── rest-apis │ └── .pages ├── .pages └── about.md ├── .walletconnect └── .pages ├── requirements.txt ├── .gitignore ├── .github ├── workflows │ ├── build.yml │ └── update-dev-portal.yml └── ISSUE_TEMPLATE │ ├── small-improvements-for-clarity-of-message.md │ ├── fixing-errors-or-inaccuracies.md │ └── large-additions-or-modifications.md ├── README.md ├── LICENSE.md └── mkdocs.yml /scripts/tmp3gygigg3: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.indexer.version: -------------------------------------------------------------------------------- 1 | 3.9.0 2 | -------------------------------------------------------------------------------- /.go-algorand-beta.version: -------------------------------------------------------------------------------- 1 | v4.3.0-beta 2 | -------------------------------------------------------------------------------- /.go-algorand-stable.version: -------------------------------------------------------------------------------- 1 | v4.3.0-stable 2 | -------------------------------------------------------------------------------- /docs/clis/goal/.pages: -------------------------------------------------------------------------------- 1 | title: goal 2 | arrange: 3 | - goal.md -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/.pages: -------------------------------------------------------------------------------- 1 | title: API Ref -------------------------------------------------------------------------------- /docs/clis/goal/app/.pages: -------------------------------------------------------------------------------- 1 | title: goal app 2 | arrange: 3 | - app.md -------------------------------------------------------------------------------- /docs/clis/goal/kmd/.pages: -------------------------------------------------------------------------------- 1 | title: goal kmd 2 | arrange: 3 | - kmd.md -------------------------------------------------------------------------------- /docs/clis/algokey/.pages: -------------------------------------------------------------------------------- 1 | title: algokey 2 | arrange: 3 | - algokey.md -------------------------------------------------------------------------------- /docs/clis/conduit/.pages: -------------------------------------------------------------------------------- 1 | title: conduit 2 | arrange: 3 | - conduit.md -------------------------------------------------------------------------------- /docs/clis/diagcfg/.pages: -------------------------------------------------------------------------------- 1 | title: diagcfg 2 | arrange: 3 | - diagcfg.md -------------------------------------------------------------------------------- /docs/clis/goal/asset/.pages: -------------------------------------------------------------------------------- 1 | title: goal asset 2 | arrange: 3 | - asset.md -------------------------------------------------------------------------------- /docs/clis/goal/clerk/.pages: -------------------------------------------------------------------------------- 1 | title: goal clerk 2 | arrange: 3 | - clerk.md -------------------------------------------------------------------------------- /docs/clis/goal/node/.pages: -------------------------------------------------------------------------------- 1 | title: goal node 2 | arrange: 3 | - node.md -------------------------------------------------------------------------------- /docs/clis/indexer/.pages: -------------------------------------------------------------------------------- 1 | title: indexer 2 | arrange: 3 | - indexer.md -------------------------------------------------------------------------------- /docs/clis/tealdbg/.pages: -------------------------------------------------------------------------------- 1 | title: tealdbg 2 | arrange: 3 | - tealdbg.md -------------------------------------------------------------------------------- /docs/clis/algokey/part/.pages: -------------------------------------------------------------------------------- 1 | title: algokey part 2 | arrange: 3 | - part.md -------------------------------------------------------------------------------- /docs/clis/conduit/list/.pages: -------------------------------------------------------------------------------- 1 | title: conduit list 2 | arrange: 3 | - list.md -------------------------------------------------------------------------------- /docs/clis/goal/app/box/.pages: -------------------------------------------------------------------------------- 1 | title: goal app box 2 | arrange: 3 | - box.md -------------------------------------------------------------------------------- /docs/clis/goal/ledger/.pages: -------------------------------------------------------------------------------- 1 | title: goal ledger 2 | arrange: 3 | - ledger.md -------------------------------------------------------------------------------- /docs/clis/goal/wallet/.pages: -------------------------------------------------------------------------------- 1 | title: goal wallet 2 | arrange: 3 | - wallet.md -------------------------------------------------------------------------------- /docs/clis/indexer/util/.pages: -------------------------------------------------------------------------------- 1 | title: indexer util 2 | arrange: 3 | - util.md -------------------------------------------------------------------------------- /docs/clis/diagcfg/metric/.pages: -------------------------------------------------------------------------------- 1 | title: diagcfg metric 2 | arrange: 3 | - metric.md -------------------------------------------------------------------------------- /docs/clis/goal/account/.pages: -------------------------------------------------------------------------------- 1 | title: goal account 2 | arrange: 3 | - account.md -------------------------------------------------------------------------------- /docs/clis/goal/logging/.pages: -------------------------------------------------------------------------------- 1 | title: goal logging 2 | arrange: 3 | - logging.md -------------------------------------------------------------------------------- /docs/clis/goal/network/.pages: -------------------------------------------------------------------------------- 1 | title: goal network 2 | arrange: 3 | - network.md -------------------------------------------------------------------------------- /docs/clis/algokey/multisig/.pages: -------------------------------------------------------------------------------- 1 | title: algokey multisig 2 | arrange: 3 | - multisig.md -------------------------------------------------------------------------------- /docs/clis/goal/completion/.pages: -------------------------------------------------------------------------------- 1 | title: goal completion 2 | arrange: 3 | - completion.md -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/.pages: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry 2 | arrange: 3 | - telemetry.md -------------------------------------------------------------------------------- /docs/clis/goal/app/interact/.pages: -------------------------------------------------------------------------------- 1 | title: goal app interact 2 | arrange: 3 | - interact.md -------------------------------------------------------------------------------- /docs/imgs/go.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/go.png -------------------------------------------------------------------------------- /docs/imgs/js.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/js.png -------------------------------------------------------------------------------- /docs/imgs/yt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/yt.png -------------------------------------------------------------------------------- /docs/clis/goal/account/multisig/.pages: -------------------------------------------------------------------------------- 1 | title: goal account multisig 2 | arrange: 3 | - multisig.md -------------------------------------------------------------------------------- /docs/clis/goal/clerk/multisig/.pages: -------------------------------------------------------------------------------- 1 | title: goal clerk multisig 2 | arrange: 3 | - multisig.md -------------------------------------------------------------------------------- /docs/imgs/aikon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/aikon.png -------------------------------------------------------------------------------- /docs/imgs/app-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-1.jpg -------------------------------------------------------------------------------- /docs/imgs/app-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-2.jpg -------------------------------------------------------------------------------- /docs/imgs/app-3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-3.jpg -------------------------------------------------------------------------------- /docs/imgs/app-4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-4.jpg -------------------------------------------------------------------------------- /docs/imgs/app-5.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-5.jpg -------------------------------------------------------------------------------- /docs/imgs/app-6.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-6.jpg -------------------------------------------------------------------------------- /docs/imgs/app-7.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-7.jpg -------------------------------------------------------------------------------- /docs/imgs/app-8.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-8.jpg -------------------------------------------------------------------------------- /docs/imgs/app-9.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-9.jpg -------------------------------------------------------------------------------- /docs/imgs/dapps.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/dapps.png -------------------------------------------------------------------------------- /docs/imgs/java.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/java.png -------------------------------------------------------------------------------- /docs/imgs/lora1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora1.png -------------------------------------------------------------------------------- /docs/imgs/lora2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora2.png -------------------------------------------------------------------------------- /docs/imgs/lora3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora3.png -------------------------------------------------------------------------------- /docs/imgs/lora4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora4.png -------------------------------------------------------------------------------- /docs/imgs/lora5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora5.png -------------------------------------------------------------------------------- /docs/imgs/lora6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora6.png -------------------------------------------------------------------------------- /docs/imgs/lora7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora7.png -------------------------------------------------------------------------------- /docs/imgs/lora8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora8.png -------------------------------------------------------------------------------- /docs/imgs/lora9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora9.png -------------------------------------------------------------------------------- /docs/get-details/dapps/smart-contracts/frontend/.pages: -------------------------------------------------------------------------------- 1 | arrange: 2 | - apps.md 3 | - smartsigs.md -------------------------------------------------------------------------------- /docs/imgs/accounts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts.png -------------------------------------------------------------------------------- /docs/imgs/algoicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algoicon.png -------------------------------------------------------------------------------- /docs/imgs/app-10.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/app-10.jpg -------------------------------------------------------------------------------- /docs/imgs/dapp-bid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/dapp-bid.png -------------------------------------------------------------------------------- /docs/imgs/discord.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/discord.png -------------------------------------------------------------------------------- /docs/imgs/localnet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/localnet.png -------------------------------------------------------------------------------- /docs/imgs/lora10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora10.png -------------------------------------------------------------------------------- /docs/imgs/lora11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora11.png -------------------------------------------------------------------------------- /docs/imgs/lora12.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora12.png -------------------------------------------------------------------------------- /docs/imgs/lora13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora13.png -------------------------------------------------------------------------------- /docs/imgs/lora14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora14.png -------------------------------------------------------------------------------- /docs/imgs/lora15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora15.png -------------------------------------------------------------------------------- /docs/imgs/lora16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora16.png -------------------------------------------------------------------------------- /docs/imgs/lora17.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora17.png -------------------------------------------------------------------------------- /docs/imgs/modes-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/modes-0.png -------------------------------------------------------------------------------- /docs/imgs/modes-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/modes-1.png -------------------------------------------------------------------------------- /docs/imgs/modes-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/modes-2.png -------------------------------------------------------------------------------- /docs/imgs/myalgo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/myalgo.png -------------------------------------------------------------------------------- /docs/imgs/network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/network.png -------------------------------------------------------------------------------- /docs/imgs/python.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/python.png -------------------------------------------------------------------------------- /docs/imgs/renew-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/renew-0.png -------------------------------------------------------------------------------- /.walletconnect/.pages: -------------------------------------------------------------------------------- 1 | title: WalletConnect 2 | 3 | arrange: 4 | - index.md 5 | - walletconnect-schema.md -------------------------------------------------------------------------------- /docs/imgs/accounts-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts-0.png -------------------------------------------------------------------------------- /docs/imgs/accounts-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts-1.png -------------------------------------------------------------------------------- /docs/imgs/accounts-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts-2.png -------------------------------------------------------------------------------- /docs/imgs/accounts-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts-3.png -------------------------------------------------------------------------------- /docs/imgs/accounts-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/accounts-4.png -------------------------------------------------------------------------------- /docs/imgs/algosigner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algosigner.png -------------------------------------------------------------------------------- /docs/imgs/basics-pos.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-pos.png -------------------------------------------------------------------------------- /docs/imgs/basics-pow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-pow.png -------------------------------------------------------------------------------- /docs/imgs/dapp-close.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/dapp-close.png -------------------------------------------------------------------------------- /docs/imgs/dapp-setup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/dapp-setup.png -------------------------------------------------------------------------------- /docs/imgs/indexerv2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/indexerv2.png -------------------------------------------------------------------------------- /docs/imgs/refarray_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_1.png -------------------------------------------------------------------------------- /docs/imgs/refarray_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_2.png -------------------------------------------------------------------------------- /docs/imgs/refarray_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_3.png -------------------------------------------------------------------------------- /docs/imgs/refarray_4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_4.png -------------------------------------------------------------------------------- /docs/imgs/refarray_5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_5.png -------------------------------------------------------------------------------- /docs/imgs/refarray_6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/refarray_6.png -------------------------------------------------------------------------------- /docs/imgs/replit-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/replit-512.png -------------------------------------------------------------------------------- /docs/imgs/stateful-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/stateful-1.png -------------------------------------------------------------------------------- /docs/imgs/stateful-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/stateful-2.png -------------------------------------------------------------------------------- /docs/imgs/tealdbg-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tealdbg-1.png -------------------------------------------------------------------------------- /docs/imgs/tealdbg-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tealdbg-2.png -------------------------------------------------------------------------------- /docs/imgs/tealdbg-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tealdbg-3.png -------------------------------------------------------------------------------- /docs/get-details/accounts/.pages: -------------------------------------------------------------------------------- 1 | title: Accounts 2 | arrange: 3 | - index.md 4 | - create.md 5 | - rekey.md -------------------------------------------------------------------------------- /docs/get-started/tokenization/.pages: -------------------------------------------------------------------------------- 1 | title: Tokenization 2 | 3 | arrange: 4 | - nft.md 5 | - ft.md 6 | -------------------------------------------------------------------------------- /docs/imgs/algoexplorer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algoexplorer.png -------------------------------------------------------------------------------- /docs/imgs/algokitdemo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokitdemo.png -------------------------------------------------------------------------------- /docs/imgs/conduitarch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/conduitarch.png -------------------------------------------------------------------------------- /docs/imgs/dapp-create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/dapp-create.png -------------------------------------------------------------------------------- /docs/imgs/lora-wallet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/lora-wallet.png -------------------------------------------------------------------------------- /docs/imgs/purestakelogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/purestakelogo.png -------------------------------------------------------------------------------- /docs/imgs/sccalltypes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/sccalltypes.png -------------------------------------------------------------------------------- /docs/imgs/vertices-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/vertices-logo.png -------------------------------------------------------------------------------- /docs/get-details/stateproofs/.pages: -------------------------------------------------------------------------------- 1 | title: Algorand State Proofs 2 | arrange: 3 | - index.md 4 | - light_client.md -------------------------------------------------------------------------------- /docs/imgs/algo_dev_stack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algo_dev_stack.png -------------------------------------------------------------------------------- /docs/imgs/algokit_v2_demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokit_v2_demo.png -------------------------------------------------------------------------------- /docs/imgs/algokitv2_json.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokitv2_json.png -------------------------------------------------------------------------------- /docs/imgs/algotides-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algotides-logo.png -------------------------------------------------------------------------------- /docs/imgs/goalseekericon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/goalseekericon.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-0.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-1.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-2.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-3.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-4.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-5.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-6.png -------------------------------------------------------------------------------- /docs/imgs/teal_overview-7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/teal_overview-7.png -------------------------------------------------------------------------------- /docs/imgs/uneconomia-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/uneconomia-logo.png -------------------------------------------------------------------------------- /docs/clis/.pages: -------------------------------------------------------------------------------- 1 | title: CLI Tools 2 | arrange: 3 | - goal 4 | - kmd.md 5 | - algokey 6 | - diagcfg 7 | -------------------------------------------------------------------------------- /docs/get-details/dapps/avm/.pages: -------------------------------------------------------------------------------- 1 | title: Algorand Virtual Machine (AVM) 2 | 3 | arrange: 4 | - index.md 5 | - teal -------------------------------------------------------------------------------- /docs/get-started/.pages: -------------------------------------------------------------------------------- 1 | title: Get started 2 | 3 | arrange: 4 | - algokit.md 5 | - basics 6 | - tokenization -------------------------------------------------------------------------------- /docs/imgs/AlgoExplorerLogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/AlgoExplorerLogo.png -------------------------------------------------------------------------------- /docs/imgs/algokitartifacts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokitartifacts.png -------------------------------------------------------------------------------- /docs/imgs/algokitplayground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokitplayground.png -------------------------------------------------------------------------------- /docs/imgs/algokitv2_starter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokitv2_starter.png -------------------------------------------------------------------------------- /docs/imgs/asc1_sdk_usage-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/asc1_sdk_usage-1.png -------------------------------------------------------------------------------- /docs/imgs/asc1_sdk_usage-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/asc1_sdk_usage-2.png -------------------------------------------------------------------------------- /docs/imgs/atomic_transfers-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/atomic_transfers-1.png -------------------------------------------------------------------------------- /docs/imgs/atomic_transfers-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/atomic_transfers-2.png -------------------------------------------------------------------------------- /docs/imgs/basics-alicebob-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-alicebob-1.png -------------------------------------------------------------------------------- /docs/imgs/basics-alicebob-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-alicebob-2.png -------------------------------------------------------------------------------- /docs/imgs/basics-immutable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-immutable.png -------------------------------------------------------------------------------- /docs/imgs/blockchain-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/blockchain-diagram.png -------------------------------------------------------------------------------- /docs/imgs/light_client_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/light_client_arch.png -------------------------------------------------------------------------------- /docs/imgs/sandbox-node-guy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/sandbox-node-guy.png -------------------------------------------------------------------------------- /docs/imgs/tokenization-nfts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tokenization-nfts.png -------------------------------------------------------------------------------- /docs/run-a-node/.pages: -------------------------------------------------------------------------------- 1 | title: Run a node 2 | arrange: 3 | - setup 4 | - operations 5 | - participate 6 | - reference -------------------------------------------------------------------------------- /docs/run-a-node/operations/.pages: -------------------------------------------------------------------------------- 1 | title: Common node operations 2 | arrange: 3 | - switch_networks.md 4 | - catchup.md -------------------------------------------------------------------------------- /docs/sdks/.pages: -------------------------------------------------------------------------------- 1 | title: SDKs 2 | arrange: 3 | - index.md 4 | - python 5 | - javascript 6 | - go 7 | - java 8 | -------------------------------------------------------------------------------- /docs/imgs/algorand_consensus-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algorand_consensus-1.png -------------------------------------------------------------------------------- /docs/imgs/algorand_consensus-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algorand_consensus-2.png -------------------------------------------------------------------------------- /docs/imgs/algorand_consensus-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algorand_consensus-3.png -------------------------------------------------------------------------------- /docs/imgs/algorand_consensus-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algorand_consensus-4.png -------------------------------------------------------------------------------- /docs/imgs/integration-indexer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/integration-indexer.png -------------------------------------------------------------------------------- /docs/imgs/rekey-single-single.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/rekey-single-single.png -------------------------------------------------------------------------------- /docs/imgs/walletconnect-header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/walletconnect-header.png -------------------------------------------------------------------------------- /docs/rest-apis/.pages: -------------------------------------------------------------------------------- 1 | title: REST APIs 2 | arrange: 3 | - algod.md 4 | - indexer.md 5 | - kmd.md 6 | - restendpoints.md -------------------------------------------------------------------------------- /docs/imgs/blockchain-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/blockchain-properties.png -------------------------------------------------------------------------------- /docs/imgs/integrations-algos-asas.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/integrations-algos-asas.png -------------------------------------------------------------------------------- /docs/imgs/rekey-single-multisig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/rekey-single-multisig.png -------------------------------------------------------------------------------- /docs/imgs/tokenization-fungible-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tokenization-fungible-1.png -------------------------------------------------------------------------------- /docs/imgs/tokenization-fungible-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tokenization-fungible-2.png -------------------------------------------------------------------------------- /docs/imgs/transaction_commitment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/transaction_commitment.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora1.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora2.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora3.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora4.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora5.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora6.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora7.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora8.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora9.png -------------------------------------------------------------------------------- /docs/imgs/basics-traditional-error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-traditional-error.png -------------------------------------------------------------------------------- /docs/imgs/block_interval_commitment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/block_interval_commitment.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs-material==8.1.9 2 | mkdocs-awesome-pages-plugin==2.6.1 3 | importlib-metadata==4.10.1 4 | gitpython==3.1.41 5 | -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/localnet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/localnet.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora10.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora11.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora12.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora12.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora13.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora14.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora15.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora16.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora17.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora17.png -------------------------------------------------------------------------------- /docs/get-details/dapps/.pages: -------------------------------------------------------------------------------- 1 | title: Smart contracts & dApps 2 | arrange: 3 | - smart-contracts 4 | - writing-contracts 5 | - avm 6 | -------------------------------------------------------------------------------- /docs/imgs/basics-woman-bid-blockchain.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-woman-bid-blockchain.png -------------------------------------------------------------------------------- /docs/imgs/basics-woman-bid-traditional.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-woman-bid-traditional.png -------------------------------------------------------------------------------- /docs/imgs/tokenization-alice-bob-nft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/tokenization-alice-bob-nft.png -------------------------------------------------------------------------------- /docs/get-details/dapps/avm/teal/.pages: -------------------------------------------------------------------------------- 1 | title: TEAL 2 | arrange: 3 | - index.md 4 | - specification.md 5 | - opcodes 6 | - guidelines.md 7 | -------------------------------------------------------------------------------- /docs/imgs/algokit-intro-video-thumbnail.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/algokit-intro-video-thumbnail.jpg -------------------------------------------------------------------------------- /docs/imgs/block_interval_commitment_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/block_interval_commitment_arch.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokit-map.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokit-map.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokitdemo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokitdemo.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/lora-wallet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/lora-wallet.png -------------------------------------------------------------------------------- /docs/get-details/algorand-networks/.pages: -------------------------------------------------------------------------------- 1 | title: Algorand networks 2 | arrange: 3 | - index.md 4 | - mainnet.md 5 | - testnet.md 6 | - betanet.md -------------------------------------------------------------------------------- /docs/get-details/dapps/smart-contracts/smartsigs/.pages: -------------------------------------------------------------------------------- 1 | title: Smart signatures 2 | 3 | arrange: 4 | - index.md 5 | - modes.md 6 | - walkthrough.md -------------------------------------------------------------------------------- /docs/imgs/basics-blockchain-vs-traditional.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/basics-blockchain-vs-traditional.png -------------------------------------------------------------------------------- /docs/.pages: -------------------------------------------------------------------------------- 1 | arrange: 2 | - index.md 3 | - get-started 4 | - get-details 5 | - sdks 6 | - rest-apis 7 | - clis 8 | - run-a-node 9 | - about.md -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokit_v2_demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokit_v2_demo.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokitv2_json.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokitv2_json.png -------------------------------------------------------------------------------- /docs/get-details/dapps/writing-contracts/.pages: -------------------------------------------------------------------------------- 1 | title: Writing Smart Contracts 2 | 3 | arrange: 4 | - python.md 5 | - pyteal.md 6 | - beaker.md 7 | -------------------------------------------------------------------------------- /docs/run-a-node/reference/.pages: -------------------------------------------------------------------------------- 1 | title: Node reference 2 | arrange: 3 | - artifacts.md 4 | - config.md 5 | - relay.md 6 | - telemetry-config.md 7 | -------------------------------------------------------------------------------- /docs/run-a-node/setup/.pages: -------------------------------------------------------------------------------- 1 | title: Installation Guide 2 | arrange: 3 | - types.md 4 | - install.md 5 | - indexer.md 6 | - node-troubleshooting.md 7 | -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokitartifacts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokitartifacts.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokitplayground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokitplayground.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokitv2_starter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokitv2_starter.png -------------------------------------------------------------------------------- /docs/imgs/walletconnect-establishing-connection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/imgs/walletconnect-establishing-connection.png -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/dappflow_transaction.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/dappflow_transaction.png -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/images/lifecycle.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/utils/ts/images/lifecycle.jpg -------------------------------------------------------------------------------- /docs/get-details/transactions/.pages: -------------------------------------------------------------------------------- 1 | title: Transactions 2 | arrange: 3 | - index.md 4 | - signatures.md 5 | - offline_transactions.md 6 | - payment_prompts.md -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_amount_spec.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/amount.spec 2 | 3 | # Module: types/amount.spec 4 | -------------------------------------------------------------------------------- /docs/get-details/dapps/smart-contracts/apps/.pages: -------------------------------------------------------------------------------- 1 | title: Smart contracts 2 | 3 | arrange: 4 | - index.md 5 | - create.md 6 | - txs.md 7 | - state.md 8 | - innertx.md -------------------------------------------------------------------------------- /docs/get-details/dapps/writing-contracts/python.md: -------------------------------------------------------------------------------- 1 | title: Python 2 | 3 | Follow [this](https://algorandfoundation.github.io/puya/) link for the Algorand Python GitHub docs. 4 | -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/lifecycle.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/lifecycle.jpg -------------------------------------------------------------------------------- /docs/get-started/basics/.pages: -------------------------------------------------------------------------------- 1 | title: Blockchain basics 2 | arrange: 3 | - what_is_blockchain.md 4 | - why_algorand.md 5 | - whats_a_dapp.md 6 | - where_to_start.md -------------------------------------------------------------------------------- /docs/run-a-node/participate/.pages: -------------------------------------------------------------------------------- 1 | title: Participate in consensus 2 | arrange: 3 | - index.md 4 | - generate_keys.md 5 | - online.md 6 | - offline.md 7 | - renew.md 8 | -------------------------------------------------------------------------------- /docs/get-details/algokit/imgs/algokit-intro-video-thumbnail.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/imgs/algokit-intro-video-thumbnail.jpg -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | site/ 2 | *~ 3 | *# 4 | .DS_Store 5 | 6 | # Environments 7 | .env 8 | .venv 9 | env/ 10 | venv/ 11 | ENV/ 12 | env.bak/ 13 | venv.bak/ 14 | .vscode/ 15 | .idea 16 | 17 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_app_client_spec.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/app-client.spec 2 | 3 | # Module: types/app-client.spec 4 | -------------------------------------------------------------------------------- /docs/get-details/algokit/.pages: -------------------------------------------------------------------------------- 1 | title: AlgoKit 2 | 3 | arrange: 4 | - index.md 5 | - features 6 | - utils 7 | - cli-reference.md 8 | - tutorials 9 | - architecture-decisions 10 | - articles -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_dispenser_client_spec.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/dispenser-client.spec 2 | 3 | # Module: types/dispenser-client.spec 4 | -------------------------------------------------------------------------------- /docs/get-details/dapps/smart-contracts/.pages: -------------------------------------------------------------------------------- 1 | title: Smart contracts and signatures 2 | 3 | arrange: 4 | - index.md 5 | - apps 6 | - smartsigs 7 | - ABI 8 | - frontend 9 | - debugging.md 10 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/.pages: -------------------------------------------------------------------------------- 1 | title: TypeScript 2 | 3 | arrange: 4 | - index.md 5 | - capabilities 6 | - codetitle: Python 7 | 8 | arrange: 9 | - index.md 10 | - capabilities 11 | - client_generator.md 12 | - code -------------------------------------------------------------------------------- /docs/get-details/dapps/avm/teal/guidelines.md: -------------------------------------------------------------------------------- 1 | title: Guidelines 2 | 3 | See [Modern guidelines for smart contracts and smart signatures on Algorand](../../../smart-contracts/guidelines/) for details on writting safe smart contracts. 4 | -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/assets/2024-01-13_native_binaries/image_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/assets/2024-01-13_native_binaries/image_1.png -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/assets/2024-01-13_native_binaries/image_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/assets/2024-01-13_native_binaries/image_2.png -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/py/.pages: -------------------------------------------------------------------------------- 1 | title: Python 2 | 3 | arrange: 4 | - index.md 5 | - capabilities 6 | - apidocs.mdtitle: TypeScript 7 | 8 | arrange: 9 | - index.md 10 | - capabilities 11 | - client_generator.md 12 | - apidocs.md -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/scenario_1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/scenario_1.jpg -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/scenario_2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/scenario_2.jpg -------------------------------------------------------------------------------- /docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/modular_templates.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/algorandfoundation/docs/HEAD/docs/get-details/algokit/architecture-decisions/assets/2023-06-06_frontend-templates/modular_templates.jpg -------------------------------------------------------------------------------- /docs/get-details/dapps/avm/teal/opcodes/.pages: -------------------------------------------------------------------------------- 1 | title: Opcodes 2 | arrange: 3 | - index.md 4 | - v12.md 5 | - v11.md 6 | - v10.md 7 | - v9.md 8 | - v8.md 9 | - v7.md 10 | - v6.md 11 | - v5.md 12 | - v4.md 13 | - v3.md 14 | - v2.md 15 | - v1.md 16 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_amount.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/amount 2 | 3 | # Module: types/amount 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [AlgoAmount](../classes/types_amount.AlgoAmount.md) 10 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_config.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/config 2 | 3 | # Module: types/config 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [UpdatableConfig](../classes/types_config.UpdatableConfig.md) 10 | 11 | ### Interfaces 12 | 13 | - [Config](../interfaces/types_config.Config.md) 14 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_algo_http_client_with_retry.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/algo-http-client-with-retry 2 | 3 | # Module: types/algo-http-client-with-retry 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [AlgoHttpClientWithRetry](../classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md) 10 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_network_client.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/network-client 2 | 3 | # Module: types/network-client 4 | 5 | ## Table of contents 6 | 7 | ### Interfaces 8 | 9 | - [AlgoClientConfig](../interfaces/types_network_client.AlgoClientConfig.md) 10 | - [AlgoConfig](../interfaces/types_network_client.AlgoConfig.md) 11 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_logic_error.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/logic-error 2 | 3 | # Module: types/logic-error 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [LogicError](../classes/types_logic_error.LogicError.md) 10 | 11 | ### Interfaces 12 | 13 | - [LogicErrorDetails](../interfaces/types_logic_error.LogicErrorDetails.md) 14 | -------------------------------------------------------------------------------- /scripts/algod_specfile_processors: -------------------------------------------------------------------------------- 1 | jq '.definitions.Account.properties.thisassettotal += {"type":"object", "additionalProperties":{"$ref": "#/definitions/AssetParams"}}' {specfile} 2 | jq '.definitions.Account.properties.assets += {"type":"object", "additionalProperties":{"$ref": "#/definitions/AssetHolding"}}' {specfile} 3 | jq '.definitions.Account.properties.thisassettotal.description |= sub("AssetParams"; "ThisAssetTotal")' {specfile} 4 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_asset.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/asset 2 | 3 | # Module: types/asset 4 | 5 | ## Table of contents 6 | 7 | ### Interfaces 8 | 9 | - [AssetBulkOptInOutParams](../interfaces/types_asset.AssetBulkOptInOutParams.md) 10 | - [AssetOptInParams](../interfaces/types_asset.AssetOptInParams.md) 11 | - [AssetOptOutParams](../interfaces/types_asset.AssetOptOutParams.md) 12 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: "Build workflow" 2 | on: [pull_request] 3 | jobs: 4 | build-test: 5 | runs-on: ubuntu-20.04 6 | container: python:3.9-slim 7 | steps: 8 | - name: Check out code 9 | uses: actions/checkout@v2 10 | with: 11 | fetch-depth: 0 12 | - name: Install pip dependencies 13 | run: pip install -r requirements.txt 14 | - name: Build 15 | run: mkdocs build 16 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_urlTokenBaseHTTPClient.CustomTokenHeader.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md) / CustomTokenHeader 2 | 3 | # Interface: CustomTokenHeader 4 | 5 | [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md).CustomTokenHeader 6 | 7 | ## Indexable 8 | 9 | ▪ [headerName: `string`]: `string` 10 | -------------------------------------------------------------------------------- /scripts/contains_doc_changes.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Helper to determine if there are any doc changes based on the git diff: 4 | # 5 | # ./contains_doc_changes.sh 6 | # if [ $? -ne 0 ]; then 7 | # echo "has changes!" 8 | # fi 9 | 10 | IFS=$'\n' 11 | for line in $(git diff -U0 | grep '^[+-]' | grep -Ev '^(--- a/|\+\+\+ b/)'); do 12 | if [[ $line != *"Auto generated by spf13/cobra on "* ]]; then 13 | echo "exit with 1" 14 | exit 1 15 | fi 16 | done 17 | 18 | exit 0 19 | -------------------------------------------------------------------------------- /docs/get-details/dapps/avm/teal/opcodes/index.md: -------------------------------------------------------------------------------- 1 | title: Opcodes By Version 2 | 3 | This page lists the TEAL opcodes by version. For more information on TEAL, see the [TEAL specification](../specification/). 4 | 5 | Opcodes by version: 6 | 7 | - [v12 - Current version on Mainnet](v12.md) 8 | - [v11](v11.md) 9 | - [v10](v10.md) 10 | - [v9](v9.md) 11 | - [v8](v8.md) 12 | - [v7](v7.md) 13 | - [v6](v6.md) 14 | - [v5](v5.md) 15 | - [v4](v4.md) 16 | - [v3](v3.md) 17 | - [v2](v2.md) 18 | - [v1](v1.md) 19 | -------------------------------------------------------------------------------- /docs/get-details/algorand-networks/mainnet.md: -------------------------------------------------------------------------------- 1 | title: MainNet 2 | 3 | # Version 4 | `v4.3.0-stable` 5 | 6 | # Release Version 7 | https://github.com/algorand/go-algorand/releases/tag/v4.3.0-stable 8 | 9 | # Genesis ID 10 | `mainnet-v1.0` 11 | 12 | # Genesis Hash 13 | `wGHE2Pwdvd7S12BL5FaOP20EGYesN73ktiC1qzkkit8=` 14 | 15 | # FeeSink Address 16 | `Y76M3MSY6DKBRHBL7C3NNDXGS5IIMQVQVUAB6MP4XEMMGVF2QWNPL226CA` 17 | 18 | # RewardsPool Address 19 | `737777777777777777777777777777777777777777777777777UFEJ2CI` 20 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/diagcfg.md: -------------------------------------------------------------------------------- 1 | title: diagcfg 2 | --- 3 | ## diagcfg 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | ``` 12 | 13 | diagcfg [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for diagcfg 26 | 27 | ``` 28 | 29 | 30 | 31 | ### SEE ALSO 32 | 33 | 34 | 35 | * [diagcfg metric](../metric/metric/) - Control and manage Algorand metrics 36 | * [diagcfg telemetry](../telemetry/telemetry/) - Control and manage Algorand logging 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /docs/get-details/.pages: -------------------------------------------------------------------------------- 1 | title: Get details 2 | 3 | arrange: 4 | - index.md 5 | - algokit 6 | - accounts 7 | - transactions 8 | - atomic_transfers.md 9 | - atc.md 10 | - asa.md 11 | - dapps 12 | - indexer.md 13 | - conduit.md 14 | - stateproofs 15 | - encoding.md 16 | - parameter_tables.md 17 | - algorand-networks 18 | - algorand_consensus.md 19 | - technical_faq.md 20 | - useful_resources.md 21 | - ethereum_to_algorand.md 22 | - crust.md 23 | -------------------------------------------------------------------------------- /docs/clis/algokey/part/info.md: -------------------------------------------------------------------------------- 1 | title: algokey part info 2 | --- 3 | ## algokey part info 4 | 5 | 6 | 7 | Print participation key information 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey part info [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for info 26 | 27 | --keyfile string Participation key filename 28 | 29 | ``` 30 | 31 | 32 | 33 | ### SEE ALSO 34 | 35 | 36 | 37 | * [algokey part](../../part/part/) - Manage participation keys 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.AppState.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / AppState 2 | 3 | # Interface: AppState 4 | 5 | [types/app](../modules/types_app.md).AppState 6 | 7 | Object holding app state values 8 | 9 | ## Indexable 10 | 11 | ▪ [key: `string`]: \{ `keyBase64`: `string` ; `keyRaw`: `Uint8Array` ; `value`: `number` \| `bigint` } \| \{ `keyBase64`: `string` ; `keyRaw`: `Uint8Array` ; `value`: `string` ; `valueBase64`: `string` ; `valueRaw`: `Uint8Array` } 12 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.TealTemplateParams.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / TealTemplateParams 2 | 3 | # Interface: TealTemplateParams 4 | 5 | [types/app](../modules/types_app.md).TealTemplateParams 6 | 7 | Dictionary of deploy-time parameters to replace in a teal template. 8 | 9 | Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`. 10 | 11 | ## Indexable 12 | 13 | ▪ [key: `string`]: `string` \| `bigint` \| `number` \| `Uint8Array` 14 | -------------------------------------------------------------------------------- /docs/about.md: -------------------------------------------------------------------------------- 1 | title: About 2 | 3 | # License 4 | 5 | The Algorand Developer Documentation is licensed under an [MIT license](https://github.com/algorand/docs/blob/master/LICENSE.md). 6 | 7 | # Contributing 8 | 9 | Learn how you can contribute by reading the [Contributing Guide](https://github.com/algorand/docs/blob/master/CONTRIBUTING.md) located in the [docs repository](https://github.com/algorand/docs) on Github. 10 | 11 | # Attributions 12 | 13 | This documentation uses [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). -------------------------------------------------------------------------------- /docs/clis/algokey/generate.md: -------------------------------------------------------------------------------- 1 | title: algokey generate 2 | --- 3 | ## algokey generate 4 | 5 | 6 | 7 | Generate key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey generate [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for generate 26 | 27 | -f, --keyfile string Private key filename 28 | 29 | -p, --pubkeyfile string Public key filename 30 | 31 | ``` 32 | 33 | 34 | 35 | ### SEE ALSO 36 | 37 | 38 | 39 | * [algokey](../../algokey/algokey/) - CLI for managing Algorand keys 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/clis/algokey/import.md: -------------------------------------------------------------------------------- 1 | title: algokey import 2 | --- 3 | ## algokey import 4 | 5 | 6 | 7 | Import key file from mnemonic 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey import [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for import 26 | 27 | -f, --keyfile string Private key filename 28 | 29 | -m, --mnemonic string Private key mnemonic 30 | 31 | ``` 32 | 33 | 34 | 35 | ### SEE ALSO 36 | 37 | 38 | 39 | * [algokey](../../algokey/algokey/) - CLI for managing Algorand keys 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Algorand Developer Documentation (Official) 2 | 3 | This is the official repository for the [Algorand Developer Documentation](https://developer.algorand.org/docs/) hosted on the [Algorand Developer Portal](https://developer.algorand.org/). 4 | 5 | ## Contributing 6 | Learn how you can contribute in our [Guide to Contributing](./CONTRIBUTING.md). 7 | 8 | ## License 9 | 10 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 11 | 12 | The documentation is licensed under an MIT license. See [LICENSE file](./LICENSE.md) for details. -------------------------------------------------------------------------------- /docs/clis/algokey/export.md: -------------------------------------------------------------------------------- 1 | title: algokey export 2 | --- 3 | ## algokey export 4 | 5 | 6 | 7 | Export key file to mnemonic and public key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey export [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for export 26 | 27 | -f, --keyfile string Private key filename 28 | 29 | -p, --pubkeyfile string Public key filename 30 | 31 | ``` 32 | 33 | 34 | 35 | ### SEE ALSO 36 | 37 | 38 | 39 | * [algokey](../../algokey/algokey/) - CLI for managing Algorand keys 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/small-improvements-for-clarity-of-message.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Small Improvements for Clarity of Message 3 | about: Suggestions on how to improve wording or code. 4 | title: '' 5 | labels: documentation 6 | assignees: '' 7 | 8 | --- 9 | 10 | **The current state** 11 | Link to or copy and paste the portion of text or code that you think should be changed. 12 | 13 | **The proposed state** 14 | Tell us how it should be changed. Provide the exact wording or code if possible. 15 | 16 | **Provide any additional context** 17 | Add any other context or screenshots about the proposed update here. 18 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_transfer.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/transfer 2 | 3 | # Module: types/transfer 4 | 5 | ## Table of contents 6 | 7 | ### Interfaces 8 | 9 | - [AlgoRekeyParams](../interfaces/types_transfer.AlgoRekeyParams.md) 10 | - [AlgoTransferParams](../interfaces/types_transfer.AlgoTransferParams.md) 11 | - [EnsureFundedParams](../interfaces/types_transfer.EnsureFundedParams.md) 12 | - [EnsureFundedReturnType](../interfaces/types_transfer.EnsureFundedReturnType.md) 13 | - [TransferAssetParams](../interfaces/types_transfer.TransferAssetParams.md) 14 | -------------------------------------------------------------------------------- /docs/clis/algokey/part/reparent.md: -------------------------------------------------------------------------------- 1 | title: algokey part reparent 2 | --- 3 | ## algokey part reparent 4 | 5 | 6 | 7 | Change parent address of participation key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey part reparent [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for reparent 26 | 27 | --keyfile string Participation key filename 28 | 29 | --parent string Address of parent account 30 | 31 | ``` 32 | 33 | 34 | 35 | ### SEE ALSO 36 | 37 | 38 | 39 | * [algokey part](../../part/part/) - Manage participation keys 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /scripts/example_tracker/list_examples.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | echo "Looking for SDK example names in docs" 4 | grep -r 'JSSDK_' ../../docs |awk -F= '{print $4}' |cut -f 2- -d '_' |sort |uniq > js_examples.txt 5 | grep -r 'PYSDK_' ../../docs |awk -F= '{print $4}' |cut -f 2- -d '_' |sort |uniq > py_examples.txt 6 | grep -r 'JAVASDK_' ../../docs |awk -F= '{print $4}' |cut -f 2- -d '_' |sort |uniq > java_examples.txt 7 | grep -r 'GOSDK_' ../../docs |awk -F= '{print $4}' |cut -f 2- -d '_' |sort |uniq > go_examples.txt 8 | 9 | 10 | echo "Looking at counts of each (they should all be 4, one for each sdk)" 11 | cat ./*.txt | sort | uniq -c | sort -n -r 12 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_dispenser_client.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/dispenser-client 2 | 3 | # Module: types/dispenser-client 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [TestNetDispenserApiClient](../classes/types_dispenser_client.TestNetDispenserApiClient.md) 10 | 11 | ### Interfaces 12 | 13 | - [DispenserFundResponse](../interfaces/types_dispenser_client.DispenserFundResponse.md) 14 | - [DispenserLimitResponse](../interfaces/types_dispenser_client.DispenserLimitResponse.md) 15 | - [TestNetDispenserApiClientParams](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) 16 | -------------------------------------------------------------------------------- /docs/clis/conduit/list/exporters.md: -------------------------------------------------------------------------------- 1 | title: conduit list exporters 2 | --- 3 | ## conduit list exporters 4 | 5 | 6 | 7 | Usage details for exporter plugins. 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Usage details for exporter plugins. Pass in a specific plugin as a positional argument for a sample configuration file. 16 | 17 | 18 | 19 | ``` 20 | 21 | conduit list exporters [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for exporters 34 | 35 | ``` 36 | 37 | 38 | 39 | ### SEE ALSO 40 | 41 | 42 | 43 | * [conduit list](../../list/list/) - List all available Conduit plugins 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /docs/clis/conduit/list/importers.md: -------------------------------------------------------------------------------- 1 | title: conduit list importers 2 | --- 3 | ## conduit list importers 4 | 5 | 6 | 7 | Usage details for importer plugins. 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Usage details for importer plugins. Pass in a specific plugin as a positional argument for a sample configuration file. 16 | 17 | 18 | 19 | ``` 20 | 21 | conduit list importers [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for importers 34 | 35 | ``` 36 | 37 | 38 | 39 | ### SEE ALSO 40 | 41 | 42 | 43 | * [conduit list](../../list/list/) - List all available Conduit plugins 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /docs/clis/goal/license.md: -------------------------------------------------------------------------------- 1 | title: goal license 2 | --- 3 | ## goal license 4 | 5 | 6 | 7 | Display license information 8 | 9 | 10 | 11 | ``` 12 | 13 | goal license [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for license 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal](../../goal/goal/) - CLI for interacting with Algorand 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/conduit/list/processors.md: -------------------------------------------------------------------------------- 1 | title: conduit list processors 2 | --- 3 | ## conduit list processors 4 | 5 | 6 | 7 | Usage details for processor plugins. 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Usage details for processor plugins. Pass in a specific plugin as a positional argument for a sample configuration file. 16 | 17 | 18 | 19 | ``` 20 | 21 | conduit list processors [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for processors 34 | 35 | ``` 36 | 37 | 38 | 39 | ### SEE ALSO 40 | 41 | 42 | 43 | * [conduit list](../../list/list/) - List all available Conduit plugins 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /docs/clis/goal/node/stop.md: -------------------------------------------------------------------------------- 1 | title: goal node stop 2 | --- 3 | ## goal node stop 4 | 5 | 6 | 7 | Stop the specified Algorand node 8 | 9 | 10 | 11 | ``` 12 | 13 | goal node stop [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for stop 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal node](../../node/node/) - Manage a specified algorand node 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/goal/kmd/stop.md: -------------------------------------------------------------------------------- 1 | title: goal kmd stop 2 | --- 3 | ## goal kmd stop 4 | 5 | 6 | 7 | Stop the kmd process if it is running 8 | 9 | 10 | 11 | ``` 12 | 13 | goal kmd stop [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for stop 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal kmd](../../kmd/kmd/) - Interact with kmd, the key management daemon 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_testing.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/testing 2 | 3 | # Module: types/testing 4 | 5 | ## Table of contents 6 | 7 | ### Interfaces 8 | 9 | - [AlgoKitLogCaptureFixture](../interfaces/types_testing.AlgoKitLogCaptureFixture.md) 10 | - [AlgorandFixture](../interfaces/types_testing.AlgorandFixture.md) 11 | - [AlgorandFixtureConfig](../interfaces/types_testing.AlgorandFixtureConfig.md) 12 | - [AlgorandTestAutomationContext](../interfaces/types_testing.AlgorandTestAutomationContext.md) 13 | - [GetTestAccountParams](../interfaces/types_testing.GetTestAccountParams.md) 14 | - [LogSnapshotConfig](../interfaces/types_testing.LogSnapshotConfig.md) 15 | -------------------------------------------------------------------------------- /docs/clis/algokey/sign.md: -------------------------------------------------------------------------------- 1 | title: algokey sign 2 | --- 3 | ## algokey sign 4 | 5 | 6 | 7 | Sign transactions from a file using a private key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey sign [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for sign 26 | 27 | -k, --keyfile string Private key filename 28 | 29 | -m, --mnemonic string Private key mnemonic 30 | 31 | -o, --outfile string Transaction output filename 32 | 33 | -t, --txfile string Transaction input filename 34 | 35 | ``` 36 | 37 | 38 | 39 | ### SEE ALSO 40 | 41 | 42 | 43 | * [algokey](../../algokey/algokey/) - CLI for managing Algorand keys 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/fixing-errors-or-inaccuracies.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Fixing Errors or Inaccuracies 3 | about: Tell us where there is an error or inaccurate information in the docs. 4 | title: '' 5 | labels: minor update 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the error** 11 | A clear and concise description of what the error is. 12 | 13 | **Link to the page or line** 14 | Link to the page and line/s if applicable either in the markdown version or on the site itself. 15 | 16 | **Optional - The recommended fix if you have one** 17 | If you know what the change should be, tell us here. 18 | 19 | **Optional - Supporting Screenshots** 20 | Any accompanying screenshots that will help us identify the problem or the fix. 21 | -------------------------------------------------------------------------------- /docs/clis/goal/completion/zsh.md: -------------------------------------------------------------------------------- 1 | title: goal completion zsh 2 | --- 3 | ## goal completion zsh 4 | 5 | 6 | 7 | Generate zsh completion commands 8 | 9 | 10 | 11 | ``` 12 | 13 | goal completion zsh [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for zsh 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal completion](../../completion/completion/) - Shell completion helper 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/goal/completion/bash.md: -------------------------------------------------------------------------------- 1 | title: goal completion bash 2 | --- 3 | ## goal completion bash 4 | 5 | 6 | 7 | Generate bash completion commands 8 | 9 | 10 | 11 | ``` 12 | 13 | goal completion bash [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for bash 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal completion](../../completion/completion/) - Shell completion helper 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/goal/logging/disable.md: -------------------------------------------------------------------------------- 1 | title: goal logging disable 2 | --- 3 | ## goal logging disable 4 | 5 | 6 | 7 | Disable Algorand remote logging 8 | 9 | 10 | 11 | ``` 12 | 13 | goal logging disable [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for disable 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal logging](../../logging/logging/) - Control and manage Algorand logging 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/goal/wallet/list.md: -------------------------------------------------------------------------------- 1 | title: goal wallet list 2 | --- 3 | ## goal wallet list 4 | 5 | 6 | 7 | List wallets managed by kmd 8 | 9 | 10 | 11 | ``` 12 | 13 | goal wallet list [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for list 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal wallet](../../wallet/wallet/) - Manage wallets: encrypted collections of Algorand account keys 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/indexer/api-config.md: -------------------------------------------------------------------------------- 1 | title: indexer api-config 2 | --- 3 | ## indexer api-config 4 | 5 | 6 | 7 | api configuration 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | api configuration 16 | 17 | 18 | 19 | ``` 20 | 21 | indexer api-config [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | --all show all api config parameters, enabled and disabled 34 | 35 | --api-config-file string supply an API config file to enable/disable parameters 36 | 37 | -h, --help help for api-config 38 | 39 | ``` 40 | 41 | 42 | 43 | ### SEE ALSO 44 | 45 | 46 | 47 | * [indexer](../../indexer/indexer/) - Algorand Indexer 48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /docs/clis/goal/node/generatetoken.md: -------------------------------------------------------------------------------- 1 | title: goal node generatetoken 2 | --- 3 | ## goal node generatetoken 4 | 5 | 6 | 7 | Generate and install a new API token 8 | 9 | 10 | 11 | ``` 12 | 13 | goal node generatetoken [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for generatetoken 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal node](../../node/node/) - Manage a specified algorand node 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/goal/report.md: -------------------------------------------------------------------------------- 1 | title: goal report 2 | --- 3 | ## goal report 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Produces report helpful for debugging. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal report [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for report 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal](../../goal/goal/) - CLI for interacting with Algorand 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_dispenser_client.DispenserLimitResponse.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / DispenserLimitResponse 2 | 3 | # Interface: DispenserLimitResponse 4 | 5 | [types/dispenser-client](../modules/types_dispenser_client.md).DispenserLimitResponse 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [amount](types_dispenser_client.DispenserLimitResponse.md#amount) 12 | 13 | ## Properties 14 | 15 | ### amount 16 | 17 | • **amount**: `number` 18 | 19 | #### Defined in 20 | 21 | [src/types/dispenser-client.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L23) 22 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/metric/status.md: -------------------------------------------------------------------------------- 1 | title: diagcfg metric status 2 | --- 3 | ## diagcfg metric status 4 | 5 | 6 | 7 | Print the node's metric status 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Print the node's metric status 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg metric status -d dataDir [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for status 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --dataDir string Data directory 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg metric](../../metric/metric/) - Control and manage Algorand metrics 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/metric/enable.md: -------------------------------------------------------------------------------- 1 | title: diagcfg metric enable 2 | --- 3 | ## diagcfg metric enable 4 | 5 | 6 | 7 | Enable metric collection on node 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable metric collection on node 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg metric enable -d dataDir [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for enable 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --dataDir string Data directory 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg metric](../../metric/metric/) - Control and manage Algorand metrics 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/metric/disable.md: -------------------------------------------------------------------------------- 1 | title: diagcfg metric disable 2 | --- 3 | ## diagcfg metric disable 4 | 5 | 6 | 7 | Disable metric collection on node 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Disable metric collection on node 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg metric disable -d dataDir [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for disable 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --dataDir string Data directory 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg metric](../../metric/metric/) - Control and manage Algorand metrics 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/clis/goal/wallet/rename.md: -------------------------------------------------------------------------------- 1 | title: goal wallet rename 2 | --- 3 | ## goal wallet rename 4 | 5 | 6 | 7 | Rename wallet 8 | 9 | 10 | 11 | ``` 12 | 13 | goal wallet rename [wallet name] [new wallet name] [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for rename 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal wallet](../../wallet/wallet/) - Manage wallets: encrypted collections of Algorand account keys 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /docs/clis/algokey/part/part.md: -------------------------------------------------------------------------------- 1 | title: algokey part 2 | --- 3 | ## algokey part 4 | 5 | 6 | 7 | Manage participation keys 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey part [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for part 26 | 27 | ``` 28 | 29 | 30 | 31 | ### SEE ALSO 32 | 33 | 34 | 35 | * [algokey](../../../algokey/algokey/) - CLI for managing Algorand keys 36 | * [algokey part generate](../generate/) - Generate participation key 37 | * [algokey part info](../info/) - Print participation key information 38 | * [algokey part keyreg](../keyreg/) - Make key registration transaction 39 | * [algokey part reparent](../reparent/) - Change parent address of participation key 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/clis/goal/version.md: -------------------------------------------------------------------------------- 1 | title: goal version 2 | --- 3 | ## goal version 4 | 5 | 6 | 7 | The current version of the Algorand daemon (algod) 8 | 9 | 10 | 11 | ``` 12 | 13 | goal version [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for version 26 | 27 | -v, --verbose Print all version info available 28 | 29 | ``` 30 | 31 | 32 | 33 | ### Options inherited from parent commands 34 | 35 | 36 | 37 | ``` 38 | 39 | -d, --datadir stringArray Data directory for the node 40 | 41 | -k, --kmddir string Data directory for kmd 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal](../../goal/goal/) - CLI for interacting with Algorand 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/clis/goal/protocols.md: -------------------------------------------------------------------------------- 1 | title: goal protocols 2 | --- 3 | ## goal protocols 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Dump standard consensus protocols as json to stdout. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal protocols [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for protocols 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal](../../goal/goal/) - CLI for interacting with Algorand 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/enable.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry enable 2 | --- 3 | ## diagcfg telemetry enable 4 | 5 | 6 | 7 | Enable Algorand remote logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable Algorand remote logging 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry enable [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for enable 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir string Data directory for the node 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg telemetry](../../telemetry/telemetry/) - Control and manage Algorand logging 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/disable.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry disable 2 | --- 3 | ## diagcfg telemetry disable 4 | 5 | 6 | 7 | Disable Algorand remote logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Disable Algorand remote logging 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry disable [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for disable 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir string Data directory for the node 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg telemetry](../../telemetry/telemetry/) - Control and manage Algorand logging 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/status.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry status 2 | --- 3 | ## diagcfg telemetry status 4 | 5 | 6 | 7 | Print the node's telemetry status 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Print the node's telemetry status 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry status [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for status 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir string Data directory for the node 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [diagcfg telemetry](../../telemetry/telemetry/) - Control and manage Algorand logging 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_urlTokenBaseHTTPClient.KMDTokenHeader.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md) / KMDTokenHeader 2 | 3 | # Interface: KMDTokenHeader 4 | 5 | [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md).KMDTokenHeader 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [X-KMD-API-Token](types_urlTokenBaseHTTPClient.KMDTokenHeader.md#x-kmd-api-token) 12 | 13 | ## Properties 14 | 15 | ### X-KMD-API-Token 16 | 17 | • **X-KMD-API-Token**: `string` 18 | 19 | #### Defined in 20 | 21 | [src/types/urlTokenBaseHTTPClient.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L17) 22 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_debugging.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/debugging 2 | 3 | # Module: types/debugging 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [AVMDebuggerSourceMap](../classes/types_debugging.AVMDebuggerSourceMap.md) 10 | - [AVMDebuggerSourceMapEntry](../classes/types_debugging.AVMDebuggerSourceMapEntry.md) 11 | - [PersistSourceMapInput](../classes/types_debugging.PersistSourceMapInput.md) 12 | 13 | ### Interfaces 14 | 15 | - [AVMDebuggerSourceMapDict](../interfaces/types_debugging.AVMDebuggerSourceMapDict.md) 16 | - [PersistSourceMapsParams](../interfaces/types_debugging.PersistSourceMapsParams.md) 17 | - [SimulateAndPersistResponseParams](../interfaces/types_debugging.SimulateAndPersistResponseParams.md) 18 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_urlTokenBaseHTTPClient.AlgodTokenHeader.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md) / AlgodTokenHeader 2 | 3 | # Interface: AlgodTokenHeader 4 | 5 | [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md).AlgodTokenHeader 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [X-Algo-API-Token](types_urlTokenBaseHTTPClient.AlgodTokenHeader.md#x-algo-api-token) 12 | 13 | ## Properties 14 | 15 | ### X-Algo-API-Token 16 | 17 | • **X-Algo-API-Token**: `string` 18 | 19 | #### Defined in 20 | 21 | [src/types/urlTokenBaseHTTPClient.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L9) 22 | -------------------------------------------------------------------------------- /docs/clis/indexer/indexer.md: -------------------------------------------------------------------------------- 1 | title: indexer 2 | --- 3 | ## indexer 4 | 5 | 6 | 7 | Algorand Indexer 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Indexer imports blocks from an algod node into an SQL database for querying. It is a daemon that can serve queries from that database. 16 | 17 | 18 | 19 | ``` 20 | 21 | indexer [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for indexer 34 | 35 | -v, --version print version and exit 36 | 37 | ``` 38 | 39 | 40 | 41 | ### SEE ALSO 42 | 43 | 44 | 45 | * [indexer api-config](../api-config/) - api configuration 46 | * [indexer daemon](../daemon/) - run indexer daemon 47 | * [indexer util](../util/util/) - Utilities for testing Indexer operation and correctness. 48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /docs/clis/goal/ledger/ledger.md: -------------------------------------------------------------------------------- 1 | title: goal ledger 2 | --- 3 | ## goal ledger 4 | 5 | 6 | 7 | Access ledger-related details 8 | 9 | 10 | 11 | ``` 12 | 13 | goal ledger [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for ledger 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 50 | * [goal ledger block](../block/) - Dump a block to a file or stdout 51 | * [goal ledger supply](../supply/) - Show ledger token supply 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_urlTokenBaseHTTPClient.IndexerTokenHeader.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md) / IndexerTokenHeader 2 | 3 | # Interface: IndexerTokenHeader 4 | 5 | [types/urlTokenBaseHTTPClient](../modules/types_urlTokenBaseHTTPClient.md).IndexerTokenHeader 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [X-Indexer-API-Token](types_urlTokenBaseHTTPClient.IndexerTokenHeader.md#x-indexer-api-token) 12 | 13 | ## Properties 14 | 15 | ### X-Indexer-API-Token 16 | 17 | • **X-Indexer-API-Token**: `string` 18 | 19 | #### Defined in 20 | 21 | [src/types/urlTokenBaseHTTPClient.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L13) 22 | -------------------------------------------------------------------------------- /docs/clis/goal/node/lastround.md: -------------------------------------------------------------------------------- 1 | title: goal node lastround 2 | --- 3 | ## goal node lastround 4 | 5 | 6 | 7 | Print the last round number 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Prints the most recent round confirmed by the Algorand node. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node lastround [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for lastround 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal node](../../node/node/) - Manage a specified algorand node 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/goal/network/stop.md: -------------------------------------------------------------------------------- 1 | title: goal network stop 2 | --- 3 | ## goal network stop 4 | 5 | 6 | 7 | Stop a deployed private network 8 | 9 | 10 | 11 | ``` 12 | 13 | goal network stop [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for stop 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | -r, --rootdir string Root directory for the private network directories 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_debugging.AVMDebuggerSourceMapDict.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/debugging](../modules/types_debugging.md) / AVMDebuggerSourceMapDict 2 | 3 | # Interface: AVMDebuggerSourceMapDict 4 | 5 | [types/debugging](../modules/types_debugging.md).AVMDebuggerSourceMapDict 6 | 7 | AVM debugger source map format. 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [txn-group-sources](types_debugging.AVMDebuggerSourceMapDict.md#txn-group-sources) 14 | 15 | ## Properties 16 | 17 | ### txn-group-sources 18 | 19 | • **txn-group-sources**: \{ `hash`: `string` ; `sourcemap-location`: `string` }[] 20 | 21 | #### Defined in 22 | 23 | [src/types/debugging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L8) 24 | -------------------------------------------------------------------------------- /docs/clis/goal/network/restart.md: -------------------------------------------------------------------------------- 1 | title: goal network restart 2 | --- 3 | ## goal network restart 4 | 5 | 6 | 7 | Restart a deployed private network 8 | 9 | 10 | 11 | ``` 12 | 13 | goal network restart [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for restart 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | -r, --rootdir string Root directory for the private network directories 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/clis/goal/completion/completion.md: -------------------------------------------------------------------------------- 1 | title: goal completion 2 | --- 3 | ## goal completion 4 | 5 | 6 | 7 | Shell completion helper 8 | 9 | 10 | 11 | ``` 12 | 13 | goal completion [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for completion 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | ``` 42 | 43 | 44 | 45 | ### SEE ALSO 46 | 47 | 48 | 49 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 50 | * [goal completion bash](../bash/) - Generate bash completion commands 51 | * [goal completion zsh](../zsh/) - Generate zsh completion commands 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/metric/metric.md: -------------------------------------------------------------------------------- 1 | title: diagcfg metric 2 | --- 3 | ## diagcfg metric 4 | 5 | 6 | 7 | Control and manage Algorand metrics 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable/disable and configure Algorand remote logging 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg metric -d dataDir [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -d, --dataDir string Data directory 34 | 35 | -h, --help help for metric 36 | 37 | ``` 38 | 39 | 40 | 41 | ### SEE ALSO 42 | 43 | 44 | 45 | * [diagcfg](../../../diagcfg/diagcfg/) - 46 | * [diagcfg metric disable](../disable/) - Disable metric collection on node 47 | * [diagcfg metric enable](../enable/) - Enable metric collection on node 48 | * [diagcfg metric status](../status/) - Print the node's metric status 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /docs/clis/algokey/part/generate.md: -------------------------------------------------------------------------------- 1 | title: algokey part generate 2 | --- 3 | ## algokey part generate 4 | 5 | 6 | 7 | Generate participation key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey part generate [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | --dilution uint Key dilution for two-level participation keys (defaults to sqrt of validity window) 26 | 27 | --first uint First round for participation key 28 | 29 | -h, --help help for generate 30 | 31 | --keyfile string Participation key filename 32 | 33 | --last uint Last round for participation key 34 | 35 | --parent string Address of parent account 36 | 37 | ``` 38 | 39 | 40 | 41 | ### SEE ALSO 42 | 43 | 44 | 45 | * [algokey part](../../part/part/) - Manage participation keys 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/clis/goal/kmd/start.md: -------------------------------------------------------------------------------- 1 | title: goal kmd start 2 | --- 3 | ## goal kmd start 4 | 5 | 6 | 7 | Start the kmd process, or restart it with an updated timeout 8 | 9 | 10 | 11 | ``` 12 | 13 | goal kmd start [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for start 26 | 27 | -t, --timeout uint Number of seconds after which to shut down kmd if there are no requests; 0 means no timeout 28 | 29 | ``` 30 | 31 | 32 | 33 | ### Options inherited from parent commands 34 | 35 | 36 | 37 | ``` 38 | 39 | -d, --datadir stringArray Data directory for the node 40 | 41 | -k, --kmddir string Data directory for kmd 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal kmd](../../kmd/kmd/) - Interact with kmd, the key management daemon 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/endpoint.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry endpoint 2 | --- 3 | ## diagcfg telemetry endpoint 4 | 5 | 6 | 7 | Sets the "URI" property 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Sets the "URI" property in the telemetry configuration 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry endpoint -e [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -e, --endpoint string Endpoint's URI 34 | 35 | -h, --help help for endpoint 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir string Data directory for the node 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [diagcfg telemetry](../../telemetry/telemetry/) - Control and manage Algorand logging 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/name.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry name 2 | --- 3 | ## diagcfg telemetry name 4 | 5 | 6 | 7 | Enable Algorand remote logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable Algorand remote logging with specified node name 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry name -n nodeName [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for name 34 | 35 | -n, --name string Friendly-name to use for node 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir string Data directory for the node 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [diagcfg telemetry](../../telemetry/telemetry/) - Control and manage Algorand logging 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/goal/network/status.md: -------------------------------------------------------------------------------- 1 | title: goal network status 2 | --- 3 | ## goal network status 4 | 5 | 6 | 7 | Prints status for all nodes in a deployed private network 8 | 9 | 10 | 11 | ``` 12 | 13 | goal network status [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for status 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | -r, --rootdir string Root directory for the private network directories 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/large-additions-or-modifications.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Large Additions or Modifications 3 | about: Request additional sections or significant modifications to existing sections 4 | in the documentation. 5 | title: '' 6 | labels: '' 7 | assignees: '' 8 | 9 | --- 10 | 11 | **Is your addition related to a problem? Please describe.** 12 | A clear and concise description of what the problem is. What confusion does it cause? How does it affect developers? 13 | 14 | **Describe the solution you'd like** 15 | A clear and concise description of what you want to happen. Which section needs to be added/modified? What should it include? 16 | 17 | **Describe alternatives you've considered** 18 | A clear and concise description of any alternative solutions you've considered. 19 | 20 | **Additional context** 21 | Add any other context or screenshots about the documentation request here. 22 | -------------------------------------------------------------------------------- /docs/clis/goal/node/generate-p2pid.md: -------------------------------------------------------------------------------- 1 | title: goal node generate-p2pid 2 | --- 3 | ## goal node generate-p2pid 4 | 5 | 6 | 7 | Generate a new p2p private key 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Generate a new p2p private key (saved to peerIDPrivKey.key) and print out peerID to stdout 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node generate-p2pid [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for generate-p2pid 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal node](../../node/node/) - Manage a specified algorand node 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/kmd.md: -------------------------------------------------------------------------------- 1 | title: kmd 2 | --- 3 | ## kmd 4 | 5 | 6 | 7 | Key Management Daemon (kmd) 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | The Key Management Daemon (kmd) is a low level wallet and key management 16 | 17 | tool. It works in conjunction with algod and goal to keep secrets safe. An 18 | 19 | optional timeout flag will automatically terminate kmd after a number of 20 | 21 | seconds has elapsed, allowing a simple way to ensure kmd will be shutdown in 22 | 23 | a timely manner. This is a blocking command. 24 | 25 | 26 | 27 | ``` 28 | 29 | kmd [flags] 30 | 31 | ``` 32 | 33 | 34 | 35 | ### Options 36 | 37 | 38 | 39 | ``` 40 | 41 | -d, --data-dir string kmd data directory. 42 | 43 | -h, --help help for kmd 44 | 45 | -t, --timout-secs uint Number of seconds that kmd will run for before termination. 46 | 47 | ``` 48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /docs/clis/indexer/util/util.md: -------------------------------------------------------------------------------- 1 | title: indexer util 2 | --- 3 | ## indexer util 4 | 5 | 6 | 7 | Utilities for testing Indexer operation and correctness. 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Utilities used for Indexer development. These are low level tools that may require low level knowledge of Indexer deployment and operation. They are included as part of this binary for ease of deployment and automation, and to publicize their existance to people who may find them useful. More detailed documention may be found on github in README files located the different 'cmd' directories. 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for util 26 | 27 | ``` 28 | 29 | 30 | 31 | ### SEE ALSO 32 | 33 | 34 | 35 | * [indexer](../../../indexer/indexer/) - Algorand Indexer 36 | * [indexer util validator](../validator/) - validator 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /docs/clis/goal/node/status.md: -------------------------------------------------------------------------------- 1 | title: goal node status 2 | --- 3 | ## goal node status 4 | 5 | 6 | 7 | Get the current node status 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Show the current status of the running Algorand node. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node status [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for status 34 | 35 | -w, --watch uint Time (in milliseconds) between two successive status updates 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal node](../../node/node/) - Manage a specified algorand node 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/algokey/algokey.md: -------------------------------------------------------------------------------- 1 | title: algokey 2 | --- 3 | ## algokey 4 | 5 | 6 | 7 | CLI for managing Algorand keys 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for algokey 26 | 27 | -v, --version Display and write current build version and exit 28 | 29 | ``` 30 | 31 | 32 | 33 | ### SEE ALSO 34 | 35 | 36 | 37 | * [algokey export](../export/) - Export key file to mnemonic and public key 38 | * [algokey generate](../generate/) - Generate key 39 | * [algokey import](../import/) - Import key file from mnemonic 40 | * [algokey multisig](../multisig/multisig/) - Add a multisig signature to transactions from a file using a private key 41 | * [algokey part](../part/part/) - Manage participation keys 42 | * [algokey sign](../sign/) - Sign transactions from a file using a private key 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /docs/clis/goal/node/wait.md: -------------------------------------------------------------------------------- 1 | title: goal node wait 2 | --- 3 | ## goal node wait 4 | 5 | 6 | 7 | Waits for the node to make progress 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Waits for the node to make progress, which includes catching up. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node wait [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for wait 34 | 35 | -w, --waittime uint32 Time (in seconds) to wait for node to make progress (default 5) 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal node](../../node/node/) - Manage a specified algorand node 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/algokey/multisig/multisig.md: -------------------------------------------------------------------------------- 1 | title: algokey multisig 2 | --- 3 | ## algokey multisig 4 | 5 | 6 | 7 | Add a multisig signature to transactions from a file using a private key 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey multisig [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for multisig 26 | 27 | -k, --keyfile string Private key filename 28 | 29 | -m, --mnemonic string Private key mnemonic 30 | 31 | -o, --outfile string Transaction output filename 32 | 33 | -t, --txfile string Transaction input filename 34 | 35 | ``` 36 | 37 | 38 | 39 | ### SEE ALSO 40 | 41 | 42 | 43 | * [algokey](../../../algokey/algokey/) - CLI for managing Algorand keys 44 | * [algokey multisig append-auth-addr](../append-auth-addr/) - Adds the necessary fields to a transaction that is sent from an account that was rekeyed to a multisig account 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.AppLookup.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / AppLookup 2 | 3 | # Interface: AppLookup 4 | 5 | [types/app](../modules/types_app.md).AppLookup 6 | 7 | A lookup of name -> Algorand app for a creator 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [apps](types_app.AppLookup.md#apps) 14 | - [creator](types_app.AppLookup.md#creator) 15 | 16 | ## Properties 17 | 18 | ### apps 19 | 20 | • **apps**: `Readonly`\<\{ `[name: string]`: [`AppMetadata`](types_app.AppMetadata.md); }\> 21 | 22 | #### Defined in 23 | 24 | [src/types/app.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254) 25 | 26 | ___ 27 | 28 | ### creator 29 | 30 | • **creator**: `string` 31 | 32 | #### Defined in 33 | 34 | [src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) 35 | -------------------------------------------------------------------------------- /docs/clis/goal/logging/send.md: -------------------------------------------------------------------------------- 1 | title: goal logging send 2 | --- 3 | ## goal logging send 4 | 5 | 6 | 7 | Upload logs and debugging information for analysis 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Upload logs and debugging information to Algorand for analysis. Ledger and wallet data are not included. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal logging send [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -c, --channel string Release channel for log file source 34 | 35 | -h, --help help for send 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal logging](../../logging/logging/) - Control and manage Algorand logging 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /.github/workflows/update-dev-portal.yml: -------------------------------------------------------------------------------- 1 | name: Trigger Documentation Build 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | - staging 8 | 9 | jobs: 10 | trigger-build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Trigger documentation build 14 | run: | 15 | # Set environment based on branch 16 | if [[ "${{ github.ref }}" == "refs/heads/master" ]]; then 17 | ENV="production" 18 | else 19 | ENV="staging" 20 | fi 21 | 22 | # Trigger repository_dispatch event 23 | curl -X POST \ 24 | -H "Authorization: token ${{ secrets.DISPATCH_TOKEN }}" \ 25 | -H "Accept: application/vnd.github.v3+json" \ 26 | -d "{\"event_type\": \"docs_update\", \"client_payload\": {\"ref\": \"${{ github.ref }}\", \"environment\": \"$ENV\"}}" \ 27 | https://api.github.com/repos/algorandfoundation/algorand-developer-portal/dispatches -------------------------------------------------------------------------------- /docs/clis/goal/ledger/supply.md: -------------------------------------------------------------------------------- 1 | title: goal ledger supply 2 | --- 3 | ## goal ledger supply 4 | 5 | 6 | 7 | Show ledger token supply 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Show ledger token supply. All units are in microAlgos. The "Total Money" is all algos held by online+offline accounts (excludes non-participating accounts). The "Online Money" is the amount held solely by online accounts. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal ledger supply [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for supply 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal ledger](../../ledger/ledger/) - Access ledger-related details 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/goal/logging/enable.md: -------------------------------------------------------------------------------- 1 | title: goal logging enable 2 | --- 3 | ## goal logging enable 4 | 5 | 6 | 7 | Enable Algorand remote logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | This will turn on remote logging. The "friendly name" for the node, used by logging, will be determined by -n nodename. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal logging enable -n nodeName [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for enable 34 | 35 | -n, --name string Friendly-name to use for node 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal logging](../../logging/logging/) - Control and manage Algorand logging 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/modules/types_account.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / types/account 2 | 3 | # Module: types/account 4 | 5 | ## Table of contents 6 | 7 | ### Classes 8 | 9 | - [MultisigAccount](../classes/types_account.MultisigAccount.md) 10 | - [SigningAccount](../classes/types_account.SigningAccount.md) 11 | 12 | ### Interfaces 13 | 14 | - [AccountConfig](../interfaces/types_account.AccountConfig.md) 15 | - [TransactionSignerAccount](../interfaces/types_account.TransactionSignerAccount.md) 16 | 17 | ### Variables 18 | 19 | - [DISPENSER\_ACCOUNT](types_account.md#dispenser_account) 20 | 21 | ## Variables 22 | 23 | ### DISPENSER\_ACCOUNT 24 | 25 | • `Const` **DISPENSER\_ACCOUNT**: ``"DISPENSER"`` 26 | 27 | The account name identifier used for fund dispensing in test environments 28 | 29 | #### Defined in 30 | 31 | [src/types/account.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L10) 32 | -------------------------------------------------------------------------------- /docs/clis/goal/wallet/wallet.md: -------------------------------------------------------------------------------- 1 | title: goal wallet 2 | --- 3 | ## goal wallet 4 | 5 | 6 | 7 | Manage wallets: encrypted collections of Algorand account keys 8 | 9 | 10 | 11 | ``` 12 | 13 | goal wallet [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -f, --default string Set the wallet with this name to be the default wallet 26 | 27 | -h, --help help for wallet 28 | 29 | ``` 30 | 31 | 32 | 33 | ### Options inherited from parent commands 34 | 35 | 36 | 37 | ``` 38 | 39 | -d, --datadir stringArray Data directory for the node 40 | 41 | -k, --kmddir string Data directory for kmd 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 52 | * [goal wallet list](../list/) - List wallets managed by kmd 53 | * [goal wallet new](../new/) - Create a new wallet 54 | * [goal wallet rename](../rename/) - Rename wallet 55 | 56 | 57 | 58 | -------------------------------------------------------------------------------- /docs/clis/goal/account/rename.md: -------------------------------------------------------------------------------- 1 | title: goal account rename 2 | --- 3 | ## goal account rename 4 | 5 | 6 | 7 | Change the human-friendly name of an account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Change the human-friendly name of an account. This is a local-only name, it is not stored on the network. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account rename [old name] [new name] [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for rename 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | -w, --wallet string Set the wallet to be used for the selected operation 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal account](../../account/account/) - Control and manage Algorand accounts 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/goal/account/deletepartkey.md: -------------------------------------------------------------------------------- 1 | title: goal account deletepartkey 2 | --- 3 | ## goal account deletepartkey 4 | 5 | 6 | 7 | Delete a participation key 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Delete the indicated participation key. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account deletepartkey [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for deletepartkey 34 | 35 | --partkeyid string Participation Key ID to delete 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/account/partkeyinfo.md: -------------------------------------------------------------------------------- 1 | title: goal account partkeyinfo 2 | --- 3 | ## goal account partkeyinfo 4 | 5 | 6 | 7 | Output details about all available part keys 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Output details about all available part keys in the specified data directory(ies), such as key validity period. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account partkeyinfo [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for partkeyinfo 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | -w, --wallet string Set the wallet to be used for the selected operation 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal account](../../account/account/) - Control and manage Algorand accounts 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/goal/network/delete.md: -------------------------------------------------------------------------------- 1 | title: goal network delete 2 | --- 3 | ## goal network delete 4 | 5 | 6 | 7 | Stops and Deletes a deployed private network 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Stops and Deletes a deployed private network. NOTE: This does not prompt first - so be careful before you do this! 16 | 17 | 18 | 19 | ``` 20 | 21 | goal network delete [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for delete 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | -r, --rootdir string Root directory for the private network directories 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/algokey/multisig/append-auth-addr.md: -------------------------------------------------------------------------------- 1 | title: algokey multisig append-auth-addr 2 | --- 3 | ## algokey multisig append-auth-addr 4 | 5 | 6 | 7 | Adds the necessary fields to a transaction that is sent from an account that was rekeyed to a multisig account 8 | 9 | 10 | 11 | ``` 12 | 13 | algokey multisig append-auth-addr -t [transaction file] -p "[threshold] [Address 1] [Address 2] ..." [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for append-auth-addr 26 | 27 | -o, --outfile string Transaction output filename. If not specified, the original file will be modified 28 | 29 | -p, --params string Multisig pre image parameters - [threshold] [Address 1] [Address 2] ... 30 | 31 | -t, --txfile string Transaction input filename 32 | 33 | ``` 34 | 35 | 36 | 37 | ### SEE ALSO 38 | 39 | 40 | 41 | * [algokey multisig](../../multisig/multisig/) - Add a multisig signature to transactions from a file using a private key 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /docs/clis/goal/node/start.md: -------------------------------------------------------------------------------- 1 | title: goal node start 2 | --- 3 | ## goal node start 4 | 5 | 6 | 7 | Initialize the specified Algorand node 8 | 9 | 10 | 11 | ``` 12 | 13 | goal node start [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for start 26 | 27 | -H, --hosted Run algod hosted by algoh 28 | 29 | -l, --listen string Endpoint / REST address to listen on 30 | 31 | -p, --peer string Peer address to dial for initial connection 32 | 33 | -t, --telemetry string Enable telemetry if supported (Use "true", "false", "0" or "1") 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal node](../../node/node/) - Manage a specified algorand node 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/get-details/algorand-networks/testnet.md: -------------------------------------------------------------------------------- 1 | title: TestNet 2 | 3 | # Version 4 | `v4.3.0-stable` 5 | 6 | # Release Version 7 | https://github.com/algorand/go-algorand/releases/tag/v4.3.0-stable 8 | 9 | # Genesis ID 10 | `testnet-v1.0` 11 | 12 | # Genesis Hash 13 | `SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=` 14 | 15 | # FeeSink Address 16 | `A7NMWS3NT3IUDMLVO26ULGXGIIOUQ3ND2TXSER6EBGRZNOBOUIQXHIBGDE` 17 | 18 | # RewardsPool Address 19 | `7777777777777777777777777777777777777777777777777774MSJUVU` 20 | 21 | # Faucet 22 | 23 | You can dispense algos to your TestNet account by visiting [Algorand TestNet Dispenser](https://dispenser.testnet.aws.algodev.network/). 24 | 25 | Click the Google sign-in link at the top of the Dispenser page and sign-in with your Google account. Complete the reCAPTCHA. Then copy and paste the address you would like to send money to into the empty text box. Click "Dispense". A `200` status code and a transaction ID means success. Run `goal account balance -a ` to view the new balance. 26 | -------------------------------------------------------------------------------- /docs/clis/diagcfg/telemetry/telemetry.md: -------------------------------------------------------------------------------- 1 | title: diagcfg telemetry 2 | --- 3 | ## diagcfg telemetry 4 | 5 | 6 | 7 | Control and manage Algorand logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable/disable and configure Algorand remote logging 16 | 17 | 18 | 19 | ``` 20 | 21 | diagcfg telemetry [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -d, --datadir string Data directory for the node 34 | 35 | -h, --help help for telemetry 36 | 37 | ``` 38 | 39 | 40 | 41 | ### SEE ALSO 42 | 43 | 44 | 45 | * [diagcfg](../../../diagcfg/diagcfg/) - 46 | * [diagcfg telemetry disable](../disable/) - Disable Algorand remote logging 47 | * [diagcfg telemetry enable](../enable/) - Enable Algorand remote logging 48 | * [diagcfg telemetry endpoint](../endpoint/) - Sets the "URI" property 49 | * [diagcfg telemetry name](../name/) - Enable Algorand remote logging 50 | * [diagcfg telemetry status](../status/) - Print the node's telemetry status 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /docs/clis/goal/account/listpartkeys.md: -------------------------------------------------------------------------------- 1 | title: goal account listpartkeys 2 | --- 3 | ## goal account listpartkeys 4 | 5 | 6 | 7 | List participation keys summary 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | List all participation keys tracked by algod along with summary of additional information. For detailed key information use 'partkeyinfo'. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account listpartkeys [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for listpartkeys 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | -w, --wallet string Set the wallet to be used for the selected operation 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal account](../../account/account/) - Control and manage Algorand accounts 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/goal/network/start.md: -------------------------------------------------------------------------------- 1 | title: goal network start 2 | --- 3 | ## goal network start 4 | 5 | 6 | 7 | Start a deployed private network 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Start a deployed private network by starting each individual node. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal network start [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for start 34 | 35 | -n, --node string Specify the name of a specific node to start 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -r, --rootdir string Root directory for the private network directories 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_spec.AppSources.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-spec](../modules/types_app_spec.md) / AppSources 2 | 3 | # Interface: AppSources 4 | 5 | [types/app-spec](../modules/types_app_spec.md).AppSources 6 | 7 | The TEAL source of a contract 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [approval](types_app_spec.AppSources.md#approval) 14 | - [clear](types_app_spec.AppSources.md#clear) 15 | 16 | ## Properties 17 | 18 | ### approval 19 | 20 | • **approval**: `string` 21 | 22 | The TEAL source of the approval program 23 | 24 | #### Defined in 25 | 26 | [src/types/app-spec.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L27) 27 | 28 | ___ 29 | 30 | ### clear 31 | 32 | • **clear**: `string` 33 | 34 | The TEAL source of the clear program 35 | 36 | #### Defined in 37 | 38 | [src/types/app-spec.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L29) 39 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_dispenser_client.DispenserFundResponse.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / DispenserFundResponse 2 | 3 | # Interface: DispenserFundResponse 4 | 5 | [types/dispenser-client](../modules/types_dispenser_client.md).DispenserFundResponse 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [amount](types_dispenser_client.DispenserFundResponse.md#amount) 12 | - [txId](types_dispenser_client.DispenserFundResponse.md#txid) 13 | 14 | ## Properties 15 | 16 | ### amount 17 | 18 | • **amount**: `number` 19 | 20 | #### Defined in 21 | 22 | [src/types/dispenser-client.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L19) 23 | 24 | ___ 25 | 26 | ### txId 27 | 28 | • **txId**: `string` 29 | 30 | #### Defined in 31 | 32 | [src/types/dispenser-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L18) 33 | -------------------------------------------------------------------------------- /docs/clis/goal/logging/logging.md: -------------------------------------------------------------------------------- 1 | title: goal logging 2 | --- 3 | ## goal logging 4 | 5 | 6 | 7 | Control and manage Algorand logging 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Enable/disable and configure Algorand remote logging. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal logging [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for logging 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 58 | * [goal logging disable](../disable/) - Disable Algorand remote logging 59 | * [goal logging enable](../enable/) - Enable Algorand remote logging 60 | * [goal logging send](../send/) - Upload logs and debugging information for analysis 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /docs/clis/goal/node/pendingtxns.md: -------------------------------------------------------------------------------- 1 | title: goal node pendingtxns 2 | --- 3 | ## goal node pendingtxns 4 | 5 | 6 | 7 | Get a snapshot of current pending transactions on this node 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Get a snapshot of current pending transactions on this node, cut off at MAX transactions (-m), default 0. If MAX=0, fetches as many transactions as possible. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node pendingtxns [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for pendingtxns 34 | 35 | -m, --maxPendingTxn uint Cap the number of txns to fetch 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal node](../../node/node/) - Manage a specified algorand node 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/clis/tealdbg/tealdbg.md: -------------------------------------------------------------------------------- 1 | title: tealdbg 2 | --- 3 | ## tealdbg 4 | 5 | 6 | 7 | Algorand TEAL Debugger 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Debug a local or remote TEAL code in controlled environment 16 | 17 | with Web or Chrome DevTools frontends 18 | 19 | 20 | 21 | ``` 22 | 23 | tealdbg [flags] 24 | 25 | ``` 26 | 27 | 28 | 29 | ### Options 30 | 31 | 32 | 33 | ``` 34 | 35 | -f, --frontend string Frontend to use: cdt, web (default "cdt") 36 | 37 | -h, --help help for tealdbg 38 | 39 | --listen string Network interface to listen on (default "127.0.0.1") 40 | 41 | --no-source-map Do not generate source maps 42 | 43 | --remote-debugging-port int Port to listen on (default 9392) 44 | 45 | -v, --verbose Verbose output 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [tealdbg debug](../debug/) off-chain 56 | * [tealdbg remote](../remote/) - Debug TEAL program on-chain 57 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.BoxReference.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / BoxReference 2 | 3 | # Interface: BoxReference 4 | 5 | [types/app](../modules/types_app.md).BoxReference 6 | 7 | A grouping of the app ID and name of the box in an Uint8Array 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [appId](types_app.BoxReference.md#appid) 14 | - [name](types_app.BoxReference.md#name) 15 | 16 | ## Properties 17 | 18 | ### appId 19 | 20 | • **appId**: `number` \| `bigint` 21 | 22 | A unique application id 23 | 24 | #### Defined in 25 | 26 | [src/types/app.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L51) 27 | 28 | ___ 29 | 30 | ### name 31 | 32 | • **name**: [`BoxIdentifier`](../modules/types_app.md#boxidentifier) 33 | 34 | Name of box to reference 35 | 36 | #### Defined in 37 | 38 | [src/types/app.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L55) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/node/restart.md: -------------------------------------------------------------------------------- 1 | title: goal node restart 2 | --- 3 | ## goal node restart 4 | 5 | 6 | 7 | Stop, and then start, the specified Algorand node 8 | 9 | 10 | 11 | ``` 12 | 13 | goal node restart [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for restart 26 | 27 | -H, --hosted Run algod hosted by algoh 28 | 29 | -l, --listen string Endpoint / REST address to listen on 30 | 31 | -p, --peer string Peer address to dial for initial connection 32 | 33 | -t, --telemetry string Enable telemetry if supported (Use "true", "false", "0" or "1") 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal node](../../node/node/) - Manage a specified algorand node 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/inspect.md: -------------------------------------------------------------------------------- 1 | title: goal clerk inspect 2 | --- 3 | ## goal clerk inspect 4 | 5 | 6 | 7 | Print a transaction file 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Loads a transaction file, attempts to decode the transaction, and displays the decoded information. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk inspect [input file 1] [input file 2]... [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for inspect 34 | 35 | -t, --txid Display the TxID for each transaction 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal clerk](../../clerk/clerk/) - Provides the tools to control transactions 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/kmd/kmd.md: -------------------------------------------------------------------------------- 1 | title: goal kmd 2 | --- 3 | ## goal kmd 4 | 5 | 6 | 7 | Interact with kmd, the key management daemon 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Interact with kmd, the key management daemon. The key management daemon is a separate process from algod that is solely responsible for key management. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal kmd [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for kmd 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 58 | * [goal kmd start](../start/) - Start the kmd process, or restart it with an updated timeout 59 | * [goal kmd stop](../stop/) - Stop the kmd process if it is running 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_account.TransactionSignerAccount.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/account](../modules/types_account.md) / TransactionSignerAccount 2 | 3 | # Interface: TransactionSignerAccount 4 | 5 | [types/account](../modules/types_account.md).TransactionSignerAccount 6 | 7 | A wrapper around `TransactionSigner` that also has the sender address. 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [addr](types_account.TransactionSignerAccount.md#addr) 14 | - [signer](types_account.TransactionSignerAccount.md#signer) 15 | 16 | ## Properties 17 | 18 | ### addr 19 | 20 | • **addr**: `string` 21 | 22 | #### Defined in 23 | 24 | [src/types/account.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L113) 25 | 26 | ___ 27 | 28 | ### signer 29 | 30 | • **signer**: `TransactionSigner` 31 | 32 | #### Defined in 33 | 34 | [src/types/account.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L114) 35 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_spec.Struct.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-spec](../modules/types_app_spec.md) / Struct 2 | 3 | # Interface: Struct 4 | 5 | [types/app-spec](../modules/types_app_spec.md).Struct 6 | 7 | A user-defined struct/tuple type 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [elements](types_app_spec.Struct.md#elements) 14 | - [name](types_app_spec.Struct.md#name) 15 | 16 | ## Properties 17 | 18 | ### elements 19 | 20 | • **elements**: [`StructElement`](../modules/types_app_spec.md#structelement)[] 21 | 22 | The elements (in order) that make up the struct/tuple 23 | 24 | #### Defined in 25 | 26 | [src/types/app-spec.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L77) 27 | 28 | ___ 29 | 30 | ### name 31 | 32 | • **name**: `string` 33 | 34 | The name of the type 35 | 36 | #### Defined in 37 | 38 | [src/types/app-spec.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L75) 39 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_spec.SchemaSpec.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-spec](../modules/types_app_spec.md) / SchemaSpec 2 | 3 | # Interface: SchemaSpec 4 | 5 | [types/app-spec](../modules/types_app_spec.md).SchemaSpec 6 | 7 | The schema for global and local storage 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [global](types_app_spec.SchemaSpec.md#global) 14 | - [local](types_app_spec.SchemaSpec.md#local) 15 | 16 | ## Properties 17 | 18 | ### global 19 | 20 | • **global**: [`Schema`](types_app_spec.Schema.md) 21 | 22 | The global storage schema 23 | 24 | #### Defined in 25 | 26 | [src/types/app-spec.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L152) 27 | 28 | ___ 29 | 30 | ### local 31 | 32 | • **local**: [`Schema`](types_app_spec.Schema.md) 33 | 34 | The local storage schema 35 | 36 | #### Defined in 37 | 38 | [src/types/app-spec.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L150) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/account/balance.md: -------------------------------------------------------------------------------- 1 | title: goal account balance 2 | --- 3 | ## goal account balance 4 | 5 | 6 | 7 | Retrieve the balances for the specified account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Retrieve the balance record for the specified account. Algo balance is displayed in microAlgos. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account balance [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Account address to retrieve balance (required) 34 | 35 | -h, --help help for balance 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/account/delete.md: -------------------------------------------------------------------------------- 1 | title: goal account delete 2 | --- 3 | ## goal account delete 4 | 5 | 6 | 7 | Delete an account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Delete the indicated account. The key management daemon will no longer know about this account, although the account will still exist on the network. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account delete [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Address of account to delete 34 | 35 | -h, --help help for delete 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/conduit/list/list.md: -------------------------------------------------------------------------------- 1 | title: conduit list 2 | --- 3 | ## conduit list 4 | 5 | 6 | 7 | List all available Conduit plugins 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | List all available Conduit plugins by type and a short description. 16 | 17 | 18 | 19 | Use this utility to explore the plugins. Drill into each plugin to get a 20 | 21 | sample configuration. 22 | 23 | 24 | 25 | Example: 26 | 27 | conduit list importers algod 28 | 29 | conduit list processors filter_processor 30 | 31 | 32 | 33 | ``` 34 | 35 | conduit list [flags] 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options 42 | 43 | 44 | 45 | ``` 46 | 47 | -h, --help help for list 48 | 49 | ``` 50 | 51 | 52 | 53 | ### SEE ALSO 54 | 55 | 56 | 57 | * [conduit](../../../conduit/conduit/) - Run the Conduit framework. 58 | * [conduit list exporters](../exporters/) - Usage details for exporter plugins. 59 | * [conduit list importers](../importers/) - Usage details for importer plugins. 60 | * [conduit list processors](../processors/) - Usage details for processor plugins. 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /docs/clis/goal/account/multisig/multisig.md: -------------------------------------------------------------------------------- 1 | title: goal account multisig 2 | --- 3 | ## goal account multisig 4 | 5 | 6 | 7 | Control and manage multisig accounts 8 | 9 | 10 | 11 | ``` 12 | 13 | goal account multisig [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for multisig 26 | 27 | ``` 28 | 29 | 30 | 31 | ### Options inherited from parent commands 32 | 33 | 34 | 35 | ``` 36 | 37 | -d, --datadir stringArray Data directory for the node 38 | 39 | -k, --kmddir string Data directory for kmd 40 | 41 | -w, --wallet string Set the wallet to be used for the selected operation 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal account](../../../account/account/) - Control and manage Algorand accounts 52 | * [goal account multisig delete](../delete/) - Delete a multisig account 53 | * [goal account multisig info](../info/) - Print information about a multisig account 54 | * [goal account multisig new](../new/) - Create a new multisig account 55 | 56 | 57 | 58 | -------------------------------------------------------------------------------- /docs/clis/goal/account/rewards.md: -------------------------------------------------------------------------------- 1 | title: goal account rewards 2 | --- 3 | ## goal account rewards 4 | 5 | 6 | 7 | Retrieve the rewards for the specified account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Retrieve the rewards for the specified account, including pending rewards. Units displayed are microAlgos. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account rewards [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Account address to retrieve rewards (required) 34 | 35 | -h, --help help for rewards 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/tealdbg/remote.md: -------------------------------------------------------------------------------- 1 | title: tealdbg remote 2 | --- 3 | ## tealdbg remote 4 | 5 | 6 | 7 | Debug TEAL program on-chain 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Start the server and wait for upcoming debug connections from remote TEAL evaluator 16 | 17 | 18 | 19 | ``` 20 | 21 | tealdbg remote [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for remote 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -f, --frontend string Frontend to use: cdt, web (default "cdt") 46 | 47 | --listen string Network interface to listen on (default "127.0.0.1") 48 | 49 | --no-source-map Do not generate source maps 50 | 51 | --remote-debugging-port int Port to listen on (default 9392) 52 | 53 | -v, --verbose Verbose output 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [tealdbg](../../tealdbg/tealdbg/) - Algorand TEAL Debugger 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_transfer.EnsureFundedReturnType.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/transfer](../modules/types_transfer.md) / EnsureFundedReturnType 2 | 3 | # Interface: EnsureFundedReturnType 4 | 5 | [types/transfer](../modules/types_transfer.md).EnsureFundedReturnType 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [amount](types_transfer.EnsureFundedReturnType.md#amount) 12 | - [transactionId](types_transfer.EnsureFundedReturnType.md#transactionid) 13 | 14 | ## Properties 15 | 16 | ### amount 17 | 18 | • **amount**: `number` 19 | 20 | The response if the transaction was sent and waited for 21 | 22 | #### Defined in 23 | 24 | [src/types/transfer.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L79) 25 | 26 | ___ 27 | 28 | ### transactionId 29 | 30 | • **transactionId**: `string` 31 | 32 | The transaction 33 | 34 | #### Defined in 35 | 36 | [src/types/transfer.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L77) 37 | -------------------------------------------------------------------------------- /docs/get-details/algorand-networks/betanet.md: -------------------------------------------------------------------------------- 1 | title: BetaNet 🔷 2 | # What's New 3 | 4 | 🔷 = BetaNet availability only 5 | 6 | # Version 7 | `v4.3.0-beta` 8 | 9 | # Release Version 10 | https://github.com/algorand/go-algorand/releases/tag/v4.3.0-beta 11 | 12 | # Genesis ID 13 | `betanet-v1.0` 14 | 15 | # Genesis Hash 16 | `mFgazF+2uRS1tMiL9dsj01hJGySEmPN28B/TjjvpVW0=` 17 | 18 | # FeeSink Address 19 | `A7NMWS3NT3IUDMLVO26ULGXGIIOUQ3ND2TXSER6EBGRZNOBOUIQXHIBGDE` 20 | 21 | # RewardsPool Address 22 | `7777777777777777777777777777777777777777777777777774MSJUVU` 23 | 24 | # Faucet 25 | 26 | You can dispense algos to your TestNet account by visiting [Algorand BetaNet Dispenser](https://bank.betanet.algodev.network/). 27 | 28 | Click the Google sign-in link at the top of the Dispenser page and sign-in with your Google account. Complete the reCAPTCHA. Then copy and paste the address you would like to send money to into the empty text box. Click "Dispense". A `200` status code and a transaction ID means success. Run `goal account balance -a ` to view the new balance. 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/clis/goal/account/new.md: -------------------------------------------------------------------------------- 1 | title: goal account new 2 | --- 3 | ## goal account new 4 | 5 | 6 | 7 | Create a new account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Coordinates the creation of a new account with KMD. The name specified here is stored in a local configuration file and is only used by goal when working against that specific node instance. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account new [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -f, --default Set this account as the default one 34 | 35 | -h, --help help for new 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/features/explore.md: -------------------------------------------------------------------------------- 1 | title: Explore 2 | 3 | AlgoKit provides a quick shortcut to [explore](../cli-reference.md#explore) various Algorand networks using [Lora](https://lora.algokit.io/mainnet) including [AlogKit LocalNet](./localnet.md)! 4 | 5 | ## LocalNet 6 | 7 | The following three commands are all equivalent and will open [Lora](https://lora.algokit.io/localnet) pointing to the local [AlgoKit LocalNet](./localnet.md) instance: 8 | 9 | - `algokit explore` 10 | - `algokit explore localnet` 11 | - `algokit localnet explore` 12 | 13 | ## Testnet 14 | 15 | `algokit explore testnet` will open [Lora](https://lora.algokit.io/testnet) pointing to TestNet via the [node](https://algonode.io/api/). 16 | 17 | ## Mainnet 18 | 19 | `algokit explore mainnet` will open [Lora](https://lora.algokit.io/mainnet) pointing to MainNet via the [node](https://algonode.io/api/). 20 | 21 | To learn more about the `algokit explore` command, please refer to [explore](../cli-reference.md#explore) in the AlgoKit CLI reference documentation. 22 | -------------------------------------------------------------------------------- /docs/clis/goal/account/export.md: -------------------------------------------------------------------------------- 1 | title: goal account export 2 | --- 3 | ## goal account export 4 | 5 | 6 | 7 | Export an account key for use with account import 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Export an account mnemonic seed, for use with account import. This exports the seed for a single account and should NOT be confused with the wallet mnemonic. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account export [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Address of account to export 34 | 35 | -h, --help help for export 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/account/multisig/new.md: -------------------------------------------------------------------------------- 1 | title: goal account multisig new 2 | --- 3 | ## goal account multisig new 4 | 5 | 6 | 7 | Create a new multisig account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Create a new multisig account from a list of existing non-multisig addresses 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account multisig new [address 1] [address 2]... [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for new 34 | 35 | -T, --threshold uint8 Number of signatures required to spend from this address (default 1) 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account multisig](../../multisig/multisig/) - Control and manage multisig accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.AppReference.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / AppReference 2 | 3 | # Interface: AppReference 4 | 5 | [types/app](../modules/types_app.md).AppReference 6 | 7 | Information about an Algorand app 8 | 9 | ## Hierarchy 10 | 11 | - **`AppReference`** 12 | 13 | ↳ [`AppMetadata`](types_app.AppMetadata.md) 14 | 15 | ## Table of contents 16 | 17 | ### Properties 18 | 19 | - [appAddress](types_app.AppReference.md#appaddress) 20 | - [appId](types_app.AppReference.md#appid) 21 | 22 | ## Properties 23 | 24 | ### appAddress 25 | 26 | • **appAddress**: `string` 27 | 28 | The Algorand address of the account associated with the app 29 | 30 | #### Defined in 31 | 32 | [src/types/app.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L41) 33 | 34 | ___ 35 | 36 | ### appId 37 | 38 | • **appId**: `number` \| `bigint` 39 | 40 | The id of the app 41 | 42 | #### Defined in 43 | 44 | [src/types/app.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L39) 45 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Algorand 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /docs/clis/goal/account/multisig/delete.md: -------------------------------------------------------------------------------- 1 | title: goal account multisig delete 2 | --- 3 | ## goal account multisig delete 4 | 5 | 6 | 7 | Delete a multisig account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Delete a multisig account. Like ordinary account delete, the local node will no longer know about the account, but it may still exist on the network. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account multisig delete [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Address of multisig account to delete 34 | 35 | -h, --help help for delete 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account multisig](../../multisig/multisig/) - Control and manage multisig accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/account/dump.md: -------------------------------------------------------------------------------- 1 | title: goal account dump 2 | --- 3 | ## goal account dump 4 | 5 | 6 | 7 | Dump the balance record for the specified account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Dump the balance record for the specified account to terminal as JSON or to a file as MessagePack. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account dump [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Account address to retrieve balance (required) 34 | 35 | -h, --help help for dump 36 | 37 | -o, --outfile string Save balance record to specified output file 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | -w, --wallet string Set the wallet to be used for the selected operation 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal account](../../account/account/) - Control and manage Algorand accounts 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/clis/goal/account/multisig/info.md: -------------------------------------------------------------------------------- 1 | title: goal account multisig info 2 | --- 3 | ## goal account multisig info 4 | 5 | 6 | 7 | Print information about a multisig account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Print information about a multisig account, such as its Algorand multisig version, or the number of keys needed to validate a transaction from the multisig account. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account multisig info [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Address of multisig account to look up 34 | 35 | -h, --help help for info 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account multisig](../../multisig/multisig/) - Control and manage multisig accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_spec.StateSchemaSpec.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-spec](../modules/types_app_spec.md) / StateSchemaSpec 2 | 3 | # Interface: StateSchemaSpec 4 | 5 | [types/app-spec](../modules/types_app_spec.md).StateSchemaSpec 6 | 7 | The rolled-up schema allocation specification for local and global state 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [global](types_app_spec.StateSchemaSpec.md#global) 14 | - [local](types_app_spec.StateSchemaSpec.md#local) 15 | 16 | ## Properties 17 | 18 | ### global 19 | 20 | • **global**: [`StateSchema`](../modules/types_app_spec.md#stateschema) 21 | 22 | Global storage spec 23 | 24 | #### Defined in 25 | 26 | [src/types/app-spec.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L166) 27 | 28 | ___ 29 | 30 | ### local 31 | 32 | • **local**: [`StateSchema`](../modules/types_app_spec.md#stateschema) 33 | 34 | Local storage spec 35 | 36 | #### Defined in 37 | 38 | [src/types/app-spec.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L168) 39 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / TestNetDispenserApiClientParams 2 | 3 | # Interface: TestNetDispenserApiClientParams 4 | 5 | [types/dispenser-client](../modules/types_dispenser_client.md).TestNetDispenserApiClientParams 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [authToken](types_dispenser_client.TestNetDispenserApiClientParams.md#authtoken) 12 | - [requestTimeout](types_dispenser_client.TestNetDispenserApiClientParams.md#requesttimeout) 13 | 14 | ## Properties 15 | 16 | ### authToken 17 | 18 | • **authToken**: `string` 19 | 20 | #### Defined in 21 | 22 | [src/types/dispenser-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L27) 23 | 24 | ___ 25 | 26 | ### requestTimeout 27 | 28 | • **requestTimeout**: ``null`` \| `number` 29 | 30 | #### Defined in 31 | 32 | [src/types/dispenser-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L28) 33 | -------------------------------------------------------------------------------- /docs/clis/goal/wallet/new.md: -------------------------------------------------------------------------------- 1 | title: goal wallet new 2 | --- 3 | ## goal wallet new 4 | 5 | 6 | 7 | Create a new wallet 8 | 9 | 10 | 11 | ``` 12 | 13 | goal wallet new [wallet name] [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for new 26 | 27 | --no-display-seed Create a new wallet without displaying the seed phrase. 28 | 29 | -r, --recover goal account new Recover the wallet from the backup mnemonic provided at wallet creation (NOT the mnemonic provided by goal account export or by algokey). Regenerate accounts in the wallet with goal account new 30 | 31 | --unencrypted Create a new wallet without a password. 32 | 33 | ``` 34 | 35 | 36 | 37 | ### Options inherited from parent commands 38 | 39 | 40 | 41 | ``` 42 | 43 | -d, --datadir stringArray Data directory for the node 44 | 45 | -k, --kmddir string Data directory for kmd 46 | 47 | ``` 48 | 49 | 50 | 51 | ### SEE ALSO 52 | 53 | 54 | 55 | * [goal wallet](../../wallet/wallet/) - Manage wallets: encrypted collections of Algorand account keys 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_spec.Schema.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-spec](../modules/types_app_spec.md) / Schema 2 | 3 | # Interface: Schema 4 | 5 | [types/app-spec](../modules/types_app_spec.md).Schema 6 | 7 | The storage schema definition 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [declared](types_app_spec.Schema.md#declared) 14 | - [reserved](types_app_spec.Schema.md#reserved) 15 | 16 | ## Properties 17 | 18 | ### declared 19 | 20 | • **declared**: `Record`\<`string`, [`DeclaredSchemaValueSpec`](types_app_spec.DeclaredSchemaValueSpec.md)\> 21 | 22 | Declared storage schema 23 | 24 | #### Defined in 25 | 26 | [src/types/app-spec.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L158) 27 | 28 | ___ 29 | 30 | ### reserved 31 | 32 | • **reserved**: `Record`\<`string`, [`ReservedSchemaValueSpec`](types_app_spec.ReservedSchemaValueSpec.md)\> 33 | 34 | Reserved storage schema 35 | 36 | #### Defined in 37 | 38 | [src/types/app-spec.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L160) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/asset/asset.md: -------------------------------------------------------------------------------- 1 | title: goal asset 2 | --- 3 | ## goal asset 4 | 5 | 6 | 7 | Manage assets 8 | 9 | 10 | 11 | ``` 12 | 13 | goal asset [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | -h, --help help for asset 26 | 27 | -w, --wallet string Set the wallet to be used for the selected operation 28 | 29 | ``` 30 | 31 | 32 | 33 | ### Options inherited from parent commands 34 | 35 | 36 | 37 | ``` 38 | 39 | -d, --datadir stringArray Data directory for the node 40 | 41 | -k, --kmddir string Data directory for kmd 42 | 43 | ``` 44 | 45 | 46 | 47 | ### SEE ALSO 48 | 49 | 50 | 51 | * [goal](../../../goal/goal/) - CLI for interacting with Algorand 52 | * [goal asset config](../config/) - Configure an asset 53 | * [goal asset create](../create/) - Create an asset 54 | * [goal asset destroy](../destroy/) - Destroy an asset 55 | * [goal asset freeze](../freeze/) - Freeze assets 56 | * [goal asset info](../info/) - Look up current parameters for an asset 57 | * [goal asset optin](../optin/) - Optin to assets 58 | * [goal asset send](../send/) - Transfer assets 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /docs/clis/goal/account/list.md: -------------------------------------------------------------------------------- 1 | title: goal account list 2 | --- 3 | ## goal account list 4 | 5 | 6 | 7 | Show the list of Algorand accounts on this machine 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Show the list of Algorand accounts on this machine. Indicates whether the account is [offline] or [online], and if the account is the default account for goal. Also displays account information with --info. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account list [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for list 34 | 35 | --info Include additional information about each account's assets and applications 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/multisig/merge.md: -------------------------------------------------------------------------------- 1 | title: goal clerk multisig merge 2 | --- 3 | ## goal clerk multisig merge 4 | 5 | 6 | 7 | Merge multisig signatures on transactions 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Combine multiple partially-signed multisig transactions, and write out transactions with a single merged multisig signature. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk multisig merge -o [merged transaction file] [input file 1] [input file 2]... [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for merge 34 | 35 | -o, --out string Output file for merged transactions 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal clerk multisig](../../multisig/multisig/) - Provides tools working with multisig transactions 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/clis/goal/account/info.md: -------------------------------------------------------------------------------- 1 | title: goal account info 2 | --- 3 | ## goal account info 4 | 5 | 6 | 7 | Retrieve information about the assets and applications belonging to the specified account 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Retrieve information about the assets and applications the specified account has created or opted into. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account info [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Account address to look up (required) 34 | 35 | -h, --help help for info 36 | 37 | --onlyShowAssetIDs Only show ASA IDs and not pull asset metadata 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | -w, --wallet string Set the wallet to be used for the selected operation 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal account](../../account/account/) - Control and manage Algorand accounts 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_indexer.AssetLookupResult.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / AssetLookupResult 2 | 3 | # Interface: AssetLookupResult 4 | 5 | [types/indexer](../modules/types_indexer.md).AssetLookupResult 6 | 7 | Indexer result for an asset lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [asset](types_indexer.AssetLookupResult.md#asset) 14 | - [current-round](types_indexer.AssetLookupResult.md#current-round) 15 | 16 | ## Properties 17 | 18 | ### asset 19 | 20 | • **asset**: [`AssetResult`](types_indexer.AssetResult.md) 21 | 22 | The returned asset 23 | 24 | #### Defined in 25 | 26 | [src/types/indexer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L58) 27 | 28 | ___ 29 | 30 | ### current-round 31 | 32 | • **current-round**: `number` 33 | 34 | Round at which the results were computed. 35 | 36 | #### Defined in 37 | 38 | [src/types/indexer.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L56) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/node/clone.md: -------------------------------------------------------------------------------- 1 | title: goal node clone 2 | --- 3 | ## goal node clone 4 | 5 | 6 | 7 | Clone the specified node to create another node 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Clone the specified node to create another node. Optionally you can control whether the clone includes the current ledger, or if it starts with an uninitialized one. The default is to clone the ledger as well. Specify -n or --noledger to start with an uninitialized ledger. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal node clone [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for clone 34 | 35 | -n, --noledger Don't include ledger when copying (No Ledger) 36 | 37 | -t, --targetdir string Target directory for the clone 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal node](../../node/node/) - Manage a specified algorand node 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.AppCompilationResult.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / AppCompilationResult 2 | 3 | # Interface: AppCompilationResult 4 | 5 | [types/app](../modules/types_app.md).AppCompilationResult 6 | 7 | The result of compiling the approval and clear TEAL for an app 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [compiledApproval](types_app.AppCompilationResult.md#compiledapproval) 14 | - [compiledClear](types_app.AppCompilationResult.md#compiledclear) 15 | 16 | ## Properties 17 | 18 | ### compiledApproval 19 | 20 | • **compiledApproval**: [`CompiledTeal`](types_app.CompiledTeal.md) 21 | 22 | The compilation result of approval 23 | 24 | #### Defined in 25 | 26 | [src/types/app.ts:316](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L316) 27 | 28 | ___ 29 | 30 | ### compiledClear 31 | 32 | • **compiledClear**: [`CompiledTeal`](types_app.CompiledTeal.md) 33 | 34 | The compilation result of clear 35 | 36 | #### Defined in 37 | 38 | [src/types/app.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L318) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/dryrun-remote.md: -------------------------------------------------------------------------------- 1 | title: goal clerk dryrun-remote 2 | --- 3 | ## goal clerk dryrun-remote 4 | 5 | 6 | 7 | Test a program with algod's dryrun REST endpoint 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Test a TEAL program with algod's dryrun REST endpoint under various conditions and verbosity. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk dryrun-remote [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -D, --dryrun-state string Dryrun request object to run 34 | 35 | -h, --help help for dryrun-remote 36 | 37 | -r, --raw Output raw response from algod 38 | 39 | -v, --verbose Print more info 40 | 41 | ``` 42 | 43 | 44 | 45 | ### Options inherited from parent commands 46 | 47 | 48 | 49 | ``` 50 | 51 | -d, --datadir stringArray Data directory for the node 52 | 53 | -k, --kmddir string Data directory for kmd 54 | 55 | -w, --wallet string Set the wallet to be used for the selected operation 56 | 57 | ``` 58 | 59 | 60 | 61 | ### SEE ALSO 62 | 63 | 64 | 65 | * [goal clerk](../../clerk/clerk/) - Provides the tools to control transactions 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /docs/clis/goal/ledger/block.md: -------------------------------------------------------------------------------- 1 | title: goal ledger block 2 | --- 3 | ## goal ledger block 4 | 5 | 6 | 7 | Dump a block to a file or stdout 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Dump a block to a file or stdout. Default behavior is to attempt to decode the raw bytes returned from algod to JSON. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal ledger block [round number] [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | --b32 Encode binary blobs using base32 instead of base64 34 | 35 | -h, --help help for block 36 | 37 | -o, --out string The filename to dump the block to (if not set, use stdout) (default "-") 38 | 39 | -r, --raw Format block as msgpack 40 | 41 | --strict Strict JSON decode: turn all keys into strings 42 | 43 | ``` 44 | 45 | 46 | 47 | ### Options inherited from parent commands 48 | 49 | 50 | 51 | ``` 52 | 53 | -d, --datadir stringArray Data directory for the node 54 | 55 | -k, --kmddir string Data directory for kmd 56 | 57 | ``` 58 | 59 | 60 | 61 | ### SEE ALSO 62 | 63 | 64 | 65 | * [goal ledger](../../ledger/ledger/) - Access ledger-related details 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_indexer.AccountLookupResult.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / AccountLookupResult 2 | 3 | # Interface: AccountLookupResult 4 | 5 | [types/indexer](../modules/types_indexer.md).AccountLookupResult 6 | 7 | Indexer result for an account lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [account](types_indexer.AccountLookupResult.md#account) 14 | - [current-round](types_indexer.AccountLookupResult.md#current-round) 15 | 16 | ## Properties 17 | 18 | ### account 19 | 20 | • **account**: [`AccountResult`](types_indexer.AccountResult.md) 21 | 22 | The returned account 23 | 24 | #### Defined in 25 | 26 | [src/types/indexer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L20) 27 | 28 | ___ 29 | 30 | ### current-round 31 | 32 | • **current-round**: `number` 33 | 34 | Round at which the results were computed. 35 | 36 | #### Defined in 37 | 38 | [src/types/indexer.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L18) 39 | -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: Algorand Developer Docs 2 | repo_name: algorand/docs 3 | repo_url: https://github.com/algorand/docs 4 | edit_uri: edit/staging/docs/ 5 | # make it serve with the path starting `docs/` 6 | # so it matches staging/main 7 | site_url: http://127.0.0.1:8000/docs/ 8 | 9 | theme: 10 | name: material 11 | font: Lato 12 | palette: 13 | primary: "#000000" 14 | accent: "#5662DB" 15 | icon: 16 | repo: fontawesome/brands/github 17 | features: 18 | - navigation.sections 19 | 20 | markdown_extensions: 21 | - admonition 22 | - footnotes 23 | - pymdownx.arithmatex 24 | - pymdownx.betterem: 25 | smart_enable: all 26 | - pymdownx.caret 27 | - pymdownx.critic 28 | - pymdownx.details 29 | - pymdownx.emoji: 30 | emoji_generator: !!python/name:pymdownx.emoji.to_svg 31 | - pymdownx.inlinehilite 32 | - pymdownx.magiclink 33 | - pymdownx.mark 34 | - pymdownx.smartsymbols 35 | - pymdownx.superfences 36 | - pymdownx.tabbed 37 | - pymdownx.tasklist: 38 | custom_checkbox: true 39 | - pymdownx.tilde 40 | - codehilite 41 | - attr_list 42 | - toc: 43 | permalink: true 44 | baselevel: 2 45 | 46 | plugins: 47 | - search 48 | - awesome-pages 49 | 50 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app.BoxName.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app](../modules/types_app.md) / BoxName 2 | 3 | # Interface: BoxName 4 | 5 | [types/app](../modules/types_app.md).BoxName 6 | 7 | The name of a box storage box 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [name](types_app.BoxName.md#name) 14 | - [nameBase64](types_app.BoxName.md#namebase64) 15 | - [nameRaw](types_app.BoxName.md#nameraw) 16 | 17 | ## Properties 18 | 19 | ### name 20 | 21 | • **name**: `string` 22 | 23 | Name in UTF-8 24 | 25 | #### Defined in 26 | 27 | [src/types/app.ts:341](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L341) 28 | 29 | ___ 30 | 31 | ### nameBase64 32 | 33 | • **nameBase64**: `string` 34 | 35 | Name in Base64 36 | 37 | #### Defined in 38 | 39 | [src/types/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L345) 40 | 41 | ___ 42 | 43 | ### nameRaw 44 | 45 | • **nameRaw**: `Uint8Array` 46 | 47 | Name in binary bytes 48 | 49 | #### Defined in 50 | 51 | [src/types/app.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L343) 52 | -------------------------------------------------------------------------------- /docs/clis/goal/asset/info.md: -------------------------------------------------------------------------------- 1 | title: goal asset info 2 | --- 3 | ## goal asset info 4 | 5 | 6 | 7 | Look up current parameters for an asset 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Look up asset information stored on the network, such as asset creator, management addresses, or asset name. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal asset info [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | --asset string DEPRECATED! Unit name of the asset to look up 34 | 35 | --assetid uint ID of the asset to look up 36 | 37 | --creator string Account address of the asset creator 38 | 39 | -h, --help help for info 40 | 41 | --unitname string Unit name of the asset to look up 42 | 43 | ``` 44 | 45 | 46 | 47 | ### Options inherited from parent commands 48 | 49 | 50 | 51 | ``` 52 | 53 | -d, --datadir stringArray Data directory for the node 54 | 55 | -k, --kmddir string Data directory for kmd 56 | 57 | -w, --wallet string Set the wallet to be used for the selected operation 58 | 59 | ``` 60 | 61 | 62 | 63 | ### SEE ALSO 64 | 65 | 66 | 67 | * [goal asset](../../asset/asset/) - Manage assets 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/multisig/multisig.md: -------------------------------------------------------------------------------- 1 | title: goal clerk multisig 2 | --- 3 | ## goal clerk multisig 4 | 5 | 6 | 7 | Provides tools working with multisig transactions 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Create, examine, and add signatures to multisig transactions. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk multisig [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for multisig 34 | 35 | ``` 36 | 37 | 38 | 39 | ### Options inherited from parent commands 40 | 41 | 42 | 43 | ``` 44 | 45 | -d, --datadir stringArray Data directory for the node 46 | 47 | -k, --kmddir string Data directory for kmd 48 | 49 | -w, --wallet string Set the wallet to be used for the selected operation 50 | 51 | ``` 52 | 53 | 54 | 55 | ### SEE ALSO 56 | 57 | 58 | 59 | * [goal clerk](../../../clerk/clerk/) - Provides the tools to control transactions 60 | * [goal clerk multisig merge](../merge/) - Merge multisig signatures on transactions 61 | * [goal clerk multisig sign](../sign/) - Add a signature to a multisig transaction 62 | * [goal clerk multisig signprogram](../signprogram/) - Add a signature to a multisig LogicSig 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_app_client.AppSourceMaps.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/app-client](../modules/types_app_client.md) / AppSourceMaps 2 | 3 | # Interface: AppSourceMaps 4 | 5 | [types/app-client](../modules/types_app_client.md).AppSourceMaps 6 | 7 | Source maps for an Algorand app 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [approvalSourceMap](types_app_client.AppSourceMaps.md#approvalsourcemap) 14 | - [clearSourceMap](types_app_client.AppSourceMaps.md#clearsourcemap) 15 | 16 | ## Properties 17 | 18 | ### approvalSourceMap 19 | 20 | • **approvalSourceMap**: [`SourceMapExport`](types_app_client.SourceMapExport.md) 21 | 22 | The source map of the approval program 23 | 24 | #### Defined in 25 | 26 | [src/types/app-client.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L223) 27 | 28 | ___ 29 | 30 | ### clearSourceMap 31 | 32 | • **clearSourceMap**: [`SourceMapExport`](types_app_client.SourceMapExport.md) 33 | 34 | The source map of the clear program 35 | 36 | #### Defined in 37 | 38 | [src/types/app-client.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L225) 39 | -------------------------------------------------------------------------------- /docs/get-details/algokit/articles/output_stability.md: -------------------------------------------------------------------------------- 1 | title: Contract Output Stability 2 | 3 | Smart contracts development is analogous to low level firmware software development; it's a highly constrained environment in terms of both compute power and memory storage, with a high risk of vulnerabilities due to lower level access to memory and less developer-oriented security tooling. 4 | Because of this, the assembly language code that is output for a smart contract is important - a seemingly innocuous minor change could inadvertently add a security vulnerability, or could significantly change the execution and memory profile. 5 | As such it is important to ensure that, even if higher level code is refactored, there are no unintended changes to the generated smart contract assembly language output. 6 | We refer to this property as **output stability**. 7 | 8 | We recommend having "output stability tests" that require a developer to explicitly opt-in to accepting a change in the output of a smart contract's assembly code. This can be implemented as part of an automated build process which fails if the output changes aren't committed to source control, thus preventing deployment of the smart contract without a human review taking place (assuming automated deployment). 9 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_testing.GetTestAccountParams.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/testing](../modules/types_testing.md) / GetTestAccountParams 2 | 3 | # Interface: GetTestAccountParams 4 | 5 | [types/testing](../modules/types_testing.md).GetTestAccountParams 6 | 7 | Parameters for the `getTestAccount` function. 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [initialFunds](types_testing.GetTestAccountParams.md#initialfunds) 14 | - [suppressLog](types_testing.GetTestAccountParams.md#suppresslog) 15 | 16 | ## Properties 17 | 18 | ### initialFunds 19 | 20 | • **initialFunds**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) 21 | 22 | Initial funds to ensure the account has 23 | 24 | #### Defined in 25 | 26 | [src/types/testing.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L40) 27 | 28 | ___ 29 | 30 | ### suppressLog 31 | 32 | • `Optional` **suppressLog**: `boolean` 33 | 34 | Whether to suppress the log (which includes a mnemonic) or not (default: do not suppress the log) 35 | 36 | #### Defined in 37 | 38 | [src/types/testing.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L42) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/split.md: -------------------------------------------------------------------------------- 1 | title: goal clerk split 2 | --- 3 | ## goal clerk split 4 | 5 | 6 | 7 | Split a file containing many transactions into one transaction per file 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Split a file containing many transactions. The input file must contain one or more transactions. These transactions will be written to individual files. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk split [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for split 34 | 35 | -i, --infile string File storing transactions to be split 36 | 37 | -o, --outfile string Base filename for writing the individual transactions; each transaction will be written to filename-N.ext 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | -w, --wallet string Set the wallet to be used for the selected operation 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal clerk](../../clerk/clerk/) - Provides the tools to control transactions 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_indexer.TransactionLookupResult.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / TransactionLookupResult 2 | 3 | # Interface: TransactionLookupResult 4 | 5 | [types/indexer](../modules/types_indexer.md).TransactionLookupResult 6 | 7 | Indexer result for a transaction lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [current-round](types_indexer.TransactionLookupResult.md#current-round) 14 | - [transaction](types_indexer.TransactionLookupResult.md#transaction) 15 | 16 | ## Properties 17 | 18 | ### current-round 19 | 20 | • **current-round**: `number` 21 | 22 | Round at which the results were computed. 23 | 24 | #### Defined in 25 | 26 | [src/types/indexer.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L64) 27 | 28 | ___ 29 | 30 | ### transaction 31 | 32 | • **transaction**: [`TransactionResult`](types_indexer.TransactionResult.md) 33 | 34 | The returned transaction 35 | 36 | #### Defined in 37 | 38 | [src/types/indexer.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L66) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/account/import.md: -------------------------------------------------------------------------------- 1 | title: goal account import 2 | --- 3 | ## goal account import 4 | 5 | 6 | 7 | Import an account key from mnemonic 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Import an account key from a mnemonic generated by the export command or by algokey (NOT a mnemonic from the goal wallet command). The imported account will be listed alongside your wallet-generated accounts, but will not be tied to your wallet. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account import [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -f, --default Set this account as the default one 34 | 35 | -h, --help help for import 36 | 37 | -m, --mnemonic string Mnemonic to import (will prompt otherwise) 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | -w, --wallet string Set the wallet to be used for the selected operation 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal account](../../account/account/) - Control and manage Algorand accounts 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/clis/goal/node/create.md: -------------------------------------------------------------------------------- 1 | title: goal node create 2 | --- 3 | ## goal node create 4 | 5 | 6 | 7 | Create a node at the desired data directory for the desired network 8 | 9 | 10 | 11 | ``` 12 | 13 | goal node create [flags] 14 | 15 | ``` 16 | 17 | 18 | 19 | ### Options 20 | 21 | 22 | 23 | ``` 24 | 25 | --api string REST API Endpoint 26 | 27 | -a, --archival Make the new node archival, storing all blocks 28 | 29 | --destination string Destination path for the new node 30 | 31 | --full-config Store full config file 32 | 33 | -h, --help help for create 34 | 35 | -H, --hosted Configure the new node to run hosted by algoh 36 | 37 | --network string Network the new node should point to 38 | 39 | --relay string Configure as a relay with specified listening address (NetAddress) 40 | 41 | ``` 42 | 43 | 44 | 45 | ### Options inherited from parent commands 46 | 47 | 48 | 49 | ``` 50 | 51 | -d, --datadir stringArray Data directory for the node 52 | 53 | -k, --kmddir string Data directory for kmd 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal node](../../node/node/) - Manage a specified algorand node 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_indexer.ApplicationLookupResult.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / ApplicationLookupResult 2 | 3 | # Interface: ApplicationLookupResult 4 | 5 | [types/indexer](../modules/types_indexer.md).ApplicationLookupResult 6 | 7 | Indexer result for an application lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [application](types_indexer.ApplicationLookupResult.md#application) 14 | - [current-round](types_indexer.ApplicationLookupResult.md#current-round) 15 | 16 | ## Properties 17 | 18 | ### application 19 | 20 | • **application**: [`ApplicationResult`](types_indexer.ApplicationResult.md) 21 | 22 | The returned application 23 | 24 | #### Defined in 25 | 26 | [src/types/indexer.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L74) 27 | 28 | ___ 29 | 30 | ### current-round 31 | 32 | • **current-round**: `number` 33 | 34 | Round at which the results were computed. 35 | 36 | #### Defined in 37 | 38 | [src/types/indexer.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L72) 39 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/rawsend.md: -------------------------------------------------------------------------------- 1 | title: goal clerk rawsend 2 | --- 3 | ## goal clerk rawsend 4 | 5 | 6 | 7 | Send raw transactions 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Send raw transactions. The transactions must be stored in a file, encoded using msgpack as transactions.SignedTxn. Multiple transactions can be concatenated together in a file. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk rawsend [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -f, --filename string Filename of file containing raw transactions 34 | 35 | -h, --help help for rawsend 36 | 37 | -N, --no-wait Don't wait for transactions to commit 38 | 39 | -r, --rejects string Filename for writing rejects to (default is txFilename.rej) 40 | 41 | ``` 42 | 43 | 44 | 45 | ### Options inherited from parent commands 46 | 47 | 48 | 49 | ``` 50 | 51 | -d, --datadir stringArray Data directory for the node 52 | 53 | -k, --kmddir string Data directory for kmd 54 | 55 | -w, --wallet string Set the wallet to be used for the selected operation 56 | 57 | ``` 58 | 59 | 60 | 61 | ### SEE ALSO 62 | 63 | 64 | 65 | * [goal clerk](../../clerk/clerk/) - Provides the tools to control transactions 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/enums/types_indexer.SignatureType.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / SignatureType 2 | 3 | # Enumeration: SignatureType 4 | 5 | [types/indexer](../modules/types_indexer.md).SignatureType 6 | 7 | Type of signature used by an account 8 | 9 | ## Table of contents 10 | 11 | ### Enumeration Members 12 | 13 | - [lsig](types_indexer.SignatureType.md#lsig) 14 | - [msig](types_indexer.SignatureType.md#msig) 15 | - [sig](types_indexer.SignatureType.md#sig) 16 | 17 | ## Enumeration Members 18 | 19 | ### lsig 20 | 21 | • **lsig** = ``"lsig"`` 22 | 23 | Logic signature 24 | 25 | #### Defined in 26 | 27 | [src/types/indexer.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L764) 28 | 29 | ___ 30 | 31 | ### msig 32 | 33 | • **msig** = ``"msig"`` 34 | 35 | Multisig 36 | 37 | #### Defined in 38 | 39 | [src/types/indexer.ts:762](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L762) 40 | 41 | ___ 42 | 43 | ### sig 44 | 45 | • **sig** = ``"sig"`` 46 | 47 | Normal signature 48 | 49 | #### Defined in 50 | 51 | [src/types/indexer.ts:760](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L760) 52 | -------------------------------------------------------------------------------- /docs/clis/goal/account/assetdetails.md: -------------------------------------------------------------------------------- 1 | title: goal account assetdetails 2 | --- 3 | ## goal account assetdetails 4 | 5 | 6 | 7 | Retrieve information about the assets belonging to the specified account inclusive of asset metadata 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Retrieve information about the assets the specified account has created or opted into, inclusive of asset metadata. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account assetdetails [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Account address to look up (required) 34 | 35 | -h, --help help for assetdetails 36 | 37 | -l, --limit uint The maximum number of assets to return 38 | 39 | -n, --next string The next asset index to use for pagination 40 | 41 | ``` 42 | 43 | 44 | 45 | ### Options inherited from parent commands 46 | 47 | 48 | 49 | ``` 50 | 51 | -d, --datadir stringArray Data directory for the node 52 | 53 | -k, --kmddir string Data directory for kmd 54 | 55 | -w, --wallet string Set the wallet to be used for the selected operation 56 | 57 | ``` 58 | 59 | 60 | 61 | ### SEE ALSO 62 | 63 | 64 | 65 | * [goal account](../../account/account/) - Control and manage Algorand accounts 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /docs/clis/goal/account/importrootkey.md: -------------------------------------------------------------------------------- 1 | title: goal account importrootkey 2 | --- 3 | ## goal account importrootkey 4 | 5 | 6 | 7 | Import .rootkey files from the data directory into a kmd wallet 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Import .rootkey files from the data directory into a kmd wallet. This is analogous to using the import command with an account seed mnemonic: the imported account will be displayed alongside your wallet-derived accounts, but will not be tied to your wallet mnemonic. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal account importrootkey [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for importrootkey 34 | 35 | -u, --unencrypted-wallet Import into the default unencrypted wallet, potentially creating it 36 | 37 | ``` 38 | 39 | 40 | 41 | ### Options inherited from parent commands 42 | 43 | 44 | 45 | ``` 46 | 47 | -d, --datadir stringArray Data directory for the node 48 | 49 | -k, --kmddir string Data directory for kmd 50 | 51 | -w, --wallet string Set the wallet to be used for the selected operation 52 | 53 | ``` 54 | 55 | 56 | 57 | ### SEE ALSO 58 | 59 | 60 | 61 | * [goal account](../../account/account/) - Control and manage Algorand accounts 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/index.md: -------------------------------------------------------------------------------- 1 | title: Overview 2 | 3 | ### Modules 4 | 5 | - [index](modules/index.md) 6 | - [testing](modules/testing.md) 7 | - [types/account](modules/types_account.md) 8 | - [types/algo-http-client-with-retry](modules/types_algo_http_client_with_retry.md) 9 | - [types/amount](modules/types_amount.md) 10 | - [types/amount.spec](modules/types_amount_spec.md) 11 | - [types/app](modules/types_app.md) 12 | - [types/app-client](modules/types_app_client.md) 13 | - [types/app-client.spec](modules/types_app_client_spec.md) 14 | - [types/app-spec](modules/types_app_spec.md) 15 | - [types/asset](modules/types_asset.md) 16 | - [types/config](modules/types_config.md) 17 | - [types/debugging](modules/types_debugging.md) 18 | - [types/dispenser-client](modules/types_dispenser_client.md) 19 | - [types/dispenser-client.spec](modules/types_dispenser_client_spec.md) 20 | - [types/indexer](modules/types_indexer.md) 21 | - [types/logging](modules/types_logging.md) 22 | - [types/logic-error](modules/types_logic_error.md) 23 | - [types/network-client](modules/types_network_client.md) 24 | - [types/testing](modules/types_testing.md) 25 | - [types/transaction](modules/types_transaction.md) 26 | - [types/transfer](modules/types_transfer.md) 27 | - [types/urlTokenBaseHTTPClient](modules/types_urlTokenBaseHTTPClient.md) 28 | -------------------------------------------------------------------------------- /docs/clis/goal/network/pregen.md: -------------------------------------------------------------------------------- 1 | title: goal network pregen 2 | --- 3 | ## goal network pregen 4 | 5 | 6 | 7 | Pregenerate private network 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Pregenerates the root and participation keys for a private network. The pregen directory can then be passed to the 'goal network create' to start the network more quickly. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal network pregen [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -h, --help help for pregen 34 | 35 | -p, --pregendir string Specify the path to the directory to export genesis.json, root and partkey files. This should only be used on private networks. 36 | 37 | -t, --template string Specify the path to the template file for the network 38 | 39 | ``` 40 | 41 | 42 | 43 | ### Options inherited from parent commands 44 | 45 | 46 | 47 | ``` 48 | 49 | -d, --datadir stringArray Data directory for the node 50 | 51 | -k, --kmddir string Data directory for kmd 52 | 53 | -r, --rootdir string Root directory for the private network directories 54 | 55 | ``` 56 | 57 | 58 | 59 | ### SEE ALSO 60 | 61 | 62 | 63 | * [goal network](../../network/network/) - Create and manage private, multi-node, locally-hosted networks 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /docs/clis/goal/clerk/multisig/sign.md: -------------------------------------------------------------------------------- 1 | title: goal clerk multisig sign 2 | --- 3 | ## goal clerk multisig sign 4 | 5 | 6 | 7 | Add a signature to a multisig transaction 8 | 9 | 10 | 11 | ### Synopsis 12 | 13 | 14 | 15 | Start a multisig, or add a signature to an existing multisig, for a given transaction. 16 | 17 | 18 | 19 | ``` 20 | 21 | goal clerk multisig sign -t [transaction file] -a [address] [flags] 22 | 23 | ``` 24 | 25 | 26 | 27 | ### Options 28 | 29 | 30 | 31 | ``` 32 | 33 | -a, --address string Address of the key to sign with 34 | 35 | -h, --help help for sign 36 | 37 | -n, --no-sig Fill in the transaction's multisig field with public keys and threshold information, but don't produce a signature 38 | 39 | -t, --tx string Partially-signed transaction file to add signature to 40 | 41 | ``` 42 | 43 | 44 | 45 | ### Options inherited from parent commands 46 | 47 | 48 | 49 | ``` 50 | 51 | -d, --datadir stringArray Data directory for the node 52 | 53 | -k, --kmddir string Data directory for kmd 54 | 55 | -w, --wallet string Set the wallet to be used for the selected operation 56 | 57 | ``` 58 | 59 | 60 | 61 | ### SEE ALSO 62 | 63 | 64 | 65 | * [goal clerk multisig](../../multisig/multisig/) - Provides tools working with multisig transactions 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_indexer.EvalDelta.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/indexer](../modules/types_indexer.md) / EvalDelta 2 | 3 | # Interface: EvalDelta 4 | 5 | [types/indexer](../modules/types_indexer.md).EvalDelta 6 | 7 | Represents a TEAL value delta. https://developer.algorand.org/docs/rest-apis/indexer/#evaldelta 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [action](types_indexer.EvalDelta.md#action) 14 | - [bytes](types_indexer.EvalDelta.md#bytes) 15 | - [uint](types_indexer.EvalDelta.md#uint) 16 | 17 | ## Properties 18 | 19 | ### action 20 | 21 | • **action**: `number` 22 | 23 | [at] delta action. 24 | 25 | #### Defined in 26 | 27 | [src/types/indexer.ts:617](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L617) 28 | 29 | ___ 30 | 31 | ### bytes 32 | 33 | • `Optional` **bytes**: `string` 34 | 35 | [bs] bytes value. 36 | 37 | #### Defined in 38 | 39 | [src/types/indexer.ts:619](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L619) 40 | 41 | ___ 42 | 43 | ### uint 44 | 45 | • `Optional` **uint**: `number` 46 | 47 | [ui] uint value. 48 | 49 | #### Defined in 50 | 51 | [src/types/indexer.ts:621](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L621) 52 | -------------------------------------------------------------------------------- /docs/get-details/algokit/utils/ts/code/interfaces/types_transaction.TransactionToSign.md: -------------------------------------------------------------------------------- 1 | [@algorandfoundation/algokit-utils](../index.md) / [types/transaction](../modules/types_transaction.md) / TransactionToSign 2 | 3 | # Interface: TransactionToSign 4 | 5 | [types/transaction](../modules/types_transaction.md).TransactionToSign 6 | 7 | Defines an unsigned transaction that will appear in a group of transactions along with its signing information 8 | 9 | ## Table of contents 10 | 11 | ### Properties 12 | 13 | - [signer](types_transaction.TransactionToSign.md#signer) 14 | - [transaction](types_transaction.TransactionToSign.md#transaction) 15 | 16 | ## Properties 17 | 18 | ### signer 19 | 20 | • **signer**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) 21 | 22 | The account to use to sign the transaction, either an account (with private key loaded) or a logic signature account 23 | 24 | #### Defined in 25 | 26 | [src/types/transaction.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L107) 27 | 28 | ___ 29 | 30 | ### transaction 31 | 32 | • **transaction**: `Transaction` 33 | 34 | The unsigned transaction to sign and send 35 | 36 | #### Defined in 37 | 38 | [src/types/transaction.ts:105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L105) 39 | --------------------------------------------------------------------------------