Skip to content
Snippets Groups Projects
runtime-calls.md 41.6 KiB
Newer Older
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.


#### remove_proxies - 3

<details><summary><code>remove_proxies()</code></summary>

```rust
```
</details>


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


<details><summary><code>anonymous(proxy_type, delay, index)</code></summary>
```rust
proxy_type: T::ProxyType
delay: T::BlockNumber
index: u16
```
</details>


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.


#### kill_anonymous - 5

<details><summary><code>kill_anonymous(spawner, proxy_type, index, height, ext_index)</code></summary>
spawner: T::AccountId
proxy_type: T::ProxyType
height: T::BlockNumber
ext_index: u32
```
</details>


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.


#### announce - 6

<details><summary><code>announce(real, call_hash)</code></summary>
real: T::AccountId
call_hash: CallHashOf<T>
```
</details>


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.


#### remove_announcement - 7

<details><summary><code>remove_announcement(real, call_hash)</code></summary>
call_hash: CallHashOf<T>
```
</details>


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.


#### reject_announcement - 8

<details><summary><code>reject_announcement(delegate, call_hash)</code></summary>
call_hash: CallHashOf<T>
```
</details>


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.


#### proxy_announced - 9

<details><summary><code>proxy_announced(delegate, real, force_proxy_type, call)</code></summary>
delegate: T::AccountId
real: T::AccountId
force_proxy_type: Option<T::ProxyType>
call: Box<<T as Config>::Call>
```
</details>


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.


### Utility - 64

#### batch - 0

<details><summary><code>batch(calls)</code></summary>
calls: Vec<<T as Config>::Call>
```
</details>


Send a batch of dispatch calls.

May be called from any origin.

- `calls`: The calls to be dispatched from the same origin. The number of call must not
  exceed the constant: `batched_calls_limit` (available in constant metadata).

If origin is root then call are dispatch without checking origin filter. (This includes
bypassing `frame_system::Config::BaseCallFilter`).


#### as_derivative - 1

<details><summary><code>as_derivative(index, call)</code></summary>
index: u16
call: Box<<T as Config>::Call>
```
</details>


Send a call through an indexed pseudonym of the sender.

Filter from origin are passed along. The call will be dispatched with an origin which
use the same filter as the origin of this call.

NOTE: If you need to ensure that any account-based filtering is not honored (i.e.
because you expect `proxy` to have been used prior in the call stack and you do not want
the call restrictions to apply to any sub-accounts), then use `as_multi_threshold_1`
in the Multisig pallet instead.

NOTE: Prior to version *12, this was called `as_limited_sub`.

The dispatch origin for this call must be _Signed_.

#### batch_all - 2

<details><summary><code>batch_all(calls)</code></summary>
calls: Vec<<T as Config>::Call>
```
</details>


Send a batch of dispatch calls and atomically execute them.
The whole transaction will rollback and fail if any of the calls failed.

May be called from any origin.

- `calls`: The calls to be dispatched from the same origin. The number of call must not
  exceed the constant: `batched_calls_limit` (available in constant metadata).

If origin is root then call are dispatch without checking origin filter. (This includes
bypassing `frame_system::Config::BaseCallFilter`).


#### force_batch - 4

<details><summary><code>force_batch(calls)</code></summary>

```rust
calls: Vec<<T as Config>::Call>
```
Send a batch of dispatch calls.
Unlike `batch`, it allows errors and won't interrupt.

May be called from any origin.

- `calls`: The calls to be dispatched from the same origin. The number of call must not
  exceed the constant: `batched_calls_limit` (available in constant metadata).

If origin is root then call are dispatch without checking origin filter. (This includes
bypassing `frame_system::Config::BaseCallFilter`).


### Treasury - 65

#### propose_spend - 0

<details><summary><code>propose_spend(value, beneficiary)</code></summary>

