[CORE-542] - Update delaymsg module to execute messages with a cached…

… context (#214)

protocol/app/app.go

@@ -1168,6 +1168,7 @@ func (app *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.Res
 	app.IndexerEventManager.SendOnchainData(block)
 	app.IndexerEventManager.ClearEvents(ctx)
 
+	app.Logger().Info("Initialized chain", "blockHeight", ctx.BlockHeight())
 	return initResponse
 }
 

protocol/lib/abci/util.go

@@ -0,0 +1,31 @@
+package abci
+
+import (
+	"fmt"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/pkg/errors"
+)
+
+// RunCached wraps a function with a cache context and writes the cache to the context if the
+// function call succeeds. If the function call fails, the cache is discarded.
+func RunCached(
+	c sdk.Context,
+	f func(sdk.Context) error,
+) (
+	err error,
+) {
+	ctx, writeCache := c.CacheContext()
+
+	defer func() {
+		if r := recover(); r != nil {
+			err = errors.WithStack(fmt.Errorf("recovered from panic in cached context: %v", r))
+		}
+	}()
+
+	if err := f(ctx); err != nil {
+		return err
+	}
+
+	writeCache()
+	return nil
+}

protocol/lib/abci/util_test.go

@@ -0,0 +1,70 @@
+package abci_test
+
+import (
+	"fmt"
+	"github.com/cometbft/cometbft/libs/log"
+	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib/abci"
+	"github.com/dydxprotocol/v4-chain/protocol/mocks"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestRunCached_Mixed(t *testing.T) {
+	testEvent := sdk.NewEvent("test", sdk.NewAttribute("key", "value"))
+	tests := map[string]struct {
+		f             func(ctx sdk.Context) error
+		expectedError error
+	}{
+		"success": {
+			f: func(ctx sdk.Context) error {
+				ctx.EventManager().EmitEvent(testEvent)
+				return nil
+			},
+		},
+		"failure": {
+			f: func(ctx sdk.Context) error {
+				ctx.EventManager().EmitEvent(testEvent)
+				return fmt.Errorf("failure")
+			},
+			expectedError: fmt.Errorf("failure"),
+		},
+		"panic": {
+			f: func(ctx sdk.Context) error {
+				ctx.EventManager().EmitEvent(testEvent)
+				panic("panic")
+			},
+			expectedError: fmt.Errorf("panic"),
+		},
+	}
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			ms := &mocks.MultiStore{}
+			cms := &mocks.CacheMultiStore{}
+
+			// Expect that the cached store is created and returned.
+			ms.On("CacheMultiStore").Return(cms).Once()
+
+			if tc.expectedError == nil {
+				// For non-error cases, expect that the cache is written to the underlying store.
+				cms.On("Write").Return(nil).Once()
+			}
+
+			ctx := sdk.NewContext(ms, tmproto.Header{}, false, log.NewNopLogger())
+
+			err := abci.RunCached(ctx, tc.f)
+
+			if tc.expectedError != nil {
+				require.ErrorContains(t, err, tc.expectedError.Error())
+				require.Len(t, ctx.EventManager().Events(), 0)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, ctx.EventManager().Events(), sdk.Events{testEvent})
+			}
+
+			ms.AssertExpectations(t)
+			cms.AssertExpectations(t)
+		})
+	}
+}

protocol/mocks/Makefile

@@ -10,6 +10,8 @@ mock-clean:
 mock-gen:
 	@go run github.com/vektra/mockery/v2 --name=InterfaceRegistry --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/codec --recursive --output=./mocks
 	@go run github.com/vektra/mockery/v2 --name=Configurator --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/types --recursive --output=./mocks
+	@go run github.com/vektra/mockery/v2 --name=MultiStore --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/store/types --recursive --output=./mocks
+	@go run github.com/vektra/mockery/v2 --name=CacheMultiStore --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/store/types --recursive --output=./mocks
 	@go run github.com/vektra/mockery/v2 --name=AnteDecorator --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/types --recursive --output=./mocks
 	@go run github.com/vektra/mockery/v2 --name=TxConfig --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/client --recursive --output=./mocks
 	@go run github.com/vektra/mockery/v2 --name=TxBuilder --dir=$(GOPATH)/pkg/mod/github.com/dydxprotocol/cosmos-sdk@$(COSMOS_VERSION)/client --recursive --output=./mocks