Add example to proto definition of max_rank

cosmos · Jul 25, 2024 · 22bfde8 · 22bfde8
1 parent 264b642
commit 22bfde8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/proto/interchain_security/ccv/provider/v1/provider.proto b/proto/interchain_security/ccv/provider/v1/provider.proto
@@ -109,6 +109,8 @@ message ConsumerAdditionProposal {
   // Corresponds to the minimal amount of (provider chain) stake required to validate on the consumer chain.
   uint64 min_stake = 20;
   // Corresponds to the maximal rank in the provider chain validator set that a validator can have to validate on the consumer chain.
+  // For example, setting this to 10 means only the
+  // 10 validators with the most stake can validate the consumer chain.
   uint32 max_rank = 21;
   // Corresponds to whether inactive validators are allowed to validate the consumer chain.
   bool allow_inactive_vals = 22;
@@ -165,6 +167,8 @@ message ConsumerModificationProposal {
   // Corresponds to the minimal amount of (provider chain) stake required to validate on the consumer chain.
   uint64 min_stake = 9;
   // Corresponds to the maximal rank in the provider chain validator set that a validator can have to validate on the consumer chain.
+  // For example, setting this to 10 means only the
+  // 10 validators with the most stake can validate the consumer chain.
   uint32 max_rank = 10;
   // Corresponds to whether inactive validators are allowed to validate the consumer chain.
   bool allow_inactive_vals = 11;

diff --git a/proto/interchain_security/ccv/provider/v1/tx.proto b/proto/interchain_security/ccv/provider/v1/tx.proto
@@ -186,6 +186,8 @@ message MsgConsumerAddition {
   // Corresponds to the minimal amount of (provider chain) stake required to validate on the consumer chain.
   uint64 min_stake = 19;
   // Corresponds to the maximal rank in the provider chain validator set that a validator can have to validate on the consumer chain.
+  // For example, setting this to 10 means only the
+  // 10 validators with the most stake can validate the consumer chain.
   uint32 max_rank = 20;
   // Corresponds to whether inactive validators are allowed to validate the consumer chain.
   bool allow_inactive_vals = 21;
@@ -328,6 +330,8 @@ message MsgConsumerModification {
   // Corresponds to the minimal amount of (provider chain) stake required to validate on the consumer chain.
   uint64 min_stake = 10;
   // Corresponds to the maximal rank in the provider chain validator set that a validator can have to validate on the consumer chain.
+  // For example, setting this to 10 means only the
+  // 10 validators with the most stake can validate the consumer chain.
   uint32 max_rank = 11;
   // Corresponds to whether inactive validators are allowed to validate the consumer chain.
   bool allow_inactive_vals = 12;