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.

Sign up for GitHub

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

Adding VerifyClientMessage to ClientState interface #1196

Merged
merged 7 commits into from
Mar 30, 2022
Merged

Adding VerifyClientMessage to ClientState interface #1196

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ff5cc2b
feat: adding VerifyClientMessage to ClientState interface
seantking Mar 30, 2022
7a2e595
fix: legacy
seantking Mar 30, 2022
eba6524
remove todo + fix test
seantking Mar 30, 2022
830299b
Update modules/core/exported/client.go
seantking Mar 30, 2022
df322e4
Update modules/core/02-client/legacy/v100/solomachine.go
seantking Mar 30, 2022
53624ad
Merge branch '02-client-refactor' into sean/issue#1191-add-verify-cli…
seantking Mar 30, 2022
41cc1a6
chore: changelog
seantking Mar 30, 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
7 changes: 7 additions & 0 deletions modules/core/02-client/legacy/v100/solomachine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@ func (cs ClientState) ExportMetadata(_ sdk.KVStore) []exported.GenesisMetadata {
panic("legacy solo machine is deprecated!")
}

// VerifyClientMessage panics
seantking marked this conversation as resolved.
Show resolved Hide resolved
func (cs *ClientState) VerifyClientMessage(
_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.ClientMessage,
) error {
panic("legacy solo machine is deprecated!")
}

// CheckHeaderAndUpdateState panics!
func (cs *ClientState) CheckHeaderAndUpdateState(
_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.ClientMessage,
Expand Down
4 changes: 3 additions & 1 deletion modules/core/exported/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ type ClientState interface {
// Genesis function
ExportMetadata(sdk.KVStore) []GenesisMetadata

// Update and Misbehaviour functions
// VerifyClientMessage verifies a Header or a Misbehaviour
seantking marked this conversation as resolved.
Show resolved Hide resolved
VerifyClientMessage(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, clientMsg ClientMessage) error

// Update and Misbehaviour functions
CheckHeaderAndUpdateState(sdk.Context, codec.BinaryCodec, sdk.KVStore, ClientMessage) (ClientState, ConsensusState, error)
CheckMisbehaviourAndUpdateState(sdk.Context, codec.BinaryCodec, sdk.KVStore, ClientMessage) (ClientState, error)
CheckSubstituteAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, subjectClientStore, substituteClientStore sdk.KVStore, substituteClient ClientState) (ClientState, error)
Expand Down
2 changes: 1 addition & 1 deletion modules/light-clients/07-tendermint/types/misbehaviour_handle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func (cs ClientState) CheckMisbehaviourAndUpdateState(
return nil, sdkerrors.Wrapf(clienttypes.ErrInvalidClientType, "expected type %T, got %T", misbehaviour, &Misbehaviour{})
}

if err := cs.VerifyClientMessage(ctx, clientStore, cdc, tmMisbehaviour); err != nil {
if err := cs.VerifyClientMessage(ctx, cdc, clientStore, tmMisbehaviour); err != nil {
return nil, err
}

Expand Down
4 changes: 2 additions & 2 deletions modules/light-clients/07-tendermint/types/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func (cs ClientState) CheckHeaderAndUpdateState(
conflictingHeader = true
}

if err := cs.VerifyClientMessage(ctx, clientStore, cdc, tmHeader); err != nil {
if err := cs.VerifyClientMessage(ctx, cdc, clientStore, tmHeader); err != nil {
return nil, nil, err
}

Expand Down Expand Up @@ -119,7 +119,7 @@ func checkTrustedHeader(header *Header, consState *ConsensusState) error {

// VerifyClientMessage checks if the clientMessage is of type Header or Misbehaviour and verifies the message
func (cs *ClientState) VerifyClientMessage(
ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryCodec,
ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore,
clientMsg exported.ClientMessage,
) error {
switch msg := clientMsg.(type) {
Expand Down
9 changes: 9 additions & 0 deletions modules/light-clients/09-localhost/types/client_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ func (cs ClientState) VerifyUpgradeAndUpdateState(
return sdkerrors.Wrap(clienttypes.ErrInvalidUpgradeClient, "cannot upgrade localhost client")
}

// VerifyClientMessage
// TODO: localhost client will be removed
func (cs ClientState) VerifyClientMessage(
_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore,
_ exported.ClientMessage,
) error {
return nil
}

// VerifyClientState verifies that the localhost client state is stored locally
func (cs ClientState) VerifyClientState(
store sdk.KVStore, cdc codec.BinaryCodec,
Expand Down