Enum pallet_recovery::pallet::Call

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

Contains one variant per dispatchable that can be called by an extrinsic.

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.

• The weight of the call + 10,000.
• One storage lookup to check account is recovered by who. O(1)

Fields of as_recovered

account: T::AccountIdcall: Box<<T as Config>::Call>

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.

• One storage write O(1)
• One event

Fields of set_recovered

lost: T::AccountIdrescuer: T::AccountId

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.

• Key: F (len of friends)
• One storage read to check that account is not already recoverable. O(1).
• A check that the friends list is sorted and unique. O(F)
• One currency reserve operation. O(X)
• One storage write. O(1). Codec O(F).
• One event.

Total Complexity: O(F + X)

Fields of create_recovery

friends: Vec<T::AccountId>threshold: u16delay_period: T::BlockNumber

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).

• One storage read to check that account is recoverable. O(F)
• One storage read to check that this recovery process hasn’t already started. O(1)
• One currency reserve operation. O(X)
• One storage read to get the current block number. O(1)
• One storage write. O(1).
• One event.

Total Complexity: O(F + X)

Fields of initiate_recovery

account: T::AccountId

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.

Key: F (len of friends in config), V (len of vouching friends)

• One storage read to get the recovery configuration. O(1), Codec O(F)
• One storage read to get the active recovery process. O(1), Codec O(V)
• One binary search to confirm caller is a friend. O(logF)
• One binary search to confirm caller has not already vouched. O(logV)
• One storage write. O(1), Codec O(V).
• One event.

Total Complexity: O(F + logF + V + logV)

Fields of vouch_recovery

lost: T::AccountIdrescuer: T::AccountId

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.

Key: F (len of friends in config), V (len of vouching friends)

• One storage read to get the recovery configuration. O(1), Codec O(F)
• One storage read to get the active recovery process. O(1), Codec O(V)
• One storage read to get the current block number. O(1)
• One storage write. O(1), Codec O(V).
• One event.

Total Complexity: O(F + V)

Fields of claim_recovery

account: T::AccountId

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.

Key: V (len of vouching friends)

• One storage read/remove to get the active recovery process. O(1), Codec O(V)
• One balance call to repatriate reserved. O(X)
• One event.

Total Complexity: O(V + X)

Fields of close_recovery

rescuer: T::AccountId

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).

Key: F (len of friends)

• One storage read to get the prefix iterator for active recoveries. O(1)
• One storage read/remove to get the recovery configuration. O(1), Codec O(F)
• One balance call to unreserved. O(X)
• One event.

Total Complexity: O(F + X)

Fields of remove_recovery

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.

• One storage mutation to check account is recovered by who. O(1)

Fields of cancel_recovered

account: T::AccountId

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_as_recovered(
    account: T::AccountId,
    call: Box<<T as Config>::Call>
) -> Self

Create a call with the variant as_recovered.

pub fn new_call_variant_set_recovered(
    lost: T::AccountId,
    rescuer: T::AccountId
) -> Self

Create a call with the variant set_recovered.

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

Create a call with the variant create_recovery.

pub fn new_call_variant_initiate_recovery(account: T::AccountId) -> Self

Create a call with the variant initiate_recovery.

pub fn new_call_variant_vouch_recovery(
    lost: T::AccountId,
    rescuer: T::AccountId
) -> Self

Create a call with the variant vouch_recovery.

pub fn new_call_variant_claim_recovery(account: T::AccountId) -> Self

Create a call with the variant claim_recovery.

pub fn new_call_variant_close_recovery(rescuer: T::AccountId) -> 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::AccountId) -> Self

Create a call with the variant cancel_recovered.

Trait Implementations

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 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 encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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

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> 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.

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<Call<T>> 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 !=.

impl<T: Config> TypeInfo for Call<T> where
    PhantomData<(T,)>: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    Box<<T as Config>::Call>: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    Vec<T::AccountId>: TypeInfo + 'static,
    T::BlockNumber: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T: Config + 'static, 

type Identity = Self

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 Origin = OriginFor<T>

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

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

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

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

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