Relayer documentation #589

romac · 2021-01-29T17:49:23Z

Closes: #542
Closes: #577

TODOs:

For contributor use:

Updated the Unreleased section of CHANGELOG.md with the issue.
If applicable: Unit tests written, added test to CI.
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.

…542)

…glossary (#542)

…ucture refactor (#542)

codecov-io · 2021-01-31T19:02:13Z

Codecov Report

Merging #589 (cf961c3) into master (b1b37f5) will increase coverage by 30.9%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master    #589      +/-   ##
=========================================
+ Coverage    13.6%   44.6%   +30.9%     
=========================================
  Files          69     144      +75     
  Lines        3752    9532    +5780     
  Branches     1374       0    -1374     
=========================================
+ Hits          513    4255    +3742     
- Misses       2618    5277    +2659     
+ Partials      621       0     -621

Impacted Files	Coverage Δ
modules/src/address.rs	`100.0% <ø> (ø)`
...application/ics20_fungible_token_transfer/error.rs	`0.0% <ø> (ø)`
...pplication/ics20_fungible_token_transfer/events.rs	`0.0% <ø> (ø)`
...ion/ics20_fungible_token_transfer/msgs/transfer.rs	`0.0% <ø> (ø)`
modules/src/events.rs	`0.0% <ø> (ø)`
modules/src/handler.rs	`100.0% <ø> (ø)`
modules/src/ics02_client/client_def.rs	`48.3% <ø> (ø)`
modules/src/ics02_client/client_type.rs	`79.1% <ø> (+31.5%)`	⬆️
modules/src/ics02_client/context.rs	`100.0% <ø> (ø)`
modules/src/ics02_client/error.rs	`100.0% <ø> (ø)`
... and 246 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 605b755...cc299aa. Read the comment docs.

ebuchman · 2021-01-31T22:43:36Z

…into andy/docs

romac · 2021-02-01T12:15:50Z

@ebuchman

packet relaying:

packet data is bytes, should be at least hex, better if JSON ...

Given that the data field is defined in the .proto file as an opaque byte array, I am not sure how we would proceed to display it a JSON. Is this field typically JSON or Protobuf-encoded? If so, then we could perhaps try to optimistically decode it as either and fall back to hex if that didn't work.

https://github.com/informalsystems/ibc-rs/blob/97f27e3475d159660ba0af6724732f071fd2616d/proto/src/prost/ibc.core.channel.v1.rs#L80-L82

This reverts commit c4f8509.

…into andy/docs

ancazamfir

Amazing work everyone!! This has been an ironman race, let's merge this!

* Initial documentation using mdbook (informalsystems#542) * Added README page to the guide with instructions. Fix index page (informalsystems#542) * Added more content mostly in the configuration section (informalsystems#542) * Some cleaning up and adding some placeholder content to a few pages (informalsystems#542) * Added information to the index page (informalsystems#542) * Added more content, new sections (most under in transactions), added glossary (informalsystems#542) * Added info to light client page, additional theme change and some structure refactor (informalsystems#542) * Added content for keys. Updated some commands references. (informalsystems#542) * Added tutorial section. Breakdown tutorial (informalsystems#542) * More content to tutorial (informalsystems#542) * Adding more content to tutorial (informalsystems#542) * Update relay_packets.md * Adding more content, fixing content mostly in local chains file (informalsystems#542) * Fixing some content to show hermes (informalsystems#542) * Added content to the create-client section (informalsystems#452) * Review sections 1-3 * Revew 3.1, remove loop_config, add config_example.toml * Small layout change * fix CLI examples * fixed and clarified ID parameters * Format bytearrays as hex-encoded strings in various commands * Formatting * Added 4.3.1 and 4.5.1 * fix query client doc * fix query client connections doc * Add the relayer_loop doc * Add documentation for tx raw connection commands and change from positional arguments to flags * Avoid duplicate tag name for ConnectionEnd, ChannelEnd, AnyConsensusState and AnyClientState * Fix JSON output in `tx raw` connection guide * Update guide following 1ed6147 * Remove tags on ChannelEnd and ConnectionEnd * Add documentation for query connection commands * json for client commands, fix in relayer loop doc * Add documentation for query channel(s) commands * Improve output of Python script a bit * Adding guide build CI workflow (informalsystems#542) * tx packet section, changed packet-send to ft-transfer * Some css changes to better show few things (informalsystems#542) * formatting * Work around gumdrop limitation which cuts off flags help text if too long * Add documentation for tx raw chan-* commands * Fix typo in e2e Python script * Adapt e2e script to new flags of tx conn commands * Add stub doc for tx raw chan-close-* commands * Fix typo * Improve tx raw conn-* doc * Improve tx raw chan-open-* doc * Only return a single result from Output type, to avoid unnecessary brackets in JSON output * Add diagrams to tx channel and tx connection pages * packet query docs * starting on feature summary * Fix typo * Adapt mermaid theme to mdbook theme * Add chan-close results to doc and to e2e script (disabled for now) * Rename events to listen mode and add listen command * File to support custom domain (informalsystems#542) * Fix mermaid theme detection * Improve conn and chan diagrams * Adding step to install mdbook-mermaid (informalsystems#542) * Adding step to install mdbook-mermaid on CI (informalsystems#542) * Removing full path from config example (informalsystems#542) * Remove log statement * Fixing type in guide.yml (informalsystems#542) * renamed troubleshoot [test] * Look for default config in ~/.hermes/config.toml and update guide * Minor stylistic change * Added Help * Split dev-env script into setup-chains and init-clients * Breakdown of the relay packets into separate sections (informalsystems#542) * Fixed links in help.md * Formatting * Fixing color for navigation buttons in mobile display (informalsystems#542) * Fix gaia version (informalsystems#542) * Added pre-requisite (Golang) needed for gaia (informalsystems#542) * Adding more content to the local_chains page (informalsystems#542) * remove order flag from tx chan clis * Add high level content in transactions * add clarification on identifiers and start cleaning 4.1.3 subsections * restructure tutorial * add relay path tutorial * Finish the channel close handshake commands referrence * remove forgotten wip * Move chan-close commands to their own section * Remove duplicate content * Moved miscellaneous into help. Consolidated the help section. * review 1-3 * Add section to install hermes via cargo install * Rename Setup page to Installation * Patching gaia * features and matrix * Add [[connections]] section to config.toml * Whitespace * Touch up feature matrix a bit * small nits * Uppercase feature descriptions * typo fix and added link * merge features in a new column in matrix, fix a few entries * cleanup * formatting * Index nits * Getting started, prereq * Fixed hyperlinks to installation.md * remove the operation instructions * Fixed tutorial URLS * Fixed URLS in commands and local_chains.md * Queries overview * Relayer CLI readme stripped down to essentials * changelog * review up to 5.2 * review 5.3 * review 5.4 * finish 5 review * Add instructions for running two relayers for bidirectional relaying * Fix broken links found with mdbook-linkcheck * Check for broken links on CI * Revert "Check for broken links on CI" This reverts commit c4f8509. * Main readme. Some fixes * Fix typo * Hermes <> IBC Relayer CLI * Fix a couple more typos * Unify Transactions and Queries index pages * Remove $ prefix in front of commands for easier copy-paste * fix concurrent packet relay section * Update title of two paths page * Disambiguation Hermes<>CLI * More explanation re: CLI * Nit in readme * Casing and descriptions * More casing * Formatting * Consistent casing in sidebar * nits * Unify notes * Nitpick * Minor stuff Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Ethan Buchman <ethan@coinculture.info> Co-authored-by: Anca Zamfir <zamfiranca@gmail.com> Co-authored-by: Adi Seredinschi <adi@informal.systems>

andynog added 12 commits January 26, 2021 17:03

Initial documentation using mdbook (#542)

d0ecb5e

Added README page to the guide with instructions. Fix index page (#542)

d135e7c

Added more content mostly in the configuration section (#542)

f157f17

Some cleaning up and adding some placeholder content to a few pages (#…

80cbee8

…542)

Added information to the index page (#542)

3b33199

Added more content, new sections (most under in transactions), added …

6ad4092

…glossary (#542)

Added info to light client page, additional theme change and some str…

7f9461c

…ucture refactor (#542)

Merge branch 'master' into andy/docs

a882df6

Added content for keys. Updated some commands references. (#542)

42a78e2

Added tutorial section. Breakdown tutorial (#542)

0142cc9

Merge master. Relayer got renamed to hermes

d8f5995

More content to tutorial (#542)

fa94412

romac added the I: documentation Internal: improvements or additions to documentation label Jan 29, 2021

romac added this to the v0.1.0 milestone Jan 29, 2021

andynog and others added 3 commits January 29, 2021 13:24

Adding more content to tutorial (#542)

0d073a0

Update relay_packets.md

f53d0d9

Adding more content, fixing content mostly in local chains file (#542)

a0a79ff

andynog and others added 9 commits January 31, 2021 18:21

Fixing some content to show hermes (#542)

c3600f9

Merge branch 'master' into andy/docs

7a2f422

Added content to the create-client section (#452)

6a5a256

Review sections 1-3

62d9f53

Revew 3.1, remove loop_config, add config_example.toml

2d9d8cf

Merge branch 'andy/docs' of https://github.com/informalsystems/ibc-rs …

4fd0678

…into andy/docs

Small layout change

28bb413

fix CLI examples

b78645d

fixed and clarified ID parameters

2465a9e

Format bytearrays as hex-encoded strings in various commands

4e80ae9

romac and others added 24 commits February 4, 2021 13:13

Add instructions for running two relayers for bidirectional relaying

6f5c58d

Fix broken links found with mdbook-linkcheck

7f07ec0

Check for broken links on CI

c4f8509

Revert "Check for broken links on CI"

2eba5b2

This reverts commit c4f8509.

Main readme. Some fixes

6cef768

Fix typo

a0a8b83

Hermes <> IBC Relayer CLI

1cdd837

Fix a couple more typos

cdc1ac4

Unify Transactions and Queries index pages

1a2f48d

Remove $ prefix in front of commands for easier copy-paste

cf961c3

fix concurrent packet relay section

8e3ab8f

Merge branch 'andy/docs' of https://github.com/informalsystems/ibc-rs …

df32972

…into andy/docs

Update title of two paths page

cf56e90

Disambiguation Hermes<>CLI

3163368

More explanation re: CLI

71665b4

Nit in readme

c2452fb

Casing and descriptions

915b44e

More casing

3bfc570

Formatting

78fd8e8

Consistent casing in sidebar

cc299aa

nits

eae46dd

Unify notes

79f1677

Nitpick

860625e

Minor stuff

5ab7323

adizere approved these changes Feb 4, 2021

View reviewed changes

ancazamfir approved these changes Feb 4, 2021

View reviewed changes

adizere removed this from the v0.1.0 milestone Feb 4, 2021

romac merged commit 1f2e72d into master Feb 4, 2021

romac deleted the andy/docs branch February 4, 2021 15:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Relayer documentation #589

Relayer documentation #589

Uh oh!

romac commented Jan 29, 2021 •

edited by adizere

Loading

Uh oh!

codecov-io commented Jan 31, 2021 •

edited

Loading

Uh oh!

ebuchman commented Jan 31, 2021 •

edited by ancazamfir

Loading

Uh oh!

romac commented Feb 1, 2021

Uh oh!

ancazamfir left a comment

Uh oh!

Uh oh!

Relayer documentation #589

Relayer documentation #589

Uh oh!

Conversation

romac commented Jan 29, 2021 • edited by adizere Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Jan 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ebuchman commented Jan 31, 2021 • edited by ancazamfir Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

romac commented Feb 1, 2021

Uh oh!

ancazamfir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

romac commented Jan 29, 2021 •

edited by adizere

Loading

codecov-io commented Jan 31, 2021 •

edited

Loading

ebuchman commented Jan 31, 2021 •

edited by ancazamfir

Loading