diff --git a/x/README.md b/x/README.md index af055f45b4..66517b66bf 100644 --- a/x/README.md +++ b/x/README.md @@ -19,4 +19,5 @@ Provenance uses inherited modules from the Cosmos SDK, and has also developed mo * [Name](./name/README.md) - Provides a system for providing human-readable names as aliases for addresses. * [Oracle](./oracle/README.md) - Provides the capability to dynamically expose query endpoints. * [Reward](./reward/README.md) - Provides a system for distributing rewards to accounts. +* [Sanction](./sanction/spec/README.md) - Provides a mechanism for sanctioning accounts. * [Trigger](./trigger/README.md) - Provides a system for triggering transactions based on predeterminded events. diff --git a/x/sanction/spec/04_events.md b/x/sanction/spec/04_events.md index 62a22a61b7..c60c38129f 100644 --- a/x/sanction/spec/04_events.md +++ b/x/sanction/spec/04_events.md @@ -8,9 +8,9 @@ This event is emitted when an account is sanctioned. `@Type`: `/provenance.sanction.v1.EventAddressSanctioned` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| address | {bech32 string of sanctioned account} | +| Attribute Key | Attribute Value | +|---------------|-----------------------------------------| +| address | \{bech32 string of sanctioned account\} | ## EventAddressUnsanctioned @@ -18,9 +18,9 @@ This event is emitted when an account is unsanctioned. `@Type`: `/provenance.sanction.v1.EventAddressUnsanctioned` -| Attribute Key | Attribute Value | -|---------------|-----------------------------------------| -| address | {bech32 string of unsanctioned account} | +| Attribute Key | Attribute Value | +|---------------|-------------------------------------------| +| address | \{bech32 string of unsanctioned account\} | ## EventTempAddressSanctioned @@ -28,9 +28,9 @@ This event is emitted when a temporary sanction is placed on an account. `@Type`: `/provenance.sanction.v1.EventTempAddressSanctioned` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| address | {bech32 string of sanctioned account} | +| Attribute Key | Attribute Value | +|---------------|-----------------------------------------| +| address | \{bech32 string of sanctioned account\} | ## EventTempAddressUnsanctioned @@ -38,9 +38,9 @@ This event is emitted when a temporary unsanction is placed on an account. `@Type`: `/provenance.sanction.v1.EventTempAddressUnsanctioned` -| Attribute Key | Attribute Value | -|---------------|-----------------------------------------| -| address | {bech32 string of unsanctioned account} | +| Attribute Key | Attribute Value | +|---------------|-------------------------------------------| +| address | \{bech32 string of unsanctioned account\} | ## EventParamsUpdated diff --git a/x/sanction/spec/README.md b/x/sanction/spec/README.md index 90aaf1db4e..4a26d5095c 100644 --- a/x/sanction/spec/README.md +++ b/x/sanction/spec/README.md @@ -1,4 +1,4 @@ -# Sanction Module +# `x/sanction` ## Abstract @@ -8,34 +8,8 @@ It injects a restriction into the `x/bank` module to enforce these sanctions. ## Contents 1. **[Concepts](01_concepts.md)** - - [Sanctioned Account](01_concepts.md#sanctioned-account) - - [Immediate Temporary Sanctions](01_concepts.md#immediate-temporary-sanctions) - - [Unsanctioning](01_concepts.md#unsanctioning) - - [Immediate Temporary Unsanctions](01_concepts.md#immediate-temporary-unsanctions) - - [Unsanctionable Addresses](01_concepts.md#unsanctionable-addresses) - - [Params](01_concepts.md#params) - - [Complex Interactions](01_concepts.md#complex-interactions) 2. **[State](02_state.md)** - - [Params](02_state.md#params) - - [Sanctioned Accounts](02_state.md#sanctioned-accounts) - - [Temporary Entries](02_state.md#temporary-entries) - - [Temporary Index](02_state.md#temporary-index) 3. **[Msg Service](03_messages.md)** - - [Msg/Sanction](03_messages.md#msgsanction) - - [Msg/Unsanction](03_messages.md#msgunsanction) - - [Msg/UpdateParams](03_messages.md#msgupdateparams) 4. **[Events](04_events.md)** - - [EventAddressSanctioned](04_events.md#eventaddresssanctioned) - - [EventAddressUnsanctioned](04_events.md#eventaddressunsanctioned) - - [EventTempAddressSanctioned](04_events.md#eventtempaddresssanctioned) - - [EventTempAddressUnsanctioned](04_events.md#eventtempaddressunsanctioned) - - [EventParamsUpdated](04_events.md#eventparamsupdated) 5. **[gRPC Queries](05_queries.md)** - - [Query/IsSanctioned](05_queries.md#queryissanctioned) - - [Query/SanctionedAddresses](05_queries.md#querysanctionedaddresses) - - [Query/TemporaryEntries](05_queries.md#querytemporaryentries) - - [Query/Params](05_queries.md#queryparams) 6. **[Client](06_client.md)** - - [gRPC](06_client.md#grpc) - - [CLI](06_client.md#cli) - - [REST](06_client.md#rest) \ No newline at end of file