Skip to content

@gala-chain/api • Readme | API

@gala-chain/api / TokenBalance

Class: TokenBalance

Extends

Constructors

new TokenBalance(params)

new TokenBalance(params?): TokenBalance

Parameters

• params?

• params.additionalKey?: string

• params.category?: string

• params.collection?: string

• params.owner?: string

• params.type?: string

Returns

TokenBalance

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 optional inUseHolds: TokenHold[]

Source

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

instanceIds?

private optional 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 optional 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

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

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

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

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

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:41

Methods

cleanupExpiredHolds()

cleanupExpiredHolds(currentTime): TokenBalance

Parameters

• currentTime: number

Returns

TokenBalance

Source

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

clearHolds()

clearHolds(instanceId, currentTime): void

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

void

Source

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

containsAnyNftInstanceId()

containsAnyNftInstanceId(): boolean

Returns

boolean

Source

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

containsInstance()

private containsInstance(instanceId): boolean

Parameters

• instanceId: BigNumber

Returns

boolean

Source

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

ensureCanAddInstance()

ensureCanAddInstance(instanceId): object

Parameters

• instanceId: BigNumber

Returns

object

add()
Returns

void

Source

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

ensureCanAddQuantity()

ensureCanAddQuantity(quantity): object

Parameters

• quantity: BigNumber

Returns

object

add()
Returns

void

Source

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

ensureCanLockInstance()

ensureCanLockInstance(hold, currentTime): object

Parameters

• hold: TokenHold

• currentTime: number

Returns

object

lock()
Returns

void

Source

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

ensureCanLockQuantity()

ensureCanLockQuantity(hold): object

Parameters

• hold: TokenHold

Returns

object

lock()
Returns

void

Source

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

ensureCanReleaseInstance()

ensureCanReleaseInstance(instanceId, name, currentTime): object

Parameters

• instanceId: BigNumber

• name: undefined | string

• currentTime: number

Returns

object

release()
Returns

void

Source

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

ensureCanRemoveInstance()

ensureCanRemoveInstance(instanceId, currentTime): object

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

object

remove()
Returns

void

Source

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

ensureCanSubtractQuantity()

ensureCanSubtractQuantity(quantity, currentTime): object

Parameters

• quantity: BigNumber

• currentTime: number

Returns

object

subtract()
Returns

void

Source

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

ensureCanUnlockInstance()

ensureCanUnlockInstance(instanceId, name, currentTime): object

Parameters

• instanceId: BigNumber

• name: undefined | string

• currentTime: number

Returns

object

unlock()
Returns

void

Source

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

ensureCanUnlockQuantity()

ensureCanUnlockQuantity(quantity, currentTime, name?, lockAuthority?): object

Parameters

• quantity: BigNumber

• currentTime: number

• name?: string

• lockAuthority?: string

Returns

object

unlock()
Returns

void

Source

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

ensureCanUseInstance()

ensureCanUseInstance(hold, currentTime): object

Parameters

• hold: TokenHold

• currentTime: number

Returns

object

use()
Returns

void

Source

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

ensureContainsNoNftInstances()

private ensureContainsNoNftInstances(): void

Returns

void

Source

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

ensureInstanceIsInBalance()

private ensureInstanceIsInBalance(instanceId): void

Parameters

• instanceId: BigNumber

Returns

void

Source

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

ensureInstanceIsNft()

private ensureInstanceIsNft(instanceId): void

Parameters

• instanceId: BigNumber

Returns

void

Source

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

ensureInstanceIsNotLocked()

private ensureInstanceIsNotLocked(instanceId, currentTime): void

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

void

Source

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

ensureInstanceIsNotLockedWithTheSameName()

private ensureInstanceIsNotLockedWithTheSameName(instanceId, name, currentTime): void

Parameters

• instanceId: BigNumber

• name: undefined | string

• currentTime: number

Returns

void

Source

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

ensureInstanceIsNotUsed()

private ensureInstanceIsNotUsed(instanceId, currentTime): void

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

void

Source

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

ensureIsValidQuantityForFungible()

private ensureIsValidQuantityForFungible(quantity): void

Parameters

• quantity: BigNumber

Returns

void

Source

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

ensureQuantityIsSpendable()

private ensureQuantityIsSpendable(quantity, currentTime): void

Parameters

• quantity: BigNumber

• currentTime: number

Returns

void

Source

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

ensureTokenQuantityHoldIsFungible()

private ensureTokenQuantityHoldIsFungible(hold): void

Parameters

• hold: TokenHold

Returns

void

Source

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

findInUseHold()

findInUseHold(instanceId, currentTime): undefined | TokenHold

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

undefined | TokenHold

Source

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

findLockedHold()

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

Parameters

• instanceId: BigNumber

• name: undefined | string

• currentTime: number

Returns

undefined | TokenHold

Source

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

getCompositeKey()

getCompositeKey(): string

Returns

string

Inherited from

ChainObject.getCompositeKey

Source

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

getCurrentLockedQuantity()

private getCurrentLockedQuantity(currentTime): BigNumber

Parameters

• currentTime: number

Returns

BigNumber

Source

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

getLockedQuantityTotal()

getLockedQuantityTotal(currentTime): BigNumber

Parameters

• currentTime: number

Returns

BigNumber

Source

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

getNftInstanceCount()

getNftInstanceCount(): number

Returns

number

Source

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

getNftInstanceIds()

getNftInstanceIds(): BigNumber[]

Returns

BigNumber[]

Source

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

getQuantityTotal()

getQuantityTotal(): BigNumber

Returns

BigNumber

Source

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

getSpendableQuantityTotal()

getSpendableQuantityTotal(currentTime): BigNumber

Parameters

• currentTime: number

Returns

BigNumber

Source

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

getUnexpiredInUseHolds()

getUnexpiredInUseHolds(currentTime): TokenHold[]

Parameters

• currentTime: number

Returns

TokenHold[]

Source

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

getUnexpiredLockedHolds()

getUnexpiredLockedHolds(currentTime): TokenHold[]

Parameters

• currentTime: number

Returns

TokenHold[]

Source

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

getUnexpiredLockedHoldsSortedByAscendingExpiration()

getUnexpiredLockedHoldsSortedByAscendingExpiration(currentTime): TokenHold[]

Parameters

• currentTime: number

Returns

TokenHold[]

Source

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

isInstanceInUse()

private isInstanceInUse(instanceId, currentTime): boolean

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

boolean

Source

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

isInstanceLocked()

private isInstanceLocked(instanceId, currentTime): boolean

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

boolean

Source

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

isInstanceSpendable()

isInstanceSpendable(instanceId, currentTime): boolean

Parameters

• instanceId: BigNumber

• currentTime: number

Returns

boolean

Source

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

isMatchingHold()

private isMatchingHold(hold, name?, lockAuthority?): boolean

Parameters

• hold: TokenHold

• name?: string

• lockAuthority?: string

Returns

boolean

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

ChainObject.serialize

Source

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

toPlainObject()

toPlainObject(): Record\<string, unknown>

Returns

Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

validate()

validate(): Promise\<ValidationError[]>

Returns

Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Returns

Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

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

deserialize()

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

Type parameters

• T

Parameters

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

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

Returns

T

Inherited from

ChainObject.deserialize

Source

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

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

• indexKey: string

• parts: unknown[]

Returns

string

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

• parts: string[]

Returns

string

Inherited from

ChainObject.getStringKeyFromParts

Source

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