```rust
value: BalanceOf<T, I>
beneficiary: <T::Lookup as StaticLookup>::Source
```
Put forward a suggestion for spending. A deposit proportional to the value
is reserved and slashed if the proposal is rejected. It is returned once the
proposal is awarded.
#### spend - 3

<details><summary><code>spend(amount, beneficiary)</code></summary>

```rust
amount: BalanceOf<T, I>
beneficiary: <T::Lookup as StaticLookup>::Source
```
</details>

Propose and approve a spend of treasury funds.
- `origin`: Must be `SpendOrigin` with the `Success` value being at least `amount`.
- `amount`: The amount to be transferred from the treasury to the `beneficiary`.
- `beneficiary`: The destination account for the transfer.
NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the
beneficiary.
<details><summary><code>remove_approval(proposal_id)</code></summary>
Éloïs's avatar
Éloïs committed

```rust
Force a previously approved proposal to be removed from the approval queue.
The original deposit will no longer be returned.
May only be called from `T::RejectOrigin`.
- `proposal_id`: The index of a proposal
There are **26** root calls from **12** pallets.
<details><summary><code>fill_block(ratio)</code></summary>
A dispatch that will fill the block weight up to the given ratio.
<details><summary><code>set_heap_pages(pages)</code></summary>
Set the number of pages in the WebAssembly environment's heap.
<details><summary><code>set_code(code)</code></summary>
#### set_code_without_checks - 4
<details><summary><code>set_code_without_checks(code)</code></summary>
Set the new runtime code without doing any checks of the given `code`.
<details><summary><code>set_storage(items)</code></summary>
<details><summary><code>kill_storage(keys)</code></summary>
<details><summary><code>kill_prefix(prefix, subkeys)</code></summary>
Kill all storage items with a key that starts with the given prefix.
**NOTE:** We rely on the Root origin to provide us the number of subkeys under
the prefix we are removing to accurately calculate the weight of this function.
<details><summary><code>plan_config_change(config)</code></summary>

```rust
config: NextConfigDescriptor
```
</details>


Plan an epoch config change. The epoch config change is recorded and will be enacted on
the next call to `enact_epoch_change`. The config will be activated one epoch after.
Multiple calls to this method will replace any existing planned config change that had
not been enacted yet.

### Balances - 6
<details><summary><code>set_balance(who, new_free, new_reserved)</code></summary>
```rust
who: <T::Lookup as StaticLookup>::Source
new_free: T::Balance
new_reserved: T::Balance
```
</details>


Set the balances of a given account.

This will alter `FreeBalance` and `ReservedBalance` in storage. it will
also alter the total issuance of the system (`TotalIssuance`) appropriately.
If the new free or reserved balance is below the existential deposit,
it will reset the account nonce (`frame_system::AccountNonce`).

The dispatch origin for this call is `root`.

<details><summary><code>force_transfer(source, dest, value)</code></summary>
source: <T::Lookup as StaticLookup>::Source
dest: <T::Lookup as StaticLookup>::Source
Exactly as `transfer`, except the origin must be root and the source account may be
specified.
<details><summary><code>force_unreserve(who, amount)</code></summary>
who: <T::Lookup as StaticLookup>::Source
Unreserve some balance from a user by force.
<details><summary><code>remove_member(member_id)</code></summary>
<details><summary><code>note_stalled(delay, best_finalized_block_number)</code></summary>
delay: T::BlockNumber
best_finalized_block_number: T::BlockNumber
Note that the current authority set of the GRANDPA finality gadget has stalled.
This will trigger a forced authority set change at the beginning of the next session, to
be enacted `delay` blocks after that. The `delay` should be high enough to safely assume
that the block signalling the forced change will not be re-orged e.g. 1000 blocks.
The block production rate (which may be slowed down because of finality lagging) should
be taken into account when choosing the `delay`. The GRANDPA voters based on the new
authority will start voting on top of `best_finalized_block_number` for new finalized
blocks. `best_finalized_block_number` should be the highest of the latest finalized
block of all validators of the new authority set.
<details><summary><code>set_members(new_members, prime, old_count)</code></summary>
new_members: Vec<T::AccountId>
prime: Option<T::AccountId>
old_count: MemberCount
Set the collective's membership.

- `new_members`: The new member list. Be nice to the chain and provide it sorted.
- `prime`: The prime member whose vote sets the default.
- `old_count`: The upper bound for the previous number of members in storage. Used for
  weight estimation.
NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
      the weight estimations rely on it to estimate dispatchable weight.
The `pallet-collective` can also be managed by logic outside of the pallet through the
implementation of the trait [`ChangeMembers`].
Any call to `set_members` must be careful that the member set doesn't get out of sync
with other logic managing the member set.
<details><summary><code>disapprove_proposal(proposal_hash)</code></summary>
Disapprove a proposal, close, and remove it from the system, regardless of its current
state.

Must be called by the Root origin.
Parameters:
* `proposal_hash`: The hash of the proposal that should be disapproved.
<details><summary><code>remove_identity(idty_index, idty_name)</code></summary>
idty_index: T::IdtyIndex
idty_name: Option<IdtyName>
#### prune_item_identities_names - 6
<details><summary><code>prune_item_identities_names(names)</code></summary>
#### force_request_membership - 0
<details><summary><code>force_request_membership(idty_id, metadata)</code></summary>
<details><summary><code>force_add_cert(issuer, receiver, verify_rules)</code></summary>
issuer: T::IdtyIndex
receiver: T::IdtyIndex
<details><summary><code>del_cert(issuer, receiver)</code></summary>
#### remove_all_certs_received_by - 3
<details><summary><code>remove_all_certs_received_by(idty_index)</code></summary>
#### force_request_membership - 0
<details><summary><code>force_request_membership(idty_id, metadata)</code></summary>
<details><summary><code>force_add_cert(issuer, receiver, verify_rules)</code></summary>
issuer: T::IdtyIndex
receiver: T::IdtyIndex
<details><summary><code>del_cert(issuer, receiver)</code></summary>
#### remove_all_certs_received_by - 3
<details><summary><code>remove_all_certs_received_by(idty_index)</code></summary>
<details><summary><code>dispatch_as(as_origin, call)</code></summary>
as_origin: Box<T::PalletsOrigin>
call: Box<<T as Config>::Call>
```
</details>


