feat: Integrating POB into sim-app base app. (#130)

Co-authored-by: Aleksandr Bezobchuk <aleks.bezobchuk@gmail.com>

tests/app/ante.go

@@ -0,0 +1,55 @@
+package app
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/ante"
+	"github.com/skip-mev/pob/mempool"
+	builderante "github.com/skip-mev/pob/x/builder/ante"
+	builderkeeper "github.com/skip-mev/pob/x/builder/keeper"
+)
+
+type POBHandlerOptions struct {
+	BaseOptions   ante.HandlerOptions
+	Mempool       mempool.Mempool
+	TxDecoder     sdk.TxDecoder
+	TxEncoder     sdk.TxEncoder
+	BuilderKeeper builderkeeper.Keeper
+}
+
+// NewPOBAnteHandler wraps all of the default Cosmos SDK AnteDecorators with the POB AnteHandler.
+func NewPOBAnteHandler(options POBHandlerOptions) sdk.AnteHandler {
+	if options.BaseOptions.AccountKeeper == nil {
+		panic("account keeper is required for ante builder")
+	}
+
+	if options.BaseOptions.BankKeeper == nil {
+		panic("bank keeper is required for ante builder")
+	}
+
+	if options.BaseOptions.SignModeHandler == nil {
+		panic("sign mode handler is required for ante builder")
+	}
+
+	anteDecorators := []sdk.AnteDecorator{
+		ante.NewSetUpContextDecorator(), // outermost AnteDecorator. SetUpContext must be called first
+		ante.NewExtensionOptionsDecorator(options.BaseOptions.ExtensionOptionChecker),
+		ante.NewValidateBasicDecorator(),
+		ante.NewTxTimeoutHeightDecorator(),
+		ante.NewValidateMemoDecorator(options.BaseOptions.AccountKeeper),
+		ante.NewConsumeGasForTxSizeDecorator(options.BaseOptions.AccountKeeper),
+		ante.NewDeductFeeDecorator(
+			options.BaseOptions.AccountKeeper,
+			options.BaseOptions.BankKeeper,
+			options.BaseOptions.FeegrantKeeper,
+			options.BaseOptions.TxFeeChecker,
+		),
+		ante.NewSetPubKeyDecorator(options.BaseOptions.AccountKeeper), // SetPubKeyDecorator must be called before all signature verification decorators
+		ante.NewValidateSigCountDecorator(options.BaseOptions.AccountKeeper),
+		ante.NewSigGasConsumeDecorator(options.BaseOptions.AccountKeeper, options.BaseOptions.SigGasConsumer),
+		ante.NewSigVerificationDecorator(options.BaseOptions.AccountKeeper, options.BaseOptions.SignModeHandler),
+		ante.NewIncrementSequenceDecorator(options.BaseOptions.AccountKeeper),
+		builderante.NewBuilderDecorator(options.BuilderKeeper, options.TxDecoder, options.TxEncoder, options.Mempool),
+	}
+
+	return sdk.ChainAnteDecorators(anteDecorators...)
+}

tests/app/app.go

@@ -25,6 +25,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/cosmos/cosmos-sdk/x/auth"
+	"github.com/cosmos/cosmos-sdk/x/auth/ante"
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config" // import for side-effects
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
@@ -65,6 +66,10 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/upgrade"
 	upgradeclient "github.com/cosmos/cosmos-sdk/x/upgrade/client"
 	upgradekeeper "github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
+	"github.com/skip-mev/pob/abci"
+	"github.com/skip-mev/pob/mempool"
+	buildermodule "github.com/skip-mev/pob/x/builder"
+	builderkeeper "github.com/skip-mev/pob/x/builder/keeper"
 )
 
 var (
@@ -102,6 +107,7 @@ var (
 		vesting.AppModuleBasic{},
 		nftmodule.AppModuleBasic{},
 		consensus.AppModuleBasic{},
+		buildermodule.AppModuleBasic{},
 	)
 )
 
