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.

Sign up for GitHub

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

Jump to bottom

Add upgrade clients CLI documentation #3067

Merged
merged 2 commits into from
Feb 13, 2023
Merged

Add upgrade clients CLI documentation #3067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
579e49a
Add upgrade clients documentation.
ancazamfir Feb 13, 2023
2006c70
Merge branch 'master' into anca/3066-upgrade-clients
seanchen1991 Feb 13, 2023
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
2 changes: 2 additions & 0 deletions .changelog/unreleased/bug-fixes/ibc-relayer-cli/3066-upgrade-clients-docs.md
View file
Open in desktop
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))
16 changes: 12 additions & 4 deletions guide/src/documentation/commands/upgrade/index.md
View file
Open in desktop
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.