Add pagination to GetValidatorSetByHeight response (#8567)

* fix pagination

* add test

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

client/grpc/tmservice/service.go

@@ -104,6 +104,9 @@ func (s queryServer) GetLatestValidatorSet(ctx context.Context, req *GetLatestVa
 	outputValidatorsRes := &GetLatestValidatorSetResponse{
 		BlockHeight: validatorsRes.BlockHeight,
 		Validators:  make([]*Validator, len(validatorsRes.Validators)),
+		Pagination: &qtypes.PageResponse{
+			Total: validatorsRes.Total,
+		},
 	}
 
 	for i, validator := range validatorsRes.Validators {
@@ -156,6 +159,7 @@ func (s queryServer) GetValidatorSetByHeight(ctx context.Context, req *GetValida
 	outputValidatorsRes := &GetValidatorSetByHeightResponse{
 		BlockHeight: validatorsRes.BlockHeight,
 		Validators:  make([]*Validator, len(validatorsRes.Validators)),
+		Pagination:  &qtypes.PageResponse{Total: validatorsRes.Total},
 	}
 
 	for i, validator := range validatorsRes.Validators {

client/grpc/tmservice/service_test.go

@@ -131,32 +131,126 @@ func (s IntegrationTestSuite) TestQueryLatestValidatorSet() {
 	s.Require().Equal(validatorSetRes.Validators[0].PubKey, anyPub)
 }
 
-func (s IntegrationTestSuite) TestQueryValidatorSetByHeight() {
+func (s IntegrationTestSuite) TestLatestValidatorSet_GRPC() {
-	val := s.network.Validators[0]
+	vals := s.network.Validators
+	testCases := []struct {
+		name      string
+		req       *tmservice.GetLatestValidatorSetRequest
+		expErr    bool
+		expErrMsg string
+	}{
+		{"nil request", nil, true, "cannot be nil"},
+		{"no pagination", &tmservice.GetLatestValidatorSetRequest{}, false, ""},
+		{"with pagination", &tmservice.GetLatestValidatorSetRequest{Pagination: &qtypes.PageRequest{Offset: 0, Limit: uint64(len(vals))}}, false, ""},
+	}
+	for _, tc := range testCases {
+		tc := tc
+		s.Run(tc.name, func() {
+			grpcRes, err := s.queryClient.GetLatestValidatorSet(context.Background(), tc.req)
+			if tc.expErr {
+				s.Require().Error(err)
+				s.Require().Contains(err.Error(), tc.expErrMsg)
+			} else {
+				s.Require().NoError(err)
+				s.Require().Len(grpcRes.Validators, len(vals))
+				s.Require().Equal(grpcRes.Pagination.Total, uint64(len(vals)))
+				content, ok := grpcRes.Validators[0].PubKey.GetCachedValue().(cryptotypes.PubKey)
+				s.Require().Equal(true, ok)
+				s.Require().Equal(content, vals[0].PubKey)
+			}
+		})
+	}
+}
 
-	// nil pagination
+func (s IntegrationTestSuite) TestLatestValidatorSet_GRPCGateway() {
-	_, err := s.queryClient.GetValidatorSetByHeight(context.Background(), &tmservice.GetValidatorSetByHeightRequest{
+	vals := s.network.Validators
-		Height:     1,
+	testCases := []struct {
-		Pagination: nil,
+		name      string
-	})
+		url       string
-	s.Require().NoError(err)
+		expErr    bool
+		expErrMsg string
+	}{
+		{"no pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/latest", vals[0].APIAddress), false, ""},
+		{"pagination invalid fields", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/latest?pagination.offset=-1&pagination.limit=-2", vals[0].APIAddress), true, "strconv.ParseUint"},
+		{"with pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/latest?pagination.offset=0&pagination.limit=2", vals[0].APIAddress), false, ""},
+	}
+	for _, tc := range testCases {
+		tc := tc
+		s.Run(tc.name, func() {
+			res, err := rest.GetRequest(tc.url)
+			s.Require().NoError(err)
+			if tc.expErr {
+				s.Require().Contains(string(res), tc.expErrMsg)
+			} else {
+				var result tmservice.GetLatestValidatorSetResponse
+				err = vals[0].ClientCtx.JSONMarshaler.UnmarshalJSON(res, &result)
+				s.Require().NoError(err)
+				s.Require().Equal(uint64(len(vals)), result.Pagination.Total)
+				anyPub, err := codectypes.NewAnyWithValue(vals[0].PubKey)
+				s.Require().NoError(err)
+				s.Require().Equal(result.Validators[0].PubKey, anyPub)
+			}
+		})
+	}
+}
 
-	_, err = s.queryClient.GetValidatorSetByHeight(context.Background(), &tmservice.GetValidatorSetByHeightRequest{
+func (s IntegrationTestSuite) TestValidatorSetByHeight_GRPC() {
-		Height: 1,
+	vals := s.network.Validators
-		Pagination: &qtypes.PageRequest{
+	testCases := []struct {
-			Offset: 0,
+		name      string
-			Limit:  10,
+		req       *tmservice.GetValidatorSetByHeightRequest
-		}})
+		expErr    bool
-	s.Require().NoError(err)
+		expErrMsg string
+	}{
+		{"nil request", nil, true, "request cannot be nil"},
+		{"empty request", &tmservice.GetValidatorSetByHeightRequest{}, true, "height must be greater than 0"},
+		{"no pagination", &tmservice.GetValidatorSetByHeightRequest{Height: 1}, false, ""},
+		{"with pagination", &tmservice.GetValidatorSetByHeightRequest{Height: 1, Pagination: &qtypes.PageRequest{Offset: 0, Limit: 1}}, false, ""},
+	}
+	for _, tc := range testCases {
+		tc := tc
+		s.Run(tc.name, func() {
+			grpcRes, err := s.queryClient.GetValidatorSetByHeight(context.Background(), tc.req)
+			if tc.expErr {
+				s.Require().Error(err)
+				s.Require().Contains(err.Error(), tc.expErrMsg)
+			} else {
+				s.Require().NoError(err)
+				s.Require().Len(grpcRes.Validators, len(vals))
+				s.Require().Equal(grpcRes.Pagination.Total, uint64(len(vals)))
+			}
+		})
+	}
+}
 
-	// no pagination rest
+func (s IntegrationTestSuite) TestValidatorSetByHeight_GRPCGateway() {
-	_, err = rest.GetRequest(fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", val.APIAddress, 1))
+	vals := s.network.Validators
-	s.Require().NoError(err)
+	testCases := []struct {
-
+		name      string
-	// rest query with pagination
+		url       string
-	restRes, err := rest.GetRequest(fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.offset=%d&pagination.limit=%d", val.APIAddress, 1, 0, 1))
+		expErr    bool
-	var validatorSetRes tmservice.GetValidatorSetByHeightResponse
+		expErrMsg string
-	s.Require().NoError(val.ClientCtx.JSONMarshaler.UnmarshalJSON(restRes, &validatorSetRes))
+	}{
+		{"invalid height", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", vals[0].APIAddress, -1), true, "height must be greater than 0"},
+		{"no pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", vals[0].APIAddress, 1), false, ""},
+		{"pagination invalid fields", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.offset=-1&pagination.limit=-2", vals[0].APIAddress, 1), true, "strconv.ParseUint"},
+		{"with pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.offset=0&pagination.limit=2", vals[0].APIAddress, 1), false, ""},
+	}
+	for _, tc := range testCases {
+		tc := tc
+		s.Run(tc.name, func() {
+			res, err := rest.GetRequest(tc.url)
+			s.Require().NoError(err)
+			if tc.expErr {
+				s.Require().Contains(string(res), tc.expErrMsg)
+			} else {
+				var result tmservice.GetValidatorSetByHeightResponse
+				err = vals[0].ClientCtx.JSONMarshaler.UnmarshalJSON(res, &result)
+				s.Require().NoError(err)
+				s.Require().Equal(uint64(len(vals)), result.Pagination.Total)
+			}
+		})
+	}
 }
 
 func TestIntegrationTestSuite(t *testing.T) {

client/rpc/validators.go

@@ -79,12 +79,14 @@ type ValidatorOutput struct {
 type ResultValidatorsOutput struct {
 	BlockHeight int64             `json:"block_height"`
 	Validators  []ValidatorOutput `json:"validators"`
+	Total       uint64            `json:"total"`
 }
 
 func (rvo ResultValidatorsOutput) String() string {
 	var b strings.Builder
 
 	b.WriteString(fmt.Sprintf("block height: %d\n", rvo.BlockHeight))
+	b.WriteString(fmt.Sprintf("total count: %d\n", rvo.Total))
 
 	for _, val := range rvo.Validators {
 		b.WriteString(
@@ -129,9 +131,15 @@ func GetValidators(ctx context.Context, clientCtx client.Context, height *int64,
 		return ResultValidatorsOutput{}, err
 	}
 
+	total := validatorsRes.Total
+	if validatorsRes.Total < 0 {
+		total = 0
+	}
+
 	outputValidatorsRes := ResultValidatorsOutput{
 		BlockHeight: validatorsRes.BlockHeight,
 		Validators:  make([]ValidatorOutput, len(validatorsRes.Validators)),
+		Total:       uint64(total),
 	}
 
 	for i := 0; i < len(validatorsRes.Validators); i++ {