Enum pallet_safe_mode::pallet::Call

pub enum Call<T: Config> {
    enter {},
    force_enter {},
    extend {},
    force_extend {},
    force_exit {},
    force_slash_deposit {
        account: T::AccountId,
        block: BlockNumberFor<T>,
    },
    release_deposit {
        account: T::AccountId,
        block: BlockNumberFor<T>,
    },
    force_release_deposit {
        account: T::AccountId,
        block: BlockNumberFor<T>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

enter

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.

force_enter

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.

extend

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.

force_extend

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.

force_exit

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.

force_slash_deposit

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.

Fields

account: T::AccountId

block: BlockNumberFor<T>

release_deposit

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.

Fields

account: T::AccountId

block: BlockNumberFor<T>

force_release_deposit

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.

Fields

account: T::AccountId

block: BlockNumberFor<T>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_enter() -> Self

Create a call with the variant enter.

pub fn new_call_variant_force_enter() -> Self

Create a call with the variant force_enter.

pub fn new_call_variant_extend() -> Self

Create a call with the variant extend.

pub fn new_call_variant_force_extend() -> Self

Create a call with the variant force_extend.

pub fn new_call_variant_force_exit() -> Self

Create a call with the variant force_exit.

pub fn new_call_variant_force_slash_deposit( account: T::AccountId, block: BlockNumberFor<T>, ) -> Self

Create a call with the variant force_slash_deposit.

pub fn new_call_variant_release_deposit( account: T::AccountId, block: BlockNumberFor<T>, ) -> Self

Create a call with the variant release_deposit.

pub fn new_call_variant_force_release_deposit( account: T::AccountId, block: BlockNumberFor<T>, ) -> Self

Create a call with the variant force_release_deposit.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<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> Debug for Call<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, BlockNumberFor<T>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin, ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike for Call<T>

impl<T: Config> Eq for Call<T>