Skip to content

@gala-chain/api ∙ API

API > TokenBalance

Class: TokenBalance

Contents

Extends

Constructors

new TokenBalance(params)

new TokenBalance(params?): TokenBalance

Parameters

▪ params?: object

▪ params.additionalKey?: string

▪ params.category?: string

▪ params.collection?: string

▪ params.owner?: string

▪ params.type?: string

Overrides

ChainObject.constructor

Source

chain-api/src/types/TokenBalance.ts:123

Properties

additionalKey

readonly additionalKey: string

Source

chain-api/src/types/TokenBalance.ts:121

category

readonly category: string

Source

chain-api/src/types/TokenBalance.ts:113

collection

readonly collection: string

Source

chain-api/src/types/TokenBalance.ts:109

inUseHolds

private inUseHolds?: TokenHold[]

Source

chain-api/src/types/TokenBalance.ts:161

instanceIds

private instanceIds?: BigNumber[]

Token instance IDs for NFTs. It is also used to determine if the balance is for fungible or non-fungible tokens. If the array is undefined, then the balance is for fungible tokens.

Source

chain-api/src/types/TokenBalance.ts:151

lockedHolds

private lockedHolds?: TokenHold[]

Source

chain-api/src/types/TokenBalance.ts:156

owner

readonly owner: string

Source

chain-api/src/types/TokenBalance.ts:105

quantity

private quantity: BigNumber

Source

chain-api/src/types/TokenBalance.ts:165

type

readonly type: string

Source

chain-api/src/types/TokenBalance.ts:117

vestingPeriodStart

vestingPeriodStart?: number

Source

chain-api/src/types/TokenBalance.ts:174

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

chain-api/src/types/ChainObject.ts:46

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:49

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:51

INDEX_KEY

static readonly INDEX_KEY: "GCTB" = "GCTB"

Source

chain-api/src/types/TokenBalance.ts:101

MIN_UNICODE_RUNE_VALUE

static MIN_UNICODE_RUNE_VALUE: string = "\u0000"

Inherited from

ChainObject.MIN_UNICODE_RUNE_VALUE

Source

chain-api/src/types/ChainObject.ts:44

Methods

cleanupExpiredHolds()

cleanupExpiredHolds(currentTime): TokenBalance

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:346

clearHolds()

