Skip to content

@gala-chain/api ∙ API

API > HighThroughputGrantAllowanceDto

Class: HighThroughputGrantAllowanceDto

Experimental: Defines allowances to be created. High-throughput implementation.

2023-03-23

Contents

Extends

Constructors

new HighThroughputGrantAllowanceDto()

new HighThroughputGrantAllowanceDto(): HighThroughputGrantAllowanceDto

Inherited from

ChainCallDTO.constructor

Properties

allowanceType

allowanceType: AllowanceType

Source

chain-api/src/types/allowance.ts:351

expires

expires?: number

Source

chain-api/src/types/allowance.ts:367

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

chain-api/src/types/dtos.ts:159

quantities

quantities: GrantAllowanceQuantity[]

Source

chain-api/src/types/allowance.ts:347

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

chain-api/src/types/dtos.ts:150

signerAddress

signerAddress?: string

Inherited from

ChainCallDTO.signerAddress

Source

chain-api/src/types/dtos.ts:166

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

chain-api/src/types/dtos.ts:173

signing

signing?: SigningScheme

Inherited from

ChainCallDTO.signing

Source

chain-api/src/types/dtos.ts:183

tokenInstance

tokenInstance: TokenInstanceQueryKey

Source

chain-api/src/types/allowance.ts:338

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

chain-api/src/types/dtos.ts:140

uses

uses: BigNumber

Source

chain-api/src/types/allowance.ts:359

DEFAULT_EXPIRES

static DEFAULT_EXPIRES: number = 0

Source

chain-api/src/types/allowance.ts:327

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

chain-api/src/types/dtos.ts:257

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

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

ChainCallDTO.sign

Source

chain-api/src/types/dtos.ts:235

signed()

signed(privateKey, useDer): HighThroughputGrantAllowanceDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

chain-api/src/types/dtos.ts:251

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

chain-api/src/types/dtos.ts:185

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

chain-api/src/types/dtos.ts:189

deserialize()

static deserialize\<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

ChainCallDTO.deserialize

Description

Instantiate a class instance from a serialized object using the provided ClassConstructor.

Source

chain-api/src/types/dtos.ts:228