remove GetClientID from 07-tendermint misbehaviour (#1097)

* remove GetClientID from 07-tendermint misbehaviour and deprecate the ClientId field in 07-tendermint Misbehaviour * add changelog entry Co-authored-by: Damian Nolan <[email protected]>
cosmos · Mar 11, 2022 · daa01db · daa01db
1 parent a333a73
commit daa01db
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### API Breaking
 
+* (07-tendermint) [\#1097](https://github.com/cosmos/ibc-go/pull/1097) Remove `GetClientID` function from 07-tendermint `Misbehaviour` type.
+* (07-tendermint) [\#1097](https://github.com/cosmos/ibc-go/pull/1097) Deprecate `ClientId` field in 07-tendermint `Misbehaviour` type.
 * (channel( [\#848](https://github.com/cosmos/ibc-go/pull/848) Added `ChannelId` to MsgChannelOpenInitResponse
 * (testing( [\#813](https://github.com/cosmos/ibc-go/pull/813) The `ack` argument to the testing function `RelayPacket` has been removed as it is no longer needed.
 * (testing) [\#774](https://github.com/cosmos/ibc-go/pull/774) Added `ChainID` arg to `SetupWithGenesisValSet` on the testing app. `Coordinator` generated ChainIDs now starts at index 1

diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md
@@ -3991,7 +3991,7 @@ that implements Misbehaviour interface expected by ICS-02
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| `client_id` | [string](#string) |  |  |
+| `client_id` | [string](#string) |  | **Deprecated.** ClientID is deprecated |
 | `header_1` | [Header](#ibc.lightclients.tendermint.v1.Header) |  |  |
 | `header_2` | [Header](#ibc.lightclients.tendermint.v1.Header) |  |  |
 

diff --git a/modules/light-clients/07-tendermint/types/misbehaviour.go b/modules/light-clients/07-tendermint/types/misbehaviour.go
@@ -31,11 +31,6 @@ func (misbehaviour Misbehaviour) ClientType() string {
 	return exported.Tendermint
 }
 
-// GetClientID returns the ID of the client that committed a misbehaviour.
-func (misbehaviour Misbehaviour) GetClientID() string {
-	return misbehaviour.ClientId
-}
-
 // GetTime returns the timestamp at which misbehaviour occurred. It uses the
 // maximum value from both headers to prevent producing an invalid header outside
 // of the misbehaviour age range.

diff --git a/modules/light-clients/07-tendermint/types/misbehaviour_test.go b/modules/light-clients/07-tendermint/types/misbehaviour_test.go
@@ -25,7 +25,6 @@ func (suite *TendermintTestSuite) TestMisbehaviour() {
 	}
 
 	suite.Require().Equal(exported.Tendermint, misbehaviour.ClientType())
-	suite.Require().Equal(clientID, misbehaviour.GetClientID())
 }
 
 func (suite *TendermintTestSuite) TestMisbehaviourValidateBasic() {

diff --git a/modules/light-clients/07-tendermint/types/tendermint.pb.go b/modules/light-clients/07-tendermint/types/tendermint.pb.go
diff --git a/proto/ibc/lightclients/tendermint/v1/tendermint.proto b/proto/ibc/lightclients/tendermint/v1/tendermint.proto
@@ -80,7 +80,8 @@ message ConsensusState {
 message Misbehaviour {
   option (gogoproto.goproto_getters) = false;
 
-  string client_id = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
+  // ClientID is deprecated
+  string client_id = 1 [deprecated = true, (gogoproto.moretags) = "yaml:\"client_id\""];
   Header header_1  = 2 [(gogoproto.customname) = "Header1", (gogoproto.moretags) = "yaml:\"header_1\""];
   Header header_2  = 3 [(gogoproto.customname) = "Header2", (gogoproto.moretags) = "yaml:\"header_2\""];
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,6 @@ func (suite *TendermintTestSuite) TestMisbehaviour() { @@
     	}
     	suite.Require().Equal(exported.Tendermint, misbehaviour.ClientType())
-    	suite.Require().Equal(clientID, misbehaviour.GetClientID())
     }
     func (suite *TendermintTestSuite) TestMisbehaviourValidateBasic() {
@@ Expand Down @@