Enum Call

pub enum Call<T: Config> {
    batch {
        calls: Vec<<T as Config>::RuntimeCall>,
    },
    as_derivative {
        index: u16,
        call: Box<<T as Config>::RuntimeCall>,
    },
    batch_all {
        calls: Vec<<T as Config>::RuntimeCall>,
    },
    dispatch_as {
        as_origin: Box<T::PalletsOrigin>,
        call: Box<<T as Config>::RuntimeCall>,
    },
    force_batch {
        calls: Vec<<T as Config>::RuntimeCall>,
    },
    with_weight {
        call: Box<<T as Config>::RuntimeCall>,
        weight: Weight,
    },
    if_else {
        main: Box<<T as Config>::RuntimeCall>,
        fallback: Box<<T as Config>::RuntimeCall>,
    },
    dispatch_as_fallible {
        as_origin: Box<T::PalletsOrigin>,
        call: Box<<T as Config>::RuntimeCall>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

batch

Send a batch of dispatch calls.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

This will return Ok in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterrupted event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompleted event is deposited.

Fields

calls: Vec<<T as Config>::RuntimeCall>

as_derivative

Send a call through an indexed pseudonym of the sender.

Filter from origin are passed along. The call will be dispatched with an origin which use the same filter as the origin of this call.

NOTE: If you need to ensure that any account-based filtering is not honored (i.e. because you expect proxy to have been used prior in the call stack and you do not want the call restrictions to apply to any sub-accounts), then use as_multi_threshold_1 in the Multisig pallet instead.

NOTE: Prior to version *12, this was called as_limited_sub.

The dispatch origin for this call must be Signed.

Fields

index: u16

call: Box<<T as Config>::RuntimeCall>

batch_all

Send a batch of dispatch calls and atomically execute them. The whole transaction will rollback and fail if any of the calls failed.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

Fields

calls: Vec<<T as Config>::RuntimeCall>

dispatch_as

Dispatches a function call with a provided origin.

The dispatch origin for this call must be Root.

Complexity

• O(1).

Fields

as_origin: Box<T::PalletsOrigin>

call: Box<<T as Config>::RuntimeCall>

force_batch

Send a batch of dispatch calls. Unlike batch, it allows errors and won’t interrupt.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

Fields

calls: Vec<<T as Config>::RuntimeCall>

with_weight

Dispatch a function call with a specified weight.

This function does not check the weight of the call, and instead allows the Root origin to specify the weight of the call.

The dispatch origin for this call must be Root.

Fields

call: Box<<T as Config>::RuntimeCall>

weight: Weight

if_else

Dispatch a fallback call in the event the main call fails to execute. May be called from any origin except None.

This function first attempts to dispatch the main call. If the main call fails, the fallback is attemted. if the fallback is successfully dispatched, the weights of both calls are accumulated and an event containing the main call error is deposited.

In the event of a fallback failure the whole call fails with the weights returned.

• main: The main call to be dispatched. This is the primary action to execute.
• fallback: The fallback call to be dispatched in case the main call fails.

Dispatch Logic

• If the origin is root, both the main and fallback calls are executed without applying any origin filters.
• If the origin is not root, the origin filter is applied to both the main and fallback calls.

Use Case

• Some use cases might involve submitting a batch type call in either main, fallback or both.

Fields

main: Box<<T as Config>::RuntimeCall>

fallback: Box<<T as Config>::RuntimeCall>

dispatch_as_fallible

Dispatches a function call with a provided origin.

Almost the same as Pallet::dispatch_as but forwards any error of the inner call.

The dispatch origin for this call must be Root.

Fields

as_origin: Box<T::PalletsOrigin>

call: Box<<T as Config>::RuntimeCall>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_batch(calls: Vec<<T as Config>::RuntimeCall>) -> Self

Create a call with the variant batch.

pub fn new_call_variant_as_derivative( index: u16, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant as_derivative.

pub fn new_call_variant_batch_all( calls: Vec<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant batch_all.

pub fn new_call_variant_dispatch_as( as_origin: Box<T::PalletsOrigin>, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant dispatch_as.

pub fn new_call_variant_force_batch( calls: Vec<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant force_batch.

pub fn new_call_variant_with_weight( call: Box<<T as Config>::RuntimeCall>, weight: Weight, ) -> Self

Create a call with the variant with_weight.

pub fn new_call_variant_if_else( main: Box<<T as Config>::RuntimeCall>, fallback: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant if_else.

pub fn new_call_variant_dispatch_as_fallible( as_origin: Box<T::PalletsOrigin>, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant dispatch_as_fallible.

Trait Implementations

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

fn authorize( &self, source: TransactionSource, ) -> Option<Result<(ValidTransaction, Weight), TransactionValidityError>>

The authorize function.

fn weight_of_authorize(&self) -> Weight

The weight of the authorization function.

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

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

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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, Vec<<T as Config>::RuntimeCall>: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, Box<T::PalletsOrigin>: TypeInfo + 'static, 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 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> DecodeWithMemTracking for Call<T>

where Vec<<T as Config>::RuntimeCall>: DecodeWithMemTracking, Box<<T as Config>::RuntimeCall>: DecodeWithMemTracking, Box<T::PalletsOrigin>: DecodeWithMemTracking,

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

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