Re-introduce "Emit header in MsgUpdateClient events (bp #8624) (#8770)""

This reverts commit 37946fb.

Ref: #8770

CHANGELOG.md

@@ -34,10 +34,14 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
-## [v0.42.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.0) - 2021-03-03
+## [v0.42.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.0) - 2021-03-05
 
 **IMPORTANT**: This release contains an important security fix for all non Cosmos Hub chains running Stargate version of the Cosmos SDK (>0.40). Non-hub chains should not be using any version of the SDK in the v0.40.x or v0.41.x release series. See [#8461](https://github.com/cosmos/cosmos-sdk/pull/8461) for more details.
 
+### Improvements
+
+* (x/ibc) [\#8624](https://github.com/cosmos/cosmos-sdk/pull/8624) Emit full header in IBC UpdateClient message.
+
 ### Bug fixes
 
 * (x/evidence) [#8461](https://github.com/cosmos/cosmos-sdk/pull/8461) Fix bech32 prefix in evidence validator address conversion

go.sum

@@ -144,7 +144,6 @@ github.com/edsrzf/mmap-go v1.0.0/go.mod h1:YO35OhQPt3KJa3ryjFM5Bs14WD66h8eGKpfaB
 github.com/enigmampc/btcutil v1.0.3-0.20200723161021-e2fb6adb2a25 h1:2vLKys4RBU4pn2T/hjXMbvwTr1Cvy5THHrQkbeY9HRk=
 github.com/enigmampc/btcutil v1.0.3-0.20200723161021-e2fb6adb2a25/go.mod h1:hTr8+TLQmkUkgcuh3mcr5fjrT9c64ZzsBCdCEC6UppY=
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
-github.com/envoyproxy/protoc-gen-validate v0.1.0 h1:EQciDnbrYxy13PgWoY8AqoxGiPrpgBZ1R8UNe3ddc+A=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/facebookgo/ensure v0.0.0-20160127193407-b4ab57deab51 h1:0JZ+dUmQeA8IIVUMzysrX4/AKuQwWhV2dYQuPZdvdSQ=
 github.com/facebookgo/ensure v0.0.0-20160127193407-b4ab57deab51/go.mod h1:Yg+htXGokKKdzcwhuNDwVvN+uBxDGXJ7G/VN1d8fa64=
@@ -224,7 +223,6 @@ github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OI
 github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/google/uuid v1.1.2 h1:EVhdT+1Kseyi1/pUmXKaFxYsDNy9RQYkMWRH68J/W7Y=
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg=
 github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk=
@@ -486,7 +484,6 @@ github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
 github.com/samuel/go-zookeeper v0.0.0-20190923202752-2cc03de413da/go.mod h1:gi+0XIa01GRL2eRQVjQkKGqKF3SF9vZR/HnPullcV2E=
-github.com/sasha-s/go-deadlock v0.2.0 h1:lMqc+fUb7RrFS3gQLtoQsJ7/6TV/pAIFvBsqX73DK8Y=
 github.com/sasha-s/go-deadlock v0.2.0/go.mod h1:StQn567HiB1fF2yJ44N9au7wOhrPS3iZqiDbRupzT10=
 github.com/sasha-s/go-deadlock v0.2.1-0.20190427202633-1595213edefa h1:0U2s5loxrTy6/VgfVoLuVLFJcURKLH49ie0zSch7gh4=
 github.com/sasha-s/go-deadlock v0.2.1-0.20190427202633-1595213edefa/go.mod h1:F73l+cr82YSh10GxyRI6qZiCgK64VaZjwesgfQ1/iLM=
@@ -538,7 +535,6 @@ github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoH
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
@@ -560,7 +556,6 @@ github.com/tendermint/tendermint v0.34.0/go.mod h1:Aj3PIipBFSNO21r+Lq3TtzQ+uKESx
 github.com/tendermint/tendermint v0.34.8 h1:PMWgUx47FrNTsfhxCWzoiIlVAC1SE9+WBlnsF9oQW0I=
 github.com/tendermint/tendermint v0.34.8/go.mod h1:JVuu3V1ZexOaZG8VJMRl8lnfrGw6hEB2TVnoUwKRbss=
 github.com/tendermint/tm-db v0.6.2/go.mod h1:GYtQ67SUvATOcoY8/+x6ylk8Qo02BQyLrAs+yAcLvGI=
-github.com/tendermint/tm-db v0.6.3 h1:ZkhQcKnB8/2jr5EaZwGndN4owkPsGezW2fSisS9zGbg=
 github.com/tendermint/tm-db v0.6.3/go.mod h1:lfA1dL9/Y/Y8wwyPp2NMLyn5P5Ptr/gvDFNWtrCWSf8=
 github.com/tendermint/tm-db v0.6.4 h1:3N2jlnYQkXNQclQwd/eKV/NzlqPlfK21cpRRIx80XXQ=
 github.com/tendermint/tm-db v0.6.4/go.mod h1:dptYhIpJ2M5kUuenLr+Yyf3zQOv1SgBZcl8/BmWlMBw=

x/ibc/core/02-client/keeper/client.go

@@ -1,6 +1,8 @@
 package keeper
 
 import (
+	"encoding/hex"
+
 	"github.com/armon/go-metrics"
 
 	"github.com/cosmos/cosmos-sdk/telemetry"
@@ -95,13 +97,24 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
 		)
 	}()
 
+	// emit the full header in events
+	var headerStr string
+	if header != nil {
+		// 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))
+
+	}
+
 	// emitting events in the keeper emits for both begin block and handler client updates
 	ctx.EventManager().EmitEvent(
 		sdk.NewEvent(
 			types.EventTypeUpdateClient,
 			sdk.NewAttribute(types.AttributeKeyClientID, clientID),
 			sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
 			sdk.NewAttribute(types.AttributeKeyConsensusHeight, consensusHeight.String()),
+			sdk.NewAttribute(types.AttributeKeyHeader, headerStr),
 		),
 	)
 

x/ibc/core/02-client/keeper/client_test.go

@@ -1,6 +1,7 @@
 package keeper_test
 
 import (
+	"encoding/hex"
 	"fmt"
 	"time"
 
@@ -601,3 +602,39 @@ func (suite *KeeperTestSuite) TestCheckMisbehaviourAndUpdateState() {
 		})
 	}
 }
