Type Alias Module Copy item path

impl<T: Config> Pallet<T>

pub fn recovery_config<KArg>( k: KArg, ) -> Option<RecoveryConfig<BlockNumberFromProviderOf<T>, BalanceOf<T>, FriendsOf<T>>>
where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for Recoverable.

impl<T: Config> Pallet<T>

pub fn active_recovery<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> Option<ActiveRecovery<BlockNumberFromProviderOf<T>, BalanceOf<T>, FriendsOf<T>>>
where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<T::AccountId>,

An auto-generated getter for ActiveRecoveries.

impl<T: Config> Pallet<T>

pub fn proxy<KArg>(k: KArg) -> Option<T::AccountId>
where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for Proxy.

impl<T: Config> Pallet<T>

pub fn as_recovered( origin: OriginFor<T>, account: AccountIdLookupOf<T>, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResult

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.

pub fn set_recovered( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, rescuer: AccountIdLookupOf<T>, ) -> DispatchResult

Allow ROOT to bypass the recovery process and set 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.

pub fn create_recovery( origin: OriginFor<T>, friends: Vec<T::AccountId>, threshold: u16, delay_period: BlockNumberFromProviderOf<T>, ) -> DispatchResult

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.

pub fn initiate_recovery( origin: OriginFor<T>, account: AccountIdLookupOf<T>, ) -> DispatchResult

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

pub fn vouch_recovery( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, rescuer: AccountIdLookupOf<T>, ) -> DispatchResult

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.

pub fn claim_recovery( origin: OriginFor<T>, account: AccountIdLookupOf<T>, ) -> DispatchResult

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.

pub fn close_recovery( origin: OriginFor<T>, rescuer: AccountIdLookupOf<T>, ) -> DispatchResult

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.

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

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

pub fn cancel_recovered( origin: OriginFor<T>, account: AccountIdLookupOf<T>, ) -> DispatchResult

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.

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,

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”. Read more

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.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

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

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

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

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]). Read more

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet. Read more

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block. Read more

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade. Read more

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade. Read more

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

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced). Read more

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.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

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

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

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

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

1.0.0 · Source§

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.

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.