AlgorandClient

Defined in: src/algorand-client.ts:19

A client that brokers easy access to Algorand functionality.

Accessors

account

Get Signature

get account(): AccountManager

Defined in: src/algorand-client.ts:185

Get or create accounts that can sign transactions.

Example

const accountManager = AlgorandClient.mainNet().account;

Returns

AccountManager

The AccountManager instance.

app

Get Signature

get app(): AppManager

Defined in: src/algorand-client.ts:205

Methods for interacting with apps.

Example

const appManager = AlgorandClient.mainNet().app;

Returns

AppManager

The AppManager instance.

appDeployer

Get Signature

get appDeployer(): AppDeployer

Defined in: src/algorand-client.ts:215

Methods for deploying apps and managing app deployment metadata.

Example

const deployer = AlgorandClient.mainNet().appDeployer;

Returns

AppDeployer

The AppDeployer instance.

asset

Get Signature

get asset(): AssetManager

Defined in: src/algorand-client.ts:195

Methods for interacting with assets.

Example

const assetManager = AlgorandClient.mainNet().asset;

Returns

AssetManager

The AssetManager instance.

client

Get Signature

get client(): ClientManager

Defined in: src/algorand-client.ts:175

Get clients, including algosdk clients and app clients.

Example

const clientManager = AlgorandClient.mainNet().client;

Returns

ClientManager

The ClientManager instance.

createTransaction

Get Signature

get createTransaction(): AlgorandClientTransactionCreator

Defined in: src/algorand-client.ts:293

Methods for creating a transaction.

Example

const payment = await AlgorandClient.mainNet().createTransaction.payment({
 sender: "SENDERADDRESS",
 receiver: "RECEIVERADDRESS",
 amount: algo(1)
})

Returns

AlgorandClientTransactionCreator

The AlgorandClientTransactionCreator instance.

network

Get Signature

get network(): NetworkManager

Defined in: src/algorand-client.ts:235

Methods for interacting with the network. Provides utilities for querying blockchain state and waiting for specific conditions.

Example

// Get last round
const lastRound = await algorand.network.getLastRound()

// Wait for a specific round
await algorand.network.waitUntilRound(1000n)

// LocalNet-specific: block warp
await algorand.network.localNet.blockWarp(100n)

Returns

NetworkManager

The NetworkManager instance.

send

Get Signature

get send(): AlgorandClientTransactionSender

Defined in: src/algorand-client.ts:279

Methods for sending a transaction.

Example

const result = await AlgorandClient.mainNet().send.payment({
 sender: "SENDERADDRESS",
 receiver: "RECEIVERADDRESS",
 amount: algo(1)
})

Returns

AlgorandClientTransactionSender

The AlgorandClientTransactionSender instance.

Methods

getSuggestedParams()

getSuggestedParams(): Promise<{ consensusVersion: string; fee: bigint; firstValid: bigint; flatFee: boolean; genesisHash: Uint8Array; genesisId: string; lastValid: bigint; minFee: bigint; }>

Defined in: src/algorand-client.ts:154

Get suggested params for a transaction (either cached or from algod if the cache is stale or empty)

Returns

Promise<{ consensusVersion: string; fee: bigint; firstValid: bigint; flatFee: boolean; genesisHash: Uint8Array; genesisId: string; lastValid: bigint; minFee: bigint; }>

The suggested transaction parameters.

Example

const params = await AlgorandClient.mainNet().getSuggestedParams();

newGroup()

newGroup(composerConfig?): TransactionComposer

Defined in: src/algorand-client.ts:257

Start a new TransactionComposer transaction group

Parameters

composerConfig?

TransactionComposerConfig

Returns

TransactionComposer

A new instance of TransactionComposer.

Example

{@includeCode ./algorand-client.spec.ts#example-newGroup}

See

Full working example

registerErrorTransformer()

registerErrorTransformer(transformer): void

Defined in: src/algorand-client.ts:243

Register a function that will be used to transform an error caught when simulating or executing composed transaction groups made from newGroup

Parameters

transformer

ErrorTransformer

Returns

void

setDefaultSigner()

setDefaultSigner(signer): AlgorandClient

Defined in: src/algorand-client.ts:77

Sets the default signer to use if no other signer is specified.

Parameters

signer

The signer to use, either a TransactionSigner or a AddressWithSigner

AddressWithTransactionSigner | TransactionSigner

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const signer = new SigningAccount(account, account.addr)
const algorand = AlgorandClient.mainNet().setDefaultSigner(signer)

setDefaultValidityWindow()

setDefaultValidityWindow(validityWindow): AlgorandClient

Defined in: src/algorand-client.ts:62

Sets the default validity window for transactions.

Parameters

validityWindow

The number of rounds between the first and last valid rounds

number | bigint

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000);

