Skip to content

@gala-chain/api ∙ API

API > TokenInstance

Class: TokenInstance

Contents

Extends

Constructors

new TokenInstance()

new TokenInstance(): TokenInstance

Inherited from

ChainObject.constructor

Properties

additionalKey

additionalKey: string

Source

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

category

category: string

Source

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

collection

collection: string

Source

chain-api/src/types/TokenInstance.ts:258

instance

instance: BigNumber

Source

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

isNonFungible

isNonFungible: boolean

Source

chain-api/src/types/TokenInstance.ts:280

owner

owner?: UserAlias

Source

chain-api/src/types/TokenInstance.ts:284

type

type: string

Source

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

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

FUNGIBLE_TOKEN_INSTANCE

static FUNGIBLE_TOKEN_INSTANCE: BigNumber

Source

chain-api/src/types/TokenInstance.ts:288

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 INDEX_KEY: string = "GCTI2"

Source

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

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

GetCompositeKeyString()

GetCompositeKeyString(): string

Source

chain-api/src/types/TokenInstance.ts:291

copy()

copy(): TokenInstance

Inherited from

ChainObject.copy

Source

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

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

instanceKeyObj()

instanceKeyObj(): TokenInstanceKey

Source

chain-api/src/types/TokenInstance.ts:295

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

CreateCompositeKey()

static CreateCompositeKey(token): string

Parameters

▪ token: TokenInstanceKeyProperties

Source

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

GetCompositeKeyFromString()

static GetCompositeKeyFromString(tokenCid): string

Parameters

▪ tokenCid: string

Source

chain-api/src/types/TokenInstance.ts:324

GetFungibleInstanceFromClass()

static GetFungibleInstanceFromClass(token): string

Parameters

▪ token: TokenClassKeyProperties

Source

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

buildInstanceKeyList()

static buildInstanceKeyList(token): [string, string, string, string, string]

Parameters

▪ token: TokenInstanceKeyProperties

Source

chain-api/src/types/TokenInstance.ts:335

buildInstanceKeyObject()

static buildInstanceKeyObject(token): Promise\<TokenInstanceKey>

Parameters

▪ token: TokenInstanceKeyProperties

Source

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

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

isFungible()

static isFungible(instanceId): boolean

Parameters

▪ instanceId: BigNumber

Source

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

isNFT()

static isNFT(instanceId): boolean

Parameters

▪ instanceId: BigNumber

Source

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