Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Escape the brackets in sanction and quarantine docs #1974

Closed
wants to merge 9 commits into from
Closed

Escape the brackets in sanction and quarantine docs #1974

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0d3a511
Escape the brackets in sanction and quarantine docs
webbushka May 15, 2024
f9af7d4
Merge branch 'main' into aj/docs-escape-brackets
webbushka May 16, 2024
7950aa2
Reset white space
webbushka May 21, 2024
ad2c5e4
Merge branch 'aj/docs-escape-brackets' of github.com:provenance-io/pr…
webbushka May 21, 2024
73a1977
Merge branch 'main' into aj/docs-escape-brackets
SpicyLemon May 21, 2024
575d8ca
Merge branch 'main' into aj/docs-escape-brackets
SpicyLemon May 21, 2024
607cff8
Merge branch 'main' into aj/docs-escape-brackets
webbushka May 21, 2024
1caa42d
Merge branch 'main' into aj/docs-escape-brackets
SpicyLemon May 24, 2024
aa8faaa
Merge branch 'main' into aj/docs-escape-brackets
iramiller May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions x/quarantine/spec/04_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,31 @@
The `x/quarantine` module emits the following events.

<!-- TOC -->
- [EventOptIn](#eventoptin)
- [EventOptOut](#eventoptout)
- [EventFundsQuarantined](#eventfundsquarantined)
- [EventFundsReleased](#eventfundsreleased)

- [EventOptIn](#eventoptin)
- [EventOptOut](#eventoptout)
- [EventFundsQuarantined](#eventfundsquarantined)
- [EventFundsReleased](#eventfundsreleased)
webbushka marked this conversation as resolved.
Show resolved Hide resolved

## EventOptIn

This event is emitted when an account opts into quarantine.

`@Type`: `/cosmos.quarantine.v1beta1.EventOptIn`

| Attribute Key | Attribute Value |
|---------------|--------------------------------------|
| to_address | {bech32 string of account opting in} |
| Attribute Key | Attribute Value |
| ------------- | -------------------------------------- |
| to_address | \{bech32 string of account opting in\} |
webbushka marked this conversation as resolved.
Show resolved Hide resolved

## EventOptOut

This event is emitted when an account opts out of quarantine.

`@Type`: `/cosmos.quarantine.v1beta1.EventOptOut`

| Attribute Key | Attribute Value |
|---------------|---------------------------------------|
| to_address | {bech32 string of account opting out} |
| Attribute Key | Attribute Value |
| ------------- | --------------------------------------- |
| to_address | \{bech32 string of account opting out\} |

## EventFundsQuarantined

Expand All @@ -35,18 +36,18 @@ The following event is also emitted.

`@Type`: `/cosmos.quarantine.v1beta1.EventFundsQuarantined`

| Attribute Key | Attribute Value |
|---------------|---------------------------------------|
| to_address | {bech32 string of intended recipient} |
| coins | {sdk.Coins of funds quarantined} |
| Attribute Key | Attribute Value |
| ------------- | --------------------------------------- |
| to_address | \{bech32 string of intended recipient\} |
| coins | \{sdk.Coins of funds quarantined\} |

## EventFundsReleased

This event is emitted when funds are fully accepted and sent from the quarantine funds holder to the originally intended recipient.

`@Type`: `/cosmos.quarantine.v1beta1.EventFundsReleased`

| Attribute Key | Attribute Value |
|---------------|-------------------------------|
| to_address | {bech32 string of recipient} |
| coins | {sdk.Coins of funds released} |
| Attribute Key | Attribute Value |
| ------------- | ------------------------------- |
| to_address | \{bech32 string of recipient\} |
| coins | \{sdk.Coins of funds released\} |
37 changes: 19 additions & 18 deletions x/sanction/spec/04_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,52 @@
The `x/sanction` module emits the following events.

<!-- TOC -->
- [EventAddressSanctioned](#eventaddresssanctioned)
- [EventAddressUnsanctioned](#eventaddressunsanctioned)
- [EventTempAddressSanctioned](#eventtempaddresssanctioned)
- [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned)
- [EventParamsUpdated](#eventparamsupdated)

- [EventAddressSanctioned](#eventaddresssanctioned)
- [EventAddressUnsanctioned](#eventaddressunsanctioned)
- [EventTempAddressSanctioned](#eventtempaddresssanctioned)
- [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned)
- [EventParamsUpdated](#eventparamsupdated)

## EventAddressSanctioned

This event is emitted when an account is sanctioned.

`@Type`: `/cosmos.sanction.v1beta1.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`: `/cosmos.sanction.v1beta1.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`: `/cosmos.sanction.v1beta1.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`: `/cosmos.sanction.v1beta1.EventTempAddressUnsanctioned`

| Attribute Key | Attribute Value |
|---------------|-----------------------------------------|
| address | {bech32 string of unsanctioned account} |
| Attribute Key | Attribute Value |
| ------------- | ----------------------------------------- |
| address | \{bech32 string of unsanctioned account\} |

## EventParamsUpdated

Expand All @@ -56,5 +57,5 @@ This event is emitted when the `x/sanction` module's params are updated.
`@Type`: `/cosmos.sanction.v1beta1.EventParamsUpdated`
SpicyLemon marked this conversation as resolved.
Show resolved Hide resolved

| Attribute Key | Attribute Value |
|---------------|-----------------|
| ------------- | --------------- |
| (none) | |
Loading