setSigner()

setSigner(sender, signer): AlgorandClient

Defined in: src/algorand-client.ts:113

Tracks the given signer against the given sender for later signing.

Parameters

sender

The sender address to use this signer for

string | Address

signer

TransactionSigner

The signer to sign transactions with for the given sender

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const signer = new SigningAccount(account, account.addr)
const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer)

setSignerFromAccount()

setSignerFromAccount(account): AlgorandClient

Defined in: src/algorand-client.ts:97

Tracks the given account (object that encapsulates an address and a signer) for later signing.

Parameters

account

The account to register, which can be a AddressWithSigner or a algosdk.Account, algosdk.LogicSigAccount, SigningAccount or MultisigAccount

MultisigAccount | AddressWithTransactionSigner | LogicSigAccount

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const accountManager = AlgorandClient.mainNet()
 .setSignerFromAccount(algosdk.generateAccount())
 .setSignerFromAccount(new algosdk.LogicSigAccount(program, args))
 .setSignerFromAccount(new SigningAccount(account, sender))
 .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2]))
 .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner})

setSuggestedParamsCache()

setSuggestedParamsCache(suggestedParams, until?): AlgorandClient

Defined in: src/algorand-client.ts:128

Sets a cache value to use for suggested transaction params.

Parameters

suggestedParams

The suggested params to use

consensusVersion

string

ConsensusVersion indicates the consensus protocol version as of LastRound.

fee

bigint

Fee is the suggested transaction fee Fee is in units of micro-Algos per byte. Fee may fall to zero but transactions must still have a fee of at least MinTxnFee for the current network protocol.

firstValid

bigint

flatFee

boolean

genesisHash

Uint8Array

GenesisHash is the hash of the genesis block.

genesisId

string

GenesisID is an ID listed in the genesis block.

lastValid

bigint

minFee

bigint

The minimum transaction fee (not per byte) required for the txn to validate for the current network protocol.

until?

Date

A date until which to cache, or if not specified then the timeout is used

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParams, new Date(+new Date() + 3_600_000))

setSuggestedParamsCacheTimeout()

setSuggestedParamsCacheTimeout(timeout): AlgorandClient

Defined in: src/algorand-client.ts:143

Sets the timeout for caching suggested params.

Parameters

timeout

number

The timeout in milliseconds

Returns

AlgorandClient

The AlgorandClient so method calls can be chained

Example

const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000)

unregisterErrorTransformer()

unregisterErrorTransformer(transformer): void

Defined in: src/algorand-client.ts:247

Parameters

transformer

ErrorTransformer

Returns

void

defaultLocalNet()

static defaultLocalNet(): AlgorandClient

Defined in: src/algorand-client.ts:306

Creates an AlgorandClient pointing at default LocalNet ports and API token.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

{@includeCode ./algorand-client.spec.ts#example-defaultLocalNet}

See

Full working example

fromClients()

static fromClients(clients): AlgorandClient

Defined in: src/algorand-client.ts:349

Creates an AlgorandClient pointing to the given client(s).

Parameters

clients

AlgoSdkClients

The clients to use.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

const algorand = AlgorandClient.fromClients({ algod, indexer, kmd });

fromConfig()

static fromConfig(config): AlgorandClient

Defined in: src/algorand-client.ts:383

Creates an AlgorandClient from the given config.

Parameters

config

AlgoConfig

The config to use.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig });

fromEnvironment()

static fromEnvironment(): AlgorandClient

Defined in: src/algorand-client.ts:372

Creates an AlgorandClient loading the configuration from environment variables.

Retrieve configurations from environment variables when defined or get default LocalNet configuration if they aren’t defined.

Expects to be called from a Node.js environment.

If process.env.ALGOD_SERVER is defined it will use that along with optional process.env.ALGOD_PORT and process.env.ALGOD_TOKEN.

If process.env.INDEXER_SERVER is defined it will use that along with optional process.env.INDEXER_PORT and process.env.INDEXER_TOKEN.

If either aren’t defined it will use the default LocalNet config.

It will return a KMD configuration that uses process.env.KMD_PORT (or port 4002) if process.env.ALGOD_SERVER is defined, otherwise it will use the default LocalNet config unless it detects testnet or mainnet.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

const client = AlgorandClient.fromEnvironment();

mainNet()

static mainNet(): AlgorandClient

Defined in: src/algorand-client.ts:334

Creates an AlgorandClient pointing at MainNet using AlgoNode.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

const algorand = AlgorandClient.mainNet();

testNet()

static testNet(): AlgorandClient

Defined in: src/algorand-client.ts:320

Creates an AlgorandClient pointing at TestNet using AlgoNode.

Returns

AlgorandClient

An instance of the AlgorandClient.

Example

const algorand = AlgorandClient.testNet();