117 lines
4.8 KiB
Markdown
117 lines
4.8 KiB
Markdown
<!--
|
|
order: 7
|
|
-->
|
|
|
|
# Events
|
|
|
|
`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. {synopsis}
|
|
|
|
## Pre-requisite Readings
|
|
|
|
- [Anatomy of an SDK application](../basics/app-anatomy.md) {prereq}
|
|
|
|
## Events
|
|
|
|
Events are implemented in the Cosmos SDK as an alias of the ABCI `Event` type and
|
|
take the form of: `{eventType}.{eventAttribute}={value}`.
|
|
|
|
+++ https://github.com/tendermint/tendermint/blob/bc572217c07b90ad9cee851f193aaa8e9557cbc7/abci/types/types.pb.go#L2187-L2193
|
|
|
|
Events contain:
|
|
|
|
- A `type`, which is meant to categorize an event at a high-level (e.g. by module or action).
|
|
- A list of `attributes`, which are key-value pairs that give more information about
|
|
the categorized `event`.
|
|
+++ https://github.com/cosmos/cosmos-sdk/blob/7d7821b9af132b0f6131640195326aa02b6751db/types/events.go#L51-L56
|
|
|
|
Events are returned to the underlying consensus engine in the response of the following ABCI messages:
|
|
|
|
- [`BeginBlock`](./baseapp.md#beginblock)
|
|
- [`EndBlock`](./baseapp.md#endblock)
|
|
- [`CheckTx`](./baseapp.md#checktx)
|
|
- [`DeliverTx`](./baseapp.md#delivertx)
|
|
|
|
Events, the `type` and `attributes`, are defined on a **per-module basis** in the module's
|
|
`/types/events.go` file, and triggered from the module's [`handler`](../building-modules/handler.md)
|
|
via the [`EventManager`](#eventmanager). In addition, each module documents its events under
|
|
`spec/xx_events.md`.
|
|
|
|
## EventManager
|
|
|
|
In Cosmos SDK applications, events are managed by an abstraction called the `EventManager`.
|
|
Internally, the `EventManager` tracks a list of `Events` for the entire execution flow of a
|
|
transaction or `BeginBlock`/`EndBlock`.
|
|
|
|
+++ https://github.com/cosmos/cosmos-sdk/blob/7d7821b9af132b0f6131640195326aa02b6751db/types/events.go#L16-L20
|
|
|
|
The `EventManager` comes with a set of useful methods to manage events. Among them, the one that is
|
|
used the most by module and application developers is the `EmitEvent` method, which tracks
|
|
an `event` in the `EventManager`.
|
|
|
|
+++ https://github.com/cosmos/cosmos-sdk/blob/7d7821b9af132b0f6131640195326aa02b6751db/types/events.go#L29-L31
|
|
|
|
Module developers should handle event emission via the `EventManager#EmitEvent` in each message
|
|
`Handler` and in each `BeginBlock`/`EndBlock` handler. The `EventManager` is accessed via
|
|
the [`Context`](./context.md), where event emission generally follows this pattern:
|
|
|
|
```go
|
|
ctx.EventManager().EmitEvent(
|
|
sdk.NewEvent(eventType, sdk.NewAttribute(attributeKey, attributeValue)),
|
|
)
|
|
```
|
|
|
|
Module's `handler` function should also set a new `EventManager` to the `context` to isolate emitted events per `message`:
|
|
```go
|
|
func NewHandler(keeper Keeper) sdk.Handler {
|
|
return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
|
|
ctx = ctx.WithEventManager(sdk.NewEventManager())
|
|
switch msg := msg.(type) {
|
|
```
|
|
|
|
See the [`Handler`](../building-modules/handler.md) concept doc for a more detailed
|
|
view on how to typically implement `Events` and use the `EventManager` in modules.
|
|
|
|
## Subscribing to Events
|
|
|
|
It is possible to subscribe to `Events` via Tendermint's [Websocket](https://tendermint.com/docs/app-dev/subscribing-to-events-via-websocket.html#subscribing-to-events-via-websocket).
|
|
This is done by calling the `subscribe` RPC method via Websocket:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "subscribe",
|
|
"id": "0",
|
|
"params": {
|
|
"query": "tm.event='eventCategory' AND eventType.eventAttribute='attributeValue'"
|
|
}
|
|
}
|
|
```
|
|
|
|
The main `eventCategory` you can subscribe to are:
|
|
|
|
- `NewBlock`: Contains `events` triggered during `BeginBlock` and `EndBlock`.
|
|
- `Tx`: Contains `events` triggered during `DeliverTx` (i.e. transaction processing).
|
|
- `ValidatorSetUpdates`: Contains validator set updates for the block.
|
|
|
|
These events are triggered from the `state` package after a block is committed. You can get the
|
|
full list of `event` categories [here](https://godoc.org/github.com/tendermint/tendermint/types#pkg-constants).
|
|
|
|
The `type` and `attribute` value of the `query` allow you to filter the specific `event` you are looking for. For example, a `transfer` transaction triggers an `event` of type `Transfer` and has `Recipient` and `Sender` as `attributes` (as defined in the [`events` file of the `bank` module](https://github.com/cosmos/cosmos-sdk/blob/master/x/bank/types/events.go)). Subscribing to this `event` would be done like so:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "subscribe",
|
|
"id": "0",
|
|
"params": {
|
|
"query": "tm.event='Tx' AND transfer.sender='senderAddress'"
|
|
}
|
|
}
|
|
```
|
|
|
|
where `senderAddress` is an address following the [`AccAddress`](../basics/accounts.md#addresses) format.
|
|
|
|
## Next {hide}
|
|
|
|
Learn about SDK [telemetry](./telemetry.md) {hide}
|