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

Add migration docs for 02-client refactor #1287

Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
1fc561e
add changes on : ClientState, Header, Misbehaviour, ConsensState, lig…
catShaark Apr 25, 2022
0e7bd3a
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
7db7f72
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
250353d
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
4699eb2
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
5b7f447
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
4de0e29
Update docs/migrations/v3-to-v4.md
catShaark Apr 25, 2022
6c9551f
add more entries and more description
catShaark Apr 26, 2022
8c77483
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
060988a
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
1c546b9
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
2f890d2
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
fefb363
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
1a27799
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
318a2d5
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
5886fed
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
ee9eb5f
Update docs/migrations/v3-to-v4.md
catShaark Apr 26, 2022
8a91ca3
Merge branch '02-client-refactor' into add-migration-docs-for-client-…
catShaark Apr 27, 2022
776890a
Merge branch '02-client-refactor' into add-migration-docs-for-client-…
catShaark Apr 27, 2022
fb92159
Merge branch '02-client-refactor' into add-migration-docs-for-client-…
catShaark Apr 29, 2022
4aad399
Update docs/migrations/v3-to-v4.md
catShaark Apr 29, 2022
f2739ea
Merge branch '02-client-refactor' into add-migration-docs-for-client-…
catShaark May 9, 2022
12f6dcb
update migration doc
catShaark May 9, 2022
c29da1e
update migration doc
catShaark May 9, 2022
9fde6ec
update migration doc
catShaark May 9, 2022
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
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
catShaark marked this conversation as resolved.
Show resolved Hide resolved

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.
catShaark marked this conversation as resolved.
Show resolved Hide resolved

The `CheckHeaderAndUpdateState` function has been split into 4 new functions: `VerifyClientMessage`, `CheckForMisbehaviour`, `UpdateState`,
`UpdateStateOnMisbehaviour`
catShaark marked this conversation as resolved.
Show resolved Hide resolved

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

catShaark marked this conversation as resolved.
Show resolved Hide resolved
The `CheckMisbehaviourAndUpdateState` function has been removed from `ClientState` interface
catShaark marked this conversation as resolved.
Show resolved Hide resolved

The `GetTimestampAtHeight` has been added to the `ClientState` interface
catShaark marked this conversation as resolved.
Show resolved Hide resolved

### Header and Misbehaviour
catShaark marked this conversation as resolved.
Show resolved Hide resolved

`exported.Header` and `exported.Misbehaviour` interface types have been merged and renamed to `ClientMessage` interface
catShaark marked this conversation as resolved.
Show resolved Hide resolved

### ConsensusState
catShaark marked this conversation as resolved.
Show resolved Hide resolved

The `GetRoot` function has been removed from consensus state interface
catShaark marked this conversation as resolved.
Show resolved Hide resolved