@gala-chain/api ∙ API
API > FetchMintRequestsDto
Class: FetchMintRequestsDto
Contents
- Description
- Remarks
- Extends
- Constructors
- new FetchMintRequestsDto()
- Properties
- additionalKey
- category
- collection
- endTimestamp
- prefix
- signature
- signerAddress
- signerPublicKey
- signing
- startTimestamp
- type
- uniqueKey
- 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 FetchMintRequestsDto()
new FetchMintRequestsDto():
FetchMintRequestsDto
Inherited from
Properties
additionalKey
additionalKey:
string
Source
chain-api/src/types/mint.ts:224
category
category:
string
Source
chain-api/src/types/mint.ts:212
collection
collection:
string
Source
chain-api/src/types/mint.ts:206
endTimestamp
endTimestamp:
number
Source
chain-api/src/types/mint.ts:230
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:170
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:161
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:177
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:184
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:194
startTimestamp
startTimestamp:
number
Source
chain-api/src/types/mint.ts:227
type
type:
string
Source
chain-api/src/types/mint.ts:218
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:151
Methods
isSignatureValid()
isSignatureValid(
publicKey):boolean
Parameters
▪ publicKey: string
Inherited from
Source
chain-api/src/types/dtos.ts:278
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:218
sign()
sign(
privateKey,useDer):void
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:246
signed()
signed(
privateKey,useDer):FetchMintRequestsDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:272
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:196
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/dtos.ts:200
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.