Crates.io | pallet-recovery |
lib.rs | pallet-recovery |
version | 35.0.0 |
source | src |
created_at | 2020-02-27 23:23:04.914722 |
updated_at | 2024-07-12 22:06:50.378088 |
description | FRAME account recovery pallet (polkadot v1.14.0) |
homepage | https://substrate.io |
repository | https://github.com/paritytech/polkadot-sdk.git |
max_upload_size | |
id | 213385 |
size | 87,680 |
The Recovery pallet is an M-of-N social recovery tool for users to gain access to their accounts if the private key or other authentication mechanism is lost. Through this pallet, a user is able to make calls on-behalf-of another account which they have recovered. The recovery process is protected by trusted "friends" whom the original account owner chooses. A threshold (M) out of N friends are needed to give another account access to the recoverable account.
The recovery process for each recoverable account can be configured by the account owner. They are able to choose:
friends
- The list of friends that the account owner trusts to protect the
recovery process for their account.threshold
- The number of friends that need to approve a recovery process for
the account to be successfully recovered.delay_period
- The minimum number of blocks after the beginning of the recovery
process that need to pass before the account can be successfully recovered.There is a configurable deposit that all users need to pay to create a recovery configuration. This deposit is composed of a base deposit plus a multiplier for the number of friends chosen. This deposit is returned in full when the account owner removes their recovery configuration.
The intended life cycle of a successful recovery takes the following steps:
create_recovery
to set up a recovery configuration
for their account.initiate_recovery
.vouch_recovery
with those
parameters.claim_recovery
, which subsequently
allows them to call as_recovered
and directly make calls on-behalf-of the lost
account.close_recovery
on the recovery process they opened, reclaiming the recovery deposit they
placed.remove_recovery
to remove the recovery
configuration on the recovered account and reclaim the recovery configuration
deposit they placed.as_recovered
, the account owner is able to call any other pallets
to clean up their state and reclaim any reserved or locked funds. They
can then transfer all funds from the recovered account to the new account.Initializing a the recovery process for a recoverable account is open and permissionless. However, the recovery deposit is an economic deterrent that should disincentivize would-be attackers from trying to maliciously recover accounts.
The recovery deposit can always be claimed by the account which is trying to to be recovered. In the case of a malicious recovery attempt, the account owner who still has access to their account can claim the deposit and essentially punish the malicious user.
Furthermore, the malicious recovery attempt can only be successful if the attacker is also able to get enough friends to vouch for the recovery attempt. In the case where the account owner prevents a malicious recovery process, this pallet makes it near-zero cost to re-configure the recovery settings and remove/replace friends who are acting inappropriately.
It is important to note that this is a powerful pallet that can compromise the security of an account if used incorrectly. Some recommended practices for users of this pallet are:
delay_period
for your recovery process: As long as you
have access to your recoverable account, you need only check the blockchain once
every delay_period
blocks to ensure that no recovery attempt is successful
against your account. Using off-chain notification systems can help with this,
but ultimately, setting a large delay_period
means that even the most skilled
attacker will need to wait this long before they can access your account.create_recovery
- Create a recovery configuration for your account and make it recoverable.initiate_recovery
- Start the recovery process for a recoverable account.vouch_recovery
- As a friend
of a recoverable account, vouch for a recovery attempt on the account.claim_recovery
- Claim access to the account that you have successfully completed the recovery process for.as_recovered
- Send a transaction as an account that you have recovered. See other functions below.close_recovery
- Close an active recovery process for your account and reclaim the recovery deposit.remove_recovery
- Remove the recovery configuration from the account, making it un-recoverable.set_recovered
- The ROOT origin is able to skip the recovery process and directly allow
one account to access another.License: Apache-2.0