Runtime calls

Calls are categorized according to the dispatch origin they require:

User calls: the dispatch origin for this kind of call must be signed by the transactor. This is the only call category that can be submitted with an extrinsic.
Root calls: This kind of call requires a special origin that can only be invoked through on-chain governance mechanisms.
Inherent calls: This kind of call is invoked by the author of the block itself (usually automatically by the node).
Disabled calls: These calls can not be called directly, they are reserved for internal use by other runtime calls.

User calls

There are 86 user calls from 21 pallets.

Account - 1

unlink_identity - 0

unlink_identity()

Taking 0.0111 % of a block.

Unlink the identity associated with the account.

Scheduler - 2

schedule - 0

schedule(when, maybe_periodic, priority, call)

Taking 0.0122 % of a block.

when: BlockNumberFor<T>
maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
priority: schedule::Priority
call: Box<<T as Config>::RuntimeCall>

Anonymously schedule a task.

cancel - 1

cancel(when, index)

Taking 0.0236 % of a block.

when: BlockNumberFor<T>
index: u32

Cancel an anonymously scheduled task.

schedule_named - 2

schedule_named(id, when, maybe_periodic, priority, call)

Taking 0.0189 % of a block.

id: TaskName
when: BlockNumberFor<T>
maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
priority: schedule::Priority
call: Box<<T as Config>::RuntimeCall>

Schedule a named task.

cancel_named - 3

cancel_named(id)

Taking 0.0248 % of a block.

id: TaskName

Cancel a named scheduled task.

schedule_after - 4

schedule_after(after, maybe_periodic, priority, call)

No weight available.

after: BlockNumberFor<T>
maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
priority: schedule::Priority
call: Box<<T as Config>::RuntimeCall>

Anonymously schedule a task after a delay.

schedule_named_after - 5

schedule_named_after(id, after, maybe_periodic, priority, call)

No weight available.

id: TaskName
after: BlockNumberFor<T>
maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
priority: schedule::Priority
call: Box<<T as Config>::RuntimeCall>

Schedule a named task after a delay.

set_retry - 6

set_retry(task, retries, period)

Taking 0.012 % of a block.

task: TaskAddress<BlockNumberFor<T>>
retries: u8
period: BlockNumberFor<T>

Set a retry configuration for a task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task's configuration, but will have a lower value for remaining than the original total_retries.

set_retry_named - 7

set_retry_named(id, retries, period)

Taking 0.0132 % of a block.

id: TaskName
retries: u8
period: BlockNumberFor<T>

Set a retry configuration for a named task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task's configuration, but will have a lower value for remaining than the original total_retries.

cancel_retry - 8

cancel_retry(task)

Taking 0.012 % of a block.

task: TaskAddress<BlockNumberFor<T>>

Removes the retry configuration of a task.

cancel_retry_named - 9

cancel_retry_named(id)

Taking 0.0132 % of a block.

id: TaskName

Cancel the retry configuration of a named task.

Babe - 3

report_equivocation - 0

report_equivocation(equivocation_proof, key_owner_proof)

No weight available.

equivocation_proof: Box<EquivocationProof<HeaderFor<T>>>
key_owner_proof: T::KeyOwnerProof

Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

Balances - 6

transfer_allow_death - 0

transfer_allow_death(dest, value)

Taking 0.0199 % of a block.

dest: AccountIdLookupOf<T>
value: T::Balance

Transfer some liquid free balance to another account.

transfer_allow_death will set the FreeBalance of the sender and receiver. If the sender's account is below the existential deposit as a result of the transfer, the account will be reaped.

The dispatch origin for this call must be Signed by the transactor.

transfer_keep_alive - 3

transfer_keep_alive(dest, value)

Taking 0.0125 % of a block.

dest: AccountIdLookupOf<T>
value: T::Balance

Same as the transfer_allow_death call, but with a check that the transfer will not kill the origin account.

99% of the time you want transfer_allow_death instead.

transfer_all - 4

transfer_all(dest, keep_alive)

Taking 0.0129 % of a block.

dest: AccountIdLookupOf<T>
keep_alive: bool

Transfer the entire transferable balance from the caller account.

NOTE: This function only attempts to transfer transferable balances. This means that any locked, reserved, or existential deposits (when keep_alive is true), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc...

The dispatch origin of this call must be Signed.

dest: The recipient of the transfer.
keep_alive: A boolean to determine if the transfer_all operation should send all of the funds the account has, causing the sender account to be killed (false), or transfer everything except at least the existential deposit, which will guarantee to keep the sender account alive (true).

force_set_balance - 8

force_set_balance(who, new_free)

No weight available.

