Better errors on out of gas

CHANGELOG.md

@@ -53,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Misc Improvements
 * [#7106](https://github.com/osmosis-labs/osmosis/pull/7106) Halve the time of log2 calculation (speeds up TWAP code)
 * [#7093](https://github.com/osmosis-labs/osmosis/pull/7093),[#7100](https://github.com/osmosis-labs/osmosis/pull/7100),[#7172](https://github.com/osmosis-labs/osmosis/pull/7093) Lower CPU overheads of the Osmosis epoch.
+* [#7181](https://github.com/osmosis-labs/osmosis/pull/7181) Improve errors for out of gas
 
 ## v21.0.0
 

x/gamm/keeper/pool_service.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"fmt"
 
+	"github.com/osmosis-labs/osmosis/osmoutils"
+
 	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
@@ -142,7 +144,11 @@ func (k Keeper) JoinPoolNoSwap(
 		if r := recover(); r != nil {
 			tokenIn = sdk.Coins{}
 			sharesOut = osmomath.Int{}
-			err = fmt.Errorf("function JoinPoolNoSwap failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function JoinPoolNoSwap failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function JoinPoolNoSwap failed due to internal reason: %v", r)
+			}
 		}
 	}()
 	// all pools handled within this method are pointer references, `JoinPool` directly updates the pools
@@ -234,7 +240,11 @@ func (k Keeper) JoinSwapExactAmountIn(
 	defer func() {
 		if r := recover(); r != nil {
 			sharesOut = osmomath.Int{}
-			err = fmt.Errorf("function JoinSwapExactAmountIn failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function JoinSwapExactAmountIn failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function JoinSwapExactAmountIn failed due to internal reason: %v", r)
+			}
 		}
 	}()
 
@@ -278,7 +288,11 @@ func (k Keeper) JoinSwapShareAmountOut(
 	defer func() {
 		if r := recover(); r != nil {
 			tokenInAmount = osmomath.Int{}
-			err = fmt.Errorf("function JoinSwapShareAmountOut failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function JoinSwapShareAmountOut failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function JoinSwapShareAmountOut failed due to internal reason: %v", r)
+			}
 		}
 	}()
 

x/gamm/keeper/swap.go

@@ -4,6 +4,8 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/osmosis-labs/osmosis/osmoutils"
+
 	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
@@ -40,7 +42,11 @@ func (k Keeper) SwapExactAmountIn(
 	defer func() {
 		if r := recover(); r != nil {
 			tokenOutAmount = osmomath.Int{}
-			err = fmt.Errorf("function swapExactAmountIn failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function swapExactAmountIn failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function swapExactAmountIn failed due to internal reason: %v", r)
+			}
 		}
 	}()
 
@@ -94,7 +100,11 @@ func (k Keeper) SwapExactAmountOut(
 	defer func() {
 		if r := recover(); r != nil {
 			tokenInAmount = osmomath.Int{}
-			err = fmt.Errorf("function swapExactAmountOut failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function swapExactAmountOut failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function swapExactAmountOut failed due to internal reason: %v", r)
+			}
 		}
 	}()
 

x/gamm/keeper/swap_test.go

@@ -466,6 +466,20 @@ func (s *KeeperTestSuite) TestActiveBalancerPoolSwap() {
 	}
 }
 
+func (s *KeeperTestSuite) TestOutOfGasError() {
+	s.SetupTest()
+	poolId := s.PrepareBalancerPool()
+
+	pool, err := s.App.GAMMKeeper.GetPool(s.Ctx, poolId)
+	s.Require().NoError(err)
+	foocoin := sdk.NewCoin("foo", osmomath.NewInt(10))
+	spreadFactor := pool.GetSpreadFactor(s.Ctx)
+	ctx := s.Ctx.WithGasMeter(sdk.NewGasMeter(10))
+	_, err = s.App.GAMMKeeper.SwapExactAmountIn(ctx, s.TestAccs[0], pool, foocoin, "bar", osmomath.ZeroInt(), spreadFactor)
+	s.Require().Error(err)
+	s.Require().Contains(err.Error(), "lack of gas")
+}
+
 // UNFORKINGNOTE: This test really wasn't testing anything important
 // With the unfork, we can no longer utilize mocks when calling SetPools, since
 // the interface needs to be registered with codec, and the mocks aren't wired to do that.

x/poolmanager/router.go

@@ -235,7 +235,11 @@ func (k Keeper) MultihopEstimateOutGivenExactAmountIn(
 	defer func() {
 		if r := recover(); r != nil {
 			tokenOutAmount = osmomath.Int{}
-			err = fmt.Errorf("function MultihopEstimateOutGivenExactAmountIn failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function MultihopEstimateOutGivenExactAmountIn failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function MultihopEstimateOutGivenExactAmountIn failed due to internal reason: %v", r)
+			}
 		}
 	}()
 
@@ -301,7 +305,11 @@ func (k Keeper) RouteExactAmountOut(ctx sdk.Context,
 	defer func() {
 		if r := recover(); r != nil {
 			tokenInAmount = osmomath.Int{}
-			err = fmt.Errorf("function RouteExactAmountOut failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function RouteExactAmountOut failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function RouteExactAmountOut failed due to internal reason: %v", r)
+			}
 		}
 	}()
 
@@ -493,7 +501,11 @@ func (k Keeper) MultihopEstimateInGivenExactAmountOut(
 	defer func() {
 		if r := recover(); r != nil {
 			insExpected = []osmomath.Int{}
-			err = fmt.Errorf("function MultihopEstimateInGivenExactAmountOut failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("function MultihopEstimateInGivenExactAmountOut failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("function MultihopEstimateInGivenExactAmountOut failed due to internal reason: %v", r)
+			}
 		}
 	}()
 

x/protorev/keeper/posthandler.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"fmt"
 
+	"github.com/osmosis-labs/osmosis/osmoutils"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/osmosis-labs/osmosis/osmomath"
@@ -113,7 +115,11 @@ func (k Keeper) ProtoRevTrade(ctx sdk.Context, swappedPools []SwapToBackrun) (er
 	// recover from panic
 	defer func() {
 		if r := recover(); r != nil {
-			err = fmt.Errorf("Protorev failed due to internal reason: %v", r)
+			if isErr, d := osmoutils.IsOutOfGasError(r); isErr {
+				err = fmt.Errorf("protorev failed due to lack of gas: %v", d)
+			} else {
+				err = fmt.Errorf("protorev failed due to internal reason: %v", r)
+			}
 		}
 	}()