Merge pull request #180 from crescent-network/feat/public-position-id…

…-query feat: add position_id in public position query
crescent-network · Aug 18, 2023 · e68105d · e68105d
2 parents 92ccc70 + 467cf33
commit e68105d
Show file tree

Hide file tree

Showing 6 changed files with 148 additions and 79 deletions.
diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -10471,6 +10471,9 @@ paths:
                       format: uint64
                     liquidity:
                       type: string
+                    position_id:
+                      type: string
+                      format: uint64
                     total_share:
                       type: object
                       properties:
@@ -10645,6 +10648,9 @@ paths:
                     format: uint64
                   liquidity:
                     type: string
+                  position_id:
+                    type: string
+                    format: uint64
                   total_share:
                     type: object
                     properties:
@@ -19416,6 +19422,9 @@ definitions:
         format: uint64
       liquidity:
         type: string
+      position_id:
+        type: string
+        format: uint64
       total_share:
         type: object
         properties:
@@ -19550,6 +19559,9 @@ definitions:
             format: uint64
           liquidity:
             type: string
+          position_id:
+            type: string
+            format: uint64
           total_share:
             type: object
             properties:
@@ -19605,6 +19617,9 @@ definitions:
               format: uint64
             liquidity:
               type: string
+            position_id:
+              type: string
+              format: uint64
             total_share:
               type: object
               properties:

diff --git a/proto/crescent/liquidamm/v1beta1/query.proto b/proto/crescent/liquidamm/v1beta1/query.proto
@@ -165,5 +165,6 @@ message PublicPositionResponse {
   uint64 last_rewards_auction_id = 8;
   string liquidity               = 9
       [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
-  cosmos.base.v1beta1.Coin total_share = 10 [(gogoproto.nullable) = false];
+  uint64                   position_id = 10; // underlying x/amm position's id
+  cosmos.base.v1beta1.Coin total_share = 11 [(gogoproto.nullable) = false];
 }
diff --git a/x/liquidamm/keeper/grpc_query.go b/x/liquidamm/keeper/grpc_query.go
@@ -70,9 +70,10 @@ func (k Querier) PublicPositions(c context.Context, req *types.QueryPublicPositi
 	var publicPositions []types.PublicPositionResponse
 	pageRes, err := query.Paginate(publicPositionStore, req.Pagination, func(key, value []byte) error {
 		publicPosition := publicPositionGetter(key, value)
-		position, found := k.GetAMMPosition(ctx, publicPosition)
+		ammPosition, found := k.GetAMMPosition(ctx, publicPosition)
 		if !found {
-			position.Liquidity = utils.ZeroInt
+			ammPosition.Liquidity = utils.ZeroInt
+			ammPosition.Id = 0
 		}
 		shareDenom := types.ShareDenom(publicPosition.Id)
 		publicPositions = append(publicPositions, types.PublicPositionResponse{
@@ -84,8 +85,9 @@ func (k Querier) PublicPositions(c context.Context, req *types.QueryPublicPositi
 			MinBidAmount:         publicPosition.MinBidAmount,
 			FeeRate:              publicPosition.FeeRate,
 			LastRewardsAuctionId: publicPosition.LastRewardsAuctionId,
-			Liquidity:            position.Liquidity,
+			Liquidity:            ammPosition.Liquidity,
 			TotalShare:           k.bankKeeper.GetSupply(ctx, shareDenom),
+			PositionId:           ammPosition.Id,
 		})
 		return nil
 	})
@@ -116,6 +118,7 @@ func (k Querier) PublicPosition(c context.Context, req *types.QueryPublicPositio
 	ammPosition, found := k.GetAMMPosition(ctx, publicPosition)
 	if !found { // sanity check
 		ammPosition.Liquidity = utils.ZeroInt
+		ammPosition.Id = 0
 	}
 	shareDenom := types.ShareDenom(publicPosition.Id)
 	resp := types.PublicPositionResponse{
@@ -129,6 +132,7 @@ func (k Querier) PublicPosition(c context.Context, req *types.QueryPublicPositio
 		LastRewardsAuctionId: publicPosition.LastRewardsAuctionId,
 		Liquidity:            ammPosition.Liquidity,
 		TotalShare:           k.bankKeeper.GetSupply(ctx, shareDenom),
+		PositionId:           ammPosition.Id,
 	}
 	return &types.QueryPublicPositionResponse{PublicPosition: resp}, nil
 }

diff --git a/x/liquidamm/keeper/grpc_query_test.go b/x/liquidamm/keeper/grpc_query_test.go
@@ -114,6 +114,19 @@ func (s *KeeperTestSuite) TestQueryPublicPosition() {
 					s.App.BankKeeper.GetSupply(s.Ctx, types.ShareDenom(publicPosition.Id)),
 					publicPosition.TotalShare)
 				s.Require().Equal(sdk.NewInt(43138144377), publicPosition.Liquidity)
+				s.Require().Equal(uint64(2), publicPosition.PositionId)
+			},
+		},
+		{
+			"no amm position",
+			&types.QueryPublicPositionRequest{
+				PublicPositionId: 2,
+			},
+			"",
+			func(resp *types.QueryPublicPositionResponse) {
+				publicPosition := resp.PublicPosition
+				s.Require().Equal(uint64(2), publicPosition.Id)
+				s.Require().Equal(uint64(0), publicPosition.PositionId)
 			},
 		},
 	} {