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

Class NetworkStakingRewards.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<NetworkStakingRewards,NetworkStakingRewards.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<NetworkStakingRewards,NetworkStakingRewards.Builder>
com.hedera.hashgraph.sdk.proto.NetworkStakingRewards.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, NetworkStakingRewardsOrBuilder, Cloneable
Enclosing class:
NetworkStakingRewards
public static final class NetworkStakingRewards.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<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

  • 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.

    • setStakingRewardsActivated

      public NetworkStakingRewards.Builder setStakingRewardsActivated(boolean value)
       *
 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;
      Parameters:
      value - The stakingRewardsActivated to set.
      Returns:
      This builder for chaining.

    • clearStakingRewardsActivated

      public NetworkStakingRewards.Builder clearStakingRewardsActivated()
       *
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setTotalStakedRewardStart

      public NetworkStakingRewards.Builder setTotalStakedRewardStart(long value)
       *
 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;
      Parameters:
      value - The totalStakedRewardStart to set.
      Returns:
      This builder for chaining.

    • clearTotalStakedRewardStart

      public NetworkStakingRewards.Builder clearTotalStakedRewardStart()
       *
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setTotalStakedStart

      public NetworkStakingRewards.Builder setTotalStakedStart(long value)
       *
 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;
      Parameters:
      value - The totalStakedStart to set.
      Returns:
      This builder for chaining.

    • clearTotalStakedStart

      public NetworkStakingRewards.Builder clearTotalStakedStart()
       *
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setPendingRewards

      public NetworkStakingRewards.Builder setPendingRewards(long value)
       *
 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;
      Parameters:
      value - The pendingRewards to set.
      Returns:
      This builder for chaining.

    • clearPendingRewards

      public NetworkStakingRewards.Builder clearPendingRewards()
       *
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setLastNodeRewardPaymentsTime

      public NetworkStakingRewards.Builder setLastNodeRewardPaymentsTime(Timestamp value)
       *
 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;

    • setLastNodeRewardPaymentsTime

      public NetworkStakingRewards.Builder setLastNodeRewardPaymentsTime(Timestamp.Builder builderForValue)
       *
 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;

    • mergeLastNodeRewardPaymentsTime

      public NetworkStakingRewards.Builder mergeLastNodeRewardPaymentsTime(Timestamp value)
       *
 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;

    • clearLastNodeRewardPaymentsTime

      public NetworkStakingRewards.Builder clearLastNodeRewardPaymentsTime()
       *
 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;