Skip to content
Snippets Groups Projects
Unverified Commit 2b7cdefc authored by bgallois's avatar bgallois
Browse files

update metadata and docs

parent e6a7cc02
No related branches found
No related tags found
No related merge requests found
Pipeline #34662 failed
Stage: labels
Stage: quality
Stage: build
Stage: tests
Show whitespace changes
Inline Side-by-side
docs/api/runtime-calls.md
+ 16
− 16
View file @ 2b7cdefc
...@@ -13,7 +13,7 @@ through on-chain governance mechanisms. ...@@ -13,7 +13,7 @@ through on-chain governance mechanisms.
## User calls ## User calls
There are **79** user calls from **23** pallets. There are **80** user calls from **23** pallets.
### Account - 1 ### Account - 1
...@@ -694,6 +694,20 @@ Revoke an identity using a revocation signature ...@@ -694,6 +694,20 @@ Revoke an identity using a revocation signature
Any signed origin can execute this call. Any signed origin can execute this call.
#### force_remove_identity - 5
<details><summary><code>force_remove_identity(idty_index, idty_name, reason)</code></summary>
```rust
idty_index: T::IdtyIndex
idty_name: Option<IdtyName>
reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
```
</details>
remove an identity from storage
#### fix_sufficients - 7 #### fix_sufficients - 7
<details><summary><code>fix_sufficients(owner_key, inc)</code></summary> <details><summary><code>fix_sufficients(owner_key, inc)</code></summary>
...@@ -1565,7 +1579,7 @@ exist altogether, thus there is no way it would have been approved in the first ...@@ -1565,7 +1579,7 @@ exist altogether, thus there is no way it would have been approved in the first
## Root calls ## Root calls
There are **20** root calls from **10** pallets. There are **19** root calls from **10** pallets.
### System - 0 ### System - 0
...@@ -1802,20 +1816,6 @@ O(P) where P is the number of max proposals ...@@ -1802,20 +1816,6 @@ O(P) where P is the number of max proposals
### Identity - 41 ### Identity - 41
#### remove_identity - 5
<details><summary><code>remove_identity(idty_index, idty_name, reason)</code></summary>
```rust
idty_index: T::IdtyIndex
idty_name: Option<IdtyName>
reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
```
</details>
remove an identity from storage
#### prune_item_identities_names - 6 #### prune_item_identities_names - 6
<details><summary><code>prune_item_identities_names(names)</code></summary> <details><summary><code>prune_item_identities_names(names)</code></summary>
......
docs/api/runtime-errors.md
+ 2
− 2
View file @ 2b7cdefc
...@@ -638,7 +638,7 @@ Insufficient certifications received to claim membership. ...@@ -638,7 +638,7 @@ Insufficient certifications received to claim membership.
<li> <li>
<details> <details>
<summary> <summary>
<code>DistanceNotOK</code> - 1</summary> <code>DistanceNotOk</code> - 1</summary>
Distance has not received a positive evaluation. Distance has not received a positive evaluation.
</details> </details>
</li> </li>
...@@ -966,7 +966,7 @@ Insufficient certifications received to claim membership. ...@@ -966,7 +966,7 @@ Insufficient certifications received to claim membership.
<li> <li>
<details> <details>
<summary> <summary>
<code>DistanceNotOK</code> - 1</summary> <code>DistanceNotOk</code> - 1</summary>
Distance has not received a positive evaluation. Distance has not received a positive evaluation.
</details> </details>
</li> </li>
......
docs/api/runtime-events.md
+ 57
− 61
View file @ 2b7cdefc
# Runtime events # Runtime events
There are **130** events from **37** pallets. There are **129** events from **37** pallets.
<ul> <ul>
<li>System - 0 <li>System - 0
...@@ -1182,11 +1182,12 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason> ...@@ -1182,11 +1182,12 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipAcquired()</code> - 0</summary> <code>MembershipAcquired(member, expire_on)</code> - 0</summary>
A membership was acquired. A membership was acquired.
```rust ```rust
: T::IdtyId member: T::IdtyId
expire_on: BlockNumberFor<T>
``` ```
</details> </details>
...@@ -1194,11 +1195,12 @@ A membership was acquired. ...@@ -1194,11 +1195,12 @@ A membership was acquired.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipExpired()</code> - 1</summary> <code>MembershipTerminated(member, reason)</code> - 1</summary>
A membership expired. A membership was terminated.
```rust ```rust
: T::IdtyId member: T::IdtyId
reason: MembershipTerminationReason
``` ```
</details> </details>
...@@ -1206,11 +1208,12 @@ A membership expired. ...@@ -1206,11 +1208,12 @@ A membership expired.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipRenewed()</code> - 2</summary> <code>PendingMembershipAdded(member, expire_on)</code> - 2</summary>
A membership was renewed. A pending membership was added.
```rust ```rust
: T::IdtyId member: T::IdtyId
expire_on: BlockNumberFor<T>
``` ```
</details> </details>
...@@ -1218,35 +1221,11 @@ A membership was renewed. ...@@ -1218,35 +1221,11 @@ A membership was renewed.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipRequested()</code> - 3</summary> <code>PendingMembershipExpired(member)</code> - 3</summary>
A membership was requested. A pending membership has expired.
```rust ```rust
: T::IdtyId member: T::IdtyId
```
</details>
</li>
<li>
<details>
<summary>
<code>MembershipRevoked()</code> - 4</summary>
A membership was revoked.
```rust
: T::IdtyId
```
</details>
</li>
<li>
<details>
<summary>
<code>PendingMembershipExpired()</code> - 5</summary>
A pending membership request has expired.
```rust
: T::IdtyId
``` ```
</details> </details>
...@@ -1303,22 +1282,27 @@ receiver: T::IdtyIndex ...@@ -1303,22 +1282,27 @@ receiver: T::IdtyIndex
</li> </li>
<li>Distance - 44 <li>Distance - 44
<ul> <ul>
</ul> <li>
</li> <details>
<li>SmithSubWot - 50 <summary>
<ul> <code>EvaluationRequested(idty_index, who)</code> - 0</summary>
</ul> A distance evaluation was requested.
```rust
idty_index: T::IdtyIndex
who: T::AccountId
```
</details>
</li> </li>
<li>SmithMembership - 52
<ul>
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipAcquired()</code> - 0</summary> <code>EvaluationUpdated(evaluator)</code> - 1</summary>
A membership was acquired. A distance evaluation was updated.
```rust ```rust
: T::IdtyId evaluator: T::AccountId
``` ```
</details> </details>
...@@ -1326,23 +1310,33 @@ A membership was acquired. ...@@ -1326,23 +1310,33 @@ A membership was acquired.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipExpired()</code> - 1</summary> <code>EvaluationStatusForced(idty_index, status)</code> - 2</summary>
A membership expired. A distance status was forced.
```rust ```rust
: T::IdtyId idty_index: T::IdtyIndex
status: Option<(<T as frame_system::Config>::AccountId, DistanceStatus)>
``` ```
</details> </details>
</li> </li>
</ul>
</li>
<li>SmithSubWot - 50
<ul>
</ul>
</li>
<li>SmithMembership - 52
<ul>
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipRenewed()</code> - 2</summary> <code>MembershipAcquired(member, expire_on)</code> - 0</summary>
A membership was renewed. A membership was acquired.
```rust ```rust
: T::IdtyId member: T::IdtyId
expire_on: BlockNumberFor<T>
``` ```
</details> </details>
...@@ -1350,11 +1344,12 @@ A membership was renewed. ...@@ -1350,11 +1344,12 @@ A membership was renewed.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipRequested()</code> - 3</summary> <code>MembershipTerminated(member, reason)</code> - 1</summary>
A membership was requested. A membership was terminated.
```rust ```rust
: T::IdtyId member: T::IdtyId
reason: MembershipTerminationReason
``` ```
</details> </details>
...@@ -1362,11 +1357,12 @@ A membership was requested. ...@@ -1362,11 +1357,12 @@ A membership was requested.
<li> <li>
<details> <details>
<summary> <summary>
<code>MembershipRevoked()</code> - 4</summary> <code>PendingMembershipAdded(member, expire_on)</code> - 2</summary>
A membership was revoked. A pending membership was added.
```rust ```rust
: T::IdtyId member: T::IdtyId
expire_on: BlockNumberFor<T>
``` ```
</details> </details>
...@@ -1374,11 +1370,11 @@ A membership was revoked. ...@@ -1374,11 +1370,11 @@ A membership was revoked.
<li> <li>
<details> <details>
<summary> <summary>
<code>PendingMembershipExpired()</code> - 5</summary> <code>PendingMembershipExpired(member)</code> - 3</summary>
A pending membership request has expired. A pending membership has expired.
```rust ```rust
: T::IdtyId member: T::IdtyId
``` ```
</details> </details>
......
docs/dev/pallet_conventions.md
+ 2
− 2
View file @ 2b7cdefc
...@@ -30,6 +30,6 @@ Hooks are inherently infallible, and no errors should be emitted within them. To ...@@ -30,6 +30,6 @@ Hooks are inherently infallible, and no errors should be emitted within them. To
Internal functions should adhere to the following naming convention: Internal functions should adhere to the following naming convention:
- `do_action` for regular functions executing the base logic of a call (e.g., `do_remove_identity`). These functions should directly emit events and trigger errors as needed. - `do_action_` for regular functions executing the base logic of a call (e.g., `do_remove_identity_`). These functions should directly emit events and trigger errors as needed.
- `force_action` for privileged functions that bypass any checks. This can be useful for specific benchmarking functions. - `force_action_` for privileged functions that bypass any checks. This can be useful for specific benchmarking functions.
- `check_` for functions performing checks and triggering errors in case of failure. - `check_` for functions performing checks and triggering errors in case of failure.
resources/metadata.scale
+ 0
− 0
View file @ 2b7cdefc
No preview for this file type
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment