minipool

Documentation

Index

• func GetMinipoolBytecode(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) ([]byte, error)
• func GetQueueEffectiveCapacity(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (*big.Int, error)
• func GetQueueLength(rp *rocketpool.RocketPool, depositType rptypes.MinipoolDeposit, ...) (uint64, error)
• func GetQueueMinipoolAtPosition(rp *rocketpool.RocketPool, position uint64, opts *bind.CallOpts, ...) (minipool.Minipool, error)
• func GetQueueNextCapacity(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (*big.Int, error)
• func GetQueuePositionOfMinipool(rp *rocketpool.RocketPool, mp minipool.Minipool, opts *bind.CallOpts, ...) (uint64, error)
• func GetQueueTotalCapacity(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (*big.Int, error)
• func GetQueueTotalLength(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (uint64, error)
• type QueueCapacity
  • func GetQueueCapacity(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (QueueCapacity, error)
• type QueueDetails
  • func GetQueueDetails(rp *rocketpool.RocketPool, mp minipool.Minipool, opts *bind.CallOpts, ...) (QueueDetails, error)
• type QueueLengths
  • func GetQueueLengths(rp *rocketpool.RocketPool, opts *bind.CallOpts, ...) (QueueLengths, error)

Functions

func GetMinipoolBytecode

func GetMinipoolBytecode(rp *rocketpool.RocketPool, opts *bind.CallOpts, legacyRocketMinipoolFactoryAddress *common.Address) ([]byte, error)

Get the CreationCode binary for the RocketMinipool contract that will be created by node deposits

func GetQueueEffectiveCapacity

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

Get the total effective capacity of the minipool queue (used in node demand calculation)

func GetQueueLength

func GetQueueLength(rp *rocketpool.RocketPool, depositType rptypes.MinipoolDeposit, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (uint64, error)

Get the length of a single minipool queue

func GetQueueMinipoolAtPosition

func GetQueueMinipoolAtPosition(rp *rocketpool.RocketPool, position uint64, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (minipool.Minipool, error)

Get the minipool at the specified position in queue (0-indexed).

func GetQueueNextCapacity

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

Get the capacity of the next minipool in the queue

func GetQueuePositionOfMinipool

func GetQueuePositionOfMinipool(rp *rocketpool.RocketPool, mp minipool.Minipool, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (uint64, error)

Get a minipools position in queue (1-indexed). 0 means it is currently not queued.

func GetQueueTotalCapacity

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

Get the total capacity of the minipool queue

func GetQueueTotalLength

func GetQueueTotalLength(rp *rocketpool.RocketPool, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (uint64, error)

Get the total length of the minipool queue

Types

type QueueCapacity

type QueueCapacity struct {
	Total        *big.Int
	Effective    *big.Int
	NextMinipool *big.Int
}

Minipool queue capacity

func GetQueueCapacity

func GetQueueCapacity(rp *rocketpool.RocketPool, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (QueueCapacity, error)

Get minipool queue capacity

type QueueDetails

type QueueDetails struct {
	Position uint64
}

Minipools queue status details

func GetQueueDetails

func GetQueueDetails(rp *rocketpool.RocketPool, mp minipool.Minipool, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (QueueDetails, error)

Get Queue position details of a minipool

type QueueLengths

type QueueLengths struct {
	Total        uint64
	FullDeposit  uint64
	HalfDeposit  uint64
	EmptyDeposit uint64
}

Minipool queue lengths

func GetQueueLengths

func GetQueueLengths(rp *rocketpool.RocketPool, opts *bind.CallOpts, legacyRocketMinipoolQueueAddress *common.Address) (QueueLengths, error)

Get minipool queue lengths