Enum polkadot_runtime_common::traits::AuctionStatus

pub enum AuctionStatus<BlockNumber> {
    NotStarted,
    StartingPeriod,
    EndingPeriod(BlockNumber, BlockNumber),
    VrfDelay(BlockNumber),
}

An enum which tracks the status of the auction system, and which phase it is in.

Variants

NotStarted

An auction has not started yet.

StartingPeriod

We are in the starting period of the auction, collecting initial bids.

EndingPeriod(BlockNumber, BlockNumber)

We are in the ending period of the auction, where we are taking snapshots of the winning bids. This state supports “sampling”, where we may only take a snapshot every N blocks. In this case, the first number is the current sample number, and the second number is the sub-sample. i.e. for sampling every 20 blocks, the 25th block in the ending period will be EndingPeriod(1, 5).

VrfDelay(BlockNumber)

We have completed the bidding process and are waiting for the VRF to return some acceptable randomness to select the winner. The number represents how many blocks we have been waiting.

Implementations

impl<BlockNumber> AuctionStatus<BlockNumber>

pub fn is_in_progress(&self) -> bool

Returns true if the auction is in any state other than NotStarted.

pub fn is_starting(&self) -> bool

Return true if the auction is in the starting period.

pub fn is_ending(self) -> Option<(BlockNumber, BlockNumber)>

Returns Some(sample, sub_sample) if the auction is in the EndingPeriod, otherwise returns None.

pub fn is_vrf(&self) -> bool

Returns true if the auction is in the VrfDelay period.

Trait Implementations

impl<BlockNumber: Debug> Debug for AuctionStatus<BlockNumber>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<BlockNumber: PartialEq> PartialEq<AuctionStatus<BlockNumber>> for AuctionStatus<BlockNumber>

fn eq(&self, other: &AuctionStatus<BlockNumber>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<BlockNumber> StructuralPartialEq for AuctionStatus<BlockNumber>