Skip to content
Snippets Groups Projects

Refac generated documentation

Merged Refac generated documentation
183-refac-doc into master
Merged Benjamin Gallois requested to merge 183-refac-doc into master
Viewing commit 0a3950f6
Show latest version
5 files
+ 130
− 88
Compare changes
  • Side-by-side
  • Inline
Files
5
docs/api/runtime-calls.md
+ 97
− 82
@@ -13,7 +13,7 @@ through on-chain governance mechanisms.
## User calls
There are **81** user calls from **21** pallets.
There are **82** user calls from **21** pallets.
### Account - 1
@@ -21,7 +21,7 @@ There are **81** user calls from **21** pallets.
<details><summary><code>unlink_identity()</code></summary>
Taking 0.0113 % of a block.
Taking 0.0114 % of a block.
```rust
```
@@ -36,7 +36,7 @@ See [`Pallet::unlink_identity`].
<details><summary><code>schedule(when, maybe_periodic, priority, call)</code></summary>
Taking 0.013 % of a block.
Taking 0.0125 % of a block.
```rust
when: BlockNumberFor<T>
@@ -53,7 +53,7 @@ See [`Pallet::schedule`].
<details><summary><code>cancel(when, index)</code></summary>
Taking 0.0195 % of a block.
Taking 0.0194 % of a block.
```rust
when: BlockNumberFor<T>
@@ -68,7 +68,7 @@ See [`Pallet::cancel`].
<details><summary><code>schedule_named(id, when, maybe_periodic, priority, call)</code></summary>
Taking 0.0203 % of a block.
Taking 0.0204 % of a block.
```rust
id: TaskName
@@ -154,7 +154,7 @@ See [`Pallet::report_equivocation`].
<details><summary><code>transfer_allow_death(dest, value)</code></summary>
Taking 0.0216 % of a block.
Taking 0.0211 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -169,7 +169,7 @@ See [`Pallet::transfer_allow_death`].
<details><summary><code>transfer_keep_alive(dest, value)</code></summary>
Taking 0.0232 % of a block.
Taking 0.0128 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -184,7 +184,7 @@ See [`Pallet::transfer_keep_alive`].
<details><summary><code>transfer_all(dest, keep_alive)</code></summary>
Taking 0.0184 % of a block.
Taking 0.013 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -210,13 +210,28 @@ new_free: T::Balance
See [`Pallet::force_set_balance`].
#### force_adjust_total_issuance - 9
<details><summary><code>force_adjust_total_issuance(direction, delta)</code></summary>
Taking 0.0038 % of a block.
```rust
direction: AdjustmentDirection
delta: T::Balance
```
</details>
See [`Pallet::force_adjust_total_issuance`].
### OneshotAccount - 7
#### create_oneshot_account - 0
<details><summary><code>create_oneshot_account(dest, value)</code></summary>
Taking 0.0126 % of a block.
Taking 0.012 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -231,7 +246,7 @@ See [`Pallet::create_oneshot_account`].
<details><summary><code>consume_oneshot_account(block_height, dest)</code></summary>
Taking 0.0214 % of a block.
Taking 0.0213 % of a block.
```rust
block_height: BlockNumberFor<T>
@@ -246,7 +261,7 @@ See [`Pallet::consume_oneshot_account`].
<details><summary><code>consume_oneshot_account_with_remaining(block_height, dest, remaining_to, balance)</code></summary>
Taking 0.0295 % of a block.
Taking 0.0294 % of a block.
```rust
block_height: BlockNumberFor<T>
@@ -265,7 +280,7 @@ See [`Pallet::consume_oneshot_account_with_remaining`].
<details><summary><code>invite_smith(receiver)</code></summary>
Taking 0.0265 % of a block.
Taking 0.0267 % of a block.
```rust
receiver: T::IdtyIndex
@@ -279,7 +294,7 @@ See [`Pallet::invite_smith`].
<details><summary><code>accept_invitation()</code></summary>
Taking 0.0133 % of a block.
Taking 0.0132 % of a block.
```rust
```
@@ -292,7 +307,7 @@ See [`Pallet::accept_invitation`].
<details><summary><code>certify_smith(receiver)</code></summary>
Taking 0.0234 % of a block.
Taking 0.0317 % of a block.
```rust
receiver: T::IdtyIndex
@@ -308,7 +323,7 @@ See [`Pallet::certify_smith`].
<details><summary><code>go_offline()</code></summary>
Taking 0.0188 % of a block.
Taking 0.0187 % of a block.
```rust
```
@@ -321,7 +336,7 @@ See [`Pallet::go_offline`].
<details><summary><code>go_online()</code></summary>
Taking 0.0225 % of a block.
Taking 0.0216 % of a block.
```rust
```
@@ -334,7 +349,7 @@ See [`Pallet::go_online`].
<details><summary><code>set_session_keys(keys)</code></summary>
Taking 0.0296 % of a block.
Taking 0.0284 % of a block.
```rust
keys: T::Keys
@@ -348,7 +363,7 @@ See [`Pallet::set_session_keys`].
<details><summary><code>remove_member_from_blacklist(member_id)</code></summary>
Taking 0.0125 % of a block.
Taking 0.0116 % of a block.
```rust
member_id: T::MemberId
@@ -398,7 +413,7 @@ See [`Pallet::dispatch_as_root_unchecked_weight`].
<details><summary><code>note_preimage(bytes)</code></summary>
Taking 0.5106 % of a block.
Taking 0.2881 % of a block.
```rust
bytes: Vec<u8>
@@ -412,7 +427,7 @@ See [`Pallet::note_preimage`].
<details><summary><code>unnote_preimage(hash)</code></summary>
Taking 0.0211 % of a block.
Taking 0.0201 % of a block.
```rust
hash: T::Hash
@@ -440,7 +455,7 @@ See [`Pallet::request_preimage`].
<details><summary><code>unrequest_preimage(hash)</code></summary>
Taking 0.0195 % of a block.
Taking 0.0201 % of a block.
```rust
hash: T::Hash
@@ -454,7 +469,7 @@ See [`Pallet::unrequest_preimage`].
<details><summary><code>ensure_updated(hashes)</code></summary>
Taking 21.0381 % of a block.
Taking 22.9245 % of a block.
```rust
hashes: Vec<T::Hash>
@@ -470,7 +485,7 @@ See [`Pallet::ensure_updated`].
<details><summary><code>execute(proposal, length_bound)</code></summary>
Taking 0.006 % of a block.
Taking 0.0055 % of a block.
```rust
proposal: Box<<T as Config<I>>::Proposal>
@@ -501,7 +516,7 @@ See [`Pallet::propose`].
<details><summary><code>vote(proposal, index, approve)</code></summary>
Taking 0.0144 % of a block.
Taking 0.0135 % of a block.
```rust
proposal: T::Hash
@@ -536,7 +551,7 @@ See [`Pallet::close`].
<details><summary><code>claim_uds()</code></summary>
Taking 0.0224 % of a block.
Taking 0.0242 % of a block.
```rust
```
@@ -549,7 +564,7 @@ See [`Pallet::claim_uds`].
<details><summary><code>transfer_ud(dest, value)</code></summary>
Taking 0.027 % of a block.
Taking 0.0226 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -564,7 +579,7 @@ See [`Pallet::transfer_ud`].
<details><summary><code>transfer_ud_keep_alive(dest, value)</code></summary>
Taking 0.0193 % of a block.
Taking 0.0141 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -581,7 +596,7 @@ See [`Pallet::transfer_ud_keep_alive`].
<details><summary><code>create_identity(owner_key)</code></summary>
Taking 0.0969 % of a block.
Taking 0.1 % of a block.
```rust
owner_key: T::AccountId
@@ -595,7 +610,7 @@ See [`Pallet::create_identity`].
<details><summary><code>confirm_identity(idty_name)</code></summary>
Taking 0.0365 % of a block.
Taking 0.037 % of a block.
```rust
idty_name: IdtyName
@@ -609,7 +624,7 @@ See [`Pallet::confirm_identity`].
<details><summary><code>change_owner_key(new_key, new_key_sig)</code></summary>
Taking 0.0507 % of a block.
Taking 0.0472 % of a block.
```rust
new_key: T::AccountId
@@ -624,7 +639,7 @@ See [`Pallet::change_owner_key`].
<details><summary><code>revoke_identity(idty_index, revocation_key, revocation_sig)</code></summary>
Taking 0.0487 % of a block.
Taking 0.0452 % of a block.
```rust
idty_index: T::IdtyIndex
@@ -640,7 +655,7 @@ See [`Pallet::revoke_identity`].
<details><summary><code>fix_sufficients(owner_key, inc)</code></summary>
Taking 0.0113 % of a block.
Taking 0.0116 % of a block.
```rust
owner_key: T::AccountId
@@ -655,7 +670,7 @@ See [`Pallet::fix_sufficients`].
<details><summary><code>link_account(account_id, payload_sig)</code></summary>
Taking 0.0182 % of a block.
Taking 0.0165 % of a block.
```rust
account_id: T::AccountId
@@ -672,7 +687,7 @@ See [`Pallet::link_account`].
<details><summary><code>add_cert(receiver)</code></summary>
Taking 0.0398 % of a block.
Taking 0.041 % of a block.
```rust
receiver: T::IdtyIndex
@@ -686,7 +701,7 @@ See [`Pallet::add_cert`].
<details><summary><code>renew_cert(receiver)</code></summary>
Taking 0.0324 % of a block.
Taking 0.0333 % of a block.
```rust
receiver: T::IdtyIndex
@@ -700,7 +715,7 @@ See [`Pallet::renew_cert`].
<details><summary><code>del_cert(issuer, receiver)</code></summary>
Taking 0.0276 % of a block.
Taking 0.0287 % of a block.
```rust
issuer: T::IdtyIndex
@@ -715,7 +730,7 @@ See [`Pallet::del_cert`].
<details><summary><code>remove_all_certs_received_by(idty_index)</code></summary>
Taking 7.8043 % of a block.
Taking 8.1029 % of a block.
```rust
idty_index: T::IdtyIndex
@@ -731,7 +746,7 @@ See [`Pallet::remove_all_certs_received_by`].
<details><summary><code>request_distance_evaluation()</code></summary>
Taking 0.0354 % of a block.
Taking 0.0365 % of a block.
```rust
```
@@ -744,7 +759,7 @@ See [`Pallet::request_distance_evaluation`].
<details><summary><code>request_distance_evaluation_for(target)</code></summary>
Taking 0.0367 % of a block.
Taking 0.038 % of a block.
```rust
target: T::IdtyIndex
@@ -758,7 +773,7 @@ See [`Pallet::request_distance_evaluation_for`].
<details><summary><code>update_evaluation(computation_result)</code></summary>
Taking 0.0351 % of a block.
Taking 0.0343 % of a block.
```rust
computation_result: ComputationResult
@@ -772,7 +787,7 @@ See [`Pallet::update_evaluation`].
<details><summary><code>force_update_evaluation(evaluator, computation_result)</code></summary>
Taking 0.018 % of a block.
Taking 0.016 % of a block.
```rust
evaluator: <T as frame_system::Config>::AccountId
@@ -787,7 +802,7 @@ See [`Pallet::force_update_evaluation`].
<details><summary><code>force_valid_distance_status(identity)</code></summary>
Taking 0.0301 % of a block.
Taking 0.0305 % of a block.
```rust
identity: <T as pallet_identity::Config>::IdtyIndex
@@ -852,7 +867,7 @@ See [`Pallet::cancel_swap`].
<details><summary><code>as_multi_threshold_1(other_signatories, call)</code></summary>
Taking 0.0045 % of a block.
Taking 0.004 % of a block.
```rust
other_signatories: Vec<T::AccountId>
@@ -903,7 +918,7 @@ See [`Pallet::approve_as_multi`].
<details><summary><code>cancel_as_multi(threshold, other_signatories, timepoint, call_hash)</code></summary>
Taking 0.0135 % of a block.
Taking 0.0125 % of a block.
```rust
threshold: u16
@@ -922,7 +937,7 @@ See [`Pallet::cancel_as_multi`].
<details><summary><code>request(randomness_type, salt)</code></summary>
Taking 0.0393 % of a block.
Taking 0.0462 % of a block.
```rust
randomness_type: RandomnessType
@@ -939,7 +954,7 @@ See [`Pallet::request`].
<details><summary><code>proxy(real, force_proxy_type, call)</code></summary>
Taking 0.0063 % of a block.
Taking 0.0055 % of a block.
```rust
real: AccountIdLookupOf<T>
@@ -955,7 +970,7 @@ See [`Pallet::proxy`].
<details><summary><code>add_proxy(delegate, proxy_type, delay)</code></summary>
Taking 0.0129 % of a block.
Taking 0.0122 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -971,7 +986,7 @@ See [`Pallet::add_proxy`].
<details><summary><code>remove_proxy(delegate, proxy_type, delay)</code></summary>
Taking 0.0133 % of a block.
Taking 0.0122 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -987,7 +1002,7 @@ See [`Pallet::remove_proxy`].
<details><summary><code>remove_proxies()</code></summary>
Taking 0.0129 % of a block.
Taking 0.0121 % of a block.
```rust
```
@@ -1000,7 +1015,7 @@ See [`Pallet::remove_proxies`].
<details><summary><code>create_pure(proxy_type, delay, index)</code></summary>
Taking 0.0141 % of a block.
Taking 0.0122 % of a block.
```rust
proxy_type: T::ProxyType
@@ -1016,7 +1031,7 @@ See [`Pallet::create_pure`].
<details><summary><code>kill_pure(spawner, proxy_type, index, height, ext_index)</code></summary>
Taking 0.0125 % of a block.
Taking 0.0122 % of a block.
```rust
spawner: AccountIdLookupOf<T>
@@ -1034,7 +1049,7 @@ See [`Pallet::kill_pure`].
<details><summary><code>announce(real, call_hash)</code></summary>
Taking 0.0218 % of a block.
Taking 0.0217 % of a block.
```rust
real: AccountIdLookupOf<T>
@@ -1049,7 +1064,7 @@ See [`Pallet::announce`].
<details><summary><code>remove_announcement(real, call_hash)</code></summary>
Taking 0.0198 % of a block.
Taking 0.02 % of a block.
```rust
real: AccountIdLookupOf<T>
@@ -1079,7 +1094,7 @@ See [`Pallet::reject_announcement`].
<details><summary><code>proxy_announced(delegate, real, force_proxy_type, call)</code></summary>
Taking 0.0235 % of a block.
Taking 0.0218 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -1098,7 +1113,7 @@ See [`Pallet::proxy_announced`].
<details><summary><code>batch(calls)</code></summary>
Taking 0.2728 % of a block.
Taking 0.1058 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1112,7 +1127,7 @@ See [`Pallet::batch`].
<details><summary><code>as_derivative(index, call)</code></summary>
Taking 0.004 % of a block.
Taking 0.0037 % of a block.
```rust
index: u16
@@ -1127,7 +1142,7 @@ See [`Pallet::as_derivative`].
<details><summary><code>batch_all(calls)</code></summary>
Taking 0.2935 % of a block.
Taking 0.1127 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1141,7 +1156,7 @@ See [`Pallet::batch_all`].
<details><summary><code>force_batch(calls)</code></summary>
Taking 0.3104 % of a block.
Taking 0.1053 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1172,7 +1187,7 @@ See [`Pallet::with_weight`].
<details><summary><code>propose_spend(value, beneficiary)</code></summary>
Taking 0.0183 % of a block.
Taking 0.0185 % of a block.
```rust
value: BalanceOf<T, I>
@@ -1202,7 +1217,7 @@ See [`Pallet::spend_local`].
<details><summary><code>remove_approval(proposal_id)</code></summary>
Taking 0.0111 % of a block.
Taking 0.0115 % of a block.
```rust
proposal_id: ProposalIndex
@@ -1216,7 +1231,7 @@ See [`Pallet::remove_approval`].
<details><summary><code>spend(asset_kind, amount, beneficiary, valid_from)</code></summary>
Taking 0.0035 % of a block.
Taking 0.0036 % of a block.
```rust
asset_kind: Box<T::AssetKind>
@@ -1233,7 +1248,7 @@ See [`Pallet::spend`].
<details><summary><code>payout(index)</code></summary>
Taking 0.0326 % of a block.
Taking 0.0286 % of a block.
```rust
index: SpendIndex
@@ -1247,7 +1262,7 @@ See [`Pallet::payout`].
<details><summary><code>check_status(index)</code></summary>
Taking 0.011 % of a block.
Taking 0.0117 % of a block.
```rust
index: SpendIndex
@@ -1261,7 +1276,7 @@ See [`Pallet::check_status`].
<details><summary><code>void_spend(index)</code></summary>
Taking 0.011 % of a block.
Taking 0.0117 % of a block.
```rust
index: SpendIndex
@@ -1283,7 +1298,7 @@ There are **18** root calls from **8** pallets.
<details><summary><code>set_heap_pages(pages)</code></summary>
Taking 0.0169 % of a block.
Taking 0.0178 % of a block.
```rust
pages: u64
@@ -1297,7 +1312,7 @@ See [`Pallet::set_heap_pages`].
<details><summary><code>set_code(code)</code></summary>
Taking 3.9604 % of a block.
Taking 3.9187 % of a block.
```rust
code: Vec<u8>
@@ -1325,7 +1340,7 @@ See [`Pallet::set_code_without_checks`].
<details><summary><code>set_storage(items)</code></summary>
Taking 5.9169 % of a block.
Taking 6.4116 % of a block.
```rust
items: Vec<KeyValue>
@@ -1339,7 +1354,7 @@ See [`Pallet::set_storage`].
<details><summary><code>kill_storage(keys)</code></summary>
Taking 5.8899 % of a block.
Taking 6.403 % of a block.
```rust
keys: Vec<Key>
@@ -1353,7 +1368,7 @@ See [`Pallet::kill_storage`].
<details><summary><code>kill_prefix(prefix, subkeys)</code></summary>
Taking 7.0785 % of a block.
Taking 7.7227 % of a block.
```rust
prefix: Key
@@ -1368,7 +1383,7 @@ See [`Pallet::kill_prefix`].
<details><summary><code>authorize_upgrade(code_hash)</code></summary>
Taking 0.0098 % of a block.
Taking 0.0105 % of a block.
```rust
code_hash: T::Hash
@@ -1396,7 +1411,7 @@ See [`Pallet::authorize_upgrade_without_checks`].
<details><summary><code>apply_authorized_upgrade(code)</code></summary>
Taking 4.1178 % of a block.
Taking 4.137 % of a block.
```rust
code: Vec<u8>
@@ -1428,7 +1443,7 @@ See [`Pallet::plan_config_change`].
<details><summary><code>force_transfer(source, dest, value)</code></summary>
Taking 0.0347 % of a block.
Taking 0.0289 % of a block.
```rust
source: AccountIdLookupOf<T>
@@ -1444,7 +1459,7 @@ See [`Pallet::force_transfer`].
<details><summary><code>force_unreserve(who, amount)</code></summary>
Taking 0.0128 % of a block.
Taking 0.0119 % of a block.
```rust
who: AccountIdLookupOf<T>
@@ -1461,7 +1476,7 @@ See [`Pallet::force_unreserve`].
<details><summary><code>remove_member(member_id)</code></summary>
Taking 0.073 % of a block.
Taking 0.0768 % of a block.
```rust
member_id: T::MemberId
@@ -1494,7 +1509,7 @@ See [`Pallet::note_stalled`].
<details><summary><code>set_members(new_members, prime, old_count)</code></summary>
Taking 0.175 % of a block.
Taking 0.1828 % of a block.
```rust
new_members: Vec<T::AccountId>
@@ -1510,7 +1525,7 @@ See [`Pallet::set_members`].
<details><summary><code>disapprove_proposal(proposal_hash)</code></summary>
Taking 0.0236 % of a block.
Taking 0.0247 % of a block.
```rust
proposal_hash: T::Hash
@@ -1526,7 +1541,7 @@ See [`Pallet::disapprove_proposal`].
<details><summary><code>prune_item_identities_names(names)</code></summary>
Taking 5.9553 % of a block.
Taking 6.4472 % of a block.
```rust
names: Vec<IdtyName>
@@ -1542,7 +1557,7 @@ See [`Pallet::prune_item_identities_names`].
<details><summary><code>dispatch_as(as_origin, call)</code></summary>
Taking 0.005 % of a block.
Taking 0.0038 % of a block.
```rust
as_origin: Box<T::PalletsOrigin>
@@ -1568,7 +1583,7 @@ There are **4** disabled calls from **2** pallets.
<details><summary><code>remark(remark)</code></summary>
Taking 0.0946 % of a block.
Taking 0.0536 % of a block.
```rust
remark: Vec<u8>
@@ -1582,7 +1597,7 @@ See [`Pallet::remark`].
<details><summary><code>remark_with_event(remark)</code></summary>
Taking 0.3505 % of a block.
Taking 0.2032 % of a block.
```rust
remark: Vec<u8>
@@ -1598,7 +1613,7 @@ See [`Pallet::remark_with_event`].
<details><summary><code>set_keys(keys, proof)</code></summary>
Taking 0.0406 % of a block.
Taking 0.0431 % of a block.
```rust
keys: T::Keys
@@ -1613,7 +1628,7 @@ See [`Pallet::set_keys`].
<details><summary><code>purge_keys()</code></summary>
Taking 0.0351 % of a block.
Taking 0.0375 % of a block.
```rust
```