Documentation for Hermes v0.2 #792
Merged
Conversation
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 comment has been minimized.
This comment has been minimized.
…dition of per-chain rpc_timeout property
6 tasks
soareschen
reviewed
Apr 13, 2021
ancazamfir
approved these changes
Apr 14, 2021
hu55a1n1
pushed a commit
to hu55a1n1/hermes
that referenced
this pull request
Sep 13, 2022
* 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 (informalsystems#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 <adi@informal.systems> Co-authored-by: cezarad <9439384+cezarad@users.noreply.github.com> Co-authored-by: Anca Zamfir <zamfiranca@gmail.com> Co-authored-by: Andy Nogueira <me@andynogueira.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #608
TODO
PRs
List of PRs which require a corresponding documentation update:
listencommand #804 (by @romac)createandupdatewrappers for client raw commands #774 (by @adizere)ft-transferCLI #807 (by @adizere)