Skip to content
Snippets Groups Projects
Commit 08d77bf5 authored by Hugo Trentesaux's avatar Hugo Trentesaux
Browse files

update docs 

(was not done in 277)
parent a53ca9fc
No related branches found
No related tags found
1 merge request!272Separate weight by chains
Pipeline #37935 passed
Stage: labels
Stage: quality
Stage: build
Stage: tests
Stage: deploy
Show whitespace changes
Inline Side-by-side
docs/api/runtime-calls.md
+ 83
− 83
View file @ 08d77bf5
......@@ -21,7 +21,7 @@ There are **86** user calls from **21** pallets.
<details><summary><code>unlink_identity()</code></summary>
Taking 0.0111 % of a block.
Taking 0.0115 % of a block.
```rust
```
......@@ -36,7 +36,7 @@ Unlink the identity associated with the account.
<details><summary><code>schedule(when, maybe_periodic, priority, call)</code></summary>
Taking 0.0122 % of a block.
Taking 0.0126 % of a block.
```rust
when: BlockNumberFor<T>
......@@ -53,7 +53,7 @@ Anonymously schedule a task.
<details><summary><code>cancel(when, index)</code></summary>
Taking 0.0232 % of a block.
Taking 0.0246 % of a block.
```rust
when: BlockNumberFor<T>
......@@ -68,7 +68,7 @@ Cancel an anonymously scheduled task.
<details><summary><code>schedule_named(id, when, maybe_periodic, priority, call)</code></summary>
Taking 0.0186 % of a block.
Taking 0.0195 % of a block.
```rust
id: TaskName
......@@ -86,7 +86,7 @@ Schedule a named task.
<details><summary><code>cancel_named(id)</code></summary>
Taking 0.0243 % of a block.
Taking 0.0257 % of a block.
```rust
id: TaskName
......@@ -135,7 +135,7 @@ Schedule a named task after a delay.
<details><summary><code>set_retry(task, retries, period)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0124 % of a block.
```rust
task: TaskAddress<BlockNumberFor<T>>
......@@ -162,7 +162,7 @@ original `total_retries`.
<details><summary><code>set_retry_named(id, retries, period)</code></summary>
Taking 0.0132 % of a block.
Taking 0.0135 % of a block.
```rust
id: TaskName
......@@ -189,7 +189,7 @@ original `total_retries`.
<details><summary><code>cancel_retry(task)</code></summary>
Taking 0.012 % of a block.
Taking 0.0124 % of a block.
```rust
task: TaskAddress<BlockNumberFor<T>>
......@@ -203,7 +203,7 @@ Removes the retry configuration of a task.
<details><summary><code>cancel_retry_named(id)</code></summary>
Taking 0.0131 % of a block.
Taking 0.0135 % of a block.
```rust
id: TaskName
......@@ -239,7 +239,7 @@ be reported.
<details><summary><code>transfer_allow_death(dest, value)</code></summary>
Taking 0.0193 % of a block.
Taking 0.0202 % of a block.
```rust
dest: AccountIdLookupOf<T>
......@@ -260,7 +260,7 @@ The dispatch origin for this call must be `Signed` by the transactor.
<details><summary><code>transfer_keep_alive(dest, value)</code></summary>
Taking 0.0123 % of a block.
Taking 0.0128 % of a block.
```rust
dest: AccountIdLookupOf<T>
......@@ -280,7 +280,7 @@ kill the origin account.
<details><summary><code>transfer_all(dest, keep_alive)</code></summary>
Taking 0.0127 % of a block.
Taking 0.0131 % of a block.
```rust
dest: AccountIdLookupOf<T>
......@@ -376,7 +376,7 @@ this `burn` operation will reduce total issuance by the amount _burned_.
<details><summary><code>create_oneshot_account(dest, value)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0123 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
......@@ -396,7 +396,7 @@ Origin account is kept alive.
<details><summary><code>consume_oneshot_account(block_height, dest)</code></summary>
Taking 0.0192 % of a block.
Taking 0.0202 % of a block.
```rust
block_height: BlockNumberFor<T>
......@@ -415,7 +415,7 @@ Consume a oneshot account and transfer its balance to an account
<details><summary><code>consume_oneshot_account_with_remaining(block_height, dest, remaining_to, balance)</code></summary>
Taking 0.026 % of a block.
Taking 0.0274 % of a block.
```rust
block_height: BlockNumberFor<T>
......@@ -443,7 +443,7 @@ and the remaining amount to another account.
<details><summary><code>invite_smith(receiver)</code></summary>
Taking 0.0228 % of a block.
Taking 0.0237 % of a block.
```rust
receiver: T::IdtyIndex
......@@ -457,7 +457,7 @@ Invite a member of the Web of Trust to attempt becoming a Smith.
<details><summary><code>accept_invitation()</code></summary>
Taking 0.0125 % of a block.
Taking 0.0129 % of a block.
```rust
```
......@@ -470,7 +470,7 @@ Accept an invitation to become a Smith (must have been invited first).
<details><summary><code>certify_smith(receiver)</code></summary>
Taking 0.0271 % of a block.
Taking 0.0283 % of a block.
```rust
receiver: T::IdtyIndex
......@@ -486,7 +486,7 @@ Certify an invited Smith, which can lead the certified to become a Smith.
<details><summary><code>go_offline()</code></summary>
Taking 0.0163 % of a block.
Taking 0.0167 % of a block.
```rust
```
......@@ -499,7 +499,7 @@ Request to leave the set of validators two sessions later.
<details><summary><code>go_online()</code></summary>
Taking 0.0183 % of a block.
Taking 0.0187 % of a block.
```rust
```
......@@ -512,7 +512,7 @@ Request to join the set of validators two sessions later.
<details><summary><code>set_session_keys(keys)</code></summary>
Taking 0.024 % of a block.
Taking 0.0249 % of a block.
```rust
keys: T::Keys
......@@ -526,7 +526,7 @@ Declare new session keys to replace current ones.
<details><summary><code>remove_member_from_blacklist(member_id)</code></summary>
Taking 0.0113 % of a block.
Taking 0.0117 % of a block.
```rust
member_id: T::MemberId
......@@ -584,7 +584,7 @@ The weight of this call is defined by the caller.
<details><summary><code>note_preimage(bytes)</code></summary>
Taking 0.2969 % of a block.
Taking 0.3146 % of a block.
```rust
bytes: Vec<u8>
......@@ -601,7 +601,7 @@ the preimage. Otherwise, a deposit is taken proportional to the size of the prei
<details><summary><code>unnote_preimage(hash)</code></summary>
Taking 0.0183 % of a block.
Taking 0.0193 % of a block.
```rust
hash: T::Hash
......@@ -620,7 +620,7 @@ If `len` is provided, then it will be a much cheaper operation.
<details><summary><code>request_preimage(hash)</code></summary>
Taking 0.013 % of a block.
Taking 0.0135 % of a block.
```rust
hash: T::Hash
......@@ -637,7 +637,7 @@ a user may have paid, and take the control of the preimage out of their hands.
<details><summary><code>unrequest_preimage(hash)</code></summary>
Taking 0.0182 % of a block.
Taking 0.0191 % of a block.
```rust
hash: T::Hash
......@@ -653,7 +653,7 @@ NOTE: THIS MUST NOT BE CALLED ON `hash` MORE TIMES THAN `request_preimage`.
<details><summary><code>ensure_updated(hashes)</code></summary>
Taking 18.57 % of a block.
Taking 20.0151 % of a block.
```rust
hashes: Vec<T::Hash>
......@@ -671,7 +671,7 @@ The caller pays no fee if at least 90% of pre-images were successfully updated.
<details><summary><code>execute(proposal, length_bound)</code></summary>
Taking 0.0063 % of a block.
Taking 0.0062 % of a block.
```rust
proposal: Box<<T as Config<I>>::Proposal>
......@@ -723,7 +723,7 @@ or put up for voting.
<details><summary><code>vote(proposal, index, approve)</code></summary>
Taking 0.0127 % of a block.
Taking 0.0131 % of a block.
```rust
proposal: T::Hash
......@@ -789,7 +789,7 @@ proposal.
<details><summary><code>claim_uds()</code></summary>
Taking 0.0211 % of a block.
Taking 0.022 % of a block.
```rust
```
......@@ -802,7 +802,7 @@ Claim Universal Dividends.
<details><summary><code>transfer_ud(dest, value)</code></summary>
Taking 0.0204 % of a block.
Taking 0.0213 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
......@@ -817,7 +817,7 @@ Transfer some liquid free balance to another account, in milliUD.
<details><summary><code>transfer_ud_keep_alive(dest, value)</code></summary>
Taking 0.0133 % of a block.
Taking 0.0138 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
......@@ -834,7 +834,7 @@ Transfer some liquid free balance to another account in milliUD and keep the acc
<details><summary><code>create_identity(owner_key)</code></summary>
Taking 0.0823 % of a block.
Taking 0.0878 % of a block.
```rust
owner_key: T::AccountId
......@@ -852,7 +852,7 @@ The origin must be allowed to create an identity.
<details><summary><code>confirm_identity(idty_name)</code></summary>
Taking 0.0316 % of a block.
Taking 0.0334 % of a block.
```rust
idty_name: IdtyName
......@@ -870,7 +870,7 @@ The identity must have been created using `create_identity` before it can be con
<details><summary><code>change_owner_key(new_key, new_key_sig)</code></summary>
Taking 0.04 % of a block.
Taking 0.0422 % of a block.
```rust
new_key: T::AccountId
......@@ -891,7 +891,7 @@ The origin should be the old identity owner key.
<details><summary><code>revoke_identity(idty_index, revocation_key, revocation_sig)</code></summary>
Taking 0.0386 % of a block.
Taking 0.0408 % of a block.
```rust
idty_index: T::IdtyIndex
......@@ -914,7 +914,7 @@ Any signed origin can execute this call.
<details><summary><code>fix_sufficients(owner_key, inc)</code></summary>
Taking 0.0113 % of a block.
Taking 0.0117 % of a block.
```rust
owner_key: T::AccountId
......@@ -937,7 +937,7 @@ reference count associated with a specified owner key.
<details><summary><code>link_account(account_id, payload_sig)</code></summary>
Taking 0.0153 % of a block.
Taking 0.0156 % of a block.
```rust
account_id: T::AccountId
......@@ -961,7 +961,7 @@ identity to sign the operation.
<details><summary><code>add_cert(receiver)</code></summary>
Taking 0.0343 % of a block.
Taking 0.0362 % of a block.
```rust
receiver: T::IdtyIndex
......@@ -975,7 +975,7 @@ Add a new certification.
<details><summary><code>renew_cert(receiver)</code></summary>
Taking 0.0282 % of a block.
Taking 0.0296 % of a block.
```rust
receiver: T::IdtyIndex
......@@ -989,7 +989,7 @@ Renew an existing certification.
<details><summary><code>del_cert(issuer, receiver)</code></summary>
Taking 0.0248 % of a block.
Taking 0.0262 % of a block.
```rust
issuer: T::IdtyIndex
......@@ -1006,7 +1006,7 @@ Remove one certification given the issuer and the receiver.
<details><summary><code>remove_all_certs_received_by(idty_index)</code></summary>
Taking 6.5528 % of a block.
Taking 7.0144 % of a block.
```rust
idty_index: T::IdtyIndex
......@@ -1024,7 +1024,7 @@ Remove all certifications received by an identity.
<details><summary><code>request_distance_evaluation()</code></summary>
Taking 0.0373 % of a block.
Taking 0.0393 % of a block.
```rust
```
......@@ -1041,7 +1041,7 @@ evaluation will result in slashing for the caller.
<details><summary><code>request_distance_evaluation_for(target)</code></summary>
Taking 0.0383 % of a block.
Taking 0.0403 % of a block.
```rust
target: T::IdtyIndex
......@@ -1058,7 +1058,7 @@ This action is only permitted for unvalidated identities.
<details><summary><code>update_evaluation(computation_result)</code></summary>
Taking 0.0332 % of a block.
Taking 0.0349 % of a block.
```rust
computation_result: ComputationResult
......@@ -1075,7 +1075,7 @@ to the evaluation pool.
<details><summary><code>force_update_evaluation(evaluator, computation_result)</code></summary>
Taking 0.0188 % of a block.
Taking 0.0194 % of a block.
```rust
evaluator: <T as frame_system::Config>::AccountId
......@@ -1094,7 +1094,7 @@ It is primarily used for testing purposes.
<details><summary><code>force_valid_distance_status(identity)</code></summary>
Taking 0.0262 % of a block.
Taking 0.0275 % of a block.
```rust
identity: <T as pallet_identity::Config>::IdtyIndex
......@@ -1314,7 +1314,7 @@ NOTE: If this is the final approval, you will want to use `as_multi` instead.
<details><summary><code>cancel_as_multi(threshold, other_signatories, timepoint, call_hash)</code></summary>
Taking 0.0122 % of a block.
Taking 0.0126 % of a block.
```rust
threshold: u16
......@@ -1353,7 +1353,7 @@ transaction for this dispatch.
<details><summary><code>request(randomness_type, salt)</code></summary>
Taking 0.039 % of a block.
Taking 0.0413 % of a block.
```rust
randomness_type: RandomnessType
......@@ -1394,7 +1394,7 @@ Parameters:
<details><summary><code>add_proxy(delegate, proxy_type, delay)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0124 % of a block.
```rust
delegate: AccountIdLookupOf<T>
......@@ -1418,7 +1418,7 @@ zero.
<details><summary><code>remove_proxy(delegate, proxy_type, delay)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0124 % of a block.
```rust
delegate: AccountIdLookupOf<T>
......@@ -1440,7 +1440,7 @@ Parameters:
<details><summary><code>remove_proxies()</code></summary>
Taking 0.0118 % of a block.
Taking 0.0123 % of a block.
```rust
```
......@@ -1458,7 +1458,7 @@ the unreserved fees will be inaccessible. **All access to this account will be l
<details><summary><code>create_pure(proxy_type, delay, index)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0124 % of a block.
```rust
proxy_type: T::ProxyType
......@@ -1491,7 +1491,7 @@ Fails if there are insufficient funds to pay for deposit.
<details><summary><code>kill_pure(spawner, proxy_type, index, height, ext_index)</code></summary>
Taking 0.0119 % of a block.
Taking 0.0123 % of a block.
```rust
spawner: AccountIdLookupOf<T>
......@@ -1524,7 +1524,7 @@ account whose `pure` call has corresponding parameters.
<details><summary><code>announce(real, call_hash)</code></summary>
Taking 0.0194 % of a block.
Taking 0.0204 % of a block.
```rust
real: AccountIdLookupOf<T>
......@@ -1553,7 +1553,7 @@ Parameters:
<details><summary><code>remove_announcement(real, call_hash)</code></summary>
Taking 0.0182 % of a block.
Taking 0.0192 % of a block.
```rust
real: AccountIdLookupOf<T>
......@@ -1577,7 +1577,7 @@ Parameters:
<details><summary><code>reject_announcement(delegate, call_hash)</code></summary>
Taking 0.0182 % of a block.
Taking 0.0191 % of a block.
```rust
delegate: AccountIdLookupOf<T>
......@@ -1601,7 +1601,7 @@ Parameters:
<details><summary><code>proxy_announced(delegate, real, force_proxy_type, call)</code></summary>
Taking 0.0196 % of a block.
Taking 0.0205 % of a block.
```rust
delegate: AccountIdLookupOf<T>
......@@ -1630,7 +1630,7 @@ Parameters:
<details><summary><code>batch(calls)</code></summary>
Taking 0.1072 % of a block.
Taking 0.1113 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
......@@ -1661,7 +1661,7 @@ event is deposited.
<details><summary><code>as_derivative(index, call)</code></summary>
Taking 0.005 % of a block.
Taking 0.0049 % of a block.
```rust
index: u16
......@@ -1688,7 +1688,7 @@ The dispatch origin for this call must be _Signed_.
<details><summary><code>batch_all(calls)</code></summary>
Taking 0.1159 % of a block.
Taking 0.1269 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
......@@ -1714,7 +1714,7 @@ includes bypassing `frame_system::Config::BaseCallFilter`).
<details><summary><code>force_batch(calls)</code></summary>
Taking 0.1072 % of a block.
Taking 0.1163 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
......@@ -1869,7 +1869,7 @@ Emits [`Event::AssetSpendApproved`] if successful.
<details><summary><code>payout(index)</code></summary>
Taking 0.0252 % of a block.
Taking 0.0265 % of a block.
```rust
index: SpendIndex
......@@ -1901,7 +1901,7 @@ Emits [`Event::Paid`] if successful.
<details><summary><code>check_status(index)</code></summary>
Taking 0.0114 % of a block.
Taking 0.0118 % of a block.
```rust
index: SpendIndex
......@@ -1933,7 +1933,7 @@ Emits [`Event::SpendProcessed`] if the spend payout has succeed.
<details><summary><code>void_spend(index)</code></summary>
Taking 0.0113 % of a block.
Taking 0.0118 % of a block.
```rust
index: SpendIndex
......@@ -1970,7 +1970,7 @@ There are **18** root calls from **8** pallets.
<details><summary><code>set_heap_pages(pages)</code></summary>
Taking 0.0163 % of a block.
Taking 0.0172 % of a block.
```rust
pages: u64
......@@ -1984,7 +1984,7 @@ Set the number of pages in the WebAssembly environment's heap.
<details><summary><code>set_code(code)</code></summary>
Taking 3.9928 % of a block.
Taking 4.3548 % of a block.
```rust
code: Vec<u8>
......@@ -2015,7 +2015,7 @@ version!
<details><summary><code>set_storage(items)</code></summary>
Taking 5.2685 % of a block.
Taking 5.7291 % of a block.
```rust
items: Vec<KeyValue>
......@@ -2029,7 +2029,7 @@ Set some items of storage.
<details><summary><code>kill_storage(keys)</code></summary>
Taking 5.2627 % of a block.
Taking 5.723 % of a block.
```rust
keys: Vec<Key>
......@@ -2043,7 +2043,7 @@ Kill some items from storage.
<details><summary><code>kill_prefix(prefix, subkeys)</code></summary>
Taking 6.1565 % of a block.
Taking 6.6205 % of a block.
```rust
prefix: Key
......@@ -2061,7 +2061,7 @@ the prefix we are removing to accurately calculate the weight of this function.
<details><summary><code>authorize_upgrade(code_hash)</code></summary>
Taking 0.0105 % of a block.
Taking 0.011 % of a block.
```rust
code_hash: T::Hash
......@@ -2099,7 +2099,7 @@ This call requires Root origin.
<details><summary><code>apply_authorized_upgrade(code)</code></summary>
Taking 4.1912 % of a block.
Taking 4.2186 % of a block.
```rust
code: Vec<u8>
......@@ -2142,7 +2142,7 @@ not been enacted yet.
<details><summary><code>force_transfer(source, dest, value)</code></summary>
Taking 0.0255 % of a block.
Taking 0.0269 % of a block.
```rust
source: AccountIdLookupOf<T>
......@@ -2159,7 +2159,7 @@ may be specified.
<details><summary><code>force_unreserve(who, amount)</code></summary>
Taking 0.0115 % of a block.
Taking 0.012 % of a block.
```rust
who: AccountIdLookupOf<T>
......@@ -2178,7 +2178,7 @@ Can only be called by ROOT.
<details><summary><code>remove_member(member_id)</code></summary>
Taking 0.0641 % of a block.
Taking 0.0686 % of a block.
```rust
member_id: T::MemberId
......@@ -2222,7 +2222,7 @@ Only callable by root.
<details><summary><code>set_members(new_members, prime, old_count)</code></summary>
Taking 0.1493 % of a block.
Taking 0.1595 % of a block.
```rust
new_members: Vec<T::AccountId>
......@@ -2261,7 +2261,7 @@ with other logic managing the member set.
<details><summary><code>disapprove_proposal(proposal_hash)</code></summary>
Taking 0.0221 % of a block.
Taking 0.0234 % of a block.
```rust
proposal_hash: T::Hash
......@@ -2286,7 +2286,7 @@ O(P) where P is the number of max proposals
<details><summary><code>prune_item_identities_names(names)</code></summary>
Taking 5.3061 % of a block.
Taking 5.7658 % of a block.
```rust
names: Vec<IdtyName>
......@@ -2308,7 +2308,7 @@ in bulk.
<details><summary><code>dispatch_as(as_origin, call)</code></summary>
Taking 0.0051 % of a block.
Taking 0.005 % of a block.
```rust
as_origin: Box<T::PalletsOrigin>
......@@ -2339,7 +2339,7 @@ There are **4** disabled calls from **2** pallets.
<details><summary><code>remark(remark)</code></summary>
Taking 0.0539 % of a block.
Taking 0.0589 % of a block.
```rust
remark: Vec<u8>
......@@ -2355,7 +2355,7 @@ Can be executed by every `origin`.
<details><summary><code>remark_with_event(remark)</code></summary>
Taking 0.2107 % of a block.
Taking 0.2176 % of a block.
```rust
remark: Vec<u8>
......@@ -2371,7 +2371,7 @@ Make some on-chain remark and emit event.
<details><summary><code>set_keys(keys, proof)</code></summary>
Taking 0.0365 % of a block.
Taking 0.0388 % of a block.
```rust
keys: T::Keys
......@@ -2394,7 +2394,7 @@ The dispatch origin of this function must be signed.
<details><summary><code>purge_keys()</code></summary>
Taking 0.0326 % of a block.
Taking 0.0349 % of a block.
```rust
```
......
docs/api/runtime-errors.md
+ 8
− 1
View file @ 08d77bf5
# Runtime errors
There are **190** errors from **35** pallets.
There are **191** errors from **35** pallets.
<ul>
<li>System - 0
......@@ -986,6 +986,13 @@ Cannot link to an inexisting account.
Insufficient balance to create an identity.
</details>
</li>
<li>
<details>
<summary>
<code>OwnerKeyUsedAsValidator</code> - 18</summary>
Owner key currently used as validator.
</details>
</li>
</ul>
</li>
<li>Membership - 42
......
docs/api/runtime-errors.po
+ 2
− 0
View file @ 08d77bf5
......@@ -254,6 +254,8 @@ msgid "Identity.AccountNotExist"
msgstr "Cannot link to an inexisting account."
msgid "Identity.InsufficientBalance"
msgstr "Insufficient balance to create an identity."
msgid "Identity.OwnerKeyUsedAsValidator"
msgstr "Owner key currently used as validator."
msgid "Membership.MembershipNotFound"
msgstr "Membership not found, can not renew."
msgid "Membership.AlreadyMember"
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment