Add flag to enable interactive prompt in create channel CLI

[seanchen1991]

Closes: #1421

Description

Changes the flow of the create channel CLI command. The default invocation has been changed from

hermes create channel --port-a <PORT-ID> --port-b <PORT-ID> <CHAIN-A-ID> <CHAIN-B-ID>

to

hermes create channel --port-a <PORT-ID> --port-b <PORT-ID> <CHAIN-A-ID> <CONNECTION-A-ID>

If users want to create new clients and connections using this invocation, it is now required that --new-client-connections flag be passed along:

hermes create channel --port-a <PORT-ID> --port-b <PORT-ID> <CHAIN-A-ID> <CHAIN-B-ID> --new-client-connections

This brings up an interactive prompt that the user must agree to, letting them know that they are creating new clients / connections as part of the invocation.

---

PR author checklist:

• Added changelog entry, using unclog.
• Added tests: integration (for Hermes) or unit/mock tests (for modules).
• Linked to GitHub issue.
• Updated code comments and documentation (e.g., docs/).

Reviewer checklist:

• Reviewed Files changed in the GitHub PR explorer.
• Manually tested (in case integration/unit/mock tests are absent).

[seanchen1991]

There's an open issue in the dialoguer crate, which is used for the interactive prompt functionality, where the prompt is re-rendered to the terminal upon user interaction.

[adizere]

Neat work! Left some suggestions below.

It seems that the 'usage' message is not very clear:

$ ./target/debug/hermes create channel
error: The following required arguments were not provided:
    --port-a <PORT_A>
    --port-b <PORT_B>
    <CHAIN_A_ID>

USAGE:
    hermes create channel [OPTIONS] --port-a <PORT_A> --port-b <PORT_B> <CHAIN_A_ID> [CHAIN_B_ID]

I think we should make it so that the 'usage' output here presents the user with the default invocation, which has a connection ID (and has no chain-b-ID). I suspect to do that we need to:

• make the chain_b_id option to be non-positional, i.e., it should have the clap pragma config including short, long

-make the connection_a option to be positional (remove the clap pragmas config short, long.

I would also suggest we rename top-level message that create channel --help provides. It is currently:

Create a new channel between two chains

maybe would be more accurate to have

Create a new channel using an existing connection, or alternatively using a new client and connection.

Stale review

[adizere]

@mzabaluev when you get a chance have a look over & review this please.

[mzabaluev]

The changes look good, though I'm still uncomfortable with bringing interactivity into the otherwise script-friendly CLI command. What's the failure mode when the input is /dev/null?

Should the guide be updated now that create channel does not automatically create a connection and clients by omission?

[seanchen1991]

Should the guide be updated now that create channel does not automatically create a connection and clients by omission?

Yes, I'll update the guide 👍

[romac]

Can we update this PR with a more descriptive title?

[mzabaluev]

Renaming looks good, just needs to be completed everywhere and the guide updated accordingly.-

[seanchen1991]

The guide has been updated accordingly. @romac are there any other changes you think need to be made before we merge this?

[romac]

Ah my bad, sorry about that. Can you please split out the guide changes into a separate PR so that we can merge it once we release v0.14? Otherwise the guide will be updated before we actually release v0.14, which may confuse users.

[romac]

Perfect 👍