@gala-chain/api • Readme | API

@gala-chain/api / LockTokenDto

Class: LockTokenDto

Extends

ChainCallDTO

Constructors

new LockTokenDto()

new LockTokenDto(): LockTokenDto

Returns

LockTokenDto

Inherited from

ChainCallDTO.constructor

Properties

lockAuthority?

optional lockAuthority: string

Source

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

owner?

optional owner: string

Source

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

quantity

quantity: BigNumber

Source

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

signature?

optional signature: string

Inherited from

ChainCallDTO.signature

Source

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

signerPublicKey?

optional signerPublicKey: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

tokenInstance

tokenInstance: TokenInstanceKey

Source

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

trace?

optional trace: TraceContext

Inherited from

ChainCallDTO.trace

Source

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

uniqueKey?

optional uniqueKey: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

useAllowances?

optional useAllowances: string[]

Source

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

ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

• publicKey: string

Returns

boolean

Inherited from

ChainCallDTO.isSignatureValid

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

Source

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

sign()

sign(privateKey, useDer): void

Parameters

• privateKey: string

• useDer: boolean= false

Returns

void

Inherited from

ChainCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): LockTokenDto

Creates a signed copy of current object.

Parameters

• privateKey: string

• useDer: boolean= false

validate()

validate(): Promise\<ValidationError[]>

Returns

Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Returns

Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

• T

Parameters

• constructor: ClassConstructor\<Inferred\<T, ChainCallDTO>>

• object: string | Record\<string, unknown> | Record\<string, unknown>[]

Returns

T

Inherited from

ChainCallDTO.deserialize

Source

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