@gala-chain/api • Readme | API

@gala-chain/api / HighThroughputGrantAllowanceDto

Class: HighThroughputGrantAllowanceDto

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

2023-03-23

Extends

ChainCallDTO

Constructors

new HighThroughputGrantAllowanceDto()

new HighThroughputGrantAllowanceDto(): HighThroughputGrantAllowanceDto

Returns

HighThroughputGrantAllowanceDto

Inherited from

ChainCallDTO.constructor

Properties

allowanceType

allowanceType: AllowanceType

Source

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

expires?

optional expires: number

Source

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

quantities

quantities: GrantAllowanceQuantity[]

Source

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

signature?

optional signature: string

Inherited from

ChainCallDTO.signature

Source

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

signerPublicKey?

optional signerPublicKey: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

tokenInstance

tokenInstance: TokenInstanceQueryKey

Source

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

trace?

optional trace: TraceContext

Inherited from

ChainCallDTO.trace

Source

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

uniqueKey?

optional uniqueKey: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

uses

uses: BigNumber

Source

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

DEFAULT_EXPIRES

static DEFAULT_EXPIRES: number = 0

Source

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

ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

• publicKey: string

Returns

boolean

Inherited from

ChainCallDTO.isSignatureValid

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

Source

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

sign()

sign(privateKey, useDer): void

Parameters

• privateKey: string

• useDer: boolean= false

Returns

void

Inherited from

ChainCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): HighThroughputGrantAllowanceDto

Creates a signed copy of current object.

Parameters

• privateKey: string

• useDer: boolean= false

validate()

validate(): Promise\<ValidationError[]>

Returns

Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Returns

Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

• T

Parameters

• constructor: ClassConstructor\<Inferred\<T, ChainCallDTO>>

• object: string | Record\<string, unknown> | Record\<string, unknown>[]

Returns

T

Inherited from

ChainCallDTO.deserialize

Source

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