Replace positional arguments with flags in CLI

.changelog/unreleased/breaking-changes/ibc-relayer-cli/2239-changed-args-to-flags.md

@@ -0,0 +1,2 @@
+- Updated all CLI commands to take flags instead of positional arguments.
+  ([#2239](https://github.com/informalsystems/ibc-rs/issues/2239))

ci/e2e.sh

@@ -16,7 +16,7 @@ echo "--------------------------------------------------------------------------
 echo "Show relayer version"
 echo "-----------------------------------------------------------------------------------------------------------------"
 echo Config: "$CONFIG_PATH"
-$RELAYER_CMD -c "$CONFIG_PATH" version
+$RELAYER_CMD --config "$CONFIG_PATH" version
 echo "-----------------------------------------------------------------------------------------------------------------"
 echo "Setting up chains"
 echo "-----------------------------------------------------------------------------------------------------------------"
@@ -34,10 +34,10 @@ echo "==========================================================================
 echo "-----------------------------------------------------------------------------------------------------------------"
 echo "Add keys for chains"
 echo "-----------------------------------------------------------------------------------------------------------------"
-hermes -c "$CONFIG_PATH" keys add "$CHAIN_A" -f user_seed_"$CHAIN_A".json
-hermes -c "$CONFIG_PATH" keys add "$CHAIN_B" -f user_seed_"$CHAIN_B".json
-hermes -c "$CONFIG_PATH" keys add "$CHAIN_A" -f user2_seed_"$CHAIN_A".json  -k user2
-hermes -c "$CONFIG_PATH" keys add "$CHAIN_B" -f user2_seed_"$CHAIN_B".json  -k user2
+hermes --config "$CONFIG_PATH" keys add --chain "$CHAIN_A" --key-file user_seed_"$CHAIN_A".json
+hermes --config "$CONFIG_PATH" keys add --chain "$CHAIN_B" --key-file user_seed_"$CHAIN_B".json
+hermes --config "$CONFIG_PATH" keys add --chain "$CHAIN_A" --key-file user2_seed_"$CHAIN_A".json  --key-name user2
+hermes --config "$CONFIG_PATH" keys add --chain "$CHAIN_B" --key-file user2_seed_"$CHAIN_B".json  --key-name user2
 
 echo "================================================================================================================="
 echo "                                             END-TO-END TESTS                                                    "

docs/architecture/adr-010-unified-cli-arguments-hermes.md

@@ -115,7 +115,7 @@ __Connection__
     * Optional: `[--height <HEIGHT>]`
 
 * `query connections --chain <CHAIN_ID>`
-    * Optional: `[--chain-counterparty <CHAIN_COUNTERPARTY_ID>] [--verbose]`
+    * Optional: `[--counterparty-chain <COUNTERPARTY_CHAIN_ID>] [--verbose]`
 
 __Channel__
 
@@ -148,6 +148,10 @@ __Packet__
 
 * `query packet unreceived-packets --chain <CHAIN_ID> --port <PORT_ID> --chan <CHANNEL_ID>`
 
+__Transfer__
+
+* `query transfer denom-trace --chain <CHAIN_ID> --hash <HASH>`
+
 __Tx__
 
 * `query tx events --chain <CHAIN_ID> --hash <HASH>`

e2e/e2e/channel.py

@@ -27,9 +27,9 @@ class TxChanOpenInit(Cmd[TxChanOpenInitRes]):
     ordering: Optional[Ordering] = None
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.connection_id,
-                self.dst_port_id, self.src_port_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.connection_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id]
 
         if self.ordering is not None:
             args.extend(['--ordering', str(self.ordering)])
@@ -65,10 +65,10 @@ class TxChanOpenTry(Cmd[TxChanOpenTryRes]):
     ordering: Optional[Ordering] = None
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.connection_id,
-                self.dst_port_id, self.src_port_id,
-                "-s", self.src_channel_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.connection_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id,
+                "--src-chan", self.src_channel_id]
 
         if self.ordering is not None:
             args.extend(['--ordering', str(self.ordering)])
