{"id":13425602,"url":"https://github.com/geoffodonnell/powershell-algorand-module","last_synced_at":"2026-01-12T06:39:14.188Z","repository":{"id":136027613,"uuid":"482115330","full_name":"geoffodonnell/powershell-algorand-module","owner":"geoffodonnell","description":"Algorand Tools for PowerShell ","archived":false,"fork":false,"pushed_at":"2024-03-29T00:56:44.000Z","size":142,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-29T03:25:45.189Z","etag":null,"topics":["algorand","powershell","powershell-module"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geoffodonnell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-16T00:11:15.000Z","updated_at":"2024-04-15T05:33:40.047Z","dependencies_parsed_at":"2024-04-15T05:33:32.375Z","dependency_job_id":"6a8fb627-7d93-48af-948a-d2f8f550a10d","html_url":"https://github.com/geoffodonnell/powershell-algorand-module","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffodonnell%2Fpowershell-algorand-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffodonnell%2Fpowershell-algorand-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffodonnell%2Fpowershell-algorand-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffodonnell%2Fpowershell-algorand-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geoffodonnell","download_url":"https://codeload.github.com/geoffodonnell/powershell-algorand-module/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243790928,"owners_count":20348377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algorand","powershell","powershell-module"],"created_at":"2024-07-31T00:01:15.381Z","updated_at":"2026-01-12T06:39:14.176Z","avatar_url":"https://github.com/geoffodonnell.png","language":"C#","funding_links":[],"categories":["Development \u0026 Tools","Development Tools"],"sub_categories":["Language SDKs \u0026 Tools","Languages"],"readme":"# powershell-algorand-module\n[![CI/CD](https://github.com/geoffodonnell/powershell-algorand-module/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/geoffodonnell/powershell-algorand-module/actions/workflows/ci-cd.yml)\n[![PSGallery version](https://img.shields.io/powershellgallery/v/Algorand?include_prereleases)](https://www.powershellgallery.com/packages/Algorand)\n[![Donate Algo](https://img.shields.io/badge/Donate-ALGO-000000.svg?style=flat)](https://explorer.perawallet.app/address/EJMR773OGLFAJY5L2BCZKNA5PXLDJOWJK4ED4XDYTYH57CG3JMGQGI25DQ/)\n\n# Overview\nThis PowerShell module provides tools for the Algorand blockchain.\n\n## Roadmap\n- [x] Initial implementation\n- [x] Publish to module repository\n- [x] Examples\n- [ ] Help documentation \n- [ ] Advanced use cases\n\n# Installation\nThis module is published to [PSGallery](https://www.powershellgallery.com/packages/Algorand), therefore it can be installed with the following command:\n\n```PowerShell\nPS\u003e Install-Module -Name Algorand -Verbose\n```\n\nNote, after installing the module call `Import-Module` to load it into the current session.\n\n# Getting Started\nThe module is pre-configured for Mainnet, Testnet, and Betanet. For each of the pre-configured networks, the module connects to nodes maintained by [AlgoNode.io](https://algonode.io/) (Thanks AlgoNode!). The current Algorand network configuration determines where requests are directed. The current network can be obtained by calling `Get-AlgorandNetwork` with no arguments. \n\n## Setting up the Account Store\nThis module can be configured to manage accounts. Accounts are persisted in the Account Store, which stores data in a [KeePass](https://keepass.info/) database using [pt.KeePassLibStd](https://github.com/panteam-net/pt.KeePassLibStd). To setup the Account Store, call `Initialize-AlgorandAccountStore` and enter and confirm a password. In subsequent sessions, use `Open-AlgorandAccountStore` to make the accounts accessible.\n\n```PowerShell\nPS C:\\Users\\admin\u003e Initialize-AlgorandAccountStore\nSet password for the new Account Store instance.\nEnter password: ********\nConfirm password: ********\n\nCreated account store: 'C:\\Users\\admin\\AppData\\Local\\.algorand\\accounts.kdbx'\n```\n\nIt is not neccessary to use the Account Store to obtain an account object for signing transactions. An account object can be initialized at any time with the following command:\n\n```PowerShell\nPS C:\\Users\\admin\u003e New-AlgorandAccount -Name \"My Account\" -Mnemonic \"$ValidMnemonic\"\n```\n\n## Getting the configured network\nCall `Get-AlgorandNetwork` to get the current network\n\n```PowerShell\nPS C:\\Users\\admin\u003e Get-AlgorandNetwork\n\nName    GenesisId    GenesisHash\n----    ---------    -----------\ntestnet testnet-v1.0 SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=\n```\n\nCall `Get-AlgorandNetwork -GetAll` to get all networks\n \n```PowerShell\nPS C:\\Users\\admin\u003e Get-AlgorandNetwork -GetAll\n\nName    GenesisId    GenesisHash\n----    ---------    -----------\nmainnet mainnet-v1.0 wGHE2Pwdvd7S12BL5FaOP20EGYesN73ktiC1qzkkit8=\ntestnet testnet-v1.0 SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=\nbetanet betanet-v1.0 mFgazF+2uRS1tMiL9dsj01hJGySEmPN28B/TjjvpVW0=\n```\n\n## Getting the node status\nUse `Get-AlgorandNodeStatus` to get the status of the configured algod node.\n\n```PowerShell\nPS C:\\Users\\admin\u003e Get-AlgorandNodeStatus\n\nCatchupTime                 : 0\nLastRound                   : 21140662\nLastVersion                 : https://github.com/algorandfoundation/specs/tree/d5ac876d7ede07367dbaa26e149aa42589aac1f7\nNextVersion                 : https://github.com/algorandfoundation/specs/tree/d5ac876d7ede07367dbaa26e149aa42589aac1f7\nNextVersionRound            : 21140663\nNextVersionSupported        : True\nStoppedAtUnsupportedRound   : False\nTimeSinceLastRound          : 1039953532\nLastCatchpoint              :\nCatchpoint                  :\nCatchpointTotalAccounts     : 0\nCatchpointProcessedAccounts : 0\nCatchpointVerifiedAccounts  : 0\nCatchpointTotalBlocks       : 0\nCatchpointAcquiredBlocks    : 0\n```\n\n# Usage\n## Examples\n## Get $ALGO balance\n```PowerShell\nPS\u003e Get-AlgorandAccount | Get-AlgorandAccountInfo | Select -ExpandProperty Amount\n22001500\n```\n\n### Get ASA balance\n```PowerShell\nPS\u003e Get-AlgorandAccount | Get-AlgorandAccountInfo | Select -ExpandProperty Assets\n\n    Amount  AssetId Creator IsFrozen\n    ------  ------- ------- --------\n 733638011 21582668            False\n 268130222 26832577            False\n    588105 26835113            False\n    270313 51435943            False\n     48007 51437163            False\n    308119 56963708            False\n```\n\n### Send a payment transaction\n```PowerShell\nPS\u003e $sender = Get-AlgorandAccount -GetAll | Select-Object -First 1\nPS\u003e $receiver = \"ZZ6Z5YKFYOEINYKVID4HNJCM23OWAP5UP6IRTE4YPY27VMXPDJHMVAWUAY\"\nPS\u003e $amount = 3000\n\nPS\u003e $tx = New-AlgorandPaymentTransaction -Sender $sender -Amount $amount -Receiver $receiver\nPS\u003e $signedTx = Sign-AlgorandTransaction -Transaction $tx -Account $sender\nPS\u003e Submit-AlgorandTransaction -Transaction $signedTx\n\nTxId\n----\n4NYOHPWD5MWIMPGE4PELLI3FPKO757HJADXUJI3HM7Q3WF7TYGJA\n```\n\n## Helpful Commands\n\n### List the available commands in the module\n```PowerShell\nPS\u003e Get-Module -Name Algorand | Select -ExpandProperty ExportedCommands | Select -ExpandProperty Values | Select Name\n\nName\n----\nAdd-AlgorandNetwork\nClose-AlgorandAccountStore\nConvertTo-AlgorandTransaction\nFind-AlgorandAccount\n...\n```\n\n# Build\n\n## Prerequisites\n* .NET 8 SDK\n* PowerShell 7.4\n\n## Local\nClone this repository and execute `build-and-load-local.ps1` in a PowerShell window to build the module and import it into the current session. By default, when building locally the module is named `Algorand.Local`.\n\n## Pipelines\npowershell-outauth-module build pipelines use GitHub Actions workflows.\n\n# License\npowershell-algorand-module is licensed under a MIT license except for the exceptions listed below. See the LICENSE file for details.\n\n## Exceptions\nNone.\n\n# Disclaimer\nNothing in the repo constitutes professional and/or financial advice. Use this module at your own risk.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoffodonnell%2Fpowershell-algorand-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeoffodonnell%2Fpowershell-algorand-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoffodonnell%2Fpowershell-algorand-module/lists"}