Index of every page on this site: llms.txt
All skills
Run it yourself

Guide for writing TypeScript code with AlgoKit Utils (`@algorandfoundation/algokit-utils`). Use this skill whenever the user is building on Algorand with TypeScript — client setup, account management, payments, asset operations, atomic transaction groups, smart contract deployment and interaction (AppFactory, AppClient, ARC-56/ARC-32 specs), raw app calls, key registration, network management, testing with algorandFixture, error handling, and the low-level crypto primitives under `@algorandfoundation/algokit-utils/crypto` (Ed25519 keygen/signing/verification, SHA-512/256 `hash`, Peikert xHD BIP44 wallets, wrapped-secret patterns). Trigger on imports from `@algorandfoundation/algokit-utils` (incl. `/crypto`, `/testing`, `/transact` subpaths), references to `AlgorandClient`, `AppFactory`, `AppClient`, `AlgoAmount`, `algorandFixture`, `ed25519Generator`, `peikertXHdWalletGenerator`, `hash`, `WrappedEd25519Seed`, or `RawEd25519Signer`. Also on any TypeScript or JavaScript code that builds on Algorand.

  • 20 files
  • 97.5 KB
  • Updated 7 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/algorandfoundation/algorand-agent-skills/algokit-utils-ts

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈258 tokens for metadata: the name and description. ≈1.6k when used: this file. ≈23k more on demand in 19 files.

Description uses 12.9% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈1031 characters, or 12.9%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

AlgoKit Utils TypeScript — Quick Reference

This skill targets version 10.x of @algorandfoundation/algokit-utils.

This skill provides idiomatic patterns for @algorandfoundation/algokit-utils (TypeScript). When helping users, prefer the patterns below over raw algosdk calls — AlgoKit Utils wraps the SDK with higher-level, type-safe abstractions.

How to use this skill

Reference docs are split into individual files under references/. Only read the file(s) relevant to the user's question — this keeps context lean. The table below maps topics to filenames.

Key concepts

  • AlgorandClient is the single entry point. Create one via AlgorandClient.defaultLocalNet(), .testNet(), .mainNet(), .fromConfig(), or .fromEnvironment().
  • AlgoAmount provides type-safe Algo/microAlgo values. Use algo(5), microAlgo(1000), AlgoAmount.Algo(5), or the prototype extensions (5).algo().
  • AccountManager (algorand.account.*) handles key generation, mnemonics, multisig, logic sigs, funding, and signer registration.
  • TransactionComposer (algorand.newGroup()) builds atomic groups with fluent chaining. Supports .addPayment(), .addAssetTransfer(), .addAppCallMethodCall(), etc.
  • AppFactory creates and deploys smart contracts from ARC-56/ARC-32 app specs. Supports idempotent deploy with onUpdate/onSchemaBreak strategies and template variable substitution.
  • AppClient interacts with deployed contracts — ABI method calls, state reads (global, local, box), bare calls, and the params builder for deferred composition.
  • Raw app calls via algorand.send.appCall(), .appCreate(), .appUpdate(), .appDelete(), .appCallMethodCall(), .appCreateMethodCall() when you don't have an app spec.
  • Crypto primitives are exposed via @algorandfoundation/algokit-utils/crypto (re-exporting @algorandfoundation/algokit-crypto). This subpath carries Ed25519 keypair generation/signing/verification (ed25519Generator, ed25519Verifier), Algorand's SHA-512/256 hash, the Peikert xHD BIP44 wallet (peikertXHdWalletGenerator), and the wrapped-secret pattern for HSM/KMS-backed keys (WrappedEd25519Seed, WrappedHdExtendedPrivateKey, ed25519SigningKeyFromWrappedSecret). Reach for it when you are building a custom RawEd25519Signer, deriving deterministic accounts from a seed, or computing Algorand-compatible hashes outside the transaction path.

Reference file index

Read only the file(s) relevant to the user's current question.

File What it covers
references/getting-started.md Installation, imports, LocalNet prerequisites
references/client-initialization.md LocalNet, TestNet, MainNet, custom config, env vars
references/account-management.md Random accounts, mnemonics, multisig, logic sigs, funding, signers
references/algoamount-and-value-handling.md algo(), microAlgo(), conversions, prototype extensions, fees
references/payment-transactions.md Simple payments, unsigned txns, notes, leases, fee control
references/asset-operations.md Create, opt-in/out, transfer, freeze, config, destroy, bulk ops, get info
references/key-registration.md Online/offline key registration for consensus participation
references/transaction-composition.md Atomic groups, build/send/simulate, fee control, clone
references/smart-contract-deployment.md AppFactory, bare/ABI create, idempotent deploy, template vars
references/smart-contract-interaction.md AppClient, ABI calls, bare calls, global/local/box state, params builder
references/raw-app-calls.md Low-level app create/call/update/delete, ABI method calls without app spec
references/network-and-client-management.md Algod/indexer/kmd access, LocalNet detection, rounds, timestamps, time/block warp
references/configuration-and-global-settings.md populateAppCallResources, confirmation rounds, logging
references/testing-utilities.md algorandFixture, newScope, generateAccount, transaction logger, log capture, indexer waits
references/error-handling.md Try/catch patterns, error transformers, overspend, app call rejections
references/ed25519.md Ed25519 keypair generation, raw signers, signature verification, pinned Noble backend
references/hashing.md Algorand SHA-512/256 hash, multisig and logic sig address construction
references/hd-wallets.md peikertXHdWalletGenerator, BIP44 paths, multi-account derivation, wiring into AccountManager
references/wrapped-secrets.md WrappedEd25519Seed, WrappedHdExtendedPrivateKey, ed25519SigningKeyFromWrappedSecret, HSM/KMS patterns

Common patterns to remember

  • algorand.send.* builds, signs, and submits in one call.
  • algorand.createTransaction.* builds without signing or sending.
  • appClient.params.* builds call params for deferred use in groups or nested args.
  • appClient.send.bare.* for bare calls; appClient.send.call() for ABI calls.
  • Readonly ABI methods (marked in ARC-56) automatically use simulate — no fees spent.
  • algorand.account.ensureFunded() is idempotent — skips if balance is already sufficient.
  • factory.deploy() is idempotent — creates, updates, replaces, or no-ops based on state.
  • Use Config.configure({ populateAppCallResources: true }) to auto-populate app call resources.
  • generateAddressWithSigners from @algorandfoundation/algokit-utils/transact accepts anything shaped like { ed25519Pubkey, rawEd25519Signer } (i.e. Ed25519SigningKey) and returns an AddressWithSigners. Pass its .signer to AccountManager.setSigner(addr, signer) — hardware wallets, KMS, and HD-derived keys all plug in through this single shape.
  • ed25519Generator, ed25519Verifier, and ed25519SigningKeyFromWrappedSecret are aliases that currently point at the @noble/ed25519-backed noble* variants. Import the noble* names directly when you need to pin the backend across future releases.
  • ed25519SigningKeyFromWrappedSecret always zeroes the unwrapped secret after use and throws an AggregateError when both the operation and the re-wrap fail — never catch and discard it silently.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 12acef7. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Steadyupdated 7 months ago

README badge

README badge for algorandfoundation/algorand-agent-skills/algokit-utils-ts