Introduce ADR 006: "Hermes release v0.2.0 use-cases" #676
Conversation
Codecov Report
@@ Coverage Diff @@
## master #676 +/- ##
=========================================
+ Coverage 13.6% 44.0% +30.3%
=========================================
Files 69 150 +81
Lines 3752 9786 +6034
Branches 1374 0 -1374
=========================================
+ Hits 513 4309 +3796
- Misses 2618 5477 +2859
+ Partials 621 0 -621
Continue to review full report at Codecov.
|
| length to a minimum. | ||
|
|
||
| To create and update a client: | ||
| - `create client <src-chain-id> <dst-chain-id>` |
There was a problem hiding this comment.
Oh, just noticed we have src chain first and then dst chain. Until now we used the other order. First we specify the destination and then the source.
There was a problem hiding this comment.
Actually I would propose we stop using the src and dst for these commands. With the exception of the client, all the others involve multiple transactions so using src/dst doesn't make sense anymore.
Maybe say a and b or something else. For connection and channel we can say that open-init is always sent to a (if that's the case)
There was a problem hiding this comment.
I still like a bit more:
"create client on X for chain Y" -> create client <chain-x> <chain-y>
instead of
"create client for Y on chain X" -> create client <chain-y> <chain-x>
It's also most consistent with update client where we only have a chain-x.
But I can live with either :)
There was a problem hiding this comment.
- For connection & channel: I like the
abdistinction and I think we should make more effort to use this naming scheme consistently. Will use this from now. - For client: cool to use
destinationbeforesource! As a more general comment, I would find it more intuitive and accurate to use the naming schemehost/targetinstead ofdestination/source, but I don't insist on it.
There was a problem hiding this comment.
Introduced the scheme with "a" and "b" 92ffdd1.
…#676) * adr 006 * Finished 1st sketch. Updated changelog. * Cosmetic improvs * Reorder start commands * Introduced establish for finishing handshakes * Added summary * Reviewed commands. Removed start w/ specific client * Review tenses & 'we' plus some nits. * Added client commands * Added create client missing params (optional) * Added port to disambiguate. Separated optional params for better clarity * Mention client create limitation * Reordered connection option * Reviewed * Added entry in TOC * Extended limitations section. Removed delay option from channel/start cmds. * Introduced 'a' and 'b' scheme. Revised * Added the host<>target scheme for client ops.
Closes: #637
Description
Based on discussion from #637, #628, and synchronous coordination with @ancazamfir and @brapse.
Introduces a new ADR 006 documenting these discussions.
ADR 006 rendered
For contributor use:
docs/) and code comments.Files changedin the Github PR explorer.