Enum pallet_proxy::pallet::Call

pub enum Call<T: Config> {
    proxy {
        real: <<T as Config>::Lookup as StaticLookup>::Source,
        force_proxy_type: Option<T::ProxyType>,
        call: Box<<T as Config>::RuntimeCall>,
    },
    add_proxy {
        delegate: <<T as Config>::Lookup as StaticLookup>::Source,
        proxy_type: T::ProxyType,
        delay: BlockNumberFor<T>,
    },
    remove_proxy {
        delegate: <<T as Config>::Lookup as StaticLookup>::Source,
        proxy_type: T::ProxyType,
        delay: BlockNumberFor<T>,
    },
    remove_proxies {},
    create_pure {
        proxy_type: T::ProxyType,
        delay: BlockNumberFor<T>,
        index: u16,
    },
    kill_pure {
        spawner: <<T as Config>::Lookup as StaticLookup>::Source,
        proxy_type: T::ProxyType,
        index: u16,
        height: BlockNumberFor<T>,
        ext_index: u32,
    },
    announce {
        real: <<T as Config>::Lookup as StaticLookup>::Source,
        call_hash: <<T as Config>::CallHasher as Hash>::Output,
    },
    remove_announcement {
        real: <<T as Config>::Lookup as StaticLookup>::Source,
        call_hash: <<T as Config>::CallHasher as Hash>::Output,
    },
    reject_announcement {
        delegate: <<T as Config>::Lookup as StaticLookup>::Source,
        call_hash: <<T as Config>::CallHasher as Hash>::Output,
    },
    proxy_announced {
        delegate: <<T as Config>::Lookup as StaticLookup>::Source,
        real: <<T as Config>::Lookup as StaticLookup>::Source,
        force_proxy_type: Option<T::ProxyType>,
        call: Box<<T as Config>::RuntimeCall>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

proxy

Dispatch the given call from an account that the sender is authorised for through add_proxy.

The dispatch origin for this call must be Signed.

Parameters:

• real: The account that the proxy will make a call on behalf of.
• force_proxy_type: Specify the exact proxy type to be used and checked for this call.
• call: The call to be made by the real account.

Fields

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

force_proxy_type: Option<T::ProxyType>

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

add_proxy

Register a proxy account for the sender that is able to make calls on its behalf.

The dispatch origin for this call must be Signed.

Parameters:

• proxy: The account that the caller would like to make a proxy.
• proxy_type: The permissions allowed for this proxy account.
• delay: The announcement period required of the initial proxy. Will generally be zero.

Fields

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

proxy_type: T::ProxyType

delay: BlockNumberFor<T>

remove_proxy

Unregister a proxy account for the sender.

The dispatch origin for this call must be Signed.

Parameters:

• proxy: The account that the caller would like to remove as a proxy.
• proxy_type: The permissions currently enabled for the removed proxy account.

Fields

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

proxy_type: T::ProxyType

delay: BlockNumberFor<T>

remove_proxies

Unregister all proxy accounts for the sender.

The dispatch origin for this call must be Signed.

WARNING: This may be called on accounts created by pure, however if done, then the unreserved fees will be inaccessible. All access to this account will be lost.

create_pure

Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and initialize it with a proxy of proxy_type for origin sender.

Requires a Signed origin.

• proxy_type: The type of the proxy that the sender will be registered as over the new account. This will almost always be the most permissive ProxyType possible to allow for maximum flexibility.
• index: A disambiguation index, in case this is called multiple times in the same transaction (e.g. with utility::batch). Unless you’re using batch you probably just want to use 0.
• delay: The announcement period required of the initial proxy. Will generally be zero.

Fails with Duplicate if this has already been called in this transaction, from the same sender, with the same parameters.

Fails if there are insufficient funds to pay for deposit.

Fields

proxy_type: T::ProxyType

delay: BlockNumberFor<T>

index: u16

kill_pure

Removes a previously spawned pure proxy.

WARNING: All access to this account will be lost. Any funds held in it will be inaccessible.

Requires a Signed origin, and the sender account must have been created by a call to pure with corresponding parameters.

• spawner: The account that originally called pure to create this account.
• index: The disambiguation index originally passed to pure. Probably 0.
• proxy_type: The proxy type originally passed to pure.
• height: The height of the chain when the call to pure was processed.
• ext_index: The extrinsic index in which the call to pure was processed.

Fails with NoPermission in case the caller is not a previously created pure account whose pure call has corresponding parameters.

Fields

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

proxy_type: T::ProxyType

index: u16

height: BlockNumberFor<T>

ext_index: u32

announce

Publish the hash of a proxy-call that will be made in the future.

This must be called some number of blocks before the corresponding proxy is attempted if the delay associated with the proxy relationship is greater than zero.

No more than MaxPending announcements may be made at any one time.

This will take a deposit of AnnouncementDepositFactor as well as AnnouncementDepositBase if there are no other pending announcements.

The dispatch origin for this call must be Signed and a proxy of real.

Parameters:

• real: The account that the proxy will make a call on behalf of.
• call_hash: The hash of the call to be made by the real account.

Fields

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

call_hash: <<T as Config>::CallHasher as Hash>::Output

remove_announcement

Remove a given announcement.

May be called by a proxy account to remove a call they previously announced and return the deposit.

The dispatch origin for this call must be Signed.

Parameters:

• real: The account that the proxy will make a call on behalf of.
• call_hash: The hash of the call to be made by the real account.

Fields

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

call_hash: <<T as Config>::CallHasher as Hash>::Output

reject_announcement

Remove the given announcement of a delegate.

May be called by a target (proxied) account to remove a call that one of their delegates (delegate) has announced they want to execute. The deposit is returned.

The dispatch origin for this call must be Signed.

Parameters:

• delegate: The account that previously announced the call.
• call_hash: The hash of the call to be made.

Fields

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

call_hash: <<T as Config>::CallHasher as Hash>::Output

proxy_announced

Dispatch the given call from an account that the sender is authorized for through add_proxy.

Removes any corresponding announcement(s).

The dispatch origin for this call must be Signed.

Parameters:

• real: The account that the proxy will make a call on behalf of.
• force_proxy_type: Specify the exact proxy type to be used and checked for this call.
• call: The call to be made by the real account.

Fields

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

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

force_proxy_type: Option<T::ProxyType>

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

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_proxy( real: <<T as Config>::Lookup as StaticLookup>::Source, force_proxy_type: Option<T::ProxyType>, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant proxy.

pub fn new_call_variant_add_proxy( delegate: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: T::ProxyType, delay: BlockNumberFor<T>, ) -> Self

Create a call with the variant add_proxy.

pub fn new_call_variant_remove_proxy( delegate: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: T::ProxyType, delay: BlockNumberFor<T>, ) -> Self

Create a call with the variant remove_proxy.

pub fn new_call_variant_remove_proxies() -> Self

Create a call with the variant remove_proxies.

pub fn new_call_variant_create_pure( proxy_type: T::ProxyType, delay: BlockNumberFor<T>, index: u16, ) -> Self

Create a call with the variant create_pure.

pub fn new_call_variant_kill_pure( spawner: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: T::ProxyType, index: u16, height: BlockNumberFor<T>, ext_index: u32, ) -> Self

Create a call with the variant kill_pure.

pub fn new_call_variant_announce( real: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Self

Create a call with the variant announce.

pub fn new_call_variant_remove_announcement( real: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Self

Create a call with the variant remove_announcement.

pub fn new_call_variant_reject_announcement( delegate: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Self

Create a call with the variant reject_announcement.

pub fn new_call_variant_proxy_announced( delegate: <<T as Config>::Lookup as StaticLookup>::Source, real: <<T as Config>::Lookup as StaticLookup>::Source, force_proxy_type: Option<T::ProxyType>, call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant proxy_announced.

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

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

where PhantomData<(T,)>: TypeInfo + 'static, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Option<T::ProxyType>: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, T::ProxyType: TypeInfo + 'static, BlockNumberFor<T>: TypeInfo + 'static + HasCompact, <<T as Config>::CallHasher as Hash>::Output: 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> EncodeLike for Call<T>

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