Set dst-channel flag to required for channel upgrade CLIs and updated…

… templates
informalsystems · Aug 3, 2023 · 2c65075 · 2c65075
1 parent 05b08d0
commit 2c65075
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 15 deletions.
diff --git a/crates/relayer-cli/src/commands/tx/channel.rs b/crates/relayer-cli/src/commands/tx/channel.rs
@@ -885,6 +885,7 @@ pub struct TxChanUpgradeTryCmd {
         long = "dst-channel",
         visible_alias = "dst-chan",
         required = true,
+        help_heading = "REQUIRED",
         value_name = "DST_CHANNEL_ID",
         help = "Identifier of the destination channel (optional)"
     )]
@@ -1038,6 +1039,8 @@ pub struct TxChanUpgradeAckCmd {
     #[clap(
         long = "dst-channel",
         visible_alias = "dst-chan",
+        required = true,
+        help_heading = "REQUIRED",
         value_name = "DST_CHANNEL_ID",
         help = "Identifier of the destination channel (optional)"
     )]
@@ -1182,6 +1185,8 @@ pub struct TxChanUpgradeOpenCmd {
     #[clap(
         long = "dst-channel",
         visible_alias = "dst-chan",
+        required = true,
+        help_heading = "REQUIRED",
         value_name = "DST_CHANNEL_ID",
         help = "Identifier of the destination channel (optional)"
     )]

diff --git a/guide/src/templates/commands/hermes/tx/chan-upgrade-ack_1.md b/guide/src/templates/commands/hermes/tx/chan-upgrade-ack_1.md
@@ -1 +1 @@
-[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-ack[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]]
+[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-ack[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]] --dst-channel [[#DST_CHANNEL_ID]]
diff --git a/guide/src/templates/commands/hermes/tx/chan-upgrade-open_1.md b/guide/src/templates/commands/hermes/tx/chan-upgrade-open_1.md
@@ -1 +1 @@
-[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-open[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]]
+[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-open[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]] --dst-channel [[#DST_CHANNEL_ID]]
diff --git a/guide/src/templates/commands/hermes/tx/chan-upgrade-try_1.md b/guide/src/templates/commands/hermes/tx/chan-upgrade-try_1.md
@@ -1 +1 @@
-[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-try[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]]
+[[#BINARY hermes]][[#GLOBALOPTIONS]] tx chan-upgrade-try[[#OPTIONS]] --dst-chain [[#DST_CHAIN_ID]] --src-chain [[#SRC_CHAIN_ID]] --dst-connection [[#DST_CONNECTION_ID]] --dst-port [[#DST_PORT_ID]] --src-port [[#SRC_PORT_ID]] --src-channel [[#SRC_CHANNEL_ID]] --dst-channel [[#DST_CHANNEL_ID]]
diff --git a/guide/src/templates/help_templates/tx/chan-upgrade-ack.md b/guide/src/templates/help_templates/tx/chan-upgrade-ack.md
@@ -2,12 +2,9 @@ DESCRIPTION:
 Relay the channel upgrade attempt (ChannelUpgradeAck)
 
 USAGE:
-    hermes tx chan-upgrade-ack [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID>
+    hermes tx chan-upgrade-ack [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID> --dst-channel <DST_CHANNEL_ID>
 
 OPTIONS:
-        --dst-channel <DST_CHANNEL_ID>
-            Identifier of the destination channel (optional) [aliases: dst-chan]
-
     -h, --help
             Print help information
 
@@ -23,6 +20,9 @@ REQUIRED:
         --dst-chain <DST_CHAIN_ID>
             Identifier of the destination chain
 
+        --dst-channel <DST_CHANNEL_ID>
+            Identifier of the destination channel (optional) [aliases: dst-chan]
+
         --dst-connection <DST_CONNECTION_ID>
             Identifier of the destination connection [aliases: dst-conn]
 

diff --git a/guide/src/templates/help_templates/tx/chan-upgrade-open.md b/guide/src/templates/help_templates/tx/chan-upgrade-open.md
@@ -2,12 +2,9 @@ DESCRIPTION:
 Relay the channel upgrade attempt (ChannelUpgradeOpen)
 
 USAGE:
-    hermes tx chan-upgrade-open [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID>
+    hermes tx chan-upgrade-open [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID> --dst-channel <DST_CHANNEL_ID>
 
 OPTIONS:
-        --dst-channel <DST_CHANNEL_ID>
-            Identifier of the destination channel (optional) [aliases: dst-chan]
-
     -h, --help
             Print help information
 
@@ -23,6 +20,9 @@ REQUIRED:
         --dst-chain <DST_CHAIN_ID>
             Identifier of the destination chain
 
+        --dst-channel <DST_CHANNEL_ID>
+            Identifier of the destination channel (optional) [aliases: dst-chan]
+
         --dst-connection <DST_CONNECTION_ID>
             Identifier of the destination connection [aliases: dst-conn]
 

diff --git a/guide/src/templates/help_templates/tx/chan-upgrade-try.md b/guide/src/templates/help_templates/tx/chan-upgrade-try.md
@@ -2,12 +2,9 @@ DESCRIPTION:
 Relay the channel upgrade attempt (ChannelUpgradeTry)
 
 USAGE:
-    hermes tx chan-upgrade-try [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID>
+    hermes tx chan-upgrade-try [OPTIONS] --dst-chain <DST_CHAIN_ID> --src-chain <SRC_CHAIN_ID> --dst-connection <DST_CONNECTION_ID> --dst-port <DST_PORT_ID> --src-port <SRC_PORT_ID> --src-channel <SRC_CHANNEL_ID> --dst-channel <DST_CHANNEL_ID>
 
 OPTIONS:
-        --dst-channel <DST_CHANNEL_ID>
-            Identifier of the destination channel (optional) [aliases: dst-chan]
-
     -h, --help
             Print help information
 
@@ -23,6 +20,9 @@ REQUIRED:
         --dst-chain <DST_CHAIN_ID>
             Identifier of the destination chain
 
+        --dst-channel <DST_CHANNEL_ID>
+            Identifier of the destination channel (optional) [aliases: dst-chan]
+
         --dst-connection <DST_CONNECTION_ID>
             Identifier of the destination connection [aliases: dst-conn]