Deprecate LoadLatest flag (#228)

## Describe your changes and provide context This flag is redundant since it should always be set to the opposite of DBSync.Enable (in tendermint config) ## Testing performed to validate your change loadtest cluster
sei-protocol · Apr 26, 2023 · ec35e9c · ec35e9c
1 parent 355f18b
commit ec35e9c
Show file tree

Hide file tree

Showing 27 changed files with 78 additions and 92 deletions.
diff --git a/baseapp/abci_test.go b/baseapp/abci_test.go
@@ -27,20 +27,20 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		expected     int64
 	}{
 		"defaults": {
-			bapp:         NewBaseApp(name, logger, db, nil, &testutil.TestAppOpts{}),
+			bapp:         NewBaseApp(name, logger, db, nil, nil, &testutil.TestAppOpts{}),
 			maxAgeBlocks: 0,
 			commitHeight: 499000,
 			expected:     0,
 		},
 		"pruning unbonding time only": {
-			bapp:         NewBaseApp(name, logger, db, nil, &testutil.TestAppOpts{}, SetMinRetainBlocks(1)),
+			bapp:         NewBaseApp(name, logger, db, nil, nil, &testutil.TestAppOpts{}, SetMinRetainBlocks(1)),
 			maxAgeBlocks: 362880,
 			commitHeight: 499000,
 			expected:     136120,
 		},
 		"pruning iavl snapshot only": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetPruning(sdk.PruningOptions{KeepEvery: 10000}),
 				SetMinRetainBlocks(1),
 			),
@@ -50,7 +50,7 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		},
 		"pruning state sync snapshot only": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetSnapshotInterval(50000),
 				SetSnapshotKeepRecent(3),
 				SetMinRetainBlocks(1),
@@ -61,7 +61,7 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		},
 		"pruning min retention only": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetMinRetainBlocks(400000),
 			),
 			maxAgeBlocks: 0,
@@ -70,7 +70,7 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		},
 		"pruning all conditions": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetPruning(sdk.PruningOptions{KeepEvery: 10000}),
 				SetMinRetainBlocks(400000),
 				SetSnapshotInterval(50000), SetSnapshotKeepRecent(3),
@@ -81,7 +81,7 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		},
 		"no pruning due to no persisted state": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetPruning(sdk.PruningOptions{KeepEvery: 10000}),
 				SetMinRetainBlocks(400000),
 				SetSnapshotInterval(50000), SetSnapshotKeepRecent(3),