+
+func (suite *KeeperTestSuite) TestUpdateClientEventEmission() {
+	clientID, _ := suite.coordinator.SetupClients(suite.chainA, suite.chainB, exported.Tendermint)
+	header, err := suite.chainA.ConstructUpdateTMClientHeader(suite.chainB, clientID)
+	suite.Require().NoError(err)
+
+	msg, err := clienttypes.NewMsgUpdateClient(
+		clientID, header,
+		suite.chainA.SenderAccount.GetAddress(),
+	)
+
+	result, err := suite.chainA.SendMsgs(msg)
+	suite.Require().NoError(err)
+	// first event type is "message"
+	updateEvent := result.Events[1]
+
+	suite.Require().Equal(clienttypes.EventTypeUpdateClient, updateEvent.Type)
+
+	// use a boolean to ensure the update event contains the header
+	contains := false
+	for _, attr := range updateEvent.Attributes {
+		if string(attr.Key) == clienttypes.AttributeKeyHeader {
+			contains = true
+
+			bz, err := hex.DecodeString(string(attr.Value))
+			suite.Require().NoError(err)
+
+			emittedHeader, err := types.UnmarshalHeader(suite.chainA.App.AppCodec(), bz)
+			suite.Require().NoError(err)
+			suite.Require().Equal(header, emittedHeader)
+		}
+
+	}
+	suite.Require().True(contains)
+
+}

x/ibc/core/02-client/types/encoding.go

@@ -57,7 +57,7 @@ func MustUnmarshalConsensusState(cdc codec.BinaryMarshaler, bz []byte) exported.
 	return consensusState
 }
 
