feat: add endblocker with valsetupdate type

baseapp/abci.go

@@ -252,6 +252,9 @@ func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBloc
 		}
 	}
 
+	// set the validator set for the next block
+	res.ValidatorUpdates = app.updatedValidators
+
 	return res
 }
 

baseapp/baseapp.go

@@ -74,6 +74,8 @@ type BaseApp struct {
 	idPeerFilter    sdk.PeerFilter             // filter peers by node ID
 	fauxMerkleMode  bool                       // if true, IAVL MountStores uses MountStoresDB for simulation speed.
 
+	ValidatorSetUpdate // absorb validator setupdate type
+
 	// manages snapshots, i.e. dumps of app state at certain intervals
 	snapshotManager *snapshots.Manager
 
@@ -227,6 +229,11 @@ func (app *BaseApp) SetMsgServiceRouter(msgServiceRouter *MsgServiceRouter) {
 	app.msgServiceRouter = msgServiceRouter
 }
 
+// ValidatorService returns the ValidatorUpdateService of a BaseApp.
+func (app *BaseApp) ValidatorService() ValidatorUpdateService {
+	return app
+}
+
 // MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp
 // multistore.
 func (app *BaseApp) MountStores(keys ...storetypes.StoreKey) {

baseapp/valset_update.go

@@ -0,0 +1,22 @@
+package baseapp
+
+import (
+	"context"
+
+	abci "github.com/cometbft/cometbft/abci/types"
+)
+
+// ValidatorUpdateService is the service that runtime will provide to the module that sets validator updates.
+type ValidatorUpdateService interface {
+	SetValidatorUpdates(context.Context, []abci.ValidatorUpdate)
+}
+
+var _ = (ValidatorUpdateService)(&ValidatorSetUpdate{})
+
+type ValidatorSetUpdate struct {
+	updatedValidators []abci.ValidatorUpdate
+}
+
+func (v *ValidatorSetUpdate) SetValidatorUpdates(ctx context.Context, updates []abci.ValidatorUpdate) {
+	v.updatedValidators = updates
+}

runtime/app.go

@@ -1,16 +1,15 @@
 package runtime
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 
-	abci "github.com/cometbft/cometbft/abci/types"
-	"golang.org/x/exp/slices"
-
 	runtimev1alpha1 "cosmossdk.io/api/cosmos/app/runtime/v1alpha1"
 	appv1alpha1 "cosmossdk.io/api/cosmos/app/v1alpha1"
-
 	storetypes "cosmossdk.io/store/types"
+	abci "github.com/cometbft/cometbft/abci/types"
+	"golang.org/x/exp/slices"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/client"
@@ -52,6 +51,8 @@ type App struct {
 	// initChainer is the init chainer function defined by the app config.
 	// this is only required if the chain wants to add special InitChainer logic.
 	initChainer sdk.InitChainer
+
+	ValSetUpdate []abci.ValidatorUpdate
 }
 
 // RegisterModules registers the provided modules with the module manager and
@@ -125,6 +126,12 @@ func (a *App) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) (abci.Respon
 	return a.ModuleManager.EndBlock(ctx, req)
 }
 
+// SetValidatorUpdates sets the validator updates for the next block.
+// CONTRACT: this must be called for modules that are updating the validator set
+func (a *App) SetValidatorUpdates(ctx context.Context, updates []abci.ValidatorUpdate) {
+	a.BaseApp.SetValidatorUpdates(ctx, updates)
+}
+
 // InitChainer initializes the chain.
 func (a *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) (abci.ResponseInitChain, error) {
 	var genesisState map[string]json.RawMessage

runtime/module.go

@@ -209,3 +209,7 @@ func ProvideTransientStoreService(key depinject.ModuleKey, app *AppBuilder) stor
 func ProvideEventService() event.Service {
 	return EventService{}
 }
+
+func ProvideSetValidatorService(ab *AppBuilder) baseapp.ValidatorUpdateService {
+	return ab.app
+}

runtime/services.go

@@ -1,8 +1,6 @@
 package runtime
 
 import (
-	"context"
-
 	appv1alpha1 "cosmossdk.io/api/cosmos/app/v1alpha1"
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	reflectionv1 "cosmossdk.io/api/cosmos/reflection/v1"
@@ -26,14 +24,9 @@ func (a *App) registerRuntimeServices(cfg module.Configurator) error {
 }
 
 // ======================================================
-// ValidatorUpdateService & BlockInfoService
+//  BlockInfoService
 // ======================================================
 
-// ValidatorUpdateService is the service that runtime will provide to the module that sets validator updates.
-type ValidatorUpdateService interface {
-	SetValidatorUpdates(context.Context, []abci.ValidatorUpdate)
-}
-
 // BlockInfoService is the service that runtime will provide to modules which need Comet block information.
 type BlockInfoService interface {
 	GetHeight() int64                // GetHeight returns the height of the block

simapp/app.go

@@ -299,7 +299,7 @@ func NewSimApp(
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 	app.StakingKeeper = stakingkeeper.NewKeeper(
-		appCodec, keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+		appCodec, keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, authtypes.NewModuleAddress(govtypes.ModuleName).String(), app.BaseApp,
 	)
 	app.MintKeeper = mintkeeper.NewKeeper(appCodec, keys[minttypes.StoreKey], app.StakingKeeper, app.AccountKeeper, app.BankKeeper, authtypes.FeeCollectorName, authtypes.NewModuleAddress(govtypes.ModuleName).String())
 

x/staking/abci.go

@@ -11,14 +11,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/staking/types"
 )
 
-// BeginBlocker will persist the current header and validator set as a historical entry
-// and prune the oldest entry based on the HistoricalEntries parameter
-func BeginBlocker(ctx sdk.Context, k *keeper.Keeper) {
-	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
-
-	k.TrackHistoricalInfo(ctx)
-}
-
 // Called every block, update validator set
 func EndBlocker(ctx sdk.Context, k *keeper.Keeper) []abci.ValidatorUpdate {
 	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyEndBlocker)

x/staking/keeper/abci.go

@@ -0,0 +1,25 @@
+package keeper
+
+import (
+	"context"
+	"time"
+
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/staking/types"
+)
+
+// BeginBlocker will persist the current header and validator set as a historical entry
+// and prune the oldest entry based on the HistoricalEntries parameter
+func (k *Keeper) BeginBlocker(ctx sdk.Context) {
+	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
+
+	k.TrackHistoricalInfo(ctx)
+}
+
+// Called every block, update validator set
+func (k *Keeper) EndBlocker(ctx context.Context) {
+	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyEndBlocker)
+
+	k.validatorService.SetValidatorUpdates(ctx, k.BlockValidatorUpdates(sdk.UnwrapSDKContext(ctx)))
+}

x/staking/keeper/keeper.go

@@ -8,6 +8,7 @@ import (
 	abci "github.com/cometbft/cometbft/abci/types"
 
 	storetypes "cosmossdk.io/store/types"
+	"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/staking/types"
@@ -27,6 +28,8 @@ type Keeper struct {
 	bankKeeper types.BankKeeper
 	hooks      types.StakingHooks
 	authority  string
+
+	validatorService baseapp.ValidatorUpdateService
 }
 
 // NewKeeper creates a new staking Keeper instance
@@ -36,6 +39,7 @@ func NewKeeper(
 	ak types.AccountKeeper,
 	bk types.BankKeeper,
 	authority string,
+	vs baseapp.ValidatorUpdateService,
 ) *Keeper {
 	// ensure bonded and not bonded module accounts are set
 	if addr := ak.GetModuleAddress(types.BondedPoolName); addr == nil {
@@ -46,18 +50,23 @@ func NewKeeper(
 		panic(fmt.Sprintf("%s module account has not been set", types.NotBondedPoolName))
 	}
 
+	if vs == nil {
+		panic("validator service not set")
+	}
+
 	// ensure that authority is a valid AccAddress
 	if _, err := ak.StringToBytes(authority); err != nil {
 		panic("authority is not a valid acc address")
 	}
 
 	return &Keeper{
-		storeKey:   key,
-		cdc:        cdc,
-		authKeeper: ak,
-		bankKeeper: bk,
-		hooks:      nil,
-		authority:  authority,
+		storeKey:         key,
+		cdc:              cdc,
+		authKeeper:       ak,
+		bankKeeper:       bk,
+		hooks:            nil,
+		authority:        authority,
+		validatorService: vs,
 	}
 }
 

x/staking/keeper/keeper_test.go

@@ -60,6 +60,7 @@ func (s *KeeperTestSuite) SetupTest() {
 		accountKeeper,
 		bankKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+		&baseapp.ValidatorSetUpdate{},
 	)
 	keeper.SetParams(ctx, stakingtypes.DefaultParams())
 

x/staking/module.go

@@ -6,28 +6,26 @@ import (
 	"fmt"
 	"sort"
 
-	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
-	"github.com/cosmos/cosmos-sdk/x/staking/exported"
-
-	abci "github.com/cometbft/cometbft/abci/types"
-	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
-	"github.com/spf13/cobra"
-	"golang.org/x/exp/maps"
-
 	modulev1 "cosmossdk.io/api/cosmos/staking/module/v1"
 	"cosmossdk.io/core/appmodule"
 	"cosmossdk.io/depinject"
-
 	store "cosmossdk.io/store/types"
+	abci "github.com/cometbft/cometbft/abci/types"
+	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
+	"github.com/spf13/cobra"
+	"golang.org/x/exp/maps"
 
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 	"github.com/cosmos/cosmos-sdk/x/staking/client/cli"
+	"github.com/cosmos/cosmos-sdk/x/staking/exported"
 	"github.com/cosmos/cosmos-sdk/x/staking/keeper"
 	"github.com/cosmos/cosmos-sdk/x/staking/simulation"
 	"github.com/cosmos/cosmos-sdk/x/staking/types"
@@ -38,7 +36,9 @@ const (
 )
 
 var (
-	_ module.EndBlockAppModule   = AppModule{}
+	_ appmodule.AppModule        = AppModule{}
+	_ appmodule.HasBeginBlocker  = AppModule{}
+	_ appmodule.HasEndBlocker    = AppModule{}
 	_ module.AppModuleBasic      = AppModuleBasic{}
 	_ module.AppModuleSimulation = AppModule{}
 )
@@ -191,14 +191,16 @@ func (AppModule) ConsensusVersion() uint64 { return consensusVersion }
 // BeginBlock returns the begin blocker for the staking module.
 func (am AppModule) BeginBlock(ctx context.Context) error {
 	c := sdk.UnwrapSDKContext(ctx)
-	BeginBlocker(c, am.keeper)
+
+	am.keeper.BeginBlocker(c)
 	return nil
 }
 
 // EndBlock returns the end blocker for the staking module. It returns no validator
 // updates.
-func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate {
-	return EndBlocker(ctx, am.keeper)
+func (am AppModule) EndBlock(ctx context.Context) error {
+	am.keeper.EndBlocker(ctx)
+	return nil // handle error in the future
 }
 
 func init() {
@@ -218,6 +220,8 @@ type ModuleInputs struct {
 	Cdc           codec.Codec
 	Key           *store.KVStoreKey
 
+	Vs baseapp.ValidatorUpdateService
+
 	// LegacySubspace is used solely for migration of x/params managed parameters
 	LegacySubspace exported.Subspace
 }
@@ -243,6 +247,7 @@ func ProvideModule(in ModuleInputs) ModuleOutputs {
 		in.AccountKeeper,
 		in.BankKeeper,
 		authority.String(),
+		in.Vs,
 	)
 	m := NewAppModule(in.Cdc, k, in.AccountKeeper, in.BankKeeper, in.LegacySubspace)
 	return ModuleOutputs{StakingKeeper: k, Module: m}