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?: UserAlias

▪ params.type?: string

Overrides

ChainObject.constructor

Source

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

Properties

additionalKey

readonly additionalKey: string

Source

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

category

readonly category: string

Source

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

collection

readonly collection: string

Source

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

inUseHolds

private inUseHolds?: TokenHold[]

Source

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

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

lockedHolds

private lockedHolds?: TokenHold[]

Source

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

owner

readonly owner: UserAlias

Source

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

quantity

private quantity: BigNumber

Source

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

type

readonly type: string

Source

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

vestingPeriodStart

vestingPeriodStart?: number

Source

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

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

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

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

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

INDEX_KEY

static readonly INDEX_KEY: "GCTB" = "GCTB"

Source

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

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

Methods

addInstance()

addInstance(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

addQuantity()

addQuantity(quantity): void

Parameters

▪ quantity: BigNumber

Source

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

cleanupExpiredHolds()

cleanupExpiredHolds(currentTime): TokenBalance

Parameters

▪ currentTime: number

Source

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

clearHolds()

clearHolds(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

containsAnyNftInstanceId()

containsAnyNftInstanceId(): boolean

Source

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

containsInstance()

private containsInstance(instanceId): boolean

Parameters

▪ instanceId: BigNumber

Source

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

copy()

copy(): TokenBalance

Inherited from

ChainObject.copy

Source

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

ensureContainsNoNftInstances()

private ensureContainsNoNftInstances(): void

Source

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

ensureInstanceIsInBalance()

private ensureInstanceIsInBalance(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

ensureInstanceIsNft()

private ensureInstanceIsNft(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

ensureInstanceIsNotLocked()

private ensureInstanceIsNotLocked(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

ensureInstanceIsNotLockedWithTheSameName()

private ensureInstanceIsNotLockedWithTheSameName(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

ensureInstanceIsNotUsed()

private ensureInstanceIsNotUsed(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

ensureIsValidQuantityForFungible()

private ensureIsValidQuantityForFungible(quantity): void

Parameters

▪ quantity: BigNumber

Source

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

ensureQuantityIsSpendable()

private ensureQuantityIsSpendable(quantity, currentTime): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Source

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

ensureTokenQuantityHoldIsFungible()

private ensureTokenQuantityHoldIsFungible(hold): void

Parameters

▪ hold: TokenHold

Source

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

findInUseHold()

findInUseHold(instanceId, currentTime): undefined | TokenHold

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

findLockedHold()

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

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

getCurrentLockedQuantity()

private getCurrentLockedQuantity(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getLockedQuantityTotal()

getLockedQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getNftInstanceCount()

getNftInstanceCount(): number

Source

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

getNftInstanceIds()

getNftInstanceIds(): BigNumber[]

Source

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

getQuantityTotal()

getQuantityTotal(): BigNumber

Source

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

getSpendableQuantityTotal()

getSpendableQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getUnexpiredInUseHolds()

getUnexpiredInUseHolds(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

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

getUnexpiredLockedHolds()

getUnexpiredLockedHolds(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

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

getUnexpiredLockedHoldsSortedByAscendingExpiration()

getUnexpiredLockedHoldsSortedByAscendingExpiration(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

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

isCallingUserAuthorized()

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

Parameters

▪ hold: TokenHold

▪ name?: string

▪ callingUser?: UserAlias

▪ isTokenAuthority?: boolean

Source

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

isInstanceInUse()

private isInstanceInUse(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

isInstanceLocked()

private isInstanceLocked(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

isInstanceSpendable()

isInstanceSpendable(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

lockInstance()

lockInstance(hold, currentTime): void

Parameters

▪ hold: TokenHold

▪ currentTime: number

Source

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

lockQuantity()

lockQuantity(hold): void

Parameters

▪ hold: TokenHold

Source

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

releaseInstance()

releaseInstance(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

removeInstance()

removeInstance(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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

subtractQuantity()

subtractQuantity(quantity, currentTime): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Source

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

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

unlockInstance()

unlockInstance(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

unlockQuantity()

unlockQuantity(quantity, currentTime, name?, callingUser?, isTokenAuthority?): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

▪ name?: string

▪ callingUser?: UserAlias

▪ isTokenAuthority?: boolean

Source

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

useInstance()

useInstance(hold, currentTime): void

Parameters

▪ hold: TokenHold

▪ currentTime: number

Source

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

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

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

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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