Mukan Erkin Törük
6852832fe8
Some checks failed
CodeQL / Analyze (push) Waiting to run
Docker Build & Push Simapp (main) / docker-build (push) Waiting to run
golangci-lint / lint (push) Waiting to run
Tests / Code Coverage / build (amd64) (push) Waiting to run
Tests / Code Coverage / build (arm64) (push) Waiting to run
Tests / Code Coverage / unit-tests (map[additional-args:-tags="test_e2e" name:e2e path:./e2e]) (push) Waiting to run
Tests / Code Coverage / unit-tests (map[name:08-wasm path:./modules/light-clients/08-wasm]) (push) Waiting to run
Tests / Code Coverage / unit-tests (map[name:ibc-go path:.]) (push) Waiting to run
Deploy to GitHub Pages / Deploy to GitHub Pages (push) Has been cancelled
Buf-Push / push (push) Has been cancelled
53 lines
2.4 KiB
Markdown
53 lines
2.4 KiB
Markdown
---
|
|
title: Relayer
|
|
sidebar_label: Relayer
|
|
sidebar_position: 7
|
|
slug: /ibc/relayer
|
|
---
|
|
|
|
# Relayer
|
|
|
|
:::note
|
|
|
|
## Pre-requisite readings
|
|
|
|
- [IBC Overview](01-overview.md)
|
|
- [Events](https://docs.cosmos.network/main/learn/advanced/events)
|
|
|
|
:::
|
|
|
|
## Events
|
|
|
|
Events are emitted for every transaction processed by the base application to indicate the execution
|
|
of some logic clients may want to be aware of. This is extremely useful when relaying IBC packets.
|
|
Any message that uses IBC will emit events for the corresponding TAO logic executed as defined in
|
|
the [IBC events document](/events/events).
|
|
|
|
In the SDK, it can be assumed that for every message there is an event emitted with the type `message`,
|
|
attribute key `action`, and an attribute value representing the type of message sent
|
|
(`channel_open_init` would be the attribute value for `MsgChannelOpenInit`). If a relayer queries
|
|
for transaction events, it can split message events using this event Type/Attribute Key pair.
|
|
|
|
The Event Type `message` with the Attribute Key `module` may be emitted multiple times for a single
|
|
message due to application callbacks. It can be assumed that any TAO logic executed will result in
|
|
a module event emission with the attribute value `ibc_<submodulename>` (02-client emits `ibc_client`).
|
|
|
|
### Subscribing with Tendermint
|
|
|
|
Calling the Tendermint RPC method `Subscribe` via Tendermint's Websocket will return events using
|
|
Tendermint's internal representation of them. Instead of receiving back a list of events as they
|
|
were emitted, Tendermint will return the type `map[string][]string` which maps a string in the
|
|
form `<event_type>.<attribute_key>` to `attribute_value`. This causes extraction of the event
|
|
ordering to be non-trivial, but still possible.
|
|
|
|
A relayer should use the `message.action` key to extract the number of messages in the transaction
|
|
and the type of IBC transactions sent. For every IBC transaction within the string array for
|
|
`message.action`, the necessary information should be extracted from the other event fields. If
|
|
`send_packet` appears at index 2 in the value for `message.action`, a relayer will need to use the
|
|
value at index 2 of the key `send_packet.packet_sequence`. This process should be repeated for each
|
|
piece of information needed to relay a packet.
|
|
|
|
## Example Implementations
|
|
|
|
- [Golang Relayer](https://github.com/cosmos/relayer)
|
|
- [Hermes](https://github.com/informalsystems/hermes)
|