AlgoKit Utils

Overview / Core Workflow

1. Create an

   AlgorandClient

   instance
2. Get or create accounts for signing
3. Send transactions using

   algorand.send.*

   methods
4. Or compose groups using

   algorand.newGroup()

How to proceed

1. Initialize AlgorandClient:
   TypeScript:
   typescript

   import { AlgorandClient } from '@algorandfoundation/algokit-utils'
   
   const algorand = AlgorandClient.fromEnvironment()
   // Or: AlgorandClient.defaultLocalNet()
   // Or: AlgorandClient.testNet()
   // Or: AlgorandClient.mainNet()

   Python:
   python

   from algokit_utils import AlgorandClient
   
   algorand = AlgorandClient.from_environment()
   # Or: AlgorandClient.default_localnet()
   # Or: AlgorandClient.testnet()
   # Or: AlgorandClient.mainnet()

2. Get accounts:
   TypeScript:
   typescript

   const account = await algorand.account.fromEnvironment('DEPLOYER')

   Python:
   python

   account = algorand.account.from_environment("DEPLOYER")

3. Send transactions:
   TypeScript:
   typescript

   await algorand.send.payment({
     sender: account.addr,
     receiver: 'RECEIVERADDRESS',
     amount: algo(1),
   })

   Python:
   python

   algorand.send.payment(PaymentParams(
     sender=account.address,
     receiver="RECEIVERADDRESS",
     amount=AlgoAmount(algo=1),
   ))

Important Rules / Guidelines

• Use AlgorandClient — It's the main entry point; avoid deprecated function-based APIs
• Default to fromEnvironment() — Works locally and in production via env vars
• Register signers — Use

  algorand.account

  to get accounts; signers are auto-registered
• Use algo() helper — For TypeScript, use

  algo(1)

  instead of raw microAlgos

Common Variations / Edge Cases

AlgorandClient.defaultLocalNet()

AlgorandClient.testNet()

.mainNet()

AlgorandClient.fromConfig({ algodConfig: {...} })

algorand.newGroup().addPayment(...).addAssetOptIn(...).send()

References / Further Reading

• TypeScript (

  references/typescript/

  ): AlgorandClient
• Python (

  references/python/

  ): AlgorandClient

• AlgoKit Utils TS Docs
• AlgoKit Utils Python Docs