Skip to main content

Balance

The total balance for a particular coin type.

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

Fields​

Balance.addressBalance ● BigInt scalar​

The balance as tracked by the accumulator object for the address.

Balance.coinBalance ● BigInt scalar​

Total balance across all owned coin objects of the coin type.

Balance.coinType ● MoveType object​

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

Balance.totalBalance ● BigInt scalar​

The sum total of the accumulator balance and individual coin balances owned by the address.

Member Of​

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