Struct TransactionApi 

pub struct TransactionApi;

Implementations

impl TransactionApi

pub fn as_recovered( &self, account: Account, call: Call, ) -> StaticPayload<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.

pub fn set_recovered( &self, lost: Lost, rescuer: Rescuer, ) -> StaticPayload<SetRecovered>

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( &self, friends: Friends, threshold: Threshold, delay_period: DelayPeriod, ) -> StaticPayload<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.

pub fn initiate_recovery( &self, account: Account, ) -> StaticPayload<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).

pub fn vouch_recovery( &self, lost: Lost, rescuer: Rescuer, ) -> StaticPayload<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.

The combination of these two parameters must point to an active recovery process.

pub fn claim_recovery(&self, account: Account) -> StaticPayload<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: 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(&self, rescuer: Rescuer) -> StaticPayload<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 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(&self) -> StaticPayload<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.

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( &self, account: Account, ) -> StaticPayload<CancelRecovered>

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.

pub fn poke_deposit( &self, maybe_account: MaybeAccount, ) -> StaticPayload<PokeDeposit>

Poke deposits for recovery configurations and / or active recoveries.

This can be used by accounts to possibly lower their locked amount.

The dispatch origin for this call must be Signed.

Parameters:

• maybe_account: Optional recoverable account for which you have an active recovery and want to adjust the deposit for the active recovery.

This function checks both recovery configuration deposit and active recovery deposits of the caller:

• If the caller has created a recovery configuration, checks and adjusts its deposit
• If the caller has initiated any active recoveries, and provides the account in maybe_account, checks and adjusts those deposits

If any deposit is updated, the difference will be reserved/unreserved from the caller’s account.

The transaction is made free if any deposit is updated and paid otherwise.

Emits DepositPoked if any deposit is updated. Multiple events may be emitted in case both types of deposits are updated.