Struct polkadot_runtime_common::auctions::pallet::Pallet [−][src]
pub struct Pallet<T>(_);
Expand description
The pallet implementing the on-chain logic.
Implementations
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
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
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 ofAuctionCounter
.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.
Cancel an in-progress auction.
Can only be called by Root origin.
Number of auctions started so far.
pub fn auction_info(
) -> Option<(<<T as Config>::Leaser as Leaser<<T as Config>::BlockNumber>>::LeasePeriod, T::BlockNumber)>
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.
Amounts currently reserved in the accounts of the bidders currently winning (sub-)ranges.
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
.
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
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 ofAuctionCounter
.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
type LeasePeriod = T::BlockNumber
type LeasePeriod = T::BlockNumber
The measurement type for counting lease periods (generally the same as BlockNumber
).
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
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. Read more
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
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. Read more
Returns the lease period at block
, and if this is the first block of a new lease period. Read more
The length of a lease period, and any offset which may be introduced. This is only used in benchmarking to automate certain calls. Read more
Check if the para and user combination has won an auction in the past.
Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more
fn run_benchmark(
extrinsic: &[u8],
c: &[(BenchmarkParameter, u32)],
whitelist: &[TrackedStorageKey],
verify: bool,
internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>
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.
Returns the current storage version as supported by the pallet.
Returns the on-chain storage version of the pallet as stored in the storage.
The block is being initialized. Implement to have something happen. Read more
The block is being finalized. Implement to have something happen.
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. Read more
Perform a module upgrade. Read more
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. Read more
Run integrity test. Read more
Run integrity test. Read more
This function is being called after every block import (when fully synced). Read more
The block is being finalized. Implement to have something happen. Read more
Something that should happen at genesis.
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. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Name of the Rust module containing the pallet.
Version of the crate containing the pallet.
Extend the given vector by all of the pallets’ information that this type represents. Read more
All of the pallets’ information that this type represents.
Auto Trait Implementations
impl<T> RefUnwindSafe for Pallet<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Pallet<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
Compare self to key
and return true
if they are equal.
Causes self
to use its Binary
implementation when Debug
-formatted.
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
Pipes by value. This is generally the method you want to use. Read more
Borrows self
and passes that borrow into the pipe function. Read more
Mutably borrows self
and passes that borrow into the pipe function. Read more
Borrows self
, then passes self.borrow()
into the pipe function. Read more
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
Borrows self
, then passes self.as_ref()
into the pipe function.
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
Borrows self
, then passes self.deref()
into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
Checks if self
is actually part of its subset T
(and can be converted to it).
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
The inclusion map: converts self
to the equivalent element of its superset.
Immutable access to the Borrow<B>
of a value. Read more
Mutable access to the BorrowMut<B>
of a value. Read more
Immutable access to the AsRef<R>
view of a value. Read more
Mutable access to the AsMut<R>
view of a value. Read more
Immutable access to the Deref::Target
of a value. Read more
Mutable access to the Deref::Target
of a value. Read more
Calls .tap()
only in debug builds, and is erased in release builds.
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref()
only in debug builds, and is erased in release
builds. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref
in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.
The counterpart to unchecked_from
.
Consume self to return an equivalent value of T
.
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more