Enum pallet_balances::pallet::Call

pub enum Call<T: Config<I>, I: 'static = ()> {
    transfer_allow_death {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: 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,
    },
    upgrade_accounts {
        who: Vec<T::AccountId>,
    },
    force_set_balance {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        new_free: T::Balance,
    },
    force_adjust_total_issuance {
        direction: AdjustmentDirection,
        delta: T::Balance,
    },
    burn {
        value: T::Balance,
        keep_alive: bool,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

transfer_allow_death

Fields

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

value: T::Balance

Transfer some liquid free balance to another account.

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

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_allow_death, except the origin must be root and the source account may be specified.

transfer_keep_alive

Fields

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

value: T::Balance

Same as the transfer_allow_death call, but with a check that the transfer will not kill the origin account.

99% of the time you want transfer_allow_death 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).

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.

upgrade_accounts

Fields

who: Vec<T::AccountId>

Upgrade a specified account.

• origin: Must be Signed.
• who: The account to be upgraded.

This will waive the transaction fee if at least all but 10% of the accounts needed to be upgraded. (We let some not have to be upgraded just in order to allow for the possibility of churn).

force_set_balance

Fields

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

new_free: T::Balance

Set the regular balance of a given account.

The dispatch origin for this call is root.

force_adjust_total_issuance

Fields

direction: AdjustmentDirection

delta: T::Balance

Adjust the total issuance in a saturating way.

Can only be called by root and always needs a positive delta.

Example

#[test]
fn force_adjust_total_issuance_example() {
	ExtBuilder::default().build_and_execute_with(|| {
		// First we set the TotalIssuance to 64 by giving Alice a balance of 64.
		assert_ok!(Balances::force_set_balance(RuntimeOrigin::root(), ALICE, 64));
		let old_ti = Balances::total_issuance();
		assert_eq!(old_ti, 64, "TI should be 64");

		// Now test the increase:
		assert_ok!(Balances::force_adjust_total_issuance(RawOrigin::Root.into(), Inc, 32));
		let new_ti = Balances::total_issuance();
		assert_eq!(old_ti + 32, new_ti, "Should increase by 32");

		// If Alice tries to call it, it errors:
		assert_noop!(
			Balances::force_adjust_total_issuance(RawOrigin::Signed(ALICE).into(), Inc, 32),
			BadOrigin,
		);
	});
}

burn

Fields

value: T::Balance

keep_alive: bool

Burn the specified liquid free balance from the origin account.

If the origin’s account ends up below the existential deposit as a result of the burn and keep_alive is false, the account will be reaped.

Unlike sending funds to a burn address, which merely makes the funds inaccessible, this burn operation will reduce total issuance by the amount burned.

Implementations

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

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

Create a call with the variant transfer_allow_death.

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.

pub fn new_call_variant_upgrade_accounts(who: Vec<T::AccountId>) -> Self

Create a call with the variant upgrade_accounts.

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

Create a call with the variant force_set_balance.

pub fn new_call_variant_force_adjust_total_issuance( direction: AdjustmentDirection, delta: T::Balance ) -> Self

Create a call with the variant force_adjust_total_issuance.

pub fn new_call_variant_burn(value: T::Balance, keep_alive: bool) -> Self

Create a call with the variant burn.

Trait Implementations

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

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

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

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 size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where 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> GetCallIndex for Call<T, I>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

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 in the same order as [GetCallIndex].

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 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, Vec<T::AccountId>: 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 RuntimeOrigin = <T as Config>::RuntimeOrigin

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

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

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

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

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