Struct pallet_proxy::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn proxy(
    origin: OriginFor<T>,
    real: T::AccountId,
    force_proxy_type: Option<T::ProxyType>,
    call: Box<<T as Config>::Call>
) -> DispatchResult

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

pub fn add_proxy(
    origin: OriginFor<T>,
    delegate: T::AccountId,
    proxy_type: T::ProxyType,
    delay: T::BlockNumber
) -> DispatchResult

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

pub fn remove_proxy(
    origin: OriginFor<T>,
    delegate: T::AccountId,
    proxy_type: T::ProxyType,
    delay: T::BlockNumber
) -> DispatchResult

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

pub fn remove_proxies(origin: OriginFor<T>) -> DispatchResult

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

pub fn anonymous(
    origin: OriginFor<T>,
    proxy_type: T::ProxyType,
    delay: T::BlockNumber,
    index: u16
) -> DispatchResult

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

pub fn kill_anonymous(
    origin: OriginFor<T>,
    spawner: T::AccountId,
    proxy_type: T::ProxyType,
    index: u16,
    height: T::BlockNumber,
    ext_index: u32
) -> DispatchResult

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

pub fn announce(
    origin: OriginFor<T>,
    real: T::AccountId,
    call_hash: <<T as Config>::CallHasher as Hash>::Output
) -> DispatchResult

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.

pub fn remove_announcement(
    origin: OriginFor<T>,
    real: T::AccountId,
    call_hash: <<T as Config>::CallHasher as Hash>::Output
) -> DispatchResult

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.

pub fn reject_announcement(
    origin: OriginFor<T>,
    delegate: T::AccountId,
    call_hash: <<T as Config>::CallHasher as Hash>::Output
) -> DispatchResult

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.

pub fn proxy_announced(
    origin: OriginFor<T>,
    delegate: T::AccountId,
    real: T::AccountId,
    force_proxy_type: Option<T::ProxyType>,
    call: Box<<T as Config>::Call>
) -> DispatchResult

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.

Weight is a function of:

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

impl<T: Config> Pallet<T>

pub fn proxies<KArg>(
    k: KArg
) -> (BoundedVec<ProxyDefinition<T::AccountId, T::ProxyType, T::BlockNumber>, T::MaxProxies>, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance) where
    KArg: EncodeLike<T::AccountId>, 

The set of account proxies. Maps the account which has delegated to the accounts which are being delegated to, together with the amount held on deposit.

impl<T: Config> Pallet<T>

pub fn announcements<KArg>(
    k: KArg
) -> (BoundedVec<Announcement<T::AccountId, <<T as Config>::CallHasher as Hash>::Output, T::BlockNumber>, T::MaxPending>, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance) where
    KArg: EncodeLike<T::AccountId>, 

The announcements made by the proxy (key).

impl<T: Config> Pallet<T>

pub fn anonymous_account(
    who: &T::AccountId,
    proxy_type: &T::ProxyType,
    index: u16,
    maybe_when: Option<(T::BlockNumber, u32)>
) -> T::AccountId

Calculate the address of an anonymous account.

• who: The spawner account.
• 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.
• maybe_when: The block height and extrinsic index of when the anonymous account was created. None to use current block height and extrinsic index.

pub fn add_proxy_delegate(
    delegator: &T::AccountId,
    delegatee: T::AccountId,
    proxy_type: T::ProxyType,
    delay: T::BlockNumber
) -> DispatchResult

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

Parameters:

• delegator: The delegator account.
• delegatee: The account that the delegator 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.

pub fn remove_proxy_delegate(
    delegator: &T::AccountId,
    delegatee: T::AccountId,
    proxy_type: T::ProxyType,
    delay: T::BlockNumber
) -> DispatchResult

Unregister a proxy account for the delegator.

Parameters:

• delegator: The delegator account.
• delegatee: The account that the delegator 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.

pub fn deposit(
    num_proxies: u32
) -> <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

pub fn find_proxy(
    real: &T::AccountId,
    delegate: &T::AccountId,
    force_proxy_type: Option<T::ProxyType>
) -> Result<ProxyDefinition<T::AccountId, T::ProxyType, T::BlockNumber>, DispatchError>

Trait Implementations

impl<T: Config> Benchmarking<BenchmarkResults> for Pallet<T> where
    T: Config, 

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResults>, &'static str>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: u64) -> u64

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> u64

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> ModuleErrorMetadata for Pallet<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

impl<T> PartialEq<Pallet<T>> for Pallet<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 !=.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>