rewards

package
v1.18.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 22, 2025 License: GPL-3.0, GPL-3.0 Imports: 13 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Claim 

func Claim(rp *rocketpool.RocketPool, address common.Address, claims types.Claims, opts *bind.TransactOpts) (common.Hash, error)

Claim rewards

func ClaimAndStake 

func ClaimAndStake(rp *rocketpool.RocketPool, address common.Address, claims types.Claims, stakeAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Claim and restake rewards

func EstimateClaimAndStakeGas 

func EstimateClaimAndStakeGas(rp *rocketpool.RocketPool, address common.Address, claims types.Claims, stakeAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate claim and restake rewards gas

func EstimateClaimGas 

func EstimateClaimGas(rp *rocketpool.RocketPool, address common.Address, claims types.Claims, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate claim rewards gas

func EstimateSubmitRewardSnapshotGas 

func EstimateSubmitRewardSnapshotGas(rp *rocketpool.RocketPool, submission RewardSubmission, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas for submitting a Merkle Tree-based snapshot for a rewards interval

func GetClaimIntervalTime 

func GetClaimIntervalTime(rp *rocketpool.RocketPool, opts *bind.CallOpts) (time.Duration, error)

Get the number of seconds in a claim interval

func GetClaimIntervalTimeStart 

func GetClaimIntervalTimeStart(rp *rocketpool.RocketPool, opts *bind.CallOpts) (time.Time, error)

Get the timestamp that the current rewards interval started

func GetNodeOperatorRewardsPercent 

func GetNodeOperatorRewardsPercent(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)

Get the percent of checkpoint rewards that goes to node operators

func GetPendingETHRewards 

func GetPendingETHRewards(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)

Get the amount of ETH rewards that will be provided to node operators

func GetPendingRPLRewards 

func GetPendingRPLRewards(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)

Get the amount of RPL rewards that will be provided to node operators

func GetProtocolDaoRewardsPercent 

func GetProtocolDaoRewardsPercent(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)

Get the percent of checkpoint rewards that goes to the PDAO

func GetTrustedNodeOperatorRewardsPercent 

func GetTrustedNodeOperatorRewardsPercent(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)

Get the percent of checkpoint rewards that goes to ODAO members

func GetTrustedNodeSubmitted 

func GetTrustedNodeSubmitted(rp *rocketpool.RocketPool, nodeAddress common.Address, rewardsIndex uint64, opts *bind.CallOpts) (bool, error)

Check whether or not the given address has submitted for the given rewards interval

func GetTrustedNodeSubmittedSpecificRewards 

func GetTrustedNodeSubmittedSpecificRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, submission RewardSubmission, opts *bind.CallOpts) (bool, error)

Check whether or not the given address has submitted specific rewards info

func IsClaimed 

func IsClaimed(rp *rocketpool.RocketPool, index *big.Int, claimerAddress common.Address, opts *bind.CallOpts) (bool, error)

Check if the given node has already claimed rewards for the given interval

func MerkleRoots 

func MerkleRoots(rp *rocketpool.RocketPool, interval *big.Int, opts *bind.CallOpts) ([]byte, error)

Get the Merkle root for an interval

func SubmitRewardSnapshot 

func SubmitRewardSnapshot(rp *rocketpool.RocketPool, submission RewardSubmission, opts *bind.TransactOpts) (common.Hash, error)

Submit a Merkle Tree-based snapshot for a rewards interval

Types

type RewardSubmission 

type RewardSubmission struct {
	RewardIndex      *big.Int   `json:"rewardIndex"`
	ExecutionBlock   *big.Int   `json:"executionBlock"`
	ConsensusBlock   *big.Int   `json:"consensusBlock"`
	MerkleRoot       [32]byte   `json:"merkleRoot"`
	IntervalsPassed  *big.Int   `json:"intervalsPassed"`
	SmoothingPoolETH *big.Int   `json:"smoothingPoolETH"`
	TreasuryRPL      *big.Int   `json:"treasuryRPL"`
	TreasuryETH      *big.Int   `json:"treasuryETH"`
	UserETH          *big.Int   `json:"userETH"`
	TrustedNodeRPL   []*big.Int `json:"trustedNodeRPL"`
	NodeRPL          []*big.Int `json:"nodeRPL"`
	NodeETH          []*big.Int `json:"nodeETH"`
}

Struct for submitting the rewards for a checkpoint

type RewardsEvent 

type RewardsEvent struct {
	Index             *big.Int
	ExecutionBlock    *big.Int
	ConsensusBlock    *big.Int
	MerkleRoot        common.Hash
	IntervalsPassed   *big.Int
	TreasuryRPL       *big.Int
	TreasuryETH       *big.Int
	TrustedNodeRPL    []*big.Int
	NodeRPL           []*big.Int
	NodeETH           []*big.Int
	UserETH           *big.Int
	IntervalStartTime time.Time
	IntervalEndTime   time.Time
	SubmissionTime    time.Time
}

Info for a rewards snapshot event

func GetRewardsEvent 

func GetRewardsEvent(rp *rocketpool.RocketPool, index uint64, rocketRewardsPoolAddresses []common.Address, opts *bind.CallOpts) (bool, RewardsEvent, error)

Get the event info for a rewards snapshot using the Atlas getter

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.