who: AccountIdLookupOf<T>
new_free: T::Balance

Upgrade a specified account.

origin: Must be Signed.
who: The account to be upgraded.

This will waive the transaction fee if at least all but 10% of the accounts needed to be upgraded. (We let some not have to be upgraded just in order to allow for the possibility of churn). Set the regular balance of a given account.

The dispatch origin for this call is root.

force_adjust_total_issuance - 9

force_adjust_total_issuance(direction, delta)

Taking 0.0048 % of a block.

direction: AdjustmentDirection
delta: T::Balance

Adjust the total issuance in a saturating way.

Can only be called by root and always needs a positive delta.

Example

burn - 10

burn(value, keep_alive)

No weight available.

value: T::Balance
keep_alive: bool

Burn the specified liquid free balance from the origin account.

If the origin's account ends up below the existential deposit as a result of the burn and keep_alive is false, the account will be reaped.

Unlike sending funds to a burn address, which merely makes the funds inaccessible, this burn operation will reduce total issuance by the amount burned.

OneshotAccount - 7

create_oneshot_account - 0

create_oneshot_account(dest, value)

Taking 0.012 % of a block.

dest: <T::Lookup as StaticLookup>::Source
value: BalanceOf<T>

Create an account that can only be consumed once

dest: The oneshot account to be created.
balance: The balance to be transfered to this oneshot account.

Origin account is kept alive.

consume_oneshot_account - 1

consume_oneshot_account(block_height, dest)

Taking 0.0197 % of a block.

block_height: BlockNumberFor<T>
dest: Account<<T::Lookup as StaticLookup>::Source>

Consume a oneshot account and transfer its balance to an account

block_height: Must be a recent block number. The limit is BlockHashCount in the past. (this is to prevent replay attacks)
dest: The destination account.
dest_is_oneshot: If set to true, then a oneshot account is created at dest. Else, dest has to be an existing account.

consume_oneshot_account_with_remaining - 2

consume_oneshot_account_with_remaining(block_height, dest, remaining_to, balance)

Taking 0.0268 % of a block.

block_height: BlockNumberFor<T>
dest: Account<<T::Lookup as StaticLookup>::Source>
remaining_to: Account<<T::Lookup as StaticLookup>::Source>
balance: BalanceOf<T>

Consume a oneshot account then transfer some amount to an account, and the remaining amount to another account.

block_height: Must be a recent block number. The limit is BlockHashCount in the past. (this is to prevent replay attacks)
dest: The destination account.
dest_is_oneshot: If set to true, then a oneshot account is created at dest. Else, dest has to be an existing account.
dest2: The second destination account.
dest2_is_oneshot: If set to true, then a oneshot account is created at dest2. Else, dest2 has to be an existing account.
balance1: The amount transfered to dest, the leftover being transfered to dest2.

SmithMembers - 10

invite_smith - 0

invite_smith(receiver)

Taking 0.0235 % of a block.

receiver: T::IdtyIndex

Invite a member of the Web of Trust to attempt becoming a Smith.

accept_invitation - 1

accept_invitation()

Taking 0.0127 % of a block.

Accept an invitation to become a Smith (must have been invited first).

certify_smith - 2

certify_smith(receiver)

Taking 0.0279 % of a block.

receiver: T::IdtyIndex

Certify an invited Smith, which can lead the certified to become a Smith.

AuthorityMembers - 11

go_offline - 0

go_offline()

Taking 0.0167 % of a block.

Request to leave the set of validators two sessions later.

go_online - 1

go_online()

Taking 0.0189 % of a block.

Request to join the set of validators two sessions later.

set_session_keys - 2

set_session_keys(keys)

Taking 0.0249 % of a block.

keys: T::Keys

Declare new session keys to replace current ones.

remove_member_from_blacklist - 4

remove_member_from_blacklist(member_id)

Taking 0.0114 % of a block.

member_id: T::MemberId

Remove a member from the blacklist. remove an identity from the blacklist

Grandpa - 16

report_equivocation - 0

report_equivocation(equivocation_proof, key_owner_proof)

No weight available.

equivocation_proof: Box<EquivocationProof<T::Hash, BlockNumberFor<T>>>
key_owner_proof: T::KeyOwnerProof

Report voter equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

UpgradeOrigin - 21

dispatch_as_root_unchecked_weight - 1

dispatch_as_root_unchecked_weight(call, weight)

No weight available.

call: Box<<T as Config>::Call>
weight: Weight

Dispatches a function call from root origin. This function does not check the weight of the call, and instead allows the caller to specify the weight of the call.

The weight of this call is defined by the caller.

Preimage - 22

note_preimage - 0

note_preimage(bytes)

