Abstract Height in IBC Clients

go.sum

@@ -545,6 +545,7 @@ github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15 h1:hqAk8riJvK4RM
 github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15/go.mod h1:z4YtwM70uOnk8h0pjJYlj3zdYwi9l03By6iAIF5j/Pk=
 github.com/tendermint/go-amino v0.15.1 h1:D2uk35eT4iTsvJd9jWIetzthE5C0/k2QmMFkCN+4JgQ=
 github.com/tendermint/go-amino v0.15.1/go.mod h1:TQU0M1i/ImAo+tYpZi73AU3V/dKeCoMC9Sphe2ZwGME=
+github.com/tendermint/tendermint v0.33.8 h1:Xxu4QhpqcomSE0iQDw1MqLgfsa8fqtPtWFJK6zZOVso=
 github.com/tendermint/tendermint v0.34.0-rc3 h1:d7Fsd5rdbxq4GmJ0kRfx7l7LesQM7e70f0ytWLTQ/Go=
 github.com/tendermint/tendermint v0.34.0-rc3/go.mod h1:BoHcEpjfpBHc1Be7RQz3AHaXFNObcDG7SNHCev6Or4g=
 github.com/tendermint/tm-db v0.6.1 h1:w3X87itMPXopcRPlFiqspEKhw4FXihPk2rnFFkP0zGk=

proto/ibc/channel/channel.proto

@@ -4,6 +4,7 @@ package ibc.channel;
 option go_package = "github.com/cosmos/cosmos-sdk/x/ibc/04-channel/types";
 
 import "gogoproto/gogo.proto";
+import "ibc/client/client.proto";
 
 // MsgChannelOpenInit defines an sdk.Msg to initialize a channel handshake. It
 // is called by a relayer on Chain A.
