Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: simulate swap as part of quotes (#547)
* 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
- Loading branch information
1 parent
ecc7019
commit f65ed41
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| package tx | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| cosmosclient "github.com/cosmos/cosmos-sdk/client" | ||
| txclient "github.com/cosmos/cosmos-sdk/client/tx" | ||
| "github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| 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/v26/app/params" | ||
| txfeestypes "github.com/osmosis-labs/osmosis/v26/x/txfees/types" | ||
| "github.com/osmosis-labs/sqs/domain/keyring" | ||
|
|
||
| gogogrpc "github.com/cosmos/gogoproto/grpc" | ||
| ) | ||
|
|
||
| // MsgSimulator is an interface for calculating gas for a transaction. | ||
| type MsgSimulator interface { | ||
| BuildTx( | ||
| ctx context.Context, | ||
| keyring keyring.Keyring, | ||
| txfeesClient txfeestypes.QueryClient, | ||
| encodingConfig params.EncodingConfig, | ||
| account *authtypes.BaseAccount, | ||
| chainID string, | ||
| msg ...sdk.Msg, | ||
| ) (cosmosclient.TxBuilder, error) | ||
|
|
||
| // SimulateMsgs simulates the execution of the given messages and returns the simulation response, | ||
| // adjusted gas used, and any error encountered. It uses the provided gRPC client, encoding config, | ||
| // account details, and chain ID to create a transaction factory for the simulation. | ||
| SimulateMsgs( | ||
| encodingConfig cosmosclient.TxConfig, | ||
| account *authtypes.BaseAccount, | ||
| 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. | ||
| func NewGasCalculator(clientCtx gogogrpc.ClientConn, calculateGas CalculateGasFn) MsgSimulator { | ||
| return &txGasCalulator{ | ||
| clientCtx: clientCtx, | ||
| calculateGas: calculateGas, | ||
| } | ||
| } | ||
|
|
||
| // CalculateGasFn is a function type that calculates the gas for a transaction. | ||
| type CalculateGasFn func(clientCtx gogogrpc.ClientConn, txf txclient.Factory, msgs ...sdk.Msg) (*txtypes.SimulateResponse, uint64, error) | ||
|
|
||
| // txGasCalulator is a GasCalculator implementation that uses simulated transactions to calculate gas. | ||
| type txGasCalulator struct { | ||
| clientCtx gogogrpc.ClientConn | ||
| calculateGas CalculateGasFn | ||
| } | ||
|
|
||
| // BuildTx constructs a transaction using the provided parameters and messages. | ||
| // Returns a TxBuilder and any error encountered. | ||
| func (c *txGasCalulator) BuildTx( | ||
| ctx context.Context, | ||
| keyring keyring.Keyring, | ||
| txfeesClient txfeestypes.QueryClient, | ||
| encodingConfig params.EncodingConfig, | ||
| account *authtypes.BaseAccount, | ||
| chainID string, | ||
| msg ...sdk.Msg, | ||
| ) (cosmosclient.TxBuilder, error) { | ||
| key := keyring.GetKey() | ||
| privKey := &secp256k1.PrivKey{Key: key.Bytes()} | ||
|
|
||
| // Create and sign the transaction | ||
| txBuilder := encodingConfig.TxConfig.NewTxBuilder() | ||
|
|
||
| err := txBuilder.SetMsgs(msg...) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| gasAdjusted, feecoin, err := c.PriceMsgs(ctx, txfeesClient, encodingConfig.TxConfig, account, chainID, msg...) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| txBuilder.SetGasLimit(gasAdjusted) | ||
| txBuilder.SetFeeAmount(sdk.Coins{feecoin}) | ||
|
|
||
| sigV2 := BuildSignatures(privKey.PubKey(), nil, account.Sequence) | ||
| err = txBuilder.SetSignatures(sigV2) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| signerData := BuildSignerData(chainID, account.AccountNumber, account.Sequence) | ||
|
|
||
| signed, err := txclient.SignWithPrivKey( | ||
| ctx, | ||
| signingtypes.SignMode_SIGN_MODE_DIRECT, signerData, | ||
| txBuilder, privKey, encodingConfig.TxConfig, account.Sequence) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| err = txBuilder.SetSignatures(signed) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return txBuilder, nil | ||
| } | ||
|
|
||
| // SimulateMsgs implements MsgSimulator. | ||
| func (c *txGasCalulator) SimulateMsgs(encodingConfig cosmosclient.TxConfig, account *authtypes.BaseAccount, chainID string, msgs []sdk.Msg) (*txtypes.SimulateResponse, uint64, error) { | ||
| txFactory := txclient.Factory{} | ||
| txFactory = txFactory.WithTxConfig(encodingConfig) | ||
| txFactory = txFactory.WithAccountNumber(account.AccountNumber) | ||
| txFactory = txFactory.WithSequence(account.Sequence) | ||
| txFactory = txFactory.WithChainID(chainID) | ||
| txFactory = txFactory.WithGasAdjustment(1.05) | ||
|
|
||
| // Estimate transaction | ||
| gasResult, adjustedGasUsed, err := c.calculateGas( | ||
| c.clientCtx, | ||
| txFactory, | ||
| msgs..., | ||
| ) | ||
| if err != nil { | ||
| return nil, adjustedGasUsed, err | ||
| } | ||
|
|
||
| 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) | ||
|
Check failure on line 159 in domain/cosmos/tx/msg_simulator.go
|
||
| 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, | ||
| txf txclient.Factory, | ||
| msgs ...sdk.Msg, | ||
| ) (*txtypes.SimulateResponse, uint64, error) { | ||
| gasResult, adjustedGasUsed, err := txclient.CalculateGas( | ||
| clientCtx, | ||
| txf, | ||
| msgs..., | ||
| ) | ||
| if err != nil { | ||
| return nil, adjustedGasUsed, err | ||
| } | ||
|
|
||
| return gasResult, adjustedGasUsed, nil | ||
| } | ||
Oops, something went wrong.