Skip to content

@gala-chain/api ∙ API

API > UnlockTokenDto

Class: UnlockTokenDto

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

new UnlockTokenDto(): UnlockTokenDto

Inherited from

SubmitCallDTO.constructor

Properties

dtoExpiresAt

dtoExpiresAt?: number

Inherited from

SubmitCallDTO.dtoExpiresAt

Source

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

dtoOperation

dtoOperation?: string

Inherited from

SubmitCallDTO.dtoOperation

Source

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

lockedHoldName

lockedHoldName?: string

Source

chain-api/src/types/lock.ts:178

multisig

multisig?: string[]

Inherited from

SubmitCallDTO.multisig

Source

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

owner

owner?: UserRef

Source

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

prefix

prefix?: string

Inherited from

SubmitCallDTO.prefix

Source

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

quantity

quantity?: BigNumber

Source

chain-api/src/types/lock.ts:163

signature

signature?: string

Inherited from

SubmitCallDTO.signature

Source

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

signerAddress

signerAddress?: UserRef

Inherited from

SubmitCallDTO.signerAddress

Source

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

signerPublicKey

signerPublicKey?: string

Inherited from

SubmitCallDTO.signerPublicKey

Source

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

tokenInstance

tokenInstance: TokenInstanceKey

Source

chain-api/src/types/lock.ts:154

uniqueKey

uniqueKey: string

Inherited from

SubmitCallDTO.uniqueKey

Source

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

Methods

expiresInMs()

expiresInMs(ms): UnlockTokenDto

Parameters

▪ ms: number

Inherited from

SubmitCallDTO.expiresInMs

Source

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

getAllSignatures()

getAllSignatures(): string[]

Inherited from

SubmitCallDTO.getAllSignatures

Source

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

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

SubmitCallDTO.isSignatureValid

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

SubmitCallDTO.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

SubmitCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): UnlockTokenDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

SubmitCallDTO.signed

Source

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

SubmitCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

SubmitCallDTO.validateOrReject

Source

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

withOperation()

withOperation(operation): UnlockTokenDto

Parameters

▪ operation: string

Inherited from

SubmitCallDTO.withOperation

Source

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

withSigner()

withSigner(ref): UnlockTokenDto

Parameters

▪ ref: UserRef

Inherited from

SubmitCallDTO.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

SubmitCallDTO.deserialize

Description

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

Source

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