feat: simulate swap as part of quotes (#547) (#549)

* feat: simulate swap as part of quotes * try adding e2e test * updates * lint * fix test * swagger * attempt fix grpc wiring * fix e2e sim test * updates (cherry picked from commit f2931d8) # Conflicts: # domain/cosmos/tx/msg_simulator.go # domain/cosmos/tx/msg_simulator_test.go # domain/mocks/msg_simulator_mock.go # domain/passthrough/passthrough_grpc_client.go Co-authored-by: Roman <[email protected]>
osmosis-labs · Nov 12, 2024 · 829a871 · 829a871
1 parent e12f7d4
commit 829a871
Show file tree

Hide file tree

Showing 28 changed files with 927 additions and 94 deletions.
diff --git a/app/sidecar_query_server.go b/app/sidecar_query_server.go
@@ -20,12 +20,16 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
+	"github.com/osmosis-labs/osmosis/v27/app"
+	txfeestypes "github.com/osmosis-labs/osmosis/v27/x/txfees/types"
+	"github.com/osmosis-labs/sqs/domain/cosmos/auth/types"
 	ingestrpcdelivry "github.com/osmosis-labs/sqs/ingest/delivery/grpc"
 	ingestusecase "github.com/osmosis-labs/sqs/ingest/usecase"
 	orderbookclaimbot "github.com/osmosis-labs/sqs/ingest/usecase/plugins/orderbook/claimbot"
 	orderbookfillbot "github.com/osmosis-labs/sqs/ingest/usecase/plugins/orderbook/fillbot"
 	orderbookrepository "github.com/osmosis-labs/sqs/orderbook/repository"
 	orderbookusecase "github.com/osmosis-labs/sqs/orderbook/usecase"
+	"github.com/osmosis-labs/sqs/quotesimulator"
 	"github.com/osmosis-labs/sqs/sqsutil/datafetchers"
 
 	chaininforepo "github.com/osmosis-labs/sqs/chaininfo/repository"
@@ -43,6 +47,7 @@ import (
 
 	"github.com/osmosis-labs/sqs/domain"
 	"github.com/osmosis-labs/sqs/domain/cache"
+	"github.com/osmosis-labs/sqs/domain/cosmos/tx"
 	"github.com/osmosis-labs/sqs/domain/keyring"
 	"github.com/osmosis-labs/sqs/domain/mvc"
 	orderbookgrpcclientdomain "github.com/osmosis-labs/sqs/domain/orderbook/grpcclient"
@@ -210,7 +215,17 @@ func NewSideCarQueryServer(appCodec codec.Codec, config domain.Config, logger lo
 	if err := tokenshttpdelivery.NewTokensHandler(e, *config.Pricing, tokensUseCase, pricingSimpleRouterUsecase, logger); err != nil {
 		return nil, err
 	}
-	routerHttpDelivery.NewRouterHandler(e, routerUsecase, tokensUseCase, logger)
+
+	grpcClient := passthroughGRPCClient.GetChainGRPCClient()
+	gasCalculator := tx.NewGasCalculator(grpcClient, tx.CalculateGas)
+	quoteSimulator := quotesimulator.NewQuoteSimulator(
+		gasCalculator,
+		app.GetEncodingConfig(),
+		txfeestypes.NewQueryClient(grpcClient),
+		types.NewQueryClient(grpcClient),
+		config.ChainID,
+	)
+	routerHttpDelivery.NewRouterHandler(e, routerUsecase, tokensUseCase, quoteSimulator, logger)
 
 	// Create a Numia HTTP client
 	passthroughConfig := config.Passthrough

diff --git a/docs/docs.go b/docs/docs.go
@@ -299,6 +299,18 @@ const docTemplate = `{
                         "description": "Boolean flag indicating whether to apply exponents to the spot price. False by default.",
                         "name": "applyExponents",
                         "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Address of the simulator to simulate the quote. If provided, the quote will be simulated.",
+                        "name": "simulatorAddress",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Slippage tolerance multiplier for the simulation. If simulatorAddress is provided, this must be provided.",
+                        "name": "simulationSlippageTolerance",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -514,7 +526,7 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "amount": {
-                    "$ref": "#/definitions/types.Int"
+                    "$ref": "#/definitions/math.Int"
                 },
                 "denom": {
                     "type": "string"
@@ -663,6 +675,9 @@ const docTemplate = `{
                 }
             }
         },
+        "math.Int": {
+            "type": "object"
+        },
         "sqsdomain.CandidatePool": {
             "type": "object",
             "properties": {
@@ -707,9 +722,6 @@ const docTemplate = `{
                     }
                 }
             }
-        },
-        "types.Int": {
-            "type": "object"
         }
     }
 }`

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -290,6 +290,18 @@
                         "description": "Boolean flag indicating whether to apply exponents to the spot price. False by default.",
                         "name": "applyExponents",
                         "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Address of the simulator to simulate the quote. If provided, the quote will be simulated.",
+                        "name": "simulatorAddress",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Slippage tolerance multiplier for the simulation. If simulatorAddress is provided, this must be provided.",
+                        "name": "simulationSlippageTolerance",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -505,7 +517,7 @@
             "type": "object",
             "properties": {
                 "amount": {
-                    "$ref": "#/definitions/types.Int"
+                    "$ref": "#/definitions/math.Int"
                 },
                 "denom": {
                     "type": "string"
@@ -654,6 +666,9 @@
                 }
             }
         },
+        "math.Int": {
+            "type": "object"
+        },
         "sqsdomain.CandidatePool": {
             "type": "object",
             "properties": {
@@ -698,9 +713,6 @@
                     }
                 }
             }
-        },
-        "types.Int": {
-            "type": "object"
         }
     }
 }
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -38,7 +38,7 @@ definitions:
   github_com_cosmos_cosmos-sdk_types.Coin:
     properties:
       amount:
