Enum Call

pub enum Call<T: Config> {
    as_multi_threshold_1 {
        other_signatories: Vec<T::AccountId>,
        call: Box<<T as Config>::RuntimeCall>,
    },
    as_multi {
        threshold: u16,
        other_signatories: Vec<T::AccountId>,
        maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>,
        call: Box<<T as Config>::RuntimeCall>,
        max_weight: Weight,
    },
    approve_as_multi {
        threshold: u16,
        other_signatories: Vec<T::AccountId>,
        maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>,
        call_hash: [u8; 32],
        max_weight: Weight,
    },
    cancel_as_multi {
        threshold: u16,
        other_signatories: Vec<T::AccountId>,
        timepoint: Timepoint<BlockNumberFor<T>>,
        call_hash: [u8; 32],
    },
    poke_deposit {
        threshold: u16,
        other_signatories: Vec<T::AccountId>,
        call_hash: [u8; 32],
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

as_multi_threshold_1

Immediately dispatch a multi-signature call using a single approval from the caller.

The dispatch origin for this call must be Signed.

• other_signatories: The accounts (other than the sender) who are part of the multi-signature, but do not participate in the approval process.
• call: The call to be executed.

Result is equivalent to the dispatched result.

Complexity

O(Z + C) where Z is the length of the call and C its execution weight.

Fields

other_signatories: Vec<T::AccountId>

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

as_multi

Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

If there are enough, then dispatch the call.

Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

The dispatch origin for this call must be Signed.

• threshold: The total number of approvals for this dispatch before it is executed.
• other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
• maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.
• call: The call to be executed.

NOTE: Unless this is the final approval, you will generally want to use approve_as_multi instead, since it only requires a hash of the call.

Result is equivalent to the dispatched result if threshold is exactly 1. Otherwise on success, result is Ok and the result from the interior call, if it was executed, may be found in the deposited MultisigExecuted event.

Complexity

• O(S + Z + Call).
• Up to one balance-reserve or unreserve operation.
• One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
• One call encode & hash, both of complexity O(Z) where Z is tx-len.
• One encode & hash, both of complexity O(S).
• Up to one binary search and insert (O(logS + S)).
• I/O: 1 read O(S), up to 1 mutate O(S). Up to one remove.
• One event.
• The weight of the call.
• Storage: inserts one item, value size bounded by MaxSignatories, with a deposit taken for its lifetime of DepositBase + threshold * DepositFactor.

Fields

threshold: u16

other_signatories: Vec<T::AccountId>

maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>

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

max_weight: Weight

approve_as_multi

Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

The dispatch origin for this call must be Signed.

• threshold: The total number of approvals for this dispatch before it is executed.
• other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
• maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.
• call_hash: The hash of the call to be executed.

NOTE: If this is the final approval, you will want to use as_multi instead.

Complexity

• O(S).
• Up to one balance-reserve or unreserve operation.
• One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
• One encode & hash, both of complexity O(S).
• Up to one binary search and insert (O(logS + S)).
• I/O: 1 read O(S), up to 1 mutate O(S). Up to one remove.
• One event.
• Storage: inserts one item, value size bounded by MaxSignatories, with a deposit taken for its lifetime of DepositBase + threshold * DepositFactor.

Fields

threshold: u16

other_signatories: Vec<T::AccountId>

maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>

call_hash: [u8; 32]

max_weight: Weight

cancel_as_multi

Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously for this operation will be unreserved on success.

The dispatch origin for this call must be Signed.

• threshold: The total number of approvals for this dispatch before it is executed.
• other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
• timepoint: The timepoint (block number and transaction index) of the first approval transaction for this dispatch.
• call_hash: The hash of the call to be executed.

Complexity

• O(S).
• Up to one balance-reserve or unreserve operation.
• One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
• One encode & hash, both of complexity O(S).
• One event.
• I/O: 1 read O(S), one remove.
• Storage: removes one item.

Fields

threshold: u16

other_signatories: Vec<T::AccountId>

timepoint: Timepoint<BlockNumberFor<T>>

call_hash: [u8; 32]

poke_deposit

Poke the deposit reserved for an existing multisig operation.

The dispatch origin for this call must be Signed and must be the original depositor of the multisig operation.

The transaction fee is waived if the deposit amount has changed.

• threshold: The total number of approvals needed for this multisig.
• other_signatories: The accounts (other than the sender) who are part of the multisig.
• call_hash: The hash of the call this deposit is reserved for.

Emits DepositPoked if successful.

Fields

threshold: u16

other_signatories: Vec<T::AccountId>

call_hash: [u8; 32]

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_as_multi_threshold_1( other_signatories: Vec<T::AccountId>, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant as_multi_threshold_1.

pub fn new_call_variant_as_multi( threshold: u16, other_signatories: Vec<T::AccountId>, maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>, call: Box<<T as Config>::RuntimeCall>, max_weight: Weight, ) -> Self

Create a call with the variant as_multi.

pub fn new_call_variant_approve_as_multi( threshold: u16, other_signatories: Vec<T::AccountId>, maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>, call_hash: [u8; 32], max_weight: Weight, ) -> Self

Create a call with the variant approve_as_multi.

pub fn new_call_variant_cancel_as_multi( threshold: u16, other_signatories: Vec<T::AccountId>, timepoint: Timepoint<BlockNumberFor<T>>, call_hash: [u8; 32], ) -> Self

Create a call with the variant cancel_as_multi.

pub fn new_call_variant_poke_deposit( threshold: u16, other_signatories: Vec<T::AccountId>, call_hash: [u8; 32], ) -> Self

Create a call with the variant poke_deposit.

Trait Implementations

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::AccountId>: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, Option<Timepoint<BlockNumberFor<T>>>: TypeInfo + 'static, Timepoint<BlockNumberFor<T>>: 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::AccountId>: DecodeWithMemTracking, Box<<T as Config>::RuntimeCall>: DecodeWithMemTracking, Option<Timepoint<BlockNumberFor<T>>>: DecodeWithMemTracking, Timepoint<BlockNumberFor<T>>: DecodeWithMemTracking,

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

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