Skip to content

Commit

Permalink
[1753]: Bring the sanction spec docs in-line with the others. Fix to …
Browse files Browse the repository at this point in the history
…properly link to the module readmes.
  • Loading branch information
SpicyLemon committed Nov 28, 2023
1 parent 853fab2 commit bfd2997
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 39 deletions.
1 change: 1 addition & 0 deletions x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
24 changes: 12 additions & 12 deletions x/sanction/spec/04_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,39 @@ 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

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

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

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

Expand Down
28 changes: 1 addition & 27 deletions x/sanction/spec/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sanction Module
# `x/sanction`

## Abstract

Expand All @@ -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)

0 comments on commit bfd2997

Please sign in to comment.