Skip to main content

Balance Queries

Functions for querying bonded balances and locked amounts.

trustBondingTotalBondedBalance​

Get the total bonded balance across all users.

Returns​

Promise<bigint> // Total bonded balance

Example​

import { trustBondingTotalBondedBalance } from '@0xintuition/protocol'
import { formatEther } from 'viem'

const totalBonded = await trustBondingTotalBondedBalance({ address: bondingAddress, publicClient })
console.log('Total bonded:', formatEther(totalBonded))

trustBondingTotalBondedBalanceAtEpochEnd​

Get total bonded balance at the end of an epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[bigint]Epoch numberYes

Returns​

Promise<bigint>

Example​

import { trustBondingTotalBondedBalanceAtEpochEnd } from '@0xintuition/protocol'

const balance = await trustBondingTotalBondedBalanceAtEpochEnd(
{ address: bondingAddress, publicClient },
{ args: [epochNumber] }
)
console.log('Total bonded at epoch end:', formatEther(balance))

trustBondingUserBondedBalanceAtEpochEnd​

Get user's bonded balance at the end of an epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[Address, bigint]User address, epoch numberYes

Returns​

Promise<bigint>

Example​

import { trustBondingUserBondedBalanceAtEpochEnd } from '@0xintuition/protocol'

const userBalance = await trustBondingUserBondedBalanceAtEpochEnd(
{ address: bondingAddress, publicClient },
{ args: [userAddress, epochNumber] }
)
console.log('User bonded at epoch end:', formatEther(userBalance))

trustBondingTotalLocked​

Get total locked amount.

Returns​

Promise<bigint>

Example​

import { trustBondingTotalLocked } from '@0xintuition/protocol'

const locked = await trustBondingTotalLocked({ address: bondingAddress, publicClient })
console.log('Total locked:', formatEther(locked))

See Also​