Rocket Pool

# auction

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

# Index

# Constants

Settings

const LotDetailsBatchSize = 10

# func ClaimBid (opens new window)

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

Claim RPL from a lot that was bid on

# func CreateLot (opens new window)

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

Create a new lot

# func EstimateClaimBidGas (opens new window)

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

Estimate the gas of ClaimBid

# func EstimateCreateLotGas (opens new window)

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

Estimate the gas of CreateLot

# func EstimatePlaceBidGas (opens new window)

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

Estimate the gas of PlaceBid

# func EstimateRecoverUnclaimedRPLGas (opens new window)

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

Estimate the gas of RecoverUnclaimedRPL

# func GetAllottedRPLBalance (opens new window)

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

Get the allotted RPL balance of the auction contract

# func GetLotAddressBidAmount (opens new window)

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 (opens new window)

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

# func GetLotCount (opens new window)

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

Get the number of lots for auction

# func GetLotCurrentPrice (opens new window)

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

# func GetLotEndBlock (opens new window)

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

# func GetLotExists (opens new window)

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

Lot details

# func GetLotIsCleared (opens new window)

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

# func GetLotPriceAtBlock (opens new window)

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 (opens new window)

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

# func GetLotPriceByTotalBids (opens new window)

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

# func GetLotRPLRecovered (opens new window)

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

# func GetLotRemainingRPLAmount (opens new window)

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

# func GetLotReservePrice (opens new window)

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

# func GetLotStartBlock (opens new window)

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

# func GetLotStartPrice (opens new window)

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

# func GetLotTotalBidAmount (opens new window)

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

# func GetLotTotalRPLAmount (opens new window)

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

# func GetRemainingRPLBalance (opens new window)

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

Get the remaining RPL balance of the auction contract

# func GetTotalRPLBalance (opens new window)

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

Get the total RPL balance of the auction contract

# func PlaceBid (opens new window)

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

Place a bid on a lot

# func RecoverUnclaimedRPL (opens new window)

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

Recover unclaimed RPL from a lot

# type LotDetails (opens new window)

Lot details

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 (opens new window)

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

Get a lot's details

# func GetLotDetailsWithBids (opens new window)

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 (opens new window)

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

Get all lot details

# func GetLotsWithBids (opens new window)

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

Get all lot details with bids from an address

← contracts →