Taking 0.2947 % of a block.

bytes: Vec<u8>

Register a preimage on-chain.

If the preimage was previously requested, no fees or deposits are taken for providing the preimage. Otherwise, a deposit is taken proportional to the size of the preimage.

unnote_preimage - 1

unnote_preimage(hash)

Taking 0.0184 % of a block.

hash: T::Hash

Clear an unrequested preimage from the runtime storage.

If len is provided, then it will be a much cheaper operation.

hash: The hash of the preimage to be removed from the store.
len: The length of the preimage of hash.

request_preimage - 2

request_preimage(hash)

Taking 0.0129 % of a block.

hash: T::Hash

Request a preimage be uploaded to the chain without paying any fees or deposits.

If the preimage requests has already been provided on-chain, we unreserve any deposit a user may have paid, and take the control of the preimage out of their hands.

unrequest_preimage - 3

unrequest_preimage(hash)

Taking 0.0184 % of a block.

hash: T::Hash

Clear a previously made request for a preimage.

NOTE: THIS MUST NOT BE CALLED ON hash MORE TIMES THAN request_preimage.

ensure_updated - 4

ensure_updated(hashes)

Taking 19.3634 % of a block.

hashes: Vec<T::Hash>

Ensure that the a bulk of pre-images is upgraded.

The caller pays no fee if at least 90% of pre-images were successfully updated.

TechnicalCommittee - 23

execute - 1

execute(proposal, length_bound)

Taking 0.0061 % of a block.

proposal: Box<<T as Config<I>>::Proposal>
length_bound: u32

Dispatch a proposal from a member using the Member origin.

Origin must be a member of the collective.

Complexity:

O(B + M + P) where:
B is proposal size in bytes (length-fee-bounded)
M members-count (code-bounded)
P complexity of dispatching proposal

propose - 2

propose(threshold, proposal, length_bound)

No weight available.

threshold: MemberCount
proposal: Box<<T as Config<I>>::Proposal>
length_bound: u32

Add a new proposal to either be voted on or executed directly.

Requires the sender to be member.

threshold determines whether proposal is executed directly (threshold < 2) or put up for voting.

Complexity

O(B + M + P1) or O(B + M + P2) where:
- B is proposal size in bytes (length-fee-bounded)
- M is members-count (code- and governance-bounded)
- branching is influenced by threshold where:
  - P1 is proposal execution complexity (threshold < 2)
  - P2 is proposals-count (code-bounded) (threshold >= 2)

vote - 3

vote(proposal, index, approve)

Taking 0.0129 % of a block.

proposal: T::Hash
index: ProposalIndex
approve: bool

Add an aye or nay vote for the sender to the given proposal.

Requires the sender to be a member.

Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee. Complexity

O(M) where M is members-count (code- and governance-bounded)

close - 6

close(proposal_hash, index, proposal_weight_bound, length_bound)

No weight available.

proposal_hash: T::Hash
index: ProposalIndex
proposal_weight_bound: Weight
length_bound: u32

Close a vote that is either approved, disapproved or whose voting period has ended.

May be called by any signed account in order to finish voting and close the proposal.

If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.

If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.

proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal.
length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

Complexity

O(B + M + P1 + P2) where:
- B is proposal size in bytes (length-fee-bounded)
- M is members-count (code- and governance-bounded)
- P1 is the complexity of proposal preimage.
- P2 is proposal-count (code-bounded)

UniversalDividend - 30

claim_uds - 0

claim_uds()

Taking 0.0218 % of a block.

Claim Universal Dividends.

transfer_ud - 1

transfer_ud(dest, value)

Taking 0.021 % of a block.

dest: <T::Lookup as StaticLookup>::Source
value: BalanceOf<T>

Transfer some liquid free balance to another account, in milliUD.

transfer_ud_keep_alive - 2

transfer_ud_keep_alive(dest, value)

Taking 0.0135 % of a block.

dest: <T::Lookup as StaticLookup>::Source
value: BalanceOf<T>

Transfer some liquid free balance to another account in milliUD and keep the account alive.

Identity - 41

create_identity - 0

create_identity(owner_key)

Taking 0.0856 % of a block.

owner_key: T::AccountId

Create an identity for an existing account

owner_key: the public key corresponding to the identity to be created

The origin must be allowed to create an identity.

confirm_identity - 1

confirm_identity(idty_name)

Taking 0.0327 % of a block.

idty_name: IdtyName

Confirm the creation of an identity and give it a name

idty_name: the name uniquely associated to this identity. Must match the validation rules defined by the runtime.

The identity must have been created using create_identity before it can be confirmed.

change_owner_key - 3

change_owner_key(new_key, new_key_sig)

