Code Examples

Browse 117 runnable TypeScript examples organized by feature area. Each example is self-contained and demonstrates specific functionality of the AlgoKit Utils library.

Quick Start

# Clone the repository
git clone https://github.com/algorandfoundation/algokit-utils-ts.git
cd algokit-utils-ts

# Install dependencies and build the package
npm ci
npm run build

# Install examples dependencies
cd examples
npm ci

# Run any example
npm run example algorand_client/01-client-instantiation.ts

Prerequisites

• Node.js >= 20.0
• AlgoKit CLI installed
• LocalNet running for network examples (algokit localnet start)

Some examples marked “No LocalNet required” work with pure utility functions.

Categories

ABI Encoding

ABI type parsing, encoding, and decoding following the ARC-4 specification.

15 examples

Mnemonic Utilities

Mnemonic and seed conversion utilities following the Algorand 25-word mnemonic standard.

5 examples

Algod Client

Algorand node operations and queries using the AlgodClient.

19 examples

Algorand Client

High-level AlgorandClient API for simplified blockchain interactions.

16 examples

Common Utilities

Utility functions and helpers.

12 examples

Indexer Client

Blockchain data queries using the IndexerClient.

16 examples

KMD Client

Key Management Daemon operations for wallet and key management.

13 examples

Testing

Testing utilities for mock server setup and Vitest integration.

7 examples

Transactions

Low-level transaction construction and signing.

14 examples