com.hederahashgraph.api.proto.java.StakingNodeInfoOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: state/token/staking_node_info.proto
package com.hederahashgraph.api.proto.java;
public interface StakingNodeInfoOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.StakingNodeInfo)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The unique entity number of the node. The shard and realm numbers are implied, based on the network
* this entity came from.
*
*
* int64 node_number = 1;
* @return The nodeNumber.
*/
long getNodeNumber();
/**
*
**
* The minimum stake on this node that is required for this node to have a non-zero weight to
* participate in the network consensus.
*
*
* int64 min_stake = 2;
* @return The minStake.
*/
long getMinStake();
/**
*
**
* The maximum stake on this node that is considered to calculate its weight to participate in the network consensus.
*
*
* int64 max_stake = 3;
* @return The maxStake.
*/
long getMaxStake();
/**
*
**
* The sum of balances of all accounts staked to this node who have opted to receive rewards.
*
*
* int64 stake_to_reward = 4;
* @return The stakeToReward.
*/
long getStakeToReward();
/**
*
**
* The sum of balances of all accounts staked to this node who have opted to decline rewards.
*
*
* int64 stake_to_not_reward = 5;
* @return The stakeToNotReward.
*/
long getStakeToNotReward();
/**
*
**
* The snapshot of stake_to_reward value at the beginning of the current staking period.
* This is needed for calculating rewards for current staking period without considering changes to
* stake_to_reward in the current staking period. It is reset at the beginning of every period.
*
*
* int64 stake_reward_start = 6;
* @return The stakeRewardStart.
*/
long getStakeRewardStart();
/**
*
**
* Tracks how much stake from stakeRewardStart will have unclaimed rewards due to accounts changing their staking
* metadata in a way that disqualifies them for the current period; It is reset at the beginning of every period
*
*
* int64 unclaimed_stake_reward_start = 7;
* @return The unclaimedStakeRewardStart.
*/
long getUnclaimedStakeRewardStart();
/**
*
**
* The total amount of effective hbar staked to this node. This is sum of stake_to_reward and stake_to_not_reward.
* If the sum is greater than max_stake, then the effective stake is max_stake.
* If the sum is less than min_stake, then the effective stake is 0.
*
*
* int64 stake = 8;
* @return The stake.
*/
long getStake();
/**
*
**
* An running sum of reward rates per hbar for the last 365+1 staking periods. The first element is the
* is the reward up to and including the last full period that finished before the present. Second element is
* the reward up to and including the period before that
*
*
* repeated int64 reward_sum_history = 9;
* @return A list containing the rewardSumHistory.
*/
java.util.List getRewardSumHistoryList();
/**
*
**
* An running sum of reward rates per hbar for the last 365+1 staking periods. The first element is the
* is the reward up to and including the last full period that finished before the present. Second element is
* the reward up to and including the period before that
*
*
* repeated int64 reward_sum_history = 9;
* @return The count of rewardSumHistory.
*/
int getRewardSumHistoryCount();
/**
*
**
* An running sum of reward rates per hbar for the last 365+1 staking periods. The first element is the
* is the reward up to and including the last full period that finished before the present. Second element is
* the reward up to and including the period before that
*
*
* repeated int64 reward_sum_history = 9;
* @param index The index of the element to return.
* @return The rewardSumHistory at the given index.
*/
long getRewardSumHistory(int index);
/**
*
**
* The consensus weight of this node in the network. This is computed based on the stake of this node
* at midnight UTC of the current day. If the stake of this node is less than minStake, then the weight is 0.
* Sum of all weights of nodes in the network should be less than 500.
* If the stake of this node A is greater than minStake, then the weight of this node A is calculated as:
* (node A stake * 500/ total stake of all nodes)
*
*
* int32 weight = 10;
* @return The weight.
*/
int getWeight();
/**
*
**
* The total staking rewards in tinybars that COULD be collected by all accounts staking to the current node after the end
* of this staking period; assuming that no account "renounces" its rewards by, for example, setting declineReward=true.
* When the current node is deleted, this amount will be subtracted from the total pending rewards of all accounts staking
* to all nodes in the network in NetworkStakingRewards.
*
*
* int64 pending_rewards = 11;
* @return The pendingRewards.
*/
long getPendingRewards();
/**
*
**
* True if this node has been deleted from network.
*
*
* bool deleted = 12;
* @return The deleted.
*/
boolean getDeleted();
}