Add IBC events, handler and per chain monitor tasks #88

ancazamfir · 2020-06-09T08:58:36Z

Closes: #87

Description

Starting with informalsystems/ibc-rs#59 as base, extract attributes specific to IBC events.
Add monitor tasks, one per chain, that register for Tx and Block events with tendermint nodes.
Push the IBC events to the main handler task.

There are a few things to clarify:

can the IBC events be determined from "message.action" list? or a try for all possible events is needed (see Same message type for MsgPacket and MsgAcknowledgment cosmos/cosmos-sdk#6358)
~~need access to TMEventData::EventDataNewBlock() that is an Option; need to extract block height. I had to change tendermint for this.~~ fixed in Quickfix: make fields in event subscription accessible publicly tendermint-rs#312 and add Clone to EventSubscription tendermint-rs#315

For contributor use:

Unit tests written
Added test to CI if applicable
Updated CHANGELOG_PENDING.md
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Updated relevant documentation (docs/) and code comments
Re-reviewed Files changed in the Github PR explorer

romac

Just have some nitpicks and minor comments, looks good otherwise! (only reviewed it superficially, so not an endorsement w.r.t. to functionality, though nothing on that side jumped out to me :)

modules/Cargo.toml

modules/src/error.rs

modules/src/events.rs

modules/src/ics02_client/client_type.rs

modules/src/ics02_client/events.rs

modules/src/events.rs

codecov-commenter · 2020-06-09T21:39:35Z

Codecov Report

Merging #88 into master will decrease coverage by 3.3%.
The diff coverage is 0.1%.

@@           Coverage Diff            @@
##           master     #88     +/-   ##
========================================
- Coverage    14.5%   11.1%   -3.4%     
========================================
  Files          58      67      +9     
  Lines        2219    2825    +606     
  Branches      761    1002    +241     
========================================
- Hits          322     315      -7     
- Misses       1598    2211    +613     
  Partials      299     299

Impacted Files	Coverage Δ
modules/src/error.rs	`0.0% <0.0%> (ø)`
modules/src/events.rs	`0.0% <0.0%> (ø)`
modules/src/ics02_client/client_type.rs	`47.6% <0.0%> (ø)`
modules/src/ics02_client/events.rs	`0.0% <0.0%> (ø)`
modules/src/ics03_connection/events.rs	`0.0% <0.0%> (ø)`
modules/src/ics03_connection/msgs.rs	`20.2% <ø> (-0.9%)`	⬇️
modules/src/ics04_channel/events.rs	`0.0% <0.0%> (ø)`
modules/src/ics04_channel/msgs.rs	`21.6% <ø> (-0.7%)`	⬇️
modules/src/ics07_tendermint/msgs/create_client.rs	`0.0% <0.0%> (ø)`
modules/src/ics07_tendermint/msgs/update_client.rs	`0.0% <0.0%> (ø)`
... and 39 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf63bda...b10f0b4. Read the comment docs.

modules/src/events.rs

modules/src/ics02_client/events.rs

milosevic · 2020-06-12T14:42:03Z

relayer/relay/src/event_monitor.rs

+        channel_to_handler: Sender<(ChainId, Vec<IBCEvent>)>,
+    ) -> Result<Self, Box<dyn std::error::Error>> {
+        let mut event_listener = event_listener::EventListener::connect(rpc_addr.clone()).await?;
+        // TODO move them to config file(?)


Can we create issue for this?

milosevic · 2020-06-12T14:42:29Z

relayer/relay/src/event_monitor.rs

+    pub async fn collect_events(&mut self) -> Result<(), TMError> {
+        if let Some(tm_event) = self.event_listener.get_event().await? {
+            if let Ok(ibc_events) = relayer_modules::events::get_all_events(tm_event) {
+                // TODO - send_timeout()?


Can we create issue for this?

milosevic

Great work. I have created an issue for figuring out common format for IBC events informalsystems/ibc-rs#102.

* Add main event handler and per chain monitor tasks * Code review comments and fix clippy errors * Fix cargo fmt * Add command to start relayer in listen mode * Change to use anomaly::BoxError - review comment * Remove unused code - review comments

Add main event handler and per chain monitor tasks

d65a26c

ancazamfir added the work in progress label Jun 9, 2020

ancazamfir added this to the 0.5-5mo milestone Jun 9, 2020

ancazamfir requested a review from romac as a code owner June 9, 2020 08:58

ancazamfir self-assigned this Jun 9, 2020

ancazamfir changed the title ~~[WIP] Add main event handler and per chain monitor tasks~~ [WIP] Add IBC events, handler and per chain monitor tasks Jun 9, 2020

ancazamfir requested review from Shivani912 and zmanian June 9, 2020 09:04

romac reviewed Jun 9, 2020

View reviewed changes

ancazamfir added 2 commits June 9, 2020 23:21

Code review comments and clippy

d0ee1be

Merge branch 'master' into anca/monitor

714a976

ancazamfir added 3 commits June 9, 2020 23:42

cargo fmt fix

1b3681f

add command to start relayer in listen mode

3f845ad

review comment - change to use anomaly::BoxError

41276b7

ancazamfir changed the title ~~[WIP] Add IBC events, handler and per chain monitor tasks~~ Add IBC events, handler and per chain monitor tasks Jun 12, 2020

ancazamfir added I: CLI Internal: related to the relayer's CLI I: logic Internal: related to the relaying logic and removed work in progress labels Jun 12, 2020

ancazamfir requested a review from milosevic June 12, 2020 06:57