comments

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

@@ -10,6 +10,12 @@ import "gogoproto/gogo.proto";
 import "cosmos_proto/cosmos.proto";
 import "google/protobuf/duration.proto";
 
+
+//
+// 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

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

@@ -11,6 +11,8 @@ import "interchain_security/ccv/provider/v1/provider.proto";
 import "tendermint/crypto/keys.proto";
 
 // GenesisState defines the CCV provider chain genesis state
+// 
+// TODO: Change to ProviderGenesisState for consistency with consumer, or create issue for this.
 message GenesisState {
   // strictly positive and set to 1 (DefaultValsetUpdateID) for a new chain
   uint64 valset_update_id = 1;

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

@@ -15,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
@@ -141,6 +146,8 @@ message GlobalSlashEntry {
 // Params defines the parameters for CCV Provider module
 // 
 // Note this type is only used internally to the provider CCV module. 
+//
+// TODO: change to ProviderParams for consistency with consumer, or create issue for this.
 message Params {
   ibc.lightclients.tendermint.v1.ClientState template_client = 1;
   // TrustingPeriodFraction is used to compute the consumer and provider IBC

proto/interchain_security/ccv/v1/shared_consumer.proto

@@ -17,7 +17,7 @@ import "google/protobuf/timestamp.proto";
 // but not sent over the wire. These schemas could change, only with careful consideration of effects!
 //
 
-// TODO: rename to ConsumerParams (make issue)
+// TODO: rename to ConsumerParams (or make issue)
 // 
 // Params defines the parameters for CCV consumer module.
 //