Class RewardState

RewardsState represents the global parameters controlling the rate at which accounts accrue rewards.

Implements

Constructors

constructor

Properties

feeSink rewardsLevel rewardsPool rewardsRate rewardsRecalculationRound rewardsResidue encodingSchema

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

  • new RewardState(params): RewardState

  • Parameters

    • params: {
          feeSink: Address;
          rewardsLevel: bigint;
          rewardsPool: Address;
          rewardsRate: bigint;
          rewardsRecalculationRound: bigint;
          rewardsResidue: bigint;
      }
      • feeSink: Address
      • rewardsLevel: bigint
      • rewardsPool: Address
      • rewardsRate: bigint
      • rewardsRecalculationRound: bigint
      • rewardsResidue: bigint

    Returns RewardState

Properties

feeSink

feeSink: Address

The FeeSink address.

rewardsLevel

rewardsLevel: bigint

RewardsLevel specifies how many rewards, in MicroAlgos, have been distributed to each config.Protocol.RewardUnit of MicroAlgos since genesis.

rewardsPool

rewardsPool: Address

The RewardsPool address.

rewardsRate

rewardsRate: bigint

The number of new MicroAlgos added to the participation stake from rewards at the next round.

rewardsRecalculationRound

rewardsRecalculationRound: bigint

The round at which the RewardsRate will be recalculated.

rewardsResidue

rewardsResidue: bigint

The number of leftover MicroAlgos after the distribution of RewardsRate/rewardUnits MicroAlgos for every reward unit in the next round.

Static Readonly encodingSchema

encodingSchema: NamedMapSchema = ...

Methods

getEncodingSchema

toEncodingData

  • toEncodingData(): Map<string, unknown>

  • Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

    Returns Map<string, unknown>

Static fromEncodingData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc