Skip to content

@gala-chain/apiAPI


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

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


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

Methods

GetCompositeKeyString()

GetCompositeKeyString(): string

Source

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


getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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


serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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


toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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


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


CreateCompositeKey()

static CreateCompositeKey(token): string

Parameters

token: TokenInstanceKeyProperties

Source

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


GetCompositeKeyFromString()

static GetCompositeKeyFromString(tokenCid): string

Parameters

tokenCid: string

Source

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


GetFungibleInstanceFromClass()

static GetFungibleInstanceFromClass(token): string

Parameters

token: TokenClassKeyProperties

Source

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


buildInstanceKeyList()

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

Parameters

token: TokenInstanceKeyProperties

Source

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


buildInstanceKeyObject()

static buildInstanceKeyObject(token): Promise\<TokenInstanceKey>

Parameters

token: TokenInstanceKeyProperties

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>[]

Inherited from

ChainObject.deserialize

Source

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


getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

indexKey: string

parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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


getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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


isFungible()

static isFungible(instanceId): boolean

Parameters

instanceId: BigNumber

Source

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


isNFT()

static isNFT(instanceId): boolean

Parameters

instanceId: BigNumber

Source

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