pallet_proxy

Branch/Release: release-polkadot-v1.10.0

Source Code

Purpose

This pallet enables delegation of rights to execute certain call types from one origin to another.

Config

  • Pallet-specific configs:

    • ProxyType — a type that describes different variants of proxy. It must implement Default trait and InstanceFilter<RuntimeCall> trait.

    • ProxyDepositBase — a base amount of currency that defines a deposit for proxy creation.

    • ProxyDepositFactor — an amount of currency that will be frozen along with the ProxyDepositBase for each additional proxy.

    • MaxProxies — maximum number of proxies that single account can create.

    • MaxPending — maximum number of announcements that can be made per account.

    • CallHasher — a type implementing a Hash trait. Will be used to hash the executed call.

    • AnnouncementDepositBase — a base amount of currency that defines a deposit for announcement creation.

    • AnnouncementDepositFactor — an amount of currency that will be frozen along with the AnnouncementDepositBase for each additional announcement.

  • Common configs:

    • RuntimeEvent

    • RuntimeCall

    • Currency

Dispatchables

add_proxy

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

Create a new Proxy that allows delegate to execute calls that fulfill proxy_type check on your origin’s behalf.

The origin must be signed for this call.

This call will take (or modify) a deposit based on number of proxies created by delegator and calculated by this formula: ProxyDepositBase + ProxyDepositFactor * <number of proxies>

There may not be more proxies than MaxProxies

Params:

  • delegate: <<T as Config>::Lookup as StaticLookup>::Source — account that will become a proxy for the origin

  • proxy_type: T::ProxyType — type of calls that will be allowed for the delegate

  • delay: BlockNumberFor<T> — number of blocks that needs to happen between announcement and call for this proxy

Errors:

  • BadOrigin — request not signed

  • LookupError — delegate not found

  • NoSelfProxy — delegate and call origin is the same account

  • Duplicate — proxy already exists

  • TooMany — too many proxies created for this delegate with this type and the same delay

  • InsufficientBalance — delegator does not have enough funds for deposit for proxy creation

  • LiquidityRestrictions — account restrictions (like frozen funds or vesting) prevent from creating a deposit

  • Overflow — reserved funds overflow the currency type. Should not happen in usual scenarios.

Events:

  • ProxyAdded(delegator, delegatee, proxy_type, delay)

announce

pub fn announce(
    real: AccountIdLookupOf<T>,
    call_hash: CallHashOf<T>,
)

Announce a call that will be executed using a proxy. As a result announcement will be created. You must create an announcement if the proxy you are using specified a delay greater than zero. In that case you will be able to execute a call after the number of blocks specified by delay.

The origin must be signed for this call.

This call will take (or modify) a deposit calculated by this formula: AnnouncementDepositBase + AnnouncementDepositFactor * <number of announcements present>

There may not be more announcements than MaxPending

Params:

  • real: AccountIdLookupOf<T> — the account on which behalf this call will be made

  • call_hash: CallHashOf<T> — hash of the call that is going to be made

Errors:

  • BadOrigin — request not signed

  • LookupError — real account not found

  • NotProxy — there is no proxy between the caller and real

  • TooMany — there is more announcements for this sender than specified in MaxPending

  • InsufficientBalance — caller does not have enough funds for deposit for announcement creation

  • LiquidityRestrictions — account restrictions (like frozen funds or vesting) prevent from creating a deposit

  • Overflow — reserved funds overflow the currency type. Should not happen in usual scenarios.

Events:

  • Announced(real, proxy, call_hash)

proxy

pub fn proxy(
    real: AccountIdLookupOf<T>,
    force_proxy_type: Option<T::ProxyType>,
    call: Box<<T as Config>::RuntimeCall>,
)

Dispatch a call on behalf of real account using a proxy that was created in advance. Proxy must be created for the call sender to execute the call.

The origin must be signed for this call.

If the proxy requires an announcement before the call, this dispatchable will fail.

Params:

  • real: AccountIdLookupOf<T> — the account on which behalf this call will be made

  • force_proxy_type: Option<T::ProxyType> — specific proxy type to get proxy for. If not specified, first one found in the storage will be used.

  • call: Box<<T as Config>::RuntimeCall> — a call to execute

Errors:

  • BadOrigin — request not signed

  • LookupError — real account not found

  • NotProxy — there is no proxy between the caller and real

  • Unannounced — there was a delay specified but not fulfilled

