diff --git a/docs/api/runtime-events.md b/docs/api/runtime-events.md index 82c4671400346474aa3fdbb47c4e6fba0044f207..33e2b4f7912042b0cac877e83d37d310f7c03dd9 100644 --- a/docs/api/runtime-events.md +++ b/docs/api/runtime-events.md @@ -1,262 +1,335 @@ # Runtime events -There are xxx calls from **37** pallets. +There are **130** events from **37** pallets. -### System - 0 +<ul> +<li>System - 0 +<ul> +<li> +<code>ExtrinsicSuccess(dispatch_info)</code> - 0 -#### ExtrinsicSuccess - 0 - -<details><summary><code>ExtrinsicSuccess(dispatch_info)</code></summary> +<details> +<summary>args</summary> ```rust dispatch_info: DispatchInfo ``` -</details> +</details> -#### ExtrinsicFailed - 1 +</li> +<li> +<code>ExtrinsicFailed(dispatch_error, dispatch_info)</code> - 1 -<details><summary><code>ExtrinsicFailed(dispatch_error, dispatch_info)</code></summary> +<details> +<summary>args</summary> ```rust dispatch_error: DispatchError dispatch_info: DispatchInfo ``` -</details> - - -#### CodeUpdated - 2 -<details><summary><code>CodeUpdated()</code></summary> - -```rust -``` </details> +</li> +<li> +<code>CodeUpdated()</code> - 2 -#### NewAccount - 3 +</li> +<li> +<code>NewAccount(account)</code> - 3 -<details><summary><code>NewAccount(account)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId ``` -</details> +</details> -#### KilledAccount - 4 +</li> +<li> +<code>KilledAccount(account)</code> - 4 -<details><summary><code>KilledAccount(account)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId ``` -</details> +</details> -#### Remarked - 5 +</li> +<li> +<code>Remarked(sender, hash)</code> - 5 -<details><summary><code>Remarked(sender, hash)</code></summary> +<details> +<summary>args</summary> ```rust sender: T::AccountId hash: T::Hash ``` -</details> +</details> -### Account - 1 - -#### ForceDestroy - 0 +</li> +</ul> +</li> +<li>Account - 1 +<ul> +<li> +<code>ForceDestroy(who, balance)</code> - 0 -<details><summary><code>ForceDestroy(who, balance)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId balance: T::Balance ``` -</details> +</details> -#### RandomIdAssigned - 1 +</li> +<li> +<code>RandomIdAssigned(who, random_id)</code> - 1 -<details><summary><code>RandomIdAssigned(who, random_id)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId random_id: H256 ``` -</details> +</details> -#### AccountLinked - 2 +</li> +<li> +<code>AccountLinked(who, identity)</code> - 2 -<details><summary><code>AccountLinked(who, identity)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId identity: IdtyIdOf<T> ``` -</details> +</details> -#### AccountUnlinked - 3 +</li> +<li> +<code>AccountUnlinked()</code> - 3 -<details><summary><code>AccountUnlinked()</code></summary> +<details> +<summary>args</summary> ```rust : T::AccountId ``` -</details> - -### Scheduler - 2 +</details> -#### Scheduled - 0 +</li> +</ul> +</li> +<li>Scheduler - 2 +<ul> +<li> +<code>Scheduled(when, index)</code> - 0 -<details><summary><code>Scheduled(when, index)</code></summary> +<details> +<summary>args</summary> ```rust when: T::BlockNumber index: u32 ``` -</details> +</details> -#### Canceled - 1 +</li> +<li> +<code>Canceled(when, index)</code> - 1 -<details><summary><code>Canceled(when, index)</code></summary> +<details> +<summary>args</summary> ```rust when: T::BlockNumber index: u32 ``` -</details> +</details> -#### Dispatched - 2 +</li> +<li> +<code>Dispatched(task, id, result)</code> - 2 -<details><summary><code>Dispatched(task, id, result)</code></summary> +<details> +<summary>args</summary> ```rust task: TaskAddress<T::BlockNumber> id: Option<TaskName> result: DispatchResult ``` -</details> +</details> -#### CallUnavailable - 3 +</li> +<li> +<code>CallUnavailable(task, id)</code> - 3 -<details><summary><code>CallUnavailable(task, id)</code></summary> +<details> +<summary>args</summary> ```rust task: TaskAddress<T::BlockNumber> id: Option<TaskName> ``` -</details> +</details> -#### PeriodicFailed - 4 +</li> +<li> +<code>PeriodicFailed(task, id)</code> - 4 -<details><summary><code>PeriodicFailed(task, id)</code></summary> +<details> +<summary>args</summary> ```rust task: TaskAddress<T::BlockNumber> id: Option<TaskName> ``` -</details> +</details> -#### PermanentlyOverweight - 5 +</li> +<li> +<code>PermanentlyOverweight(task, id)</code> - 5 -<details><summary><code>PermanentlyOverweight(task, id)</code></summary> +<details> +<summary>args</summary> ```rust task: TaskAddress<T::BlockNumber> id: Option<TaskName> ``` -</details> +</details> -### Babe - 3 - -### Timestamp - 4 - -### Parameters - 5 - -### Balances - 6 - -#### Endowed - 0 +</li> +</ul> +</li> +<li>Babe - 3 +<ul> +</ul> +</li> +<li>Timestamp - 4 +<ul> +</ul> +</li> +<li>Parameters - 5 +<ul> +</ul> +</li> +<li>Balances - 6 +<ul> +<li> +<code>Endowed(account, free_balance)</code> - 0 -<details><summary><code>Endowed(account, free_balance)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId free_balance: T::Balance ``` -</details> +</details> -#### DustLost - 1 +</li> +<li> +<code>DustLost(account, amount)</code> - 1 -<details><summary><code>DustLost(account, amount)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Transfer - 2 +</li> +<li> +<code>Transfer(from, to, amount)</code> - 2 -<details><summary><code>Transfer(from, to, amount)</code></summary> +<details> +<summary>args</summary> ```rust from: T::AccountId to: T::AccountId amount: T::Balance ``` -</details> +</details> -#### BalanceSet - 3 +</li> +<li> +<code>BalanceSet(who, free)</code> - 3 -<details><summary><code>BalanceSet(who, free)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId free: T::Balance ``` -</details> +</details> -#### Reserved - 4 +</li> +<li> +<code>Reserved(who, amount)</code> - 4 -<details><summary><code>Reserved(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Unreserved - 5 +</li> +<li> +<code>Unreserved(who, amount)</code> - 5 -<details><summary><code>Unreserved(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### ReserveRepatriated - 6 +</li> +<li> +<code>ReserveRepatriated(from, to, amount, destination_status)</code> - 6 -<details><summary><code>ReserveRepatriated(from, to, amount, destination_status)</code></summary> +<details> +<summary>args</summary> ```rust from: T::AccountId @@ -264,191 +337,246 @@ to: T::AccountId amount: T::Balance destination_status: Status ``` -</details> +</details> -#### Deposit - 7 +</li> +<li> +<code>Deposit(who, amount)</code> - 7 -<details><summary><code>Deposit(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Withdraw - 8 +</li> +<li> +<code>Withdraw(who, amount)</code> - 8 -<details><summary><code>Withdraw(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Slashed - 9 +</li> +<li> +<code>Slashed(who, amount)</code> - 9 -<details><summary><code>Slashed(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Minted - 10 +</li> +<li> +<code>Minted(who, amount)</code> - 10 -<details><summary><code>Minted(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Burned - 11 +</li> +<li> +<code>Burned(who, amount)</code> - 11 -<details><summary><code>Burned(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Suspended - 12 +</li> +<li> +<code>Suspended(who, amount)</code> - 12 -<details><summary><code>Suspended(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Restored - 13 +</li> +<li> +<code>Restored(who, amount)</code> - 13 -<details><summary><code>Restored(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Upgraded - 14 +</li> +<li> +<code>Upgraded(who)</code> - 14 -<details><summary><code>Upgraded(who)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId ``` -</details> +</details> -#### Issued - 15 +</li> +<li> +<code>Issued(amount)</code> - 15 -<details><summary><code>Issued(amount)</code></summary> +<details> +<summary>args</summary> ```rust amount: T::Balance ``` -</details> +</details> -#### Rescinded - 16 +</li> +<li> +<code>Rescinded(amount)</code> - 16 -<details><summary><code>Rescinded(amount)</code></summary> +<details> +<summary>args</summary> ```rust amount: T::Balance ``` -</details> +</details> -#### Locked - 17 +</li> +<li> +<code>Locked(who, amount)</code> - 17 -<details><summary><code>Locked(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Unlocked - 18 +</li> +<li> +<code>Unlocked(who, amount)</code> - 18 -<details><summary><code>Unlocked(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Frozen - 19 +</li> +<li> +<code>Frozen(who, amount)</code> - 19 -<details><summary><code>Frozen(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> +</details> -#### Thawed - 20 +</li> +<li> +<code>Thawed(who, amount)</code> - 20 -<details><summary><code>Thawed(who, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId amount: T::Balance ``` -</details> - -### TransactionPayment - 32 +</details> -#### TransactionFeePaid - 0 +</li> +</ul> +</li> +<li>TransactionPayment - 32 +<ul> +<li> +<code>TransactionFeePaid(who, actual_fee, tip)</code> - 0 -<details><summary><code>TransactionFeePaid(who, actual_fee, tip)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId actual_fee: BalanceOf<T> tip: BalanceOf<T> ``` -</details> - -### OneshotAccount - 7 +</details> -#### OneshotAccountCreated - 0 +</li> +</ul> +</li> +<li>OneshotAccount - 7 +<ul> +<li> +<code>OneshotAccountCreated(account, balance, creator)</code> - 0 -<details><summary><code>OneshotAccountCreated(account, balance, creator)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId balance: <T::Currency as Currency<T::AccountId>>::Balance creator: T::AccountId ``` -</details> +</details> -#### OneshotAccountConsumed - 1 +</li> +<li> +<code>OneshotAccountConsumed(account, dest1, dest2)</code> - 1 -<details><summary><code>OneshotAccountConsumed(account, dest1, dest2)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId @@ -457,307 +585,377 @@ dest2: Option< (T::AccountId,<T::Currency as Currency<T::AccountId>>::Balance,) > ``` -</details> +</details> -#### Withdraw - 2 +</li> +<li> +<code>Withdraw(account, balance)</code> - 2 -<details><summary><code>Withdraw(account, balance)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId balance: <T::Currency as Currency<T::AccountId>>::Balance ``` -</details> - -### Quota - 66 +</details> -#### Refunded - 0 +</li> +</ul> +</li> +<li>Quota - 66 +<ul> +<li> +<code>Refunded(who, identity, amount)</code> - 0 -<details><summary><code>Refunded(who, identity, amount)</code></summary> +<details> +<summary>args</summary> ```rust who: T::AccountId identity: IdtyId<T> amount: BalanceOf<T> ``` -</details> +</details> -#### NoQuotaForIdty - 1 +</li> +<li> +<code>NoQuotaForIdty()</code> - 1 -<details><summary><code>NoQuotaForIdty()</code></summary> +<details> +<summary>args</summary> ```rust : IdtyId<T> ``` -</details> - - -#### NoMoreCurrencyForRefund - 2 -<details><summary><code>NoMoreCurrencyForRefund()</code></summary> - -```rust -``` </details> +</li> +<li> +<code>NoMoreCurrencyForRefund()</code> - 2 -#### RefundFailed - 3 +</li> +<li> +<code>RefundFailed()</code> - 3 -<details><summary><code>RefundFailed()</code></summary> +<details> +<summary>args</summary> ```rust : T::AccountId ``` -</details> - - -#### RefundQueueFull - 4 - -<details><summary><code>RefundQueueFull()</code></summary> -```rust -``` </details> +</li> +<li> +<code>RefundQueueFull()</code> - 4 -### AuthorityMembers - 10 - -#### IncomingAuthorities - 0 +</li> +</ul> +</li> +<li>AuthorityMembers - 10 +<ul> +<li> +<code>IncomingAuthorities()</code> - 0 -<details><summary><code>IncomingAuthorities()</code></summary> +<details> +<summary>args</summary> ```rust : Vec<T::MemberId> ``` -</details> +</details> -#### OutgoingAuthorities - 1 +</li> +<li> +<code>OutgoingAuthorities()</code> - 1 -<details><summary><code>OutgoingAuthorities()</code></summary> +<details> +<summary>args</summary> ```rust : Vec<T::MemberId> ``` -</details> +</details> -#### MemberGoOffline - 2 +</li> +<li> +<code>MemberGoOffline()</code> - 2 -<details><summary><code>MemberGoOffline()</code></summary> +<details> +<summary>args</summary> ```rust : T::MemberId ``` -</details> +</details> -#### MemberGoOnline - 3 +</li> +<li> +<code>MemberGoOnline()</code> - 3 -<details><summary><code>MemberGoOnline()</code></summary> +<details> +<summary>args</summary> ```rust : T::MemberId ``` -</details> +</details> -#### MemberRemoved - 4 +</li> +<li> +<code>MemberRemoved()</code> - 4 -<details><summary><code>MemberRemoved()</code></summary> +<details> +<summary>args</summary> ```rust : T::MemberId ``` -</details> +</details> -#### MemberRemovedFromBlackList - 5 +</li> +<li> +<code>MemberRemovedFromBlackList()</code> - 5 -<details><summary><code>MemberRemovedFromBlackList()</code></summary> +<details> +<summary>args</summary> ```rust : T::MemberId ``` -</details> - -### Authorship - 11 - -### Offences - 12 +</details> -#### Offence - 0 +</li> +</ul> +</li> +<li>Authorship - 11 +<ul> +</ul> +</li> +<li>Offences - 12 +<ul> +<li> +<code>Offence(kind, timeslot)</code> - 0 -<details><summary><code>Offence(kind, timeslot)</code></summary> +<details> +<summary>args</summary> ```rust kind: Kind timeslot: OpaqueTimeSlot ``` -</details> - - -### Historical - 13 -### Session - 14 +</details> -#### NewSession - 0 +</li> +</ul> +</li> +<li>Historical - 13 +<ul> +</ul> +</li> +<li>Session - 14 +<ul> +<li> +<code>NewSession(session_index)</code> - 0 -<details><summary><code>NewSession(session_index)</code></summary> +<details> +<summary>args</summary> ```rust session_index: SessionIndex ``` -</details> - - -### Grandpa - 15 - -#### NewAuthorities - 0 -<details><summary><code>NewAuthorities(authority_set)</code></summary> - -```rust -authority_set: AuthorityList -``` </details> +</li> +</ul> +</li> +<li>Grandpa - 15 +<ul> +<li> +<code>NewAuthorities(authority_set)</code> - 0 -#### Paused - 1 - -<details><summary><code>Paused()</code></summary> +<details> +<summary>args</summary> ```rust +authority_set: AuthorityList ``` -</details> - - -#### Resumed - 2 - -<details><summary><code>Resumed()</code></summary> -```rust -``` </details> +</li> +<li> +<code>Paused()</code> - 1 -### ImOnline - 16 +</li> +<li> +<code>Resumed()</code> - 2 -#### HeartbeatReceived - 0 +</li> +</ul> +</li> +<li>ImOnline - 16 +<ul> +<li> +<code>HeartbeatReceived(authority_id)</code> - 0 -<details><summary><code>HeartbeatReceived(authority_id)</code></summary> +<details> +<summary>args</summary> ```rust authority_id: T::AuthorityId ``` -</details> - - -#### AllGood - 1 -<details><summary><code>AllGood()</code></summary> - -```rust -``` </details> +</li> +<li> +<code>AllGood()</code> - 1 -#### SomeOffline - 2 +</li> +<li> +<code>SomeOffline(offline)</code> - 2 -<details><summary><code>SomeOffline(offline)</code></summary> +<details> +<summary>args</summary> ```rust offline: Vec<IdentificationTuple<T>> ``` -</details> - -### AuthorityDiscovery - 17 - -### Sudo - 20 +</details> -#### Sudid - 0 +</li> +</ul> +</li> +<li>AuthorityDiscovery - 17 +<ul> +</ul> +</li> +<li>Sudo - 20 +<ul> +<li> +<code>Sudid(sudo_result)</code> - 0 -<details><summary><code>Sudid(sudo_result)</code></summary> +<details> +<summary>args</summary> ```rust sudo_result: DispatchResult ``` -</details> +</details> -#### KeyChanged - 1 +</li> +<li> +<code>KeyChanged(old_sudoer)</code> - 1 -<details><summary><code>KeyChanged(old_sudoer)</code></summary> +<details> +<summary>args</summary> ```rust old_sudoer: Option<T::AccountId> ``` -</details> +</details> -#### SudoAsDone - 2 +</li> +<li> +<code>SudoAsDone(sudo_result)</code> - 2 -<details><summary><code>SudoAsDone(sudo_result)</code></summary> +<details> +<summary>args</summary> ```rust sudo_result: DispatchResult ``` -</details> - -### UpgradeOrigin - 21 +</details> -#### DispatchedAsRoot - 0 +</li> +</ul> +</li> +<li>UpgradeOrigin - 21 +<ul> +<li> +<code>DispatchedAsRoot(result)</code> - 0 -<details><summary><code>DispatchedAsRoot(result)</code></summary> +<details> +<summary>args</summary> ```rust result: DispatchResult ``` -</details> +</details> -### Preimage - 22 - -#### Noted - 0 +</li> +</ul> +</li> +<li>Preimage - 22 +<ul> +<li> +<code>Noted(hash)</code> - 0 -<details><summary><code>Noted(hash)</code></summary> +<details> +<summary>args</summary> ```rust hash: T::Hash ``` -</details> +</details> -#### Requested - 1 +</li> +<li> +<code>Requested(hash)</code> - 1 -<details><summary><code>Requested(hash)</code></summary> +<details> +<summary>args</summary> ```rust hash: T::Hash ``` -</details> +</details> -#### Cleared - 2 +</li> +<li> +<code>Cleared(hash)</code> - 2 -<details><summary><code>Cleared(hash)</code></summary> +<details> +<summary>args</summary> ```rust hash: T::Hash ``` -</details> - -### TechnicalCommittee - 23 +</details> -#### Proposed - 0 +</li> +</ul> +</li> +<li>TechnicalCommittee - 23 +<ul> +<li> +<code>Proposed(account, proposal_index, proposal_hash, threshold)</code> - 0 -<details><summary><code>Proposed(account, proposal_index, proposal_hash, threshold)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId @@ -765,12 +963,15 @@ proposal_index: ProposalIndex proposal_hash: T::Hash threshold: MemberCount ``` -</details> +</details> -#### Voted - 1 +</li> +<li> +<code>Voted(account, proposal_hash, voted, yes, no)</code> - 1 -<details><summary><code>Voted(account, proposal_hash, voted, yes, no)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId @@ -779,68 +980,88 @@ voted: bool yes: MemberCount no: MemberCount ``` -</details> +</details> -#### Approved - 2 +</li> +<li> +<code>Approved(proposal_hash)</code> - 2 -<details><summary><code>Approved(proposal_hash)</code></summary> +<details> +<summary>args</summary> ```rust proposal_hash: T::Hash ``` -</details> +</details> -#### Disapproved - 3 +</li> +<li> +<code>Disapproved(proposal_hash)</code> - 3 -<details><summary><code>Disapproved(proposal_hash)</code></summary> +<details> +<summary>args</summary> ```rust proposal_hash: T::Hash ``` -</details> +</details> -#### Executed - 4 +</li> +<li> +<code>Executed(proposal_hash, result)</code> - 4 -<details><summary><code>Executed(proposal_hash, result)</code></summary> +<details> +<summary>args</summary> ```rust proposal_hash: T::Hash result: DispatchResult ``` -</details> +</details> -#### MemberExecuted - 5 +</li> +<li> +<code>MemberExecuted(proposal_hash, result)</code> - 5 -<details><summary><code>MemberExecuted(proposal_hash, result)</code></summary> +<details> +<summary>args</summary> ```rust proposal_hash: T::Hash result: DispatchResult ``` -</details> +</details> -#### Closed - 6 +</li> +<li> +<code>Closed(proposal_hash, yes, no)</code> - 6 -<details><summary><code>Closed(proposal_hash, yes, no)</code></summary> +<details> +<summary>args</summary> ```rust proposal_hash: T::Hash yes: MemberCount no: MemberCount ``` -</details> - -### UniversalDividend - 30 +</details> -#### NewUdCreated - 0 +</li> +</ul> +</li> +<li>UniversalDividend - 30 +<ul> +<li> +<code>NewUdCreated(amount, index, monetary_mass, members_count)</code> - 0 -<details><summary><code>NewUdCreated(amount, index, monetary_mass, members_count)</code></summary> +<details> +<summary>args</summary> ```rust amount: BalanceOf<T> @@ -848,171 +1069,224 @@ index: UdIndex monetary_mass: BalanceOf<T> members_count: BalanceOf<T> ``` -</details> +</details> -#### UdReevalued - 1 +</li> +<li> +<code>UdReevalued(new_ud_amount, monetary_mass, members_count)</code> - 1 -<details><summary><code>UdReevalued(new_ud_amount, monetary_mass, members_count)</code></summary> +<details> +<summary>args</summary> ```rust new_ud_amount: BalanceOf<T> monetary_mass: BalanceOf<T> members_count: BalanceOf<T> ``` -</details> +</details> -#### UdsAutoPaidAtRemoval - 2 +</li> +<li> +<code>UdsAutoPaidAtRemoval(count, total, who)</code> - 2 -<details><summary><code>UdsAutoPaidAtRemoval(count, total, who)</code></summary> +<details> +<summary>args</summary> ```rust count: UdIndex total: BalanceOf<T> who: T::AccountId ``` -</details> +</details> -#### UdsClaimed - 3 +</li> +<li> +<code>UdsClaimed(count, total, who)</code> - 3 -<details><summary><code>UdsClaimed(count, total, who)</code></summary> +<details> +<summary>args</summary> ```rust count: UdIndex total: BalanceOf<T> who: T::AccountId ``` -</details> - - -### Wot - 40 -### Identity - 41 +</details> -#### IdtyCreated - 0 +</li> +</ul> +</li> +<li>Wot - 40 +<ul> +</ul> +</li> +<li>Identity - 41 +<ul> +<li> +<code>IdtyCreated(idty_index, owner_key)</code> - 0 -<details><summary><code>IdtyCreated(idty_index, owner_key)</code></summary> +<details> +<summary>args</summary> ```rust idty_index: T::IdtyIndex owner_key: T::AccountId ``` -</details> +</details> -#### IdtyConfirmed - 1 +</li> +<li> +<code>IdtyConfirmed(idty_index, owner_key, name)</code> - 1 -<details><summary><code>IdtyConfirmed(idty_index, owner_key, name)</code></summary> +<details> +<summary>args</summary> ```rust idty_index: T::IdtyIndex owner_key: T::AccountId name: IdtyName ``` -</details> +</details> -#### IdtyValidated - 2 +</li> +<li> +<code>IdtyValidated(idty_index)</code> - 2 -<details><summary><code>IdtyValidated(idty_index)</code></summary> +<details> +<summary>args</summary> ```rust idty_index: T::IdtyIndex ``` -</details> +</details> -#### IdtyChangedOwnerKey - 3 +</li> +<li> +<code>IdtyChangedOwnerKey(idty_index, new_owner_key)</code> - 3 -<details><summary><code>IdtyChangedOwnerKey(idty_index, new_owner_key)</code></summary> +<details> +<summary>args</summary> ```rust idty_index: T::IdtyIndex new_owner_key: T::AccountId ``` -</details> +</details> -#### IdtyRemoved - 4 +</li> +<li> +<code>IdtyRemoved(idty_index, reason)</code> - 4 -<details><summary><code>IdtyRemoved(idty_index, reason)</code></summary> +<details> +<summary>args</summary> ```rust idty_index: T::IdtyIndex reason: IdtyRemovalReason<T::IdtyRemovalOtherReason> ``` -</details> +</details> -### Membership - 42 - -#### MembershipAcquired - 0 +</li> +</ul> +</li> +<li>Membership - 42 +<ul> +<li> +<code>MembershipAcquired()</code> - 0 -<details><summary><code>MembershipAcquired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipExpired - 1 +</li> +<li> +<code>MembershipExpired()</code> - 1 -<details><summary><code>MembershipExpired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRenewed - 2 +</li> +<li> +<code>MembershipRenewed()</code> - 2 -<details><summary><code>MembershipRenewed()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRequested - 3 +</li> +<li> +<code>MembershipRequested()</code> - 3 -<details><summary><code>MembershipRequested()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRevoked - 4 +</li> +<li> +<code>MembershipRevoked()</code> - 4 -<details><summary><code>MembershipRevoked()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### PendingMembershipExpired - 5 +</li> +<li> +<code>PendingMembershipExpired()</code> - 5 -<details><summary><code>PendingMembershipExpired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> - -### Cert - 43 +</details> -#### NewCert - 0 +</li> +</ul> +</li> +<li>Cert - 43 +<ul> +<li> +<code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code> - 0 -<details><summary><code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex @@ -1020,12 +1294,15 @@ issuer_issued_count: u32 receiver: T::IdtyIndex receiver_received_count: u32 ``` -</details> +</details> -#### RemovedCert - 1 +</li> +<li> +<code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code> - 1 -<details><summary><code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex @@ -1034,91 +1311,123 @@ receiver: T::IdtyIndex receiver_received_count: u32 expiration: bool ``` -</details> +</details> -#### RenewedCert - 2 +</li> +<li> +<code>RenewedCert(issuer, receiver)</code> - 2 -<details><summary><code>RenewedCert(issuer, receiver)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex receiver: T::IdtyIndex ``` -</details> - - -### Distance - 44 -### SmithSubWot - 50 - -### SmithMembership - 52 +</details> -#### MembershipAcquired - 0 +</li> +</ul> +</li> +<li>Distance - 44 +<ul> +</ul> +</li> +<li>SmithSubWot - 50 +<ul> +</ul> +</li> +<li>SmithMembership - 52 +<ul> +<li> +<code>MembershipAcquired()</code> - 0 -<details><summary><code>MembershipAcquired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipExpired - 1 +</li> +<li> +<code>MembershipExpired()</code> - 1 -<details><summary><code>MembershipExpired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRenewed - 2 +</li> +<li> +<code>MembershipRenewed()</code> - 2 -<details><summary><code>MembershipRenewed()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRequested - 3 +</li> +<li> +<code>MembershipRequested()</code> - 3 -<details><summary><code>MembershipRequested()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### MembershipRevoked - 4 +</li> +<li> +<code>MembershipRevoked()</code> - 4 -<details><summary><code>MembershipRevoked()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -#### PendingMembershipExpired - 5 +</li> +<li> +<code>PendingMembershipExpired()</code> - 5 -<details><summary><code>PendingMembershipExpired()</code></summary> +<details> +<summary>args</summary> ```rust : T::IdtyId ``` -</details> +</details> -### SmithCert - 53 - -#### NewCert - 0 +</li> +</ul> +</li> +<li>SmithCert - 53 +<ul> +<li> +<code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code> - 0 -<details><summary><code>NewCert(issuer, issuer_issued_count, receiver, receiver_received_count)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex @@ -1126,12 +1435,15 @@ issuer_issued_count: u32 receiver: T::IdtyIndex receiver_received_count: u32 ``` -</details> +</details> -#### RemovedCert - 1 +</li> +<li> +<code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code> - 1 -<details><summary><code>RemovedCert(issuer, issuer_issued_count, receiver, receiver_received_count, expiration)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex @@ -1140,74 +1452,96 @@ receiver: T::IdtyIndex receiver_received_count: u32 expiration: bool ``` -</details> +</details> -#### RenewedCert - 2 +</li> +<li> +<code>RenewedCert(issuer, receiver)</code> - 2 -<details><summary><code>RenewedCert(issuer, receiver)</code></summary> +<details> +<summary>args</summary> ```rust issuer: T::IdtyIndex receiver: T::IdtyIndex ``` -</details> +</details> -### AtomicSwap - 60 - -#### NewSwap - 0 +</li> +</ul> +</li> +<li>AtomicSwap - 60 +<ul> +<li> +<code>NewSwap(account, proof, swap)</code> - 0 -<details><summary><code>NewSwap(account, proof, swap)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId proof: HashedProof swap: PendingSwap<T> ``` -</details> +</details> -#### SwapClaimed - 1 +</li> +<li> +<code>SwapClaimed(account, proof, success)</code> - 1 -<details><summary><code>SwapClaimed(account, proof, success)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId proof: HashedProof success: bool ``` -</details> +</details> -#### SwapCancelled - 2 +</li> +<li> +<code>SwapCancelled(account, proof)</code> - 2 -<details><summary><code>SwapCancelled(account, proof)</code></summary> +<details> +<summary>args</summary> ```rust account: T::AccountId proof: HashedProof ``` -</details> - -### Multisig - 61 +</details> -#### NewMultisig - 0 +</li> +</ul> +</li> +<li>Multisig - 61 +<ul> +<li> +<code>NewMultisig(approving, multisig, call_hash)</code> - 0 -<details><summary><code>NewMultisig(approving, multisig, call_hash)</code></summary> +<details> +<summary>args</summary> ```rust approving: T::AccountId multisig: T::AccountId call_hash: CallHash ``` -</details> +</details> -#### MultisigApproval - 1 +</li> +<li> +<code>MultisigApproval(approving, timepoint, multisig, call_hash)</code> - 1 -<details><summary><code>MultisigApproval(approving, timepoint, multisig, call_hash)</code></summary> +<details> +<summary>args</summary> ```rust approving: T::AccountId @@ -1215,12 +1549,15 @@ timepoint: Timepoint<T::BlockNumber> multisig: T::AccountId call_hash: CallHash ``` -</details> +</details> -#### MultisigExecuted - 2 +</li> +<li> +<code>MultisigExecuted(approving, timepoint, multisig, call_hash, result)</code> - 2 -<details><summary><code>MultisigExecuted(approving, timepoint, multisig, call_hash, result)</code></summary> +<details> +<summary>args</summary> ```rust approving: T::AccountId @@ -1229,12 +1566,15 @@ multisig: T::AccountId call_hash: CallHash result: DispatchResult ``` -</details> +</details> -#### MultisigCancelled - 3 +</li> +<li> +<code>MultisigCancelled(cancelling, timepoint, multisig, call_hash)</code> - 3 -<details><summary><code>MultisigCancelled(cancelling, timepoint, multisig, call_hash)</code></summary> +<details> +<summary>args</summary> ```rust cancelling: T::AccountId @@ -1242,49 +1582,65 @@ timepoint: Timepoint<T::BlockNumber> multisig: T::AccountId call_hash: CallHash ``` -</details> - -### ProvideRandomness - 62 +</details> -#### FilledRandomness - 0 +</li> +</ul> +</li> +<li>ProvideRandomness - 62 +<ul> +<li> +<code>FilledRandomness(request_id, randomness)</code> - 0 -<details><summary><code>FilledRandomness(request_id, randomness)</code></summary> +<details> +<summary>args</summary> ```rust request_id: RequestId randomness: H256 ``` -</details> +</details> -#### RequestedRandomness - 1 +</li> +<li> +<code>RequestedRandomness(request_id, salt, r#type)</code> - 1 -<details><summary><code>RequestedRandomness(request_id, salt, r#type)</code></summary> +<details> +<summary>args</summary> ```rust request_id: RequestId salt: H256 r#type: RandomnessType ``` -</details> - -### Proxy - 63 +</details> -#### ProxyExecuted - 0 +</li> +</ul> +</li> +<li>Proxy - 63 +<ul> +<li> +<code>ProxyExecuted(result)</code> - 0 -<details><summary><code>ProxyExecuted(result)</code></summary> +<details> +<summary>args</summary> ```rust result: DispatchResult ``` -</details> +</details> -#### PureCreated - 1 +</li> +<li> +<code>PureCreated(pure, who, proxy_type, disambiguation_index)</code> - 1 -<details><summary><code>PureCreated(pure, who, proxy_type, disambiguation_index)</code></summary> +<details> +<summary>args</summary> ```rust pure: T::AccountId @@ -1292,24 +1648,30 @@ who: T::AccountId proxy_type: T::ProxyType disambiguation_index: u16 ``` -</details> +</details> -#### Announced - 2 +</li> +<li> +<code>Announced(real, proxy, call_hash)</code> - 2 -<details><summary><code>Announced(real, proxy, call_hash)</code></summary> +<details> +<summary>args</summary> ```rust real: T::AccountId proxy: T::AccountId call_hash: CallHashOf<T> ``` -</details> +</details> -#### ProxyAdded - 3 +</li> +<li> +<code>ProxyAdded(delegator, delegatee, proxy_type, delay)</code> - 3 -<details><summary><code>ProxyAdded(delegator, delegatee, proxy_type, delay)</code></summary> +<details> +<summary>args</summary> ```rust delegator: T::AccountId @@ -1317,12 +1679,15 @@ delegatee: T::AccountId proxy_type: T::ProxyType delay: T::BlockNumber ``` -</details> +</details> -#### ProxyRemoved - 4 +</li> +<li> +<code>ProxyRemoved(delegator, delegatee, proxy_type, delay)</code> - 4 -<details><summary><code>ProxyRemoved(delegator, delegatee, proxy_type, delay)</code></summary> +<details> +<summary>args</summary> ```rust delegator: T::AccountId @@ -1330,164 +1695,193 @@ delegatee: T::AccountId proxy_type: T::ProxyType delay: T::BlockNumber ``` -</details> - -### Utility - 64 +</details> -#### BatchInterrupted - 0 +</li> +</ul> +</li> +<li>Utility - 64 +<ul> +<li> +<code>BatchInterrupted(index, error)</code> - 0 -<details><summary><code>BatchInterrupted(index, error)</code></summary> +<details> +<summary>args</summary> ```rust index: u32 error: DispatchError ``` -</details> - - -#### BatchCompleted - 1 - -<details><summary><code>BatchCompleted()</code></summary> - -```rust -``` -</details> - - -#### BatchCompletedWithErrors - 2 - -<details><summary><code>BatchCompletedWithErrors()</code></summary> -```rust -``` </details> +</li> +<li> +<code>BatchCompleted()</code> - 1 -#### ItemCompleted - 3 - -<details><summary><code>ItemCompleted()</code></summary> - -```rust -``` -</details> +</li> +<li> +<code>BatchCompletedWithErrors()</code> - 2 +</li> +<li> +<code>ItemCompleted()</code> - 3 -#### ItemFailed - 4 +</li> +<li> +<code>ItemFailed(error)</code> - 4 -<details><summary><code>ItemFailed(error)</code></summary> +<details> +<summary>args</summary> ```rust error: DispatchError ``` -</details> +</details> -#### DispatchedAs - 5 +</li> +<li> +<code>DispatchedAs(result)</code> - 5 -<details><summary><code>DispatchedAs(result)</code></summary> +<details> +<summary>args</summary> ```rust result: DispatchResult ``` -</details> +</details> -### Treasury - 65 - -#### Proposed - 0 +</li> +</ul> +</li> +<li>Treasury - 65 +<ul> +<li> +<code>Proposed(proposal_index)</code> - 0 -<details><summary><code>Proposed(proposal_index)</code></summary> +<details> +<summary>args</summary> ```rust proposal_index: ProposalIndex ``` -</details> +</details> -#### Spending - 1 +</li> +<li> +<code>Spending(budget_remaining)</code> - 1 -<details><summary><code>Spending(budget_remaining)</code></summary> +<details> +<summary>args</summary> ```rust budget_remaining: BalanceOf<T, I> ``` -</details> +</details> -#### Awarded - 2 +</li> +<li> +<code>Awarded(proposal_index, award, account)</code> - 2 -<details><summary><code>Awarded(proposal_index, award, account)</code></summary> +<details> +<summary>args</summary> ```rust proposal_index: ProposalIndex award: BalanceOf<T, I> account: T::AccountId ``` -</details> +</details> -#### Rejected - 3 +</li> +<li> +<code>Rejected(proposal_index, slashed)</code> - 3 -<details><summary><code>Rejected(proposal_index, slashed)</code></summary> +<details> +<summary>args</summary> ```rust proposal_index: ProposalIndex slashed: BalanceOf<T, I> ``` -</details> +</details> -#### Burnt - 4 +</li> +<li> +<code>Burnt(burnt_funds)</code> - 4 -<details><summary><code>Burnt(burnt_funds)</code></summary> +<details> +<summary>args</summary> ```rust burnt_funds: BalanceOf<T, I> ``` -</details> +</details> -#### Rollover - 5 +</li> +<li> +<code>Rollover(rollover_balance)</code> - 5 -<details><summary><code>Rollover(rollover_balance)</code></summary> +<details> +<summary>args</summary> ```rust rollover_balance: BalanceOf<T, I> ``` -</details> +</details> -#### Deposit - 6 +</li> +<li> +<code>Deposit(value)</code> - 6 -<details><summary><code>Deposit(value)</code></summary> +<details> +<summary>args</summary> ```rust value: BalanceOf<T, I> ``` -</details> +</details> -#### SpendApproved - 7 +</li> +<li> +<code>SpendApproved(proposal_index, amount, beneficiary)</code> - 7 -<details><summary><code>SpendApproved(proposal_index, amount, beneficiary)</code></summary> +<details> +<summary>args</summary> ```rust proposal_index: ProposalIndex amount: BalanceOf<T, I> beneficiary: T::AccountId ``` -</details> +</details> -#### UpdatedInactive - 8 +</li> +<li> +<code>UpdatedInactive(reactivated, deactivated)</code> - 8 -<details><summary><code>UpdatedInactive(reactivated, deactivated)</code></summary> +<details> +<summary>args</summary> ```rust reactivated: BalanceOf<T, I> deactivated: BalanceOf<T, I> ``` -</details> +</details> +</li> +</ul> +</li> +</ul> \ No newline at end of file diff --git a/xtask/res/templates/runtime-events.md b/xtask/res/templates/runtime-events.md index f3888e3abd1e08c1b14f0b75778a262716920d0a..4f74c8e8d7fd6cf422bee0bf1c5a1c42fb56378b 100644 --- a/xtask/res/templates/runtime-events.md +++ b/xtask/res/templates/runtime-events.md @@ -1,26 +1,33 @@ # Runtime events -There are xxx calls from **{{ pallets | length }}** pallets. +There are **{{event_counter}}** events from **{{ pallets | length }}** pallets. +<ul> {% for pallet in pallets -%} -### {{ pallet.name }} - {{ pallet.index }} - +<li>{{ pallet.name }} - {{ pallet.index }} +<ul> {% for event in pallet.events -%} -#### {{ event.name }} - {{ event.index }} - -<details><summary><code>{{ event.name }}( - {%- for param in event.params -%} - {{ param.name }}{% if loop.last != true %}, {% endif %} - {%- endfor -%} - )</code></summary> +<li> +<code>{{ event.name }}( +{%- for param in event.params -%} +{{ param.name }}{% if loop.last != true %}, {% endif %} +{%- endfor -%} +)</code> - {{ event.index }} +{% if event.params | length != 0 %} +<details> +<summary>args</summary> ```rust {% for param in event.params -%} {{ param.name }}: {{ param.type_name }} {% endfor -%} ``` -</details> - +</details> +{% endif %} +</li> {% endfor -%} +</ul> +</li> {% endfor -%} +</ul> \ No newline at end of file diff --git a/xtask/src/gen_doc.rs b/xtask/src/gen_doc.rs index 3ca8f27e0b9b642b53bdd075b454add716e7be72..5fb1f56a36a683663812f6f6cdb4c91dad90ce75 100644 --- a/xtask/src/gen_doc.rs +++ b/xtask/src/gen_doc.rs @@ -335,6 +335,11 @@ fn print_runtime(pallets: RuntimePallets) -> (String, String) { }) .collect(); + let mut event_counter = 0; + pallets + .iter() + .for_each(|pallet| event_counter += pallet.events.len()); + // compile template let tera = match Tera::new(TEMPLATES_GLOB) { Ok(t) => t, @@ -360,6 +365,7 @@ fn print_runtime(pallets: RuntimePallets) -> (String, String) { // render events context.insert("pallets", &pallets); + context.insert("event_counter", &event_counter); let event_doc = tera .render("runtime-events.md", &context) .expect("template error");