Enum orml_tokens::module::Call

pub enum Call<T: Config> {
    transfer {
        dest: <T::Lookup as StaticLookup>::Source,
        currency_id: T::CurrencyId,
        amount: T::Balance,
    },
    transfer_all {
        dest: <T::Lookup as StaticLookup>::Source,
        currency_id: T::CurrencyId,
        keep_alive: bool,
    },
    transfer_keep_alive {
        dest: <T::Lookup as StaticLookup>::Source,
        currency_id: T::CurrencyId,
        amount: T::Balance,
    },
    force_transfer {
        source: <T::Lookup as StaticLookup>::Source,
        dest: <T::Lookup as StaticLookup>::Source,
        currency_id: T::CurrencyId,
        amount: T::Balance,
    },
    set_balance {
        who: <T::Lookup as StaticLookup>::Source,
        currency_id: T::CurrencyId,
        new_free: T::Balance,
        new_reserved: T::Balance,
    },
    // some variants omitted
}

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

Variants

transfer

Fields

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

currency_id: T::CurrencyId

amount: T::Balance

Transfer some liquid free balance to another account.

transfer will set the FreeBalance of the sender and receiver. It will decrease the total issuance of the system by the TransferFee. 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.

• dest: The recipient of the transfer.
• currency_id: currency type.
• amount: free balance amount to tranfer.

transfer_all

Fields

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

currency_id: T::CurrencyId

keep_alive: bool

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

transfer_keep_alive

Fields

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

currency_id: T::CurrencyId

amount: 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.

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

• dest: The recipient of the transfer.
• currency_id: currency type.
• amount: free balance amount to tranfer.

force_transfer

Fields

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

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

currency_id: T::CurrencyId

amount: T::Balance

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

The dispatch origin for this call must be Root.

• source: The sender of the transfer.
• dest: The recipient of the transfer.
• currency_id: currency type.
• amount: free balance amount to tranfer.

set_balance

Fields

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

currency_id: T::CurrencyId

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 decrease the total issuance of the system (TotalIssuance). If the new free or reserved balance is below the existential deposit, it will reap the AccountInfo.

The dispatch origin for this call is root.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_transfer(
    dest: <T::Lookup as StaticLookup>::Source,
    currency_id: T::CurrencyId,
    amount: T::Balance
) -> Self

Create a call with the variant transfer.

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

Create a call with the variant transfer_all.

pub fn new_call_variant_transfer_keep_alive(
    dest: <T::Lookup as StaticLookup>::Source,
    currency_id: T::CurrencyId,
    amount: T::Balance
) -> Self

Create a call with the variant transfer_keep_alive.

pub fn new_call_variant_force_transfer(
    source: <T::Lookup as StaticLookup>::Source,
    dest: <T::Lookup as StaticLookup>::Source,
    currency_id: T::CurrencyId,
    amount: T::Balance
) -> Self

Create a call with the variant force_transfer.

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

Create a call with the variant set_balance.

Trait Implementations

impl<T: Config> Clone for Call<T>

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> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

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> Encode for Call<T>

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> GetCallName for Call<T>

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> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<T>

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> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    <T::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    T::CurrencyId: TypeInfo + 'static,
    T::Balance: HasCompact,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

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> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>