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

Interface StakingInfoOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDeclineReward()
    * A flag indicating that the holder of this account has chosen to decline staking rewards.
    long
    getPendingReward()
    * An amount, in tinybar, to be received in the next reward payout.<br/> Rewards are not paid out immediately; for efficiency reasons rewards are only paid out as part of another transaction involving that account.
    AccountID
    getStakedAccountId()
    * A delegated stake.
    StakingInfo.StakedIdCase
    getStakedIdCase()
     
    long
    getStakedNodeId()
    * A direct stake.
    long
    getStakedToMe()
    * A proxy-staked balance.<br/> The total HBAR balance of all accounts that delegate staking to this account or contract.
    Timestamp
    getStakePeriodStart()
    * A `Timestamp` of the start time for the latest active staking period.
    boolean
    hasStakedAccountId()
    * A delegated stake.
    boolean
    hasStakedNodeId()
    * A direct stake.
    boolean
    hasStakePeriodStart()
    * A `Timestamp` of the start time for the latest active staking period.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getDeclineReward

      boolean getDeclineReward()
       *
 A flag indicating that the holder of this account has chosen to decline
 staking rewards.
      bool decline_reward = 1;
      Returns:
      The declineReward.

    • hasStakePeriodStart

      boolean hasStakePeriodStart()
       *
 A `Timestamp` of the start time for the latest active staking period.
 <p>
 This MUST be a period during which either the staking settings for this
 account or contract changed or the account or contract received staking
 rewards, whichever is later. Examples of a change in staking settings
 include starting staking or changing the staked_node_id.<br/>
 If this account or contract is not currently staked to a node, then this
 field SHALL NOT be set.
      .proto.Timestamp stake_period_start = 2;
      Returns:
      Whether the stakePeriodStart field is set.

    • getStakePeriodStart

      Timestamp getStakePeriodStart()
       *
 A `Timestamp` of the start time for the latest active staking period.
 <p>
 This MUST be a period during which either the staking settings for this
 account or contract changed or the account or contract received staking
 rewards, whichever is later. Examples of a change in staking settings
 include starting staking or changing the staked_node_id.<br/>
 If this account or contract is not currently staked to a node, then this
 field SHALL NOT be set.
      .proto.Timestamp stake_period_start = 2;
      Returns:
      The stakePeriodStart.

    • getPendingReward

      long getPendingReward()
       *
 An amount, in tinybar, to be received in the next reward payout.<br/>
 Rewards are not paid out immediately; for efficiency reasons rewards are
 only paid out as part of another transaction involving that account.
      int64 pending_reward = 3;
      Returns:
      The pendingReward.

    • getStakedToMe

      long getStakedToMe()
       *
 A proxy-staked balance.<br/>
 The total HBAR balance of all accounts that delegate staking to this
 account or contract.
      int64 staked_to_me = 4;
      Returns:
      The stakedToMe.

    • hasStakedAccountId

      boolean hasStakedAccountId()
       *
 A delegated stake.
 <p>
 This account delegates to the indicated account for staking purposes.
      .proto.AccountID staked_account_id = 5;
      Returns:
      Whether the stakedAccountId field is set.

    • getStakedAccountId

      AccountID getStakedAccountId()
       *
 A delegated stake.
 <p>
 This account delegates to the indicated account for staking purposes.
      .proto.AccountID staked_account_id = 5;
      Returns:
      The stakedAccountId.

    • hasStakedNodeId

      boolean hasStakedNodeId()
       *
 A direct stake.
 <p>
 This accounts stakes its balance to the designated node.
      int64 staked_node_id = 6;
      Returns:
      Whether the stakedNodeId field is set.

    • getStakedNodeId

      long getStakedNodeId()
       *
 A direct stake.
 <p>
 This accounts stakes its balance to the designated node.
      int64 staked_node_id = 6;
      Returns:
      The stakedNodeId.

    • getStakedIdCase

      StakingInfo.StakedIdCase getStakedIdCase()