Enum pallet_proxy::Call

pub enum Call<T: Config> {
    proxy(T::AccountId, Option<T::ProxyType>, Box<<T as Config>::Call>),
    add_proxy(T::AccountId, T::ProxyType, T::BlockNumber),
    remove_proxy(T::AccountId, T::ProxyType, T::BlockNumber),
    remove_proxies(),
    anonymous(T::ProxyType, T::BlockNumber, u16),
    kill_anonymous(T::AccountId, T::ProxyType, u16, T::BlockNumber, u32),
    announce(T::AccountId, <<T as Config>::CallHasher as Hash>::Output),
    remove_announcement(T::AccountId, <<T as Config>::CallHasher as Hash>::Output),
    reject_announcement(T::AccountId, <<T as Config>::CallHasher as Hash>::Output),
    proxy_announced(T::AccountId, T::AccountId, Option<T::ProxyType>, Box<<T as Config>::Call>),
    // some variants omitted
}

Dispatchable calls.

Each variant of this enum maps to a dispatchable function from the associated module.

Variants

proxy(T::AccountId, Option<T::ProxyType>, Box<<T as Config>::Call>)

Dispatch the given call from an account that the sender is authorised 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.

Weight is a function of the number of proxies the user has (P).

add_proxy(T::AccountId, T::ProxyType, T::BlockNumber)

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.

Weight is a function of the number of proxies the user has (P).

remove_proxy(T::AccountId, T::ProxyType, T::BlockNumber)

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.

Weight is a function of the number of proxies the user has (P).

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 anonymous, however if done, then the unreserved fees will be inaccessible. All access to this account will be lost.

Weight is a function of the number of proxies the user has (P).

anonymous(T::ProxyType, T::BlockNumber, u16)

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.

Weight is a function of the number of proxies the user has (P).

TODO: Might be over counting 1 read

kill_anonymous(T::AccountId, T::ProxyType, u16, T::BlockNumber, u32)

Removes a previously spawned anonymous 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 anonymous with corresponding parameters.

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

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

Weight is a function of the number of proxies the user has (P).

announce(T::AccountId, <<T as Config>::CallHasher as Hash>::Output)

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.

Weight is a function of:

• A: the number of announcements made.
• P: the number of proxies the user has.

remove_announcement(T::AccountId, <<T as Config>::CallHasher as Hash>::Output)

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.

Weight is a function of:

• A: the number of announcements made.
• P: the number of proxies the user has.

reject_announcement(T::AccountId, <<T as Config>::CallHasher as Hash>::Output)

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.

Weight is a function of:

• A: the number of announcements made.
• P: the number of proxies the user has.

proxy_announced(T::AccountId, T::AccountId, Option<T::ProxyType>, Box<<T as Config>::Call>)

Dispatch the given call from an account that the sender is authorised 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.

Weight is a function of:

• A: the number of announcements made.
• P: the number of proxies the user has.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T> where
    T::AccountId: Decode,
    T::AccountId: Decode,
    Option<T::ProxyType>: Decode,
    Option<T::ProxyType>: Decode,
    Box<<T as Config>::Call>: Decode,
    Box<<T as Config>::Call>: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::ProxyType: Decode,
    T::ProxyType: Decode,
    T::BlockNumber: Decode,
    T::BlockNumber: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::ProxyType: Decode,
    T::ProxyType: Decode,
    T::BlockNumber: Decode,
    T::BlockNumber: Decode,
    T::ProxyType: Decode,
    T::ProxyType: Decode,
    T::BlockNumber: Decode,
    T::BlockNumber: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::ProxyType: Decode,
    T::ProxyType: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    <<T as Config>::CallHasher as Hash>::Output: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    Option<T::ProxyType>: Decode,
    Option<T::ProxyType>: Decode,
    Box<<T as Config>::Call>: Decode,
    Box<<T as Config>::Call>: Decode,
    T::BlockNumber: HasCompact, 

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T> where
    T::AccountId: Encode,
    T::AccountId: Encode,
    Option<T::ProxyType>: Encode,
    Option<T::ProxyType>: Encode,
    Box<<T as Config>::Call>: Encode,
    Box<<T as Config>::Call>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    Option<T::ProxyType>: Encode,
    Option<T::ProxyType>: Encode,
    Box<<T as Config>::Call>: Encode,
    Box<<T as Config>::Call>: Encode,
    T::BlockNumber: HasCompact, 

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

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

pub fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> EncodeLike<Call<T>> for Call<T> where
    T::AccountId: Encode,
    T::AccountId: Encode,
    Option<T::ProxyType>: Encode,
    Option<T::ProxyType>: Encode,
    Box<<T as Config>::Call>: Encode,
    Box<<T as Config>::Call>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::BlockNumber: Encode,
    T::BlockNumber: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::ProxyType: Encode,
    T::ProxyType: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    <<T as Config>::CallHasher as Hash>::Output: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    Option<T::ProxyType>: Encode,
    Option<T::ProxyType>: Encode,
    Box<<T as Config>::Call>: Encode,
    Box<<T as Config>::Call>: Encode,
    T::BlockNumber: HasCompact, 

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

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.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

type Origin = T::Origin

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

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

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