Type Alias Proxy

pub type Proxy = Pallet<Runtime>;

Aliased Type

struct Proxy(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn proxy( origin: <T as Config>::RuntimeOrigin, real: <<T as Config>::Lookup as StaticLookup>::Source, force_proxy_type: Option<<T as Config>::ProxyType>, call: Box<<T as Config>::RuntimeCall>, ) -> Result<(), DispatchError>

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.

pub fn add_proxy( origin: <T as Config>::RuntimeOrigin, delegate: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: <T as Config>::ProxyType, delay: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, ) -> Result<(), DispatchError>

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.

pub fn remove_proxy( origin: <T as Config>::RuntimeOrigin, delegate: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: <T as Config>::ProxyType, delay: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, ) -> Result<(), DispatchError>

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.

pub fn remove_proxies( origin: <T as Config>::RuntimeOrigin, ) -> Result<(), DispatchError>

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.

pub fn create_pure( origin: <T as Config>::RuntimeOrigin, proxy_type: <T as Config>::ProxyType, delay: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, index: u16, ) -> Result<(), DispatchError>

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.

pub fn kill_pure( origin: <T as Config>::RuntimeOrigin, spawner: <<T as Config>::Lookup as StaticLookup>::Source, proxy_type: <T as Config>::ProxyType, index: u16, height: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, ext_index: u32, ) -> Result<(), DispatchError>

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.

pub fn announce( origin: <T as Config>::RuntimeOrigin, real: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Result<(), DispatchError>

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.

pub fn remove_announcement( origin: <T as Config>::RuntimeOrigin, real: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Result<(), DispatchError>

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.

pub fn reject_announcement( origin: <T as Config>::RuntimeOrigin, delegate: <<T as Config>::Lookup as StaticLookup>::Source, call_hash: <<T as Config>::CallHasher as Hash>::Output, ) -> Result<(), DispatchError>

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.

pub fn proxy_announced( origin: <T as Config>::RuntimeOrigin, delegate: <<T as Config>::Lookup as StaticLookup>::Source, real: <<T as Config>::Lookup as StaticLookup>::Source, force_proxy_type: Option<<T as Config>::ProxyType>, call: Box<<T as Config>::RuntimeCall>, ) -> Result<(), DispatchError>

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.

pub fn poke_deposit( origin: <T as Config>::RuntimeOrigin, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Poke / Adjust deposits made for proxies and announcements based on current values. This can be used by accounts to possibly lower their locked amount.

The dispatch origin for this call must be Signed.

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

Emits DepositPoked if successful.

impl<T> Pallet<T>

where T: Config,

pub fn check_permissions( call: <T as Config>::RuntimeCall, proxy_type: <T as Config>::ProxyType, ) -> bool

Check if a RuntimeCall is allowed for a given ProxyType.

pub fn is_superset( to_check: <T as Config>::ProxyType, against: <T as Config>::ProxyType, ) -> bool

Check if one ProxyType is a subset of another ProxyType.

impl<T> Pallet<T>

where T: Config,

pub fn proxies( account: <T as Config>::AccountId, ) -> (BoundedVec<ProxyDefinition<<T as Config>::AccountId, <T as Config>::ProxyType, <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber>, <T as Config>::MaxProxies>, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance)

Public function to proxies storage.

pub fn announcements( account: <T as Config>::AccountId, ) -> (BoundedVec<Announcement<<T as Config>::AccountId, <<T as Config>::CallHasher as Hash>::Output, <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber>, <T as Config>::MaxPending>, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance)

Public function to announcements storage.

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

Calculate the address of an pure 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 pure account was created. None to use current block height and extrinsic index.

pub fn add_proxy_delegate( delegator: &<T as Config>::AccountId, delegatee: <T as Config>::AccountId, proxy_type: <T as Config>::ProxyType, delay: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, ) -> Result<(), DispatchError>

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 as Config>::AccountId, delegatee: <T as Config>::AccountId, proxy_type: <T as Config>::ProxyType, delay: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber, ) -> Result<(), DispatchError>

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 as Config>::AccountId, delegate: &<T as Config>::AccountId, force_proxy_type: Option<<T as Config>::ProxyType>, ) -> Result<ProxyDefinition<<T as Config>::AccountId, <T as Config>::ProxyType, <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber>, DispatchError>

pub fn remove_all_proxy_delegates(delegator: &<T as Config>::AccountId)

Removes all proxy delegates for a given delegator.

Parameters:

• delegator: The delegator account.

Trait Implementations

impl<T> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + 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<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T> Callable<T> for Pallet<T>

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

fn dispatch_view_function<O>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

where O: Output,

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> <Pallet<T> as GetStorageVersion>::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or NoStorageVersionSet if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use Self::current_storage_version instead.

impl<T> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before Hooks::on_finalize).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T> IntegrityTest for Pallet<T>

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

impl<T> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

impl<T> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

impl<T> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

impl<T> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

impl<T> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

Code to execute every now and then at the beginning of the block after inherent application.

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

See Hooks::pre_upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), DispatchError>

See Hooks::post_upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

impl<T> PalletInfoAccess for Pallet<T>

where T: Config,

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.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T> PalletsInfoAccess for Pallet<T>

where T: Config,

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Pallet<T>) -> 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> StorageInfoTrait for Pallet<T>

where T: Config,

fn storage_info() -> Vec<StorageInfo>

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>