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 provided_block_number() -> ProvidedBlockNumberOf<T>

The provided block number that will be used to measure time.

pub fn friend_groups(lost: T::AccountId) -> Vec<FriendGroupOf<T>>

The friend groups of an account that can initiate recovery attempts.

pub fn attempts(lost: T::AccountId) -> Vec<(FriendGroupOf<T>, AttemptOf<T>)>

Ongoing recovery attempts for a lost account.

pub fn inheritor(lost: T::AccountId) -> Option<T::AccountId>

The account that inherited full access to the lost account.

pub fn inheritance(heir: T::AccountId) -> Vec<T::AccountId>

All the recovered accounts that heir inherited access to.

impl<T: Config> Pallet<T>

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

Allows the inheritor of a recovered account to control it.

The controller is not allowed to dispatch calls of the recovery pallet. Otherwise they could mess with the recovery configuration and possibly cancel or slash attempts from higher-priority friend groups.

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

Revoke the inheritor of the calling (lost) account.

This removes the inheritor entry and refunds the inheritor deposit. Can only be called by the lost account itself after it regains access.

pub fn set_friend_groups( origin: OriginFor<T>, friend_groups: Vec<FriendGroupOf<T>>, ) -> DispatchResult

Set the friend groups of the calling account before it lost access.

Cannot be used while there are ongoing recovery attempts. The friends of each group MUST be sorted and unique. Trying to insert two friend groups with the same set of friends will result in an error.

A FriendGroupsChanged event is emitted only when the new friends groups differed from the old ones.

pub fn initiate_attempt( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, friend_group_index: FriendGroupIndex, ) -> DispatchResult

Attempt to recover a lost account by a friend within the given friend group.

The initiator’s approval is recorded automatically, so they do not need to call approve_attempt themselves.

Once an account has been recovered by a friend group, no friend group of equal or lower priority can open a new attempt: it will fail with Error::HigherPriorityRecovered. Only a strictly higher-priority group (lower numerical FriendGroup::inheritance_priority) can take over the inheritor.

pub fn approve_attempt( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, friend_group_index: FriendGroupIndex, ) -> DispatchResult

Approve the recovery for a lost account.

Must be called by a friend of the friend group that the recovery attempt belongs to that did not yet vote. Voting is only allowed until the threshold is reached. finish_attempt should be called after the last friend voted.

pub fn finish_attempt( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, friend_group_index: FriendGroupIndex, ) -> DispatchResult

Finish a recovery attempt and make the lost account accessible from the inheritor.

Can be called by anyone who is willing to pay for the inheritor deposit.

pub fn cancel_attempt( origin: OriginFor<T>, lost: AccountIdLookupOf<T>, friend_group_index: FriendGroupIndex, ) -> DispatchResult

The lost account can cancel an attempt at any moment; the initiator, only after a delay.

This will release the security deposit back to the initiator. The cancel delay must be respected if the initiator calls it to prevent it from front-running the lost account from slashing the attempt.

pub fn slash_attempt( origin: OriginFor<T>, friend_group_index: FriendGroupIndex, ) -> DispatchResult

Slash a malicious recovery attempt and burn the security deposit of the initiator.

impl<T: Config> Pallet<T>

pub fn friend_group_footprint(friend_groups: &FriendGroupsOf<T>) -> Footprint

pub fn attempt_footprint() -> Footprint

pub fn inheritor_footprint() -> Footprint

pub fn inheritor_ticket( who: &T::AccountId, ) -> Result<InheritorTicketOf<T>, DispatchError>

pub fn friend_group_of( lost: &T::AccountId, friend_group_index: FriendGroupIndex, ) -> Result<FriendGroupOf<T>, Error<T>>

pub fn attempt_of( lost: &T::AccountId, friend_group_index: FriendGroupIndex, ) -> Result<(AttemptOf<T>, AttemptTicketOf<T>, SecurityDepositOf<T>), Error<T>>

pub fn bound_friend_groups( lost: &T::AccountId, friend_groups: Vec<FriendGroupOf<T>>, ) -> Result<FriendGroupsOf<T>, Error<T>>

Sanity check the friend groups and bound them into a bounded vector.

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,

Available on crate features runtime-benchmarks only.

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 duplicate of the value.

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

Performs copy-assignment from source.

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

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 integrity_test()

Check the integrity of this pallet’s configuration.

fn on_initialize(_n: BlockNumber) -> Weight

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

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.

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