Enum pallet_recovery::pallet::Call

pub enum Call<T: Config> {
    as_recovered {
        account: <<T as Config>::Lookup as StaticLookup>::Source,
        call: Box<<T as Config>::RuntimeCall>,
    },
    set_recovered {
        lost: <<T as Config>::Lookup as StaticLookup>::Source,
        rescuer: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    create_recovery {
        friends: Vec<T::AccountId>,
        threshold: u16,
        delay_period: BlockNumberFor<T>,
    },
    initiate_recovery {
        account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    vouch_recovery {
        lost: <<T as Config>::Lookup as StaticLookup>::Source,
        rescuer: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    claim_recovery {
        account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    close_recovery {
        rescuer: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    remove_recovery {},
    cancel_recovered {
        account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

as_recovered

Send a call through a recovered account.

The dispatch origin for this call must be Signed and registered to be able to make calls on behalf of the recovered account.

Parameters:

• account: The recovered account you want to make a call on-behalf-of.
• call: The call you want to make with the recovered account.

Fields

account: <<T as Config>::Lookup as StaticLookup>::Source

call: Box<<T as Config>::RuntimeCall>

set_recovered

Allow ROOT to bypass the recovery process and set an a rescuer account for a lost account directly.

The dispatch origin for this call must be ROOT.

Parameters:

• lost: The “lost account” to be recovered.
• rescuer: The “rescuer account” which can call as the lost account.

Fields

lost: <<T as Config>::Lookup as StaticLookup>::Source

rescuer: <<T as Config>::Lookup as StaticLookup>::Source

create_recovery

Create a recovery configuration for your account. This makes your account recoverable.

Payment: ConfigDepositBase + FriendDepositFactor * #_of_friends balance will be reserved for storing the recovery configuration. This deposit is returned in full when the user calls remove_recovery.

The dispatch origin for this call must be Signed.

Parameters:

• friends: A list of friends you trust to vouch for recovery attempts. Should be ordered and contain no duplicate values.
• threshold: The number of friends that must vouch for a recovery attempt before the account can be recovered. Should be less than or equal to the length of the list of friends.
• delay_period: The number of blocks after a recovery attempt is initialized that needs to pass before the account can be recovered.

Fields

friends: Vec<T::AccountId>

threshold: u16

delay_period: BlockNumberFor<T>

initiate_recovery

Initiate the process for recovering a recoverable account.

Payment: RecoveryDeposit balance will be reserved for initiating the recovery process. This deposit will always be repatriated to the account trying to be recovered. See close_recovery.

The dispatch origin for this call must be Signed.

Parameters:

• account: The lost account that you want to recover. This account needs to be recoverable (i.e. have a recovery configuration).

Fields

account: <<T as Config>::Lookup as StaticLookup>::Source

vouch_recovery

Allow a “friend” of a recoverable account to vouch for an active recovery process for that account.

The dispatch origin for this call must be Signed and must be a “friend” for the recoverable account.

Parameters:

• lost: The lost account that you want to recover.
• rescuer: The account trying to rescue the lost account that you want to vouch for.

The combination of these two parameters must point to an active recovery process.

Fields

lost: <<T as Config>::Lookup as StaticLookup>::Source

rescuer: <<T as Config>::Lookup as StaticLookup>::Source

claim_recovery

Allow a successful rescuer to claim their recovered account.

The dispatch origin for this call must be Signed and must be a “rescuer” who has successfully completed the account recovery process: collected threshold or more vouches, waited delay_period blocks since initiation.

Parameters:

• account: The lost account that you want to claim has been successfully recovered by you.

Fields

account: <<T as Config>::Lookup as StaticLookup>::Source

close_recovery

As the controller of a recoverable account, close an active recovery process for your account.

Payment: By calling this function, the recoverable account will receive the recovery deposit RecoveryDeposit placed by the rescuer.

The dispatch origin for this call must be Signed and must be a recoverable account with an active recovery process for it.

Parameters:

• rescuer: The account trying to rescue this recoverable account.

Fields

rescuer: <<T as Config>::Lookup as StaticLookup>::Source

remove_recovery

Remove the recovery process for your account. Recovered accounts are still accessible.

NOTE: The user must make sure to call close_recovery on all active recovery attempts before calling this function else it will fail.

Payment: By calling this function the recoverable account will unreserve their recovery configuration deposit. (ConfigDepositBase + FriendDepositFactor * #_of_friends)

The dispatch origin for this call must be Signed and must be a recoverable account (i.e. has a recovery configuration).

cancel_recovered

Cancel the ability to use as_recovered for account.

The dispatch origin for this call must be Signed and registered to be able to make calls on behalf of the recovered account.

Parameters:

• account: The recovered account you are able to call on-behalf-of.

Fields

account: <<T as Config>::Lookup as StaticLookup>::Source

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_as_recovered( account: <<T as Config>::Lookup as StaticLookup>::Source, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant as_recovered.

pub fn new_call_variant_set_recovered( lost: <<T as Config>::Lookup as StaticLookup>::Source, rescuer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant set_recovered.

pub fn new_call_variant_create_recovery( friends: Vec<T::AccountId>, threshold: u16, delay_period: BlockNumberFor<T>, ) -> Self

Create a call with the variant create_recovery.

pub fn new_call_variant_initiate_recovery( account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant initiate_recovery.

pub fn new_call_variant_vouch_recovery( lost: <<T as Config>::Lookup as StaticLookup>::Source, rescuer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant vouch_recovery.

pub fn new_call_variant_claim_recovery( account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant claim_recovery.

pub fn new_call_variant_close_recovery( rescuer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant close_recovery.

pub fn new_call_variant_remove_recovery() -> Self

Create a call with the variant remove_recovery.

pub fn new_call_variant_cancel_recovered( account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant cancel_recovered.

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 as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, Vec<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>