@@ -24,7 +25,7 @@ message MsgChannelOpenTry {
   string  counterparty_version = 4
       [(gogoproto.moretags) = "yaml:\"counterparty_version\""];
   bytes  proof_init   = 5 [(gogoproto.moretags) = "yaml:\"proof_init\""];
-  uint64 proof_height = 6 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 6 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer       = 7
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -37,7 +38,7 @@ message MsgChannelOpenAck {
   string counterparty_version = 3
       [(gogoproto.moretags) = "yaml:\"counterparty_version\""];
   bytes  proof_try    = 4 [(gogoproto.moretags) = "yaml:\"proof_try\""];
-  uint64 proof_height = 5 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 5 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer       = 6
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -48,7 +49,7 @@ message MsgChannelOpenConfirm {
   string port_id      = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
   string channel_id   = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
   bytes  proof_ack    = 3 [(gogoproto.moretags) = "yaml:\"proof_ack\""];
-  uint64 proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer       = 5
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -68,7 +69,7 @@ message MsgChannelCloseConfirm {
   string port_id      = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
   string channel_id   = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
   bytes  proof_init   = 3 [(gogoproto.moretags) = "yaml:\"proof_init\""];
-  uint64 proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer       = 5
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -77,7 +78,7 @@ message MsgChannelCloseConfirm {
 message MsgRecvPacket {
   Packet packet       = 1 [(gogoproto.nullable) = false];
   bytes  proof        = 2;
-  uint64 proof_height = 3 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 3 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer       = 4
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -86,7 +87,7 @@ message MsgRecvPacket {
 message MsgTimeout {
   Packet packet       = 1 [(gogoproto.nullable) = false];
   bytes  proof        = 2;
-  uint64 proof_height = 3 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 3 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   uint64 next_sequence_recv = 4
       [(gogoproto.moretags) = "yaml:\"next_sequence_recv\""];
   bytes signer = 5
@@ -98,7 +99,7 @@ message MsgTimeoutOnClose {
   Packet packet       = 1 [(gogoproto.nullable) = false];
   bytes  proof        = 2;
   bytes  proof_close  = 3 [(gogoproto.moretags) = "yaml:\"proof_close\""];
-  uint64 proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   uint64 next_sequence_recv = 5
       [(gogoproto.moretags) = "yaml:\"next_sequence_recv\""];
   bytes signer = 6
@@ -110,7 +111,7 @@ message MsgAcknowledgement {
   Packet packet          = 1 [(gogoproto.nullable) = false];
   bytes  acknowledgement = 2;
   bytes  proof           = 3;
-  uint64 proof_height    = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height    = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   bytes  signer          = 5
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
@@ -222,10 +223,9 @@ message Packet {
   // actual opaque bytes transferred directly to the application module
   bytes data = 6;
   // block height after which the packet times out
-  uint64 timeout_height = 7 [(gogoproto.moretags) = "yaml:\"timeout_height\""];
+  ibc.client.Height timeout_height = 7 [(gogoproto.moretags) = "yaml:\"timeout_height\""];
   // block timestamp (in nanoseconds) after which the packet times out
-  uint64 timeout_timestamp = 8
-      [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
+  uint64 timeout_timestamp = 8 [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
 }
 
 // PacketAckCommitment defines the genesis type necessary to retrieve and store

proto/ibc/channel/query.proto

@@ -39,7 +39,7 @@ service Query {
   // associated with the provided channel identifiers.
   rpc ChannelConsensusState(QueryChannelConsensusStateRequest)
     returns (QueryChannelConsensusStateResponse) {
-      option (google.api.http).get = "/ibc/channel/v1beta1/channels/{channel_id}/ports/{port_id}/consensus_state/{height}";
+      option (google.api.http).get = "/ibc/channel/v1beta1/channels/{channel_id}/ports/{port_id}/consensus_state/epoch/{epoch_number}/height/{epoch_height}";
   }
 
   // PacketCommitment queries a stored packet commitment hash.
@@ -94,7 +94,7 @@ message QueryChannelResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryChannelsRequest is the request type for the Query/Channels RPC method
@@ -152,7 +152,7 @@ message QueryChannelClientStateResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryChannelConsensusStateRequest is the request type for the
@@ -162,8 +162,10 @@ message QueryChannelConsensusStateRequest {
   string port_id = 1;
   // channel unique identifier
   string channel_id = 2;
+  // epoch of the consensus state
+  uint64 epoch_number = 3;
   // height of the consensus state
-  uint64 height = 3;
+  uint64 epoch_height = 4;
 }
 
 // QueryChannelClientStateResponse is the Response type for the
@@ -178,7 +180,7 @@ message QueryChannelConsensusStateResponse {
   // merkle proof path
   string proof_path = 4;
   // height at which the proof was retrieved
-  uint64 proof_height = 5;
+  ibc.client.Height proof_height = 5;
 }
 
 // QueryPacketCommitmentRequest is the request type for the
@@ -203,7 +205,7 @@ message QueryPacketCommitmentResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryPacketCommitmentsRequest is the request type for the
@@ -249,7 +251,7 @@ message QueryPacketAcknowledgementResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryUnrelayedPacketsRequest is the request type for the
@@ -294,6 +296,6 @@ message QueryNextSequenceReceiveResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 

proto/ibc/client/client.proto

@@ -21,3 +21,18 @@ message ClientConsensusStates {
   // consensus states associated with the client
   repeated google.protobuf.Any consensus_states = 2 [(gogoproto.moretags) = "yaml:\"consensus_states\""];
 }
+
+// Height is a monotonically increasing data type
+// that can be compared against another Height for the purposes of updating and freezing clients
+//
+// Normally the EpochHeight is incremented at each height while keeping epoch number the same
+// However some consensus algorithms may choose to reset the height in certain conditions
+// e.g. hard forks, state-machine breaking changes
+// In these cases, the epoch number is incremented so that height continues to be monitonically increasing
+// even as the EpochHeight gets reset
+message Height {
+  // the epoch that the client is currently on
+  uint64 epoch_number = 1 [(gogoproto.moretags) = "yaml:\"epoch_number\""];
+  // the height within the given epoch
+  uint64 epoch_height = 2 [(gogoproto.moretags) = "yaml:\"epoch_height\""];
+}

proto/ibc/client/query.proto

@@ -22,7 +22,7 @@ service Query {
 
   // ConsensusState queries a consensus state associated with a client state at a given height.
   rpc ConsensusState(QueryConsensusStateRequest) returns (QueryConsensusStateResponse) {
-    option (google.api.http).get = "/ibc/client/v1beta1/consensus_states/{client_id}/{height}";
+    option (google.api.http).get = "/ibc/client/v1beta1/consensus_states/{client_id}/epoch/{epoch_number}/height/{epoch_height}";
   }
 
   // ConsensusStates queries all the consensus state associated with a given client.
@@ -49,7 +49,7 @@ message QueryClientStateResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  Height proof_height = 4;
 }
 
 // QueryClientStatesRequest is the request type for the Query/ClientStates RPC
@@ -73,10 +73,12 @@ message QueryClientStatesResponse {
 message QueryConsensusStateRequest {
   // client identifier
   string client_id = 1;
-  // consensus state height
-  uint64 height = 2;
+  // consensus state epoch-number
+  uint64 epoch_number = 2;
+  // consensus state epoch-height
+  uint64 epoch_height = 3;
   // latest_height overrrides the height field and queries the latest stored ConsensusState
-  bool latest_height = 3;
+  bool latest_height = 4;
 }
 
 // QueryConsensusStateResponse is the response type for the Query/ConsensusState RPC method
@@ -88,7 +90,7 @@ message QueryConsensusStateResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  Height proof_height = 4;
 }
 
 // QueryConsensusStatesRequest is the request type for the Query/ConsensusStates RPC method.

proto/ibc/connection/connection.proto

@@ -5,6 +5,7 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/ibc/03-connection/types";
 
 import "gogoproto/gogo.proto";
 import "google/protobuf/any.proto";
+import "ibc/client/client.proto";
 import "ibc/commitment/commitment.proto";
 
 // MsgConnectionOpenInit defines the msg sent by an account on Chain A to
@@ -36,15 +37,15 @@ message MsgConnectionOpenTry {
   Counterparty counterparty = 4 [(gogoproto.nullable) = false];
   repeated string counterparty_versions = 5
       [(gogoproto.moretags) = "yaml:\"counterparty_versions\""];
-  uint64 proof_height = 6 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 6 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   // proof of the initialization the connection on Chain A: `UNITIALIZED ->
   // INIT`
   bytes proof_init = 7 [(gogoproto.moretags) = "yaml:\"proof_init\""];
   // proof of client state included in message
   bytes proof_client = 8 [(gogoproto.moretags) = "yaml:\"proof_client\""];
   // proof of client consensus state
   bytes proof_consensus = 9 [(gogoproto.moretags) = "yaml:\"proof_consensus\""];
-  uint64 consensus_height = 10
+  ibc.client.Height consensus_height = 10
       [(gogoproto.moretags) = "yaml:\"consensus_height\""];
   bytes signer = 11
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
@@ -60,15 +61,15 @@ message MsgConnectionOpenAck {
   google.protobuf.Any client_state = 3 [
     (gogoproto.moretags) = "yaml:\"client_state\""
   ];
-  uint64 proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  ibc.client.Height proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
   // proof of the initialization the connection on Chain B: `UNITIALIZED ->
   // TRYOPEN`
   bytes proof_try = 5 [(gogoproto.moretags) = "yaml:\"proof_try\""];
   // proof of client state included in message
   bytes proof_client = 6 [(gogoproto.moretags) = "yaml:\"proof_client\""];
   // proof of client consensus state
   bytes proof_consensus = 7 [(gogoproto.moretags) = "yaml:\"proof_consensus\""];
-  uint64 consensus_height = 8
+  ibc.client.Height consensus_height = 8
       [(gogoproto.moretags) = "yaml:\"consensus_height\""];
   bytes signer = 9
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
@@ -82,8 +83,8 @@ message MsgConnectionOpenConfirm {
   ];
   // proof for the change of the connection state on Chain A: `INIT -> OPEN`
   bytes proof_ack = 2 [(gogoproto.moretags) = "yaml:\"proof_ack\""];
-  uint64 proof_height = 3 [(gogoproto.moretags) = "yaml:\"proof_height\""];
-  bytes signer = 4
+  ibc.client.Height proof_height = 4 [(gogoproto.moretags) = "yaml:\"proof_height\""];
+  bytes signer = 5
       [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
 }
 

proto/ibc/connection/query.proto

@@ -62,7 +62,7 @@ message QueryConnectionResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryConnectionsRequest is the request type for the Query/Connections RPC
@@ -99,7 +99,7 @@ message QueryClientConnectionsResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was generated
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryConnectionClientStateRequest is the request type for the
@@ -121,7 +121,7 @@ message QueryConnectionClientStateResponse {
   // merkle proof path
   string proof_path = 3;
   // height at which the proof was retrieved
-  uint64 proof_height = 4;
+  ibc.client.Height proof_height = 4;
 }
 
 // QueryConnectionConsensusStateRequest is the request type for the
@@ -146,5 +146,5 @@ message QueryConnectionConsensusStateResponse {
   // merkle proof path
   string proof_path = 4;
   // height at which the proof was retrieved
-  uint64 proof_height = 5;
+  ibc.client.Height proof_height = 5;
 }

proto/ibc/tendermint/tendermint.proto

@@ -8,6 +8,7 @@ import "tendermint/types/types.proto";
 import "confio/proofs.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "ibc/client/client.proto";
 import "ibc/commitment/commitment.proto";
 import "gogoproto/gogo.proto";
 
@@ -41,9 +42,9 @@ message ClientState {
     (gogoproto.moretags)    = "yaml:\"max_clock_drift\""
   ];
   // Block height when the client was frozen due to a misbehaviour
-  uint64 frozen_height = 6 [(gogoproto.moretags) = "yaml:\"frozen_height\""];
+  ibc.client.Height frozen_height = 6 [(gogoproto.moretags) = "yaml:\"frozen_height\""];
   // Latest height the client was updated to
-  uint64 latest_height = 7 [(gogoproto.moretags) = "yaml:\"latest_height\""];
+  ibc.client.Height latest_height = 7 [(gogoproto.moretags) = "yaml:\"latest_height\""];
   // Proof specifications used in verifying counterparty state
   repeated ics23.ProofSpec proof_specs = 8
       [(gogoproto.moretags) = "yaml:\"proof_specs\""];
@@ -60,7 +61,7 @@ message ConsensusState {
   // commitment root (i.e app hash)
   ibc.commitment.MerkleRoot root = 2 [(gogoproto.nullable) = false];
   // height at which the consensus state was stored.
-  uint64 height               = 3;
+  ibc.client.Height height               = 3;
   bytes  next_validators_hash = 4 [
     (gogoproto.casttype) =
         "github.com/tendermint/tendermint/libs/bytes.HexBytes",
@@ -106,7 +107,7 @@ message Header {
 
   .tendermint.types.ValidatorSet validator_set = 2
       [(gogoproto.moretags) = "yaml:\"validator_set\""];
-  uint64 trusted_height = 3 [(gogoproto.moretags) = "yaml:\"trusted_height\""];
+  ibc.client.Height trusted_height = 3 [(gogoproto.moretags) = "yaml:\"trusted_height\""];
   .tendermint.types.ValidatorSet trusted_validators = 4
       [(gogoproto.moretags) = "yaml:\"trusted_validators\""];
 }

proto/ibc/transfer/transfer.proto

@@ -5,6 +5,7 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/ibc-transfer/types";
 
 import "gogoproto/gogo.proto";
 import "cosmos/base/v1beta1/coin.proto";
+import "ibc/client/client.proto";
 
 // MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between
 // ICS20 enabled chains. See ICS Spec here:
@@ -22,10 +23,10 @@ message MsgTransfer {
   string receiver = 5;
   // Timeout height relative to the current block height.
   // The timeout is disabled when set to 0.
-  uint64 timeout_height = 6 [(gogoproto.moretags) = "yaml:\"timeout_height\""];
+  ibc.client.Height timeout_height = 7 [(gogoproto.moretags) = "yaml:\"timeout_height\""];
   // Timeout timestamp (in nanoseconds) relative to the current block timestamp.
   // The timeout is disabled when set to 0.
-  uint64 timeout_timestamp = 7 [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
+  uint64 timeout_timestamp = 8 [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
 }
 
 // FungibleTokenPacketData defines a struct for the packet payload