Documentation
¶
Index ¶
- Constants
- func ClaimUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
- func ConfirmRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
- func CreateVacantMinipool(rp *rocketpool.RocketPool, bondAmount *big.Int, minimumNodeFee float64, ...) (*types.Transaction, error)
- func DeployMegapool(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
- func Deposit(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, ...) (*types.Transaction, error)
- func DepositWithCredit(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, ...) (*types.Transaction, error)
- func EstimateClaimUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateConfirmRPLWithdrawalAddressGas(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateCreateVacantMinipoolGas(rp *rocketpool.RocketPool, bondAmount *big.Int, minimumNodeFee float64, ...) (rocketpool.GasInfo, error)
- func EstimateDeployMegapool(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateDepositGas(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, ...) (rocketpool.GasInfo, error)
- func EstimateDepositWithCreditGas(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, ...) (rocketpool.GasInfo, error)
- func EstimateInitializeFeeDistributorGas(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateProvisionExpressTicketsGas(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateRegisterNodeGas(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateSetRPLLockingAllowedGas(rp *rocketpool.RocketPool, caller common.Address, allowed bool, ...) (rocketpool.GasInfo, error)
- func EstimateSetRPLWithdrawalAddressGas(rp *rocketpool.RocketPool, nodeAddress common.Address, ...) (rocketpool.GasInfo, error)
- func EstimateSetSmoothingPoolRegistrationStateGas(rp *rocketpool.RocketPool, optIn bool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateSetStakeRPLForAllowedGas(rp *rocketpool.RocketPool, caller common.Address, allowed bool, ...) (rocketpool.GasInfo, error)
- func EstimateSetTimezoneLocationGas(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateStakeGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateUnstakeGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateUnstakeLegacyRPLGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateWithdrawCreditGas(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func EstimateWithdrawEthGas(rp *rocketpool.RocketPool, nodeAccount common.Address, ethAmount *big.Int, ...) (rocketpool.GasInfo, error)
- func EstimateWithdrawRPLGas(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func GetBondRequirement(rp *rocketpool.RocketPool, numValidators *big.Int, opts *bind.CallOpts) (*big.Int, error)
- func GetDistributorAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
- func GetExpressTicketCount(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
- func GetExpressTicketsProvisioned(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetFeeDistributorInitialized(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetMegapoolAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
- func GetNodeAddresses(rp *rocketpool.RocketPool, opts *bind.CallOpts) ([]common.Address, error)
- func GetNodeAddressesFast(rp *rocketpool.RocketPool, multicallAddress common.Address, ...) ([]common.Address, error)
- func GetNodeAt(rp *rocketpool.RocketPool, index uint64, opts *bind.CallOpts) (common.Address, error)
- func GetNodeAverageFee(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (float64, error)
- func GetNodeAverageFeeRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)
- func GetNodeCreditAndBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeDepositCredit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeETHCollateralisationRatio(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeEthBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeEthBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeEthMatched(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeEthMatchedLimit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeExists(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetNodeLastUnstakeTime(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
- func GetNodeLegacyStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeLockedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeManagerVersion(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint8, error)
- func GetNodeMegapoolETHBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeMegapoolETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeMegapoolStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeMinimumLegacyRPLStake(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeMinipoolETHBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeMinipoolETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodePendingRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
- func GetNodeRPLStakedTime(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
- func GetNodeRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
- func GetNodeRPLWithdrawalAddressIsSet(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetNodeRegistrationTime(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (time.Time, error)
- func GetNodeRegistrationTimeRaw(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeStakingVersion(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint8, error)
- func GetNodeTimezoneLocation(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (string, error)
- func GetNodeUnstakingRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeUsableCredit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetNodeUsableCreditAndBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetRPLLockedAllowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetRewardNetwork(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
- func GetRewardNetworkRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetSmoothingPoolRegisteredNodeCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)
- func GetSmoothingPoolRegistrationChanged(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (time.Time, error)
- func GetSmoothingPoolRegistrationChangedRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func GetSmoothingPoolRegistrationState(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
- func GetTotalLegacyStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
- func GetTotalMegapoolStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
- func GetTotalStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
- func GetUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (float64, error)
- func GetUnclaimedRewardsRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
- func InitializeFeeDistributor(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
- func ProvisionExpressTickets(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
- func RegisterNode(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (common.Hash, error)
- func SetNodeStakeRPLForAllowed(rp *rocketpool.RocketPool, nodeAddress common.Address, caller common.Address, ...) (common.Hash, error)
- func SetRPLLockingAllowed(rp *rocketpool.RocketPool, caller common.Address, allowed bool, ...) (common.Hash, error)
- func SetRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, ...) (common.Hash, error)
- func SetSmoothingPoolRegistrationState(rp *rocketpool.RocketPool, optIn bool, opts *bind.TransactOpts) (common.Hash, error)
- func SetStakeRPLForAllowed(rp *rocketpool.RocketPool, caller common.Address, allowed bool, ...) (common.Hash, error)
- func SetTimezoneLocation(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (common.Hash, error)
- func StakeRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
- func UnstakeLegacyRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
- func UnstakeRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
- func UseExpressTicket(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
- func WithdrawCredit(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (*types.Transaction, error)
- func WithdrawEth(rp *rocketpool.RocketPool, nodeAccount common.Address, ethAmount *big.Int, ...) (*types.Transaction, error)
- func WithdrawRPL(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
- type Distributor
- func (d *Distributor) Distribute(opts *bind.TransactOpts) (common.Hash, error)
- func (d *Distributor) EstimateDistributeGas(opts *bind.TransactOpts) (rocketpool.GasInfo, error)
- func (d *Distributor) GetNodeShare(opts *bind.CallOpts) (*big.Int, error)
- func (d *Distributor) GetUserShare(opts *bind.CallOpts) (*big.Int, error)
- type NodeDetails
- type TimezoneCount
- type TrustedNodeParticipation
Constants ¶
const ( NodeAddressBatchSize = 50 NodeDetailsBatchSize = 20 SmoothingPoolCountBatchSize uint64 = 2000 )
Settings
Variables ¶
This section is empty.
Functions ¶
func ClaimUnclaimedRewards ¶ added in v1.18.0
func ClaimUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
Sends any unclaimed rewards to node operator's withdrawal address
func ConfirmRPLWithdrawalAddress ¶
func ConfirmRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
Confirm the RPL-specific withdrawal address
func CreateVacantMinipool ¶
func CreateVacantMinipool(rp *rocketpool.RocketPool, bondAmount *big.Int, minimumNodeFee float64, validatorPubkey rptypes.ValidatorPubkey, salt *big.Int, expectedMinipoolAddress common.Address, currentBalance *big.Int, opts *bind.TransactOpts) (*types.Transaction, error)
Make a vacant minipool for solo staker migration
func DeployMegapool ¶ added in v1.18.0
func DeployMegapool(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
Deploys a Megapool contract
func Deposit ¶
func Deposit(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, validatorPubkey rptypes.ValidatorPubkey, validatorSignature rptypes.ValidatorSignature, depositDataRoot common.Hash, opts *bind.TransactOpts) (*types.Transaction, error)
Make a node deposit
func DepositWithCredit ¶
func DepositWithCredit(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, validatorPubkey rptypes.ValidatorPubkey, validatorSignature rptypes.ValidatorSignature, depositDataRoot common.Hash, opts *bind.TransactOpts) (*types.Transaction, error)
Make a node deposit by using the credit balance
func EstimateClaimUnclaimedRewards ¶ added in v1.18.0
func EstimateClaimUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for sending unclaimed rewards to node operator's withdrawal address
func EstimateConfirmRPLWithdrawalAddressGas ¶
func EstimateConfirmRPLWithdrawalAddressGas(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for confirming the RPL-specific withdrawal address
func EstimateCreateVacantMinipoolGas ¶
func EstimateCreateVacantMinipoolGas(rp *rocketpool.RocketPool, bondAmount *big.Int, minimumNodeFee float64, validatorPubkey rptypes.ValidatorPubkey, salt *big.Int, expectedMinipoolAddress common.Address, currentBalance *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of CreateVacantMinipool
func EstimateDeployMegapool ¶ added in v1.18.0
func EstimateDeployMegapool(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
func EstimateDepositGas ¶
func EstimateDepositGas(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, validatorPubkey rptypes.ValidatorPubkey, validatorSignature rptypes.ValidatorSignature, depositDataRoot common.Hash, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of Deposit
func EstimateDepositWithCreditGas ¶
func EstimateDepositWithCreditGas(rp *rocketpool.RocketPool, bondAmount *big.Int, useExpressTicket bool, validatorPubkey rptypes.ValidatorPubkey, validatorSignature rptypes.ValidatorSignature, depositDataRoot common.Hash, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of DepositWithCredit
func EstimateInitializeFeeDistributorGas ¶
func EstimateInitializeFeeDistributorGas(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for creating the fee distributor contract for a node
func EstimateProvisionExpressTicketsGas ¶ added in v1.18.0
func EstimateProvisionExpressTicketsGas(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for provisioning the node's express tickets
func EstimateRegisterNodeGas ¶
func EstimateRegisterNodeGas(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of RegisterNode
func EstimateSetRPLLockingAllowedGas ¶
func EstimateSetRPLLockingAllowedGas(rp *rocketpool.RocketPool, caller common.Address, allowed bool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of set RPL locking allowed
func EstimateSetRPLWithdrawalAddressGas ¶
func EstimateSetRPLWithdrawalAddressGas(rp *rocketpool.RocketPool, nodeAddress common.Address, withdrawalAddress common.Address, confirm bool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for setting the RPL-specific withdrawal address
func EstimateSetSmoothingPoolRegistrationStateGas ¶
func EstimateSetSmoothingPoolRegistrationStateGas(rp *rocketpool.RocketPool, optIn bool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas for opting into / out of the smoothing pool
func EstimateSetStakeRPLForAllowedGas ¶
func EstimateSetStakeRPLForAllowedGas(rp *rocketpool.RocketPool, caller common.Address, allowed bool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of set stake RPL for allowed
func EstimateSetTimezoneLocationGas ¶
func EstimateSetTimezoneLocationGas(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of SetTimezoneLocation
func EstimateStakeGas ¶
func EstimateStakeGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of Stake
func EstimateUnstakeGas ¶ added in v1.18.0
func EstimateUnstakeGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of UnstakeRPL
func EstimateUnstakeLegacyRPLGas ¶ added in v1.18.0
func EstimateUnstakeLegacyRPLGas(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of UnstakeLegacyRPL
func EstimateWithdrawCreditGas ¶ added in v1.18.0
func EstimateWithdrawCreditGas(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas required to withdraw credit
func EstimateWithdrawEthGas ¶
func EstimateWithdrawEthGas(rp *rocketpool.RocketPool, nodeAccount common.Address, ethAmount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas to WithdrawETH
func EstimateWithdrawRPLGas ¶
func EstimateWithdrawRPLGas(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of WithdrawRPL
func GetBondRequirement ¶ added in v1.18.0
func GetBondRequirement(rp *rocketpool.RocketPool, numValidators *big.Int, opts *bind.CallOpts) (*big.Int, error)
func GetDistributorAddress ¶
func GetDistributorAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
Gets the deterministic address for a node's reward distributor contract
func GetExpressTicketCount ¶ added in v1.18.0
func GetExpressTicketCount(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
Get express ticket count for a node
func GetExpressTicketsProvisioned ¶ added in v1.18.0
func GetExpressTicketsProvisioned(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Check if the node's express tickets have been provisioned yet
func GetFeeDistributorInitialized ¶
func GetFeeDistributorInitialized(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Check if a node's fee distributor has been initialized yet
func GetMegapoolAddress ¶ added in v1.18.0
func GetMegapoolAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
Get the megapool address for the given node operator
func GetNodeAddresses ¶
func GetNodeAddresses(rp *rocketpool.RocketPool, opts *bind.CallOpts) ([]common.Address, error)
Get all node addresses
func GetNodeAddressesFast ¶
func GetNodeAddressesFast(rp *rocketpool.RocketPool, multicallAddress common.Address, opts *bind.CallOpts) ([]common.Address, error)
Get all node addresses using a multicaller
func GetNodeAt ¶
func GetNodeAt(rp *rocketpool.RocketPool, index uint64, opts *bind.CallOpts) (common.Address, error)
Get a node address by index
func GetNodeAverageFee ¶
func GetNodeAverageFee(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (float64, error)
Get a node's average minipool fee
func GetNodeAverageFeeRaw ¶
func GetNodeAverageFeeRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get a node's average minipool fee
func GetNodeCount ¶
func GetNodeCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)
Get the number of nodes in the network
func GetNodeCreditAndBalance ¶
func GetNodeCreditAndBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the sum of the credit balance of a given node operator and their ETH balance
func GetNodeDepositCredit ¶
func GetNodeDepositCredit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH in the node's deposit credit bank
func GetNodeETHBorrowed ¶ added in v1.18.0
func GetNodeETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has borrowed from the deposit pool
func GetNodeETHCollateralisationRatio ¶ added in v1.18.0
func GetNodeETHCollateralisationRatio(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the ratio between capital taken from users and provided by a node operator for minipools
func GetNodeEthBalance ¶
func GetNodeEthBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the current ETH balance for the given node operator
func GetNodeEthBonded ¶ added in v1.18.0
func GetNodeEthBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has bonded
func GetNodeEthMatched ¶
func GetNodeEthMatched(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has borrowed from the deposit pool to create its minipools
func GetNodeEthMatchedLimit ¶
func GetNodeEthMatchedLimit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node can borrow from the deposit pool to create its minipools
func GetNodeExists ¶
func GetNodeExists(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Check whether a node exists
func GetNodeLastUnstakeTime ¶ added in v1.18.0
func GetNodeLastUnstakeTime(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
Get the time a node last unstaked RPL
func GetNodeLegacyStakedRPL ¶ added in v1.18.0
func GetNodeLegacyStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get a node's legacy RPL staked
func GetNodeLockedRPL ¶ added in v1.18.0
func GetNodeLockedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of RPL locked as part of active PDAO proposals or challenges
func GetNodeManagerVersion ¶
func GetNodeManagerVersion(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint8, error)
Get the version of the Node Manager contract
func GetNodeMegapoolETHBonded ¶ added in v1.18.0
func GetNodeMegapoolETHBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has bonded for its megapool
func GetNodeMegapoolETHBorrowed ¶ added in v1.18.0
func GetNodeMegapoolETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has borrowed from the deposit pool for its megapool
func GetNodeMegapoolStakedRPL ¶ added in v1.18.0
func GetNodeMegapoolStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get a node's megapool RPL staked
func GetNodeMinimumLegacyRPLStake ¶ added in v1.18.7
func GetNodeMinimumLegacyRPLStake(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the minimum amount of legacy staked RPL a node must have after unstaking
func GetNodeMinipoolETHBonded ¶ added in v1.18.0
func GetNodeMinipoolETHBonded(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has bonded for its minipools
func GetNodeMinipoolETHBorrowed ¶ added in v1.18.0
func GetNodeMinipoolETHBorrowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH the node has borrowed from the deposit pool for its minipools
func GetNodePendingRPLWithdrawalAddress ¶
func GetNodePendingRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
Get the pending RPL-specific withdrawal address
func GetNodeRPLStakedTime ¶
func GetNodeRPLStakedTime(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
Get the time a node last staked RPL
func GetNodeRPLWithdrawalAddress ¶
func GetNodeRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (common.Address, error)
Get the RPL-specific withdrawal address
func GetNodeRPLWithdrawalAddressIsSet ¶
func GetNodeRPLWithdrawalAddressIsSet(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Check if the RPL-specific withdrawal address has been set
func GetNodeRegistrationTime ¶
func GetNodeRegistrationTime(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (time.Time, error)
Get the time that the user registered as a claimer
func GetNodeRegistrationTimeRaw ¶
func GetNodeRegistrationTimeRaw(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the time that the user registered as a claimer
func GetNodeStakedRPL ¶ added in v1.18.0
func GetNodeStakedRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get a node's total RPL staked
func GetNodeStakingVersion ¶
func GetNodeStakingVersion(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint8, error)
Get the version of the Node Staking contract
func GetNodeTimezoneLocation ¶
func GetNodeTimezoneLocation(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (string, error)
Get a node's timezone location
func GetNodeUnstakingRPL ¶ added in v1.18.0
func GetNodeUnstakingRPL(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of unstaking RPL for a node
func GetNodeUsableCredit ¶
func GetNodeUsableCredit(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of ETH credit currently usable by a given node operator
func GetNodeUsableCreditAndBalance ¶
func GetNodeUsableCreditAndBalance(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the sum of the amount of ETH credit currently usable by a given node operator and their balance
func GetRPLLockedAllowed ¶
func GetRPLLockedAllowed(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Get RPL locking allowed state for a node
func GetRewardNetwork ¶
func GetRewardNetwork(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (uint64, error)
Get the network ID for a node's rewards
func GetRewardNetworkRaw ¶
func GetRewardNetworkRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the network ID for a node's rewards
func GetSmoothingPoolRegisteredNodeCount ¶
func GetSmoothingPoolRegisteredNodeCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)
Get the number of nodes in the Smoothing Pool
func GetSmoothingPoolRegistrationChanged ¶
func GetSmoothingPoolRegistrationChanged(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (time.Time, error)
Get the time of the previous smoothing pool opt-in / opt-out
func GetSmoothingPoolRegistrationChangedRaw ¶
func GetSmoothingPoolRegistrationChangedRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the time of the previous smoothing pool opt-in / opt-out
func GetSmoothingPoolRegistrationState ¶
func GetSmoothingPoolRegistrationState(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (bool, error)
Get the smoothing pool opt-in status of a node
func GetTotalLegacyStakedRPL ¶ added in v1.18.0
func GetTotalLegacyStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
Get the total RPL staked in the network on megapools
func GetTotalMegapoolStakedRPL ¶ added in v1.18.0
func GetTotalMegapoolStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
Get the total RPL staked in the network on megapools
func GetTotalStakedRPL ¶ added in v1.18.0
func GetTotalStakedRPL(rp *rocketpool.RocketPool, opts *bind.CallOpts) (*big.Int, error)
Get the total RPL staked in the network
func GetUnclaimedRewards ¶ added in v1.18.0
func GetUnclaimedRewards(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (float64, error)
Get the amount of unclaimed ETH rewards for a given node operator
func GetUnclaimedRewardsRaw ¶ added in v1.18.0
func GetUnclaimedRewardsRaw(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.CallOpts) (*big.Int, error)
Get the amount of unclaimed ETH rewards for a given node operator
func InitializeFeeDistributor ¶
func InitializeFeeDistributor(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
Create the fee distributor contract for a node
func ProvisionExpressTickets ¶ added in v1.18.0
func ProvisionExpressTickets(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
Provision the node's express tickets
func RegisterNode ¶
func RegisterNode(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (common.Hash, error)
Register a node
func SetNodeStakeRPLForAllowed ¶ added in v1.18.0
func SetNodeStakeRPLForAllowed(rp *rocketpool.RocketPool, nodeAddress common.Address, caller common.Address, allowed bool, opts *bind.TransactOpts) (common.Hash, error)
Set stake RPL for allowed for a certain node
func SetRPLLockingAllowed ¶
func SetRPLLockingAllowed(rp *rocketpool.RocketPool, caller common.Address, allowed bool, opts *bind.TransactOpts) (common.Hash, error)
Set RPL locking allowed
func SetRPLWithdrawalAddress ¶
func SetRPLWithdrawalAddress(rp *rocketpool.RocketPool, nodeAddress common.Address, withdrawalAddress common.Address, confirm bool, opts *bind.TransactOpts) (common.Hash, error)
Set the RPL-specific withdrawal address
func SetSmoothingPoolRegistrationState ¶
func SetSmoothingPoolRegistrationState(rp *rocketpool.RocketPool, optIn bool, opts *bind.TransactOpts) (common.Hash, error)
Opt into / out of the smoothing pool
func SetStakeRPLForAllowed ¶
func SetStakeRPLForAllowed(rp *rocketpool.RocketPool, caller common.Address, allowed bool, opts *bind.TransactOpts) (common.Hash, error)
Set stake RPL for allowed
func SetTimezoneLocation ¶
func SetTimezoneLocation(rp *rocketpool.RocketPool, timezoneLocation string, opts *bind.TransactOpts) (common.Hash, error)
Set a node's timezone location
func StakeRPL ¶
func StakeRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
Stake RPL
func UnstakeLegacyRPL ¶ added in v1.18.0
func UnstakeLegacyRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
Unstake legacy RPL
func UnstakeRPL ¶ added in v1.18.0
func UnstakeRPL(rp *rocketpool.RocketPool, rplAmount *big.Int, opts *bind.TransactOpts) (common.Hash, error)
Unstake RPL
func UseExpressTicket ¶ added in v1.18.0
func UseExpressTicket(rp *rocketpool.RocketPool, nodeAddress common.Address, opts *bind.TransactOpts) (common.Hash, error)
Consume an express ticket for the given node operator
func WithdrawCredit ¶ added in v1.18.0
func WithdrawCredit(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (*types.Transaction, error)
Withdraws credit store on a node as rETH
func WithdrawEth ¶
func WithdrawEth(rp *rocketpool.RocketPool, nodeAccount common.Address, ethAmount *big.Int, opts *bind.TransactOpts) (*types.Transaction, error)
Withdraw unused Ether that was staked on behalf of the node
func WithdrawRPL ¶
func WithdrawRPL(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)
Withdraw staked RPL
Types ¶
type Distributor ¶
type Distributor struct {
Address common.Address
Contract *rocketpool.Contract
RocketPool *rocketpool.RocketPool
}
Distributor contract
func NewDistributor ¶
func NewDistributor(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*Distributor, error)
Create new distributor contract
func (*Distributor) Distribute ¶
func (d *Distributor) Distribute(opts *bind.TransactOpts) (common.Hash, error)
Distribute the contract's balance to the rETH contract and the user
func (*Distributor) EstimateDistributeGas ¶
func (d *Distributor) EstimateDistributeGas(opts *bind.TransactOpts) (rocketpool.GasInfo, error)
Estimate the gas of a distribute
func (*Distributor) GetNodeShare ¶
Gets the node share of the distributor's current balance
func (*Distributor) GetUserShare ¶
Gets the user share of the distributor's current balance
type NodeDetails ¶
type NodeDetails struct {
Address common.Address `json:"address"`
Exists bool `json:"exists"`
PrimaryWithdrawalAddress common.Address `json:"primaryWithdrawalAddress"`
PendingPrimaryWithdrawalAddress common.Address `json:"pendingPrimaryWithdrawalAddress"`
IsRPLWithdrawalAddressSet bool `json:"isRPLWithdrawalAddressSet"`
RPLWithdrawalAddress common.Address `json:"rplWithdrawalAddress"`
PendingRPLWithdrawalAddress common.Address `json:"pendingRPLWithdrawalAddress"`
TimezoneLocation string `json:"timezoneLocation"`
}
Node details
func GetNodeDetails ¶
func GetNodeDetails(rp *rocketpool.RocketPool, nodeAddress common.Address, includeRplWithdrawalAddress bool, opts *bind.CallOpts) (NodeDetails, error)
Get a node's details The 'includeRplWithdrawalAddress' flag is used for backwards compatibility with Atlas, - set it to `false` if Houston hasn't been deployed yet
func GetNodes ¶
func GetNodes(rp *rocketpool.RocketPool, includeRplWithdrawalAddress bool, opts *bind.CallOpts) ([]NodeDetails, error)
Get all node details The 'includeRplWithdrawalAddress' flag is used for backwards compatibility with Atlas, - set it to `false` if Houston hasn't been deployed yet
type TimezoneCount ¶
Count of nodes belonging to a timezone
func GetNodeCountPerTimezone ¶
func GetNodeCountPerTimezone(rp *rocketpool.RocketPool, offset, limit *big.Int, opts *bind.CallOpts) ([]TimezoneCount, error)
Get a breakdown of the number of nodes per timezone
type TrustedNodeParticipation ¶
type TrustedNodeParticipation struct {
StartBlock uint64
UpdateFrequency uint64
UpdateCount uint64
Probability float64
ExpectedSubmissions float64
ActualSubmissions map[common.Address]float64
Participation map[common.Address][]bool
}
The results of the trusted node participation calculation