Function orml_tokens::module::dispatchables::transfer_all
source · pub fn transfer_all<T: Config>(
dest: <T::Lookup as StaticLookup>::Source,
currency_id: T::CurrencyId,
keep_alive: bool
)
Expand description
Transfer all remaining balance to the given 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 for this call must be Signed
by the
transactor.
dest
: The recipient of the transfer.currency_id
: currency type.keep_alive
: A boolean to determine if thetransfer_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).
§Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::transfer_all
.