Skip to main content
Version: v29.0.x

Class: Subsidies

Defined in: src/api/entities/Subsidies.ts:8

Handles all Account Subsidies related functionality

Extends

Methods

getBeneficiaries()

getBeneficiaries(): Promise<SubsidyWithAllowance[]>

Defined in: src/api/entities/Subsidies.ts:12

Get the list of Subsidy relationship along with their subsidized amount for which this Account is the subsidizer

Returns

Promise<SubsidyWithAllowance[]>


getSubsidizer()

Call Signature

getSubsidizer(): Promise<null | SubsidyWithAllowance>

Defined in: src/api/entities/Subsidies.ts:60

Get the Subsidy relationship along with the subsidized amount for this Account is the beneficiary.

Returns

Promise<null | SubsidyWithAllowance>

the Subsidy relationship, or null if this Account isn't being subsidized

Call Signature

getSubsidizer(callback: SubCallback<null | SubsidyWithAllowance>): Promise<UnsubCallback>

Defined in: src/api/entities/Subsidies.ts:70

Get the Subsidy relationship along with the subsidized amount for this Account is the beneficiary.

Parameters
ParameterTypeDescription

callback

SubCallback<null | SubsidyWithAllowance>

Callback function that can be used to listen for changes to the subsidy relationship

Returns

Promise<UnsubCallback>

the Subsidy relationship, or null if this Account isn't being subsidized

Note

can be subscribed to, if connected to node using a web socket