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

update metadata and docs

parent de534f42
No related branches found
No related tags found
No related merge requests found
Pipeline #34658 passed
......@@ -13,7 +13,7 @@ through on-chain governance mechanisms.
## User calls
There are **79** user calls from **23** pallets.
There are **80** user calls from **23** pallets.
### Account - 1
......@@ -694,6 +694,20 @@ Revoke an identity using a revocation signature
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
<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
## Root calls
There are **20** root calls from **10** pallets.
There are **19** root calls from **10** pallets.
### System - 0
......@@ -1802,20 +1816,6 @@ O(P) where P is the number of max proposals
### 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
<details><summary><code>prune_item_identities_names(names)</code></summary>
......
......@@ -638,7 +638,7 @@ Insufficient certifications received to claim membership.
<li>
<details>
<summary>
<code>DistanceNotOK</code> - 1</summary>
<code>DistanceNotOk</code> - 1</summary>
Distance has not received a positive evaluation.
</details>
</li>
......@@ -966,7 +966,7 @@ Insufficient certifications received to claim membership.
<li>
<details>
<summary>
<code>DistanceNotOK</code> - 1</summary>
<code>DistanceNotOk</code> - 1</summary>
Distance has not received a positive evaluation.
</details>
</li>
......
# Runtime events
There are **130** events from **37** pallets.
There are **129** events from **37** pallets.
<ul>
<li>System - 0
......@@ -1182,11 +1182,12 @@ reason: IdtyRemovalReason<T::IdtyRemovalOtherReason>
<li>
<details>
<summary>
<code>MembershipAcquired()</code> - 0</summary>
<code>MembershipAcquired(member, expire_on)</code> - 0</summary>
A membership was acquired.
```rust
: T::IdtyId
member: T::IdtyId
expire_on: BlockNumberFor<T>
```
</details>
......@@ -1194,11 +1195,12 @@ A membership was acquired.
<li>
<details>
<summary>
<code>MembershipExpired()</code> - 1</summary>
A membership expired.
<code>MembershipTerminated(member, reason)</code> - 1</summary>
A membership was terminated.
```rust
: T::IdtyId
member: T::IdtyId
reason: MembershipTerminationReason
```
</details>
......@@ -1206,11 +1208,12 @@ A membership expired.
<li>
<details>
<summary>
<code>MembershipRenewed()</code> - 2</summary>
A membership was renewed.
<code>PendingMembershipAdded(member, expire_on)</code> - 2</summary>
A pending membership was added.
```rust
: T::IdtyId
member: T::IdtyId
expire_on: BlockNumberFor<T>
```
</details>
......@@ -1218,35 +1221,11 @@ A membership was renewed.
<li>
<details>
<summary>
<code>MembershipRequested()</code> - 3</summary>
A membership was requested.
<code>PendingMembershipExpired(member)</code> - 3</summary>
A pending membership has expired.
```rust
: 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
member: T::IdtyId
```
</details>
......@@ -1303,22 +1282,27 @@ receiver: T::IdtyIndex
</li>
<li>Distance - 44
<ul>
</ul>
</li>
<li>SmithSubWot - 50
<ul>
</ul>
<li>
<details>
<summary>
<code>EvaluationRequested(idty_index, who)</code> - 0</summary>
A distance evaluation was requested.
```rust
idty_index: T::IdtyIndex
who: T::AccountId
```
</details>
</li>
<li>SmithMembership - 52
<ul>
<li>
<details>
<summary>
<code>MembershipAcquired()</code> - 0</summary>
A membership was acquired.
<code>EvaluationUpdated(evaluator)</code> - 1</summary>
A distance evaluation was updated.
```rust
: T::IdtyId
evaluator: T::AccountId
```
</details>
......@@ -1326,23 +1310,33 @@ A membership was acquired.
<li>
<details>
<summary>
<code>MembershipExpired()</code> - 1</summary>
A membership expired.
<code>EvaluationStatusForced(idty_index, status)</code> - 2</summary>
A distance status was forced.
```rust
: T::IdtyId
idty_index: T::IdtyIndex
status: Option<(<T as frame_system::Config>::AccountId, DistanceStatus)>
```
</details>
</li>
</ul>
</li>
<li>SmithSubWot - 50
<ul>
</ul>
</li>
<li>SmithMembership - 52
<ul>
<li>
<details>
<summary>
<code>MembershipRenewed()</code> - 2</summary>
A membership was renewed.
<code>MembershipAcquired(member, expire_on)</code> - 0</summary>
A membership was acquired.
```rust
: T::IdtyId
member: T::IdtyId
expire_on: BlockNumberFor<T>
```
</details>
......@@ -1350,11 +1344,12 @@ A membership was renewed.
<li>
<details>
<summary>
<code>MembershipRequested()</code> - 3</summary>
A membership was requested.
<code>MembershipTerminated(member, reason)</code> - 1</summary>
A membership was terminated.
```rust
: T::IdtyId
member: T::IdtyId
reason: MembershipTerminationReason
```
</details>
......@@ -1362,11 +1357,12 @@ A membership was requested.
<li>
<details>
<summary>
<code>MembershipRevoked()</code> - 4</summary>
A membership was revoked.
<code>PendingMembershipAdded(member, expire_on)</code> - 2</summary>
A pending membership was added.
```rust
: T::IdtyId
member: T::IdtyId
expire_on: BlockNumberFor<T>
```
</details>
......@@ -1374,11 +1370,11 @@ A membership was revoked.
<li>
<details>
<summary>
<code>PendingMembershipExpired()</code> - 5</summary>
A pending membership request has expired.
<code>PendingMembershipExpired(member)</code> - 3</summary>
A pending membership has expired.
```rust
: T::IdtyId
member: T::IdtyId
```
</details>
......
No preview for this file type
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment