Skip to content

@gala-chain/apiReadme | API


@gala-chain/api / TokenInstanceKey

Class: TokenInstanceKey

Extends

Constructors

new TokenInstanceKey()

new TokenInstanceKey(): TokenInstanceKey

Returns

TokenInstanceKey

Inherited from

ChainCallDTO.constructor

Properties

additionalKey

additionalKey: string

Source

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


category

category: string

Source

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


collection

collection: string

Source

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


instance

instance: BigNumber

Source

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


signature?

optional signature: string

Inherited from

ChainCallDTO.signature

Source

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


signerPublicKey?

optional signerPublicKey: string

Inherited from

ChainCallDTO.signerPublicKey

Source

chain-api/src/types/dtos.ts:143


trace?

optional trace: TraceContext

Inherited from

ChainCallDTO.trace

Source

chain-api/src/types/dtos.ts:99


type

type: string

Source

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


uniqueKey?

optional uniqueKey: string

Inherited from

ChainCallDTO.uniqueKey

Source

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


ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

Methods

getTokenClassKey()

getTokenClassKey(): TokenClassKey

Returns

TokenClassKey

Source

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


isFungible()

isFungible(): boolean

Returns

boolean

Source

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


isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

publicKey: string

Returns

boolean

Inherited from

ChainCallDTO.isSignatureValid

Source

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


serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

Source

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


sign()

sign(privateKey, useDer): void

Parameters

privateKey: string

useDer: boolean= false

Returns

void

Inherited from

ChainCallDTO.sign

Source

chain-api/src/types/dtos.ts:168


signed()

signed(privateKey, useDer): TokenInstanceKey

Creates a signed copy of current object.

Parameters

privateKey: string

useDer: boolean= false

Returns

TokenInstanceKey

Inherited from

ChainCallDTO.signed

Source

chain-api/src/types/dtos.ts:179


toQueryKey()

toQueryKey(): TokenInstanceQueryKey

Returns

TokenInstanceQueryKey

Source

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


toString()

toString(): string

Returns

string

Source

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


toStringKey()

toStringKey(): string

Returns

string

Source

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


validate()

validate(): Promise\<ValidationError[]>

Returns

Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

chain-api/src/types/dtos.ts:145


validateOrReject()

validateOrReject(): Promise\<void>

Returns

Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

chain-api/src/types/dtos.ts:149


deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

T

Parameters

constructor: ClassConstructor\<Inferred\<T, ChainCallDTO>>

object: string | Record\<string, unknown> | Record\<string, unknown>[]

Returns

T

Inherited from

ChainCallDTO.deserialize

Source

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


fungibleKey()

static fungibleKey(c): TokenInstanceKey

Parameters

c: TokenClassKey | TokenClass

Returns

TokenInstanceKey

Source

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


nftKey()

static nftKey(c, instance): TokenInstanceKey

Parameters

c: TokenClassKeyProperties | TokenClassKey | TokenClass

instance: string | number | BigNumber

Returns

TokenInstanceKey

Source

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