@@ -104,11 +104,11 @@ class TxChanOpenAck(Cmd[TxChanOpenAckRes]):
     src_channel_id: ChannelId
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.connection_id,
-                self.dst_port_id, self.src_port_id,
-                "-d", self.dst_channel_id,
-                "-s", self.src_channel_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.connection_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id,
+                "--dst-chan", self.dst_channel_id,
+                "--src-chan", self.src_channel_id]
 
         return args
 
@@ -141,11 +141,11 @@ class TxChanOpenConfirm(Cmd[TxChanOpenConfirmRes]):
     src_channel_id: ChannelId
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.connection_id,
-                self.dst_port_id, self.src_port_id,
-                "-d", self.dst_channel_id,
-                "-s", self.src_channel_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.connection_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id,
+                "--dst-chan", self.dst_channel_id,
+                "--src-chan", self.src_channel_id]
 
         return args
 
@@ -177,11 +177,11 @@ class TxChanCloseInit(Cmd[TxChanCloseInitRes]):
     src_chan_id: ChannelId
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.dst_conn_id,
-                self.dst_port_id, self.src_port_id,
-                "-d", self.dst_chan_id,
-                "-s", self.src_chan_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.dst_conn_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id,
+                "--dst-chan", self.dst_chan_id,
+                "--src-chan", self.src_chan_id]
 
         return args
 
@@ -214,11 +214,11 @@ class TxChanCloseConfirm(Cmd[TxChanCloseConfirmRes]):
     src_chan_id: ChannelId
 
     def args(self) -> List[str]:
-        args = [self.dst_chain_id, self.src_chain_id,
-                self.dst_conn_id,
-                self.dst_port_id, self.src_port_id,
-                "-d", self.dst_chan_id,
-                "-s", self.src_chan_id]
+        args = ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-conn", self.dst_conn_id,
+                "--dst-port", self.dst_port_id, "--src-port", self.src_port_id,
+                "--dst-chan", self.dst_chan_id,
+                "--src-chan", self.src_chan_id]
 
         return args
 
@@ -267,7 +267,7 @@ class QueryChannelEnd(Cmd[ChannelEnd]):
     channel_id: ChannelId
 
     def args(self) -> List[str]:
-        return [self.chain_id, self.port_id, self.channel_id]
+        return ["--chain", self.chain_id, "--port", self.port_id, "--chan", self.channel_id]
 
     def process(self, result: Any) -> ChannelEnd:
         return from_dict(ChannelEnd, result)
@@ -280,7 +280,7 @@ class QueryChannelEnds(Cmd[ChannelEnds]):
     channel_id: ChannelId
 
     def args(self) -> List[str]:
-        return [self.chain_id, self.port_id, self.channel_id]
+        return ["--chain", self.chain_id, "--port", self.port_id, "--chan", self.channel_id]
 
     def process(self, result: Any) -> ChannelEnds:
         return from_dict(ChannelEnds, result)

e2e/e2e/client.py

@@ -19,7 +19,7 @@ class TxCreateClient(Cmd[ClientCreated]):
     src_chain_id: ChainId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id]
+        return ["--host-chain", self.dst_chain_id, "--reference-chain", self.src_chain_id]
 
     def process(self, result: Any) -> ClientCreated:
         return from_dict(ClientCreated, result['CreateClient'])
@@ -43,7 +43,7 @@ class TxUpdateClient(Cmd[ClientUpdated]):
     dst_client_id: ClientId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.dst_client_id]
+        return ["--host-chain", self.dst_chain_id, "--client", self.dst_client_id]
 
     def process(self, result: Any) -> ClientUpdated:
         return from_dict(ClientUpdated, result[-1]['UpdateClient']['common'])
@@ -86,7 +86,7 @@ def args(self) -> List[str]:
         if self.proof:
             args.append('--proof')
 
