getBalance()

The getBalance() method retrieves the connected wallet's current balance from the Irys network.

Returns

TypeDescription
BigNumberWallet balance in atomic units. You can convert it into standard units using irys.utils.fromAtomic()

Example

Note
Note
Use a token-specific version of getIrysUploader() to connect to an Irys Bundler before uploading.
const irys = await getIrysUploader();

// Get loaded balance in atomic units
const atomicBalance = await irys.getBalance();
console.log(`Node balance (atomic units) = ${atomicBalance}`);

// Convert balance to standard
const convertedBalance = irys.utils.fromAtomic(atomicBalance);
console.log(`Node balance (converted) = ${convertedBalance}`);

Key Points

  • Returns balance in atomic units (smallest denomination)
  • Requires an initialized Irys uploader instance
  • Conversion utility available via irys.utils.fromAtomic() for standard unit display