clearHolds(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:305

containsAnyNftInstanceId()

containsAnyNftInstanceId(): boolean

Source

chain-api/src/types/TokenBalance.ts:330

containsInstance()

private containsInstance(instanceId): boolean

Parameters

▪ instanceId: BigNumber

Source

chain-api/src/types/TokenBalance.ts:352

ensureCanAddInstance()

ensureCanAddInstance(instanceId): object

Parameters

▪ instanceId: BigNumber

Returns

add()

Source

chain-api/src/types/TokenBalance.ts:198

ensureCanAddQuantity()

ensureCanAddQuantity(quantity): object

Parameters

▪ quantity: BigNumber

Returns

add()

Source

chain-api/src/types/TokenBalance.ts:421

ensureCanLockInstance()

ensureCanLockInstance(hold, currentTime): object

Parameters

▪ hold: TokenHold

▪ currentTime: number

Returns

lock()

Source

chain-api/src/types/TokenBalance.ts:241

ensureCanLockQuantity()

ensureCanLockQuantity(hold): object

Parameters

▪ hold: TokenHold

Returns

lock()

Source

chain-api/src/types/TokenBalance.ts:468

ensureCanReleaseInstance()

ensureCanReleaseInstance(instanceId, name, currentTime): object

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Returns

release()

Source

chain-api/src/types/TokenBalance.ts:286

ensureCanRemoveInstance()

ensureCanRemoveInstance(instanceId, currentTime): object

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Returns

remove()

Source

chain-api/src/types/TokenBalance.ts:224

ensureCanSubtractQuantity()

ensureCanSubtractQuantity(quantity, currentTime): object

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Returns

subtract()

Source

chain-api/src/types/TokenBalance.ts:432

ensureCanUnlockInstance()

ensureCanUnlockInstance(instanceId, name, currentTime): object

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Returns

unlock()

Source

chain-api/src/types/TokenBalance.ts:254

ensureCanUnlockQuantity()

ensureCanUnlockQuantity(quantity, currentTime, name?, callingUser?, isTokenAuthority?): object

Parameters

▪ quantity: BigNumber

▪ currentTime: number

▪ name?: string

▪ callingUser?: string

▪ isTokenAuthority?: boolean

Returns

unlock()

Source

chain-api/src/types/TokenBalance.ts:494

ensureCanUseInstance()

ensureCanUseInstance(hold, currentTime): object

Parameters

▪ hold: TokenHold

▪ currentTime: number

Returns

use()

Source

chain-api/src/types/TokenBalance.ts:273

ensureContainsNoNftInstances()

private ensureContainsNoNftInstances(): void

Source

chain-api/src/types/TokenBalance.ts:565

ensureInstanceIsInBalance()

private ensureInstanceIsInBalance(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

chain-api/src/types/TokenBalance.ts:371

ensureInstanceIsNft()

private ensureInstanceIsNft(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

chain-api/src/types/TokenBalance.ts:364

ensureInstanceIsNotLocked()

private ensureInstanceIsNotLocked(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:388

ensureInstanceIsNotLockedWithTheSameName()

private ensureInstanceIsNotLockedWithTheSameName(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:377

ensureInstanceIsNotUsed()

private ensureInstanceIsNotUsed(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:395

ensureIsValidQuantityForFungible()

private ensureIsValidQuantityForFungible(quantity): void

Parameters

▪ quantity: BigNumber

Source

chain-api/src/types/TokenBalance.ts:575

ensureQuantityIsSpendable()

private ensureQuantityIsSpendable(quantity, currentTime): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:444

ensureTokenQuantityHoldIsFungible()

private ensureTokenQuantityHoldIsFungible(hold): void

Parameters

▪ hold: TokenHold

Source

chain-api/src/types/TokenBalance.ts:458

findInUseHold()

findInUseHold(instanceId, currentTime): undefined | TokenHold

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:325

findLockedHold()

findLockedHold(instanceId, name, currentTime): undefined | TokenHold

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:316

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

chain-api/src/types/ChainObject.ts:80

getCurrentLockedQuantity()

private getCurrentLockedQuantity(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:552

getLockedQuantityTotal()

getLockedQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:415

getNftInstanceCount()

getNftInstanceCount(): number

Source

chain-api/src/types/TokenBalance.ts:180

getNftInstanceIds()

getNftInstanceIds(): BigNumber[]

Source

chain-api/src/types/TokenBalance.ts:342

getQuantityTotal()

getQuantityTotal(): BigNumber

Source

chain-api/src/types/TokenBalance.ts:404

getSpendableQuantityTotal()

getSpendableQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:409

getUnexpiredInUseHolds()

getUnexpiredInUseHolds(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:194

getUnexpiredLockedHolds()

getUnexpiredLockedHolds(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:184

getUnexpiredLockedHoldsSortedByAscendingExpiration()

getUnexpiredLockedHoldsSortedByAscendingExpiration(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:188

isCallingUserAuthorized()

private isCallingUserAuthorized(hold, name?, callingUser?, isTokenAuthority?): boolean

Parameters

▪ hold: TokenHold

▪ name?: string

▪ callingUser?: string

▪ isTokenAuthority?: boolean

Source

chain-api/src/types/TokenBalance.ts:479

isInstanceInUse()

private isInstanceInUse(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:360

isInstanceLocked()

private isInstanceLocked(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:356

isInstanceSpendable()

isInstanceSpendable(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:334

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

chain-api/src/types/ChainObject.ts:53

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

chain-api/src/types/ChainObject.ts:69

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

chain-api/src/types/ChainObject.ts:57

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

chain-api/src/types/ChainObject.ts:61

decodeFromBase58()

static decodeFromBase58(base58String): string

Parameters

▪ base58String: string

Inherited from

ChainObject.decodeFromBase58

Source

chain-api/src/types/ChainObject.ts:142

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

▪ T

Parameters

▪ constructor: ClassConstructor\<Inferred\<T, ChainObject>>

▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]

Inherited from

ChainObject.deserialize

Source

chain-api/src/types/ChainObject.ts:73

encodeToBase58()

static encodeToBase58(stringKey): string

Parameters

▪ stringKey: string

Inherited from

ChainObject.encodeToBase58

Source

chain-api/src/types/ChainObject.ts:137

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

chain-api/src/types/ChainObject.ts:105

getEncodableStringKeyFromParts()

static getEncodableStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getEncodableStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:129

getPartsFromEncodableStringKey()

static getPartsFromEncodableStringKey(stringKey): string[]

Parameters

▪ stringKey: string

Inherited from

ChainObject.getPartsFromEncodableStringKey

Source

chain-api/src/types/ChainObject.ts:133

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:125