feat: add decorator to wrap panic messages with the transaction that …

…caused them (backport #2559) (#2572)

This is an automatic backport of pull request #2559 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

---------

Co-authored-by: Callum Waters <[email protected]>

app/ante/ante.go

@@ -21,8 +21,10 @@ func NewAnteHandler(
 	channelKeeper *ibckeeper.Keeper,
 ) sdk.AnteHandler {
 	return sdk.ChainAnteDecorators(
+		// Wraps the panic with the string format of the transaction
+		NewHandlePanicDecorator(),
 		// Set up the context with a gas meter.
-		// Contract: must be called first.
+		// Must be called before gas consumption occurs in any other decorator.
 		ante.NewSetUpContextDecorator(),
 		// Ensure the tx does not contain any extension options.
 		ante.NewExtensionOptionsDecorator(nil),

app/ante/panic.go

@@ -0,0 +1,32 @@
+package ante
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// HandlePanicDecorator that catches panics and wraps them in the transaction that caused the panic
+type HandlePanicDecorator struct{}
+
+func NewHandlePanicDecorator() HandlePanicDecorator {
+	return HandlePanicDecorator{}
+}
+
+func (d HandlePanicDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
+	defer func() {
+		if r := recover(); r != nil {
+			panic(fmt.Sprint(r, FormatTx(tx)))
+		}
+	}()
+
+	return next(ctx, tx, simulate)
+}
+
+func FormatTx(tx sdk.Tx) string {
+	output := "\ncaused by transaction:\n"
+	for _, msg := range tx.GetMsgs() {
+		output += fmt.Sprintf("%T{%s}\n", msg, msg)
+	}
+	return output
+}

app/ante/panic_test.go

@@ -0,0 +1,37 @@
+package ante_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/celestiaorg/celestia-app/app"
+	"github.com/celestiaorg/celestia-app/app/ante"
+	"github.com/celestiaorg/celestia-app/app/encoding"
+	"github.com/celestiaorg/celestia-app/test/util/testfactory"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPanicHandlerDecorator(t *testing.T) {
+	decorator := ante.NewHandlePanicDecorator()
+	anteHandler := sdk.ChainAnteDecorators(decorator, mockPanicDecorator{})
+	ctx := sdk.Context{}
+	encCfg := encoding.MakeConfig(app.ModuleEncodingRegisters...)
+	builder := encCfg.TxConfig.NewTxBuilder()
+	err := builder.SetMsgs(banktypes.NewMsgSend(testfactory.RandomAddress().(sdk.AccAddress), testfactory.RandomAddress().(sdk.AccAddress), sdk.NewCoins(sdk.NewInt64Coin(app.BondDenom, 10))))
+	require.NoError(t, err)
+	tx := builder.GetTx()
+	defer func() {
+		r := recover()
+		require.NotNil(t, r)
+		require.Equal(t, fmt.Sprint("mock panic", ante.FormatTx(tx)), r)
+	}()
+	_, _ = anteHandler(ctx, tx, false)
+}
+
+type mockPanicDecorator struct{}
+
+func (d mockPanicDecorator) AnteHandle(_ sdk.Context, _ sdk.Tx, _ bool, _ sdk.AnteHandler) (newCtx sdk.Context, err error) {
+	panic("mock panic")
+}