@gala-chain/api ∙ API

---

API > TokenInstanceQueryKey

Class: TokenInstanceQueryKey

Contents

• Description
• Remarks
• Extends
• Constructors
• new TokenInstanceQueryKey()
• Properties
• additionalKey
• category
• collection
• dtoExpiresAt
• dtoOperation
• instance
• multisig
• prefix
• signature
• signerAddress
• signerPublicKey
• type
• uniqueKey
• Methods
• expiresInMs()
• getAllSignatures()
• isCompleteKey()
• isSignatureValid()
• publicKeyProperties()
• serialize()
• sign()
• signed()
• toCompleteKey()
• toQueryParams()
• validate()
• validateOrReject()
• withOperation()
• withSigner()
• deserialize()

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

• ChainCallDTO

Constructors

new TokenInstanceQueryKey()

new TokenInstanceQueryKey(): TokenInstanceQueryKey

Inherited from

ChainCallDTO.constructor

Properties

additionalKey

additionalKey?: string

Source

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

---

category

category?: string

Source

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

---

collection

collection: string

Source

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

---

dtoExpiresAt

dtoExpiresAt?: number

Inherited from

ChainCallDTO.dtoExpiresAt

Source

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

---

dtoOperation

dtoOperation?: string

Inherited from

ChainCallDTO.dtoOperation

Source

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

---

instance

instance?: BigNumber

Source

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

---

multisig

multisig?: string[]

Inherited from

ChainCallDTO.multisig

Source

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

---

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

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

---

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

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

---

signerAddress

signerAddress?: UserRef

Inherited from

ChainCallDTO.signerAddress

Source

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

---

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

---

type

type?: string

Source

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

---

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

Methods

expiresInMs()

expiresInMs(ms): TokenInstanceQueryKey

Parameters

▪ ms: number

Inherited from

ChainCallDTO.expiresInMs

Source

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

---

getAllSignatures()

getAllSignatures(): string[]

Inherited from

ChainCallDTO.getAllSignatures

Source

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

---

isCompleteKey()

isCompleteKey(): boolean

Source

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

---

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

---

publicKeyProperties()

publicKeyProperties(): string[]

Source

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

---

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

---

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

---

signed()

signed(privateKey, useDer): TokenInstanceQueryKey

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

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

---

toCompleteKey()

toCompleteKey(): TokenInstanceKey

Source

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

---

toQueryParams()

toQueryParams(): string[]

Source

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

---

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

---

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

---

withOperation()

withOperation(operation): TokenInstanceQueryKey

Parameters

▪ operation: string

Inherited from

ChainCallDTO.withOperation

Source

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

---

withSigner()

withSigner(ref): TokenInstanceQueryKey

Parameters

▪ ref: UserRef

Inherited from

ChainCallDTO.withSigner

Source

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

---

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