Struct parachain_gen::parachain_runtime::balances::calls::TransactionApi

pub struct TransactionApi;

Implementations

impl TransactionApi

pub fn transfer( &self, dest: MultiAddress<AccountId32, ()>, value: u128 ) -> StaticTxPayload<Transfer>

Transfer some liquid free balance to another account.

transfer will set the FreeBalance of the sender and receiver. If the sender’s account is below the existential deposit as a result of the transfer, the account will be reaped.

The dispatch origin for this call must be Signed by the transactor.

• Dependent on arguments but not critical, given proper implementations for input config types. See related functions below.
• It contains a limited number of reads and writes internally and no complex computation.

Related functions:

• ensure_can_withdraw is always called internally but has a bounded complexity.
• Transferring balances to accounts that did not exist before will cause T::OnNewAccount::on_new_account to be called.
• Removing enough funds from an account will trigger T::DustRemoval::on_unbalanced.
• transfer_keep_alive works the same way as transfer, but has an additional check that the transfer will not kill the origin account.

---

• Origin account is already in memory, so no DB operations for them.

pub fn set_balance( &self, who: MultiAddress<AccountId32, ()>, new_free: u128, new_reserved: u128 ) -> StaticTxPayload<SetBalance>

Set the balances of a given account.

This will alter FreeBalance and ReservedBalance in storage. it will also alter the total issuance of the system (TotalIssuance) appropriately. If the new free or reserved balance is below the existential deposit, it will reset the account nonce (frame_system::AccountNonce).

The dispatch origin for this call is root.

pub fn force_transfer( &self, source: MultiAddress<AccountId32, ()>, dest: MultiAddress<AccountId32, ()>, value: u128 ) -> StaticTxPayload<ForceTransfer>

Exactly as transfer, except the origin must be root and the source account may be specified.

• Same as transfer, but additional read and write because the source account is not assumed to be in the overlay.

pub fn transfer_keep_alive( &self, dest: MultiAddress<AccountId32, ()>, value: u128 ) -> StaticTxPayload<TransferKeepAlive>

Same as the transfer call, but with a check that the transfer will not kill the origin account.

99% of the time you want transfer instead.

pub fn transfer_all( &self, dest: MultiAddress<AccountId32, ()>, keep_alive: bool ) -> StaticTxPayload<TransferAll>

Transfer the entire transferable balance from the caller account.

NOTE: This function only attempts to transfer transferable balances. This means that any locked, reserved, or existential deposits (when keep_alive is true), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc…

The dispatch origin of this call must be Signed.

• dest: The recipient of the transfer.
• keep_alive: A boolean to determine if the transfer_all operation should send all of the funds the account has, causing the sender account to be killed (false), or transfer everything except at least the existential deposit, which will guarantee to keep the sender account alive (true). #
• O(1). Just like transfer, but reading the user’s transferable balance first. #

pub fn force_unreserve( &self, who: MultiAddress<AccountId32, ()>, amount: u128 ) -> StaticTxPayload<ForceUnreserve>

Unreserve some balance from a user by force.

Can only be called by ROOT.