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

Jump to bottom

docs: add detailed explanation about default events #1083

Merged
merged 3 commits into from
Sep 20, 2023
Merged

docs: add detailed explanation about default events #1083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad2435c
docs: add detailed explanation about default events
ryu1-sakai Aug 17, 2023
b47dcb6
Update CHANGELOG.md
ryu1-sakai Aug 17, 2023
2cdfa90
improve redundant sentences
ryu1-sakai Sep 12, 2023
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Build, CI

### Document Updates
* (docs) [\#1083](https://github.com/Finschia/finschia-sdk/pull/1083) Add detailed explanation about default events
6 changes: 6 additions & 0 deletions docs/docs/core/08-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ There are a few events that are automatically emitted for all messages, directly
* `message.sender`: The address of the message signer.
* `message.module`: The name of the module that emitted the message.

:::tip
`baseapp` emits exactly one `message` event for each message before any other events emitted by the message.
The `message` event contains at least 2 attributes, exactly one `action` and exactly one `sender`.
The position of the event may change in the next major version.
:::

:::tip
The module name is assumed by `baseapp` to be the second element of the message route: `"cosmos.bank.v1beta1.MsgSend" -> "bank"`.
In case a module does not follow the standard message path, (e.g. IBC), it is advised to keep emitting the module name event.
Expand Down
Loading