-        args.extend([self.chain_id, self.client_id])
+        args.extend(["--chain", self.chain_id, "--client", self.client_id])
 
         return args
 

e2e/e2e/cmd.py

@@ -55,7 +55,7 @@ def to_cmd(self) -> str:
         return f"{self.name} {' '.join(self.args())}"
 
     def run(self, config: Config, retries: int = 0) -> CmdResult[T]:
-        full_cmd = f'{config.relayer_cmd} -c {config.config_file} --json'.split(' ')
+        full_cmd = f'{config.relayer_cmd} --config {config.config_file} --json'.split(' ')
         full_cmd.extend(self.name.split(' '))
         full_cmd.extend(self.args())
         l.debug(' '.join(full_cmd))

e2e/e2e/connection.py

@@ -22,8 +22,8 @@ class TxConnInit(Cmd[TxConnInitRes]):
     src_client_id: ClientId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id,
-                self.dst_client_id, self.src_client_id]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-client", self.dst_client_id, "--src-client", self.src_client_id]
 
     def process(self, result: Any) -> TxConnInitRes:
         return from_dict(TxConnInitRes, result['OpenInitConnection'])
@@ -46,9 +46,9 @@ class TxConnTry(Cmd[TxConnTryRes]):
     src_conn_id: ConnectionId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id,
-                self.dst_client_id, self.src_client_id,
-                "-s", self.src_conn_id]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-client", self.dst_client_id, "--src-client", self.src_client_id,
+                "--src-conn", self.src_conn_id]
 
     def process(self, result: Any) -> TxConnTryRes:
         return from_dict(TxConnTryRes, result['OpenTryConnection'])
@@ -72,10 +72,10 @@ class TxConnAck(Cmd[TxConnAckRes]):
     src_conn_id: ConnectionId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id,
-                self.dst_client_id, self.src_client_id,
-                "-d", self.dst_conn_id,
-                "-s", self.src_conn_id]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-client", self.dst_client_id, "--src-client", self.src_client_id,
+                "--dst-conn", self.dst_conn_id,
+                "--src-conn", self.src_conn_id]
 
     def process(self, result: Any) -> TxConnAckRes:
         return from_dict(TxConnAckRes, result['OpenAckConnection'])
@@ -99,10 +99,10 @@ class TxConnConfirm(Cmd[TxConnConfirmRes]):
     src_conn_id: ConnectionId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id,
-                self.dst_client_id, self.src_client_id,
-                "-d", self.dst_conn_id,
-                "-s", self.src_conn_id]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id,
+                "--dst-client", self.dst_client_id, "--src-client", self.src_client_id,
+                "--dst-conn", self.dst_conn_id,
+                "--src-conn", self.src_conn_id]
 
     def process(self, result: Any) -> TxConnConfirmRes:
         return from_dict(TxConnConfirmRes, result['OpenConfirmConnection'])
@@ -139,7 +139,7 @@ class QueryConnectionEnd(Cmd[ConnectionEnd]):
     connection_id: ConnectionId
 
     def args(self) -> List[str]:
-        return [self.chain_id, self.connection_id]
+        return ["--chain", self.chain_id, "--conn", self.connection_id]
 
     def process(self, result: Any) -> ConnectionEnd:
         return from_dict(ConnectionEnd, result)

e2e/e2e/packet.py

@@ -36,19 +36,19 @@ class TxPacketSend(Cmd[TxPacketSendRes]):
 
     def args(self) -> List[str]:
         args = [
-            self.dst_chain_id,
-            self.src_chain_id,
-            self.src_port,
-            self.src_channel,
-            str(self.amount),
-            "-o", str(self.height_offset),
+            "--dst-chain", self.dst_chain_id,
+            "--src-chain", self.src_chain_id,
+            "--src-port", self.src_port,
+            "--src-chan", self.src_channel,
+            "--amount", str(self.amount),
+            "--timeout-height-offset", str(self.height_offset),
         ]
 
         if self.number_msgs != None:
-            args.extend(['-n', str(self.number_msgs)])
+            args.extend(['--number-msgs', str(self.number_msgs)])
 
         if self.key != None:
-            args.extend(['-k', str(self.key)])
+            args.extend(['--key-name', str(self.key)])
 
         return args
 
@@ -75,7 +75,7 @@ class TxPacketRecv(Cmd[TxPacketRecvRes]):
     src_channel: ChannelId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id, self.src_port, self.src_channel]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id, "--src-port", self.src_port, "--src-chan", self.src_channel]
 
     def process(self, result: Any) -> TxPacketRecvRes:
         entry = find_entry(result, 'WriteAcknowledgement')
@@ -99,7 +99,7 @@ class TxPacketTimeout(Cmd[TxPacketTimeoutRes]):
     src_channel: ChannelId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id, self.src_port, self.src_channel]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id, "--src-port", self.src_port, "--src-chan", self.src_channel]
 
     def process(self, result: Any) -> TxPacketTimeoutRes:
         entry = find_entry(result, 'TimeoutPacket')
@@ -124,7 +124,7 @@ class TxPacketAck(Cmd[TxPacketAckRes]):
     src_channel: ChannelId
 
     def args(self) -> List[str]:
-        return [self.dst_chain_id, self.src_chain_id, self.src_port, self.src_channel]
+        return ["--dst-chain", self.dst_chain_id, "--src-chain", self.src_chain_id, "--src-port", self.src_port, "--src-chan", self.src_channel]
 
     def process(self, result: Any) -> TxPacketAckRes:
         entry = find_entry(result, 'AcknowledgePacket')
@@ -141,7 +141,7 @@ class QueryUnreceivedPackets(Cmd[List[int]]):
     channel: ChannelId
 
     def args(self) -> List[str]:
-        return [self.chain, self.port, self.channel]
+        return ["--chain", self.chain, "--port", self.port, "--chan", self.channel]
 
     def process(self, result: Any) -> List[int]:
         return from_dict(List[int], result)
@@ -169,7 +169,7 @@ class QueryUnreceivedAcks(Cmd[List[int]]):
     channel: ChannelId
 
     def args(self) -> List[str]:
-        return [self.chain, self.port, self.channel]
+        return ["--chain", self.chain, "--port", self.port, "--chan", self.channel]
 
     def process(self, result: Any) -> List[int]:
         return from_dict(List[int], result)

e2e/e2e/relayer.py

@@ -6,6 +6,6 @@
 
 
 def start(c: Config) -> Popen:
-    full_cmd = f'{c.relayer_cmd} -c {c.config_file} -j start'.split(' ')
+    full_cmd = f'{c.relayer_cmd} --config {c.config_file} --json start'.split(' ')
     l.debug(' '.join(full_cmd))
     return Popen(full_cmd)

guide/src/SUMMARY.md

@@ -56,6 +56,7 @@
      - [Channel Open](./commands/raw/channel-open.md)
      - [Channel Close](./commands/raw/channel-close.md)
      - [Packet](./commands/raw/packet.md)
+     - [Upgrade](./commands/raw/upgrade.md)
 - [Help](./help.md)
 - [Glossary](./glossary.md)
 ---

guide/src/commands/config.md

@@ -6,7 +6,7 @@ your configuration file.
 
 ```shell
 USAGE:
-    hermes config validate <OPTIONS>
+    hermes config validate
 
 DESCRIPTION:
     validate the relayer configuration
@@ -30,13 +30,13 @@ Success: "validation passed successfully"
 Validate a config file at an arbitrary location:
 
 ```shell
-hermes -c ./config.toml config validate
+hermes --config ./config.toml config validate
 ```
 
 This one fails validation because we mistakenly added two separate sections for
 the same chain `ibc-1`:
 
 ```text
-hermes -c ./config.toml  config validate
+hermes --config ./config.toml config validate
 error: hermes fatal error: config error: config file has duplicate entry for the chain with id ibc-1
 ```