@@ -135,6 +141,7 @@ type TestApp struct {
 	FeeGrantKeeper        feegrantkeeper.Keeper
 	GroupKeeper           groupkeeper.Keeper
 	ConsensusParamsKeeper consensuskeeper.Keeper
+	BuilderKeeper         builderkeeper.Keeper
 }
 
 func init() {
@@ -212,6 +219,7 @@ func New(
 		&app.EvidenceKeeper,
 		&app.FeeGrantKeeper,
 		&app.GroupKeeper,
+		&app.BuilderKeeper,
 		&app.ConsensusParamsKeeper,
 	); err != nil {
 		panic(err)
@@ -245,6 +253,39 @@ func New(
 
 	app.App = appBuilder.Build(logger, db, traceStore, baseAppOptions...)
 
+	// Set POB's mempool into the app.
+	mempool := mempool.NewAuctionMempool(app.txConfig.TxDecoder(), app.txConfig.TxEncoder(), 0, mempool.NewDefaultAuctionFactory(app.txConfig.TxDecoder()))
+	app.App.SetMempool(mempool)
+
+	// Create a global ante handler that will be called on each transaction when
+	// proposals are being built and verified.
+	handlerOptions := ante.HandlerOptions{
+		AccountKeeper:   app.AccountKeeper,
+		BankKeeper:      app.BankKeeper,
+		FeegrantKeeper:  app.FeeGrantKeeper,
+		SigGasConsumer:  ante.DefaultSigVerificationGasConsumer,
+		SignModeHandler: app.txConfig.SignModeHandler(),
+	}
+	options := POBHandlerOptions{
+		BaseOptions:   handlerOptions,
+		BuilderKeeper: app.BuilderKeeper,
+		Mempool:       mempool,
+		TxDecoder:     app.txConfig.TxDecoder(),
+		TxEncoder:     app.txConfig.TxEncoder(),
+	}
+	anteHandler := NewPOBAnteHandler(options)
+
+	// Set the proposal handlers on the BaseApp.
+	proposalHandlers := abci.NewProposalHandler(
+		mempool,
+		app.App.Logger(),
+		anteHandler,
+		options.TxEncoder,
+		options.TxDecoder,
+	)
+	app.App.SetPrepareProposal(proposalHandlers.PrepareProposalHandler())
+	app.App.SetProcessProposal(proposalHandlers.ProcessProposalHandler())
+
 	// load state streaming if enabled
 	if _, _, err := streaming.LoadStreamingServices(app.App.BaseApp, appOpts, app.appCodec, logger, app.kvStoreKeys()); err != nil {
 		logger.Error("failed to load state streaming", "err", err)

tests/app/config.go

@@ -43,6 +43,8 @@ import (
 	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	buildermodulev1 "github.com/skip-mev/pob/api/pob/builder/module/v1"
+	buildertypes "github.com/skip-mev/pob/x/builder/types"
 	"google.golang.org/protobuf/types/known/durationpb"
 )
 
@@ -59,7 +61,7 @@ var (
 		distrtypes.ModuleName, stakingtypes.ModuleName, slashingtypes.ModuleName, govtypes.ModuleName,
 		minttypes.ModuleName, crisistypes.ModuleName, genutiltypes.ModuleName, evidencetypes.ModuleName, authz.ModuleName,
 		feegrant.ModuleName, group.ModuleName, paramstypes.ModuleName, upgradetypes.ModuleName,
-		vestingtypes.ModuleName, consensustypes.ModuleName,
+		vestingtypes.ModuleName, consensustypes.ModuleName, buildertypes.ModuleName,
 	}
 
 	// module account permissions
@@ -70,6 +72,7 @@ var (
 		{Account: stakingtypes.BondedPoolName, Permissions: []string{authtypes.Burner, stakingtypes.ModuleName}},
 		{Account: stakingtypes.NotBondedPoolName, Permissions: []string{authtypes.Burner, stakingtypes.ModuleName}},
 		{Account: govtypes.ModuleName, Permissions: []string{authtypes.Burner}},
+		{Account: buildertypes.ModuleName, Permissions: []string{}},
 	}
 
 	// blocked account addresses
@@ -113,6 +116,7 @@ var (
 						group.ModuleName,
 						paramstypes.ModuleName,
 						vestingtypes.ModuleName,
+						buildertypes.ModuleName,
 						consensustypes.ModuleName,
 					},
 					EndBlockers: []string{
@@ -134,6 +138,7 @@ var (
 						consensustypes.ModuleName,
 						upgradetypes.ModuleName,
 						vestingtypes.ModuleName,
+						buildertypes.ModuleName,
 					},
 					OverrideStoreKeys: []*runtimev1alpha1.StoreKeyConfig{
 						{
@@ -238,6 +243,10 @@ var (
 				Name:   consensustypes.ModuleName,
 				Config: appconfig.WrapAny(&consensusmodulev1.Module{}),
 			},
+			{
+				Name:   buildertypes.ModuleName,
+				Config: appconfig.WrapAny(&buildermodulev1.Module{}),
+			},
 		},
 	})
 )