Skip to content

Commit

Permalink
Add upgrade clients documentation. (#3067)
Browse files Browse the repository at this point in the history
Co-authored-by: Sean Chen <[email protected]>
  • Loading branch information
ancazamfir and seanchen1991 authored Feb 13, 2023
1 parent 90a1c53 commit 7c954dd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
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
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.

0 comments on commit 7c954dd

Please sign in to comment.