Struct Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

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

Enter safe-mode permissionlessly for Config::EnterDuration blocks.

Reserves Config::EnterDepositAmount from the caller’s account. Emits an Event::Entered event on success. Errors with Error::Entered if the safe-mode is already entered. Errors with Error::NotConfigured if the deposit amount is None.

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

Enter safe-mode by force for a per-origin configured number of blocks.

Emits an Event::Entered event on success. Errors with Error::Entered if the safe-mode is already entered.

Can only be called by the Config::ForceEnterOrigin origin.

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

Extend the safe-mode permissionlessly for Config::ExtendDuration blocks.

This accumulates on top of the current remaining duration. Reserves Config::ExtendDepositAmount from the caller’s account. Emits an Event::Extended event on success. Errors with Error::Exited if the safe-mode is entered. Errors with Error::NotConfigured if the deposit amount is None.

This may be called by any signed origin with Config::ExtendDepositAmount free currency to reserve. This call can be disabled for all origins by configuring Config::ExtendDepositAmount to None.

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

Extend the safe-mode by force for a per-origin configured number of blocks.

Emits an Event::Extended event on success. Errors with Error::Exited if the safe-mode is inactive.

Can only be called by the Config::ForceExtendOrigin origin.

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

Exit safe-mode by force.

Emits an Event::Exited with ExitReason::Force event on success. Errors with Error::Exited if the safe-mode is inactive.

Note: safe-mode will be automatically deactivated by Pallet::on_initialize hook after the block height is greater than the EnteredUntil storage item. Emits an Event::Exited with ExitReason::Timeout event when deactivated in the hook.

pub fn force_slash_deposit( origin: OriginFor<T>, account: T::AccountId, block: BlockNumberFor<T>, ) -> DispatchResult

Slash a deposit for an account that entered or extended safe-mode at a given historical block.

This can only be called while safe-mode is entered.

Emits a Event::DepositSlashed event on success. Errors with Error::Entered if safe-mode is entered.

Can only be called by the Config::ForceDepositOrigin origin.

pub fn release_deposit( origin: OriginFor<T>, account: T::AccountId, block: BlockNumberFor<T>, ) -> DispatchResult

Permissionlessly release a deposit for an account that entered safe-mode at a given historical block.

The call can be completely disabled by setting Config::ReleaseDelay to None. This cannot be called while safe-mode is entered and not until Config::ReleaseDelay blocks have passed since safe-mode was entered.

Emits a Event::DepositReleased event on success. Errors with Error::Entered if the safe-mode is entered. Errors with Error::CannotReleaseYet if Config::ReleaseDelay block have not passed since safe-mode was entered. Errors with Error::NoDeposit if the payee has no reserved currency at the block specified.

pub fn force_release_deposit( origin: OriginFor<T>, account: T::AccountId, block: BlockNumberFor<T>, ) -> DispatchResult

Force to release a deposit for an account that entered safe-mode at a given historical block.

This can be called while safe-mode is still entered.

Emits a Event::DepositReleased event on success. Errors with Error::Entered if safe-mode is entered. Errors with Error::NoDeposit if the payee has no reserved currency at the specified block.

Can only be called by the Config::ForceDepositOrigin origin.

impl<T: Config> Pallet<T>

pub fn is_entered() -> bool

Return whether safe-mode is entered.

pub fn is_allowed(call: &T::RuntimeCall) -> bool

where T::RuntimeCall: GetCallMetadata,

Return whether the given call is allowed to be dispatched.

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, T::Currency: Mutate<T::AccountId>,

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: Config> Contains<<T as Config>::RuntimeCall> for Pallet<T>

where T::RuntimeCall: GetCallMetadata,

fn contains(call: &T::RuntimeCall) -> bool

Return whether the given call is allowed to be dispatched.

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(current: BlockNumberFor<T>) -> Weight

Automatically exits safe-mode when the current block number is greater than EnteredUntil.

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

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

Block number type.

fn is_entered() -> bool

Whether safe mode is entered.

fn remaining() -> Option<BlockNumberFor<T>>

How many more blocks safe mode will stay entered.

fn enter(duration: BlockNumberFor<T>) -> Result<(), SafeModeError>

Enter safe mode for duration blocks.

fn extend(duration: BlockNumberFor<T>) -> Result<(), SafeModeError>

Extend safe mode for duration blocks.

fn exit() -> Result<(), SafeModeError>

Exit safe mode immediately.

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>