Skip to content

Commit

Permalink
docs: document default events (#1081)
Browse files Browse the repository at this point in the history
* Add events docs

* Update CHANGELOG.md
  • Loading branch information
0Tech authored Aug 17, 2023
1 parent 3d482e2 commit 1df6411
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Build, CI

### Document Updates

* (docs) [\#1081](https://github.com/Finschia/finschia-sdk/pull/1081) Document default events
22 changes: 22 additions & 0 deletions docs/docs/core/08-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 1
---
# Events

:::note Synopsis
`Event`s are objects that contain information about the execution of the application. They are mainly used by service providers like block explorers and wallet to track the execution of various messages and index transactions.
:::

## Default Events

There are a few events that are automatically emitted for all messages, directly from `baseapp`.

* `message.action`: The name of the message type.
* `message.sender`: The address of the message signer.
* `message.module`: The name of the module that emitted the message.

:::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.
`Baseapp` only emits that event if the module have not already done so.
:::

0 comments on commit 1df6411

Please sign in to comment.