Type Alias Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

impl<T: Config> Pallet<T>

pub fn new_auction( origin: OriginFor<T>, duration: BlockNumberFor<T>, lease_period_index: <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::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<BlockNumberFor<T>>>::LeasePeriod, last_slot: <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::LeasePeriod, amount: <<<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::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 handle_bid( bidder: T::AccountId, para: ParaId, auction_index: u32, first_slot: <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::LeasePeriod, last_slot: <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::LeasePeriod, amount: <<<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

type AccountId = <T as Config>::AccountId

An account identifier for a leaser.

type LeasePeriod = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

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

type Currency = <<T as Config>::Leaser as Leaser<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Currency

The currency type in which the lease is taken.

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

Create a new auction.

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

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<BlockNumberFor<T>>>::LeasePeriod, last_slot: <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::LeasePeriod, amount: <<<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

Place a bid in the current auction.

fn lease_period_index(b: BlockNumberFor<T>) -> 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() -> (BlockNumberFor<T>, BlockNumberFor<T>)

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: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + 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 RuntimeCall = 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> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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 for Pallet<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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: Config> TryDecodeEntireStorage for Pallet<T>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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

fn prefix() -> [u8; 16]

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

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>