EstimateTradeBasedOnPriceImpact Query

CHANGELOG.md

@@ -154,6 +154,7 @@ Fixes mainnet bugs w/ incorrect accumulation sumtrees, and CL handling for a bal
 
 ### API breaks
 
+* [#6167](https://github.com/osmosis-labs/osmosis/pull/6167) add EstimateTradeBasedOnPriceImpact query to x/poolmanager.
 * [#6238](https://github.com/osmosis-labs/osmosis/pull/6238) switch osmomath to sdkmath types and rename BigDec constructors to contain "Big" in the name.
    * Note: with the update, the Dec and Int do not get initialized to zero values
    by default in proto marhaling/unmarshaling. Instead, they get set to nil values.

client/docs/static/openapi/openapi.yaml

@@ -4198,6 +4198,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -4447,6 +4448,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -4700,6 +4702,7 @@ paths:
                               - ByDuration
                               - ByTime
                               - NoLock
+                              - ByGroup
                             default: ByDuration
                             description: >-
                               LockQueryType defines the type of the lock query that can
@@ -4874,6 +4877,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -5313,6 +5317,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -5565,6 +5570,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -8052,6 +8058,7 @@ paths:
                                 - ByDuration
                                 - ByTime
                                 - NoLock
+                                - ByGroup
                               default: ByDuration
                               description: >-
                                 LockQueryType defines the type of the lock query that can
@@ -8373,6 +8380,7 @@ paths:
         - Query
   "/osmosis/superfluid/v1beta1/account_delegated_cl_positions/{delegator_address}":
     get:
+      summary: Returns all of a user's full range CL positions that are superfluid staked.
       operationId: UserConcentratedSuperfluidPositionsDelegated
       responses:
         "200":
@@ -32673,6 +32681,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can
@@ -32826,6 +32835,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can
@@ -32974,6 +32984,7 @@ components:
                 - ByDuration
                 - ByTime
                 - NoLock
+                - ByGroup
               default: ByDuration
               description: |-
                 LockQueryType defines the type of the lock query that can
@@ -33099,6 +33110,7 @@ components:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -33227,6 +33239,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can
@@ -33430,6 +33443,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can
@@ -33583,6 +33597,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can
@@ -33705,6 +33720,7 @@ components:
         - ByDuration
         - ByTime
         - NoLock
+        - ByGroup
       default: ByDuration
       description: |-
         LockQueryType defines the type of the lock query that can
@@ -33719,6 +33735,7 @@ components:
             - ByDuration
             - ByTime
             - NoLock
+            - ByGroup
           default: ByDuration
           description: |-
             LockQueryType defines the type of the lock query that can
@@ -35036,6 +35053,7 @@ components:
                       - ByDuration
                       - ByTime
                       - NoLock
+                      - ByGroup
                     default: ByDuration
                     description: |-
                       LockQueryType defines the type of the lock query that can

client/docs/static/swagger/swagger.yaml

@@ -4557,6 +4557,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -4833,6 +4834,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -5112,6 +5114,7 @@ paths:
                           - ByDuration
                           - ByTime
                           - NoLock
+                          - ByGroup
                         default: ByDuration
                         description: >-
                           LockQueryType defines the type of the lock query that
@@ -5308,6 +5311,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -5766,6 +5770,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -6046,6 +6051,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -8638,6 +8644,7 @@ paths:
                             - ByDuration
                             - ByTime
                             - NoLock
+                            - ByGroup
                           default: ByDuration
                           description: >-
                             LockQueryType defines the type of the lock query
@@ -8966,6 +8973,9 @@ paths:
         - Query
   /osmosis/superfluid/v1beta1/account_delegated_cl_positions/{delegator_address}:
     get:
+      summary: >-
+        Returns all of a user's full range CL positions that are superfluid
+        staked.
       operationId: UserConcentratedSuperfluidPositionsDelegated
       responses:
         '200':
@@ -35434,6 +35444,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -35609,6 +35620,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -35776,6 +35788,7 @@ definitions:
               - ByDuration
               - ByTime
               - NoLock
+              - ByGroup
             default: ByDuration
             description: |-
               LockQueryType defines the type of the lock query that can
@@ -35909,6 +35922,7 @@ definitions:
                   - ByDuration
                   - ByTime
                   - NoLock
+                  - ByGroup
                 default: ByDuration
                 description: |-
                   LockQueryType defines the type of the lock query that can
@@ -36058,6 +36072,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -36281,6 +36296,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -36456,6 +36472,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can
@@ -36593,6 +36610,7 @@ definitions:
       - ByDuration
       - ByTime
       - NoLock
+      - ByGroup
     default: ByDuration
     description: |-
       LockQueryType defines the type of the lock query that can
@@ -36607,6 +36625,7 @@ definitions:
           - ByDuration
           - ByTime
           - NoLock
+          - ByGroup
         default: ByDuration
         description: |-
           LockQueryType defines the type of the lock query that can
@@ -38079,6 +38098,7 @@ definitions:
                     - ByDuration
                     - ByTime
                     - NoLock
+                    - ByGroup
                   default: ByDuration
                   description: |-
                     LockQueryType defines the type of the lock query that can

cmd/osmosisd/cmd/stargate-query.go

@@ -407,6 +407,8 @@ func GetStructAndFill(queryPath, module, structName string, structArguments ...s
 			v.BaseAssetDenom = structArguments[1]
 			v.QuoteAssetDenom = structArguments[2]
 			return v, nil
+		case "EstimateTradeBasedOnPriceImpactRequest":
+			return nil, fmt.Errorf("swap route parsing not supported yet")
 		}
 	case "txfees":
 		switch structName {

proto/osmosis/poolmanager/v1beta1/query.proto

@@ -111,6 +111,15 @@ service Query {
     option (google.api.http).get =
         "/osmosis/poolmanager/v1beta1/pools/total_liquidity";
   }
+
+  // EstimateTradeBasedOnPriceImpact returns an estimated trade based on price
+  // impact, if a trade cannot be estimated a 0 input and 0 output would be
+  // returned.
+  rpc EstimateTradeBasedOnPriceImpact(EstimateTradeBasedOnPriceImpactRequest)
+      returns (EstimateTradeBasedOnPriceImpactResponse) {
+    option (google.api.http).get =
+        "/osmosis/poolmanager/v1beta1/{pool_id}/estimate_trade";
+  }
 }
 
 //=============================== Params
@@ -250,4 +259,51 @@ message TotalLiquidityResponse {
     (gogoproto.moretags) = "yaml:\"liquidity\"",
     (gogoproto.nullable) = false
   ];
-}
+}
+
+//=============================== EstimateTradeBasedOnPriceImpact
+
+// EstimateTradeBasedOnPriceImpactRequest represents a request to estimate a
+// trade for Balancer/StableSwap/Concentrated liquidity pool types based on the
+// given parameters.
+message EstimateTradeBasedOnPriceImpactRequest {
+  // from_coin is the total amount of tokens that the user wants to sell.
+  cosmos.base.v1beta1.Coin from_coin = 1 [ (gogoproto.nullable) = false ];
+
+  // to_coin_denom is the denom identifier of the token that the user wants to
+  // buy.
+  string to_coin_denom = 2;
+
+  // pool_id is the identifier of the liquidity pool that the trade will occur
+  // on.
+  uint64 pool_id = 3;
+
+  // max_price_impact is the maximum percentage that the user is willing
+  // to affect the price of the liquidity pool.
+  string max_price_impact = 4 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ];
+
+  // external_price is an optional external price that the user can enter.
+  // It adjusts the MaxPriceImpact as the SpotPrice of a pool can be changed at
+  // any time.
+  string external_price = 5 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ];
+}
+
+// EstimateTradeBasedOnPriceImpactResponse represents the response data
+// for an estimated trade based on price impact. If a trade fails to be
+// estimated the response would be 0,0 for input_coin and output_coin and will
+// not error.
+message EstimateTradeBasedOnPriceImpactResponse {
+  // input_coin is the actual input amount that would be tradeable
+  // under the specified price impact.
+  cosmos.base.v1beta1.Coin input_coin = 1 [ (gogoproto.nullable) = false ];
+
+  // output_coin is the amount of tokens of the ToCoinDenom type
+  // that will be received for the actual InputCoin trade.
+  cosmos.base.v1beta1.Coin output_coin = 2 [ (gogoproto.nullable) = false ];
+}

proto/osmosis/poolmanager/v1beta1/query.yml

@@ -72,3 +72,9 @@ queries:
       query_func: "k.TotalLiquidity"
     cli:
       cmd: "TotalLiquidity"
+  EstimateTradeBasedOnPriceImpact:
+    proto_wrapper:
+      query_func: "k.EstimateTradeBasedOnPriceImpact"
+      response: "*queryproto.EstimateTradeBasedOnPriceImpactResponse"
+    cli:
+      cmd: "EstimateTradeBasedOnPriceImpact"