Enum pallet_balances::pallet::Call[−][src]

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

Expand description

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

Variants

transfer

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.

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.

Fields of transfer

dest: <T::Lookup as StaticLookup>::Sourcevalue: T::Balance

set_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 reset the account nonce (frame_system::AccountNonce).

The dispatch origin for this call is root.

Fields of set_balance

who: <T::Lookup as StaticLookup>::Sourcenew_free: T::Balancenew_reserved: T::Balance

force_transfer

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.

Fields of force_transfer

source: <T::Lookup as StaticLookup>::Sourcedest: <T::Lookup as StaticLookup>::Sourcevalue: T::Balance

transfer_keep_alive

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.

Fields of transfer_keep_alive

dest: <T::Lookup as StaticLookup>::Sourcevalue: T::Balance

transfer_all

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

Fields of transfer_all

dest: <T::Lookup as StaticLookup>::Sourcekeep_alive: bool

force_unreserve

Unreserve some balance from a user by force.

Can only be called by ROOT.

Fields of force_unreserve

who: <T::Lookup as StaticLookup>::Sourceamount: T::Balance

Enum pallet_balances::pallet::Call[−][src]

Variants

Fields of transfer

Fields of set_balance

Fields of force_transfer

Fields of transfer_keep_alive

Fields of transfer_all

Fields of force_unreserve

Implementations

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

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

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

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

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

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

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

Trait Implementations

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

fn clone(&self) -> Self

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

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

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

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

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

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

fn encoded_fixed_size() -> Option<usize>

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

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

fn size_hint(&self) -> usize

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

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

fn encoded_size(&self) -> usize

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

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

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

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

fn get_dispatch_info(&self) -> DispatchInfo

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

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

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

type Identity = Self

fn type_info() -> Type

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

type Origin = OriginFor<T>

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

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>

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

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

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

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> DecodeAll for T where T: Decode,

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

impl<T> DecodeLimit for T where T: Decode,

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

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

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

impl<T> Downcast for T where T: Any,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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,

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

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

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

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

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

fn conv<T>(self) -> T where
Self: Into<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

impl<T> DecodeAll for T where
T: Decode,

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

impl<T> DecodeLimit for T where
T: Decode,

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

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

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

impl<T> Downcast for T where
T: Any,

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

impl<T> DynClone for T where
T: Clone,

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

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

impl<T> Hashable for T where
T: Codec,

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

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

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

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

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

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

impl<T> KeyedVec for T where
T: Codec,

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

impl<T> Pipe for T where
T: ?Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,

fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,