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

Properties

additionalKey

readonly additionalKey: string

Source

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

category

readonly category: string

Source

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

collection

readonly collection: string

Source

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

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

lockedHolds

private lockedHolds?: TokenHold[]

Source

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

owner

readonly owner: UserAlias

Source

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

quantity

private quantity: BigNumber

Source

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

type

readonly type: string

Source

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

vestingPeriodStart

vestingPeriodStart?: number

Source

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

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

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

addInstance()

addInstance(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

addQuantity()

addQuantity(quantity): void

Parameters

▪ quantity: BigNumber

Source

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

cleanupExpiredHolds()

cleanupExpiredHolds(currentTime): TokenBalance

Parameters

▪ currentTime: number

Source

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

clearHolds()

clearHolds(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

containsAnyNftInstanceId()

containsAnyNftInstanceId(): boolean

Source

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

containsInstance()

private containsInstance(instanceId): boolean

Parameters

▪ instanceId: BigNumber

Source

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

copy()

copy(): TokenBalance

Inherited from

ChainObject.copy

Source

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

ensureContainsNoNftInstances()

private ensureContainsNoNftInstances(): void

Source

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

ensureInstanceIsInBalance()

private ensureInstanceIsInBalance(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

ensureInstanceIsNft()

private ensureInstanceIsNft(instanceId): void

Parameters

▪ instanceId: BigNumber

Source

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

ensureInstanceIsNotLocked()

private ensureInstanceIsNotLocked(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

ensureInstanceIsNotLockedWithTheSameName()

private ensureInstanceIsNotLockedWithTheSameName(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

ensureIsValidQuantityForFungible()

private ensureIsValidQuantityForFungible(quantity): void

Parameters

▪ quantity: BigNumber

Source

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

ensureQuantityIsSpendable()

private ensureQuantityIsSpendable(quantity, currentTime): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Source

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

ensureTokenQuantityHoldIsFungible()

private ensureTokenQuantityHoldIsFungible(hold): void

Parameters

▪ hold: TokenHold

Source

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

findLockedHold()

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

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

getCurrentLockedQuantity()

private getCurrentLockedQuantity(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getLockedQuantityTotal()

getLockedQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getNftInstanceCount()

getNftInstanceCount(): number

Source

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

getNftInstanceIds()

getNftInstanceIds(): BigNumber[]

Source

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

getQuantityTotal()

getQuantityTotal(): BigNumber

Source

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

getSpendableQuantityTotal()

getSpendableQuantityTotal(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

getUnexpiredLockedHolds()

getUnexpiredLockedHolds(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

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

getUnexpiredLockedHoldsSortedByAscendingExpiration()

getUnexpiredLockedHoldsSortedByAscendingExpiration(currentTime): TokenHold[]

Parameters

▪ currentTime: number

Source

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

isCallingUserAuthorized()

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

Parameters

▪ hold: TokenHold

▪ name?: string

▪ callingUser?: UserAlias

▪ isTokenAuthority?: boolean

Source

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

isInstanceLocked()

private isInstanceLocked(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

isInstanceSpendable()

isInstanceSpendable(instanceId, currentTime): boolean

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

lockInstance()

lockInstance(hold, currentTime): void

Parameters

▪ hold: TokenHold

▪ currentTime: number

Source

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

lockQuantity()

lockQuantity(hold): void

Parameters

▪ hold: TokenHold

Source

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

removeInstance()

removeInstance(instanceId, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ currentTime: number

Source

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

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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

subtractQuantity()

subtractQuantity(quantity, currentTime): void

Parameters

▪ quantity: BigNumber

▪ currentTime: number

Source

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

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

unlockInstance()

unlockInstance(instanceId, name, currentTime): void

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

▪ currentTime: number

Source

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

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

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

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

encodeToBase58()

static encodeToBase58(stringKey): string

Parameters

▪ stringKey: string

Inherited from

ChainObject.encodeToBase58

Source

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

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

getEncodableStringKeyFromParts()

static getEncodableStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getEncodableStringKeyFromParts

Source

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

getPartsFromEncodableStringKey()

static getPartsFromEncodableStringKey(stringKey, expectedParts): string[]

Parameters

▪ stringKey: string

▪ expectedParts: number

Inherited from

ChainObject.getPartsFromEncodableStringKey

Source

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

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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