Skip to main content

Interface: TokenBalanceInput

GalaChain core SDK 1.0.0-rc.8

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

Interface: TokenBalanceInput

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

fetchTokenBalance: one owner's balance of one token class, with its holds summed.

Properties​

asOf?​

optional asOf?: number

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

The time holds are judged at, in epoch milliseconds (default now).

includeExpiredHolds?​

optional includeExpiredHolds?: boolean

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

Keep holds that have expired (default false: an expired hold no longer holds anything).

owner​

owner: string

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

The owner (see BalancesFilter.owner).

tokenClassKey​

tokenClassKey: TokenClassKeyInput

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

The token class (pipe string with exactly four parts, $ composite key, or object).