-
Notifications
You must be signed in to change notification settings - Fork 352
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation for Hermes v0.2 (#792)
* Add websocket_addr config option to the guide * Licences & consistent badges in all crate readmes. * Crates.io small improvs for cli * Update guide to account for removal of global timeout property and addition of per-chain rpc_timeout property * Remove documentation about light client config and commands * modifiend output for command sections 3.3, 4.1.1, 4.1.2, 4.31. * Fix typo * Rename init-clients to init-hermes * Update tutorial_set_new_path.md * path * Update tutorial_relay_two_paths.md * Update Keys section of the guide * Add backward compatibility note for keys format * Document update to `listen` command * Fix clippy - not caught by CI? * Update sections that mention 'tx raw update-client' CLI * Updates for query client consensus command * Update feature matrix and layout * Small cleanup * Rought content for the path setup and streaming sub-sections * Add misbehaviour skeleton and links with connection and packets guides * Added details on misbehaviour * Exit on misbehaviour event * Exit on misbehaviour event or if client is already frozen * revert header check changed for testing * Update ft-transfer with the --receiver option * Fix output of `create connection` in no-JSON mode * Update `create client` and `update client` commands doc * Fix `create client`, `update client` commands docs using Gaia v4.2.0 * Add Display instance to Order * Comment out unused --version parameter in `create channel` command * Update `create channel` doc * Update clients doc * Upgrade guide, create CLI wrapper * Use `create client` command in upgrade doc * Fix TOC in Packet Relaying page * Fix broken link for upgrade guide * Add channel version option * Add fee denom and amount where missing * Same format for channel order accross CLIs, update guide * Only print command options in debug mode * Minor changes in existing tutorials * Minor update to ft-transfer interface * Use default values with gumdrop * Update documentation for multi-paths relaying * Quick fix for multi-start * Mention config everywhere in tutorial_relay_two_paths.md * Re-organize the guide and check all links * Comment out link checker for CI * Rename upgrade pages * Move feature_matrix under features/ * Change ft-transfer to use same param order as the other packet clis * Output for upgrade * Output for raw client and connection * Output for raw channel open * Use pretty debug output in channel handshake * Add more output to multi-path tutorial * Update lockfile * Use pretty in channel open * Use standard Debug instance for Height * Use standard Debug instance for Height in guide * More pretty channel messages * Fix compilation * Show commitment root hash as a hex-encoded string * Update client queries * Output for raw packet clis * Output for channel close handshake * Fix output for connection open * Fix output for misbehaviour * Update listen command output * Update query connection guide doc * Update query channel guide doc * Update packet queries guide docs * First pass at features * Update packet queries guide docs, part 2 * Add page on global options and JSON output * Update output on help page * Use debug! in tx connection command * Updates to documentation in the tutorials sections (#792) * Next steps and a comment * More uppercase on deletion of data folder * Updates on features * More variables in setup-chains * Rename Disk keyring store to Test * Fix ft-transfer invocation * Update start-multi queries Co-authored-by: Adi Seredinschi <[email protected]> Co-authored-by: cezarad <[email protected]> Co-authored-by: Anca Zamfir <[email protected]> Co-authored-by: Andy Nogueira <[email protected]>
- Loading branch information
5 people
authored
Apr 14, 2021
1 parent
306b7b6
commit cbf5138
Showing
104 changed files
with
4,021 additions
and
2,225 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Global options | ||
|
|
||
| The Hermes accepts global options which affect all commands. | ||
|
|
||
| ```shell | ||
| hermes 0.1.1 | ||
| Informal Systems <[email protected]> | ||
| Implementation of `hermes`, an IBC Relayer developed in Rust. | ||
|
|
||
| FLAGS: | ||
| -c, --config CONFIG path to configuration file | ||
| -h, --help print help message | ||
| -j, --json enable JSON output | ||
| ``` | ||
|
|
||
| The flags must be specified right after the `hermes` command and before any subcommand. | ||
|
|
||
| __Example__ | ||
|
|
||
| To start the relayer using the configuration file at `/home/my_chain.toml` and enable JSON output: | ||
|
|
||
| ```shell | ||
| hermes -c /home/my_chain.toml --json start ibc-0 ibc-1 | ||
| ``` | ||
|
|
||
| ## JSON output | ||
|
|
||
| If the `--json` option is supplied, all relayer commands will output single-line JSON values instead of plain text. | ||
|
|
||
| Intermediate log messages will be written to `stderr`, while the final result will be written to `stdout`. | ||
| This allows processing only the final output using [`jq`](https://stedolan.github.io/jq/). | ||
| To process all the output using `jq`, one can redirect `stderr` to `stdout` with `hermes --json COMMAND 2>&1 | jq`. | ||
|
|
||
| __Example__ | ||
|
|
||
| ```shell | ||
| hermes -c /home/my_chain.toml --json create client ibc-0 ibc-1 | ||
| ``` | ||
|
|
||
| ```json | ||
| {"timestamp":"Apr 13 20:46:31.921","level":"INFO","fields":{"message":"Using default configuration from: '.hermes/config.toml'"},"target":"ibc_relayer_cli::commands"} | ||
| {"timestamp":"Apr 13 20:46:31.961","level":"INFO","fields":{"message":"running listener","chain.id":"ibc-1"},"target":"ibc_relayer::event::monitor"} | ||
| {"timestamp":"Apr 13 20:46:31.989","level":"INFO","fields":{"message":"running listener","chain.id":"ibc-0"},"target":"ibc_relayer::event::monitor"} | ||
| {"result":{"CreateClient":{"client_id":"07-tendermint-1","client_type":"Tendermint","consensus_height":{"revision_height":10060,"revision_number":1},"height":{"revision_height":10072,"revision_number":0}}},"status":"success"} | ||
| ``` | ||
|
|
||
| The first three lines are printed to `stderr`, while the last line with a `"result"` key is printed to `stdout`. | ||
|
|
||
| __Example__ | ||
|
|
||
| To improve the readability, pipe all of the output to `jq`: | ||
|
|
||
| ``` | ||
| hermes -c /home/my_chain.toml --json create client ibc-0 ibc-1 2>&1 | jq | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "Apr 13 20:52:26.060", | ||
| "level": "INFO", | ||
| "fields": { | ||
| "message": "Using default configuration from: '.hermes/config.toml'" | ||
| }, | ||
| "target": "ibc_relayer_cli::commands" | ||
| } | ||
| { | ||
| "timestamp": "Apr 13 20:52:26.082", | ||
| "level": "INFO", | ||
| "fields": { | ||
| "message": "running listener", | ||
| "chain.id": "ibc-1" | ||
| }, | ||
| "target": "ibc_relayer::event::monitor" | ||
| } | ||
| { | ||
| "timestamp": "Apr 13 20:52:26.088", | ||
| "level": "INFO", | ||
| "fields": { | ||
| "message": "running listener", | ||
| "chain.id": "ibc-0" | ||
| }, | ||
| "target": "ibc_relayer::event::monitor" | ||
| } | ||
| { | ||
| "result": { | ||
| "CreateClient": { | ||
| "client_id": "07-tendermint-5", | ||
| "client_type": "Tendermint", | ||
| "consensus_height": { | ||
| "revision_height": 10364, | ||
| "revision_number": 1 | ||
| }, | ||
| "height": { | ||
| "revision_height": 10375, | ||
| "revision_number": 0 | ||
| } | ||
| } | ||
| }, | ||
| "status": "success" | ||
| } | ||
| ``` | ||
|
|
||
| __Example__ | ||
|
|
||
| To extract the identifer of the newly created client above: | ||
|
|
||
| ``` | ||
| hermes -c /home/my_chain.toml --json create client ibc-0 ibc-1 | jq '.result.CreateClient.client_id' | ||
| ``` | ||
|
|
||
| ``` | ||
| "07-tendermint-2" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Commands | ||
|
|
||
| The `Commands` section presents the commands current available in Hermes | ||
|
|
||
| ## Sections | ||
|
|
||
| **[Keys](./keys/index.md)** | ||
|
|
||
| Commands to manage keys (private keys) for each chain. | ||
|
|
||
| **[Path Setup and Streaming](./setup-and-relaying/index.md)** | ||
|
|
||
| Commands to manage clients, connections, channels and performing packet relaying | ||
|
|
||
| **[Listen Mode](./listen/index.md)** | ||
|
|
||
| Commands to listen for IBC events | ||
|
|
||
| **[Upgrade](./upgrade/index.md)** | ||
|
|
||
| Commands to perform client upgrade | ||
|
|
||
| **[Monitor](./misbehaviour/index.md)** | ||
|
|
||
| Commands to monitor clients and submit evidence of misbehaviour | ||
|
|
||
| **[Queries](./queries/index.md)** | ||
|
|
||
| Commands to execute queries on configured chains | ||
|
|
||
| **[Raw Transactions](./raw/index.md)** | ||
|
|
||
| Commands to submit individual transactions to configured chains |
Oops, something went wrong.