refactor: clean protos for clarity (#1071)

* consumer proto folder

* provider comments, move one msg

* ccv comments

* moved shiz

* proto changes to build

* make proto gen again

* no circ dep

* Update wire.proto

* comments

* dun builds

* progress save

* FIN

* refactors

* rm improper proto ref

* rm todos, issue now

* lint till I die

* update comments, rebuild protos

* change ccv.go to wire.go, and test file

* consistent comment

* Update wire.proto

* example alias diff

app/consumer-democracy/app.go

@@ -112,6 +112,7 @@ import (
 	ccvdistr "github.com/cosmos/interchain-security/v3/x/ccv/democracy/distribution"
 	ccvgov "github.com/cosmos/interchain-security/v3/x/ccv/democracy/governance"
 	ccvstaking "github.com/cosmos/interchain-security/v3/x/ccv/democracy/staking"
+	ccvtypes "github.com/cosmos/interchain-security/v3/x/ccv/types"
 )
 
 const (
@@ -712,7 +713,7 @@ func New(
 				return fromVM, fmt.Errorf("failed to unmarshal genesis state: %w", err)
 			}
 
-			consumerGenesis := consumertypes.GenesisState{}
+			consumerGenesis := ccvtypes.GenesisState{}
 			appCodec.MustUnmarshalJSON(appState[consumertypes.ModuleName], &consumerGenesis)
 
 			consumerGenesis.PreCCV = true

legacy_ibc_testing/testing/app.go

@@ -29,6 +29,7 @@ import (
 	"github.com/cosmos/interchain-security/v3/legacy_ibc_testing/core"
 	"github.com/cosmos/interchain-security/v3/legacy_ibc_testing/simapp"
 	consumertypes "github.com/cosmos/interchain-security/v3/x/ccv/consumer/types"
+	ccvtypes "github.com/cosmos/interchain-security/v3/x/ccv/types"
 )
 
 /*
@@ -111,7 +112,7 @@ func SetupWithGenesisValSet(t *testing.T, appIniter AppIniter, valSet *tmtypes.V
 	// set validators and delegations
 	var (
 		stakingGenesis  stakingtypes.GenesisState
-		consumerGenesis consumertypes.GenesisState
+		consumerGenesis ccvtypes.GenesisState
 		bondDenom       string
 	)
 	if genesisState[stakingtypes.ModuleName] != nil {

proto/interchain_security/ccv/consumer/v1/consumer.proto

@@ -1,7 +1,7 @@
 syntax = "proto3";
 package interchain_security.ccv.consumer.v1;
 
-import "interchain_security/ccv/v1/ccv.proto";
+import "interchain_security/ccv/v1/wire.proto";
 
 option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/consumer/types";
 
@@ -11,68 +11,17 @@ import "cosmos_proto/cosmos.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 
-// Params defines the parameters for CCV consumer module
-message Params {
-  // TODO: Remove enabled flag and find a better way to setup integration tests
-  // See: https://github.com/cosmos/interchain-security/issues/339
-  bool enabled = 1;
-
-  ///////////////////////
-  // Distribution Params
-  // Number of blocks between ibc-token-transfers from the consumer chain to
-  // the provider chain. Note that at this transmission event a fraction of
-  // the accumulated tokens are divided and sent consumer redistribution
-  // address.
-  int64 blocks_per_distribution_transmission = 2;
-
-  // Channel, and provider-chain receiving address to send distribution token
-  // transfers over. These parameters is auto-set during the consumer <->
-  // provider handshake procedure.
-  string distribution_transmission_channel = 3;
-  string provider_fee_pool_addr_str = 4;
-  // Sent CCV related IBC packets will timeout after this duration
-  google.protobuf.Duration ccv_timeout_period = 5
-      [ (gogoproto.nullable) = false, (gogoproto.stdduration) = true ];
-
-  // Sent transfer related IBC packets will timeout after this duration
-  google.protobuf.Duration transfer_timeout_period = 6
-      [ (gogoproto.nullable) = false, (gogoproto.stdduration) = true ];
-
-  // The fraction of tokens allocated to the consumer redistribution address
-  // during distribution events. The fraction is a string representing a
-  // decimal number. For example "0.75" would represent 75%.
-  string consumer_redistribution_fraction = 7;
-
-  // The number of historical info entries to persist in store.
-  // This param is a part of the cosmos sdk staking module. In the case of
-  // a ccv enabled consumer chain, the ccv module acts as the staking module.
-  int64 historical_entries = 8;
-
-  // Unbonding period for the consumer,
-  // which should be smaller than that of the provider in general.
-  google.protobuf.Duration unbonding_period = 9
-      [ (gogoproto.nullable) = false, (gogoproto.stdduration) = true ];
-
-  // The threshold for the percentage of validators at the bottom of the set who
-  // can opt out of running the consumer chain without being punished. For
-  // example, a value of 0.05 means that the validators in the bottom 5% of the
-  // set can opt out
-  string soft_opt_out_threshold = 10;
-
-  // Reward denoms. These are the denominations which are allowed to be sent to
-  // the provider as rewards.
-  repeated string reward_denoms = 11;
-
-  // Provider-originated reward denoms. These are denoms coming from the
-  // provider which are allowed to be used as rewards. e.g. "uatom"
-  repeated string provider_reward_denoms = 12;
-}
-
-// LastTransmissionBlockHeight is the last time validator holding
-// pools were transmitted to the provider chain
-message LastTransmissionBlockHeight { int64 height = 1; }
-
-// CrossChainValidator defines the validators for CCV consumer module
+//
+// Note any type defined in this file is ONLY used internally to the consumer CCV module.
+// These schemas can change with proper consideration of compatibility or migration. 
+// 
+
+// CrossChainValidator defines the type used to store validator information internal 
+// to the consumer CCV module.  Note one cross chain validator entry is persisted for
+// each consumer validator, where incoming VSC packets update this data, which is eventually
+// forwarded to comet for consumer chain consensus. 
+//
+// Note this type is only used internally to the consumer CCV module. 
 message CrossChainValidator {
   bytes address = 1;
   int64 power = 2;
@@ -83,17 +32,12 @@ message CrossChainValidator {
   ];
 }
 
-// MaturingVSCPacket contains the maturing time of a received VSCPacket
-message MaturingVSCPacket {
-  uint64 vscId = 1;
-  google.protobuf.Timestamp maturity_time = 2
-      [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];
-}
-
 // A record storing the state of a slash packet sent to the provider chain
 // which may bounce back and forth until handled by the provider.
+// 
+// Note this type is only used internally to the consumer CCV module. 
 message SlashRecord {
   bool waiting_on_reply = 1;
   google.protobuf.Timestamp send_time = 2
       [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];
-}
+}

proto/interchain_security/ccv/consumer/v1/query.proto

@@ -1,6 +1,7 @@
 syntax = "proto3";
 
 package interchain_security.ccv.consumer.v1;
+import "interchain_security/ccv/v1/shared_consumer.proto";
 option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/consumer/types";
 
 import "gogoproto/gogo.proto";
@@ -54,7 +55,7 @@ message QueryParamsRequest {}
 // QueryParamsResponse is response type for the Query/Params RPC method.
 message QueryParamsResponse {
   // params holds all the parameters of this module.
-  Params params = 1 [ (gogoproto.nullable) = false ];
+  interchain_security.ccv.v1.Params params = 1 [ (gogoproto.nullable) = false ];
 }
 
 message QueryProviderInfoRequest {}

proto/interchain_security/ccv/provider/v1/genesis.proto

@@ -5,10 +5,9 @@ package interchain_security.ccv.provider.v1;
 option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/provider/types";
 
 import "gogoproto/gogo.proto";
-import "interchain_security/ccv/v1/ccv.proto";
+import "interchain_security/ccv/v1/shared_consumer.proto";
+import "interchain_security/ccv/v1/wire.proto";
 import "interchain_security/ccv/provider/v1/provider.proto";
-import "interchain_security/ccv/consumer/v1/consumer.proto";
-import "interchain_security/ccv/consumer/v1/genesis.proto";
 import "tendermint/crypto/keys.proto";
 
 // GenesisState defines the CCV provider chain genesis state
@@ -24,7 +23,7 @@ message GenesisState {
   repeated interchain_security.ccv.provider.v1.UnbondingOp unbonding_ops = 3
       [ (gogoproto.nullable) = false ];
   // empty for a new chain
-  interchain_security.ccv.v1.MaturedUnbondingOps mature_unbonding_ops = 4;
+  interchain_security.ccv.provider.v1.MaturedUnbondingOps mature_unbonding_ops = 4;
   // empty for a new chain
   repeated ValsetUpdateIdToHeight valset_update_id_to_height = 5
       [ (gogoproto.nullable) = false ];
@@ -52,7 +51,9 @@ message GenesisState {
       [ (gogoproto.nullable) = false ];
 }
 
-// consumer chain
+// The provider CCV module's knowledge of consumer state. 
+//
+// Note this type is only used internally to the provider CCV module.
 message ConsumerState {
   // ChainID defines the chain ID for the consumer chain
   string chain_id = 1;
@@ -63,7 +64,7 @@ message ConsumerState {
   // InitalHeight defines the initial block height for the consumer chain
   uint64 initial_height = 4;
   // ConsumerGenesis defines the initial consumer chain genesis states
-  interchain_security.ccv.consumer.v1.GenesisState consumer_genesis = 5
+  interchain_security.ccv.v1.GenesisState consumer_genesis = 5
       [ (gogoproto.nullable) = false ];
   // PendingValsetChanges defines the pending validator set changes for the
   // consumer chain

proto/interchain_security/ccv/provider/v1/provider.proto

@@ -4,6 +4,8 @@ package interchain_security.ccv.provider.v1;
 
 option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/provider/types";
 
+import "interchain_security/ccv/v1/shared_consumer.proto";
+import "interchain_security/ccv/v1/wire.proto";
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
 import "google/protobuf/duration.proto";
@@ -13,6 +15,11 @@ import "tendermint/crypto/keys.proto";
 import "cosmos/evidence/v1beta1/evidence.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
+//
+// Note any type defined in this file is ONLY used internally to the provider CCV module.
+// These schemas can change with proper consideration of compatibility or migration. 
+// 
+
 // ConsumerAdditionProposal is a governance proposal on the provider chain to
 // spawn a new consumer chain. If it passes, then all validators on the provider
 // chain are expected to validate the consumer chain at spawn time or get
@@ -96,6 +103,10 @@ message ConsumerRemovalProposal {
       [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];
 }
 
+// EquivocationProposal is a governance proposal on the provider chain to
+// punish a validator for equivocation on a consumer chain.
+// 
+// This type is only used internally to the consumer CCV module.  
 message EquivocationProposal {
   // the title of the proposal
   string title = 1;
@@ -164,13 +175,8 @@ message Params {
       [ (gogoproto.nullable) = false ];
 }
 
-message HandshakeMetadata {
-  string provider_fee_pool_addr = 1;
-  string version = 2;
-}
-
 // SlashAcks contains cons addresses of consumer chain validators
-// successfully slashed on the provider chain
+// successfully slashed on the provider chain. 
 message SlashAcks { repeated string addresses = 1; }
 
 // ConsumerAdditionProposals holds pending governance proposals on the provider
@@ -221,6 +227,16 @@ message VscSendTimestamp {
       [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];
 }
 
+// ValidatorSetChangePackets is a pb list of ccv.ValidatorSetChangePacketData.
+message ValidatorSetChangePackets {
+  repeated interchain_security.ccv.v1.ValidatorSetChangePacketData list = 1
+      [ (gogoproto.nullable) = false ];
+}
+
+// MaturedUnbondingOps defines a list of ids corresponding to ids of matured
+// unbonding operations.
+message MaturedUnbondingOps { repeated uint64 ids = 1; }
+
 // ExportedVscSendTimestamps is VscSendTimestamp with chainID info for exporting to genesis
 message ExportedVscSendTimestamp {
   string chain_id = 1;

proto/interchain_security/ccv/provider/v1/query.proto

@@ -6,9 +6,9 @@ option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/provider/typ
 import "google/api/annotations.proto";
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
-import "interchain_security/ccv/v1/ccv.proto";
-import "interchain_security/ccv/consumer/v1/genesis.proto";
 import "interchain_security/ccv/provider/v1/provider.proto";
+import "interchain_security/ccv/v1/shared_consumer.proto";
+import "interchain_security/ccv/v1/wire.proto";
 
 service Query {
   // ConsumerGenesis queries the genesis state needed to start a consumer chain
@@ -86,7 +86,7 @@ service Query {
 message QueryConsumerGenesisRequest { string chain_id = 1; }
 
 message QueryConsumerGenesisResponse {
-  interchain_security.ccv.consumer.v1.GenesisState genesis_state = 1
+  interchain_security.ccv.v1.GenesisState genesis_state = 1
       [ (gogoproto.nullable) = false ];
 }