BE-636 | Add pagination + sorting + query filtering support for /pools endpoint

app/sidecar_query_server.go

@@ -147,7 +147,14 @@ func NewSideCarQueryServer(appCodec codec.Codec, config domain.Config, logger lo
 	}
 
 	// Initialize pools repository, usecase and HTTP handler
-	poolsUseCase, err := poolsUseCase.NewPoolsUsecase(config.Pools, config.ChainGRPCGatewayEndpoint, routerRepository, tokensUseCase.GetChainScalingFactorByDenomMut, logger)
+	poolsUseCase, err := poolsUseCase.NewPoolsUsecase(
+		config.Pools,
+		config.ChainGRPCGatewayEndpoint,
+		routerRepository,
+		tokensUseCase.GetChainScalingFactorByDenomMut,
+		tokensUseCase,
+		logger,
+	)
 	if err != nil {
 		return nil, err
 	}

domain/mocks/pool_handler_mock.go

@@ -17,24 +17,19 @@ type PoolHandlerMock struct {
 var _ mvc.PoolHandler = &PoolHandlerMock{}
 
 // GetPools implements mvc.PoolHandler.
-func (p *PoolHandlerMock) GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, error) {
+func (p *PoolHandlerMock) GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, uint64, error) {
 	if p.ForceGetPoolsError != nil {
-		return nil, p.ForceGetPoolsError
-	}
-
-	options := domain.PoolsOptions{
-		MinPoolLiquidityCap: 0,
-		PoolIDFilter:        []uint64{},
+		return nil, 0, p.ForceGetPoolsError
 	}
 
+	var options domain.PoolsOptions
 	for _, opt := range opts {
 		opt(&options)
 	}
 
 	result := make([]sqsdomain.PoolI, 0)
-
-	if len(options.PoolIDFilter) > 0 {
-		for _, id := range options.PoolIDFilter {
+	if f := options.Filter; f != nil && len(f.PoolId) > 0 {
+		for _, id := range f.PoolId {
 			for _, pool := range p.Pools {
 				if pool.GetId() == id {
 					result = append(result, pool)
@@ -43,13 +38,15 @@ func (p *PoolHandlerMock) GetPools(opts ...domain.PoolsOption) ([]sqsdomain.Pool
 		}
 	} else {
 		for _, pool := range p.Pools {
-			if pool.GetLiquidityCap().Uint64() > options.MinPoolLiquidityCap {
-				result = append(result, pool)
+			if f := options.Filter; f != nil {
+				if pool.GetLiquidityCap().Uint64() > f.MinLiquidityCap {
+					result = append(result, pool)
+				}
 			}
 		}
 	}
 
-	return result, nil
+	return result, uint64(len(result)), nil
 }
 
 // StorePools implements mvc.PoolHandler.

domain/mocks/pools_usecase_mock.go

@@ -20,7 +20,7 @@ var _ mvc.PoolsUsecase = &PoolsUsecaseMock{}
 
 type PoolsUsecaseMock struct {
 	GetAllPoolsFunc                     func() ([]sqsdomain.PoolI, error)
-	GetPoolsFunc                        func(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, error)
+	GetPoolsFunc                        func(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, uint64, error)
 	StorePoolsFunc                      func(pools []sqsdomain.PoolI) error
 	GetRoutesFromCandidatesFunc         func(candidateRoutes sqsdomain.CandidateRoutes, tokenInDenom, tokenOutDenom string) ([]route.RouteImpl, error)
 	GetTickModelMapFunc                 func(poolIDs []uint64) (map[uint64]*sqsdomain.TickModel, error)
@@ -79,7 +79,7 @@ func (pm *PoolsUsecaseMock) GetCosmWasmPoolConfig() domain.CosmWasmPoolRouterCon
 }
 
 // GetPools implements mvc.PoolsUsecase.
-func (pm *PoolsUsecaseMock) GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, error) {
+func (pm *PoolsUsecaseMock) GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, uint64, error) {
 	if pm.GetPoolsFunc != nil {
 		return pm.GetPoolsFunc(opts...)
 	}

domain/mvc/pools.go

@@ -46,8 +46,9 @@ type PoolsUsecase interface {
 }
 
 type PoolHandler interface {
-	// GetPools returns the pools corresponding to the given IDs.
-	GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, error)
+	// GetPools returns the pools corresponding to the given options and the total number of pools.
+	// If pagination is provided, returns the pools corresponding to the pagination.
+	GetPools(opts ...domain.PoolsOption) ([]sqsdomain.PoolI, uint64, error)
 
 	// StorePools stores the given pools in the usecase
 	StorePools(pools []sqsdomain.PoolI) error

domain/pools.go

@@ -3,6 +3,9 @@ package domain
 import (
 	"context"
 
+	v1beta1 "github.com/osmosis-labs/sqs/pkg/api/v1beta1"
+	api "github.com/osmosis-labs/sqs/pkg/api/v1beta1/pools"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/osmosis-labs/osmosis/osmomath"
 )
@@ -85,40 +88,63 @@ func (c CanonicalOrderBooksResult) Validate() error {
 }
 
 type PoolsOptions struct {
-	MinPoolLiquidityCap  uint64
-	PoolIDFilter         []uint64
-	WithMarketIncentives bool
-	// HadEmptyFilter is true if the pool ID filter was empty.
-	// This signifies avoid getting all pools and rather exit early.
-	HadEmptyFilter bool
+	Filter     *api.GetPoolsRequestFilter
+	Pagination *v1beta1.PaginationRequest
+	Sort       *v1beta1.SortRequest
 }
 
 // PoolsOption configures the pools filter options.
 type PoolsOption func(*PoolsOptions)
 
+// WithNonNilFilter ensures the Filter field in PoolsOptions is not nil and applies the provided configuration function.
+func WithNonNilFilter(configure func(*api.GetPoolsRequestFilter)) PoolsOption {
+	return func(o *PoolsOptions) {
+		if o.Filter == nil {
+			o.Filter = &api.GetPoolsRequestFilter{} // Initialize Filter if nil
+		}
+		configure(o.Filter) // Apply the configuration function
+	}
+}
+
 // WithMinPooslLiquidityCap configures with the min pool liquidity
 // capitalization.
 func WithMinPoolsLiquidityCap(minPoolLiquidityCap uint64) PoolsOption {
-	return func(o *PoolsOptions) {
-		o.MinPoolLiquidityCap = minPoolLiquidityCap
-	}
+	return WithNonNilFilter(func(filter *api.GetPoolsRequestFilter) {
+		filter.MinLiquidityCap = minPoolLiquidityCap
+	})
 }
 
 // WithPoolIDFilter configures the pools options with the pool ID filter.
 func WithPoolIDFilter(poolIDFilter []uint64) PoolsOption {
+	return WithNonNilFilter(func(filter *api.GetPoolsRequestFilter) {
+		filter.PoolId = poolIDFilter
+	})
+}
+
+// WithMarketIncentives configures the pools options with the market incentives filter.
+func WithMarketIncentives(withMarketIncentives bool) PoolsOption {
+	return WithNonNilFilter(func(filter *api.GetPoolsRequestFilter) {
+		filter.WithMarketIncentives = withMarketIncentives
+	})
+}
+
+// WithPagination configures the pools options with the pagination request.
+func WithFilter(f *api.GetPoolsRequestFilter) PoolsOption {
 	return func(o *PoolsOptions) {
-		// We should simply return early rather than attempting to get all pools.
-		if len(poolIDFilter) == 0 {
-			o.HadEmptyFilter = true
-			return
-		}
+		o.Filter = f
+	}
+}
 
-		o.PoolIDFilter = poolIDFilter
+// WithPagination configures the pools options with the pagination request.
+func WithPagination(p *v1beta1.PaginationRequest) PoolsOption {
+	return func(o *PoolsOptions) {
+		o.Pagination = p
 	}
 }
 
-func WithMarketIncentives(withMarketIncentives bool) PoolsOption {
+// WithSort configures the pools options with the sort request.
+func WithSort(s *v1beta1.SortRequest) PoolsOption {
 	return func(o *PoolsOptions) {
-		o.WithMarketIncentives = withMarketIncentives
+		o.Sort = s
 	}
 }

pools/delivery/http/pools_handler.go

@@ -11,7 +11,8 @@ import (
 	deliveryhttp "github.com/osmosis-labs/sqs/delivery/http"
 	"github.com/osmosis-labs/sqs/domain"
 	"github.com/osmosis-labs/sqs/domain/mvc"
-	"github.com/osmosis-labs/sqs/domain/number"
+	v1beta1 "github.com/osmosis-labs/sqs/pkg/api/v1beta1"
+	api "github.com/osmosis-labs/sqs/pkg/api/v1beta1/pools"
 	"github.com/osmosis-labs/sqs/sqsdomain"
 
 	"github.com/osmosis-labs/osmosis/osmomath"
@@ -45,6 +46,12 @@ type PoolResponse struct {
 	FeesData sqspassthroughdomain.PoolFeesDataStatusWrap `json:"fees_data,omitempty"`
 }
 
+// GetPoolsResponse is a structure for serializing pools result returned to clients.
+type GetPoolsResponse struct {
+	Data []PoolResponse              `json:"data"`
+	Meta *v1beta1.PaginationResponse `json:"meta"`
+}
+
 const resourcePrefix = "/pools"
 
 func formatPoolsResource(resource string) string {
@@ -74,53 +81,31 @@ func NewPoolsHandler(e *echo.Echo, us mvc.PoolsUsecase) {
 // @Success 200  {array}  sqsdomain.PoolI  "List of pool(s) details"
 // @Router /pools [get]
 func (a *PoolsHandler) GetPools(c echo.Context) error {
-	// Get pool ID parameters as strings.
-	poolIDsStr := c.QueryParam("IDs")
-	minLiquidityCapStr := c.QueryParam("min_liquidity_cap")
-	withMarketIncentives, err := deliveryhttp.ParseBooleanQueryParam(c, "with_market_incentives")
-	if err != nil {
-		return c.JSON(http.StatusBadRequest, ResponseError{Message: err.Error()})
+	var req api.GetPoolsRequest
+	if err := deliveryhttp.ParseRequest(c, &req); err != nil {
+		return c.JSON(http.StatusBadRequest, domain.ResponseError{Message: err.Error()})
 	}
 
 	var (
 		pools []sqsdomain.PoolI
 	)
 
-	// Parse numbers
-	poolIDs, err := number.ParseNumbers(poolIDsStr)
-	if err != nil {
-		return c.JSON(http.StatusBadRequest, ResponseError{Message: err.Error()})
-	}
-
-	// Parse min liquidity cap if provided
-	var minLiquidityCap uint64
-	if minLiquidityCapStr != "" {
-		minLiquidityCap, err = strconv.ParseUint(minLiquidityCapStr, 10, 64)
-		if err != nil {
-			return c.JSON(http.StatusBadRequest, ResponseError{Message: "Invalid min_liquidity_cap value"})
-		}
-	}
-
 	filters := []domain.PoolsOption{
-		domain.WithMinPoolsLiquidityCap(minLiquidityCap),
-		domain.WithMarketIncentives(withMarketIncentives),
-	}
-
-	// Only add pool ID filter if it is not empty.
-	if len(poolIDs) > 0 {
-		filters = append(filters, domain.WithPoolIDFilter(poolIDs))
+		domain.WithFilter(req.Filter),
+		domain.WithPagination(req.Pagination),
+		domain.WithSort(req.Sort),
 	}
 
 	// Get pools
-	pools, err = a.PUsecase.GetPools(
+	pools, total, err := a.PUsecase.GetPools(
 		filters...,
 	)
 	if err != nil {
 		return c.JSON(getStatusCode(err), ResponseError{Message: err.Error()})
 	}
 
 	// Convert pools to the appropriate format
-	resultPools := convertPoolsToResponse(pools)
+	resultPools := convertPoolsToResponse(&req, pools, total)
 
 	return c.JSON(http.StatusOK, resultPools)
 }
@@ -225,10 +210,14 @@ func convertPoolToResponse(pool sqsdomain.PoolI) PoolResponse {
 }
 
 // convertPoolsToResponse converts the given pools to the appropriate response type.
-func convertPoolsToResponse(pools []sqsdomain.PoolI) []PoolResponse {
-	resultPools := make([]PoolResponse, 0, len(pools))
-	for _, pool := range pools {
-		resultPools = append(resultPools, convertPoolToResponse(pool))
+func convertPoolsToResponse(req *api.GetPoolsRequest, p []sqsdomain.PoolI, total uint64) *GetPoolsResponse {
+	pools := make([]PoolResponse, 0, len(p))
+	for _, pool := range p {
+		pools = append(pools, convertPoolToResponse(pool))
+	}
+
+	return &GetPoolsResponse{
+		Data: pools,
+		Meta: v1beta1.NewPaginationResponse(req.Pagination, total),
 	}
-	return resultPools
 }

pools/usecase/export_test.go

@@ -39,14 +39,10 @@ func (p *poolsUseCase) StoreInvalidOrderBookEntry(baseDenom, quoteDenom string)
 	p.canonicalOrderBookForBaseQuoteDenom.Store(formatBaseQuoteDenom(baseDenom, quoteDenom), invalidEntryType)
 }
 
-func (p poolsUseCase) SetPoolAPRAndFeeDataIfConfigured(pool sqsdomain.PoolI, options domain.PoolsOptions) {
+func (p *poolsUseCase) SetPoolAPRAndFeeDataIfConfigured(pool sqsdomain.PoolI, options domain.PoolsOptions) {
 	p.setPoolAPRAndFeeDataIfConfigured(pool, options)
 }
 
-func (p *poolsUseCase) RetainPoolIfMatchesOptions(poolsToUpdate []sqsdomain.PoolI, poolConsidered sqsdomain.PoolI, options domain.PoolsOptions) []sqsdomain.PoolI {
-	return p.retainPoolIfMatchesOptions(poolsToUpdate, poolConsidered, options)
-}
-
 func (p *poolsUseCase) CalcExitPool(ctx sdk.Context, pool types.CFMMPoolI, exitingSharesIn osmomath.Int, exitFee osmomath.Dec) (sdk.Coins, error) {
 	return calcExitPool(ctx, pool, exitingSharesIn, exitFee)
 }