Taking 0.0424 % of a block.

new_key: T::AccountId
new_key_sig: T::Signature

Change identity owner key.

new_key: the new owner key.
new_key_sig: the signature of the encoded form of IdtyIndexAccountIdPayload. Must be signed by new_key.

The origin should be the old identity owner key.

revoke_identity - 4

revoke_identity(idty_index, revocation_key, revocation_sig)

Taking 0.0399 % of a block.

idty_index: T::IdtyIndex
revocation_key: T::AccountId
revocation_sig: T::Signature

Revoke an identity using a revocation signature

idty_index: the index of the identity to be revoked.
revocation_key: the key used to sign the revocation payload.
revocation_sig: the signature of the encoded form of RevocationPayload. Must be signed by revocation_key.

Any signed origin can execute this call.

fix_sufficients - 7

fix_sufficients(owner_key, inc)

Taking 0.0113 % of a block.

owner_key: T::AccountId
inc: bool

Change sufficient reference count for a given key.

This function allows a privileged root origin to increment or decrement the sufficient reference count associated with a specified owner key.

origin - The origin of the call. It must be root.
owner_key - The account whose sufficient reference count will be modified.
inc - A boolean indicating whether to increment (true) or decrement (false) the count.

link_account - 8

link_account(account_id, payload_sig)

Taking 0.0155 % of a block.

account_id: T::AccountId
payload_sig: T::Signature

Link an account to an identity.

This function links a specified account to an identity, requiring both the account and the identity to sign the operation.

origin - The origin of the call, which must have an associated identity index.
account_id - The account ID to link, which must sign the payload.
payload_sig - The signature with the linked identity.

Certification - 43

add_cert - 0

add_cert(receiver)

Taking 0.0356 % of a block.

receiver: T::IdtyIndex

Add a new certification.

renew_cert - 3

renew_cert(receiver)

Taking 0.0292 % of a block.

receiver: T::IdtyIndex

Renew an existing certification.

del_cert - 1

del_cert(issuer, receiver)

Taking 0.0257 % of a block.

issuer: T::IdtyIndex
receiver: T::IdtyIndex

Remove one certification given the issuer and the receiver.

origin: Must be Root.

remove_all_certs_received_by - 2

remove_all_certs_received_by(idty_index)

Taking 6.846 % of a block.

idty_index: T::IdtyIndex

Remove all certifications received by an identity.

origin: Must be Root.

Distance - 44

request_distance_evaluation - 0

request_distance_evaluation()

Taking 0.0389 % of a block.

Request evaluation of the caller's identity distance.

This function allows the caller to request an evaluation of their distance. A positive evaluation will lead to claiming or renewing membership, while a negative evaluation will result in slashing for the caller.

request_distance_evaluation_for - 4

request_distance_evaluation_for(target)

Taking 0.0399 % of a block.

target: T::IdtyIndex

Request evaluation of a target identity's distance.

This function allows the caller to request an evaluation of a specific target identity's distance. This action is only permitted for unvalidated identities.

update_evaluation - 1

update_evaluation(computation_result)

Taking 0.0341 % of a block.

computation_result: ComputationResult

Push an evaluation result to the pool.

This inherent function is called internally by validators to push an evaluation result to the evaluation pool.

force_update_evaluation - 2

force_update_evaluation(evaluator, computation_result)

Taking 0.0192 % of a block.

evaluator: <T as frame_system::Config>::AccountId
computation_result: ComputationResult

Force push an evaluation result to the pool.

It is primarily used for testing purposes.

origin: Must be Root.

force_valid_distance_status - 3

force_valid_distance_status(identity)

Taking 0.027 % of a block.

identity: <T as pallet_identity::Config>::IdtyIndex

Force set the distance evaluation status of an identity.

It is primarily used for testing purposes.

origin: Must be Root.

AtomicSwap - 50

create_swap - 0

create_swap(target, hashed_proof, action, duration)

No weight available.

target: T::AccountId
hashed_proof: HashedProof
action: T::SwapAction
duration: BlockNumberFor<T>

Register a new atomic swap, declaring an intention to send funds from origin to target on the current blockchain. The target can claim the fund using the revealed proof. If the fund is not claimed after duration blocks, then the sender can cancel the swap.

The dispatch origin for this call must be Signed.

target: Receiver of the atomic swap.
hashed_proof: The blake2_256 hash of the secret proof.
balance: Funds to be sent from origin.
duration: Locked duration of the atomic swap. For safety reasons, it is recommended that the revealer uses a shorter duration than the counterparty, to prevent the situation where the revealer reveals the proof too late around the end block.

claim_swap - 1

claim_swap(proof, action)

