Skip to content

@gala-chain/connect ∙ API

API > TokenInstanceKey

Class: TokenInstanceKey

Contents

Description

The base DTO (Data Transfer Object) class. Provides common properties and methods for signing, uniqueness, validation, and serialization. All other DTOs in the SDK extend from this base class. To implement custom a custom DTO, create a new class that extends ChainCallDTO, and use the class-validator npm package to decorate the properties of the new class.

Remarks

Additional details for specific properties of this class are generated via the class-validator-jsonschema npm module and can either be viewed in the source code or in the OpenAPI documentation served alongside GalaChain's API endpoints.

Extends

Constructors

new TokenInstanceKey()

new TokenInstanceKey(): 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

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

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

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

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

signerAddress

signerAddress?: string

Inherited from

ChainCallDTO.signerAddress

Source

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

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

signing

signing?: SigningScheme

Inherited from

ChainCallDTO.signing

Source

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

type

type: string

Source

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

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

Methods

getTokenClassKey()

getTokenClassKey(): TokenClassKey

Source

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

isFungible()

isFungible(): boolean

Source

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

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

Description

Serialze this object to string in a determinsitic fashion. See Hyperledger Fabric's documentation on JSON Determinism for more details.

Source

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

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): TokenInstanceKey

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

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

toQueryKey()

toQueryKey(): TokenInstanceQueryKey

Source

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

toString()

toString(): string

Source

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

toStringKey()

toStringKey(): string

Source

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

deserialize()

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

Type parameters

▪ T

Parameters

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

ClassConstructor that extends ChainCallDTO

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

serialized string or plain object to be instantiated via the provided ClassConstructor

Returns

An instantiated class created with the provided ClassConstructor

Inherited from

ChainCallDTO.deserialize

Description

Instantiate a class instance from a serialized object using the provided ClassConstructor.

Source

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

fungibleKey()

static fungibleKey(c): TokenInstanceKey

Parameters

▪ c: TokenClassKey | TokenClass

Source

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

nftKey()

static nftKey(c, instance): TokenInstanceKey

Parameters

▪ c: TokenClassKeyProperties | TokenClassKey | TokenClass

▪ instance: string | number | BigNumber

Source

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