Problem: init/validate-genesis cmd include gravity module by default (#…

…639) * Problem: inconsistent logic regarding experimental modules in genesis export/validate Solution: - Use different module managers according to --unsafe-experimental flag fix experimental flag in unit tests Update CHANGELOG.md use cmd-flags to fix integration tests pystarport merged to main * fix devnet configs
crypto-org-chain · Aug 17, 2022 · fb80ae1 · fb80ae1
1 parent 4be9702
commit fb80ae1
Show file tree

Hide file tree

Showing 11 changed files with 111 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 
 - [cronos#502](https://github.com/crypto-org-chain/cronos/pull/502) Fix failed tx are ignored in json-rpc apis.
 - [cronos#556](https://github.com/crypto-org-chain/cronos/pull/556) Bump gravity bridge module version to include bugfixes (including grpc endpoint)
+- [cronos#639](https://github.com/crypto-org-chain/cronos/pull/639) init and validate-genesis commands don't include experimental modules by default.
 
 ### Improvements
 - [cronos#418](https://github.com/crypto-org-chain/cronos/pull/418) Support logs in evm-hooks and return id for SendToEthereum events

diff --git a/app/app.go b/app/app.go
@@ -174,33 +174,8 @@ var (
 	// ModuleBasics defines the module BasicManager is in charge of setting up basic,
 	// non-dependant module elements, such as codec registration
 	// and genesis verification.
-	ModuleBasics = module.NewBasicManager(
-		auth.AppModuleBasic{},
-		genutil.AppModuleBasic{},
-		bank.AppModuleBasic{},
-		capability.AppModuleBasic{},
-		staking.AppModuleBasic{},
-		mint.AppModuleBasic{},
-		distr.AppModuleBasic{},
-		gov.NewAppModuleBasic(getGovProposalHandlers()),
-		params.AppModuleBasic{},
-		crisis.AppModuleBasic{},
-		slashing.AppModuleBasic{},
-		feegrantmodule.AppModuleBasic{},
-		upgrade.AppModuleBasic{},
-		evidence.AppModuleBasic{},
-		authzmodule.AppModuleBasic{},
-		ibc.AppModuleBasic{},
-		transfer.AppModuleBasic{},
-		vesting.AppModuleBasic{},
-		ica.AppModuleBasic{},
-		icactlmodule.AppModuleBasic{},
-		evm.AppModuleBasic{},
-		feemarket.AppModuleBasic{},
-		gravity.AppModuleBasic{},
-		// this line is used by starport scaffolding # stargate/app/moduleBasic
-		cronos.AppModuleBasic{},
-	)
+	// Contains experimental modules by default.
+	ModuleBasics = GenModuleBasics(true)
 
 	// module account permissions
 	maccPerms = map[string][]string{
@@ -231,6 +206,40 @@ func init() {
 	DefaultNodeHome = filepath.Join(userHomeDir, "."+Name)
 }
 
+// GenModuleBasics generate basic module manager according to experimental flag
+func GenModuleBasics(experimental bool) module.BasicManager {
+	basicModules := []module.AppModuleBasic{
+		auth.AppModuleBasic{},
+		genutil.AppModuleBasic{},
+		bank.AppModuleBasic{},
+		capability.AppModuleBasic{},
+		staking.AppModuleBasic{},
+		mint.AppModuleBasic{},
+		distr.AppModuleBasic{},
+		gov.NewAppModuleBasic(getGovProposalHandlers()),
+		params.AppModuleBasic{},
+		crisis.AppModuleBasic{},
+		slashing.AppModuleBasic{},
+		feegrantmodule.AppModuleBasic{},
+		upgrade.AppModuleBasic{},
+		evidence.AppModuleBasic{},
+		authzmodule.AppModuleBasic{},
+		ibc.AppModuleBasic{},
+		transfer.AppModuleBasic{},
+		vesting.AppModuleBasic{},
+		ica.AppModuleBasic{},
+		icactlmodule.AppModuleBasic{},
+		evm.AppModuleBasic{},
+		feemarket.AppModuleBasic{},
+		// this line is used by starport scaffolding # stargate/app/moduleBasic
+		cronos.AppModuleBasic{},
+	}
+	if experimental {
+		basicModules = append(basicModules, gravity.AppModuleBasic{})
+	}
+	return module.NewBasicManager(basicModules...)
+}
+
 // App extends an ABCI application, but with most of its parameters exported.
 // They are exported for convenience in creating helper functions, as object
 // capabilities aren't needed for testing.
@@ -293,6 +302,9 @@ type App struct {
 
 	// module configurator
 	configurator module.Configurator
+
+	// if enable experimental gravity-bridge feature module
+	experimental bool
 }
 
 // New returns a reference to an initialized chain.
@@ -346,6 +358,7 @@ func New(
 		keys:              keys,
 		tkeys:             tkeys,
 		memKeys:           memKeys,
+		experimental:      experimental,
 	}
 
 	app.ParamsKeeper = initParamsKeeper(appCodec, cdc, keys[paramstypes.StoreKey], tkeys[paramstypes.TStoreKey], experimental)

diff --git a/app/genesis.go b/app/genesis.go
@@ -16,6 +16,6 @@ import (
 type GenesisState map[string]json.RawMessage
 
 // NewDefaultGenesisState generates the default state for the application.
-func NewDefaultGenesisState(cdc codec.JSONCodec) GenesisState {
-	return ModuleBasics.DefaultGenesis(cdc)
+func NewDefaultGenesisState(cdc codec.JSONCodec, experimental bool) GenesisState {
+	return GenModuleBasics(experimental).DefaultGenesis(cdc)
 }
diff --git a/app/state.go b/app/state.go
@@ -162,7 +162,8 @@ func StateRandomizedFn(
 	accs []simtypes.Account, genesisTimestamp time.Time, appParams simtypes.AppParams,
 ) (json.RawMessage, []simtypes.Account) {
 	numAccs := int64(len(accs))
-	genesisState := NewDefaultGenesisState(cdc)
+	// test with experimental modules by default
+	genesisState := NewDefaultGenesisState(cdc, true)
 
 	// generate a random amount of initial stake coins and a random initial
 	// number of bonded accounts

diff --git a/app/test_helpers.go b/app/test_helpers.go
@@ -86,7 +86,7 @@ func setup(withGenesis bool, invCheckPeriod uint, experimental bool) (*App, Gene
 	}
 	app := New(log.NewNopLogger(), db, nil, true, map[int64]bool{}, DefaultNodeHome, invCheckPeriod, encCdc, appOption)
 	if withGenesis {
-		return app, NewDefaultGenesisState(encCdc.Codec)
+		return app, NewDefaultGenesisState(encCdc.Codec, experimental)
 	}
 	return app, GenesisState{}
 }

diff --git a/cmd/cronosd/cmd/root.go b/cmd/cronosd/cmd/root.go
@@ -11,6 +11,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/simapp/params"
 	"github.com/cosmos/cosmos-sdk/snapshots"
+	"github.com/cosmos/cosmos-sdk/types/module"
 
 	"github.com/spf13/cast"
 	"github.com/spf13/cobra"
@@ -113,12 +114,12 @@ func initRootCmd(rootCmd *cobra.Command, encodingConfig params.EncodingConfig) {
 
 	rootCmd.AddCommand(
 		ethermintclient.ValidateChainID(
-			genutilcli.InitCmd(app.ModuleBasics, app.DefaultNodeHome),
+			WrapInitCmd(app.DefaultNodeHome),
 		),
 		genutilcli.CollectGenTxsCmd(banktypes.GenesisBalancesIterator{}, app.DefaultNodeHome),
 		genutilcli.MigrateGenesisCmd(),
-		genutilcli.GenTxCmd(app.ModuleBasics, encodingConfig.TxConfig, banktypes.GenesisBalancesIterator{}, app.DefaultNodeHome),
-		genutilcli.ValidateGenesisCmd(app.ModuleBasics),
+		WrapGenTxCmd(encodingConfig.TxConfig, banktypes.GenesisBalancesIterator{}, app.DefaultNodeHome),
+		WrapValidateGenesisCmd(),
 		AddGenesisAccountCmd(app.DefaultNodeHome),
 		tmcli.NewCompletionCmd(rootCmd, true),
 		ethermintclient.NewTestnetCmd(app.ModuleBasics, banktypes.GenesisBalancesIterator{}),
@@ -333,3 +334,48 @@ func overwriteFlagDefaults(c *cobra.Command, defaults map[string]string) {
 		overwriteFlagDefaults(c, defaults)
 	}
 }
+
+// WrapValidateGenesisCmd extends `genutilcli.ValidateGenesisCmd` to support `--unsafe-experimental` flag.
+func WrapValidateGenesisCmd() *cobra.Command {
+	wrapCmd := genutilcli.ValidateGenesisCmd(module.NewBasicManager())
+	wrapCmd.RunE = func(cmd *cobra.Command, args []string) error {
+		experimental, err := cmd.Flags().GetBool(cronos.ExperimentalFlag)
+		if err != nil {
+			return err
+		}
+		moduleBasics := app.GenModuleBasics(experimental)
+		return genutilcli.ValidateGenesisCmd(moduleBasics).RunE(cmd, args)
+	}
+	wrapCmd.Flags().Bool(cronos.ExperimentalFlag, false, "Enable experimental features")
+	return wrapCmd
+}
+
+// WrapInitCmd extends `genutilcli.InitCmd` to support `--unsafe-experimental` flag.
+func WrapInitCmd(home string) *cobra.Command {
+	wrapCmd := genutilcli.InitCmd(module.NewBasicManager(), home)
+	wrapCmd.RunE = func(cmd *cobra.Command, args []string) error {
+		experimental, err := cmd.Flags().GetBool(cronos.ExperimentalFlag)
+		if err != nil {
+			return err
+		}
+		moduleBasics := app.GenModuleBasics(experimental)
+		return genutilcli.InitCmd(moduleBasics, home).RunE(cmd, args)
+	}
+	wrapCmd.Flags().Bool(cronos.ExperimentalFlag, false, "Enable experimental features")
+	return wrapCmd
+}
+
+// WrapGenTxCmd extends `genutilcli.GenTxCmd` to support `--unsafe-experimental` flag.
+func WrapGenTxCmd(txEncCfg client.TxEncodingConfig, genBalIterator banktypes.GenesisBalancesIterator, defaultNodeHome string) *cobra.Command {
+	wrapCmd := genutilcli.GenTxCmd(module.NewBasicManager(), txEncCfg, genBalIterator, defaultNodeHome)
+	wrapCmd.RunE = func(cmd *cobra.Command, args []string) error {
+		experimental, err := cmd.Flags().GetBool(cronos.ExperimentalFlag)
+		if err != nil {
+			return err
+		}
+		moduleBasics := app.GenModuleBasics(experimental)
+		return genutilcli.GenTxCmd(moduleBasics, txEncCfg, genBalIterator, defaultNodeHome).RunE(cmd, args)
+	}
+	wrapCmd.Flags().Bool(cronos.ExperimentalFlag, false, "Enable experimental features")
+	return wrapCmd
+}
diff --git a/integration_tests/configs/disable_auto_deployment.jsonnet b/integration_tests/configs/disable_auto_deployment.jsonnet
@@ -2,7 +2,8 @@ local config = import 'default.jsonnet';
 
 config {
   'cronos_777-1'+: {
-    'start-flags': '--trace --unsafe-experimental --inv-check-period 5',
+    'cmd-flags': '--unsafe-experimental',
+    'start-flags': '--trace --inv-check-period 5',
     'app-config'+: {
       'minimum-gas-prices':: super['minimum-gas-prices'],
       'json-rpc'+: {

diff --git a/integration_tests/configs/genesis_token_mapping.jsonnet b/integration_tests/configs/genesis_token_mapping.jsonnet
@@ -2,7 +2,8 @@ local config = import 'default.jsonnet';
 
 config {
   'cronos_777-1'+: {
-    'start-flags': '--trace --unsafe-experimental --inv-check-period 5',
+    'cmd-flags': '--unsafe-experimental',
+    'start-flags': '--trace --inv-check-period 5',
     'app-config'+: {
       'minimum-gas-prices':: super['minimum-gas-prices'],
       'json-rpc'+: {

diff --git a/integration_tests/poetry.lock b/integration_tests/poetry.lock
diff --git a/scripts/cronos-experimental-devnet.yaml b/scripts/cronos-experimental-devnet.yaml
@@ -1,6 +1,7 @@
 cronos_777-1:
   cmd: cronosd
-  start-flags: "--trace --unsafe-experimental"
+  cmd-flags: "--unsafe-experimental"
+  start-flags: "--trace"
   app-config:
     minimum-gas-prices: 100000000000basetcro
     index-events:

diff --git a/scripts/devnet.yaml b/scripts/devnet.yaml
@@ -1,7 +1,8 @@
 dotenv: .env
 cronos_777-1:
   cmd: ./build/cronosd
-  start-flags: "--trace --unsafe-experimental"
+  cmd-flags: "--unsafe-experimental"
+  start-flags: "--trace"
   config:
     tx_index:
       indexer: "null"