No weight available.

proof: Vec<u8>
action: T::SwapAction

Claim an atomic swap.

The dispatch origin for this call must be Signed.

proof: Revealed proof of the claim.
action: Action defined in the swap, it must match the entry in blockchain. Otherwise the operation fails. This is used for weight calculation.

cancel_swap - 2

cancel_swap(target, hashed_proof)

No weight available.

target: T::AccountId
hashed_proof: HashedProof

Cancel an atomic swap. Only possible after the originally set duration has passed.

The dispatch origin for this call must be Signed.

target: Target of the original atomic swap.
hashed_proof: Hashed proof of the original atomic swap.

Multisig - 51

as_multi_threshold_1 - 0

as_multi_threshold_1(other_signatories, call)

Taking 0.005 % of a block.

other_signatories: Vec<T::AccountId>
call: Box<<T as Config>::RuntimeCall>

Immediately dispatch a multi-signature call using a single approval from the caller.

The dispatch origin for this call must be Signed.

other_signatories: The accounts (other than the sender) who are part of the multi-signature, but do not participate in the approval process.
call: The call to be executed.

Result is equivalent to the dispatched result.

Complexity O(Z + C) where Z is the length of the call and C its execution weight.

as_multi - 1

as_multi(threshold, other_signatories, maybe_timepoint, call, max_weight)

No weight available.

threshold: u16
other_signatories: Vec<T::AccountId>
maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>
call: Box<<T as Config>::RuntimeCall>
max_weight: Weight

Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

If there are enough, then dispatch the call.

Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

The dispatch origin for this call must be Signed.

threshold: The total number of approvals for this dispatch before it is executed.
other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.
call: The call to be executed.

NOTE: Unless this is the final approval, you will generally want to use approve_as_multi instead, since it only requires a hash of the call.

Result is equivalent to the dispatched result if threshold is exactly 1. Otherwise on success, result is Ok and the result from the interior call, if it was executed, may be found in the deposited MultisigExecuted event.

Complexity

O(S + Z + Call).
Up to one balance-reserve or unreserve operation.
One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
One call encode & hash, both of complexity O(Z) where Z is tx-len.
One encode & hash, both of complexity O(S).
Up to one binary search and insert (O(logS + S)).
I/O: 1 read O(S), up to 1 mutate O(S). Up to one remove.
One event.
The weight of the call.
Storage: inserts one item, value size bounded by MaxSignatories, with a deposit taken for its lifetime of DepositBase + threshold * DepositFactor.

approve_as_multi - 2

approve_as_multi(threshold, other_signatories, maybe_timepoint, call_hash, max_weight)

No weight available.

threshold: u16
other_signatories: Vec<T::AccountId>
maybe_timepoint: Option<Timepoint<BlockNumberFor<T>>>
call_hash: [u8; 32]
max_weight: Weight

Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

The dispatch origin for this call must be Signed.

threshold: The total number of approvals for this dispatch before it is executed.
other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.
call_hash: The hash of the call to be executed.

NOTE: If this is the final approval, you will want to use as_multi instead.

Complexity

O(S).
Up to one balance-reserve or unreserve operation.
One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
One encode & hash, both of complexity O(S).
Up to one binary search and insert (O(logS + S)).
I/O: 1 read O(S), up to 1 mutate O(S). Up to one remove.
One event.
Storage: inserts one item, value size bounded by MaxSignatories, with a deposit taken for its lifetime of DepositBase + threshold * DepositFactor.

cancel_as_multi - 3

cancel_as_multi(threshold, other_signatories, timepoint, call_hash)

Taking 0.0123 % of a block.

threshold: u16
other_signatories: Vec<T::AccountId>
timepoint: Timepoint<BlockNumberFor<T>>
call_hash: [u8; 32]

Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously for this operation will be unreserved on success.

The dispatch origin for this call must be Signed.

threshold: The total number of approvals for this dispatch before it is executed.
other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.
timepoint: The timepoint (block number and transaction index) of the first approval transaction for this dispatch.
call_hash: The hash of the call to be executed.

Complexity

O(S).
Up to one balance-reserve or unreserve operation.
One passthrough operation, one insert, both O(S) where S is the number of signatories. S is capped by MaxSignatories, with weight being proportional.
One encode & hash, both of complexity O(S).
One event.
I/O: 1 read O(S), one remove.
Storage: removes one item.

ProvideRandomness - 52

request - 0

request(randomness_type, salt)

Taking 0.0404 % of a block.

randomness_type: RandomnessType
salt: H256

Request randomness.

Proxy - 53

proxy - 0

proxy(real, force_proxy_type, call)

Taking 0.0062 % of a block.

