Skip to main content

Balance

The balance of a particular coin type held by an address.

Balances can be held in coin objects, in the address's balance accumulator, or both.

type Balance {
  addressBalance: BigInt
  coinBalance: BigInt
  coinType: MoveType
  totalBalance: BigInt
}

Fields​

Balance.addressBalance ● BigInt scalar​

The balance held in the address's balance accumulator.

Balance.coinBalance ● BigInt scalar​

The balance held in coin objects owned by the address.

Balance.coinType ● MoveType object​

Coin type for the balance, such as 0x2::sui::SUI.

Balance.totalBalance ● BigInt scalar​

The sum of coinBalance and addressBalance.

Returned By​

multiGetBalances query

Member Of​

Address object ● BalanceConnection object ● BalanceEdge object ● CoinMetadata object ● DynamicField object ● IAddressable interface ● MoveObject object ● MovePackage object ● Object object