Dispatches a function call with a provided origin.

The dispatch origin for this call must be _Root_.





There are **7** disabled calls from **4** pallets.
<details><summary><code>remark(remark)</code></summary>
<details><summary><code>remark_with_event(remark)</code></summary>
Make some on-chain remark and emit event.

### Session - 14
<details><summary><code>set_keys(keys, proof)</code></summary>
```rust
keys: T::Keys
proof: Vec<u8>
```
</details>


Sets the session key(s) of the function caller to `keys`.
Allows an account to set its session key prior to becoming a validator.
This doesn't take effect until the next session.

The dispatch origin of this function must be signed.


#### purge_keys - 1

<details><summary><code>purge_keys()</code></summary>

```rust
```
</details>


Removes any session key(s) of the function caller.

This doesn't take effect until the next session.

The dispatch origin of this function must be Signed and the account must be either be
convertible to a validator ID using the chain's typical addressing system (this usually
means being a controller account) or directly convertible into a validator ID (which
usually means being a stash account).


<details><summary><code>claim_membership(maybe_idty_id)</code></summary>

```rust
maybe_idty_id: Option<T::IdtyId>
```
</details>




<details><summary><code>revoke_membership(maybe_idty_id)</code></summary>

```rust
maybe_idty_id: Option<T::IdtyId>
```
</details>




<details><summary><code>claim_membership(maybe_idty_id)</code></summary>

```rust
maybe_idty_id: Option<T::IdtyId>
```
</details>