Algod Client

← Back to Examples Overview

Algorand node operations and queries using the AlgodClient.

Examples (19)

Example	Description
Node Health and Status	This example demonstrates how to check node health and status using the AlgodClient methods: healthCheck(), ready(), status(), and statusAfterBlock().
Version and Genesis Information	This example demonstrates how to retrieve node version information and genesis configuration using the AlgodClient methods: version() and genesis().
Ledger Supply Information	This example demonstrates how to retrieve ledger supply information using the AlgodClient method: supply().
Account Information	This example demonstrates how to retrieve comprehensive account information using the AlgodClient methods: accountInformation(), accountApplicationInformation(), and accountAssetInformation().
Transaction Parameters	This example demonstrates how to get suggested transaction parameters using suggestedParams() and transactionParams() methods. These parameters are essential for constructing valid transactions on the Algorand network.
Send and Confirm Transaction	This example demonstrates how to send transactions and wait for confirmation using sendRawTransaction() and pendingTransactionInformation(). It shows the complete lifecycle of submitting a transaction to the Algorand network.
Pending Transactions	This example demonstrates how to query pending transactions in the transaction pool using pendingTransactions() and pendingTransactionsByAddress(). Pending transactions are those that have been submitted but not yet confirmed in a block.
Block Data	This example demonstrates how to retrieve block information using the AlgodClient methods: block(), blockHash(), and blockTxIds().
Asset Information	This example demonstrates how to retrieve asset information using the AlgodClient method: assetById()
Application Information	This example demonstrates how to retrieve application information using the AlgodClient method: applicationById()
Application Boxes	This example demonstrates how to query application boxes using the AlgodClient methods: applicationBoxes() and applicationBoxByName()
TEAL Compile and Disassemble	This example demonstrates how to compile TEAL source code to bytecode and disassemble bytecode back to TEAL using the AlgodClient methods: tealCompile(source, options?) - Compile TEAL source to bytecode tealDisassemble(bytecode) - Disassemble bytecode back to TEAL
Transaction Simulation	This example demonstrates how to simulate transactions before submitting them to the Algorand network. Simulation allows you to: Preview transaction outcomes without committing to the blockchain Estimate transaction fees Detect potential errors before spending fees Debug smart contract execution
Ledger State Deltas	This example demonstrates how to retrieve ledger state deltas using: ledgerStateDelta(round) - Get state changes for a specific round ledgerStateDeltaForTransactionGroup(txId) - Get deltas for a specific transaction group transactionGroupLedgerStateDeltasForRound(round) - Get all transaction group deltas in a round State deltas show what changed in the ledger (accounts, balances, apps, assets) between rounds. Note: These endpoints may require node configuration to enable (EnableDeveloperAPI=true).
Transaction Proof	This example demonstrates how to get transaction proofs using: transactionProof(round, txId) - Get the Merkle proof for a transaction Transaction proofs are cryptographic proofs that a transaction is included in a specific block. They are used for light client verification, allowing clients to verify transaction inclusion without downloading the entire blockchain. The proof uses a Merkle tree structure where: Each transaction in a block is a leaf in the tree The root of the tree is committed in the block header The proof provides the sibling hashes needed to reconstruct the root
Light Block Header Proof	This example demonstrates how to get light block header proofs using: lightBlockHeaderProof(round) - Get the proof for a block header Light block header proofs are part of Algorand’s State Proof system, which allows light clients and other blockchains to verify Algorand’s blockchain state without needing to sync all blocks or trust intermediaries. Key concepts: State proofs are generated at regular intervals (every 256 rounds on MainNet) Light block header proofs verify that a block header is part of the state proof interval The proof uses a vector commitment tree (similar to Merkle tree) structure Only blocks within a state proof interval have available light block header proofs
State Proof	This example demonstrates how to get state proofs using: stateProof(round) - Get the state proof for a specific round State proofs are cryptographic proofs that attest to the state of the Algorand blockchain. They allow external systems (like bridges, light clients, and other blockchains) to verify Algorand’s blockchain state without trusting any intermediary. Key concepts: State proofs are generated at regular intervals (every 256 rounds on MainNet) Each state proof covers a range of block headers (the interval) State proofs are signed by a supermajority of online stake The proof uses post-quantum secure cryptographic techniques (Falcon signatures)
DevMode Timestamp Offset	This example demonstrates how to manage block timestamp offset in DevMode using: blockTimeStampOffset() - Get the current timestamp offset setBlockTimeStampOffset(offset) - Set a new timestamp offset In DevMode, you can control the timestamp of blocks by setting an offset. This is useful for testing time-dependent smart contracts without waiting for real time to pass. Key concepts: Timestamp offset is in seconds Setting offset to 0 resets to using the real clock New blocks will have timestamps = realTime + offset These endpoints only work on DevMode nodes (LocalNet in dev mode)
Sync Round Management	This example demonstrates how to manage the sync round using: syncRound() - Get the minimum sync round the ledger will cache setSyncRound(round) - Set the minimum sync round unsetSyncRound() - Unset/reset the sync round What is the sync round? The sync round is a configuration that controls the minimum round the node will keep data for. When set, the node will: Only keep block data from this round onwards Allow old block data to be deleted/pruned Reduce storage requirements for archival data This is useful for: Nodes that only need recent data (not full archival history) Indexers that only need data from a specific point forward Applications that don’t need ancient historical data Key concepts: syncRound() returns GetSyncRoundResponse with { round: bigint } setSyncRound(round) sets the minimum round to keep unsetSyncRound() removes the sync round restriction Historical data below the sync round may be unavailable

Quick Start

Run any example from the repository’s examples directory:

cd examples
npm run example algod_client/01-*.ts