AlgoKit Utils TypeScript

Installation

npm

npm install @algorandfoundation/algokit-utils

pnpm

pnpm add @algorandfoundation/algokit-utils

yarn

yarn add @algorandfoundation/algokit-utils

Quick Example

import { AlgorandClient } from '@algorandfoundation/algokit-utils'

// Connect to LocalNet
const algorand = AlgorandClient.fromEnvironment()

// Create and fund a test account
const account = algorand.account.random()
await algorand.account.ensureFunded(account, algorand.account.localNetDispenser(), (10).algo())

// Send a payment
const result = await algorand.send.payment({
  sender: account.addr,
  receiver: 'RECEIVERADDRESS',
  amount: (1).algo(),
})

console.log('Transaction ID:', result.txIds[0])

Features

AlgorandClient

The main entry point for interacting with Algorand networks.

Transaction Composer

Build and send atomic transaction groups with ease.

App Client

Deploy and interact with smart contracts.

Testing Utilities

Comprehensive testing support for LocalNet.