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

Interface StakingNodeInfoOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDeleted()
    * A flag indicating that this node has been removed from this network.
    long
    getMaxStake()
    * The maximum stake to this node that is considered to calculate its weight in the network consensus.
    long
    getMinStake()
    * The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus.
    long
    getNodeNumber()
    * The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node.
    long
    getPendingRewards()
    * The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period.
    long
    getRewardSumHistory(int index)
    * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).
    int
    getRewardSumHistoryCount()
    * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).
    List<Long>
    getRewardSumHistoryList()
    * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).
    long
    getStake()
    * The total amount of HBAR staked to this node.
    long
    getStakeRewardStart()
    * The snapshot of stake_to_reward value at the beginning of the current staking period.
    long
    getStakeToNotReward()
    * The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.
    long
    getStakeToReward()
    * The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.
    long
    getUnclaimedStakeRewardStart()
    * The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period.
    int
    getWeight()
    Deprecated.
    proto.StakingNodeInfo.weight is deprecated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getNodeNumber

      long getNodeNumber()
       *
 The entity number of this node.<br/>
 The shard and realm numbers are implied, based on the network address
 book entry for this node.
 <p>
 This value SHALL be unique within a given shard and realm.<br/>
 This value MAY be repeated across shards and/or realms.
      int64 node_number = 1;
      Returns:
      The nodeNumber.

    • getMinStake

      long getMinStake()
       *
 The minimum stake, in tinybar, that is required for this node to have a
 non-zero weight in the network consensus.
 <p>
 If the current value of `stake` is below this value, this node SHALL have
 a zero weight in network consensus.
      int64 min_stake = 2;
      Returns:
      The minStake.

    • getMaxStake

      long getMaxStake()
       *
 The maximum stake to this node that is considered to calculate its weight
 in the network consensus.
 <p>
 If the current `stake` value is above this limit, the excess staked HBAR
 SHALL NOT be considered when determining consensus weight.
      int64 max_stake = 3;
      Returns:
      The maxStake.

    • getStakeToReward

      long getStakeToReward()
       *
 The sum of balances of all accounts staked to this node, considering only
 accounts that choose to receive rewards.
      int64 stake_to_reward = 4;
      Returns:
      The stakeToReward.

    • getStakeToNotReward

      long getStakeToNotReward()
       *
 The sum of balances of all accounts staked to this node, considering only
 accounts that decline to receive rewards.
      int64 stake_to_not_reward = 5;
      Returns:
      The stakeToNotReward.

    • getStakeRewardStart

      long getStakeRewardStart()
       *
 The snapshot of stake_to_reward value at the beginning of the current
 staking period.
 <p>
 This is necessary when calculating rewards for the 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 stake_reward_start = 6;
      Returns:
      The stakeRewardStart.

    • getUnclaimedStakeRewardStart

      long getUnclaimedStakeRewardStart()
       *
 The amount of staked HBAR from `stake_reward_start` that will have
 unclaimed rewards due to accounts changing their staking metadata in a
 way that disqualifies them for the current staking period.
 <p>
 This value SHALL be reset at the beginning of every staking period.
      int64 unclaimed_stake_reward_start = 7;
      Returns:
      The unclaimedStakeRewardStart.

    • getStake

      long getStake()
       *
 The total amount of HBAR staked to this node.
 <p>
 This is sum of stake_to_reward and stake_to_not_reward.<br/>
 If the sum is greater than `max_stake`, then the _effective_ stake
 SHALL be `max_stake`.<br/>
 If the sum is less than `min_stake`, then the _effective_ stake
 SHALL be `0`.
      int64 stake = 8;
      Returns:
      The stake.

    • getRewardSumHistoryList

      List<Long> getRewardSumHistoryList()
       *
 A running list of reward amounts for the last 365+1 staking periods
 (typically a year and a day).
 <p>
 The first element SHALL be the reward up to and including the last full
 period prior to the present reward period.<br/>
 The second element SHALL be the reward up to and including the period
 before the last full period prior to the present period.<br/>
 The list SHALL continue in reverse chronological order until the reward
 history limit is reached.
      repeated int64 reward_sum_history = 9;
      Returns:
      A list containing the rewardSumHistory.

    • getRewardSumHistoryCount

      int getRewardSumHistoryCount()
       *
 A running list of reward amounts for the last 365+1 staking periods
 (typically a year and a day).
 <p>
 The first element SHALL be the reward up to and including the last full
 period prior to the present reward period.<br/>
 The second element SHALL be the reward up to and including the period
 before the last full period prior to the present period.<br/>
 The list SHALL continue in reverse chronological order until the reward
 history limit is reached.
      repeated int64 reward_sum_history = 9;
      Returns:
      The count of rewardSumHistory.

    • getRewardSumHistory

      long getRewardSumHistory(int index)
       *
 A running list of reward amounts for the last 365+1 staking periods
 (typically a year and a day).
 <p>
 The first element SHALL be the reward up to and including the last full
 period prior to the present reward period.<br/>
 The second element SHALL be the reward up to and including the period
 before the last full period prior to the present period.<br/>
 The list SHALL continue in reverse chronological order until the reward
 history limit is reached.
      repeated int64 reward_sum_history = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The rewardSumHistory at the given index.

    • getWeight

      @Deprecated int getWeight()
      Deprecated.
      proto.StakingNodeInfo.weight is deprecated. See staking_node_info.proto;l=133
       *
 The consensus weight of this node in the network.
 <p>
 This is recomputed based on the `stake` of this node at midnight UTC of
 each day. If the `stake` of this node at that time is less than
 `min_stake`, then the weight SHALL be 0.<br/>
 <p>
 Given the following:
 <ul>
 <li>The `effective stake` of a single node SHALL be `0` if the node
 `stake` is less than `min_stake`.</li>
 <li>The `effective stake` SHALL be `max_stake` if the node `stake` is
 greater than `max_stake`.</li>
 <li>The `effective stake` SHALL be the actual value of `stake` if
 `min_stake` < `stake` < `max_stake`.</li>
 <li>The `effective network stake` SHALL be calculated as ∑(`effective
 stake` of each node) for all nodes in the network address book.</li>
 </ul>
 <p>
 This field is deprecated and SHALL NOT be used when RosterLifecycle
 is enabled. The weight SHALL be same as the `effective_stake` described above.
      int32 weight = 10 [deprecated = true];
      Returns:
      The weight.

    • getPendingRewards

      long getPendingRewards()
       *
 The total staking rewards in tinybars that MAY be collected by all
 accounts staking to the current node 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/>
 When the current node is deleted, this amount SHALL be subtracted from
 the total pending rewards of all accounts staking to all nodes in the
 network in NetworkStakingRewards.
      int64 pending_rewards = 11;
      Returns:
      The pendingRewards.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating that this node has been removed from this network.
      bool deleted = 12;
      Returns:
      The deleted.