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 schedule( origin: OriginFor<T>, when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResult

Anonymously schedule a task.

pub fn cancel( origin: OriginFor<T>, when: BlockNumberFor<T>, index: u32, ) -> DispatchResult

Cancel an anonymously scheduled task.

pub fn schedule_named( origin: OriginFor<T>, id: TaskName, when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResult

Schedule a named task.

pub fn cancel_named(origin: OriginFor<T>, id: TaskName) -> DispatchResult

Cancel a named scheduled task.

pub fn schedule_after( origin: OriginFor<T>, after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResult

Anonymously schedule a task after a delay.

pub fn schedule_named_after( origin: OriginFor<T>, id: TaskName, after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResult

Schedule a named task after a delay.

pub fn set_retry( origin: OriginFor<T>, task: TaskAddress<BlockNumberFor<T>>, retries: u8, period: BlockNumberFor<T>, ) -> DispatchResult

Set a retry configuration for a task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

pub fn set_retry_named( origin: OriginFor<T>, id: TaskName, retries: u8, period: BlockNumberFor<T>, ) -> DispatchResult

Set a retry configuration for a named task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

pub fn cancel_retry( origin: OriginFor<T>, task: TaskAddress<BlockNumberFor<T>>, ) -> DispatchResult

Removes the retry configuration of a task.

pub fn cancel_retry_named(origin: OriginFor<T>, id: TaskName) -> DispatchResult

Cancel the retry configuration of a named task.

impl<T: Config> Pallet<T>

pub fn migrate_v1_to_v4() -> Weight

Migrate storage format from V1 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v2_to_v4() -> Weight

Migrate storage format from V2 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v3_to_v4() -> Weight

Migrate storage format from V3 to V4.

Returns the weight consumed by this migration.

impl<T: Config> Pallet<T>

pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + Decode>()

Helper to migrate scheduler when the pallet origin type has changed.

Trait Implementations

impl<T: Config> Anon<<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, u32)

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

👎Deprecated: Use v3 instead. Will be removed after September 2024.

A means of expressing a call by the hash of its encoded data.

fn schedule( when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: CallOrHashOf<T>, ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel((when, index): Self::Address) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.

fn reschedule( address: Self::Address, when: DispatchTime<BlockNumberFor<T>>, ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named.

fn next_dispatch_time( (when, index): Self::Address, ) -> Result<BlockNumberFor<T>, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task.

impl<T: Config> Anon<<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

type Hasher = <T as Config>::Hashing

The hasher used in the runtime.

fn schedule( when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: BoundedCallOf<T>, ) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel((when, index): Self::Address) -> Result<(), DispatchError>

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.

fn reschedule( address: Self::Address, when: DispatchTime<BlockNumberFor<T>>, ) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named.

fn next_dispatch_time( (when, index): Self::Address, ) -> Result<BlockNumberFor<T>, DispatchError>

Return the next dispatch time for a given task.

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> 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 on_initialize(_now: SystemBlockNumberFor<T>) -> Weight

Execute the scheduled calls

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> Named<<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, u32)

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

👎Deprecated: Use v3 instead. Will be removed after September 2024.

A means of expressing a call by the hash of its encoded data.

fn schedule_named( id: Vec<u8>, when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: CallOrHashOf<T>, ) -> Result<Self::Address, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel_named(id: Vec<u8>) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also.

fn reschedule_named( id: Vec<u8>, when: DispatchTime<BlockNumberFor<T>>, ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: Vec<u8>) -> Result<BlockNumberFor<T>, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task.

impl<T: Config> Named<<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, <T as Config>::RuntimeCall, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = (<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, u32)

An address which can be used for removing a scheduled task.

type Hasher = <T as Config>::Hashing

The hasher used in the runtime.

fn schedule_named( id: TaskName, when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: BoundedCallOf<T>, ) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

fn cancel_named(id: TaskName) -> Result<(), DispatchError>

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also.

fn reschedule_named( id: TaskName, when: DispatchTime<BlockNumberFor<T>>, ) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: TaskName) -> Result<BlockNumberFor<T>, DispatchError>

Return the next dispatch time for a given task.

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>