-
Notifications
You must be signed in to change notification settings - Fork 579
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
) * Adding 09-localhost loopback client module (#3229) feat: adding 09-localhost loopback client module [\#3034](#3034). Please see the 09-localhost documentation [here](https://ibc.cosmos.network/main/ibc/light-clients/localhost/overview.html). feat: AllowedClients on-chain param allows chains to pause usage of specific client types by removing the client type from the param. imp: Update all channel events to use `connection_id` attribute. The `packet_connection` attribute has been deprecated. (cherry picked from commit d840c69) # Conflicts: # .github/workflows/e2e-upgrade.yaml # docs/ibc/events.md # e2e/relayer/relayer.go # e2e/testconfig/testconfig.go # e2e/tests/upgrades/upgrade_test.go # e2e/testsuite/codec.go # e2e/testsuite/grpc_query.go # e2e/testsuite/testsuite.go # modules/core/02-client/keeper/client.go # modules/core/02-client/keeper/proposal.go # modules/core/02-client/types/errors.go # modules/core/03-connection/keeper/verify.go # modules/core/03-connection/types/msgs_test.go # modules/core/04-channel/keeper/packet.go # modules/core/04-channel/types/msgs.go * rm -rf e2e * rm .github/workflows/e2e-upgrade.yaml * fix errorsmod -> sdkerrors * ibcerror -> sdkerror in localhost client_state.go --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com>
- Loading branch information
1 parent
9403c30
commit 893b7af
Showing
63 changed files
with
1,921 additions
and
243 deletions.
There are no files selected for viewing
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 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 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,60 @@ | ||
| <!-- | ||
| order: 3 | ||
| --> | ||
|
|
||
| # `ClientState` | ||
|
|
||
| The 09-localhost `ClientState` maintains a single field used to track the latest sequence of the state machine i.e. the height of the blockchain. | ||
|
|
||
| ```go | ||
| type ClientState struct { | ||
| // the latest height of the blockchain | ||
| LatestHeight clienttypes.Height | ||
| } | ||
| ``` | ||
|
|
||
| The 09-localhost `ClientState` is instantiated in the `InitGenesis` handler of the 02-client submodule in core IBC. | ||
| It calls `CreateLocalhostClient`, declaring a new `ClientState` and initializing it with its own client prefixed store. | ||
|
|
||
| ```go | ||
| func (k Keeper) CreateLocalhostClient(ctx sdk.Context) error { | ||
| var clientState localhost.ClientState | ||
| return clientState.Initialize(ctx, k.cdc, k.ClientStore(ctx, exported.LocalhostClientID), nil) | ||
| } | ||
| ``` | ||
|
|
||
| It is possible to disable the localhost client by removing the `09-localhost` entry from the `allowed_clients` list through governance. | ||
|
|
||
| ## Client updates | ||
|
|
||
| The latest height is updated periodically through the ABCI [`BeginBlock`](https://docs.cosmos.network/v0.47/building-modules/beginblock-endblock) interface of the 02-client submodule in core IBC. | ||
|
|
||
| [See `BeginBlocker` in abci.go.](https://github.com/cosmos/ibc-go/blob/09-localhost/modules/core/02-client/abci.go#L12) | ||
|
|
||
| ```go | ||
| func BeginBlocker(ctx sdk.Context, k keeper.Keeper) { | ||
| // ... | ||
|
|
||
| if clientState, found := k.GetClientState(ctx, exported.Localhost); found { | ||
| if k.GetClientStatus(ctx, clientState, exported.Localhost) == exported.Active { | ||
| k.UpdateLocalhostClient(ctx, clientState) | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The above calls into the the 09-localhost `UpdateState` method of the `ClientState` . | ||
| It retrieves the current block height from the application context and sets the `LatestHeight` of the 09-localhost client. | ||
|
|
||
| ```go | ||
| func (cs ClientState) UpdateState(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, clientMsg exported.ClientMessage) []exported.Height { | ||
| height := clienttypes.GetSelfHeight(ctx) | ||
| cs.LatestHeight = height | ||
|
|
||
| clientStore.Set(host.ClientStateKey(), clienttypes.MustMarshalClientState(cdc, &cs)) | ||
|
|
||
| return []exported.Height{height} | ||
| } | ||
| ``` | ||
|
|
||
| Note that the 09-localhost `ClientState` is not updated through the 02-client interface leveraged by conventional IBC light clients. |
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,25 @@ | ||
| <!-- | ||
| order: 4 | ||
| --> | ||
|
|
||
| # Localhost connections | ||
|
|
||
| The 09-localhost light client module integrates with core IBC through a single sentinel localhost connection. | ||
| The sentinel `ConnectionEnd` is stored by default in the core IBC store. | ||
|
|
||
| This enables channel handshakes to be initiated out of the box by supplying the localhost connection identifier (`connection-localhost`) in the `connectionHops` parameter of `MsgChannelOpenInit`. | ||
|
|
||
| The `ConnectionEnd` is created and set in store via the `InitGenesis` handler of the 03-connection submodule in core IBC. | ||
| The `ConnectionEnd` and its `Counterparty` both reference the `09-localhost` client identifier, and share the localhost connection identifier `connection-localhost`. | ||
|
|
||
| ```go | ||
| // CreateSentinelLocalhostConnection creates and sets the sentinel localhost connection end in the IBC store. | ||
| func (k Keeper) CreateSentinelLocalhostConnection(ctx sdk.Context) { | ||
| counterparty := types.NewCounterparty(exported.LocalhostClientID, exported.LocalhostConnectionID, commitmenttypes.NewMerklePrefix(k.GetCommitmentPrefix().Bytes())) | ||
| connectionEnd := types.NewConnectionEnd(types.OPEN, exported.LocalhostClientID, counterparty, types.ExportedVersionsToProto(types.GetCompatibleVersions()), 0) | ||
|
|
||
| k.SetConnection(ctx, exported.LocalhostConnectionID, connectionEnd) | ||
| } | ||
| ``` | ||
|
|
||
| Note that connection handshakes are disallowed when using the `09-localhost` client type. |
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,16 @@ | ||
| <!-- | ||
| order: 2 | ||
| --> | ||
|
|
||
| # Integration | ||
|
|
||
| The 09-localhost light client module registers codec types within the core IBC module. This differs from other light client module implementations which are expected to register codec types using the `AppModuleBasic` interface. | ||
|
|
||
| The localhost client is added to the 02-client submodule param [`allowed_clients`](https://github.com/cosmos/ibc-go/blob/v7.0.0-rc0/proto/ibc/core/client/v1/client.proto#L102) by default in ibc-go. | ||
|
|
||
| ```go | ||
| var ( | ||
| // DefaultAllowedClients are the default clients for the AllowedClients parameter. | ||
| DefaultAllowedClients = []string{exported.Solomachine, exported.Tendermint, exported.Localhost} | ||
| ) | ||
| ``` |
Oops, something went wrong.