Rocket Pool

Appearance

auction ​

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

Index ​

Constants ​

Settings

go
const LotDetailsBatchSize = 10
const LotDetailsBatchSize = 10

func ClaimBid ​

go
func ClaimBid(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)
func ClaimBid(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)

Claim RPL from a lot that was bid on

func CreateLot ​

go
func CreateLot(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (uint64, common.Hash, error)
func CreateLot(rp *rocketpool.RocketPool, opts *bind.TransactOpts) (uint64, common.Hash, error)

Create a new lot

func EstimateClaimBidGas ​

go
func EstimateClaimBidGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
func EstimateClaimBidGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of ClaimBid

func EstimateCreateLotGas ​

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

Estimate the gas of CreateLot

func EstimatePlaceBidGas ​

go
func EstimatePlaceBidGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
func EstimatePlaceBidGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of PlaceBid

func EstimateRecoverUnclaimedRPLGas ​

go
func EstimateRecoverUnclaimedRPLGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)
func EstimateRecoverUnclaimedRPLGas(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (rocketpool.GasInfo, error)

Estimate the gas of RecoverUnclaimedRPL

func GetAllottedRPLBalance ​

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

Get the allotted RPL balance of the auction contract

func GetLotAddressBidAmount ​

go
func GetLotAddressBidAmount(rp *rocketpool.RocketPool, lotIndex uint64, bidder common.Address, opts *bind.CallOpts) (*big.Int, error)
func GetLotAddressBidAmount(rp *rocketpool.RocketPool, lotIndex uint64, bidder common.Address, opts *bind.CallOpts) (*big.Int, error)

Get the ETH amount bid on a lot by an address

func GetLotClaimedRPLAmount ​

go
func GetLotClaimedRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotClaimedRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotCount ​

go
func GetLotCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)
func GetLotCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, error)

Get the number of lots for auction

func GetLotCurrentPrice ​

go
func GetLotCurrentPrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotCurrentPrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotEndBlock ​

go
func GetLotEndBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (uint64, error)
func GetLotEndBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (uint64, error)

func GetLotExists ​

go
func GetLotExists(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)
func GetLotExists(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)

Lot details

func GetLotIsCleared ​

go
func GetLotIsCleared(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)
func GetLotIsCleared(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)

func GetLotPriceAtBlock ​

go
func GetLotPriceAtBlock(rp *rocketpool.RocketPool, lotIndex, blockNumber uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotPriceAtBlock(rp *rocketpool.RocketPool, lotIndex, blockNumber uint64, opts *bind.CallOpts) (*big.Int, error)

Get the price of a lot at a specific block

func GetLotPriceAtCurrentBlock ​

go
func GetLotPriceAtCurrentBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotPriceAtCurrentBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotPriceByTotalBids ​

go
func GetLotPriceByTotalBids(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotPriceByTotalBids(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotRPLRecovered ​

go
func GetLotRPLRecovered(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)
func GetLotRPLRecovered(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (bool, error)

func GetLotRemainingRPLAmount ​

go
func GetLotRemainingRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotRemainingRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotReservePrice ​

go
func GetLotReservePrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotReservePrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotStartBlock ​

go
func GetLotStartBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (uint64, error)
func GetLotStartBlock(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (uint64, error)

func GetLotStartPrice ​

go
func GetLotStartPrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotStartPrice(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotTotalBidAmount ​

go
func GetLotTotalBidAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotTotalBidAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetLotTotalRPLAmount ​

go
func GetLotTotalRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)
func GetLotTotalRPLAmount(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (*big.Int, error)

func GetRemainingRPLBalance ​

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

Get the remaining RPL balance of the auction contract

func GetTotalRPLBalance ​

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

Get the total RPL balance of the auction contract

func PlaceBid ​

go
func PlaceBid(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)
func PlaceBid(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)

Place a bid on a lot

func RecoverUnclaimedRPL ​

go
func RecoverUnclaimedRPL(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)
func RecoverUnclaimedRPL(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.TransactOpts) (common.Hash, error)

Recover unclaimed RPL from a lot

type LotDetails ​

Lot details

go
type LotDetails struct {
    Index               uint64   `json:"index"`
    Exists              bool     `json:"exists"`
    StartBlock          uint64   `json:"startBlock"`
    EndBlock            uint64   `json:"endBlock"`
    StartPrice          *big.Int `json:"startPrice"`
    ReservePrice        *big.Int `json:"reservePrice"`
    PriceAtCurrentBlock *big.Int `json:"priceAtCurrentBlock"`
    PriceByTotalBids    *big.Int `json:"priceByTotalBids"`
    CurrentPrice        *big.Int `json:"currentPrice"`
    TotalRPLAmount      *big.Int `json:"totalRplAmount"`
    ClaimedRPLAmount    *big.Int `json:"claimedRplAmount"`
    RemainingRPLAmount  *big.Int `json:"remainingRplAmount"`
    TotalBidAmount      *big.Int `json:"totalBidAmount"`
    AddressBidAmount    *big.Int `json:"addressBidAmount"`
    Cleared             bool     `json:"cleared"`
    RPLRecovered        bool     `json:"rplRecovered"`
}
type LotDetails struct {
    Index               uint64   `json:"index"`
    Exists              bool     `json:"exists"`
    StartBlock          uint64   `json:"startBlock"`
    EndBlock            uint64   `json:"endBlock"`
    StartPrice          *big.Int `json:"startPrice"`
    ReservePrice        *big.Int `json:"reservePrice"`
    PriceAtCurrentBlock *big.Int `json:"priceAtCurrentBlock"`
    PriceByTotalBids    *big.Int `json:"priceByTotalBids"`
    CurrentPrice        *big.Int `json:"currentPrice"`
    TotalRPLAmount      *big.Int `json:"totalRplAmount"`
    ClaimedRPLAmount    *big.Int `json:"claimedRplAmount"`
    RemainingRPLAmount  *big.Int `json:"remainingRplAmount"`
    TotalBidAmount      *big.Int `json:"totalBidAmount"`
    AddressBidAmount    *big.Int `json:"addressBidAmount"`
    Cleared             bool     `json:"cleared"`
    RPLRecovered        bool     `json:"rplRecovered"`
}

func GetLotDetails ​

go
func GetLotDetails(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (LotDetails, error)
func GetLotDetails(rp *rocketpool.RocketPool, lotIndex uint64, opts *bind.CallOpts) (LotDetails, error)

Get a lot's details

func GetLotDetailsWithBids ​

go
func GetLotDetailsWithBids(rp *rocketpool.RocketPool, lotIndex uint64, bidder common.Address, opts *bind.CallOpts) (LotDetails, error)
func GetLotDetailsWithBids(rp *rocketpool.RocketPool, lotIndex uint64, bidder common.Address, opts *bind.CallOpts) (LotDetails, error)

Get a lot's details with address bid amounts

func GetLots ​

go
func GetLots(rp *rocketpool.RocketPool, opts *bind.CallOpts) ([]LotDetails, error)
func GetLots(rp *rocketpool.RocketPool, opts *bind.CallOpts) ([]LotDetails, error)

Get all lot details

func GetLotsWithBids ​

go
func GetLotsWithBids(rp *rocketpool.RocketPool, bidder common.Address, opts *bind.CallOpts) ([]LotDetails, error)
func GetLotsWithBids(rp *rocketpool.RocketPool, bidder common.Address, opts *bind.CallOpts) ([]LotDetails, error)

Get all lot details with bids from an address

Made by Rocket Pool with ❤️