-        $ref: '#/definitions/types.Int'
+        $ref: '#/definitions/math.Int'
       denom:
         type: string
     type: object
@@ -142,6 +142,8 @@ definitions:
           $ref: '#/definitions/github_com_osmosis-labs_sqs_domain_orderbook.LimitOrder'
         type: array
     type: object
+  math.Int:
+    type: object
   sqsdomain.CandidatePool:
     properties:
       id:
@@ -171,8 +173,6 @@ definitions:
           type: object
         type: object
     type: object
-  types.Int:
-    type: object
 info:
   contact: {}
   title: Osmosis Sidecar Query Server Example API
@@ -407,6 +407,16 @@ paths:
         in: query
         name: applyExponents
         type: boolean
+      - description: Address of the simulator to simulate the quote. If provided,
+          the quote will be simulated.
+        in: query
+        name: simulatorAddress
+        type: string
+      - description: Slippage tolerance multiplier for the simulation. If simulatorAddress
+          is provided, this must be provided.
+        in: query
+        name: simulationSlippageTolerance
+        type: string
       produces:
       - application/json
       responses:

diff --git a/domain/cosmos/tx/msg_simulator.go b/domain/cosmos/tx/msg_simulator.go
@@ -10,6 +10,7 @@ import (
 	txtypes "github.com/cosmos/cosmos-sdk/types/tx"
 	signingtypes "github.com/cosmos/cosmos-sdk/types/tx/signing"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+
 	"github.com/osmosis-labs/osmosis/v27/app/params"
 	txfeestypes "github.com/osmosis-labs/osmosis/v27/x/txfees/types"
 	"github.com/osmosis-labs/sqs/domain/keyring"
@@ -38,6 +39,17 @@ type MsgSimulator interface {
 		chainID string,
 		msgs []sdk.Msg,
 	) (*txtypes.SimulateResponse, uint64, error)
+
+	// PriceMsgs simulates the execution of the given messages and returns the gas used and the fee coin,
+	// which is the fee amount in the base denomination.
+	PriceMsgs(
+		ctx context.Context,
+		txfeesClient txfeestypes.QueryClient,
+		encodingConfig cosmosclient.TxConfig,
+		account *authtypes.BaseAccount,
+		chainID string,
+		msg ...sdk.Msg,
+	) (uint64, sdk.Coin, error)
 }
 
 // NewGasCalculator creates a new GasCalculator instance.
@@ -79,23 +91,13 @@ func (c *txGasCalulator) BuildTx(
 		return nil, err
 	}
 
-	_, gas, err := c.SimulateMsgs(
-		encodingConfig.TxConfig,
-		account,
-		chainID,
-		msg,
-	)
-	if err != nil {
-		return nil, err
-	}
-	txBuilder.SetGasLimit(gas)
-
-	feecoin, err := CalculateFeeCoin(ctx, txfeesClient, gas)
+	gasAdjusted, feecoin, err := c.PriceMsgs(ctx, txfeesClient, encodingConfig.TxConfig, account, chainID, msg...)
 	if err != nil {
 		return nil, err
 	}
 
-	txBuilder.SetFeeAmount(sdk.NewCoins(feecoin))
+	txBuilder.SetGasLimit(gasAdjusted)
+	txBuilder.SetFeeAmount(sdk.Coins{feecoin})
 
 	sigV2 := BuildSignatures(privKey.PubKey(), nil, account.Sequence)
 	err = txBuilder.SetSignatures(sigV2)
@@ -143,6 +145,26 @@ func (c *txGasCalulator) SimulateMsgs(encodingConfig cosmosclient.TxConfig, acco
 	return gasResult, adjustedGasUsed, nil
 }
 
+// PriceMsgs implements MsgSimulator.
+func (c *txGasCalulator) PriceMsgs(ctx context.Context, txfeesClient txfeestypes.QueryClient, encodingConfig cosmosclient.TxConfig, account *authtypes.BaseAccount, chainID string, msg ...sdk.Msg) (uint64, sdk.Coin, error) {
+	_, gasAdjusted, err := c.SimulateMsgs(
+		encodingConfig,
+		account,
+		chainID,
+		msg,
+	)
+	if err != nil {
+		return 0, sdk.Coin{}, err
+	}
+
+	feeCoin, err := CalculateFeeCoin(ctx, txfeesClient, gasAdjusted)
+	if err != nil {
+		return 0, sdk.Coin{}, err
+	}
+
+	return gasAdjusted, feeCoin, nil
+}
+
 // CalculateGas calculates the gas required for a transaction using the provided transaction factory and messages.
 func CalculateGas(
 	clientCtx gogogrpc.ClientConn,