runtime-calls.md

Runtime calls

Calls are categorized according to the dispatch origin they require:

1. 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.
2. Root calls: This kind of call requires a special origin that can only be invoked through on-chain governance mechanisms.
3. Inherent calls: This kind of call is invoked by the author of the block itself (usually automatically by the node).
4. Disabled calls: These calls can not be called directly, they are reserved for internal use by other runtime calls.

User calls

There are 68 user calls from 21 pallets.

Scheduler - 2

schedule - 0

schedule(when, maybe_periodic, priority, call)

when: T::BlockNumber
maybe_periodic: Option<schedule::Period<T::BlockNumber>>
priority: schedule::Priority
call: Box<CallOrHashOf<T>>

Anonymously schedule a task.

cancel - 1

cancel(when, index)

when: T::BlockNumber
index: u32

Cancel an anonymously scheduled task.

schedule_named - 2

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

id: Vec<u8>
when: T::BlockNumber
maybe_periodic: Option<schedule::Period<T::BlockNumber>>
priority: schedule::Priority
call: Box<CallOrHashOf<T>>

Schedule a named task.

cancel_named - 3

cancel_named(id)

id: Vec<u8>

Cancel a named scheduled task.

schedule_after - 4

schedule_after(after, maybe_periodic, priority, call)

after: T::BlockNumber
maybe_periodic: Option<schedule::Period<T::BlockNumber>>
priority: schedule::Priority
call: Box<CallOrHashOf<T>>

Anonymously schedule a task after a delay.

schedule_named_after - 5

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

id: Vec<u8>
after: T::BlockNumber
maybe_periodic: Option<schedule::Period<T::BlockNumber>>
priority: schedule::Priority
call: Box<CallOrHashOf<T>>

Schedule a named task after a delay.

Babe - 3

report_equivocation - 0

report_equivocation(equivocation_proof, key_owner_proof)

equivocation_proof: Box<EquivocationProof<T::Header>>
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 - 0

transfer(dest, value)

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

Transfer some liquid free balance to another account.

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

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

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

99% of the time you want transfer instead.

transfer_all - 4

transfer_all(dest, keep_alive)

dest: <T::Lookup as StaticLookup>::Source
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). #
• O(1). Just like transfer, but reading the user's transferable balance first. #

OneshotAccount - 7

create_oneshot_account - 0

create_oneshot_account(dest, value)

dest: <T::Lookup as StaticLookup>::Source
value: <T::Currency as Currency<T::AccountId>>::Balance

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)

block_height: T::BlockNumber
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)

block_height: T::BlockNumber
dest: Account<<T::Lookup as StaticLookup>::Source>
remaining_to: Account<<T::Lookup as StaticLookup>::Source>
balance: <T::Currency as Currency<T::AccountId>>::Balance

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.

AuthorityMembers - 10

go_offline - 0

go_offline()

go_online - 1

go_online()

set_session_keys - 2

set_session_keys(keys)

keys: T::KeysWrapper

Grandpa - 15

report_equivocation - 0

report_equivocation(equivocation_proof, key_owner_proof)

equivocation_proof: Box<EquivocationProof<T::Hash, T::BlockNumber>>
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)

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)

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)

hash: T::Hash

Clear an unrequested preimage from the runtime storage.

request_preimage - 2

request_preimage(hash)

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)

hash: T::Hash

Clear a previously made request for a preimage.

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

TechnicalCommittee - 23

execute - 1

execute(proposal, length_bound)

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.

propose - 2

propose(threshold, proposal, length_bound)

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.

vote - 3

vote(proposal, index, approve)

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.

close - 4

close(proposal_hash, index, proposal_weight_bound, length_bound)

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.

UniversalDividend - 30

claim_uds - 0

claim_uds()

Claim Universal Dividends

transfer_ud - 1

transfer_ud(dest, value)

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)

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

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

force_set_first_eligible_ud - 3

force_set_first_eligible_ud(who, first_eligible_ud)

who: T::AccountId
first_eligible_ud: FirstEligibleUd

Identity - 41

create_identity - 0

create_identity(owner_key)

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)

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.

validate_identity - 2

validate_identity(idty_index)

idty_index: T::IdtyIndex

change_owner_key - 3

change_owner_key(new_key, new_key_sig)

new_key: T::AccountId
new_key_sig: T::NewOwnerKeySignature

Change identity owner key.

• new_key: the new owner key.
• new_key_sig: the signature of the encoded form of NewOwnerKeyPayload. 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)

idty_index: T::IdtyIndex
revocation_key: T::AccountId
revocation_sig: T::RevocationSignature

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)

owner_key: T::AccountId
inc: bool

Membership - 42

request_membership - 1

request_membership(metadata)

metadata: T::MetaData

renew_membership - 3

renew_membership(maybe_idty_id)

maybe_idty_id: Option<T::IdtyId>

Cert - 43

add_cert - 1

add_cert(issuer, receiver)

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

Add a new certification or renew an existing one

• receiver: the account receiving the certification from the origin

The origin must be allow to certify.

SmithsMembership - 52

request_membership - 1

request_membership(metadata)

metadata: T::MetaData

renew_membership - 3

renew_membership(maybe_idty_id)

maybe_idty_id: Option<T::IdtyId>

revoke_membership - 4

revoke_membership(maybe_idty_id)

maybe_idty_id: Option<T::IdtyId>

SmithsCert - 53

add_cert - 1

add_cert(issuer, receiver)

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

Add a new certification or renew an existing one

• receiver: the account receiving the certification from the origin

The origin must be allow to certify.

AtomicSwap - 60

create_swap - 0

create_swap(target, hashed_proof, action, duration)

target: T::AccountId
hashed_proof: HashedProof
action: T::SwapAction
duration: T::BlockNumber

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)

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)

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

as_multi_threshold_1 - 0

as_multi_threshold_1(other_signatories, call)

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

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.

as_multi - 1

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

threshold: u16
other_signatories: Vec<T::AccountId>
maybe_timepoint: Option<Timepoint<T::BlockNumber>>
call: OpaqueCall<T>
store_call: bool
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.

approve_as_multi - 2

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

threshold: u16
other_signatories: Vec<T::AccountId>
maybe_timepoint: Option<Timepoint<T::BlockNumber>>
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.

cancel_as_multi - 3

cancel_as_multi(threshold, other_signatories, timepoint, call_hash)

threshold: u16
other_signatories: Vec<T::AccountId>
timepoint: Timepoint<T::BlockNumber>
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.

ProvideRandomness - 62

request - 0

request(randomness_type, salt)

randomness_type: RandomnessType
salt: H256

Request a randomness

Proxy - 63

proxy - 0

proxy(real, force_proxy_type, call)

real: T::AccountId
force_proxy_type: Option<T::ProxyType>
call: Box<<T as Config>::Call>

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 the real account.

add_proxy - 1

add_proxy(delegate, proxy_type, delay)

delegate: T::AccountId
proxy_type: T::ProxyType
delay: T::BlockNumber

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)

delegate: T::AccountId
proxy_type: T::ProxyType
delay: T::BlockNumber

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

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.

anonymous - 4

anonymous(proxy_type, delay, index)

proxy_type: T::ProxyType
delay: T::BlockNumber
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_anonymous - 5

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

spawner: T::AccountId
proxy_type: T::ProxyType
index: u16
height: T::BlockNumber
ext_index: u32

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.