Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace positional arguments with flags in CLI #2275

Merged
merged 39 commits into from
Jun 28, 2022
Merged
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
51852ae
Updated CLI commands to take flags everywhere and updated e2e tests a…
ljoss17 Jun 7, 2022
21580d3
Updated gm to use flags when calling Hermes
ljoss17 Jun 7, 2022
09c157f
Added missing flags to e2e test for 'query client state' command
ljoss17 Jun 7, 2022
612a707
Fixed flag errors in e2e tests and removed conflicting short flag.
ljoss17 Jun 7, 2022
88474db
Removed all short flags and updated CLI commands comments
ljoss17 Jun 8, 2022
a76599f
Removed forgotten short flags.
ljoss17 Jun 8, 2022
bf60ca1
Updated Hermes guide with flags instead of positional arguments
ljoss17 Jun 8, 2022
b9983ef
Updated script and comment with new long flags for Hermes
ljoss17 Jun 8, 2022
eb13cd0
Completed 'tx raw upgrade-' commands guide page. Updated Testing clie…
ljoss17 Jun 10, 2022
7a25573
Added changelog entry
ljoss17 Jun 10, 2022
2e3fff3
Added example unit-tests to the 'keys add' command
ljoss17 Jun 15, 2022
ff84119
Added value names to parameters and removed cli parsing unit-tests
ljoss17 Jun 17, 2022
4d35800
Cargo fmt changes
ljoss17 Jun 17, 2022
c7e1b9a
Updated flags in order to reflect ADR 010
ljoss17 Jun 17, 2022
c363e04
Updated guide to reflect flag changes from ADR 010
ljoss17 Jun 17, 2022
9e6d309
Updated gm script and e2e tests to match flag changes from ADR 010
ljoss17 Jun 17, 2022
52f5542
Merge branch 'master' into luca_joss/replace_positional_args_with_flags
ljoss17 Jun 20, 2022
89bfbf6
Fixed ADR 010 typo
ljoss17 Jun 20, 2022
01aeaac
Remove short flags from `key` error messages
seanchen1991 Jun 21, 2022
f5ee6dd
Fix inconsistent error messaging in channel.rs
seanchen1991 Jun 21, 2022
3f923de
Fix more inconsistent error messaging
seanchen1991 Jun 21, 2022
7b28a03
Run cargo fmt
seanchen1991 Jun 21, 2022
ca4a26d
Fix commands that use deprecated `-c` flag
seanchen1991 Jun 22, 2022
d4218da
Added the query transfer subcommand in docs.
adizere Jun 24, 2022
a28dc78
Scrub query clients
adizere Jun 24, 2022
52a83c9
Scrub query client state
adizere Jun 24, 2022
2624c7a
Removed excessive debug line
adizere Jun 24, 2022
7612d8b
Disabled filtering for query channels CLI
adizere Jun 24, 2022
49b4a41
Merge branch 'master' into luca_joss/replace_positional_args_with_flags
ljoss17 Jun 28, 2022
840a51c
Added aliases for 'connection', 'channel' and 'sequence' flags
ljoss17 Jun 28, 2022
d389f3d
Fixed error in CLI replacing HeightQuery with QueryHeight
ljoss17 Jun 28, 2022
e06b55a
Fix cargo fmt
ljoss17 Jun 28, 2022
fd71131
Changed 'version' to 'channel-version' for 'hermes create channel' co…
ljoss17 Jun 28, 2022
64e54e2
Separated 'hermes create channel' help into short and long message
ljoss17 Jun 28, 2022
d2ef49c
Updated 'hermes listen' so that '--events' flag can take multiple values
ljoss17 Jun 28, 2022
7d8a58e
Updated guide with new '--events' flag for 'hermes listen'
ljoss17 Jun 28, 2022
92cd463
Start all arguments help text with an uppercase letter, to match Clap…
romac Jun 28, 2022
eff375c
Update guide to account for argument help text starting with an upper…
romac Jun 28, 2022
6b2947e
Add shortened aliases for `tx raw` commands
romac Jun 28, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated guide with new '--events' flag for 'hermes listen'
  • Loading branch information
ljoss17 committed Jun 28, 2022
commit 7d8a58e52ea86dec7171f46df1b6fcf8851691e5
8 changes: 4 additions & 4 deletions guide/src/commands/listen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ FLAGS:
--chain <CHAIN_ID> Identifier of the chain to listen for events from

OPTIONS:
--event <EVENT> Add an event type to listen for, can be repeated. Listen for all events by default (available: Tx, NewBlock)
--events <EVENT>... Add an event type to listen for, can be repeated. Listen for all events by default (available: Tx, NewBlock)
```

__Example__
Expand Down Expand Up @@ -155,8 +155,8 @@ At the moment, two event types are available:

The `--event` flag can be repeated to specify more than one event type.

- To listen for only `NewBlock` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --event NewBlock`
- To listen for only `Tx` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --event Tx`
- To listen for both `NewBlock` and `Tx` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --event NewBlock --event Tx`
- To listen for only `NewBlock` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --events NewBlock`
- To listen for only `Tx` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --events Tx`
- To listen for both `NewBlock` and `Tx` events on `ibc-0`, invoke `hermes listen --chain ibc-0 --events NewBlock Tx`

If the `--event` flag is omitted, the relayer will subscribe to all event types.