Calls
asRecovered
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.
cancelRecovered
Cancel the ability to useas_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.
claimRecovery
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: collectedthreshold 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.
closeRecovery
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 depositRecoveryDeposit 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.
createRecovery
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.
initiateRecovery
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).
removeRecovery
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.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).
Namespace
setRecovered
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.
vouchRecovery
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.
Storage
activeRecoveries
Active recovery attempts. First account is the account to be recovered, and the second account is the user trying to recover the account. Namespaceproxy
The list of allowed proxy accounts. Map from the user who can access it to the recovered account. Namespacerecoverable
The set of recoverable accounts and their recovery configuration. NamespaceEvents
AccountRecovered
Lost account has been successfully recovered by the rescuer account. NamespaceRecoveryClosed
A recovery process for lost account by rescuer account has been closed. NamespaceRecoveryCreated
A recovery process has been set up for an account. NamespaceRecoveryInitiated
A recovery process has been initiated for lost account by rescuer account. NamespaceRecoveryRemoved
A recovery process has been removed for an account. NamespaceRecoveryVouched
A recovery process for a lost account by rescuer account has been vouched for by the sender. NamespaceErrors
AlreadyProxy
This account is already set up for recovery NamespaceAlreadyRecoverable
This account is already set up for recovery NamespaceAlreadyStarted
A recovery process has already started for this account NamespaceAlreadyVouched
This user has already vouched for this recovery NamespaceBadState
Some internal state is broken. NamespaceDelayPeriod
The friend must wait until the delay period to vouch for this recovery NamespaceMaxFriends
Friends list must be less than max friends NamespaceNotAllowed
User is not allowed to make a call on behalf of this account NamespaceNotEnoughFriends
Friends list must be greater than zero and threshold NamespaceNotFriend
This account is not a friend who can vouch NamespaceNotRecoverable
This account is not set up for recovery NamespaceNotSorted
Friends list must be sorted and free of duplicates NamespaceNotStarted
A recovery process has not started for this rescuer NamespaceStillActive
There are still active recovery attempts that need to be closed NamespaceThreshold
The threshold for recovering this account has not been met NamespaceZeroThreshold
Threshold must be greater than zero NamespaceConstants
configDepositBase
The base amount of currency needed to reserve for creating a recovery configuration. This is held for an additional storage item whose value size is2 + sizeof(BlockNumber, Balance) bytes.
Namespace
friendDepositFactor
The amount of currency needed per additional user when creating a recovery configuration. This is held for addingsizeof(AccountId) bytes more into a pre-existing storage value.
Namespace
maxFriends
The maximum amount of friends allowed in a recovery configuration.NOTE: The threshold programmed in this Pallet uses u16, so it does not make sense to have a limit here greater than u16::MAX. But also, that is a lot more than you should probably set this value to anyway.
recoveryDeposit
The base amount of currency needed to reserve for starting a recovery. This is primarily held for deterring malicious recovery attempts, and should have a value large enough that a bad actor would choose not to place this deposit. It also acts to fund additional storage item whose value size issizeof(BlockNumber, Balance + T * AccountId) bytes. Where T is a configurable threshold.
Namespace