real: AccountIdLookupOf<T>
force_proxy_type: Option<T::ProxyType>
call: Box<<T as Config>::RuntimeCall>

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.

add_proxy - 1

add_proxy(delegate, proxy_type, delay)

Taking 0.0121 % of a block.

delegate: AccountIdLookupOf<T>
proxy_type: T::ProxyType
delay: BlockNumberFor<T>

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.

remove_proxy - 2

remove_proxy(delegate, proxy_type, delay)

Taking 0.0121 % of a block.

delegate: AccountIdLookupOf<T>
proxy_type: T::ProxyType
delay: BlockNumberFor<T>

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.

remove_proxies - 3

remove_proxies()

Taking 0.012 % of a block.

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.

create_pure - 4

create_pure(proxy_type, delay, index)

Taking 0.0121 % of a block.

proxy_type: T::ProxyType
delay: BlockNumberFor<T>
index: u16

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_pure - 5

kill_pure(spawner, proxy_type, index, height, ext_index)

Taking 0.012 % of a block.

spawner: AccountIdLookupOf<T>
proxy_type: T::ProxyType
index: u16
height: BlockNumberFor<T>
ext_index: u32

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.

announce - 6

announce(real, call_hash)

Taking 0.0199 % of a block.

real: AccountIdLookupOf<T>
call_hash: CallHashOf<T>

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

remove_announcement(real, call_hash)

Taking 0.0186 % of a block.

real: AccountIdLookupOf<T>
call_hash: CallHashOf<T>

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

reject_announcement(delegate, call_hash)

Taking 0.0186 % of a block.

delegate: AccountIdLookupOf<T>
call_hash: CallHashOf<T>

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

proxy_announced(delegate, real, force_proxy_type, call)

Taking 0.02 % of a block.

delegate: AccountIdLookupOf<T>
real: AccountIdLookupOf<T>
force_proxy_type: Option<T::ProxyType>
call: Box<<T as Config>::RuntimeCall>

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 - 54

batch - 0

batch(calls)

Taking 0.1149 % of a block.

calls: Vec<<T as Config>::RuntimeCall>

Send a batch of dispatch calls.

May be called from any origin except None.

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 the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

O(C) where C is the number of calls to be batched.

This will return Ok in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterrupted event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompleted event is deposited.

as_derivative - 1

as_derivative(index, call)

Taking 0.0047 % of a block.

index: u16
call: Box<<T as Config>::RuntimeCall>

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

batch_all(calls)

Taking 0.1241 % of a block.

calls: Vec<<T as Config>::RuntimeCall>

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 except None.

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 the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

O(C) where C is the number of calls to be batched.

force_batch - 4

force_batch(calls)

Taking 0.1155 % of a block.

calls: Vec<<T as Config>::RuntimeCall>

Send a batch of dispatch calls. Unlike batch, it allows errors and won't interrupt.

May be called from any origin except None.

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 the calls are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

O(C) where C is the number of calls to be batched.

with_weight - 5

with_weight(call, weight)

No weight available.

call: Box<<T as Config>::RuntimeCall>
weight: Weight

Dispatch a function call with a specified weight.

This function does not check the weight of the call, and instead allows the Root origin to specify the weight of the call.

The dispatch origin for this call must be Root.

Treasury - 55

spend_local - 3

spend_local(amount, beneficiary)

Taking 0.0045 % of a block.

amount: BalanceOf<T, I>
beneficiary: AccountIdLookupOf<T>

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be [Config::SpendOrigin] with the Success value being at least amount.

Details

NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the beneficiary.

Parameters

amount: The amount to be transferred from the treasury to the beneficiary.
beneficiary: The destination account for the transfer.

Events

Emits [Event::SpendApproved] if successful.

remove_approval - 4

remove_approval(proposal_id)

Taking 0.0056 % of a block.

proposal_id: ProposalIndex

Force a previously approved proposal to be removed from the approval queue.

Dispatch Origin

Must be [Config::RejectOrigin].

Details

The original deposit will no longer be returned.

Parameters

proposal_id: The index of a proposal

#Complexity

O(A) where A is the number of approvals

Errors

[Error::ProposalNotApproved]: The proposal_id supplied was not found in the approval queue, i.e., the proposal has not been approved. This could also mean the proposal does not exist altogether, thus there is no way it would have been approved in the first place.

spend - 5

spend(asset_kind, amount, beneficiary, valid_from)

Taking 0.0045 % of a block.

asset_kind: Box<T::AssetKind>
amount: AssetBalanceOf<T, I>
beneficiary: Box<BeneficiaryLookupOf<T, I>>
valid_from: Option<BlockNumberFor<T>>

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be [Config::SpendOrigin] with the Success value being at least amount of asset_kind in the native asset. The amount of asset_kind is converted for assertion using the [Config::BalanceConverter].

