fix: enable pagination and introduce new response data in queries (#2398)

* init commit

* added changelog and changed docs

Author: insumity

.changelog/unreleased/bug-fixes/2398-enable-pagination-in-listing-chain-query.md

@@ -0,0 +1,2 @@
+- `[x/provider]` Fixed pagination bug in query for listing the consumer chains.
+  ([\#2398](https://github.com/cosmos/interchain-security/pull/2398))

docs/docs/build/modules/02-provider.md

@@ -2336,7 +2336,7 @@ Output:
 
 #### List Consumer Chains
 
-The `QueryConsumerChains` endpoint queries consumer chains supported by the provider chain.
+The `QueryConsumerChains` endpoint queries consumer chains supported by the provider chain and supports pagination for managing a large number of chains.
 An optional integer parameter can be passed for phase filtering of consumer chains, (Registered=1|Initialized=2|Launched=3|Stopped=4|Deleted=5).`
 
 ```bash
@@ -2873,7 +2873,8 @@ grpcurl -plaintext -d '{"consumer_id": "0"}' localhost:9090 interchain_security.
     "validatorSetCap": 50,
     "minStake": "1000",
     "allowInactiveVals": true
-  }
+  },
+  "clientId": "07-tendermint-28"
 }
 ```
 

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

@@ -397,6 +397,9 @@ message QueryConsumerChainResponse {
   ConsumerMetadata metadata = 5 [ (gogoproto.nullable) = false ];
   ConsumerInitializationParameters init_params = 6;
   PowerShapingParameters power_shaping_params = 7;
+
+  // corresponds to the id of the client that is created during launch
+  string client_id = 8;
 }
 
 message QueryConsumerGenesisTimeRequest {

x/ccv/provider/client/cli/query.go

@@ -10,7 +10,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/types/query"
 	"github.com/cosmos/cosmos-sdk/version"
 
 	"github.com/cosmos/interchain-security/v6/x/ccv/provider/types"
@@ -76,12 +75,12 @@ func CmdConsumerGenesis() *cobra.Command {
 
 func CmdConsumerChains() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "list-consumer-chains [phase] [limit]",
+		Use:   "list-consumer-chains [phase]",
 		Short: "Query consumer chains for provider chain.",
 		Long: `Query consumer chains for provider chain. An optional
 		integer parameter can be passed for phase filtering of consumer chains,
 		(Registered=1|Initialized=2|Launched=3|Stopped=4|Deleted=5).`,
-		Args: cobra.MaximumNArgs(2),
+		Args: cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
 			clientCtx, err := client.GetClientQueryContext(cmd)
 			if err != nil {
@@ -99,14 +98,14 @@ func CmdConsumerChains() *cobra.Command {
 				req.Phase = types.ConsumerPhase(phase)
 			}
 
-			if len(args) == 2 && args[1] != "" {
-				limit, err := strconv.ParseInt(args[1], 10, 32)
-				if err != nil {
-					return err
-				}
-				req.Pagination = &query.PageRequest{
-					Limit: uint64(limit),
-				}
+			fs, err := client.FlagSetWithPageKeyDecoded(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			req.Pagination, err = client.ReadPageRequest(fs)
+			if err != nil {
+				return err
 			}
 
 			res, err := queryClient.QueryConsumerChains(cmd.Context(), req)
@@ -119,6 +118,7 @@ func CmdConsumerChains() *cobra.Command {
 	}
 
 	flags.AddQueryFlagsToCmd(cmd)
+	flags.AddPaginationFlagsToCmd(cmd, "consumer chains")
 
 	return cmd
 }

x/ccv/provider/keeper/grpc_query.go

@@ -618,6 +618,10 @@ func (k Keeper) QueryConsumerChain(goCtx context.Context, req *types.QueryConsum
 	initParams, _ := k.GetConsumerInitializationParameters(ctx, consumerId)
 	powerParams, _ := k.GetConsumerPowerShapingParameters(ctx, consumerId)
 
+	// The client id might not exist in case the consumer chain has not yet launched or in case the chain has been deleted.
+	// That's why we do not check if the client id is found.
+	clientId, _ := k.GetConsumerClientId(ctx, consumerId)
+
 	return &types.QueryConsumerChainResponse{
 		ChainId:            chainId,
 		ConsumerId:         consumerId,
@@ -626,10 +630,11 @@ func (k Keeper) QueryConsumerChain(goCtx context.Context, req *types.QueryConsum
 		Metadata:           metadata,
 		InitParams:         &initParams,
 		PowerShapingParams: &powerParams,
+		ClientId:           clientId,
 	}, nil
 }
 
-//  QueryConsumerGenesisTime returns the genesis time
+// QueryConsumerGenesisTime returns the genesis time
 // of the consumer chain associated with the provided consumer id
 func (k Keeper) QueryConsumerGenesisTime(goCtx context.Context, req *types.QueryConsumerGenesisTimeRequest) (*types.QueryConsumerGenesisTimeResponse, error) {
 	if req == nil {

x/ccv/provider/keeper/grpc_query_test.go

@@ -557,6 +557,7 @@ func TestQueryConsumerChain(t *testing.T) {
 
 	consumerId := "0"
 	chainId := "consumer"
+	clientId := "client-0"
 
 	req := types.QueryConsumerChainRequest{
 		ConsumerId: consumerId,
@@ -587,6 +588,8 @@ func TestQueryConsumerChain(t *testing.T) {
 	err = providerKeeper.SetConsumerMetadata(ctx, consumerId, types.ConsumerMetadata{Name: chainId})
 	require.NoError(t, err)
 
+	providerKeeper.SetConsumerClientId(ctx, consumerId, clientId)
+
 	expRes := types.QueryConsumerChainResponse{
 		ChainId:            chainId,
 		ConsumerId:         consumerId,
@@ -595,6 +598,7 @@ func TestQueryConsumerChain(t *testing.T) {
 		Phase:              types.CONSUMER_PHASE_REGISTERED.String(),
 		InitParams:         &types.ConsumerInitializationParameters{},
 		PowerShapingParams: &types.PowerShapingParameters{},
+		ClientId:           clientId,
 	}
 
 	// expect no error when neither the consumer init and power shaping params are set