com.hedera.hashgraph.sdk.proto.NodeStakeOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: node_stake_update.proto

// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;

public interface NodeStakeOrBuilder extends
    // @@protoc_insertion_point(interface_extends:proto.NodeStake)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * The maximum stake (rewarded or not rewarded) this node can have as consensus weight. If its stake to
   * reward is above this maximum at the start of a period, then accounts staking to the node in that 
   * period will be rewarded at a lower rate scaled by (maxStake / stakeRewardStart).
   * 
   *
   * int64 max_stake = 1;
   * @return The maxStake.
   */
  long getMaxStake();

  /**
   *    **
   * The minimum stake (rewarded or not rewarded) this node must reach before having non-zero consensus weight.
   * If its total stake is below this minimum at the start of a period, then accounts staking to the node in 
   * that period will receive no rewards.
   * 
   *
   * int64 min_stake = 2;
   * @return The minStake.
   */
  long getMinStake();

  /**
   *    **
   * The id of this node.
   * 
   *
   * int64 node_id = 3;
   * @return The nodeId.
   */
  long getNodeId();

  /**
   *    **
   * The reward rate _per whole hbar_ that was staked to this node with declineReward=false from the start of 
   * the staking period that is ending. 
   * 
   *
   * int64 reward_rate = 4;
   * @return The rewardRate.
   */
  long getRewardRate();

  /**
   *    **
   * Consensus weight of this node for the new staking period.
   * 
   *
   * int64 stake = 5;
   * @return The stake.
   */
  long getStake();

  /**
   *    **
   * Total of (balance + stakedToMe) for all accounts staked to this node with declineReward=true, at the 
   * beginning of the new staking period.
   * 
   *
   * int64 stake_not_rewarded = 6;
   * @return The stakeNotRewarded.
   */
  long getStakeNotRewarded();

  /**
   *    **
   * Total of (balance + stakedToMe) for all accounts staked to this node with declineReward=false, at the 
   * beginning of the new staking period.
   * 
   *
   * int64 stake_rewarded = 7;
   * @return The stakeRewarded.
   */
  long getStakeRewarded();
}