Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface NetworkStakingRewardsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
NetworkStakingRewards, NetworkStakingRewards.Builder
@Generated public interface NetworkStakingRewardsOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Timestamp
    getLastNodeRewardPaymentsTime()
    * The last time a node reward payment was made.
    long
    getPendingRewards()
    * The total staking rewards, in tinybars, that may be collected by all accounts staking to all nodes after the end of this staking period.
    boolean
    getStakingRewardsActivated()
    * A flag indicating that staking rewards are activated on the network.
    long
    getTotalStakedRewardStart()
    * A global snapshot of the `stake_to_reward` value for all nodes at the beginning of the current staking period.
    long
    getTotalStakedStart()
    * A global snapshot of the `stake` value for all nodes at the beginning of the current staking period.
    boolean
    hasLastNodeRewardPaymentsTime()
    * The last time a node reward payment was made.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getStakingRewardsActivated

      boolean getStakingRewardsActivated()
       *
 A flag indicating that staking rewards are activated on the network.
 <p>
 Among other criteria, this is set to true when the balance of 0.0.800
 (the account that pays rewards) reaches a minimum required balance.
      bool staking_rewards_activated = 1;
      Returns:
      The stakingRewardsActivated.

    • getTotalStakedRewardStart

      long getTotalStakedRewardStart()
       *
 A global snapshot of the `stake_to_reward` value for all nodes at the
 beginning of the current staking period.
 <p>
 The `stake_to_reward` value is the sum of balance and `staked_to_me` for
 all accounts staked to a node that do not decline staking rewards.<br/>
 This is needed for calculating rewards for current staking period without
 considering changes to `stake_to_reward` within the current staking period.<br/>
 This value SHALL be reset at the beginning of every staking period.
      int64 total_staked_reward_start = 2;
      Returns:
      The totalStakedRewardStart.

    • getTotalStakedStart

      long getTotalStakedStart()
       *
 A global snapshot of the `stake` value for all nodes at the beginning of
 the current staking period.
 <p>
 The `stake` value is the sum of balance and `staked_to_me` for all
 accounts staked to a node, and SHALL NOT consider whether the account
 has accepted or declined rewards.<br/>
 This value SHALL be reset at the beginning of every staking period.
      int64 total_staked_start = 3;
      Returns:
      The totalStakedStart.

    • getPendingRewards

      long getPendingRewards()
       *
 The total staking rewards, in tinybars, that may be collected by all
 accounts staking to all nodes after the end of this staking period.
 <p>
 This SHALL be calculated assuming that no account "renounces" its
 rewards by setting `decline_reward` to true, or is ineligible for some
 other reason.<br/>
 If a node is removed, the `pending_rewards` value of that node SHALL be
 subtracted from this value.
      int64 pending_rewards = 4;
      Returns:
      The pendingRewards.

    • hasLastNodeRewardPaymentsTime

      boolean hasLastNodeRewardPaymentsTime()
       *
 The last time a node reward payment was made. This will be set at the
 end of a staking period.
      .proto.Timestamp last_node_reward_payments_time = 5;
      Returns:
      Whether the lastNodeRewardPaymentsTime field is set.

    • getLastNodeRewardPaymentsTime

      Timestamp getLastNodeRewardPaymentsTime()
       *
 The last time a node reward payment was made. This will be set at the
 end of a staking period.
      .proto.Timestamp last_node_reward_payments_time = 5;
      Returns:
      The lastNodeRewardPaymentsTime.