@gala-chain/api ∙ API

---

API > CollectDto

Class: CollectDto

Contents

• Description
• Remarks
• Extends
• Constructors
• new CollectDto(token0, token1, fee, amount0Requested, amount1Requested, tickLower, tickUpper)
• Properties
• amount0Requested
• amount1Requested
• fee
• prefix
• signature
• signerAddress
• signerPublicKey
• signing
• tickLower
• tickUpper
• token0
• token1
• trace
• uniqueKey
• ENCODING
• Methods
• isSignatureValid()
• serialize()
• sign()
• signed()
• validate()
• validateOrReject()
• 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 CollectDto(token0, token1, fee, amount0Requested, amount1Requested, tickLower, tickUpper)

new CollectDto(token0, token1, fee, amount0Requested, amount1Requested, tickLower, tickUpper): CollectDto

Parameters

▪ token0: TokenClassKey

▪ token1: TokenClassKey

▪ fee: number

▪ amount0Requested: BigNumber

▪ amount1Requested: BigNumber

▪ tickLower: number

▪ tickUpper: number

Overrides

ChainCallDTO.constructor

Source

chain-api/src/types/DexDtos.ts:401

Properties

amount0Requested

amount0Requested: BigNumber

Source

chain-api/src/types/DexDtos.ts:392

---

amount1Requested

amount1Requested: BigNumber

Source

chain-api/src/types/DexDtos.ts:395

---

fee

fee: number

Source

chain-api/src/types/DexDtos.ts:389

---

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

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

---

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

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

---

signerAddress

signerAddress?: string

Inherited from

ChainCallDTO.signerAddress

Source

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

---

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

---

signing

signing?: SigningScheme

Inherited from

ChainCallDTO.signing

Source

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

---

tickLower

tickLower: number

Source

chain-api/src/types/DexDtos.ts:397

---

tickUpper

tickUpper: number

Source

chain-api/src/types/DexDtos.ts:399

---

token0

token0: TokenClassKey

Source

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

---

token1

token1: TokenClassKey

Source

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

---

trace

trace?: TraceContext

Inherited from

ChainCallDTO.trace

Source

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

---

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

---

ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

---

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

---

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

---

signed()

signed(privateKey, useDer): CollectDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

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

---

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

---

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

---

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