Skip to content

@gala-chain/api ∙ API

API > ChainCallDTO

Class: ChainCallDTO

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.

Extended By

Constructors

new ChainCallDTO()

new ChainCallDTO(): ChainCallDTO

Properties

prefix

prefix?: string

Source

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

signature

signature?: string

Source

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

signerAddress

signerAddress?: string

Source

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

signerPublicKey

signerPublicKey?: string

Source

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

signing

signing?: SigningScheme

Source

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

uniqueKey

uniqueKey?: string

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Source

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

serialize()

serialize(): string

Returns

string

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

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Source

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

signed()

signed(privateKey, useDer): ChainCallDTO

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Source

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

validate()

validate(): Promise\<ValidationError[]>

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Source

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

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

Description

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

Source

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