fix: update related functions

docs/architecture/adr-027-ibc-wasm.md

@@ -100,7 +100,7 @@ packaged inside a payload which is json serialized and passed to `callContract`
 array of bytes returned by the smart contract. This data is deserialized and passed as return argument.
 
 ```go
-func (c *ClientState) CheckProposedHeaderAndUpdateState(context sdk.Context, marshaler codec.BinaryMarshaler, store sdk.KVStore, header exported.Header) (exported.ClientState, exported.ConsensusState, error) {
+func (c *ClientState) CheckProposedHeaderAndUpdateState(context sdk.Context, marshaler codec.BinaryMarshaler, store sdk.KVStore, header exported.ClientMessage) (exported.ClientState, exported.ConsensusState, error) {
 	// get consensus state corresponding to client state to check if the client is expired
 	consensusState, err := GetConsensusState(store, marshaler, c.LatestHeight)
 	if err != nil {

modules/core/02-client/client/cli/tx.go

@@ -100,7 +100,7 @@ func NewUpdateClientCmd() *cobra.Command {
 
 			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
 
-			var header exported.Header
+			var header exported.ClientMessage
 			headerContentOrFileName := args[1]
 			if err := cdc.UnmarshalInterfaceJSON([]byte(headerContentOrFileName), &header); err != nil {
 
@@ -129,20 +129,21 @@ func NewUpdateClientCmd() *cobra.Command {
 // future updates.
 func NewSubmitMisbehaviourCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:     "misbehaviour [path/to/misbehaviour.json]",
+		Use:     "misbehaviour [clientID] [path/to/misbehaviour.json]",
 		Short:   "submit a client misbehaviour",
 		Long:    "submit a client misbehaviour to prevent future updates",
-		Example: fmt.Sprintf("%s tx ibc %s misbehaviour [path/to/misbehaviour.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
-		Args:    cobra.ExactArgs(1),
+		Example: fmt.Sprintf("%s tx ibc %s misbehaviour [clientID] [path/to/misbehaviour.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
+		Args:    cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
 				return err
 			}
 			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
 
-			var misbehaviour exported.Misbehaviour
-			misbehaviourContentOrFileName := args[0]
+			var misbehaviour exported.ClientMessage
+			clientID := args[0]
+			misbehaviourContentOrFileName := args[1]
 			if err := cdc.UnmarshalInterfaceJSON([]byte(misbehaviourContentOrFileName), &misbehaviour); err != nil {
 
 				// check for file path if JSON input is not provided
@@ -156,7 +157,7 @@ func NewSubmitMisbehaviourCmd() *cobra.Command {
 				}
 			}
 
-			msg, err := types.NewMsgSubmitMisbehaviour(misbehaviour.GetClientID(), misbehaviour, clientCtx.GetFromAddress().String())
+			msg, err := types.NewMsgSubmitMisbehaviour(clientID, misbehaviour, clientCtx.GetFromAddress().String())
 			if err != nil {
 				return err
 			}

modules/core/02-client/keeper/client.go

@@ -57,7 +57,7 @@ func (k Keeper) CreateClient(
 }
 
 // UpdateClient updates the consensus state and the state root from a provided header.
-func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.Header) error {
+func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.ClientMessage) error {
 	clientState, found := k.GetClientState(ctx, clientID)
 	if !found {
 		return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot update client with ID %s", clientID)
@@ -85,7 +85,7 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
 		// Marshal the Header as an Any and encode the resulting bytes to hex.
 		// This prevents the event value from containing invalid UTF-8 characters
 		// which may cause data to be lost when JSON encoding/decoding.
-		headerStr = hex.EncodeToString(types.MustMarshalHeader(k.cdc, header))
+		headerStr = hex.EncodeToString(types.MustMarshalClientMessage(k.cdc, header))
 		// set default consensus height with header height
 		consensusHeight = header.GetHeight()
 
@@ -188,16 +188,16 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
 
 // CheckMisbehaviourAndUpdateState checks for client misbehaviour and freezes the
 // client if so.
-func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour exported.Misbehaviour) error {
-	clientState, found := k.GetClientState(ctx, misbehaviour.GetClientID())
+func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, clientID string, misbehaviour exported.ClientMessage) error {
+	clientState, found := k.GetClientState(ctx, clientID)
 	if !found {
-		return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot check misbehaviour for client with ID %s", misbehaviour.GetClientID())
+		return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot check misbehaviour for client with ID %s", clientID)
 	}
 
-	clientStore := k.ClientStore(ctx, misbehaviour.GetClientID())
+	clientStore := k.ClientStore(ctx, clientID)
 
 	if status := clientState.Status(ctx, clientStore, k.cdc); status != exported.Active {
-		return sdkerrors.Wrapf(types.ErrClientNotActive, "cannot process misbehaviour for client (%s) with status %s", misbehaviour.GetClientID(), status)
+		return sdkerrors.Wrapf(types.ErrClientNotActive, "cannot process misbehaviour for client (%s) with status %s", clientID, status)
 	}
 
 	if err := misbehaviour.ValidateBasic(); err != nil {
@@ -209,21 +209,21 @@ func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour ex
 		return err
 	}
 
-	k.SetClientState(ctx, misbehaviour.GetClientID(), clientState)
-	k.Logger(ctx).Info("client frozen due to misbehaviour", "client-id", misbehaviour.GetClientID())
+	k.SetClientState(ctx, clientID, clientState)
+	k.Logger(ctx).Info("client frozen due to misbehaviour", "client-id", clientID)
 
 	defer func() {
 		telemetry.IncrCounterWithLabels(
 			[]string{"ibc", "client", "misbehaviour"},
 			1,
 			[]metrics.Label{
 				telemetry.NewLabel(types.LabelClientType, misbehaviour.ClientType()),
-				telemetry.NewLabel(types.LabelClientID, misbehaviour.GetClientID()),
+				telemetry.NewLabel(types.LabelClientID, clientID),
 			},
 		)
 	}()
 
-	EmitSubmitMisbehaviourEvent(ctx, misbehaviour.GetClientID(), clientState)
+	EmitSubmitMisbehaviourEvent(ctx, clientID, clientState)
 
 	return nil
 }

modules/core/02-client/keeper/client_test.go

@@ -650,7 +650,7 @@ func (suite *KeeperTestSuite) TestCheckMisbehaviourAndUpdateState() {
 
 			tc.misbehaviour.ClientId = clientID
 
-			err = suite.keeper.CheckMisbehaviourAndUpdateState(suite.ctx, tc.misbehaviour)
+			err = suite.keeper.CheckMisbehaviourAndUpdateState(suite.ctx, clientID, tc.misbehaviour)
 
 			if tc.expPass {
 				suite.Require().NoError(err, "valid test case %d failed: %s", i, tc.name)
@@ -691,7 +691,7 @@ func (suite *KeeperTestSuite) TestUpdateClientEventEmission() {
 			bz, err := hex.DecodeString(string(attr.Value))
 			suite.Require().NoError(err)
 
-			emittedHeader, err := types.UnmarshalHeader(suite.chainA.App.AppCodec(), bz)
+			emittedHeader, err := types.UnmarshalClientMessage(suite.chainA.App.AppCodec(), bz)
 			suite.Require().NoError(err)
 			suite.Require().Equal(header, emittedHeader)
 		}

modules/core/02-client/legacy/v100/solomachine.go

@@ -90,14 +90,14 @@ func (cs ClientState) ExportMetadata(_ sdk.KVStore) []exported.GenesisMetadata {
 
 // CheckHeaderAndUpdateState panics!
 func (cs *ClientState) CheckHeaderAndUpdateState(
-	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.Header,
+	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.ClientMessage,
 ) (exported.ClientState, exported.ConsensusState, error) {
 	panic("legacy solo machine is deprecated!")
 }
 
 // CheckMisbehaviourAndUpdateState panics!
 func (cs ClientState) CheckMisbehaviourAndUpdateState(
-	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.Misbehaviour,
+	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.ClientMessage,
 ) (exported.ClientState, error) {
 	panic("legacy solo machine is deprecated!")
 }

modules/core/02-client/types/codec.go

@@ -139,8 +139,8 @@ func PackClientMessage(clientMessage exported.ClientMessage) (*codectypes.Any, e
 	return any, nil
 }
 
-// UnpackHeader unpacks an Any into a Header. It returns an error if the
-// consensus state can't be unpacked into a Header.
+// UnpackClientMessage unpacks an Any into a ClientMessage. It returns an error if the
+// consensus state can't be unpacked into a ClientMessage.
 func UnpackClientMessage(any *codectypes.Any) (exported.ClientMessage, error) {
 	if any == nil {
 		return nil, sdkerrors.Wrap(sdkerrors.ErrUnpackAny, "protobuf Any message cannot be nil")

modules/core/02-client/types/codec_test.go

@@ -116,11 +116,11 @@ func (suite *TypesTestSuite) TestPackConsensusState() {
 	}
 }
 
-func (suite *TypesTestSuite) TestPackHeader() {
+func (suite *TypesTestSuite) TestPackClientMessage() {
 	testCases := []struct {
-		name    string
-		header  exported.Header
-		expPass bool
+		name          string
+		clientMessage exported.ClientMessage
+		expPass       bool
 	}{
 		{
 			"solo machine header",
@@ -142,7 +142,7 @@ func (suite *TypesTestSuite) TestPackHeader() {
 	testCasesAny := []caseAny{}
 
 	for _, tc := range testCases {
-		clientAny, err := types.PackHeader(tc.header)
+		clientAny, err := types.PackClientMessage(tc.clientMessage)
 		if tc.expPass {
 			suite.Require().NoError(err, tc.name)
 		} else {
@@ -153,57 +153,10 @@ func (suite *TypesTestSuite) TestPackHeader() {
 	}
 
 	for i, tc := range testCasesAny {
-		cs, err := types.UnpackHeader(tc.any)
+		cs, err := types.UnpackClientMessage(tc.any)
 		if tc.expPass {
 			suite.Require().NoError(err, tc.name)
-			suite.Require().Equal(testCases[i].header, cs, tc.name)
-		} else {
-			suite.Require().Error(err, tc.name)
-		}
-	}
-}
-
-func (suite *TypesTestSuite) TestPackMisbehaviour() {
-	testCases := []struct {
-		name         string
-		misbehaviour exported.Misbehaviour
-		expPass      bool
-	}{
-		{
-			"solo machine misbehaviour",
-			ibctesting.NewSolomachine(suite.T(), suite.chainA.Codec, "solomachine", "", 2).CreateMisbehaviour(),
-			true,
-		},
-		{
-			"tendermint misbehaviour",
-			ibctmtypes.NewMisbehaviour("tendermint", suite.chainA.LastHeader, suite.chainA.LastHeader),
-			true,
-		},
-		{
-			"nil",
-			nil,
-			false,
-		},
-	}
-
-	testCasesAny := []caseAny{}
-
-	for _, tc := range testCases {
-		clientAny, err := types.PackMisbehaviour(tc.misbehaviour)
-		if tc.expPass {
-			suite.Require().NoError(err, tc.name)
-		} else {
-			suite.Require().Error(err, tc.name)
-		}
-
-		testCasesAny = append(testCasesAny, caseAny{tc.name, clientAny, tc.expPass})
-	}
-
-	for i, tc := range testCasesAny {
-		cs, err := types.UnpackMisbehaviour(tc.any)
-		if tc.expPass {
-			suite.Require().NoError(err, tc.name)
-			suite.Require().Equal(testCases[i].misbehaviour, cs, tc.name)
+			suite.Require().Equal(testCases[i].clientMessage, cs, tc.name)
 		} else {
 			suite.Require().Error(err, tc.name)
 		}

modules/core/02-client/types/encoding_test.go

@@ -13,18 +13,17 @@ func (suite *TypesTestSuite) TestMarshalHeader() {
 	}
 
 	// marshal header
-	bz, err := types.MarshalHeader(cdc, h)
+	bz, err := types.MarshalClientMessage(cdc, h)
 	suite.Require().NoError(err)
 
 	// unmarshal header
-	newHeader, err := types.UnmarshalHeader(cdc, bz)
+	newHeader, err := types.UnmarshalClientMessage(cdc, bz)
 	suite.Require().NoError(err)
 
 	suite.Require().Equal(h, newHeader)
 
 	// use invalid bytes
-	invalidHeader, err := types.UnmarshalHeader(cdc, []byte("invalid bytes"))
+	invalidHeader, err := types.UnmarshalClientMessage(cdc, []byte("invalid bytes"))
 	suite.Require().Error(err)
 	suite.Require().Nil(invalidHeader)
-
 }

modules/core/ante/ante_test.go

@@ -153,7 +153,7 @@ func (suite *AnteTestSuite) createUpdateClientMessage() sdk.Msg {
 	// ensure counterparty has committed state
 	endpoint.Chain.Coordinator.CommitBlock(endpoint.Counterparty.Chain)
 
-	var header exported.Header
+	var header exported.ClientMessage
 
 	switch endpoint.ClientConfig.GetClientType() {
 	case exported.Tendermint:

modules/core/exported/client.go

@@ -199,6 +199,7 @@ type ClientMessage interface {
 	proto.Message
 
 	ClientType() string
+	GetHeight() Height
 	ValidateBasic() error
 }
 

modules/core/keeper/msg_server.go

@@ -45,7 +45,7 @@ func (k Keeper) CreateClient(goCtx context.Context, msg *clienttypes.MsgCreateCl
 func (k Keeper) UpdateClient(goCtx context.Context, msg *clienttypes.MsgUpdateClient) (*clienttypes.MsgUpdateClientResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 
-	header, err := clienttypes.UnpackHeader(msg.Header)
+	header, err := clienttypes.UnpackClientMessage(msg.Header)
 	if err != nil {
 		return nil, err
 	}
@@ -82,12 +82,12 @@ func (k Keeper) UpgradeClient(goCtx context.Context, msg *clienttypes.MsgUpgrade
 func (k Keeper) SubmitMisbehaviour(goCtx context.Context, msg *clienttypes.MsgSubmitMisbehaviour) (*clienttypes.MsgSubmitMisbehaviourResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 
-	misbehaviour, err := clienttypes.UnpackMisbehaviour(msg.Misbehaviour)
+	misbehaviour, err := clienttypes.UnpackClientMessage(msg.Misbehaviour)
 	if err != nil {
 		return nil, err
 	}
 
-	if err := k.ClientKeeper.CheckMisbehaviourAndUpdateState(ctx, misbehaviour); err != nil {
+	if err := k.ClientKeeper.CheckMisbehaviourAndUpdateState(ctx, msg.ClientId, misbehaviour); err != nil {
 		return nil, sdkerrors.Wrap(err, "failed to process misbehaviour for IBC client")
 	}
 

modules/light-clients/06-solomachine/types/codec.go

@@ -22,11 +22,11 @@ func RegisterInterfaces(registry codectypes.InterfaceRegistry) {
 		&ConsensusState{},
 	)
 	registry.RegisterImplementations(
-		(*exported.Header)(nil),
+		(*exported.ClientMessage)(nil),
 		&Header{},
 	)
 	registry.RegisterImplementations(
-		(*exported.Misbehaviour)(nil),
+		(*exported.ClientMessage)(nil),
 		&Misbehaviour{},
 	)
 }

modules/light-clients/06-solomachine/types/header.go

@@ -10,7 +10,7 @@ import (
 	"github.com/cosmos/ibc-go/v3/modules/core/exported"
 )
 
-var _ exported.Header = &Header{}
+var _ exported.ClientMessage = &Header{}
 
 // ClientType defines that the Header is a Solo Machine.
 func (Header) ClientType() string {

modules/light-clients/06-solomachine/types/misbehaviour.go

@@ -10,7 +10,7 @@ import (
 	"github.com/cosmos/ibc-go/v3/modules/core/exported"
 )
 
-var _ exported.Misbehaviour = &Misbehaviour{}
+var _ exported.ClientMessage = &Misbehaviour{}
 
 // ClientType is a Solo Machine light client.
 func (misbehaviour Misbehaviour) ClientType() string {
@@ -75,3 +75,9 @@ func (sd SignatureAndData) ValidateBasic() error {
 
 	return nil
 }
+
+// TODO: Remove GetHeight()
+// GetHeight implements the curret exported.Header interface, to be updated
+func (misbehaviour Misbehaviour) GetHeight() exported.Height {
+	return nil
+}

modules/light-clients/06-solomachine/types/misbehaviour_handle.go

@@ -19,7 +19,7 @@ func (cs ClientState) CheckMisbehaviourAndUpdateState(
 	ctx sdk.Context,
 	cdc codec.BinaryCodec,
 	clientStore sdk.KVStore,
-	misbehaviour exported.Misbehaviour,
+	misbehaviour exported.ClientMessage,
 ) (exported.ClientState, error) {
 
 	soloMisbehaviour, ok := misbehaviour.(*Misbehaviour)

modules/light-clients/06-solomachine/types/misbehaviour_handle_test.go

@@ -10,7 +10,7 @@ import (
 func (suite *SoloMachineTestSuite) TestCheckMisbehaviourAndUpdateState() {
 	var (
 		clientState  exported.ClientState
-		misbehaviour exported.Misbehaviour
+		misbehaviour exported.ClientMessage
 	)
 
 	// test singlesig and multisig public keys

modules/light-clients/06-solomachine/types/update.go

@@ -17,7 +17,7 @@ import (
 // - the currently registered public key did not provide the update signature
 func (cs ClientState) CheckHeaderAndUpdateState(
 	ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore,
-	header exported.Header,
+	header exported.ClientMessage,
 ) (exported.ClientState, exported.ConsensusState, error) {
 	smHeader, ok := header.(*Header)
 	if !ok {

modules/light-clients/06-solomachine/types/update_test.go

@@ -13,7 +13,7 @@ import (
 func (suite *SoloMachineTestSuite) TestCheckHeaderAndUpdateState() {
 	var (
 		clientState exported.ClientState
-		header      exported.Header
+		header     exported.ClientMessage 
 	)
 
 	// test singlesig and multisig public keys