diff --git a/baseapp/abci.go b/baseapp/abci.go index fb9ed37dd..33b675fa4 100644 --- a/baseapp/abci.go +++ b/baseapp/abci.go @@ -34,6 +34,10 @@ const ( // InitChain implements the ABCI interface. It runs the initialization logic // directly on the CommitMultiStore. func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain) { + if req.ChainId != app.chainID { + panic(fmt.Sprintf("invalid chain-id on InitChain; expected: %s, got: %s", app.chainID, req.ChainId)) + } + // On a new chain, we consider the init chain block height as 0, even though // req.InitialHeight is 1 by default. initHeader := tmproto.Header{ChainID: req.ChainId, Time: req.Time} @@ -54,8 +58,14 @@ func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitC // initialize states with a correct header app.setState(runTxModeDeliver, initHeader) app.setState(runTxModeCheck, initHeader) - app.setState(runTxPrepareProposal, initHeader) - app.setState(runTxProcessProposal, initHeader) + + // Use an empty header for prepare and process proposal states. The header + // will be overwritten for the first block (see getContextForProposal()) and + // cleaned up on every Commit(). Only the ChainID is needed so it's set in + // the context. + emptyHeader := tmproto.Header{ChainID: req.ChainId} + app.setState(runTxPrepareProposal, emptyHeader) + app.setState(runTxProcessProposal, emptyHeader) // Store the consensus params in the BaseApp's paramstore. Note, this must be // done after the deliver state and context have been set as it's persisted @@ -148,6 +158,10 @@ func (app *BaseApp) FilterPeerByID(info string) abci.ResponseQuery { // BeginBlock implements the ABCI application interface. func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeginBlock) { + if req.Header.ChainID != app.chainID { + panic(fmt.Sprintf("invalid chain-id on BeginBlock; expected: %s, got: %s", app.chainID, req.Header.ChainID)) + } + if app.cms.TracingEnabled() { app.cms.SetTracingContext(sdk.TraceContext( map[string]interface{}{"blockHeight": req.Header.Height}, @@ -250,15 +264,15 @@ func (app *BaseApp) PrepareProposal(req abci.RequestPrepareProposal) (resp abci. panic("PrepareProposal called with invalid height") } - gasMeter := app.getBlockGasMeter(app.prepareProposalState.ctx) - ctx := app.getContextForProposal(app.prepareProposalState.ctx, req.Height) - - ctx = ctx.WithVoteInfos(app.voteInfos). + app.prepareProposalState.ctx = app.getContextForProposal(app.prepareProposalState.ctx, req.Height). + WithVoteInfos(app.voteInfos). WithBlockHeight(req.Height). WithBlockTime(req.Time). - WithProposer(req.ProposerAddress). - WithConsensusParams(app.GetConsensusParams(ctx)). - WithBlockGasMeter(gasMeter) + WithProposer(req.ProposerAddress) + + app.prepareProposalState.ctx = app.prepareProposalState.ctx. + WithConsensusParams(app.GetConsensusParams(app.prepareProposalState.ctx)). + WithBlockGasMeter(app.getBlockGasMeter(app.prepareProposalState.ctx)) defer func() { if err := recover(); err != nil { @@ -273,7 +287,7 @@ func (app *BaseApp) PrepareProposal(req abci.RequestPrepareProposal) (resp abci. } }() - resp = app.prepareProposal(ctx, req) + resp = app.prepareProposal(app.prepareProposalState.ctx, req) return resp } @@ -297,17 +311,16 @@ func (app *BaseApp) ProcessProposal(req abci.RequestProcessProposal) (resp abci. panic("app.ProcessProposal is not set") } - gasMeter := app.getBlockGasMeter(app.processProposalState.ctx) - ctx := app.getContextForProposal(app.processProposalState.ctx, req.Height) - - ctx = ctx. + app.processProposalState.ctx = app.getContextForProposal(app.processProposalState.ctx, req.Height). WithVoteInfos(app.voteInfos). WithBlockHeight(req.Height). WithBlockTime(req.Time). WithHeaderHash(req.Hash). - WithProposer(req.ProposerAddress). - WithConsensusParams(app.GetConsensusParams(ctx)). - WithBlockGasMeter(gasMeter) + WithProposer(req.ProposerAddress) + + app.processProposalState.ctx = app.processProposalState.ctx. + WithConsensusParams(app.GetConsensusParams(app.processProposalState.ctx)). + WithBlockGasMeter(app.getBlockGasMeter(app.processProposalState.ctx)) defer func() { if err := recover(); err != nil { @@ -322,7 +335,7 @@ func (app *BaseApp) ProcessProposal(req abci.RequestProcessProposal) (resp abci. } }() - resp = app.processProposal(ctx, req) + resp = app.processProposal(app.processProposalState.ctx, req) return resp } @@ -436,8 +449,12 @@ func (app *BaseApp) Commit() abci.ResponseCommit { // NOTE: This is safe because Tendermint holds a lock on the mempool for // Commit. Use the header from this latest block. app.setState(runTxModeCheck, header) - app.setState(runTxPrepareProposal, header) - app.setState(runTxProcessProposal, header) + + // Reset state to the latest committed but with an empty header to avoid + // leaking the header from the last block. + emptyHeader := tmproto.Header{ChainID: app.chainID} + app.setState(runTxPrepareProposal, emptyHeader) + app.setState(runTxProcessProposal, emptyHeader) // empty/reset the deliver state app.deliverState = nil @@ -955,6 +972,8 @@ func SplitABCIQueryPath(requestPath string) (path []string) { func (app *BaseApp) getContextForProposal(ctx sdk.Context, height int64) sdk.Context { if height == 1 { ctx, _ = app.deliverState.ctx.CacheContext() + // clear all context data set during InitChain to avoid inconsistent behavior + ctx = ctx.WithBlockHeader(tmproto.Header{}) return ctx } return ctx diff --git a/baseapp/abci_test.go b/baseapp/abci_test.go index d2aee6d44..0d7bc456a 100644 --- a/baseapp/abci_test.go +++ b/baseapp/abci_test.go @@ -43,7 +43,7 @@ func TestABCI_InitChain(t *testing.T) { name := t.Name() db := dbm.NewMemDB() logger := defaultLogger() - app := baseapp.NewBaseApp(name, logger, db, nil) + app := baseapp.NewBaseApp(name, logger, db, nil, baseapp.SetChainID("test-chain-id")) capKey := sdk.NewKVStoreKey("main") capKey2 := sdk.NewKVStoreKey("key2") @@ -62,8 +62,13 @@ func TestABCI_InitChain(t *testing.T) { Data: key, } + // initChain is nil and chain ID is wrong - panics + require.Panics(t, func() { + app.InitChain(abci.RequestInitChain{ChainId: "wrong-chain-id"}) + }) + // initChain is nil - nothing happens - app.InitChain(abci.RequestInitChain{}) + app.InitChain(abci.RequestInitChain{ChainId: "test-chain-id"}) res := app.Query(query) require.Equal(t, 0, len(res.Value)) diff --git a/baseapp/baseapp.go b/baseapp/baseapp.go index 7f70a0d83..605c36c5c 100644 --- a/baseapp/baseapp.go +++ b/baseapp/baseapp.go @@ -11,6 +11,9 @@ import ( "github.com/cometbft/cometbft/crypto/tmhash" "github.com/cometbft/cometbft/libs/log" tmproto "github.com/cometbft/cometbft/proto/tendermint/types" + "github.com/cosmos/gogoproto/proto" + "golang.org/x/exp/maps" + codectypes "github.com/cosmos/cosmos-sdk/codec/types" "github.com/cosmos/cosmos-sdk/snapshots" "github.com/cosmos/cosmos-sdk/store" @@ -19,8 +22,6 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" "github.com/cosmos/cosmos-sdk/types/mempool" - "github.com/cosmos/gogoproto/proto" - "golang.org/x/exp/maps" ) type ( @@ -142,6 +143,8 @@ type BaseApp struct { //nolint: maligned // abciListeners for hooking into the ABCI message processing of the BaseApp // and exposing the requests and responses to external consumers abciListeners []ABCIListener + + chainID string } // NewBaseApp returns a reference to an initialized BaseApp. It accepts a @@ -349,7 +352,7 @@ func (app *BaseApp) Init() error { panic("cannot call initFromMainStore: baseapp already sealed") } - emptyHeader := tmproto.Header{} + emptyHeader := tmproto.Header{ChainID: app.chainID} // needed for the export command which inits from store but never calls initchain app.setState(runTxModeCheck, emptyHeader) diff --git a/baseapp/options.go b/baseapp/options.go index c3ba9f649..e669495f6 100644 --- a/baseapp/options.go +++ b/baseapp/options.go @@ -91,6 +91,11 @@ func SetMempool(mempool mempool.Mempool) func(*BaseApp) { return func(app *BaseApp) { app.SetMempool(mempool) } } +// SetChainID sets the chain ID in BaseApp. +func SetChainID(chainID string) func(*BaseApp) { + return func(app *BaseApp) { app.chainID = chainID } +} + func (app *BaseApp) SetName(name string) { if app.sealed { panic("SetName() on sealed BaseApp") diff --git a/server/rollback.go b/server/rollback.go index 87196b993..ae2a7e0a0 100644 --- a/server/rollback.go +++ b/server/rollback.go @@ -4,9 +4,10 @@ import ( "fmt" tmcmd "github.com/cometbft/cometbft/cmd/cometbft/commands" + "github.com/spf13/cobra" + "github.com/cosmos/cosmos-sdk/client/flags" "github.com/cosmos/cosmos-sdk/server/types" - "github.com/spf13/cobra" ) // NewRollbackCmd creates a command to rollback tendermint and multistore state by one height. diff --git a/server/util.go b/server/util.go index 25b6f2010..33262096d 100644 --- a/server/util.go +++ b/server/util.go @@ -20,6 +20,7 @@ import ( tmcli "github.com/cometbft/cometbft/libs/cli" tmflags "github.com/cometbft/cometbft/libs/cli/flags" tmlog "github.com/cometbft/cometbft/libs/log" + tmtypes "github.com/cometbft/cometbft/types" "github.com/spf13/cast" "github.com/spf13/cobra" "github.com/spf13/pflag" @@ -435,7 +436,19 @@ func DefaultBaseappOptions(appOpts types.AppOptions) []func(*baseapp.BaseApp) { panic(err) } - snapshotDir := filepath.Join(cast.ToString(appOpts.Get(flags.FlagHome)), "data", "snapshots") + homeDir := cast.ToString(appOpts.Get(flags.FlagHome)) + chainID := cast.ToString(appOpts.Get(flags.FlagChainID)) + if chainID == "" { + // fallback to genesis chain-id + appGenesis, err := tmtypes.GenesisDocFromFile(filepath.Join(homeDir, "config", "genesis.json")) + if err != nil { + panic(err) + } + + chainID = appGenesis.ChainID + } + + snapshotDir := filepath.Join(homeDir, "data", "snapshots") if err = os.MkdirAll(snapshotDir, os.ModePerm); err != nil { panic(fmt.Errorf("failed to create snapshots directory: %w", err)) } @@ -472,5 +485,6 @@ func DefaultBaseappOptions(appOpts types.AppOptions) []func(*baseapp.BaseApp) { ), ), baseapp.SetIAVLLazyLoading(cast.ToBool(appOpts.Get(FlagIAVLLazyLoading))), + baseapp.SetChainID(chainID), } } diff --git a/simapp/sim_test.go b/simapp/sim_test.go index 32ee379a2..5f9c3ca12 100644 --- a/simapp/sim_test.go +++ b/simapp/sim_test.go @@ -84,7 +84,7 @@ func TestFullAppSimulation(t *testing.T) { appOptions[flags.FlagHome] = DefaultNodeHome appOptions[server.FlagInvCheckPeriod] = simcli.FlagPeriodValue - app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt) + app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt, baseapp.SetChainID(SimAppChainID)) require.Equal(t, "SimApp", app.Name()) // run randomized simulation @@ -129,7 +129,7 @@ func TestAppImportExport(t *testing.T) { appOptions[flags.FlagHome] = DefaultNodeHome appOptions[server.FlagInvCheckPeriod] = simcli.FlagPeriodValue - app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt) + app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt, baseapp.SetChainID(SimAppChainID)) require.Equal(t, "SimApp", app.Name()) // Run randomized simulation @@ -169,7 +169,7 @@ func TestAppImportExport(t *testing.T) { require.NoError(t, os.RemoveAll(newDir)) }() - newApp := NewSimApp(log.NewNopLogger(), newDB, nil, true, appOptions, fauxMerkleModeOpt) + newApp := NewSimApp(log.NewNopLogger(), newDB, nil, true, appOptions, fauxMerkleModeOpt, baseapp.SetChainID(SimAppChainID)) require.Equal(t, "SimApp", newApp.Name()) var genesisState GenesisState @@ -245,7 +245,7 @@ func TestAppSimulationAfterImport(t *testing.T) { appOptions[flags.FlagHome] = DefaultNodeHome appOptions[server.FlagInvCheckPeriod] = simcli.FlagPeriodValue - app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt) + app := NewSimApp(logger, db, nil, true, appOptions, fauxMerkleModeOpt, baseapp.SetChainID(SimAppChainID)) require.Equal(t, "SimApp", app.Name()) // Run randomized simulation @@ -290,10 +290,11 @@ func TestAppSimulationAfterImport(t *testing.T) { require.NoError(t, os.RemoveAll(newDir)) }() - newApp := NewSimApp(log.NewNopLogger(), newDB, nil, true, appOptions, fauxMerkleModeOpt) + newApp := NewSimApp(log.NewNopLogger(), newDB, nil, true, appOptions, fauxMerkleModeOpt, baseapp.SetChainID(SimAppChainID)) require.Equal(t, "SimApp", newApp.Name()) newApp.InitChain(abci.RequestInitChain{ + ChainId: SimAppChainID, AppStateBytes: exported.AppState, }) @@ -345,7 +346,7 @@ func TestAppStateDeterminism(t *testing.T) { } db := dbm.NewMemDB() - app := NewSimApp(logger, db, nil, true, appOptions, interBlockCacheOpt()) + app := NewSimApp(logger, db, nil, true, appOptions, interBlockCacheOpt(), baseapp.SetChainID(SimAppChainID)) fmt.Printf( "running non-determinism simulation; seed %d: %d/%d, attempt: %d/%d\n", diff --git a/simapp/test_helpers.go b/simapp/test_helpers.go index dfa0aa4ec..de9cc9cd9 100644 --- a/simapp/test_helpers.go +++ b/simapp/test_helpers.go @@ -231,6 +231,7 @@ func NewTestNetworkFixture() network.TestFixture { simtestutil.NewAppOptionsWithFlagHome(val.GetCtx().Config.RootDir), bam.SetPruning(pruningtypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)), bam.SetMinGasPrices(val.GetAppConfig().MinGasPrices), + bam.SetChainID(val.GetCtx().Viper.GetString(flags.FlagChainID)), ) } diff --git a/tests/e2e/params/suite.go b/tests/e2e/params/suite.go index bbb018f80..bd4f45c94 100644 --- a/tests/e2e/params/suite.go +++ b/tests/e2e/params/suite.go @@ -71,6 +71,7 @@ func (s *E2ETestSuite) SetupSuite() { nil, baseapp.SetPruning(pruningtypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)), baseapp.SetMinGasPrices(val.GetAppConfig().MinGasPrices), + baseapp.SetChainID(s.cfg.ChainID), ) s.Require().NoError(app.Load(false)) diff --git a/tests/integration/gov/module_test.go b/tests/integration/gov/module_test.go index f7216d34d..ef1153415 100644 --- a/tests/integration/gov/module_test.go +++ b/tests/integration/gov/module_test.go @@ -11,6 +11,8 @@ import ( "github.com/stretchr/testify/require" "cosmossdk.io/simapp" + + "github.com/cosmos/cosmos-sdk/baseapp" "github.com/cosmos/cosmos-sdk/client/flags" "github.com/cosmos/cosmos-sdk/server" simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims" @@ -25,7 +27,7 @@ func TestItCreatesModuleAccountOnInitBlock(t *testing.T) { appOptions[flags.FlagHome] = simapp.DefaultNodeHome appOptions[server.FlagInvCheckPeriod] = 5 - app := simapp.NewSimApp(log.NewNopLogger(), db, nil, true, appOptions) + app := simapp.NewSimApp(log.NewNopLogger(), db, nil, true, appOptions, baseapp.SetChainID("test-chain-id")) genesisState := simapp.GenesisStateWithSingleValidator(t, app) stateBytes, err := tmjson.Marshal(genesisState) diff --git a/testutil/network/network.go b/testutil/network/network.go index 517151de9..d6e1691a3 100644 --- a/testutil/network/network.go +++ b/testutil/network/network.go @@ -24,12 +24,15 @@ import ( "cosmossdk.io/math" tmlog "github.com/cometbft/cometbft/libs/log" + "github.com/cosmos/cosmos-sdk/testutil/configurator" "github.com/cosmos/cosmos-sdk/testutil/testdata" "cosmossdk.io/depinject" + "github.com/cosmos/cosmos-sdk/baseapp" "github.com/cosmos/cosmos-sdk/client" + "github.com/cosmos/cosmos-sdk/client/flags" "github.com/cosmos/cosmos-sdk/client/tx" "github.com/cosmos/cosmos-sdk/codec" codectypes "github.com/cosmos/cosmos-sdk/codec/types" @@ -184,6 +187,7 @@ func DefaultConfigWithAppConfig(appConfig depinject.Config) (Config, error) { nil, baseapp.SetPruning(pruningtypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)), baseapp.SetMinGasPrices(val.GetAppConfig().MinGasPrices), + baseapp.SetChainID(cfg.ChainID), ) testdata.RegisterQueryServer(app.GRPCQueryRouter(), testdata.QueryImpl{}) @@ -546,6 +550,9 @@ func New(l Logger, baseDir string, cfg Config) (*Network, error) { WithTxConfig(cfg.TxConfig). WithAccountRetriever(cfg.AccountRetriever) + // Provide ChainID here since we can't modify it in the Comet config. + ctx.Viper.Set(flags.FlagChainID, cfg.ChainID) + network.Validators[i] = &Validator{ AppConfig: appCfg, ClientCtx: clientCtx,