@gala-chain/api ∙ API
API > UnlockTokenDto
Class: UnlockTokenDto
Contents
- Description
- Remarks
- Extends
- Constructors
- new UnlockTokenDto()
- Properties
- lockedHoldName
- owner
- prefix
- quantity
- signature
- signerAddress
- signerPublicKey
- signing
- tokenInstance
- 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
Constructors
new UnlockTokenDto()
new UnlockTokenDto():
UnlockTokenDto
Inherited from
Properties
lockedHoldName
lockedHoldName?:
string
Source
chain-api/src/types/lock.ts:165
owner
owner?:
string
Source
chain-api/src/types/lock.ts:157
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:160
quantity
quantity?:
BigNumber
Source
chain-api/src/types/lock.ts:150
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:151
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:167
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:174
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:184
tokenInstance
tokenInstance:
TokenInstanceKey
Source
chain-api/src/types/lock.ts:141
trace
trace?:
TraceContext
Inherited from
Source
chain-api/src/types/dtos.ts:126
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:141
ENCODING
staticreadonlyENCODING:"base64"="base64"
Inherited from
Source
chain-api/src/types/dtos.ts:127
Methods
isSignatureValid()
isSignatureValid(
publicKey):boolean
Parameters
▪ publicKey: string
Inherited from
Source
chain-api/src/types/dtos.ts:258
serialize()
serialize():
string
Returns
string
Inherited from
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
Source
chain-api/src/types/dtos.ts:236
signed()
signed(
privateKey,useDer):UnlockTokenDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:252
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:186
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/dtos.ts:190
deserialize()
staticdeserialize\<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
Description
Instantiate a class instance from a serialized object using the provided ClassConstructor.