Skip to content

Commit

Permalink
add changes on : ClientState, Header, Misbehaviour, ConsensState, lig…
Browse files Browse the repository at this point in the history
…ht client impl to migration doc
  • Loading branch information
catShaark committed Apr 25, 2022
1 parent e249518 commit 1fc561e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/migrations/v3-to-v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@ This is an API breaking change and as such IBC application developers will have

## IBC Light Clients

### Light client and ClientState

The `VerifyUpgradeAndUpdateState` function has been modified. The client state and consensus state return value has been removed.

Light clients **must** set the updated client state and consensus state in the client store after verifying a valid client upgrade.

The `CheckHeaderAndUpdateState` function has been split into 4 new functions: `VerifyClientMessage`, `CheckForMisbehaviour`, `UpdateState`,
`UpdateStateOnMisbehaviour`

Light client implementations now need to manage setting of client and consensus states for these interface functions `UpdateState`, `UpdateStateOnMisbehaviour`, `VerifyUpgradeAndUpdateState`, `CheckSubstituteAndUpdateState`

The `CheckMisbehaviourAndUpdateState` function has been removed from `ClientState` interface

The `GetTimestampAtHeight` has been added to the `ClientState` interface

### Header and Misbehaviour

`exported.Header` and `exported.Misbehaviour` interface types have been merged and renamed to `ClientMessage` interface

### ConsensusState

The `GetRoot` function has been removed from consensus state interface

0 comments on commit 1fc561e

Please sign in to comment.