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

Class NetworkStakingRewards

java.lang.Object
com.google.protobuf.AbstractMessageLite<NetworkStakingRewards,NetworkStakingRewards.Builder>
com.google.protobuf.GeneratedMessageLite<NetworkStakingRewards,NetworkStakingRewards.Builder>
com.hedera.hashgraph.sdk.proto.NetworkStakingRewards
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, NetworkStakingRewardsOrBuilder
@Generated public final class NetworkStakingRewards extends com.google.protobuf.GeneratedMessageLite<NetworkStakingRewards,NetworkStakingRewards.Builder> implements NetworkStakingRewardsOrBuilder
 *
 An Hedera Token Service staking reward entity.
 This stores values related to the aggregate staking rewards for all nodes in
 the network. It is calculated at the beginning of each staking period.
Protobuf type proto.NetworkStakingRewards

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    NetworkStakingRewards.Builder
    * An Hedera Token Service staking reward entity.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LAST_NODE_REWARD_PAYMENTS_TIME_FIELD_NUMBER
     
    static final int
    PENDING_REWARDS_FIELD_NUMBER
     
    static final int
    STAKING_REWARDS_ACTIVATED_FIELD_NUMBER
     
    static final int
    TOTAL_STAKED_REWARD_START_FIELD_NUMBER
     
    static final int
    TOTAL_STAKED_START_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static NetworkStakingRewards
    getDefaultInstance()
     
    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.
    static NetworkStakingRewards.Builder
    newBuilder()
     
    static NetworkStakingRewards.Builder
    newBuilder(NetworkStakingRewards prototype)
     
    static NetworkStakingRewards
    parseDelimitedFrom(InputStream input)
     
    static NetworkStakingRewards
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NetworkStakingRewards
    parseFrom(byte[] data)
     
    static NetworkStakingRewards
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NetworkStakingRewards
    parseFrom(com.google.protobuf.ByteString data)
     
    static NetworkStakingRewards
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NetworkStakingRewards
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static NetworkStakingRewards
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NetworkStakingRewards
    parseFrom(InputStream input)
     
    static NetworkStakingRewards
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NetworkStakingRewards
    parseFrom(ByteBuffer data)
     
    static NetworkStakingRewards
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<NetworkStakingRewards>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • STAKING_REWARDS_ACTIVATED_FIELD_NUMBER

      public static final int STAKING_REWARDS_ACTIVATED_FIELD_NUMBER
      See Also:

    • TOTAL_STAKED_REWARD_START_FIELD_NUMBER

      public static final int TOTAL_STAKED_REWARD_START_FIELD_NUMBER
      See Also:

    • TOTAL_STAKED_START_FIELD_NUMBER

      public static final int TOTAL_STAKED_START_FIELD_NUMBER
      See Also:

    • PENDING_REWARDS_FIELD_NUMBER

      public static final int PENDING_REWARDS_FIELD_NUMBER
      See Also:

    • LAST_NODE_REWARD_PAYMENTS_TIME_FIELD_NUMBER

      public static final int LAST_NODE_REWARD_PAYMENTS_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getStakingRewardsActivated

      public 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;
      Specified by:
      getStakingRewardsActivated in interface NetworkStakingRewardsOrBuilder
      Returns:
      The stakingRewardsActivated.

    • getTotalStakedRewardStart

      public 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;
      Specified by:
      getTotalStakedRewardStart in interface NetworkStakingRewardsOrBuilder
      Returns:
      The totalStakedRewardStart.

    • getTotalStakedStart

      public 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;
      Specified by:
      getTotalStakedStart in interface NetworkStakingRewardsOrBuilder
      Returns:
      The totalStakedStart.

    • getPendingRewards

      public 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;
      Specified by:
      getPendingRewards in interface NetworkStakingRewardsOrBuilder
      Returns:
      The pendingRewards.

    • hasLastNodeRewardPaymentsTime

      public 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;
      Specified by:
      hasLastNodeRewardPaymentsTime in interface NetworkStakingRewardsOrBuilder
      Returns:
      Whether the lastNodeRewardPaymentsTime field is set.

    • getLastNodeRewardPaymentsTime

      public 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;
      Specified by:
      getLastNodeRewardPaymentsTime in interface NetworkStakingRewardsOrBuilder
      Returns:
      The lastNodeRewardPaymentsTime.

    • parseFrom

      public static NetworkStakingRewards parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NetworkStakingRewards parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NetworkStakingRewards parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NetworkStakingRewards parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NetworkStakingRewards parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NetworkStakingRewards parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NetworkStakingRewards parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static NetworkStakingRewards.Builder newBuilder()

    • newBuilder

      public static NetworkStakingRewards.Builder newBuilder(NetworkStakingRewards prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<NetworkStakingRewards,NetworkStakingRewards.Builder>

    • getDefaultInstance

      public static NetworkStakingRewards getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NetworkStakingRewards> parser()