[DOCUMENT] Interfaces for the M3 Relay Protocol (issue-#265)

[andrewnguyen22]

Description

Code / document interfaces for the Relay Protocol to enable consensus and understanding around this piece of the M3 milestone.

M3 Milestone

This is the first step into beginning the Relay Protocol development.

• Clear interface(s) that show the lifecycle of the relay protocol
• Clear documentation supporting the above

Issue

Fixes #265

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Major breaking change
• Documentation
• Other

List of changes

• Added Relay Protocol interfaces and diagrams

Testing

• make develop_test
• LocalNet w/ all of the steps outlined in the README

Required Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have tested my changes using the available tooling
• I have updated the corresponding CHANGELOG

If Applicable Checklist

• I have updated the corresponding README(s); local and/or global
• I have added tests that prove my fix is effective or that my feature works
• I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[Olshansk]

I haven't reviewed utility/service/service.go yet but left some comments on utility/service/README.md and figured I'd submit a first review.

Most NITS, a couple questions, and just one idea I wanted to get your thoughts on.

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@bcadafd). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #306   +/-   ##
=======================================
  Coverage        ?   40.06%           
=======================================
  Files           ?       28           
  Lines           ?     2184           
  Branches        ?        0           
=======================================
  Hits            ?      875           
  Misses          ?     1255           
  Partials        ?       54           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Olshansk]

Should this be from config files from the on-chain state?

Asking because we store the supported RelayChains on chain

[andrewnguyen22]

It's both technically, but definitely locally is a validation point

[Olshansk]

Approved with one minor remaining NIT.