Enum pallet_balances::pallet::Call

pub enum Call<T: Config<I>, I: 'static = ()> {
    transfer {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: T::Balance,
    },
    set_balance {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        new_free: T::Balance,
        new_reserved: T::Balance,
    },
    force_transfer {
        source: <<T as Config>::Lookup as StaticLookup>::Source,
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: T::Balance,
    },
    transfer_keep_alive {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: T::Balance,
    },
    transfer_all {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        keep_alive: bool,
    },
    force_unreserve {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        amount: T::Balance,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

transfer

Fields

dest: <<T as Config>::Lookup as StaticLookup>::Source

value: T::Balance

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.

set_balance

Fields

who: <<T as Config>::Lookup as StaticLookup>::Source

new_free: T::Balance

new_reserved: T::Balance

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.

force_transfer

Fields

source: <<T as Config>::Lookup as StaticLookup>::Source

dest: <<T as Config>::Lookup as StaticLookup>::Source

value: T::Balance

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.

transfer_keep_alive

Fields

dest: <<T as Config>::Lookup as StaticLookup>::Source

value: T::Balance

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.

transfer_all

Fields

dest: <<T as Config>::Lookup as StaticLookup>::Source

keep_alive: bool

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. #

force_unreserve

Fields

who: <<T as Config>::Lookup as StaticLookup>::Source

amount: T::Balance

Unreserve some balance from a user by force.

Can only be called by ROOT.

Implementations

impl<T: Config<I>, I: 'static> Call<T, I>

pub fn new_call_variant_transfer(
    dest: <<T as Config>::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> Self

Create a call with the variant transfer.

pub fn new_call_variant_set_balance(
    who: <<T as Config>::Lookup as StaticLookup>::Source,
    new_free: T::Balance,
    new_reserved: T::Balance
) -> Self

Create a call with the variant set_balance.

pub fn new_call_variant_force_transfer(
    source: <<T as Config>::Lookup as StaticLookup>::Source,
    dest: <<T as Config>::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> Self

Create a call with the variant force_transfer.

pub fn new_call_variant_transfer_keep_alive(
    dest: <<T as Config>::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> Self

Create a call with the variant transfer_keep_alive.

pub fn new_call_variant_transfer_all(
    dest: <<T as Config>::Lookup as StaticLookup>::Source,
    keep_alive: bool
) -> Self

Create a call with the variant transfer_all.

pub fn new_call_variant_force_unreserve(
    who: <<T as Config>::Lookup as StaticLookup>::Source,
    amount: T::Balance
) -> Self

Create a call with the variant force_unreserve.

Trait Implementations

impl<T: Config<I>, I: 'static> Clone for Call<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config<I>, I: 'static> Debug for Call<T, I>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for Call<T, I>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config<I>, I: 'static> Encode for Call<T, I>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> GetCallName for Call<T, I>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config<I>, I: 'static> GetDispatchInfo for Call<T, I>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config<I>, I: 'static> PartialEq<Call<T, I>> for Call<T, I>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, I> TypeInfo for Call<T, I>where
    PhantomData<(T, I)>: TypeInfo + 'static,
    <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    T::Balance: HasCompact + TypeInfo + 'static,
    T: Config<I> + 'static,
    I: 'static,

type Identity = Call<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> UnfilteredDispatchable for Call<T, I>

type Origin = <T as Config>::Origin

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config<I>, I: 'static> EncodeLike<Call<T, I>> for Call<T, I>

impl<T: Config<I>, I: 'static> Eq for Call<T, I>