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 suspend_xcm_execution(origin: OriginFor<T>) -> DispatchResult

Suspends all XCM executions for the XCMP queue, regardless of the sender’s origin.

• origin: Must pass ControllerOrigin.

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

Resumes all XCM executions for the XCMP queue.

Note that this function doesn’t change the status of the in/out bound channels.

• origin: Must pass ControllerOrigin.

pub fn update_suspend_threshold( origin: OriginFor<T>, new: u32, ) -> DispatchResult

Overwrites the number of pages which must be in the queue for the other side to be told to suspend their sending.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.suspend_value

pub fn update_drop_threshold(origin: OriginFor<T>, new: u32) -> DispatchResult

Overwrites the number of pages which must be in the queue after which we drop any further messages from the channel.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.drop_threshold

pub fn update_resume_threshold(origin: OriginFor<T>, new: u32) -> DispatchResult

Overwrites the number of pages which the queue must be reduced to before it signals that message sending may recommence after it has been suspended.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.resume_threshold

impl<T: Config> Pallet<T>

pub fn on_idle_weight() -> Weight

The worst-case weight of on_idle.

Trait Implementations

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,

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

type Id = Id

Type used for assigning different fee factors to different destinations

fn get_fee_factor(id: Self::Id) -> FixedU128

Returns the current message fee factor.

fn set_fee_factor(id: Self::Id, val: FixedU128)

Sets the current message fee factor.

const MIN_FEE_FACTOR: FixedU128 = _

Minimal delivery fee factor.

const EXPONENTIAL_FEE_BASE: FixedU128 = _

The factor that is used to increase the current message fee factor when the transport protocol is experiencing some lags.

const MESSAGE_SIZE_FEE_BASE: FixedU128 = _

The factor that is used to increase the current message fee factor for every sent kilobyte.

fn do_increase_fee_factor(fee_factor: &mut FixedU128, message_size: u128)

fn increase_fee_factor(id: Self::Id, message_size: u128)

Increases the delivery fee factor by a factor based on message size and records the result.

fn do_decrease_fee_factor(fee_factor: &mut FixedU128) -> bool

fn decrease_fee_factor(id: Self::Id) -> bool

Decreases the delivery fee factor by a constant factor and records the result.

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

type InCodeStorageVersion = StorageVersion

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 integrity_test()

Check the integrity of this pallet’s configuration.

fn on_idle(_block: BlockNumberFor<T>, limit: 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_initialize(_n: BlockNumber) -> 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_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.

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

fn clear_messages()

Clear the queues at the beginning of Runtime API call, so that subsequent Self::get_messages() will return only messages generated by said Runtime API.

fn get_messages() -> Vec<(VersionedLocation, Vec<VersionedXcm<()>>)>

Get queued messages and their destinations.

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

fn on_queue_changed(para: ParaId, fp: QueueFootprint)

Note that the queue id now has item_count items in it, taking up items_size bytes.

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

fn is_paused(para: &ParaId) -> bool

Whether this queue is paused.

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

Xcm sender for sending to a sibling parachain.

type Ticket = (Id, VersionedXcm<()>)

Intermediate value which connects the two phases of the send operation.

fn validate( dest: &mut Option<Location>, msg: &mut Option<Xcm<()>>, ) -> SendResult<(ParaId, VersionedXcm<()>)>

Check whether the given _message is deliverable to the given _destination and if so determine the cost which will be paid by this chain to do so, returning a Validated token which can be used to enact delivery.

fn deliver((id, xcm): (ParaId, VersionedXcm<()>)) -> Result<XcmHash, SendError>

Actually carry out the delivery operation for a previously validated message sending.

fn ensure_successful_delivery(_location: Option<Location>)

Ensure [Self::delivery] is successful for the given location when called in benchmarks.

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

fn handle_xcmp_messages<'a, I: Iterator<Item = (ParaId, RelayBlockNumber, &'a [u8])>>( iter: I, max_weight: Weight, ) -> Weight

Handle some incoming XCMP messages (note these are the big one-per-block aggregate messages).

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

fn take_outbound_messages(maximum_channels: usize) -> Vec<(ParaId, Vec<u8>)>

Take a single XCMP message from the queue for the given dest, if one exists.

impl<T> Eq for Pallet<T>