Struct pallet_proxy::pallet::Pallet [−][src]
pub struct Pallet<T>(_);Expand description
The pallet implementing the on-chain logic.
Implementations
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 therealaccount.
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
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 thecallerwould 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
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 thecallerwould 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).
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
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 permissiveProxyTypepossible to allow for maximum flexibility.index: A disambiguation index, in case this is called multiple times in the same transaction (e.g. withutility::batch). Unless you’re usingbatchyou probably just want to use0.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
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 calledanonymousto create this account.index: The disambiguation index originally passed toanonymous. Probably0.proxy_type: The proxy type originally passed toanonymous.height: The height of the chain when the call toanonymouswas processed.ext_index: The extrinsic index in which the call toanonymouswas 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
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 therealaccount.
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
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 therealaccount.
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
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.
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 therealaccount.
Weight is a function of:
- A: the number of announcements made.
- P: the number of proxies the user has.
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>,
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.
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>,
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).
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 permissiveProxyTypepossible to allow for maximum flexibility.index: A disambiguation index, in case this is called multiple times in the same transaction (e.g. withutility::batch). Unless you’re usingbatchyou probably just want to use0.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
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 thedelegatorwould 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
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 thedelegatorwould 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
Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more
fn run_benchmark(
extrinsic: &[u8],
c: &[(BenchmarkParameter, u32)],
whitelist: &[TrackedStorageKey],
verify: bool,
internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>
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.
Returns the current storage version as supported by the pallet.
Returns the on-chain storage version of the pallet as stored in the storage.
The block is being finalized. Implement to have something happen.
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. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
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. Read more
Run integrity test. Read more
Run integrity test. Read more
This function is being called after every block import (when fully synced). Read more
The block is being finalized. Implement to have something happen. Read more
Something that should happen at genesis.
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. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Name of the Rust module containing the pallet.
Version of the crate containing the pallet.
Extend the given vector by all of the pallets’ information that this type represents. Read more
All of the pallets’ information that this type represents.
Auto Trait Implementations
impl<T> RefUnwindSafe for Pallet<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Pallet<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
Compare self to key and return true if they are equal.
Causes self to use its Binary implementation when Debug-formatted.
Causes self to use its Display implementation when
Debug-formatted. Read more
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
Causes self to use its Pointer implementation when
Debug-formatted. Read more
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
Borrows self, then passes self.deref() into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref() only in debug builds, and is erased in release
builds. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self for modification.
The counterpart to unchecked_from.
Consume self to return an equivalent value of T.
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more