@gala-chain/api • Readme | API

---

@gala-chain/api / TokenInstance

Class: TokenInstance

Extends

• ChainObject

Constructors

new TokenInstance()

new TokenInstance(): TokenInstance

Returns

TokenInstance

Inherited from

ChainObject.constructor

Properties

additionalKey

additionalKey: string

Source

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

---

category

category: string

Source

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

---

collection

collection: string

Source

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

---

instance

instance: BigNumber

Source

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

---

isNonFungible

isNonFungible: boolean

Source

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

---

owner?

optional owner: string

Source

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

---

type

type: string

Source

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

---

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

---

FUNGIBLE_TOKEN_INSTANCE

static FUNGIBLE_TOKEN_INSTANCE: BigNumber

Source

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

---

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

Source

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

---

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

GetCompositeKeyString()

GetCompositeKeyString(): string

Returns

string

Source

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

---

getCompositeKey()

getCompositeKey(): string

Returns

string

Inherited from

ChainObject.getCompositeKey

Source

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

---

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

---

CreateCompositeKey()

static CreateCompositeKey(token): string

Parameters

• token: TokenInstanceKeyProperties

Returns

string

Source

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

---

GetCompositeKeyFromString()

static GetCompositeKeyFromString(tokenCid): string

Parameters

• tokenCid: string

Returns

string

Source

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

---

GetFungibleInstanceFromClass()

static GetFungibleInstanceFromClass(token): string

Parameters

• token: TokenClassKeyProperties

Returns

string

Source

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

---

buildInstanceKeyList()

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

Parameters

• token: TokenInstanceKeyProperties

Returns

[string, string, string, string, string]

Source

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

---

buildInstanceKeyObject()

static buildInstanceKeyObject(token): Promise\<TokenInstanceKey>

Parameters

• token: TokenInstanceKeyProperties

Returns

Promise\<TokenInstanceKey>

Source

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

---

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

---

isFungible()

static isFungible(instanceId): boolean

Parameters

• instanceId: BigNumber

Returns

boolean

Source

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

---

isNFT()

static isNFT(instanceId): boolean

Parameters

• instanceId: BigNumber

Returns

boolean

Source

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