Events:

  • ProxyExecuted(result)

proxy_announced

pub fn proxy_announced<T: Config>(
    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>
)

Execute previously announced call using a proxy and remove the announcement. Proxy must be created for the call sender to execute the call.

The origin must be signed for this call.

This call will fail if delay after announcement have not passed or call was not announced.

Params:

  • delegate: <<T as Config>::Lookup as StaticLookup>::Source — the account proxy was given to and who announced the call

  • real: <<T as Config>::Lookup as StaticLookup>::Source — delegator of the proxy, on whose behalf call will be executed

  • force_proxy_type: Option<T::ProxyType> — specific proxy type to get proxy for. If not specified, first one found in the storage will be used.

  • call: Box<<T as Config>::RuntimeCall> — a call to execute

Errors:

  • BadOrigin — request not signed

  • LookupError — real or delegate account not found

  • NotProxy — there is no proxy between the delegate and real

  • Unannounced — there was a delay specified but not fulfilled or call was not announced

Events:

  • ProxyExecuted(result)

reject_announcement

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

Remove the given announcement. Deposit is returned in case of success.

May be called from delegator of the proxy to remove announcement made by delegatee.

The origin must be signed for this call.

Params:

  • delegate: <<T as Config>::Lookup as StaticLookup>::Source — account that created an announcement

  • call_hash: <<T as Config>::CallHasher as Hash>::Output — hash that was created for the announcement

Errors:

  • BadOrigin — request not signed

  • LookupError — delegate account not found

  • NotFound — proxy not found for this delegator and delegatee

remove_announcement

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

Remove the given announcement. Deposit is returned in case of success.

May be called from delegatee of the proxy to remove announcement made by them.

The origin must be signed for this call.

Params:

  • real: <<T as Config>::Lookup as StaticLookup>::Source — delegator of the proxy for the announcement to remove

  • call_hash: <<T as Config>::CallHasher as Hash>::Output — hash of announced call

Errors:

  • BadOrigin — request not signed

  • LookupError — delegate account not found

  • NotFound — proxy not found for this delegator and delegatee

remove_proxies

pub fn remove_proxies()

Removes all proxies issued to the caller. The origin must be signed for this call.

Errors:

  • BadOrigin — request not signed

remove_proxy

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

Remove the proxy issued by the caller. Deposit is returned to the delegator.

Origin must be signed for this call.

Params:

  • delegate: <<T as Config>::Lookup as StaticLookup>::Source — account to whom this proxy was issued

  • proxy_type: T::ProxyType — type of the issued proxy

  • delay: BlockNumberFor<T> — delay of the issued proxy

Errors:

  • BadOrigin — request not signed

  • LookupError — delegate account not found

  • NotFound — no such proxy exists

Events:

  • ProxyRemoved(delegator, delegatee, proxy_type, delay)

create_pure

pub fn create_pure<T: Config>(
    proxy_type: T::ProxyType,
    delay: BlockNumberFor<T>,
    index: u16
)

This call creates a pure account with a proxy issued to it from the call’s origin.

The origin must be signed for this call.

Params:

  • proxy_type: T::ProxyType — type of calls that will be allowed for the proxy

  • delay: BlockNumberFor<T> — number of blocks that needs to happen between announcement and call for this proxy

  • index: u16 — 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.

Errors:

  • BadOrigin — request not signed

  • Duplicate — create_pure was called more than once with the same parameters in the same transaction

  • TooMany — there is more announcements for this sender than specified in MaxPending

  • InsufficientBalance — delegator does not have enough funds for deposit for proxy creation

  • LiquidityRestrictions — account restrictions (like frozen funds or vesting) prevent from creating a deposit

  • Overflow — reserved funds overflow the currency type. Should not happen in usual scenarios.

Events:

  • PureCreated(pure, who, proxy_type, disambiguation_index)

kill_pure

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

Remove a previously created pure account.

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

All access to this account will be lost.

Params:

  • spawner — account who created a proxy and pure account

  • proxy_type — type of proxy used for it

  • index — the disambiguation index used for pure account creation

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

Errors:

  • BadOrigin — request not signed

  • LookupError — spawner account not found

  • NoPermission — emitted when account tries to remove somebody but not itself

← pallet_multisig
pallet_transaction_payment →