pub enum BalancesCall<T, I = ()>where
    T: Config<I>,
    I: 'static,{
    transfer {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: <T as Config<I>>::Balance,
    },
    set_balance {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        new_free: <T as Config<I>>::Balance,
        new_reserved: <T as Config<I>>::Balance,
    },
    force_transfer {
        source: <<T as Config>::Lookup as StaticLookup>::Source,
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: <T as Config<I>>::Balance,
    },
    transfer_keep_alive {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: <T as Config<I>>::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 as Config<I>>::Balance,
    },
    // some variants omitted
}
Expand description

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 as Config<I>>::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 as Config<I>>::Balance
§new_reserved: <T as Config<I>>::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 as Config<I>>::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 as Config<I>>::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 as Config<I>>::Balance

Unreserve some balance from a user by force.

Can only be called by ROOT.

Implementations§

§

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

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

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 as Config<I>>::Balance, new_reserved: <T as Config<I>>::Balance ) -> Call<T, I>

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 as Config<I>>::Balance ) -> Call<T, I>

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 as Config<I>>::Balance ) -> Call<T, I>

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 ) -> Call<T, I>

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 as Config<I>>::Balance ) -> Call<T, I>

Create a call with the variant force_unreserve.

Trait Implementations§

§

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

§

fn clone(&self) -> Call<T, I>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

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

§

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Call<T, I>, Error>where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.
§

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory. Read more
§

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

Attempt to skip the encoded value from input. Read more
§

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more
§

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

§

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding. Read more
§

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

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

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. Read more
§

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

§

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, I> GetDispatchInfo for Call<T, I>where T: Config<I>, I: 'static,

§

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch. Read more
§

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

§

fn eq(&self, other: &Call<T, I>) -> bool

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

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

§

type Identity = Call<T, I>

The type identifying for which type info is provided. Read more
§

fn type_info() -> Type<MetaForm>

Returns the static type identifier for Self.
§

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

§

type Origin = <T as Config>::Origin

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

fn dispatch_bypass_filter( self, origin: <Call<T, I> as UnfilteredDispatchable>::Origin ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

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

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

§

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

Auto Trait Implementations§

§

impl<T, I> RefUnwindSafe for Call<T, I>where I: RefUnwindSafe, T: RefUnwindSafe, <T as Config<I>>::Balance: RefUnwindSafe, <<T as Config>::Lookup as StaticLookup>::Source: RefUnwindSafe,

§

impl<T, I> Send for Call<T, I>where I: Send, T: Send, <<T as Config>::Lookup as StaticLookup>::Source: Send,

§

impl<T, I> Sync for Call<T, I>where I: Sync, T: Sync, <<T as Config>::Lookup as StaticLookup>::Source: Sync,

§

impl<T, I> Unpin for Call<T, I>where I: Unpin, T: Unpin, <T as Config<I>>::Balance: Unpin, <<T as Config>::Lookup as StaticLookup>::Source: Unpin,

§

impl<T, I> UnwindSafe for Call<T, I>where I: UnwindSafe, T: UnwindSafe, <T as Config<I>>::Balance: UnwindSafe, <<T as Config>::Lookup as StaticLookup>::Source: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CanUpdate<()> for T

source§

fn can_add(&self, _entity: &()) -> bool

Checks whether the new entity can be added.
source§

fn can_remove(&self, _entity: &()) -> bool

Checks whether the existing entity can be removed.
source§

fn can_replace(&self, _new: &(), _entity: &()) -> bool

Checks whether the provided entity can replace the existing one.
§

impl<T> CheckedConversion for T

§

fn checked_from<T>(t: T) -> Option<Self>where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
§

fn checked_into<T>(self) -> Option<T>where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
§

impl<T> DecodeAll for Twhere T: Decode,

§

fn decode_all(input: &mut &[u8]) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more
§

impl<T> DecodeLimit for Twhere T: Decode,

§

fn decode_all_with_depth_limit(limit: u32, input: &mut &[u8]) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more
§

fn decode_with_depth_limit<I>(limit: u32, input: &mut I) -> Result<T, Error>where I: Input,

Decode Self with the given maximum recursion depth and advance input by the number of bytes consumed. Read more
§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FullLeaf for Twhere T: Encode + Decode + Clone + PartialEq<T> + Debug,

§

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

Encode the leaf either in its full or compact form. Read more
§

impl<T> Hashable for Twhere T: Codec,

§

fn blake2_128(&self) -> [u8; 16]

§

fn blake2_256(&self) -> [u8; 32]

§

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

§

fn twox_128(&self) -> [u8; 16]

§

fn twox_256(&self) -> [u8; 32]

§

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

§

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

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IsType<T> for T

§

fn from_ref(t: &T) -> &T

Cast reference.
§

fn into_ref(&self) -> &T

Cast reference.
§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.
§

fn into_mut(&mut self) -> &mut T

Cast mutable reference.
§

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> KeyedVec for Twhere T: Codec,

§

fn to_keyed_vec(&self, prepend_key: &[u8]) -> Vec<u8, Global>

Return an encoding of Self prepended by given slice.
§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<T> SaturatedConversion for T

§

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
§

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
§

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<S> Codec for Swhere S: Decode + Encode,

§

impl<T> EncodeLike<&&T> for Twhere T: Encode,

§

impl<T> EncodeLike<&T> for Twhere T: Encode,

§

impl<T> EncodeLike<&mut T> for Twhere T: Encode,

§

impl<T> EncodeLike<Arc<T>> for Twhere T: Encode,

§

impl<T> EncodeLike<Box<T, Global>> for Twhere T: Encode,

§

impl<'a, T> EncodeLike<Cow<'a, T>> for Twhere T: ToOwned + Encode,

§

impl<T> EncodeLike<Rc<T>> for Twhere T: Encode,

§

impl<S> FullCodec for Swhere S: Decode + FullEncode,

§

impl<S> FullEncode for Swhere S: Encode + EncodeLike<S>,

§

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeDebug for Twhere T: Debug,

§

impl<T> MaybeDebug for Twhere T: Debug,

§

impl<T> MaybeRefUnwindSafe for Twhere T: RefUnwindSafe,

§

impl<T> Member for Twhere T: Send + Sync + Debug + Eq + PartialEq<T> + Clone + 'static,

§

impl<T> Parameter for Twhere T: Codec + EncodeLike<T> + Clone + Eq + Debug + TypeInfo,

§

impl<T> StaticTypeInfo for Twhere T: TypeInfo + 'static,