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

Interface NodeStakeOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getMaxStake()
    * A limit to the amount of stake considered for consensus weight.
    long
    getMinStake()
    * A minimum amount of HBAR staked to a node to receive rewards.
    long
    getNodeId()
    * A node identifier.<br/> This value uniquely identifies this node within the network address book.
    long
    getRewardRate()
    * The rate of rewards, in tinybar per HBAR, for the staking reward period that just ended.
    long
    getStake()
    * A consensus weight assigned to this node for the next staking period.
    long
    getStakeNotRewarded()
    * The total amount staked to this node, while declining rewards.
    long
    getStakeRewarded()
    * The total amount staked to this node, while accepting rewards.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getMaxStake

      long getMaxStake()
       *
 A limit to the amount of stake considered for consensus weight.
 <p>
 The amount of stake (whether accepting rewards or not) assigned to a
 node that exceeds this limit SHALL NOT be considered for
 consensus weight calculation.<br/>
 If stake to _reward_ for a node exceeds this threshold, then all
 accounts staking to that node SHALL receive a lower reward rate in
 proportion to the excess stake.
      int64 max_stake = 1;
      Returns:
      The maxStake.

    • getMinStake

      long getMinStake()
       *
 A minimum amount of HBAR staked to a node to receive rewards.
 <p>
 If the amount of stake (whether accepting rewards or not) assigned to
 a node at the start of a staking period is less than this threshold,
 then no rewards SHALL be paid to that node or to any accounts
 staking to that node.
      int64 min_stake = 2;
      Returns:
      The minStake.

    • getNodeId

      long getNodeId()
       *
 A node identifier.<br/>
 This value uniquely identifies this node within the
 network address book.
      int64 node_id = 3;
      Returns:
      The nodeId.

    • getRewardRate

      long getRewardRate()
       *
 The rate of rewards, in tinybar per HBAR, for the staking reward
 period that just ended.
      int64 reward_rate = 4;
      Returns:
      The rewardRate.

    • getStake

      long getStake()
       *
 A consensus weight assigned to this node for the next staking period.
      int64 stake = 5;
      Returns:
      The stake.

    • getStakeNotRewarded

      long getStakeNotRewarded()
       *
 The total amount staked to this node, while declining rewards.
 <p>
 This SHALL be the total staked amount, in tinybar, that is staked to
 this node with the value of the `decline_reward` set.<br/>
 This value MUST be calculated at the beginning of the staking period.
      int64 stake_not_rewarded = 6;
      Returns:
      The stakeNotRewarded.

    • getStakeRewarded

      long getStakeRewarded()
       *
 The total amount staked to this node, while accepting rewards.
 <p>
 This SHALL be the total staked amount, in tinybar, that is staked to
 this node with the value of the `decline_reward` not set.<br/>
 This value MUST be calculated at the beginning of the staking period.
      int64 stake_rewarded = 7;
      Returns:
      The stakeRewarded.