@gala-chain/api ∙ API
API > FetchFeeChannelPaymentsDto
Class: FetchFeeChannelPaymentsDto
Contents
- Description
- Remarks
- Extends
- Constructors
- new FetchFeeChannelPaymentsDto()
- Properties
- bookmark
- day
- dtoExpiresAt
- feeCode
- hours
- limit
- minutes
- month
- paidByUser
- prefix
- signature
- signerAddress
- signerPublicKey
- signing
- txId
- uniqueKey
- year
- 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 FetchFeeChannelPaymentsDto()
new FetchFeeChannelPaymentsDto():
FetchFeeChannelPaymentsDto
Inherited from
Properties
bookmark
bookmark?:
string
Source
chain-api/src/types/fee.ts:333
day
day?:
string
Source
chain-api/src/types/fee.ts:287
dtoExpiresAt
dtoExpiresAt?:
number
Inherited from
Source
chain-api/src/types/dtos.ts:202
feeCode
feeCode?:
string
Source
chain-api/src/types/fee.ts:311
hours
hours?:
string
Source
chain-api/src/types/fee.ts:295
limit
limit?:
number
Source
chain-api/src/types/fee.ts:340
minutes
minutes?:
string
Source
chain-api/src/types/fee.ts:304
month
month?:
string
Source
chain-api/src/types/fee.ts:279
paidByUser
paidByUser?:
UserRef
Source
chain-api/src/types/fee.ts:318
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:171
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:162
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:178
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:185
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:195
txId
txId?:
string
Source
chain-api/src/types/fee.ts:325
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:152
year
year?:
string
Source
chain-api/src/types/fee.ts:271
Methods
isSignatureValid()
isSignatureValid(
publicKey):boolean
Parameters
▪ publicKey: string
Inherited from
Source
chain-api/src/types/dtos.ts:286
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:226
sign()
sign(
privateKey,useDer):void
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:254
signed()
signed(
privateKey,useDer):FetchFeeChannelPaymentsDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:280
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:204
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/dtos.ts:208
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.