took into account comments

cosmos · May 17, 2024 · bda4936 · bda4936
1 parent 135cf0e
commit bda4936
Show file tree

Hide file tree

Showing 6 changed files with 259 additions and 261 deletions.
diff --git a/proto/interchain_security/ccv/provider/v1/query.proto b/proto/interchain_security/ccv/provider/v1/query.proto
@@ -135,9 +135,11 @@ service Query {
       "/interchain_security/ccv/provider/oldest_unconfirmed_vsc/{chain_id}";
     }
 
-  // QueryConsumerChainConsumerValidators returns the latest set consumer-validator set for a given chainID
-  rpc QueryConsumerChainConsumerValidators(QueryConsumerChainConsumerValidatorsRequest)
-      returns (QueryConsumerChainConsumerValidatorsResponse) {
+  // QueryConsumerValidators returns the latest set consumer-validator set for a given chainID
+  // Note that this does not necessarily mean that the consumer chain is using this validator set at this exact moment
+  // because a VSCPacket could be delayed to be delivered on the consumer chain.
+  rpc QueryConsumerValidators(QueryConsumerValidatorsRequest)
+      returns (QueryConsumerValidatorsResponse) {
         option (google.api.http).get =
             "/interchain_security/ccv/provider/consumer_validators/{chain_id}";
   }
@@ -278,11 +280,11 @@ message QueryConsumerChainOptedInValidatorsResponse {
   repeated string validators_provider_addresses = 1;
 }
 
-message QueryConsumerChainConsumerValidatorsRequest {
+message QueryConsumerValidatorsRequest {
   string chain_id = 1;
 }
 
-message QueryConsumerChainConsumerValidator {
+message QueryConsumerValidatorsValidator {
   // The consensus address of the validator on the provider chain
   string provider_address = 1 [ (gogoproto.moretags) = "yaml:\"address\"" ];
   // The consumer public key of the validator used on the consumer chain
@@ -291,8 +293,8 @@ message QueryConsumerChainConsumerValidator {
   int64 power = 3;
 }
 
-message QueryConsumerChainConsumerValidatorsResponse {
-  repeated QueryConsumerChainConsumerValidator validators = 1;
+message QueryConsumerValidatorsResponse {
+  repeated QueryConsumerValidatorsValidator validators = 1;
 }
 
 message QueryConsumerChainsValidatorHasToValidateRequest {

diff --git a/x/ccv/provider/client/cli/query.go b/x/ccv/provider/client/cli/query.go
@@ -36,7 +36,7 @@ func NewQueryCmd() *cobra.Command {
 	cmd.AddCommand(CmdAllPairsValConAddrByConsumerChainID())
 	cmd.AddCommand(CmdProviderParameters())
 	cmd.AddCommand(CmdConsumerChainOptedInValidators())
-	cmd.AddCommand(CmdConsumerChainConsumerValidators())
+	cmd.AddCommand(CmdConsumerValidators())
 	cmd.AddCommand(CmdConsumerChainsValidatorHasToValidate())
 	cmd.AddCommand(CmdValidatorConsumerCommissionRate())
 	cmd.AddCommand(CmdOldestUnconfirmedVsc())
@@ -450,7 +450,7 @@ $ %s consumer-opted-in-validators foochain
 }
 
 // Command to query the consumer validators by consumer chain ID
-func CmdConsumerChainConsumerValidators() *cobra.Command {
+func CmdConsumerValidators() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "consumer-validators [chainid]",
 		Short: "Query the last set consumer-validator set for a given consumer chain",
@@ -469,8 +469,8 @@ $ %s consumer-validators foochain
 			}
 			queryClient := types.NewQueryClient(clientCtx)
 
-			res, err := queryClient.QueryConsumerChainConsumerValidators(cmd.Context(),
-				&types.QueryConsumerChainConsumerValidatorsRequest{ChainId: args[0]})
+			res, err := queryClient.QueryConsumerValidators(cmd.Context(),
+				&types.QueryConsumerValidatorsRequest{ChainId: args[0]})
 			if err != nil {
 				return err
 			}

diff --git a/x/ccv/provider/keeper/grpc_query.go b/x/ccv/provider/keeper/grpc_query.go
@@ -252,8 +252,8 @@ func (k Keeper) QueryConsumerChainOptedInValidators(goCtx context.Context, req *
 	}, nil
 }
 
-// QueryConsumerChainConsumerValidators returns all validators that are consumer validators in a given consumer chain
-func (k Keeper) QueryConsumerChainConsumerValidators(goCtx context.Context, req *types.QueryConsumerChainConsumerValidatorsRequest) (*types.QueryConsumerChainConsumerValidatorsResponse, error) {
+// QueryConsumerValidators returns all validators that are consumer validators in a given consumer chain
+func (k Keeper) QueryConsumerValidators(goCtx context.Context, req *types.QueryConsumerValidatorsRequest) (*types.QueryConsumerValidatorsResponse, error) {
 	if req == nil {
 		return nil, status.Error(codes.InvalidArgument, "empty request")
 	}
@@ -270,16 +270,16 @@ func (k Keeper) QueryConsumerChainConsumerValidators(goCtx context.Context, req
 		return nil, status.Error(codes.InvalidArgument, fmt.Sprintf("no started consumer chain: %s", consumerChainID))
 	}
 
-	var validators []*types.QueryConsumerChainConsumerValidator
+	var validators []*types.QueryConsumerValidatorsValidator
 	for _, v := range k.GetConsumerValSet(ctx, consumerChainID) {
-		validators = append(validators, &types.QueryConsumerChainConsumerValidator{
+		validators = append(validators, &types.QueryConsumerValidatorsValidator{
 			ProviderAddress: sdk.ConsAddress(v.ProviderConsAddr).String(),
 			ConsumerKey:     v.ConsumerPublicKey,
 			Power:           v.Power,
 		})
 	}
 
-	return &types.QueryConsumerChainConsumerValidatorsResponse{
+	return &types.QueryConsumerValidatorsResponse{
 		Validators: validators,
 	}, nil
 }

diff --git a/x/ccv/provider/keeper/grpc_query_test.go b/x/ccv/provider/keeper/grpc_query_test.go
@@ -135,18 +135,18 @@ func TestQueryConsumerChainOptedInValidators(t *testing.T) {
 	require.Equal(t, &expectedResponse, res)
 }
 
-func TestQueryConsumerChainConsumerValidators(t *testing.T) {
+func TestQueryConsumerValidators(t *testing.T) {
 	chainID := "chainID"
 
 	pk, ctx, ctrl, _ := testkeeper.GetProviderKeeperAndCtx(t, testkeeper.NewInMemKeeperParams(t))
 	defer ctrl.Finish()
 
-	req := types.QueryConsumerChainConsumerValidatorsRequest{
+	req := types.QueryConsumerValidatorsRequest{
 		ChainId: chainID,
 	}
 
 	// error returned from not-started chain
-	_, err := pk.QueryConsumerChainConsumerValidators(ctx, &req)
+	_, err := pk.QueryConsumerValidators(ctx, &req)
 	require.Error(t, err)
 
 	providerAddr1 := types.NewProviderConsAddress([]byte("providerAddr1"))
@@ -157,8 +157,8 @@ func TestQueryConsumerChainConsumerValidators(t *testing.T) {
 	consumerKey2 := cryptotestutil.NewCryptoIdentityFromIntSeed(2).TMProtoCryptoPublicKey()
 	consumerValidator2 := types.ConsumerValidator{ProviderConsAddr: providerAddr2.ToSdkConsAddr(), Power: 2, ConsumerPublicKey: &consumerKey2}
 
-	expectedResponse := types.QueryConsumerChainConsumerValidatorsResponse{
-		Validators: []*types.QueryConsumerChainConsumerValidator{
+	expectedResponse := types.QueryConsumerValidatorsResponse{
+		Validators: []*types.QueryConsumerValidatorsValidator{
 			{providerAddr1.String(), &consumerKey1, 1},
 			{providerAddr2.String(), &consumerKey2, 2},
 		},
@@ -168,7 +168,7 @@ func TestQueryConsumerChainConsumerValidators(t *testing.T) {
 	pk.SetConsumerClientId(ctx, chainID, "clientID")
 	pk.SetConsumerValSet(ctx, chainID, []types.ConsumerValidator{consumerValidator1, consumerValidator2})
 
-	res, err := pk.QueryConsumerChainConsumerValidators(ctx, &req)
+	res, err := pk.QueryConsumerValidators(ctx, &req)
 	require.NoError(t, err)
 	require.Equal(t, &expectedResponse, res)
 }