Skip to content

@gala-chain/api ∙ API

API > BatchDto

Class: BatchDto

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 BatchDto()

new BatchDto(): BatchDto

Inherited from

ChainCallDTO.constructor

Properties

dtoExpiresAt

dtoExpiresAt?: number

Inherited from

ChainCallDTO.dtoExpiresAt

Source

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

dtoOperation

dtoOperation?: string

Inherited from

ChainCallDTO.dtoOperation

Source

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

multisig

multisig?: string[]

Inherited from

ChainCallDTO.multisig

Source

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

noPartialSuccess

noPartialSuccess?: boolean

Source

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

operations

operations: BatchOperationDto[]

Source

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

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

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

writesLimit

writesLimit?: number

Source

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

BATCH_SIZE_LIMIT

static readonly BATCH_SIZE_LIMIT: number = 1_000

Source

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

WRITES_DEFAULT_LIMIT

static readonly WRITES_DEFAULT_LIMIT: number = 10_000

Source

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

WRITES_HARD_LIMIT

static readonly WRITES_HARD_LIMIT: number = 100_000

Source

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

Methods

expiresInMs()

expiresInMs(ms): BatchDto

Parameters

▪ ms: number

Inherited from

ChainCallDTO.expiresInMs

Source

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

getAllSignatures()

getAllSignatures(): string[]

Inherited from

ChainCallDTO.getAllSignatures

Source

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

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

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

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): BatchDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

withOperation()

withOperation(operation): BatchDto

Parameters

▪ operation: string

Inherited from

ChainCallDTO.withOperation

Source

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

withSigner()

withSigner(ref): BatchDto

Parameters

▪ ref: UserRef

Inherited from

ChainCallDTO.withSigner

Source

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

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