Add migration docs for 02-client refactor (cosmos#1287)

* add changes on : ClientState, Header, Misbehaviour, ConsensState, light client impl to migration doc * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: colin axnér <[email protected]> * add more entries and more description * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Sean King <[email protected]> * Update docs/migrations/v3-to-v4.md Co-authored-by: Carlos Rodriguez <[email protected]> * update migration doc * update migration doc * update migration doc Co-authored-by: colin axnér <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: Sean King <[email protected]>
ComposableFi · Aug 9, 2022 · 2a6aa3a · 2a6aa3a
1 parent c0877c9
commit 2a6aa3a
Showing 1 changed file with 45 additions and 5 deletions.
diff --git a/docs/migrations/v3-to-v4.md b/docs/migrations/v3-to-v4.md
@@ -18,13 +18,53 @@ No genesis or in-place migrations required when upgrading from v1 or v2 of ibc-g
 
 ## Chains
 
-### IS04 - Channel 
+### IS04 - Channel
 
-The `WriteAcknowledgement` API now takes the `exported.Acknowledgement` type instead of passing in the acknowledgement byte array directly. 
-This is an API breaking change and as such IBC application developers will have to update any calls to `WriteAcknowledgement`. 
+The `WriteAcknowledgement` API now takes the `exported.Acknowledgement` type instead of passing in the acknowledgement byte array directly.
+This is an API breaking change and as such IBC application developers will have to update any calls to `WriteAcknowledgement`.
 
 ## IBC Light Clients
 
-The `VerifyUpgradeAndUpdateState` function has been modified. The client state and consensus state return value has been removed. 
+### `ClientState` interface changes
 
-Light clients **must** set the updated client state and consensus state in the client store after verifying a valid client upgrade.
+The `VerifyUpgradeAndUpdateState` function has been modified. The client state and consensus state return values have been removed.
+
+Light clients **must** handle all management of client and consensus states including the setting of updated client state and consensus state in the client store.
+
+The `CheckHeaderAndUpdateState` function has been split into 4 new functions:
+
+- `VerifyClientMessage` verifies a `ClientMessage`. A `ClientMessage` could be a `Header`, `Misbehaviour`, or batch update. Calls to `CheckForMisbehaviour`, `UpdateState`, and `UpdateStateOnMisbehaviour` will assume that the content of the `ClientMessage` has been verified and can be trusted. An error should be returned if the `ClientMessage` fails to verify.
+
+- `CheckForMisbehaviour` checks for evidence of a misbehaviour in `Header` or `Misbehaviour` types.
+
+- `UpdateStateOnMisbehaviour` performs appropriate state changes on a `ClientState` given that misbehaviour has been detected and verified.
+
+- `UpdateState` updates and stores as necessary any associated information for an IBC client, such as the `ClientState` and corresponding `ConsensusState`. An error is returned if `ClientMessage` is of type `Misbehaviour`. Upon successful update, a list containing the updated consensus state height is returned.
+
+The `CheckMisbehaviourAndUpdateState` function has been removed from `ClientState` interface. This functionality is now encapsulated by the usage of `VerifyClientMessage`, `CheckForMisbehaviour`, `UpdateStateOnMisbehaviour`, `UpdateState`.
+
+The function `GetTimestampAtHeight` has been added to the `ClientState` interface. It should return the timestamp for a consensus state associated with the provided height.
+
+### `Header` and `Misbehaviour`
+
+`exported.Header` and `exported.Misbehaviour` interface types have been merged and renamed to `ClientMessage` interface.
+
+`GetHeight` function has been removed from `exported.Header` and thus is not included in the `ClientMessage` interface
+
+### `ConsensusState`
+
+The `GetRoot` function has been removed from consensus state interface since it was not used by core IBC.
+
+### Light client implementations
+
+09-localhost light client implementation has been removed because it is currently non-functional.
+
+### Client Keeper
+
+Keeper function `CheckMisbehaviourAndUpdateState` has been removed since function `UpdateClient` can now handle updating `ClientState` on `ClientMessage` type which can be any `Misbehaviour` implementations.  
+
+### SDK Message
+
+`MsgSubmitMisbehaviour` is deprecated since `MsgUpdateClient` can now submit a `ClientMessage` type which can be any `Misbehaviour` implementations.
+
+The field `header` in `MsgUpdateClient` has been renamed to `client message`.