@gala-chain/api ∙ API
API > LockTokenDto
Class: LockTokenDto
Contents
- Description
- Remarks
- Extends
- Constructors
- new LockTokenDto()
- Properties
- lockAuthority
- owner
- prefix
- quantity
- signature
- signerAddress
- signerPublicKey
- signing
- tokenInstance
- uniqueKey
- useAllowances
- 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 LockTokenDto()
new LockTokenDto():
LockTokenDto
Inherited from
Properties
lockAuthority
lockAuthority?:
UserRef
Source
chain-api/src/types/lock.ts:54
owner
owner?:
UserRef
Source
chain-api/src/types/lock.ts:44
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:159
quantity
quantity:
BigNumber
Source
chain-api/src/types/lock.ts:71
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:150
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:166
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:173
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:183
tokenInstance
tokenInstance:
TokenInstanceKey
Source
chain-api/src/types/lock.ts:64
uniqueKey
uniqueKey:
string
Inherited from
Source
chain-api/src/types/dtos.ts:271
useAllowances
useAllowances?:
string[]
Source
chain-api/src/types/lock.ts:79
Methods
isSignatureValid()
isSignatureValid(
publicKey):boolean
Parameters
▪ publicKey: string
Inherited from
SubmitCallDTO.isSignatureValid
Source
chain-api/src/types/dtos.ts:257
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:207
sign()
sign(
privateKey,useDer):void
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:235
signed()
signed(
privateKey,useDer):LockTokenDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:251
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:185
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
SubmitCallDTO.validateOrReject
Source
chain-api/src/types/dtos.ts:189
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.