referrerpolicy=no-referrer-when-downgrade

Function pallet_assets::pallet::dispatchables::transfer_all

source ·
pub fn transfer_all<T: Config<I>, I: 'static>(
    id: T::AssetIdParameter,
    dest: <<T as Config>::Lookup as StaticLookup>::Source,
    keep_alive: bool,
)
Expand description

Transfer the entire transferable balance from the caller asset account.

NOTE: This function only attempts to transfer transferable balances. This means that any held, frozen, or minimum balance (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.

  • id: The identifier of the asset for the account holding a deposit.
  • dest: The recipient of the transfer.
  • keep_alive: A boolean to determine if the transfer_all operation should send all of the funds the asset account has, causing the sender asset account to be killed (false), or transfer everything except at least the minimum balance, which will guarantee to keep the sender asset 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.