@gala-chain/api ∙ API
API > FetchTokenSupplyDto
Class: FetchTokenSupplyDto
Contents
- Description
- Remarks
- Extends
- Constructors
- new FetchTokenSupplyDto()
- Properties
- additionalKey
- category
- collection
- dtoExpiresAt
- dtoOperation
- multisig
- prefix
- signature
- signerAddress
- signerPublicKey
- signing
- type
- uniqueKey
- Methods
- isSignatureValid()
- serialize()
- sign()
- signed()
- validate()
- validateOrReject()
- withOperation()
- 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 FetchTokenSupplyDto()
new FetchTokenSupplyDto():
FetchTokenSupplyDto
Inherited from
Properties
additionalKey
additionalKey:
string
Source
chain-api/src/types/mint.ts:259
category
category:
string
Source
chain-api/src/types/mint.ts:247
collection
collection:
string
Source
chain-api/src/types/mint.ts:241
dtoExpiresAt
dtoExpiresAt?:
number
Inherited from
Source
chain-api/src/types/dtos.ts:234
dtoOperation
dtoOperation?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:227
multisig
multisig?:
string[]
Inherited from
Source
chain-api/src/types/dtos.ts:216
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:169
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:203
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:176
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:183
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:193
type
type:
string
Source
chain-api/src/types/mint.ts:253
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:160
Methods
isSignatureValid()
isSignatureValid(
publicKey,index?):boolean
Parameters
▪ publicKey: string
▪ index?: number
Inherited from
Source
chain-api/src/types/dtos.ts:343
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:258
sign()
sign(
privateKey,useDer):void
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:286
signed()
signed(
privateKey,useDer):FetchTokenSupplyDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:331
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:236
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/dtos.ts:240
withOperation()
withOperation(
operation):FetchTokenSupplyDto
Parameters
▪ operation: string
Inherited from
Source
chain-api/src/types/dtos.ts:337
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.