Details

Create an approved spend for transferring a specific amount of asset_kind to a designated beneficiary. The spend must be claimed using the payout dispatchable within the [Config::PayoutPeriod].

Parameters

asset_kind: An indicator of the specific asset class to be spent.
amount: The amount to be transferred from the treasury to the beneficiary.
beneficiary: The beneficiary of the spend.
valid_from: The block number from which the spend can be claimed. It can refer to the past if the resulting spend has not yet expired according to the [Config::PayoutPeriod]. If None, the spend can be claimed immediately after approval.

Events

Emits [Event::AssetSpendApproved] if successful.

payout - 6

payout(index)

Taking 0.0057 % of a block.

index: SpendIndex

Claim a spend.

Dispatch Origin

Must be signed

Details

Spends must be claimed within some temporal bounds. A spend may be claimed within one [Config::PayoutPeriod] from the valid_from block. In case of a payout failure, the spend status must be updated with the check_status dispatchable before retrying with the current function.

Parameters

index: The spend index.

Events

Emits [Event::Paid] if successful.

check_status - 7

check_status(index)

Taking 0.0057 % of a block.

index: SpendIndex

Check the status of the spend and remove it from the storage if processed.

Dispatch Origin

Must be signed.

Details

The status check is a prerequisite for retrying a failed payout. If a spend has either succeeded or expired, it is removed from the storage by this function. In such instances, transaction fees are refunded.

Parameters

index: The spend index.

Events

Emits [Event::PaymentFailed] if the spend payout has failed. Emits [Event::SpendProcessed] if the spend payout has succeed.

void_spend - 8

void_spend(index)

Taking 0.0057 % of a block.

index: SpendIndex

Void previously approved spend.

Dispatch Origin

Must be [Config::RejectOrigin].

Details

A spend void is only possible if the payout has not been attempted yet.

Parameters

index: The spend index.

Events

Emits [Event::AssetSpendVoided] if successful.

Root calls

There are 18 root calls from 8 pallets.

System - 0

set_heap_pages - 1

set_heap_pages(pages)

Taking 0.0165 % of a block.

pages: u64

Set the number of pages in the WebAssembly environment's heap.

set_code - 2

set_code(code)

Taking 3.9234 % of a block.

code: Vec<u8>

Set the new runtime code.

set_code_without_checks - 3

set_code_without_checks(code)

No weight available.

code: Vec<u8>

Set the new runtime code without doing any checks of the given code.

Note that runtime upgrades will not run if this is called with a not-increasing spec version!

set_storage - 4

set_storage(items)

Taking 5.4867 % of a block.

items: Vec<KeyValue>

Set some items of storage.

kill_storage - 5

kill_storage(keys)

Taking 5.4797 % of a block.

keys: Vec<Key>

Kill some items from storage.

kill_prefix - 6

kill_prefix(prefix, subkeys)

Taking 6.4024 % of a block.

prefix: Key
subkeys: u32

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.

authorize_upgrade - 9

authorize_upgrade(code_hash)

Taking 0.0105 % of a block.

code_hash: T::Hash

Authorize an upgrade to a given code_hash for the runtime. The runtime can be supplied later.

This call requires Root origin.

authorize_upgrade_without_checks - 10

authorize_upgrade_without_checks(code_hash)

No weight available.

code_hash: T::Hash

Authorize an upgrade to a given code_hash for the runtime. The runtime can be supplied later.

WARNING: This authorizes an upgrade that will take place without any safety checks, for example that the spec name remains the same and that the version number increases. Not recommended for normal use. Use authorize_upgrade instead.

This call requires Root origin.

apply_authorized_upgrade - 11

apply_authorized_upgrade(code)

Taking 4.1629 % of a block.

code: Vec<u8>

Provide the preimage (runtime binary) code for an upgrade that has been authorized.

If the authorization required a version check, this call will ensure the spec name remains unchanged and that the spec version has increased.

Depending on the runtime's OnSetCode configuration, this function may directly apply the new code in the same block or attempt to schedule the upgrade.

All origins are allowed.

Babe - 3

plan_config_change - 2

plan_config_change(config)

No weight available.

config: NextConfigDescriptor

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

force_transfer - 2

force_transfer(source, dest, value)

Taking 0.0262 % of a block.

source: AccountIdLookupOf<T>
dest: AccountIdLookupOf<T>
value: T::Balance

Exactly as transfer_allow_death, except the origin must be root and the source account may be specified.

force_unreserve - 5

force_unreserve(who, amount)

