Relayer v0 MVP

[adizere]

Next third: Relayer v0 MVP

How to read this admin issue:

• This supersedes and expands on High Level Goal - IBC Relayer  #114 and 12.2020 - High Level Goal - IBC Handlers #119.
• Issues assigned to milestone v0.0.5 have the highest priority.
• Issues are clustered by crate, and ordered bottom-up: starting from crate ibc (deepest in the stack), then relayer and relayer-cli last.
• This tracks work at least until Dec. 31 2020 (for two upcoming releases, v0.0.5 and v0.0.6) -> edit up to Jan 31st 2021 v0.1.0
• Any issue labeled with dependencies should ideally:
  • (1) detail the dependency, and
  • (2) clarify the expectations on upstream teams (e.g., tendermint-rs, cosmos/ics, sdk) before starting work on the PR.

Work breakdown

The main short-term deliverable is #381, and on a medium term we target #216.
Like prior milestones, the primary goal here is to obtain an integration point between crate ibc and the relayer implementation, towards improving our testing.

General, technical debt:

• Upgrade all crates to at least version 0.1.0 Upgrade all crates to at least version 0.1.0 cosmos/ibc-rs#124
• Follow-up to migration work Follow-up to migration work #469
• Follow up on proto changes after deduplication fixes Follow up on proto changes after deduplication fixes cosmos/ibc-rs#107
• Issues with Light Client verification for relayer v0 MVP Issues with Light Client verification for relayer v0 MVP #410
• Migrate to stargate 6 Move to cosmos-sdk rc6 #503

ICS 04:

• Channel messages & domain type serialization Implement the channel message domain types cosmos/ibc-rs#105
• Packets, Ack, and Timeout
  • Messages & domain type Packet Domain Types cosmos/ibc-rs#134
• channOpenInit handler Implement ChanOpenInit handler cosmos/ibc-rs#97

IBC Module improvements:

• Follow up on proto changes after deduplication fixes Follow up on proto changes after deduplication fixes cosmos/ibc-rs#107
• Extract the type_url explicit strings into constants Extract the type_url explicit strings into constants #254

Protos and events:

• ibc-proto: Add Cosmos SDK sources as a Git submodule ibc-proto: Add Cosmos SDK sources as a Git submodule cosmos/ibc-proto-rs#20

Relayer queries

• The list of queries tracked separately by Implement the chain queries required by the relayer #128.

Relayer application

The relayer application follows the decomposition laid out in ADR-004.

• Implementation of ADR-005 relayer concurrency, split across:
  • Chain thread: Runtime implementation Chain Runtime #330
  • Link module Relayer link implementation #328
  • Monitor/subscription Implement relayer v0 event filtering #380
  • Relayer v0 config executor implementation Relayer v0 config executor implementation #382
  • (Sink issue) Implement concurrency architecture Implement the Relayer v0 concurrency architecture #327
• Main thread logic:
  • Implement query_header_at_height() Implement query_header_at_height() #336
  • Configuration and parameters relayer V0 command: configuration and parameters #346
  • Client lifecycle Implement Client lifecycle in relayer v0 #376
  • Connection lifecycle Implement Connection lifecycle in relayer v0 #377
  • Channel lifecycle Implement channel lifecycle in relayer v0 #378
  • Packet events & relay Implement Packet lifecycle in relayer v0 #379
• Implement basic keystore for V0 testing
  • Command to add a key to a configured chain in the relayer Command to add a key to a configured chain in the relayer #363

Relayer configuration:

• Align relayer config file with the light client config Align relayer config file with the light client config #99

Relayer CLI TX

The goal here is to add support for relayer tx raw <command> CLI for manipulating various IBC objects. These are valuable for testing & debugging. They also provide the building blocks for the relayer main thread.

ICS02 / Client lifecycle CLIs:

• Client Create Relayer CLIs for client create messages #207
• Client Update Relayer CLIs for client update message #277

ICS03 / Connection open handshake CLIs:

• Tracked in Relayer CLIs for connection messages #208 and decomposed into
  • ConnOpenInit Implement relayer CLI for MsgConnectionOpenInit #206
  • ConnOpenTry Relayer CLI for MsgConnectionOpenTry #358
  • ConnOpenAck Relayer CLI for MsgConnectionOpenAck #359
  • ConnOpenConfirm Relayer CLI for MsgConnectionOpenConfirm #360

ICS04 / Channel & Packet lifecycle CLIs:

• MsgChannelOpenInit Relayer CLI for MsgChannelOpenInit #371
• MsgChannelOpenTry Relayer CLI for MsgChannelOpenTry #372
• MsgChannelOpenAck Relayer CLI for MsgChannelOpenAck #373
• MsgChannelOpenConfirm Relayer CLI for MsgChannelOpenConfirm #374
• MsgRecvPacket Packet CLIs for recv_packet #443
• MsgChannelCloseInit, MsgChannelCloseConfirm, MsgTransfer, MsgTimeout, MsgAcknowledgement

Testing & debugging

• Integration tests for IBC queries Infrastructure to support running integration tests #32
• Automatic client updates
  • Mock context should accommodate TM light blocks Mock context should accommodate TM light blocks cosmos/ibc-rs#100
  • Local chain Local chain type #158,
  • Client ping pong against local chain Relayer v0 tests for client update ping pong #381,
• Upgrade simapp files to run with latest simd Upgrade simapp files to run with latest simd #204

Backlog:

Some issues that are very low priority, or will not be attempted altogether in v0:

• Channel handler implementation Implement the channel message handlers cosmos/ibc-rs#104
• Packet handlers implementation Handler for Packets (ICS 004) cosmos/ibc-rs#101
• Update Relayer ADR Update Relayer ADR #67
• Investigate and clean the validate_basic method Investigate and clean the validate_basic method cosmos/ibc-rs#135
• Introduce datagram domain type Introduce datagram domain type #288
• Modular logic for ICS3 Connection handshake protocol Modular logic for ICS3 Connection handshake protocol #92
• Extract mocks protos from the ibc-proto crate into the ibc crate Extract mocks protos from the ibc-proto crate into the ibc crate cosmos/ibc-proto-rs#19
• Figure out a common format for IBC events Figure out common format for IBC events cosmos/ibc-rs#31
• Model-based testing for ICS02 via ICS26 Model-based testing for ICS02 via ICS26 #324
• Client Upgrade Relayer CLI for client upgrade message #357
• Where should thetrust_threshold and trusting_period configuration params live? Where should thetrust_threshold and trusting_period configuration params live? #356
• Error wrapping and conversion between modules Error wrapping and conversion between modules #68

[ancazamfir]

All issues closed

[romac]

Wow. Amazing work, @ancazamfir and @adizere!