-// MustMarshalConsensusState attempts to encode an ConsensusState object and returns the
+// MustMarshalConsensusState attempts to encode a ConsensusState object and returns the
 // raw encoded bytes. It panics on error.
 func MustMarshalConsensusState(cdc codec.BinaryMarshaler, consensusState exported.ConsensusState) []byte {
 	bz, err := MarshalConsensusState(cdc, consensusState)
@@ -68,12 +68,12 @@ func MustMarshalConsensusState(cdc codec.BinaryMarshaler, consensusState exporte
 	return bz
 }
 
-// MarshalConsensusState protobuf serializes an ConsensusState interface
+// MarshalConsensusState protobuf serializes a ConsensusState interface
 func MarshalConsensusState(cdc codec.BinaryMarshaler, cs exported.ConsensusState) ([]byte, error) {
 	return cdc.MarshalInterface(cs)
 }
 
-// UnmarshalConsensusState returns an ConsensusState interface from raw encoded clientState
+// UnmarshalConsensusState returns a ConsensusState interface from raw encoded consensus state
 // bytes of a Proto-based ConsensusState type. An error is returned upon decoding
 // failure.
 func UnmarshalConsensusState(cdc codec.BinaryMarshaler, bz []byte) (exported.ConsensusState, error) {
@@ -84,3 +84,30 @@ func UnmarshalConsensusState(cdc codec.BinaryMarshaler, bz []byte) (exported.Con
 
 	return consensusState, nil
 }
+
+// MarshalHeader protobuf serializes a Header interface
+func MarshalHeader(cdc codec.BinaryMarshaler, h exported.Header) ([]byte, error) {
+	return cdc.MarshalInterface(h)
+}
+
+// MustMarshalHeader attempts to encode a Header object and returns the
+// raw encoded bytes. It panics on error.
+func MustMarshalHeader(cdc codec.BinaryMarshaler, header exported.Header) []byte {
+	bz, err := MarshalHeader(cdc, header)
+	if err != nil {
+		panic(fmt.Errorf("failed to encode header: %w", err))
+	}
+
+	return bz
+}
+
+// UnmarshalHeader returns a Header interface from raw proto encoded header bytes.
+// An error is returned upon decoding failure.
+func UnmarshalHeader(cdc codec.BinaryMarshaler, bz []byte) (exported.Header, error) {
+	var header exported.Header
+	if err := cdc.UnmarshalInterface(bz, &header); err != nil {
+		return nil, err
+	}
+
+	return header, nil
+}

x/ibc/core/02-client/types/encoding_test.go

@@ -0,0 +1,30 @@
+package types_test
+
+import (
+	"github.com/cosmos/cosmos-sdk/x/ibc/core/02-client/types"
+	ibctmtypes "github.com/cosmos/cosmos-sdk/x/ibc/light-clients/07-tendermint/types"
+)
+
+func (suite *TypesTestSuite) TestMarshalHeader() {
+
+	cdc := suite.chainA.App.AppCodec()
+	h := &ibctmtypes.Header{
+		TrustedHeight: types.NewHeight(4, 100),
+	}
+
+	// marshal header
+	bz, err := types.MarshalHeader(cdc, h)
+	suite.Require().NoError(err)
+
+	// unmarshal header
+	newHeader, err := types.UnmarshalHeader(cdc, bz)
+	suite.Require().NoError(err)
+
+	suite.Require().Equal(h, newHeader)
+
+	// use invalid bytes
+	invalidHeader, err := types.UnmarshalHeader(cdc, []byte("invalid bytes"))
+	suite.Require().Error(err)
+	suite.Require().Nil(invalidHeader)
+
+}

x/ibc/core/02-client/types/events.go

@@ -11,6 +11,7 @@ const (
 	AttributeKeyClientID        = "client_id"
 	AttributeKeyClientType      = "client_type"
 	AttributeKeyConsensusHeight = "consensus_height"
+	AttributeKeyHeader          = "header"
 )
 
 // IBC client events vars

x/ibc/core/spec/06_events.md

@@ -32,6 +32,7 @@ callbacks to IBC applications.
 | update_client | client_id        | {clientId}        |
 | update_client | client_type      | {clientType}      |
 | update_client | consensus_height | {consensusHeight} |
+| update_client | header           | {header}          |
 | message       | action           | update_client     |
 | message       | module           | ibc_client        |
 
@@ -238,4 +239,3 @@ callbacks to IBC applications.
 | message        | action                   | timeout_packet       |
 | message        | module                   | ibc-channel          |
 
-