Struct polkadot_runtime_common::auctions::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn new_auction(
    origin: OriginFor<T>,
    duration: T::BlockNumber,
    lease_period_index: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod
) -> DispatchResult

Create a new auction.

This can only happen when there isn’t already an auction in progress and may only be called by the root origin. Accepts the duration of this auction and the lease_period_index of the initial lease period of the four that are to be auctioned.

pub fn bid(
    origin: OriginFor<T>,
    para: ParaId,
    auction_index: AuctionIndex,
    first_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    last_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    amount: <<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResult

Make a new bid from an account (including a parachain account) for deploying a new parachain.

Multiple simultaneous bids from the same bidder are allowed only as long as all active bids overlap each other (i.e. are mutually exclusive). Bids cannot be redacted.

• sub is the sub-bidder ID, allowing for multiple competing bids to be made by (and funded by) the same account.
• auction_index is the index of the auction to bid on. Should just be the present value of AuctionCounter.
• first_slot is the first lease period index of the range to bid on. This is the absolute lease period index value, not an auction-specific offset.
• last_slot is the last lease period index of the range to bid on. This is the absolute lease period index value, not an auction-specific offset.
• amount is the amount to bid to be held as deposit for the parachain should the bid win. This amount is held throughout the range.

pub fn cancel_auction(origin: OriginFor<T>) -> DispatchResult

Cancel an in-progress auction.

Can only be called by Root origin.

impl<T: Config> Pallet<T>

pub fn auction_counter() -> AuctionIndex

Number of auctions started so far.

impl<T: Config> Pallet<T>

pub fn auction_info(
) -> Option<(<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod, T::BlockNumber)>

Information relating to the current auction, if there is one.

The first item in the tuple is the lease period index that the first of the four contiguous lease periods on auction is for. The second is the block number when the auction will “begin to end”, i.e. the first block of the Ending Period of the auction.

impl<T: Config> Pallet<T>

pub fn reserved_amounts<KArg>(
    k: KArg
) -> Option<<<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance>where
    KArg: EncodeLike<(T::AccountId, ParaId)>,

Amounts currently reserved in the accounts of the bidders currently winning (sub-)ranges.

impl<T: Config> Pallet<T>

pub fn winning<KArg>(
    k: KArg
) -> Option<[Option<(<T as Config>::AccountId, ParaId, <<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance)>; 36]>where
    KArg: EncodeLike<T::BlockNumber>,

The winning bids for each of the 10 ranges at each sample in the final Ending Period of the current auction. The map’s key is the 0-based index into the Sample Size. The first sample of the ending period is 0; the last is Sample Size - 1.

impl<T: Config> Pallet<T>

pub fn handle_bid(
    bidder: T::AccountId,
    para: ParaId,
    auction_index: u32,
    first_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    last_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    amount: <<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResult

Actually place a bid in the current auction.

• bidder: The account that will be funding this bid.
• auction_index: The auction index of the bid. For this to succeed, must equal the current value of AuctionCounter.
• first_slot: The first lease period index of the range to be bid on.
• last_slot: The last lease period index of the range to be bid on (inclusive).
• amount: The total amount to be the bid for deposit over the range.

Trait Implementations

impl<T: Config> Auctioneer<<T as Config>::BlockNumber> for Pallet<T>

type AccountId = <T as Config>::AccountId

An account identifier for a leaser.

type LeasePeriod = <T as Config>::BlockNumber

The measurement type for counting lease periods (generally the same as BlockNumber).

type Currency = <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency

The currency type in which the lease is taken.

fn new_auction(
    duration: T::BlockNumber,
    lease_period_index: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod
) -> DispatchResult

Create a new auction.

fn auction_status(now: T::BlockNumber) -> AuctionStatus<T::BlockNumber>

Given the current block number, return the current auction status.

fn place_bid(
    bidder: T::AccountId,
    para: ParaId,
    first_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    last_slot: <<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod,
    amount: <<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResult

Place a bid in the current auction.

fn lease_period_index(b: T::BlockNumber) -> Option<(Self::LeasePeriod, bool)>

Returns the lease period at block, and if this is the first block of a new lease period.

fn lease_period_length() -> (T::BlockNumber, T::BlockNumber)

The length of a lease period, and any offset which may be introduced. This is only used in benchmarking to automate certain calls.

fn has_won_an_auction(para: ParaId, bidder: &T::AccountId) -> bool

Check if the para and user combination has won an auction in the past.

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> 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<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>