Taking 0.0117 % of a block.

who: AccountIdLookupOf<T>
amount: T::Balance

Unreserve some balance from a user by force.

Can only be called by ROOT.

AuthorityMembers - 11

remove_member - 3

remove_member(member_id)

Taking 0.0665 % of a block.

member_id: T::MemberId

Remove a member from the set of validators.

Grandpa - 16

note_stalled - 2

note_stalled(delay, best_finalized_block_number)

No weight available.

delay: BlockNumberFor<T>
best_finalized_block_number: BlockNumberFor<T>

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.

Only callable by root.

TechnicalCommittee - 23

set_members - 0

set_members(new_members, prime, old_count)

Taking 0.1558 % of a block.

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.

The dispatch of this call must be SetMembersOrigin.

NOTE: Does not enforce the expected MaxMembers limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.

WARNING:

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.

Complexity:

O(MP + N) where:
- M old-members-count (code- and governance-bounded)
- N new-members-count (code- and governance-bounded)
- P proposals-count (code-bounded)

disapprove_proposal - 5

disapprove_proposal(proposal_hash)

Taking 0.0226 % of a block.

proposal_hash: T::Hash

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.

Complexity O(P) where P is the number of max proposals

Identity - 41

prune_item_identities_names - 6

prune_item_identities_names(names)

Taking 5.524 % of a block.

names: Vec<IdtyName>

Remove identity names from storage.

This function allows a privileged root origin to remove multiple identity names from storage in bulk.

origin - The origin of the call. It must be root.
names - A vector containing the identity names to be removed from storage.

Utility - 54

dispatch_as - 3

dispatch_as(as_origin, call)

Taking 0.0048 % of a block.

as_origin: Box<T::PalletsOrigin>
call: Box<<T as Config>::RuntimeCall>

Dispatches a function call with a provided origin.

The dispatch origin for this call must be Root.

Complexity

O(1).

Disabled calls

There are 4 disabled calls from 2 pallets.

System - 0

remark - 0

remark(remark)

Taking 0.0546 % of a block.

remark: Vec<u8>

Make some on-chain remark.

Can be executed by every origin.

remark_with_event - 7

remark_with_event(remark)

Taking 0.2093 % of a block.

remark: Vec<u8>

Make some on-chain remark and emit event.

Session - 15

set_keys - 0

set_keys(keys, proof)

Taking 0.0378 % of a block.

keys: T::Keys
proof: Vec<u8>

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.

Complexity

O(1). Actual cost depends on the number of length of T::Keys::key_ids() which is fixed.

purge_keys - 1

purge_keys()

Taking 0.0336 % of a block.

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

Complexity

O(1) in number of key types. Actual cost depends on the number of length of T::Keys::key_ids() which is fixed.

Files

runtime-calls.md

Latest commit

History

runtime-calls.md

File metadata and controls

Runtime calls

User calls

Account - 1

unlink_identity - 0

Scheduler - 2

schedule - 0

cancel - 1

schedule_named - 2

cancel_named - 3

schedule_after - 4

schedule_named_after - 5

set_retry - 6

set_retry_named - 7

cancel_retry - 8

cancel_retry_named - 9

Babe - 3

report_equivocation - 0

Balances - 6

transfer_allow_death - 0

transfer_keep_alive - 3

transfer_all - 4

force_set_balance - 8

force_adjust_total_issuance - 9

Example

burn - 10

OneshotAccount - 7

create_oneshot_account - 0

consume_oneshot_account - 1

consume_oneshot_account_with_remaining - 2

SmithMembers - 10

invite_smith - 0

accept_invitation - 1

certify_smith - 2

AuthorityMembers - 11

go_offline - 0

go_online - 1

set_session_keys - 2

remove_member_from_blacklist - 4

Grandpa - 16

report_equivocation - 0

UpgradeOrigin - 21

dispatch_as_root_unchecked_weight - 1

Preimage - 22

note_preimage - 0

unnote_preimage - 1

request_preimage - 2

unrequest_preimage - 3

ensure_updated - 4

TechnicalCommittee - 23

execute - 1

propose - 2

vote - 3

close - 6

UniversalDividend - 30

claim_uds - 0

transfer_ud - 1

transfer_ud_keep_alive - 2

Identity - 41

create_identity - 0

confirm_identity - 1

change_owner_key - 3

revoke_identity - 4

fix_sufficients - 7

link_account - 8

Certification - 43

add_cert - 0

renew_cert - 3

del_cert - 1

remove_all_certs_received_by - 2

Distance - 44

request_distance_evaluation - 0

request_distance_evaluation_for - 4

update_evaluation - 1

force_update_evaluation - 2