-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add upgrade clients documentation. (#3067)
Co-authored-by: Sean Chen <[email protected]>
- Loading branch information
1 parent
90a1c53
commit 7c954dd
Showing
2 changed files
with
14 additions
and
4 deletions.
There are no files selected for viewing
2 changes: 2 additions & 0 deletions
2
.changelog/unreleased/bug-fixes/ibc-relayer-cli/3066-upgrade-clients-docs.md
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,2 @@ | ||
- Document upgrade clients command | ||
([#3066](https://github.com/informalsystems/hermes/issues/3066)) |
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 |
---|---|---|
@@ -1,13 +1,21 @@ | ||
# Client Upgrade | ||
# Upgrading Clients | ||
If IBC clients need to be upgraded after their reference chains went through an upgrade, the following CLIs may be used. | ||
|
||
## Client Upgrade Command | ||
|
||
Use the `upgrade client` command to upgrade a client after a chain upgrade. | ||
## Upgrade Client Command | ||
Use the `upgrade client` command to upgrade a specific IBC client after a chain upgrade. | ||
|
||
```shell | ||
{{#include ../../../templates/help_templates/upgrade/client.md}} | ||
``` | ||
|
||
## Upgrade Clients Command | ||
|
||
Use the `upgrade clients` command to upgrade all IBC clients that target a specific (upgraded) chain. | ||
|
||
```shell | ||
{{#include ../../../templates/help_templates/upgrade/clients.md}} | ||
``` | ||
|
||
__Example__ | ||
|
||
Here is [an example](./test.md) of a chain upgrade proposal submission and client upgrade. |