fix(x/crisis): do not recover panic

cosmos · Nov 6, 2023 · c91f5a9 · c91f5a9
1 parent fb9dadc
commit c91f5a9
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 10 deletions.
diff --git a/baseapp/recovery.go b/baseapp/recovery.go
@@ -7,10 +7,13 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	storetypes "cosmossdk.io/store/types"
 
+	"github.com/cockroachdb/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 )
 
+var IrrecoverablePanic = errors.New("irrecoverable panic")
+
 // RecoveryHandler handles recovery() object.
 // Return a non-nil error if recoveryObj was processed.
 // Return nil if recoveryObj was not processed.
@@ -24,6 +27,12 @@ type recoveryMiddleware func(recoveryObj interface{}) (recoveryMiddleware, error
 // processRecovery processes recoveryMiddleware chain for recovery() object.
 // Chain processing stops on non-nil error or when chain is processed.
 func processRecovery(recoveryObj interface{}, middleware recoveryMiddleware) error {
+	if err, ok := recoveryObj.(error); ok {
+		if errors.Is(err, IrrecoverablePanic) {
+			panic(err)
+		}
+	}
+
 	if middleware == nil {
 		return nil
 	}

diff --git a/x/crisis/keeper/keeper.go b/x/crisis/keeper/keeper.go
@@ -8,8 +8,10 @@ import (
 	"cosmossdk.io/collections"
 	"cosmossdk.io/core/address"
 	storetypes "cosmossdk.io/core/store"
+	"cosmossdk.io/errors"
 	"cosmossdk.io/log"
 
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/crisis/types"
@@ -107,11 +109,9 @@ func (k *Keeper) AssertInvariants(ctx context.Context) {
 
 		invCtx, _ := sdkCtx.CacheContext()
 		if res, stop := ir.Invar(invCtx); stop {
-			// TODO: Include app name as part of context to allow for this to be
-			// variable.
-			panic(fmt.Errorf("invariant broken: %s\n"+
+			panic(errors.Wrap(baseapp.IrrecoverablePanic, fmt.Sprintf("invariant broken: %s\n"+
 				"\tCRITICAL please submit the following transaction:\n"+
-				"\t\t tx crisis invariant-broken %s %s", res, ir.ModuleName, ir.Route))
+				"\t\t tx crisis invariant-broken %s %s", res, ir.ModuleName, ir.Route)))
 		}
 	}
 

diff --git a/x/crisis/keeper/msg_server.go b/x/crisis/keeper/msg_server.go
@@ -6,6 +6,7 @@ import (
 	"cosmossdk.io/errors"
 	govtypes "cosmossdk.io/x/gov/types"
 
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/x/crisis/types"
@@ -15,7 +16,7 @@ var _ types.MsgServer = &Keeper{}
 
 // VerifyInvariant implements MsgServer.VerifyInvariant method.
 // It defines a method to verify a particular invariant.
-func (k *Keeper) VerifyInvariant(goCtx context.Context, msg *types.MsgVerifyInvariant) (*types.MsgVerifyInvariantResponse, error) {
+func (k *Keeper) VerifyInvariant(ctx context.Context, msg *types.MsgVerifyInvariant) (*types.MsgVerifyInvariantResponse, error) {
 	if msg.Sender == "" {
 		return nil, sdkerrors.ErrInvalidAddress.Wrap("empty address string is not allowed")
 	}
@@ -24,8 +25,7 @@ func (k *Keeper) VerifyInvariant(goCtx context.Context, msg *types.MsgVerifyInva
 		return nil, sdkerrors.ErrInvalidAddress.Wrapf("invalid sender address: %s", err)
 	}
 
-	ctx := sdk.UnwrapSDKContext(goCtx)
-	params, err := k.ConstantFee.Get(goCtx)
+	params, err := k.ConstantFee.Get(ctx)
 	if err != nil {
 		return nil, err
 	}
@@ -36,7 +36,8 @@ func (k *Keeper) VerifyInvariant(goCtx context.Context, msg *types.MsgVerifyInva
 	}
 
 	// use a cached context to avoid gas costs during invariants
-	cacheCtx, _ := ctx.CacheContext()
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	cacheCtx, _ := sdkCtx.CacheContext()
 
 	found := false
 	msgFullRoute := msg.FullInvariantRoute()
@@ -61,10 +62,10 @@ func (k *Keeper) VerifyInvariant(goCtx context.Context, msg *types.MsgVerifyInva
 		// blockchain thus the constant fee will have never been deducted. Thus no refund is required.
 
 		// TODO replace with circuit breaker
-		panic(res)
+		panic(errors.Wrap(baseapp.IrrecoverablePanic, res))
 	}
 
-	ctx.EventManager().EmitEvents(sdk.Events{
+	sdkCtx.EventManager().EmitEvents(sdk.Events{
 		sdk.NewEvent(
 			types.EventTypeInvariant,
 			sdk.NewAttribute(types.AttributeKeyRoute, msg.InvariantRoute),