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.

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

docs: update docs for updating client params #3869

Merged
merged 6 commits into from
Jun 20, 2023
Merged
Changes from all commits
Commits
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
21 changes: 10 additions & 11 deletions docs/ibc/light-clients/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,29 +101,28 @@ Within the `02-client` submodule, the [`ClientState` is then initialized](https:

In order to successfully create an IBC client using a new client type, it [must be supported](https://github.com/cosmos/ibc-go/blob/v7.0.0/modules/core/02-client/keeper/client.go#L19-L25). Light client support in IBC is gated by on-chain governance. The allow list may be updated by submitting a new governance proposal to update the `02-client` parameter `AllowedClients`.

<!--
- TODO: update when params are managed by ibc-go
- https://github.com/cosmos/ibc-go/issues/2010
-->
See below for example:

```shell
%s tx gov submit-proposal param-change <path/to/proposal.json> --from=<key_or_address>
%s tx gov submit-proposal <path/to/proposal.json> --from <key_or_address>
```

where `proposal.json` contains:

```json
{
"title": "IBC Clients Param Change",
"description": "Update allowed clients",
"changes": [
"summary": "Update allowed clients",
"messages": [
{
"subspace": "ibc",
"key": "AllowedClients",
"value": ["06-solomachine", "07-tendermint", "0x-new-client"]
"@type": "/ibc.core.client.v1.MsgUpdateParams",
"authority": "cosmos1...", // The gov module account address
"params": {
"allowed_clients": ["06-solomachine", "07-tendermint", "0x-new-client"]
}
}
],
"deposit": "1000stake"
"metadata": "AQ==",
"deposit": "100stake"
}
```