Skip to main content

Interface: GalaChainTokenBalanceSummary

GalaChain core SDK 1.0.0-rc.8

GalaChain core SDK 1.0.0-rc.8 / index / GalaChainTokenBalanceSummary

Interface: GalaChainTokenBalanceSummary

Defined in: packages/gala-core-sdk/dist/index.d.ts:2757

An owner's balance of one token class with its holds totalled. Every quantity is whole tokens as a plain decimal string (no exponent), computed exactly (bignumber.js), never scaled.

Properties​

availableQuantity​

readonly availableQuantity: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2771

quantity - lockedQuantity - inUseQuantity.

instanceIds​

readonly instanceIds: readonly string[]

Defined in: packages/gala-core-sdk/dist/index.d.ts:2773

The instance ids held (non-fungible tokens).

inUseHolds​

readonly inUseHolds: readonly GalaChainTokenHold[]

Defined in: packages/gala-core-sdk/dist/index.d.ts:2765

The in-use holds still in force (all of them with includeExpiredHolds).

inUseQuantity​

readonly inUseQuantity: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2769

The sum of inUseHolds.

lockedHolds​

readonly lockedHolds: readonly GalaChainTokenHold[]

Defined in: packages/gala-core-sdk/dist/index.d.ts:2763

The locks still in force (all of them with includeExpiredHolds).

lockedQuantity​

readonly lockedQuantity: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2767

The sum of lockedHolds.

owner​

readonly owner: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2758

quantity​

readonly quantity: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2761

The whole holding.

tokenClassKey​

readonly tokenClassKey: GalaChainTokenClassKey

Defined in: packages/gala-core-sdk/dist/index.d.ts:2759