From d45936f99fb71a68420070fd0025c96d7f5e3cfb Mon Sep 17 00:00:00 2001
From: Hugo Trentesaux <hugo@trentesaux.fr>
Date: Mon, 27 Nov 2023 09:56:34 +0100
Subject: [PATCH] adds event documentation
---
docs/api/runtime-events.md | 172 ++++++++++++++++++++++++++
xtask/res/templates/runtime-events.md | 1 +
2 files changed, 173 insertions(+)
diff --git a/docs/api/runtime-events.md b/docs/api/runtime-events.md
index 239759137..e8f92c641 100644
--- a/docs/api/runtime-events.md
+++ b/docs/api/runtime-events.md
@@ -9,6 +9,7 @@ There are **130** events from **37** pallets.
<details>
<summary>
<code>ExtrinsicSuccess(dispatch_info)</code> - 0</summary>
+An extrinsic completed successfully.
```rust
dispatch_info: DispatchInfo
@@ -20,6 +21,7 @@ dispatch_info: DispatchInfo
<details>
<summary>
<code>ExtrinsicFailed(dispatch_error, dispatch_info)</code> - 1</summary>
+An extrinsic failed.
```rust
dispatch_error: DispatchError
@@ -32,6 +34,7 @@ dispatch_info: DispatchInfo
<details>
<summary>
<code>CodeUpdated()</code> - 2</summary>
+`:code` was updated.
```rust
no args
@@ -43,6 +46,7 @@ no args
<details>
<summary>
<code>NewAccount(account)</code> - 3</summary>
+A new account was created.
```rust
account: T::AccountId
@@ -54,6 +58,7 @@ account: T::AccountId
<details>
<summary>
<code>KilledAccount(account)</code> - 4</summary>
+An account was reaped.
```rust
account: T::AccountId
@@ -65,6 +70,7 @@ account: T::AccountId
<details>
<summary>
<code>Remarked(sender, hash)</code> - 5</summary>
+On on-chain remark happened.
```rust
sender: T::AccountId
@@ -81,6 +87,9 @@ hash: T::Hash
<details>
<summary>
<code>ForceDestroy(who, balance)</code> - 0</summary>
+Force the destruction of an account because its free balance is insufficient to pay
+the account creation price.
+[who, balance]
```rust
who: T::AccountId
@@ -93,6 +102,8 @@ balance: T::Balance
<details>
<summary>
<code>RandomIdAssigned(who, random_id)</code> - 1</summary>
+Random id assigned
+[account_id, random_id]
```rust
who: T::AccountId
@@ -105,6 +116,7 @@ random_id: H256
<details>
<summary>
<code>AccountLinked(who, identity)</code> - 2</summary>
+account linked to identity
```rust
who: T::AccountId
@@ -117,6 +129,7 @@ identity: IdtyIdOf<T>
<details>
<summary>
<code>AccountUnlinked()</code> - 3</summary>
+account unlinked from identity
```rust
: T::AccountId
@@ -132,6 +145,7 @@ identity: IdtyIdOf<T>
<details>
<summary>
<code>Scheduled(when, index)</code> - 0</summary>
+Scheduled some task.
```rust
when: T::BlockNumber
@@ -144,6 +158,7 @@ index: u32
<details>
<summary>
<code>Canceled(when, index)</code> - 1</summary>
+Canceled some task.
```rust
when: T::BlockNumber
@@ -156,6 +171,7 @@ index: u32
<details>
<summary>
<code>Dispatched(task, id, result)</code> - 2</summary>
+Dispatched some task.
```rust
task: TaskAddress<T::BlockNumber>
@@ -169,6 +185,7 @@ result: DispatchResult
<details>
<summary>
<code>CallUnavailable(task, id)</code> - 3</summary>
+The call for the provided hash was not found so the task has been aborted.
```rust
task: TaskAddress<T::BlockNumber>
@@ -181,6 +198,7 @@ id: Option<TaskName>
<details>
<summary>
<code>PeriodicFailed(task, id)</code> - 4</summary>
+The given task was unable to be renewed since the agenda is full at that block.
```rust
task: TaskAddress<T::BlockNumber>
@@ -193,6 +211,7 @@ id: Option<TaskName>
<details>
<summary>
<code>PermanentlyOverweight(task, id)</code> - 5</summary>
+The given task can never be executed since it is overweight.
```rust
task: TaskAddress<T::BlockNumber>
@@ -221,6 +240,7 @@ id: Option<TaskName>
<details>
<summary>
<code>Endowed(account, free_balance)</code> - 0</summary>
+An account was created with some free balance.
```rust
account: T::AccountId
@@ -233,6 +253,8 @@ free_balance: T::Balance
<details>
<summary>
<code>DustLost(account, amount)</code> - 1</summary>
+An account was removed whose balance was non-zero but below ExistentialDeposit,
+resulting in an outright loss.
```rust
account: T::AccountId
@@ -245,6 +267,7 @@ amount: T::Balance
<details>
<summary>
<code>Transfer(from, to, amount)</code> - 2</summary>
+Transfer succeeded.
```rust
from: T::AccountId
@@ -258,6 +281,7 @@ amount: T::Balance
<details>
<summary>
<code>BalanceSet(who, free)</code> - 3</summary>
+A balance was set by root.
```rust
who: T::AccountId
@@ -270,6 +294,7 @@ free: T::Balance
<details>
<summary>
<code>Reserved(who, amount)</code> - 4</summary>
+Some balance was reserved (moved from free to reserved).
```rust
who: T::AccountId
@@ -282,6 +307,7 @@ amount: T::Balance
<details>
<summary>
<code>Unreserved(who, amount)</code> - 5</summary>
+Some balance was unreserved (moved from reserved to free).
```rust
who: T::AccountId
@@ -294,6 +320,8 @@ amount: T::Balance
<details>
<summary>
<code>ReserveRepatriated(from, to, amount, destination_status)</code> - 6</summary>
+Some balance was moved from the reserve of the first account to the second account.
+Final argument indicates the destination balance type.
```rust
from: T::AccountId
@@ -308,6 +336,7 @@ destination_status: Status
<details>
<summary>
<code>Deposit(who, amount)</code> - 7</summary>
+Some amount was deposited (e.g. for transaction fees).
```rust
who: T::AccountId
@@ -320,6 +349,7 @@ amount: T::Balance
<details>
<summary>
<code>Withdraw(who, amount)</code> - 8</summary>
+Some amount was withdrawn from the account (e.g. for transaction fees).
```rust
who: T::AccountId
@@ -332,6 +362,7 @@ amount: T::Balance
<details>
<summary>
<code>Slashed(who, amount)</code> - 9</summary>
+Some amount was removed from the account (e.g. for misbehavior).
```rust
who: T::AccountId
@@ -344,6 +375,7 @@ amount: T::Balance
<details>
<summary>
<code>Minted(who, amount)</code> - 10</summary>
+Some amount was minted into an account.
```rust
who: T::AccountId
@@ -356,6 +388,7 @@ amount: T::Balance
<details>
<summary>
<code>Burned(who, amount)</code> - 11</summary>
+Some amount was burned from an account.
```rust
who: T::AccountId
@@ -368,6 +401,7 @@ amount: T::Balance
<details>
<summary>
<code>Suspended(who, amount)</code> - 12</summary>
+Some amount was suspended from an account (it can be restored later).
```rust
who: T::AccountId
@@ -380,6 +414,7 @@ amount: T::Balance
<details>
<summary>
<code>Restored(who, amount)</code> - 13</summary>
+Some amount was restored into an account.
```rust
who: T::AccountId
@@ -392,6 +427,7 @@ amount: T::Balance
<details>
<summary>
<code>Upgraded(who)</code> - 14</summary>
+An account was upgraded.
```rust
who: T::AccountId
@@ -403,6 +439,7 @@ who: T::AccountId
<details>
<summary>
<code>Issued(amount)</code> - 15</summary>
+Total issuance was increased by `amount`, creating a credit to be balanced.
```rust
amount: T::Balance
@@ -414,6 +451,7 @@ amount: T::Balance
<details>
<summary>
<code>Rescinded(amount)</code> - 16</summary>
+Total issuance was decreased by `amount`, creating a debt to be balanced.
```rust
amount: T::Balance
@@ -425,6 +463,7 @@ amount: T::Balance
<details>
<summary>
<code>Locked(who, amount)</code> - 17</summary>
+Some balance was locked.
```rust
who: T::AccountId
@@ -437,6 +476,7 @@ amount: T::Balance
<details>
<summary>
<code>Unlocked(who, amount)</code> - 18</summary>
+Some balance was unlocked.
```rust
who: T::AccountId
@@ -449,6 +489,7 @@ amount: T::Balance
<details>
<summary>
<code>Frozen(who, amount)</code> - 19</summary>
+Some balance was frozen.
```rust
who: T::AccountId
@@ -461,6 +502,7 @@ amount: T::Balance
<details>
<summary>
<code>Thawed(who, amount)</code> - 20</summary>
+Some balance was thawed.
```rust
who: T::AccountId
@@ -477,6 +519,8 @@ amount: T::Balance
<details>
<summary>
<code>TransactionFeePaid(who, actual_fee, tip)</code> - 0</summary>
+A transaction fee `actual_fee`, of which `tip` was added to the minimum inclusion fee,
+has been paid by `who`.
```rust
who: T::AccountId
@@ -495,6 +539,7 @@ tip: BalanceOf<T>
<summary>
<code>OneshotAccountCreated(account, balance, creator)</code> - 0</summary>
+
```rust
account: T::AccountId
balance: <T::Currency as Currency<T::AccountId>>::Balance
@@ -508,6 +553,7 @@ creator: T::AccountId
<summary>
<code>OneshotAccountConsumed(account, dest1, dest2)</code> - 1</summary>
+
```rust
account: T::AccountId
dest1: (T::AccountId,<T::Currency as Currency<T::AccountId>>::Balance,)
@@ -523,6 +569,7 @@ dest2: Option<
<summary>
<code>Withdraw(account, balance)</code> - 2</summary>
+
```rust
account: T::AccountId
balance: <T::Currency as Currency<T::AccountId>>::Balance
@@ -538,6 +585,7 @@ balance: <T::Currency as Currency<T::AccountId>>::Balance
<details>
<summary>
<code>Refunded(who, identity, amount)</code> - 0</summary>
+Refunded fees to an account
```rust
who: T::AccountId
@@ -551,6 +599,7 @@ amount: BalanceOf<T>
<details>
<summary>
<code>NoQuotaForIdty()</code> - 1</summary>
+No quota for identity
```rust
: IdtyId<T>
@@ -562,6 +611,7 @@ amount: BalanceOf<T>
<details>
<summary>
<code>NoMoreCurrencyForRefund()</code> - 2</summary>
+No more currency available for refund
```rust
no args
@@ -573,6 +623,7 @@ no args
<details>
<summary>
<code>RefundFailed()</code> - 3</summary>
+Refund failed
```rust
: T::AccountId
@@ -584,6 +635,7 @@ no args
<details>
<summary>
<code>RefundQueueFull()</code> - 4</summary>
+Refund queue full
```rust
no args
@@ -599,6 +651,8 @@ no args
<details>
<summary>
<code>IncomingAuthorities()</code> - 0</summary>
+List of members who will enter the set of authorities at the next session.
+[Vec<member_id>]
```rust
: Vec<T::MemberId>
@@ -610,6 +664,8 @@ no args
<details>
<summary>
<code>OutgoingAuthorities()</code> - 1</summary>
+List of members who will leave the set of authorities at the next session.
+[Vec<member_id>]
```rust
: Vec<T::MemberId>
@@ -621,6 +677,8 @@ no args
<details>
<summary>
<code>MemberGoOffline()</code> - 2</summary>
+A member will leave the set of authorities in 2 sessions.
+[member_id]
```rust
: T::MemberId
@@ -632,6 +690,8 @@ no args
<details>
<summary>
<code>MemberGoOnline()</code> - 3</summary>
+A member will enter the set of authorities in 2 sessions.
+[member_id]
```rust
: T::MemberId
@@ -643,6 +703,9 @@ no args
<details>
<summary>
<code>MemberRemoved()</code> - 4</summary>
+A member has lost the right to be part of the authorities,
+this member will be removed from the authority set in 2 sessions.
+[member_id]
```rust
: T::MemberId
@@ -654,6 +717,8 @@ no args
<details>
<summary>
<code>MemberRemovedFromBlackList()</code> - 5</summary>
+A member has been removed from the blacklist.
+[member_id]
```rust
: T::MemberId
@@ -673,6 +738,9 @@ no args
<details>
<summary>
<code>Offence(kind, timeslot)</code> - 0</summary>
+There is an offence reported of the given `kind` happened at the `session_index` and
+(kind-specific) time slot. This event is not deposited for duplicate slashes.
+\[kind, timeslot\].
```rust
kind: Kind
@@ -693,6 +761,8 @@ timeslot: OpaqueTimeSlot
<details>
<summary>
<code>NewSession(session_index)</code> - 0</summary>
+New session has happened. Note that the argument is the session index, not the
+block number as the type might suggest.
```rust
session_index: SessionIndex
@@ -708,6 +778,7 @@ session_index: SessionIndex
<details>
<summary>
<code>NewAuthorities(authority_set)</code> - 0</summary>
+New authority set has been applied.
```rust
authority_set: AuthorityList
@@ -719,6 +790,7 @@ authority_set: AuthorityList
<details>
<summary>
<code>Paused()</code> - 1</summary>
+Current authority set has been paused.
```rust
no args
@@ -730,6 +802,7 @@ no args
<details>
<summary>
<code>Resumed()</code> - 2</summary>
+Current authority set has been resumed.
```rust
no args
@@ -745,6 +818,7 @@ no args
<details>
<summary>
<code>HeartbeatReceived(authority_id)</code> - 0</summary>
+A new heartbeat was received from `AuthorityId`.
```rust
authority_id: T::AuthorityId
@@ -756,6 +830,7 @@ authority_id: T::AuthorityId
<details>
<summary>
<code>AllGood()</code> - 1</summary>
+At the end of the session, no offence was committed.
```rust
no args
@@ -767,6 +842,7 @@ no args
<details>
<summary>
<code>SomeOffline(offline)</code> - 2</summary>
+At the end of the session, at least one validator was found to be offline.
```rust
offline: Vec<IdentificationTuple<T>>
@@ -786,6 +862,7 @@ offline: Vec<IdentificationTuple<T>>
<details>
<summary>
<code>Sudid(sudo_result)</code> - 0</summary>
+A sudo just took place. \[result\]
```rust
sudo_result: DispatchResult
@@ -797,6 +874,7 @@ sudo_result: DispatchResult
<details>
<summary>
<code>KeyChanged(old_sudoer)</code> - 1</summary>
+The \[sudoer\] just switched identity; the old key is supplied if one existed.
```rust
old_sudoer: Option<T::AccountId>
@@ -808,6 +886,7 @@ old_sudoer: Option<T::AccountId>
<details>
<summary>
<code>SudoAsDone(sudo_result)</code> - 2</summary>
+A sudo just took place. \[result\]
```rust
sudo_result: DispatchResult
@@ -823,6 +902,7 @@ sudo_result: DispatchResult
<details>
<summary>
<code>DispatchedAsRoot(result)</code> - 0</summary>
+A call was dispatched as root from an upgradable origin
```rust
result: DispatchResult
@@ -838,6 +918,7 @@ result: DispatchResult
<details>
<summary>
<code>Noted(hash)</code> - 0</summary>
+A preimage has been noted.
```rust
hash: T::Hash
@@ -849,6 +930,7 @@ hash: T::Hash
<details>
<summary>
<code>Requested(hash)</code> - 1</summary>
+A preimage has been requested.
```rust
hash: T::Hash
@@ -860,6 +942,7 @@ hash: T::Hash
<details>
<summary>
<code>Cleared(hash)</code> - 2</summary>
+A preimage has ben cleared.
```rust
hash: T::Hash
@@ -875,6 +958,8 @@ hash: T::Hash
<details>
<summary>
<code>Proposed(account, proposal_index, proposal_hash, threshold)</code> - 0</summary>
+A motion (given hash) has been proposed (by given account) with a threshold (given
+`MemberCount`).
```rust
account: T::AccountId
@@ -889,6 +974,8 @@ threshold: MemberCount
<details>
<summary>
<code>Voted(account, proposal_hash, voted, yes, no)</code> - 1</summary>
+A motion (given hash) has been voted on by given account, leaving
+a tally (yes votes and no votes given respectively as `MemberCount`).
```rust
account: T::AccountId
@@ -904,6 +991,7 @@ no: MemberCount
<details>
<summary>
<code>Approved(proposal_hash)</code> - 2</summary>
+A motion was approved by the required threshold.
```rust
proposal_hash: T::Hash
@@ -915,6 +1003,7 @@ proposal_hash: T::Hash
<details>
<summary>
<code>Disapproved(proposal_hash)</code> - 3</summary>
+A motion was not approved by the required threshold.
```rust
proposal_hash: T::Hash
@@ -926,6 +1015,7 @@ proposal_hash: T::Hash
<details>
<summary>
<code>Executed(proposal_hash, result)</code> - 4</summary>
+A motion was executed; result will be `Ok` if it returned without error.
```rust
proposal_hash: T::Hash
@@ -938,6 +1028,7 @@ result: DispatchResult
<details>
<summary>
<code>MemberExecuted(proposal_hash, result)</code> - 5</summary>
+A single member did some action; result will be `Ok` if it returned without error.
```rust
proposal_hash: T::Hash
@@ -950,6 +1041,7 @@ result: DispatchResult
<details>
<summary>
<code>Closed(proposal_hash, yes, no)</code> - 6</summary>
+A proposal was closed because its threshold was reached or after its duration was up.
```rust
proposal_hash: T::Hash
@@ -967,6 +1059,7 @@ no: MemberCount
<details>
<summary>
<code>NewUdCreated(amount, index, monetary_mass, members_count)</code> - 0</summary>
+A new universal dividend is created.
```rust
amount: BalanceOf<T>
@@ -981,6 +1074,7 @@ members_count: BalanceOf<T>
<details>
<summary>
<code>UdReevalued(new_ud_amount, monetary_mass, members_count)</code> - 1</summary>
+The universal dividend has been re-evaluated.
```rust
new_ud_amount: BalanceOf<T>
@@ -994,6 +1088,7 @@ members_count: BalanceOf<T>
<details>
<summary>
<code>UdsAutoPaidAtRemoval(count, total, who)</code> - 2</summary>
+DUs were automatically transferred as part of a member removal.
```rust
count: UdIndex
@@ -1007,6 +1102,7 @@ who: T::AccountId
<details>
<summary>
<code>UdsClaimed(count, total, who)</code> - 3</summary>
+A member claimed his UDs.
```rust
count: UdIndex
@@ -1028,6 +1124,8 @@ who: T::AccountId
<details>
<summary>
<code>IdtyCreated(idty_index, owner_key)</code> - 0</summary>
+A new identity has been created
+[idty_index, owner_key]
```rust
idty_index: T::IdtyIndex
@@ -1040,6 +1138,8 @@ owner_key: T::AccountId
<details>
<summary>
<code>IdtyConfirmed(idty_index, owner_key, name)</code> - 1</summary>
+An identity has been confirmed by its owner
+[idty_index, owner_key, name]
```rust
idty_index: T::IdtyIndex
@@ -1053,6 +1153,8 @@ name: IdtyName
<details>
<summary>
<code>IdtyValidated(idty_index)</code> - 2</summary>
+An identity has been validated
+[idty_index]
```rust
idty_index: T::IdtyIndex
@@ -1065,6 +1167,7 @@ idty_index: T::IdtyIndex
<summary>
<code>IdtyChangedOwnerKey(idty_index, new_owner_key)</code> - 3</summary>
+
```rust
idty_index: T::IdtyIndex
new_owner_key: T::AccountId
@@ -1076,6 +1179,8 @@ new_owner_key: T::AccountId
<details>
<summary>
<code>IdtyRemoved(idty_index, reason)</code> - 4</summary>
+An identity has been removed
+[idty_index]
```rust
idty_index: T::IdtyIndex
@@ -1092,6 +1197,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>MembershipAcquired()</code> - 0</summary>
+A membership was acquired
+[idty_id]
```rust
: T::IdtyId
@@ -1103,6 +1210,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>MembershipExpired()</code> - 1</summary>
+A membership expired
+[idty_id]
```rust
: T::IdtyId
@@ -1114,6 +1223,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>MembershipRenewed()</code> - 2</summary>
+A membership was renewed
+[idty_id]
```rust
: T::IdtyId
@@ -1125,6 +1236,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>MembershipRequested()</code> - 3</summary>
+An membership was requested
+[idty_id]
```rust
: T::IdtyId
@@ -1136,6 +1249,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>MembershipRevoked()</code> - 4</summary>
+A membership was revoked
+[idty_id]
```rust
: T::IdtyId
@@ -1147,6 +1262,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>PendingMembershipExpired()</code> - 5</summary>
+A pending membership request has expired
+[idty_id]
```rust
: T::IdtyId
@@ -1162,6 +1279,8 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<details>
<summary>
<code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code> - 0</summary>
+New certification
+[issuer, issuer_issued_count, receiver, receiver_received_count]
```rust
issuer: T::IdtyIndex
@@ -1176,6 +1295,8 @@ receiver_received_count: u32
<details>
<summary>
<code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code> - 1</summary>
+Removed certification
+[issuer, issuer_issued_count, receiver, receiver_received_count, expiration]
```rust
issuer: T::IdtyIndex
@@ -1191,6 +1312,8 @@ expiration: bool
<details>
<summary>
<code>RenewedCert(issuer, receiver)</code> - 2</summary>
+Renewed certification
+[issuer, receiver]
```rust
issuer: T::IdtyIndex
@@ -1215,6 +1338,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>MembershipAcquired()</code> - 0</summary>
+A membership was acquired
+[idty_id]
```rust
: T::IdtyId
@@ -1226,6 +1351,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>MembershipExpired()</code> - 1</summary>
+A membership expired
+[idty_id]
```rust
: T::IdtyId
@@ -1237,6 +1364,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>MembershipRenewed()</code> - 2</summary>
+A membership was renewed
+[idty_id]
```rust
: T::IdtyId
@@ -1248,6 +1377,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>MembershipRequested()</code> - 3</summary>
+An membership was requested
+[idty_id]
```rust
: T::IdtyId
@@ -1259,6 +1390,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>MembershipRevoked()</code> - 4</summary>
+A membership was revoked
+[idty_id]
```rust
: T::IdtyId
@@ -1270,6 +1403,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>PendingMembershipExpired()</code> - 5</summary>
+A pending membership request has expired
+[idty_id]
```rust
: T::IdtyId
@@ -1285,6 +1420,8 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code> - 0</summary>
+New certification
+[issuer, issuer_issued_count, receiver, receiver_received_count]
```rust
issuer: T::IdtyIndex
@@ -1299,6 +1436,8 @@ receiver_received_count: u32
<details>
<summary>
<code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code> - 1</summary>
+Removed certification
+[issuer, issuer_issued_count, receiver, receiver_received_count, expiration]
```rust
issuer: T::IdtyIndex
@@ -1314,6 +1453,8 @@ expiration: bool
<details>
<summary>
<code>RenewedCert(issuer, receiver)</code> - 2</summary>
+Renewed certification
+[issuer, receiver]
```rust
issuer: T::IdtyIndex
@@ -1330,6 +1471,7 @@ receiver: T::IdtyIndex
<details>
<summary>
<code>NewSwap(account, proof, swap)</code> - 0</summary>
+Swap created.
```rust
account: T::AccountId
@@ -1343,6 +1485,7 @@ swap: PendingSwap<T>
<details>
<summary>
<code>SwapClaimed(account, proof, success)</code> - 1</summary>
+Swap claimed. The last parameter indicates whether the execution succeeds.
```rust
account: T::AccountId
@@ -1356,6 +1499,7 @@ success: bool
<details>
<summary>
<code>SwapCancelled(account, proof)</code> - 2</summary>
+Swap cancelled.
```rust
account: T::AccountId
@@ -1372,6 +1516,7 @@ proof: HashedProof
<details>
<summary>
<code>NewMultisig(approving, multisig, call_hash)</code> - 0</summary>
+A new multisig operation has begun.
```rust
approving: T::AccountId
@@ -1385,6 +1530,7 @@ call_hash: CallHash
<details>
<summary>
<code>MultisigApproval(approving, timepoint, multisig, call_hash)</code> - 1</summary>
+A multisig operation has been approved by someone.
```rust
approving: T::AccountId
@@ -1399,6 +1545,7 @@ call_hash: CallHash
<details>
<summary>
<code>MultisigExecuted(approving, timepoint, multisig, call_hash, result)</code> - 2</summary>
+A multisig operation has been executed.
```rust
approving: T::AccountId
@@ -1414,6 +1561,7 @@ result: DispatchResult
<details>
<summary>
<code>MultisigCancelled(cancelling, timepoint, multisig, call_hash)</code> - 3</summary>
+A multisig operation has been cancelled.
```rust
cancelling: T::AccountId
@@ -1432,6 +1580,7 @@ call_hash: CallHash
<details>
<summary>
<code>FilledRandomness(request_id, randomness)</code> - 0</summary>
+Filled randomness
```rust
request_id: RequestId
@@ -1444,6 +1593,7 @@ randomness: H256
<details>
<summary>
<code>RequestedRandomness(request_id, salt, r#type)</code> - 1</summary>
+Requested randomness
```rust
request_id: RequestId
@@ -1461,6 +1611,7 @@ r#type: RandomnessType
<details>
<summary>
<code>ProxyExecuted(result)</code> - 0</summary>
+A proxy was executed correctly, with the given.
```rust
result: DispatchResult
@@ -1472,6 +1623,8 @@ result: DispatchResult
<details>
<summary>
<code>PureCreated(pure, who, proxy_type, disambiguation_index)</code> - 1</summary>
+A pure account has been created by new proxy with given
+disambiguation index and proxy type.
```rust
pure: T::AccountId
@@ -1486,6 +1639,7 @@ disambiguation_index: u16
<details>
<summary>
<code>Announced(real, proxy, call_hash)</code> - 2</summary>
+An announcement was placed to make a call in the future.
```rust
real: T::AccountId
@@ -1499,6 +1653,7 @@ call_hash: CallHashOf<T>
<details>
<summary>
<code>ProxyAdded(delegator, delegatee, proxy_type, delay)</code> - 3</summary>
+A proxy was added.
```rust
delegator: T::AccountId
@@ -1513,6 +1668,7 @@ delay: T::BlockNumber
<details>
<summary>
<code>ProxyRemoved(delegator, delegatee, proxy_type, delay)</code> - 4</summary>
+A proxy was removed.
```rust
delegator: T::AccountId
@@ -1531,6 +1687,8 @@ delay: T::BlockNumber
<details>
<summary>
<code>BatchInterrupted(index, error)</code> - 0</summary>
+Batch of dispatches did not complete fully. Index of first failing dispatch given, as
+well as the error.
```rust
index: u32
@@ -1543,6 +1701,7 @@ error: DispatchError
<details>
<summary>
<code>BatchCompleted()</code> - 1</summary>
+Batch of dispatches completed fully with no error.
```rust
no args
@@ -1554,6 +1713,7 @@ no args
<details>
<summary>
<code>BatchCompletedWithErrors()</code> - 2</summary>
+Batch of dispatches completed but has errors.
```rust
no args
@@ -1565,6 +1725,7 @@ no args
<details>
<summary>
<code>ItemCompleted()</code> - 3</summary>
+A single item within a Batch of dispatches has completed with no error.
```rust
no args
@@ -1576,6 +1737,7 @@ no args
<details>
<summary>
<code>ItemFailed(error)</code> - 4</summary>
+A single item within a Batch of dispatches has completed with error.
```rust
error: DispatchError
@@ -1587,6 +1749,7 @@ error: DispatchError
<details>
<summary>
<code>DispatchedAs(result)</code> - 5</summary>
+A call was dispatched.
```rust
result: DispatchResult
@@ -1602,6 +1765,7 @@ result: DispatchResult
<details>
<summary>
<code>Proposed(proposal_index)</code> - 0</summary>
+New proposal.
```rust
proposal_index: ProposalIndex
@@ -1613,6 +1777,7 @@ proposal_index: ProposalIndex
<details>
<summary>
<code>Spending(budget_remaining)</code> - 1</summary>
+We have ended a spend period and will now allocate funds.
```rust
budget_remaining: BalanceOf<T, I>
@@ -1624,6 +1789,7 @@ budget_remaining: BalanceOf<T, I>
<details>
<summary>
<code>Awarded(proposal_index, award, account)</code> - 2</summary>
+Some funds have been allocated.
```rust
proposal_index: ProposalIndex
@@ -1637,6 +1803,7 @@ account: T::AccountId
<details>
<summary>
<code>Rejected(proposal_index, slashed)</code> - 3</summary>
+A proposal was rejected; funds were slashed.
```rust
proposal_index: ProposalIndex
@@ -1649,6 +1816,7 @@ slashed: BalanceOf<T, I>
<details>
<summary>
<code>Burnt(burnt_funds)</code> - 4</summary>
+Some of our funds have been burnt.
```rust
burnt_funds: BalanceOf<T, I>
@@ -1660,6 +1828,7 @@ burnt_funds: BalanceOf<T, I>
<details>
<summary>
<code>Rollover(rollover_balance)</code> - 5</summary>
+Spending has finished; this is the amount that rolls over until next spend.
```rust
rollover_balance: BalanceOf<T, I>
@@ -1671,6 +1840,7 @@ rollover_balance: BalanceOf<T, I>
<details>
<summary>
<code>Deposit(value)</code> - 6</summary>
+Some funds have been deposited.
```rust
value: BalanceOf<T, I>
@@ -1682,6 +1852,7 @@ value: BalanceOf<T, I>
<details>
<summary>
<code>SpendApproved(proposal_index, amount, beneficiary)</code> - 7</summary>
+A new spend proposal has been approved.
```rust
proposal_index: ProposalIndex
@@ -1695,6 +1866,7 @@ beneficiary: T::AccountId
<details>
<summary>
<code>UpdatedInactive(reactivated, deactivated)</code> - 8</summary>
+The inactive funds of the pallet have been updated.
```rust
reactivated: BalanceOf<T, I>
diff --git a/xtask/res/templates/runtime-events.md b/xtask/res/templates/runtime-events.md
index d458e31db..6c612bc8a 100644
--- a/xtask/res/templates/runtime-events.md
+++ b/xtask/res/templates/runtime-events.md
@@ -15,6 +15,7 @@ There are **{{event_counter}}** events from **{{ pallets | length }}** pallets.
{{ param.name }}{% if loop.last != true %}, {% endif %}
{%- endfor -%}
)</code> - {{ event.index }}</summary>
+{{ event.documentation }}
```rust
{% for param in event.params -%}
--
GitLab