Add Query pools by coin denom (osmosis-labs#6766)

* Add Cli query pools by denom * revert * minor * minor * Update x/poolmanager/client/query_proto_wrap.go Co-authored-by: Ruslan Akhtariev <[email protected]> * Update x/poolmanager/client/query_proto_wrap.go Co-authored-by: Ruslan Akhtariev <[email protected]> * Update x/poolmanager/router.go Co-authored-by: Ruslan Akhtariev <[email protected]> * Update proto/osmosis/poolmanager/v1beta1/query.proto Co-authored-by: Matt, Park <[email protected]> * Update x/poolmanager/router.go Co-authored-by: Matt, Park <[email protected]> * Update proto/osmosis/poolmanager/v1beta1/query.proto Co-authored-by: Matt, Park <[email protected]> * Update x/poolmanager/router.go Co-authored-by: Matt, Park <[email protected]> * Update x/poolmanager/router.go Co-authored-by: Matt, Park <[email protected]> * minor and lint * Use dynamic slice instead of Allocate the slice * changelog * make proto-gen * lint proto * add test * Update x/poolmanager/router_test.go Co-authored-by: Matt, Park <[email protected]> * Update x/poolmanager/router_test.go Co-authored-by: Matt, Park <[email protected]> * make proto-all * use a few poolType Concentrated --------- Co-authored-by: Ruslan Akhtariev <[email protected]> Co-authored-by: Matt, Park <[email protected]> Co-authored-by: Hieu Vu <[email protected]>
doggystylez · Feb 14, 2024 · 22e8db8 · 22e8db8
1 parent 5640a99
commit 22e8db8
Show file tree

Hide file tree

Showing 9 changed files with 789 additions and 136 deletions.
diff --git a/proto/osmosis/poolmanager/v1beta1/query.proto b/proto/osmosis/poolmanager/v1beta1/query.proto
@@ -91,6 +91,12 @@ service Query {
   rpc AllPools(AllPoolsRequest) returns (AllPoolsResponse) {
     option (google.api.http).get = "/osmosis/poolmanager/v1beta1/all-pools";
   }
+  // ListPoolsByDenom return all pools by denom
+  rpc ListPoolsByDenom(ListPoolsByDenomRequest)
+      returns (ListPoolsByDenomResponse) {
+    option (google.api.http).get =
+        "/osmosis/poolmanager/v1beta1/list-pools-by-denom";
+  }
 
   // SpotPrice defines a gRPC query handler that returns the spot price given
   // a base denomination and a quote denomination.
@@ -234,6 +240,17 @@ message AllPoolsResponse {
       [ (cosmos_proto.accepts_interface) = "PoolI" ];
 }
 
+// =======================================================
+// ListPoolsByDenomRequest
+message ListPoolsByDenomRequest {
+  string denom = 1 [ (gogoproto.moretags) = "yaml:\"denom\"" ];
+}
+
+message ListPoolsByDenomResponse {
+  repeated google.protobuf.Any pools = 1
+      [ (cosmos_proto.accepts_interface) = "PoolI" ];
+}
+// ==========================================================
 // SpotPriceRequest defines the gRPC request structure for a SpotPrice
 // query.
 message SpotPriceRequest {

diff --git a/scripts/setup_superfluid.sh b/scripts/setup_superfluid.sh
@@ -33,4 +33,4 @@ sleep 7
 osmosisd tx gov vote 1 yes --from=validator1 --keyring-backend=test --chain-id=testing --yes --home=$HOME/.osmosisd/validator1
 sleep 7
 osmosisd tx gov vote 1 yes --from=validator2 --keyring-backend=test --chain-id=testing --yes --home=$HOME/.osmosisd/validator2
-sleep 7
+sleep 7
diff --git a/x/poolmanager/client/cli/query.go b/x/poolmanager/client/cli/query.go
@@ -32,6 +32,7 @@ func GetQueryCmd() *cobra.Command {
 	osmocli.AddQueryCmd(cmd, queryproto.NewQueryClient, GetCmdTotalVolumeForPool)
 	osmocli.AddQueryCmd(cmd, queryproto.NewQueryClient, GetCmdTradingPairTakerFee)
 	osmocli.AddQueryCmd(cmd, queryproto.NewQueryClient, GetCmdEstimateTradeBasedOnPriceImpact)
+	osmocli.AddQueryCmd(cmd, queryproto.NewQueryClient, GetCmdListPoolsByDenom)
 	cmd.AddCommand(
 		osmocli.GetParams[*queryproto.ParamsRequest](
 			types.ModuleName, queryproto.NewQueryClient),
@@ -105,6 +106,15 @@ func GetCmdSpotPrice() (*osmocli.QueryDescriptor, *queryproto.SpotPriceRequest)
 `,
 	}, &queryproto.SpotPriceRequest{}
 }
+func GetCmdListPoolsByDenom() (*osmocli.QueryDescriptor, *queryproto.ListPoolsByDenomRequest) {
+	return &osmocli.QueryDescriptor{
+		Use:   "list-pools-by-denom",
+		Short: "Query list-pools-by-denom",
+		Long: `Query list-pools-by-denom
+{{.CommandPrefix}} list-pools-by-denom uosmo 
+`,
+	}, &queryproto.ListPoolsByDenomRequest{}
+}
 
 func EstimateSwapExactAmountInParseArgs(args []string, fs *flag.FlagSet) (proto.Message, error) {
 	poolID, err := strconv.Atoi(args[0])

diff --git a/x/poolmanager/client/grpc/grpc_query.go b/x/poolmanager/client/grpc/grpc_query.go
@@ -71,6 +71,16 @@ func (q Querier) SpotPrice(grpcCtx context.Context,
 	return q.Q.SpotPrice(ctx, *req)
 }
 
+func (q Querier) ListPoolsByDenom(grpcCtx context.Context,
+	req *queryproto.ListPoolsByDenomRequest,
+) (*queryproto.ListPoolsByDenomResponse, error) {
+	if req == nil {
+		return nil, status.Error(codes.InvalidArgument, "empty request")
+	}
+	ctx := sdk.UnwrapSDKContext(grpcCtx)
+	return q.Q.ListPoolsByDenom(ctx, *req)
+}
+
 func (q Querier) Pool(grpcCtx context.Context,
 	req *queryproto.PoolRequest,
 ) (*queryproto.PoolResponse, error) {

diff --git a/x/poolmanager/client/query_proto_wrap.go b/x/poolmanager/client/query_proto_wrap.go
@@ -214,6 +214,30 @@ func (q Querier) AllPools(ctx sdk.Context, req queryproto.AllPoolsRequest) (*que
 	}, nil
 }
 
+// ListPoolsByDenom returns a list of pools filtered by denom
+func (q Querier) ListPoolsByDenom(ctx sdk.Context, req queryproto.ListPoolsByDenomRequest) (*queryproto.ListPoolsByDenomResponse, error) {
+	if req.Denom == "" {
+		return nil, status.Error(codes.InvalidArgument, "invalid denom")
+	}
+	pools, err := q.K.ListPoolsByDenom(ctx, req.Denom)
+	if err != nil {
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+
+	var anyPools []*codectypes.Any
+	for _, pool := range pools {
+		any, err := codectypes.NewAnyWithValue(pool.AsSerializablePool())
+		if err != nil {
+			return nil, err
+		}
+		anyPools = append(anyPools, any)
+	}
+
+	return &queryproto.ListPoolsByDenomResponse{
+		Pools: anyPools,
+	}, nil
+}
+
 // SpotPrice returns the spot price of the pool with the given quote and base asset denoms. 18 decimals.
 func (q Querier) SpotPrice(ctx sdk.Context, req queryproto.SpotPriceRequest) (*queryproto.SpotPriceResponse, error) {
 	if req.BaseAssetDenom == "" {

diff --git a/x/poolmanager/client/queryproto/query.pb.go b/x/poolmanager/client/queryproto/query.pb.go
diff --git a/x/poolmanager/client/queryproto/query.pb.gw.go b/x/poolmanager/client/queryproto/query.pb.gw.go
diff --git a/x/poolmanager/router.go b/x/poolmanager/router.go
@@ -548,6 +548,38 @@ func (k Keeper) AllPools(
 	return sortedPools, nil
 }
 
+// ListPoolsByDenom returns all pools by denom sorted by their ids
+// from every pool module registered in the
+// pool manager keeper.
+func (k Keeper) ListPoolsByDenom(
+	ctx sdk.Context,
+	denom string,
+) ([]types.PoolI, error) {
+	less := func(i, j types.PoolI) bool {
+		return i.GetId() < j.GetId()
+	}
+	var sortedPools []types.PoolI
+	for _, poolModule := range k.poolModules {
+		currentModulePools, err := poolModule.GetPools(ctx)
+		if err != nil {
+			return nil, err
+		}
+
+		var poolsByDenom []types.PoolI
+		for _, pool := range currentModulePools {
+			coins, err := k.GetTotalPoolLiquidity(ctx, pool.GetId())
+			if err != nil {
+				return nil, err
+			}
+			if coins.AmountOf(denom).GT(osmomath.ZeroInt()) {
+				poolsByDenom = append(poolsByDenom, pool)
+			}
+		}
+		sortedPools = osmoutils.MergeSlices(sortedPools, poolsByDenom, less)
+	}
+	return sortedPools, nil
+}
+
 // createMultihopExpectedSwapOuts defines the output denom and output amount for the last pool in
 // the routeStep of pools the caller is intending to hop through in a fixed-output multihop tx. It estimates the input
 // amount for this last pool and then chains that input as the output of the previous pool in the routeStep, repeating

diff --git a/x/poolmanager/router_test.go b/x/poolmanager/router_test.go
@@ -3785,3 +3785,82 @@ func (s *KeeperTestSuite) testSwapExactAmpountInVolumeTracked(noTakerFeeVariant
 	totalVolume = s.App.PoolManagerKeeper.GetTotalVolumeForPool(s.Ctx, concentratedPool.GetId())
 	s.Require().Equal(tokenIn.String(), totalVolume.String())
 }
+
+func (suite *KeeperTestSuite) TestListPoolsByDenom() {
+	suite.Setup()
+
+	tests := map[string]struct {
+		denom            string
+		poolCoins        []sdk.Coins
+		expectedNumPools int
+		expectedError    bool
+		poolType         []types.PoolType
+	}{
+		"Single pool, pool contain denom": {
+			poolType: []types.PoolType{types.Balancer},
+			poolCoins: []sdk.Coins{
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 1 bar-uosmo
+			},
+			denom:            BAR,
+			expectedNumPools: 1,
+		},
+		"Single pool, pool does not contain denom": {
+			poolType: []types.PoolType{types.Balancer},
+			poolCoins: []sdk.Coins{
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 1 bar-uosmo
+			},
+			denom:            FOO,
+			expectedNumPools: 0,
+		},
+		"Two pools, pools contains denom": {
+			poolType: []types.PoolType{types.Balancer, types.Balancer},
+			poolCoins: []sdk.Coins{
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 1 bar-uosmo
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(FOO, defaultInitPoolAmount)),   // pool 2. baz-foo
+			},
+			denom:            BAR,
+			expectedNumPools: 2,
+		},
+		"Two pools, pools does not contains denom": {
+			poolType: []types.PoolType{types.Balancer, types.Concentrated},
+			poolCoins: []sdk.Coins{
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 1 bar-uosmo
+				sdk.NewCoins(sdk.NewCoin(BAZ, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 2. baz-foo
+			},
+			denom:            FOO,
+			expectedNumPools: 0,
+		},
+		"Many pools": {
+			poolType: []types.PoolType{types.Concentrated, types.Balancer, types.Concentrated, types.Balancer},
+			poolCoins: []sdk.Coins{
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 1 bar-uosmo
+				sdk.NewCoins(sdk.NewCoin(BAZ, defaultInitPoolAmount), sdk.NewCoin(FOO, defaultInitPoolAmount)),   // pool 2. baz-foo
+				sdk.NewCoins(sdk.NewCoin(BAR, defaultInitPoolAmount), sdk.NewCoin(BAZ, defaultInitPoolAmount)),   // pool 3. bar-baz
+				sdk.NewCoins(sdk.NewCoin(BAZ, defaultInitPoolAmount), sdk.NewCoin(UOSMO, defaultInitPoolAmount)), // pool 4. baz-uosmo
+			},
+			denom:            BAR,
+			expectedNumPools: 2,
+		},
+	}
+
+	for name, tc := range tests {
+		suite.Run(name, func() {
+			suite.SetupTest()
+			ctx := suite.Ctx
+			poolManagerKeeper := suite.App.PoolManagerKeeper
+
+			for i := range tc.poolType {
+				suite.FundAcc(suite.TestAccs[0], tc.poolCoins[i])
+				suite.CreatePoolFromTypeWithCoins(tc.poolType[i], tc.poolCoins[i])
+			}
+
+			poolsResult, err := poolManagerKeeper.ListPoolsByDenom(ctx, tc.denom)
+			if tc.expectedError {
+				suite.Require().Error(err)
+			} else {
+				suite.Require().NoError(err)
+				suite.Require().Equal(tc.expectedNumPools, len(poolsResult))
+			}
+		})
+	}
+}