refactor(core,server): make commands not rely on server context (#20422)

Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

CHANGELOG.md

@@ -119,6 +119,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i
 
 ### API Breaking Changes
 
+* (server) [#20422](https://github.com/cosmos/cosmos-sdk/pull/20422) Deprecated `ServerContext`. To get `cmtcfg.Config` from cmd, use `client.GetCometConfigFromCmd(cmd)` instead of `server.GetServerContextFromCmd(cmd).Config`
 * (types)[#20369](https://github.com/cosmos/cosmos-sdk/pull/20369) The signature of `HasAminoCodec` has changed to accept a `core/legacy.Amino` interface instead of `codec.LegacyAmino`.
 * (x/simulation)[#20056](https://github.com/cosmos/cosmos-sdk/pull/20056) `SimulateFromSeed` now takes an address codec as argument.
 * (x/crisis) [#20043](https://github.com/cosmos/cosmos-sdk/pull/20043) Changed `NewMsgVerifyInvariant` to accept a string as argument instead of an `AccAddress`.

client/cmd.go

@@ -8,13 +8,17 @@ import (
  "slices"
  "strings"
 
+ cmtcfg "github.com/cometbft/cometbft/config"
  "github.com/spf13/cobra"
  "github.com/spf13/pflag"
+ "github.com/spf13/viper"
  "google.golang.org/grpc"
  "google.golang.org/grpc/credentials"
  "google.golang.org/grpc/credentials/insecure"
 
  signingv1beta1 "cosmossdk.io/api/cosmos/tx/signing/v1beta1"
+ corectx "cosmossdk.io/core/context"
+ "cosmossdk.io/log"
 
  "github.com/cosmos/cosmos-sdk/client/flags"
  "github.com/cosmos/cosmos-sdk/crypto/keyring"
@@ -373,3 +377,40 @@ func SetCmdClientContext(cmd *cobra.Command, clientCtx Context) error {
 
  return nil
 }
+
+func GetViperFromCmd(cmd *cobra.Command) *viper.Viper {
+ value := cmd.Context().Value(corectx.ViperContextKey{})
+ v, ok := value.(*viper.Viper)
+ if !ok {
+ return viper.New()
+ }
+ return v
+}
+
+func GetConfigFromCmd(cmd *cobra.Command) *cmtcfg.Config {
+ v := cmd.Context().Value(corectx.ViperContextKey{})
+ viper, ok := v.(*viper.Viper)
+ if !ok {
+ return cmtcfg.DefaultConfig()
+ }
+ return GetConfigFromViper(viper)
+}
+
+func GetLoggerFromCmd(cmd *cobra.Command) log.Logger {
+ v := cmd.Context().Value(corectx.LoggerContextKey{})
+ logger, ok := v.(log.Logger)
+ if !ok {
+ return log.NewLogger(cmd.OutOrStdout())
+ }
+ return logger
+}
+
+func GetConfigFromViper(v *viper.Viper) *cmtcfg.Config {
+ conf := cmtcfg.DefaultConfig()
+ err := v.Unmarshal(conf)
+ rootDir := v.GetString(flags.FlagHome)
+ if err != nil {
+ return cmtcfg.DefaultConfig().SetRoot(rootDir)
+ }
+ return conf.SetRoot(rootDir)
+}

client/snapshot/delete.go

@@ -5,6 +5,7 @@ import (
 
  "github.com/spf13/cobra"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
 )
 
@@ -14,7 +15,7 @@ func DeleteSnapshotCmd() *cobra.Command {
  Short: "Delete a local snapshot",
  Args: cobra.ExactArgs(2),
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
+ viper := client.GetViperFromCmd(cmd)
 
  height, err := strconv.ParseUint(args[0], 10, 64)
  if err != nil {
@@ -25,7 +26,7 @@ func DeleteSnapshotCmd() *cobra.Command {
  return err
  }
 
- snapshotStore, err := server.GetSnapshotStore(ctx.Viper)
+ snapshotStore, err := server.GetSnapshotStore(viper)
  if err != nil {
  return err
  }

client/snapshot/dump.go

@@ -11,6 +11,7 @@ import (
 
  "github.com/spf13/cobra"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
 )
 
@@ -21,8 +22,8 @@ func DumpArchiveCmd() *cobra.Command {
  Short: "Dump the snapshot as portable archive format",
  Args: cobra.ExactArgs(2),
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
- snapshotStore, err := server.GetSnapshotStore(ctx.Viper)
+ viper := client.GetViperFromCmd(cmd)
+ snapshotStore, err := server.GetSnapshotStore(viper)
  if err != nil {
  return err
  }

client/snapshot/export.go

@@ -5,6 +5,7 @@ import (
 
  "cosmossdk.io/log"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
  servertypes "github.com/cosmos/cosmos-sdk/server/types"
 )
@@ -16,20 +17,21 @@ func ExportSnapshotCmd[T servertypes.Application](appCreator servertypes.AppCrea
  Short: "Export app state to snapshot store",
  Args: cobra.NoArgs,
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
+ cfg := client.GetConfigFromCmd(cmd)
+ viper := client.GetViperFromCmd(cmd)
 
  height, err := cmd.Flags().GetInt64("height")
  if err != nil {
  return err
  }
 
- home := ctx.Config.RootDir
- db, err := openDB(home, server.GetAppDBBackend(ctx.Viper))
+ home := cfg.RootDir
+ db, err := openDB(home, server.GetAppDBBackend(viper))
  if err != nil {
  return err
  }
  logger := log.NewLogger(cmd.OutOrStdout())
- app := appCreator(logger, db, nil, ctx.Viper)
+ app := appCreator(logger, db, nil, viper)
 
  if height == 0 {
  height = app.CommitMultiStore().LastCommitID().Version

client/snapshot/list.go

@@ -5,6 +5,7 @@ import (
 
  "github.com/spf13/cobra"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
 )
 
@@ -13,8 +14,8 @@ var ListSnapshotsCmd = &cobra.Command{
  Use: "list",
  Short: "List local snapshots",
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
- snapshotStore, err := server.GetSnapshotStore(ctx.Viper)
+ viper := client.GetViperFromCmd(cmd)
+ snapshotStore, err := server.GetSnapshotStore(viper)
  if err != nil {
  return err
  }

client/snapshot/load.go

@@ -15,6 +15,7 @@ import (
 
  snapshottypes "cosmossdk.io/store/snapshots/types"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
 )
 
@@ -27,8 +28,8 @@ func LoadArchiveCmd() *cobra.Command {
  Short: "Load a snapshot archive file (.tar.gz) into snapshot store",
  Args: cobra.ExactArgs(1),
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
- snapshotStore, err := server.GetSnapshotStore(ctx.Viper)
+ viper := client.GetViperFromCmd(cmd)
+ snapshotStore, err := server.GetSnapshotStore(viper)
  if err != nil {
  return err
  }

client/snapshot/restore.go

@@ -9,6 +9,7 @@ import (
 
  "cosmossdk.io/log"
 
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/server"
  servertypes "github.com/cosmos/cosmos-sdk/server/types"
 )
@@ -21,7 +22,8 @@ func RestoreSnapshotCmd[T servertypes.Application](appCreator servertypes.AppCre
  Long: "Restore app state from local snapshot",
  Args: cobra.ExactArgs(2),
  RunE: func(cmd *cobra.Command, args []string) error {
- ctx := server.GetServerContextFromCmd(cmd)
+ cfg := client.GetConfigFromCmd(cmd)
+ viper := client.GetViperFromCmd(cmd)
 
  height, err := strconv.ParseUint(args[0], 10, 64)
  if err != nil {
@@ -32,13 +34,13 @@ func RestoreSnapshotCmd[T servertypes.Application](appCreator servertypes.AppCre
  return err
  }
 
- home := ctx.Config.RootDir
- db, err := openDB(home, server.GetAppDBBackend(ctx.Viper))
+ home := cfg.RootDir
+ db, err := openDB(home, server.GetAppDBBackend(viper))
  if err != nil {
  return err
  }
  logger := log.NewLogger(cmd.OutOrStdout())
- app := appCreator(logger, db, nil, ctx.Viper)
+ app := appCreator(logger, db, nil, viper)
 
  sm := app.SnapshotManager()
  return sm.RestoreLocalSnapshot(height, uint32(format))

core/context/server_context.go

@@ -0,0 +1,6 @@
+package context
+
+type (
+ LoggerContextKey struct{}
+ ViperContextKey struct{}
+)

core/go.mod

@@ -10,7 +10,7 @@ require (
 )
 
 require (
- github.com/davecgh/go-spew v1.1.1 // indirect
+ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
  github.com/google/go-cmp v0.6.0 // indirect
  github.com/kr/pretty v0.3.1 // indirect
  github.com/pmezard/go-difflib v1.0.0 // indirect

core/go.sum

@@ -1,8 +1,8 @@
 github.com/cosmos/gogoproto v1.4.12 h1:vB6Lbe/rtnYGjQuFxkPiPYiCybqFT8QvLipDZP8JpFE=
 github.com/cosmos/gogoproto v1.4.12/go.mod h1:LnZob1bXRdUoqMMtwYlcR3wjiElmlC+FkjaZRv1/eLY=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=

server/util.go

@@ -24,6 +24,7 @@ import (
  "github.com/spf13/viper"
  "golang.org/x/sync/errgroup"
 
+ corectx "cosmossdk.io/core/context"
  corelog "cosmossdk.io/core/log"
  "cosmossdk.io/log"
  "cosmossdk.io/store"
@@ -46,6 +47,7 @@ import (
 const ServerContextKey = sdk.ContextKey("server.context")
 
 // Context server context
+// Deprecated: Do not use since we use viper to track all config
 type Context struct {
  Viper *viper.Viper
  Config *cmtcfg.Config
@@ -224,7 +226,11 @@ func SetCmdServerContext(cmd *cobra.Command, serverCtx *Context) error {
  cmdCtx = cmd.Context()
  }
 
- cmd.SetContext(context.WithValue(cmdCtx, ServerContextKey, serverCtx))
+ cmdCtx = context.WithValue(cmdCtx, ServerContextKey, serverCtx)
+ cmdCtx = context.WithValue(cmdCtx, corectx.ViperContextKey{}, serverCtx.Viper)
+ cmdCtx = context.WithValue(cmdCtx, corectx.LoggerContextKey{}, serverCtx.Logger)
+
+ cmd.SetContext(cmdCtx)
 
  return nil
 }

simapp/simd/cmd/testnet.go

@@ -140,8 +140,7 @@ Example:
  return err
  }
 
- serverCtx := server.GetServerContextFromCmd(cmd)
- config := serverCtx.Config
+ config := client.GetConfigFromCmd(cmd)
 
  args := initArgs{}
  args.outputDir, _ = cmd.Flags().GetString(flagOutputDir)
@@ -407,6 +406,9 @@ func initTestnetFiles(
  return err
  }
 
+ // Update viper root since root dir become rootdir/node/simd
+ client.GetViperFromCmd(cmd).Set(flags.FlagHome, nodeConfig.RootDir)
+
  cmd.PrintErrf("Successfully initialized %d node directories\n", args.numValidators)
  return nil
 }

simapp/simd/cmd/testnet_test.go

@@ -8,6 +8,7 @@ import (
  "github.com/spf13/viper"
  "github.com/stretchr/testify/require"
 
+ corectx "cosmossdk.io/core/context"
  "cosmossdk.io/depinject"
  "cosmossdk.io/log"
  "cosmossdk.io/x/auth"
@@ -17,7 +18,6 @@ import (
  "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/client/flags"
  codectestutil "github.com/cosmos/cosmos-sdk/codec/testutil"
- "github.com/cosmos/cosmos-sdk/server"
  "github.com/cosmos/cosmos-sdk/testutil/configurator"
  "github.com/cosmos/cosmos-sdk/types/module"
  moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
@@ -51,13 +51,15 @@ func Test_TestnetCmd(t *testing.T) {
  cdcOpts := codectestutil.CodecOptions{}
  encodingConfig := moduletestutil.MakeTestEncodingConfig(cdcOpts, auth.AppModule{}, staking.AppModule{})
  logger := log.NewNopLogger()
+ viper := viper.New()
  cfg, err := genutiltest.CreateDefaultCometConfig(home)
  require.NoError(t, err)
 
  err = genutiltest.ExecInitCmd(moduleManager, home, encodingConfig.Codec)
  require.NoError(t, err)
 
- serverCtx := server.NewContext(viper.New(), cfg, logger)
+ err = genutiltest.WriteAndTrackCometConfig(viper, home, cfg)
+ require.NoError(t, err)
  clientCtx := client.Context{}.
  WithCodec(encodingConfig.Codec).
  WithHomeDir(home).
@@ -66,14 +68,15 @@ func Test_TestnetCmd(t *testing.T) {
  WithValidatorAddressCodec(cdcOpts.GetValidatorCodec())
 
  ctx := context.Background()
- ctx = context.WithValue(ctx, server.ServerContextKey, serverCtx)
+ ctx = context.WithValue(ctx, corectx.ViperContextKey{}, viper)
+ ctx = context.WithValue(ctx, corectx.LoggerContextKey{}, logger)
  ctx = context.WithValue(ctx, client.ClientContextKey, &clientCtx)
  cmd := testnetInitFilesCmd(moduleManager, banktypes.GenesisBalancesIterator{})
  cmd.SetArgs([]string{fmt.Sprintf("--%s=test", flags.FlagKeyringBackend), fmt.Sprintf("--output-dir=%s", home)})
  err = cmd.ExecuteContext(ctx)
  require.NoError(t, err)
 
- genFile := cfg.GenesisFile()
+ genFile := client.GetConfigFromCmd(cmd).GenesisFile()
  appState, _, err := genutiltypes.GenesisStateFromGenFile(genFile)
  require.NoError(t, err)
 

simapp/test_helpers.go

@@ -20,6 +20,7 @@ import (
  minttypes "cosmossdk.io/x/mint/types"
 
  bam "github.com/cosmos/cosmos-sdk/baseapp"
+ "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/client/flags"
  "github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1"
  "github.com/cosmos/cosmos-sdk/server"
@@ -228,11 +229,11 @@ func NewTestNetworkFixture() network.TestFixture {
 
  appCtr := func(val network.ValidatorI) servertypes.Application {
  return NewSimApp(
- val.GetCtx().Logger, dbm.NewMemDB(), nil, true,
- simtestutil.NewAppOptionsWithFlagHome(val.GetCtx().Config.RootDir),
+ val.GetLogger(), dbm.NewMemDB(), nil, true,
+ simtestutil.NewAppOptionsWithFlagHome(client.GetConfigFromViper(val.GetViper()).RootDir),
  bam.SetPruning(pruningtypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)),
  bam.SetMinGasPrices(val.GetAppConfig().MinGasPrices),
- bam.SetChainID(val.GetCtx().Viper.GetString(flags.FlagChainID)),
+ bam.SetChainID(val.GetViper().GetString(flags.FlagChainID)),
  )
  }