@@ -92,7 +92,7 @@ func TestGetBlockRentionHeight(t *testing.T) {
 		},
 		"disable pruning": {
 			bapp: NewBaseApp(
-				name, logger, db, nil, &testutil.TestAppOpts{},
+				name, logger, db, nil, nil, &testutil.TestAppOpts{},
 				SetPruning(sdk.PruningOptions{KeepEvery: 10000}),
 				SetMinRetainBlocks(0),
 				SetSnapshotInterval(50000), SetSnapshotKeepRecent(3),
@@ -131,7 +131,7 @@ func TestBaseAppCreateQueryContext(t *testing.T) {
 	logger := defaultLogger()
 	db := dbm.NewMemDB()
 	name := t.Name()
-	app := NewBaseApp(name, logger, db, nil, &testutil.TestAppOpts{})
+	app := NewBaseApp(name, logger, db, nil, nil, &testutil.TestAppOpts{})
 
 	app.FinalizeBlock(context.Background(), &abci.RequestFinalizeBlock{Height: 1})
 	app.SetDeliverStateToCommit()

diff --git a/baseapp/baseapp.go b/baseapp/baseapp.go
@@ -152,7 +152,7 @@ type BaseApp struct { //nolint: maligned
 
 	compactionInterval uint64
 
-	tmConfig *tmcfg.Config
+	TmConfig *tmcfg.Config
 }
 
 type appStore struct {
@@ -207,7 +207,7 @@ type snapshotData struct {
 //
 // NOTE: The db is used to store the version number for now.
 func NewBaseApp(
-	name string, logger log.Logger, db dbm.DB, txDecoder sdk.TxDecoder, appOpts servertypes.AppOptions, options ...func(*BaseApp),
+	name string, logger log.Logger, db dbm.DB, txDecoder sdk.TxDecoder, tmConfig *tmcfg.Config, appOpts servertypes.AppOptions, options ...func(*BaseApp),
 ) *BaseApp {
 	cms := store.NewCommitMultiStore(db)
 	archivalVersion := cast.ToInt64(appOpts.Get(FlagArchivalVersion))
@@ -239,6 +239,7 @@ func NewBaseApp(
 			msgServiceRouter: NewMsgServiceRouter(),
 		},
 		txDecoder: txDecoder,
+		TmConfig:  tmConfig,
 	}
 
 	for _, option := range options {
@@ -259,10 +260,6 @@ func NewBaseApp(
 	return app
 }
 
-func (app *BaseApp) SetTendermintConfig(cfg *tmcfg.Config) {
-	app.tmConfig = cfg
-}
-
 // Name returns the name of the BaseApp.
 func (app *BaseApp) Name() string {
 	return app.name
@@ -1112,7 +1109,7 @@ func (app *BaseApp) ReloadDB() error {
 	if err := app.db.Close(); err != nil {
 		return err
 	}
-	db, err := sdk.NewLevelDB("application", app.tmConfig.DBDir())
+	db, err := sdk.NewLevelDB("application", app.TmConfig.DBDir())
 	if err != nil {
 		return err
 	}

diff --git a/baseapp/baseapp_test.go b/baseapp/baseapp_test.go
@@ -36,7 +36,7 @@ func newBaseApp(name string, options ...func(*BaseApp)) *BaseApp {
 	db := dbm.NewMemDB()
 	codec := codec.NewLegacyAmino()
 	registerTestCodec(codec)
-	return NewBaseApp(name, logger, db, testTxDecoder(codec), &testutil.TestAppOpts{}, options...)
+	return NewBaseApp(name, logger, db, testTxDecoder(codec), nil, &testutil.TestAppOpts{}, options...)
 }
 
 func registerTestCodec(cdc *codec.LegacyAmino) {
@@ -83,7 +83,7 @@ func TestLoadVersionPruning(t *testing.T) {
 	pruningOpt := SetPruning(pruningOptions)
 	db := dbm.NewMemDB()
 	name := t.Name()
-	app := NewBaseApp(name, logger, db, nil, &testutil.TestAppOpts{}, pruningOpt)
+	app := NewBaseApp(name, logger, db, nil, nil, &testutil.TestAppOpts{}, pruningOpt)
 
 	// make a cap key and mount the store
 	capKey := sdk.NewKVStoreKey("key1")
@@ -122,7 +122,7 @@ func TestLoadVersionPruning(t *testing.T) {
 	}
 
 	// reload with LoadLatestVersion, check it loads last version
-	app = NewBaseApp(name, logger, db, nil, &testutil.TestAppOpts{}, pruningOpt)
+	app = NewBaseApp(name, logger, db, nil, nil, &testutil.TestAppOpts{}, pruningOpt)
 	app.MountStores(capKey)
 
 	err = app.LoadLatestVersion()

diff --git a/baseapp/block_gas_test.go b/baseapp/block_gas_test.go
@@ -67,7 +67,7 @@ func TestBaseApp_BlockGas(t *testing.T) {
 			encCfg.InterfaceRegistry.RegisterImplementations((*sdk.Msg)(nil),
 				&testdata.TestMsg{},
 			)
-			app = simapp.NewSimApp(log.NewNopLogger(), dbm.NewMemDB(), nil, true, map[int64]bool{}, "", 0, encCfg, &simapp.EmptyAppOptions{}, routerOpt)
+			app = simapp.NewSimApp(log.NewNopLogger(), dbm.NewMemDB(), nil, true, map[int64]bool{}, "", 0, nil, encCfg, &simapp.EmptyAppOptions{}, routerOpt)
 			genState := simapp.NewDefaultGenesisState(encCfg.Marshaler)
 			stateBytes, err := json.MarshalIndent(genState, "", " ")
 			require.NoError(t, err)

diff --git a/baseapp/deliver_tx_test.go b/baseapp/deliver_tx_test.go
@@ -251,7 +251,7 @@ func TestBaseApp_EndBlock(t *testing.T) {
 	}
 
 	codec := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(codec), &testutil.TestAppOpts{})
+	app := NewBaseApp(name, logger, db, testTxDecoder(codec), nil, &testutil.TestAppOpts{})
 	app.SetParamStore(&paramStore{db: dbm.NewMemDB()})
 	app.InitChain(context.Background(), &abci.RequestInitChain{
 		ConsensusParams: cp,
@@ -1062,7 +1062,7 @@ func TestInitChainer(t *testing.T) {
 	db := dbm.NewMemDB()
 	logger := defaultLogger()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{})
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{})
 	capKey := sdk.NewKVStoreKey("main")
 	capKey2 := sdk.NewKVStoreKey("key2")
 	app.MountStores(capKey, capKey2)
@@ -1118,7 +1118,7 @@ func TestInitChainer(t *testing.T) {
 
 	// reload app
 	cc = codec.NewLegacyAmino()
-	app = NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{})
+	app = NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{})
 	app.SetInitChainer(initChainer)
 	app.MountStores(capKey, capKey2)
 	err = app.LoadLatestVersion() // needed to make stores non-nil
@@ -1146,7 +1146,7 @@ func TestInitChain_WithInitialHeight(t *testing.T) {
 	db := dbm.NewMemDB()
 	logger := defaultLogger()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{})
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{})
 
 	app.InitChain(
 		context.Background(), &abci.RequestInitChain{
@@ -1163,7 +1163,7 @@ func TestBeginBlock_WithInitialHeight(t *testing.T) {
 	db := dbm.NewMemDB()
 	logger := defaultLogger()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{})
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{})
 
 	app.InitChain(
 		context.Background(), &abci.RequestInitChain{
@@ -1539,7 +1539,7 @@ func TestOptionFunction(t *testing.T) {
 	logger := defaultLogger()
 	db := dbm.NewMemDB()
 	cc := codec.NewLegacyAmino()
-	bap := NewBaseApp("starting name", logger, db, testTxDecoder(cc), &testutil.TestAppOpts{}, testChangeNameHelper("new name"))
+	bap := NewBaseApp("starting name", logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, testChangeNameHelper("new name"))
 	require.Equal(t, bap.name, "new name", "BaseApp should have had name changed via option function")
 }
 
@@ -1631,7 +1631,7 @@ func TestVersionSetterGetter(t *testing.T) {
 	db := dbm.NewMemDB()
 	name := t.Name()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{}, pruningOpt)
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, pruningOpt)
 
 	require.Equal(t, "", app.Version())
 	res, _ := app.Query(context.Background(), &abci.RequestQuery{Path: "app/version"})
@@ -1652,7 +1652,7 @@ func TestLoadVersionInvalid(t *testing.T) {
 	db := dbm.NewMemDB()
 	name := t.Name()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{}, pruningOpt)
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, pruningOpt)
 
 	err := app.LoadLatestVersion()
 	require.Nil(t, err)
@@ -1670,7 +1670,7 @@ func TestLoadVersionInvalid(t *testing.T) {
 
 	// create a new app with the stores mounted under the same cap key
 	cc = codec.NewLegacyAmino()
-	app = NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{}, pruningOpt)
+	app = NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, pruningOpt)
 
 	// require we can load the latest version
 	err = app.LoadVersion(1)
@@ -1776,7 +1776,7 @@ func TestLoadVersion(t *testing.T) {
 	db := dbm.NewMemDB()
 	name := t.Name()
 	cc := codec.NewLegacyAmino()
-	app := NewBaseApp(name, logger, db, testTxDecoder(cc), &testutil.TestAppOpts{}, pruningOpt)
+	app := NewBaseApp(name, logger, db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, pruningOpt)
 
 	// make a cap key and mount the store
 	err := app.LoadLatestVersion() // needed to make stores non-nil
@@ -1878,7 +1878,7 @@ func TestSetLoader(t *testing.T) {
 				opts = append(opts, tc.setLoader)
 			}
 			cc := codec.NewLegacyAmino()
-			app := NewBaseApp(t.Name(), defaultLogger(), db, testTxDecoder(cc), &testutil.TestAppOpts{}, opts...)
+			app := NewBaseApp(t.Name(), defaultLogger(), db, testTxDecoder(cc), nil, &testutil.TestAppOpts{}, opts...)
 			app.MountStores(sdk.NewKVStoreKey(tc.loadStoreKey))
 			err := app.LoadLatestVersion()
 			require.Nil(t, err)

diff --git a/baseapp/grpcrouter_test.go b/baseapp/grpcrouter_test.go
@@ -2,9 +2,10 @@ package baseapp_test
 
 import (
 	"context"
-	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 	"testing"
 
+	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
+
 	"github.com/stretchr/testify/require"
 	"github.com/tendermint/tendermint/libs/log"
 	dbm "github.com/tendermint/tm-db"
@@ -55,7 +56,7 @@ func TestRegisterQueryServiceTwice(t *testing.T) {
 	// Setup baseapp.
 	db := dbm.NewMemDB()
 	encCfg := simapp.MakeTestEncodingConfig()
-	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), &testutil.TestAppOpts{})
+	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), nil, &testutil.TestAppOpts{})
 	app.SetInterfaceRegistry(encCfg.InterfaceRegistry)
 	testdata.RegisterInterfaces(encCfg.InterfaceRegistry)
 

diff --git a/baseapp/msg_service_router_test.go b/baseapp/msg_service_router_test.go
@@ -24,7 +24,7 @@ func TestRegisterMsgService(t *testing.T) {
 
 	// Create an encoding config that doesn't register testdata Msg services.
 	encCfg := simapp.MakeTestEncodingConfig()
-	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), &testutil.TestAppOpts{})
+	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), nil, &testutil.TestAppOpts{})
 	app.SetInterfaceRegistry(encCfg.InterfaceRegistry)
 	require.Panics(t, func() {
 		testdata.RegisterMsgServer(
@@ -47,7 +47,7 @@ func TestRegisterMsgServiceTwice(t *testing.T) {
 	// Setup baseapp.
 	db := dbm.NewMemDB()
 	encCfg := simapp.MakeTestEncodingConfig()
-	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), &testutil.TestAppOpts{})
+	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), nil, &testutil.TestAppOpts{})
 	app.SetInterfaceRegistry(encCfg.InterfaceRegistry)
 	testdata.RegisterInterfaces(encCfg.InterfaceRegistry)
 
@@ -73,7 +73,7 @@ func TestMsgService(t *testing.T) {
 	encCfg := simapp.MakeTestEncodingConfig()
 	testdata.RegisterInterfaces(encCfg.InterfaceRegistry)
 	db := dbm.NewMemDB()
-	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), &testutil.TestAppOpts{})
+	app := baseapp.NewBaseApp("test", log.NewTestingLogger(t), db, encCfg.TxConfig.TxDecoder(), nil, &testutil.TestAppOpts{})
 	app.SetInterfaceRegistry(encCfg.InterfaceRegistry)
 	testdata.RegisterMsgServer(
 		app.MsgServiceRouter(),

diff --git a/client/pruning/main.go b/client/pruning/main.go
@@ -63,7 +63,7 @@ func PruningCmd(appCreator servertypes.AppCreator) *cobra.Command {
 			}
 
 			logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
-			app := appCreator(logger, db, nil, vp)
+			app := appCreator(logger, db, nil, nil, vp)
 			cms := app.CommitMultiStore()
 
 			rootMultiStore, ok := cms.(*rootmulti.Store)

diff --git a/server/config/config.go b/server/config/config.go
@@ -80,8 +80,6 @@ type BaseConfig struct {
 	// CompactionInterval sets (in seconds) the interval between forced levelDB
 	// compaction. A value of 0 means no forced levelDB
 	CompactionInterval uint64 `mapstructure:"compaction-interval"`
-
-	LoadLatest bool `mapstructure:"load-latest"`
 }
 
 // APIConfig defines the API listener configuration.
@@ -225,7 +223,6 @@ func DefaultConfig() *Config {
 			IAVLCacheSize:       781250, // 50 MB
 			IAVLDisableFastNode: true,
 			CompactionInterval:  0,
-			LoadLatest:          true,
 		},
 		Telemetry: telemetry.Config{
 			Enabled:      false,
@@ -294,7 +291,6 @@ func GetConfig(v *viper.Viper) (Config, error) {
 			IAVLCacheSize:       v.GetUint64("iavl-cache-size"),
 			IAVLDisableFastNode: v.GetBool("iavl-disable-fastnode"),
 			CompactionInterval:  v.GetUint64("compaction-interval"),
-			LoadLatest:          v.GetBool("load-latest"),
 		},
 		Telemetry: telemetry.Config{
 			ServiceName:             v.GetString("telemetry.service-name"),
@@ -349,12 +345,6 @@ func (c Config) ValidateBasic(tendermintConfig *tmcfg.Config) error {
 			"cannot enable state sync snapshots with '%s' pruning setting", storetypes.PruningOptionEverything,
 		)
 	}
-	if c.BaseConfig.LoadLatest && tendermintConfig.DBSync.Enable {
-		return sdkerrors.ErrAppConfig.Wrap("cannot load latest with DB sync enabled")
-	}
-	if !c.BaseConfig.LoadLatest && !tendermintConfig.DBSync.Enable {
-		return sdkerrors.ErrAppConfig.Wrap("shoulkd load latest with DB sync disabled")
-	}
 
 	return nil
 }
diff --git a/server/config/toml.go b/server/config/toml.go
@@ -65,9 +65,6 @@ min-retain-blocks = {{ .BaseConfig.MinRetainBlocks }}
 # InterBlockCache enables inter-block caching.
 inter-block-cache = {{ .BaseConfig.InterBlockCache }}
 
-# Whether to load the latest version of store immediately upon start
-load-latest = {{ .BaseConfig.LoadLatest }}
-
 # IndexEvents defines the set of events in the form {eventType}.{attributeKey},
 # which informs Tendermint what to index. If empty, all events will be indexed.
 #

diff --git a/server/export_test.go b/server/export_test.go
@@ -127,7 +127,7 @@ func setupApp(t *testing.T, tempDir string) (*simapp.SimApp, context.Context, *t
 	logger := log.NewTestingLogger(t)
 	db := dbm.NewMemDB()
 	encCfg := simapp.MakeTestEncodingConfig()
-	app := simapp.NewSimApp(logger, db, nil, true, map[int64]bool{}, tempDir, 0, encCfg, &simapp.EmptyAppOptions{})
+	app := simapp.NewSimApp(logger, db, nil, true, map[int64]bool{}, tempDir, 0, nil, encCfg, &simapp.EmptyAppOptions{})
 
 	serverCtx := server.NewDefaultContext()
 	serverCtx.Config.RootDir = tempDir
@@ -152,13 +152,13 @@ func setupApp(t *testing.T, tempDir string) (*simapp.SimApp, context.Context, *t
 
 			var simApp *simapp.SimApp
 			if height != -1 {
-				simApp = simapp.NewSimApp(logger, db, nil, false, map[int64]bool{}, "", 0, encCfg, &simapp.EmptyAppOptions{})
+				simApp = simapp.NewSimApp(logger, db, nil, false, map[int64]bool{}, "", 0, nil, encCfg, &simapp.EmptyAppOptions{})
 
 				if err := simApp.LoadHeight(height); err != nil {
 					return types.ExportedApp{}, err
 				}
 			} else {
-				simApp = simapp.NewSimApp(logger, db, nil, true, map[int64]bool{}, "", 0, encCfg, &simapp.EmptyAppOptions{})
+				simApp = simapp.NewSimApp(logger, db, nil, true, map[int64]bool{}, "", 0, nil, encCfg, &simapp.EmptyAppOptions{})
 			}
 
 			return simApp.ExportAppStateAndValidators(forZeroHeight, jailAllowedAddrs)