chore: MsgUpdateClient rename header to client_message (#1316)

* updating MsgUpdateClient to use client_message field in favour of header

* updating clis, field naming, and adding deprecation notices

docs/ibc/proto-docs.md

@@ -3418,13 +3418,13 @@ type.
 
 ### MsgUpdateClient
 MsgUpdateClient defines an sdk.Msg to update a IBC client state using
-the given header.
+the given client message.
 
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `client_id` | [string](#string) |  | client unique identifier |
-| `header` | [google.protobuf.Any](#google.protobuf.Any) |  | header to update the light client |
+| `client_message` | [google.protobuf.Any](#google.protobuf.Any) |  | client message to update the light client |
 | `signer` | [string](#string) |  | signer address |
 
 

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

@@ -44,7 +44,7 @@ func NewTxCmd() *cobra.Command {
 	txCmd.AddCommand(
 		NewCreateClientCmd(),
 		NewUpdateClientCmd(),
-		NewSubmitMisbehaviourCmd(),
+		NewSubmitMisbehaviourCmd(), // Deprecated
 		NewUpgradeClientCmd(),
 	)
 

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

@@ -86,10 +86,10 @@ func NewCreateClientCmd() *cobra.Command {
 // NewUpdateClientCmd defines the command to update an IBC client.
 func NewUpdateClientCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:     "update [client-id] [path/to/header.json]",
-		Short:   "update existing client with a header",
-		Long:    "update existing client with a header",
-		Example: fmt.Sprintf("%s tx ibc %s update [client-id] [path/to/header.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
+		Use:     "update [client-id] [path/to/client_msg.json]",
+		Short:   "update existing client with a client message",
+		Long:    "update existing client with a client message, for example a header, misbehaviour or batch update",
+		Example: fmt.Sprintf("%s tx ibc %s update [client-id] [path/to/client_msg.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)
@@ -100,22 +100,22 @@ func NewUpdateClientCmd() *cobra.Command {
 
 			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
 
-			var header exported.ClientMessage
-			headerContentOrFileName := args[1]
-			if err := cdc.UnmarshalInterfaceJSON([]byte(headerContentOrFileName), &header); err != nil {
+			var clientMsg exported.ClientMessage
+			clientMsgContentOrFileName := args[1]
+			if err := cdc.UnmarshalInterfaceJSON([]byte(clientMsgContentOrFileName), &clientMsg); err != nil {
 
 				// check for file path if JSON input is not provided
-				contents, err := ioutil.ReadFile(headerContentOrFileName)
+				contents, err := ioutil.ReadFile(clientMsgContentOrFileName)
 				if err != nil {
 					return fmt.Errorf("neither JSON input nor path to .json file for header were provided: %w", err)
 				}
 
-				if err := cdc.UnmarshalInterfaceJSON(contents, &header); err != nil {
+				if err := cdc.UnmarshalInterfaceJSON(contents, &clientMsg); err != nil {
 					return fmt.Errorf("error unmarshalling header file: %w", err)
 				}
 			}
 
-			msg, err := types.NewMsgUpdateClient(clientID, header, clientCtx.GetFromAddress().String())
+			msg, err := types.NewMsgUpdateClient(clientID, clientMsg, clientCtx.GetFromAddress().String())
 			if err != nil {
 				return err
 			}
@@ -127,6 +127,8 @@ func NewUpdateClientCmd() *cobra.Command {
 
 // NewSubmitMisbehaviourCmd defines the command to submit a misbehaviour to prevent
 // future updates.
+// Deprecated: NewSubmitMisbehaviourCmd is deprecated and will be removed in a future release.
+// Please use NewUpdateClientCmd instead.
 func NewSubmitMisbehaviourCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:     "misbehaviour [clientID] [path/to/misbehaviour.json]",

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

@@ -101,16 +101,16 @@ func (msg MsgCreateClient) UnpackInterfaces(unpacker codectypes.AnyUnpacker) err
 
 // NewMsgUpdateClient creates a new MsgUpdateClient instance
 //nolint:interfacer
-func NewMsgUpdateClient(id string, header exported.ClientMessage, signer string) (*MsgUpdateClient, error) {
-	anyHeader, err := PackClientMessage(header)
+func NewMsgUpdateClient(id string, clientMsg exported.ClientMessage, signer string) (*MsgUpdateClient, error) {
+	anyClientMsg, err := PackClientMessage(clientMsg)
 	if err != nil {
 		return nil, err
 	}
 
 	return &MsgUpdateClient{
-		ClientId: id,
-		Header:   anyHeader,
-		Signer:   signer,
+		ClientId:      id,
+		ClientMessage: anyClientMsg,
+		Signer:        signer,
 	}, nil
 }
 
@@ -120,11 +120,11 @@ func (msg MsgUpdateClient) ValidateBasic() error {
 	if err != nil {
 		return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
 	}
-	header, err := UnpackClientMessage(msg.Header)
+	clientMsg, err := UnpackClientMessage(msg.ClientMessage)
 	if err != nil {
 		return err
 	}
-	if err := header.ValidateBasic(); err != nil {
+	if err := clientMsg.ValidateBasic(); err != nil {
 		return err
 	}
 	return host.ClientIdentifierValidator(msg.ClientId)
@@ -141,8 +141,8 @@ func (msg MsgUpdateClient) GetSigners() []sdk.AccAddress {
 
 // UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces
 func (msg MsgUpdateClient) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
-	var header exported.ClientMessage
-	return unpacker.UnpackAny(msg.Header, &header)
+	var clientMsg exported.ClientMessage
+	return unpacker.UnpackAny(msg.ClientMessage, &clientMsg)
 }
 
 // NewMsgUpgradeClient creates a new MsgUpgradeClient instance

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

@@ -278,7 +278,7 @@ func (suite *TypesTestSuite) TestMsgUpdateClient_ValidateBasic() {
 		{
 			"failed to unpack header",
 			func() {
-				msg.Header = nil
+				msg.ClientMessage = nil
 			},
 			false,
 		},

modules/core/keeper/msg_server.go

@@ -45,12 +45,12 @@ 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.UnpackClientMessage(msg.Header)
+	clientMsg, err := clienttypes.UnpackClientMessage(msg.ClientMessage)
 	if err != nil {
 		return nil, err
 	}
 
-	if err = k.ClientKeeper.UpdateClient(ctx, msg.ClientId, header); err != nil {
+	if err = k.ClientKeeper.UpdateClient(ctx, msg.ClientId, clientMsg); err != nil {
 		return nil, err
 	}
 

proto/ibc/core/client/v1/tx.proto

@@ -40,15 +40,15 @@ message MsgCreateClient {
 message MsgCreateClientResponse {}
 
 // MsgUpdateClient defines an sdk.Msg to update a IBC client state using
-// the given header.
+// the given client message.
 message MsgUpdateClient {
   option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;
 
   // client unique identifier
   string client_id = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
-  // header to update the light client
-  google.protobuf.Any header = 2;
+  // client message to update the light client
+  google.protobuf.Any client_message = 2;
   // signer address
   string signer = 3;
 }