Rocket Pool

# tokens

import "github.com/rocket-pool/rocketpool-go/tokens"

# Index

# func ApproveFixedSupplyRPL (opens new window)

func ApproveFixedSupplyRPL(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Approve an fixed-supply RPL spender

# func ApproveRETH (opens new window)

func ApproveRETH(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Approve a rETH spender

# func ApproveRPL (opens new window)

func ApproveRPL(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Approve an RPL spender

# func BurnRETH (opens new window)

func BurnRETH(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Burn rETH for ETH

# func EstimateApproveFixedSupplyRPLGas (opens new window)

func EstimateApproveFixedSupplyRPLGas(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of ApproveFixedSupplyRPL

# func EstimateApproveRETHGas (opens new window)

func EstimateApproveRETHGas(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of ApproveRETH

# func EstimateApproveRPLGas (opens new window)

func EstimateApproveRPLGas(rp *rocketpool.RocketPool, spender common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of ApproveRPL

# func EstimateBurnRETHGas (opens new window)

func EstimateBurnRETHGas(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of BurnRETH

# func EstimateMintInflationRPLGas (opens new window)

func EstimateMintInflationRPLGas(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of MintInflationRPL

# func EstimateSwapFixedSupplyRPLForRPLGas (opens new window)

func EstimateSwapFixedSupplyRPLForRPLGas(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of SwapFixedSupplyRPLForRPL

# func EstimateTransferFixedSupplyRPLGas (opens new window)

func EstimateTransferFixedSupplyRPLGas(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferFixedSupplyRPL

# func EstimateTransferFromFixedSupplyRPLGas (opens new window)

func EstimateTransferFromFixedSupplyRPLGas(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferFromFixedSupplyRPL

# func EstimateTransferFromRETHGas (opens new window)

func EstimateTransferFromRETHGas(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferFromRETH

# func EstimateTransferFromRPLGas (opens new window)

func EstimateTransferFromRPLGas(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferFromRPL

# func EstimateTransferRETHGas (opens new window)

func EstimateTransferRETHGas(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferRETH

# func EstimateTransferRPLGas (opens new window)

func EstimateTransferRPLGas(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of TransferRPL

# func GetETHValueOfRETH (opens new window)

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

Get the ETH value of an amount of rETH

# func GetFixedSupplyRPLAllowance (opens new window)

func GetFixedSupplyRPLAllowance(rp *rocketpool.RocketPool, owner, spender common.Address, opts *bind.CallOpts) (*big.Int, error)

Get fixed-supply RPL allowance

# func GetFixedSupplyRPLBalance (opens new window)

func GetFixedSupplyRPLBalance(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*big.Int, error)

Get fixed-supply RPL balance

# func GetFixedSupplyRPLTotalSupply (opens new window)

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

Get fixed-supply RPL total supply

# func GetRETHAllowance (opens new window)

func GetRETHAllowance(rp *rocketpool.RocketPool, owner, spender common.Address, opts *bind.CallOpts) (*big.Int, error)

Get rETH allowance

# func GetRETHBalance (opens new window)

func GetRETHBalance(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*big.Int, error)

Get rETH balance

# func GetRETHCollateralRate (opens new window)

func GetRETHCollateralRate(rp *rocketpool.RocketPool, opts *bind.CallOpts) (float64, error)

Get the rETH collateralization rate

# func GetRETHContractETHBalance (opens new window)

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

Get the rETH contract ETH balance

# func GetRETHExchangeRate (opens new window)

func GetRETHExchangeRate(rp *rocketpool.RocketPool, opts *bind.CallOpts) (float64, error)

Get the current ETH : rETH exchange rate

# func GetRETHTotalCollateral (opens new window)

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

Get the total amount of ETH collateral available for rETH trades

# func GetRETHTotalSupply (opens new window)

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

Get rETH total supply

# func GetRETHValueOfETH (opens new window)

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

Get the rETH value of an amount of ETH

# func GetRPLAllowance (opens new window)

func GetRPLAllowance(rp *rocketpool.RocketPool, owner, spender common.Address, opts *bind.CallOpts) (*big.Int, error)

Get RPL allowance

# func GetRPLBalance (opens new window)

func GetRPLBalance(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (*big.Int, error)

Get RPL balance

# func GetRPLInflationIntervalRate (opens new window)

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

Get the RPL inflation interval rate

# func GetRPLTotalSupply (opens new window)

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

Get RPL total supply

# func MintInflationRPL (opens new window)

func MintInflationRPL(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (common.Hash, error)

Mint new RPL tokens from inflation

# func SwapFixedSupplyRPLForRPL (opens new window)

func SwapFixedSupplyRPLForRPL(rp *rocketpool.RocketPool, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Swap fixed-supply RPL for new RPL tokens

# func TransferFixedSupplyRPL (opens new window)

func TransferFixedSupplyRPL(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer fixed-supply RPL

# func TransferFromFixedSupplyRPL (opens new window)

func TransferFromFixedSupplyRPL(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer fixed-supply RPL from a sender

# func TransferFromRETH (opens new window)

func TransferFromRETH(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer rETH from a sender

# func TransferFromRPL (opens new window)

func TransferFromRPL(rp *rocketpool.RocketPool, from, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer RPL from a sender

# func TransferRETH (opens new window)

func TransferRETH(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer rETH

# func TransferRPL (opens new window)

func TransferRPL(rp *rocketpool.RocketPool, to common.Address, amount *big.Int, opts *bind.TransactOpts) (common.Hash, error)

Transfer RPL

# type Balances (opens new window)

Token balances

type Balances struct {
    ETH            *big.Int `json:"eth"`
    RETH           *big.Int `json:"reth"`
    RPL            *big.Int `json:"rpl"`
    FixedSupplyRPL *big.Int `json:"fixedSupplyRpl"`
}

# func GetBalances (opens new window)

func GetBalances(rp *rocketpool.RocketPool, address common.Address, opts *bind.CallOpts) (Balances, error)

Get token balances of an address

← types →