Problem: memiavl configs are not defined in app.toml (#1028)

* Problem: memiavl configs are not defined in app.toml Solution: - integrate custom configs into app.toml * Update CHANGELOG.md Signed-off-by: yihuang <huang@crypto.com> * better memiavl setup code * fix integration test --------- Signed-off-by: yihuang <huang@crypto.com>
crypto-org-chain · May 15, 2023 · 0d5bf68 · 0d5bf68
1 parent 47d7749
commit 0d5bf68
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@
 - [#950](https://github.com/crypto-org-chain/cronos/pull/950) Implement memiavl and integrate with state machine.
 - [#985](https://github.com/crypto-org-chain/cronos/pull/985) Fix versiondb verify command on older versions
 - [#998](https://github.com/crypto-org-chain/cronos/pull/998) Bump grocksdb to v1.7.16 and rocksdb to v7.10.2
+- [#1028](https://github.com/crypto-org-chain/cronos/pull/1028) Add memiavl configs into app.toml
 
 
 *April 13, 2023*

diff --git a/app/app.go b/app/app.go
@@ -125,7 +125,6 @@ import (
 
 	// this line is used by starport scaffolding # stargate/app/moduleImport
 
-	"github.com/crypto-org-chain/cronos/store/rootmulti"
 	"github.com/crypto-org-chain/cronos/v2/x/cronos"
 	cronosclient "github.com/crypto-org-chain/cronos/v2/x/cronos/client"
 	cronoskeeper "github.com/crypto-org-chain/cronos/v2/x/cronos/keeper"
@@ -150,11 +149,6 @@ const (
 	//
 	// NOTE: In the SDK, the default value is 255.
 	AddrLen = 20
-
-	FlagMemIAVL  = "store.memiavl"
-	FlagAsyncWAL = "store.memiavl-async-wal"
-	// don't enable zero-copy together with inter-block cache.
-	FlagZeroCopy = "store.memiavl-zero-copy"
 )
 
 // this line is used by starport scaffolding # stargate/wasm/app/enabledProposals
@@ -349,15 +343,7 @@ func New(
 	cdc := encodingConfig.Amino
 	interfaceRegistry := encodingConfig.InterfaceRegistry
 
-	if cast.ToBool(appOpts.Get(FlagMemIAVL)) {
-		// cms must be overridden before the other options, because they may use the cms,
-		// FIXME we are assuming the cms won't be overridden by the other options, but we can't be sure.
-		cms := rootmulti.NewStore(filepath.Join(homePath, "data", "memiavl.db"), logger)
-		cms.SetAsyncWAL(cast.ToBool(appOpts.Get(FlagAsyncWAL)))
-		cms.SetZeroCopy(cast.ToBool(appOpts.Get(FlagZeroCopy)))
-		baseAppOptions = append([]func(*baseapp.BaseApp){setCMS(cms)}, baseAppOptions...)
-	}
-
+	baseAppOptions = SetupMemIAVL(logger, homePath, appOpts, baseAppOptions)
 	bApp := baseapp.NewBaseApp(Name, logger, db, encodingConfig.TxConfig.TxDecoder(), baseAppOptions...)
 
 	bApp.SetCommitMultiStoreTracer(traceStore)

diff --git a/app/config/config.go b/app/config/config.go
@@ -0,0 +1,23 @@
+package config
+
+import "github.com/evmos/ethermint/server/config"
+
+type Config struct {
+	config.Config
+
+	MemIAVL MemIAVLConfig `mapstructure:"memiavl"`
+}
+
+type MemIAVLConfig struct {
+	// Enable defines if the memiavl should be enabled.
+	Enable bool `mapstructure:"enable"`
+	// ZeroCopy defines if the memiavl should return slices pointing to mmap-ed buffers directly (zero-copy),
+	// the zero-copied slices must not be retained beyond current block's execution.
+	ZeroCopy bool `mapstructure:"zero-copy"`
+	// AsyncCommit defines if the memiavl should commit asynchronously, this greatly improve block catching-up performance.
+	AsyncCommit bool `mapstructure:"async-commit"`
+}
+
+func DefaultMemIAVLConfig() MemIAVLConfig {
+	return MemIAVLConfig{}
+}
diff --git a/app/config/toml.go b/app/config/toml.go
@@ -0,0 +1,20 @@
+package config
+
+// DefaultConfigTemplate defines the configuration template for the EVM RPC configuration
+const DefaultConfigTemplate = `
+###############################################################################
+###                             Cronos Configuration                        ###
+###############################################################################
+
+[memiavl]
+
+# Enable defines if the memiavl should be enabled.
+enable = {{ .MemIAVL.Enable }}
+
+# ZeroCopy defines if the memiavl should return slices pointing to mmap-ed buffers directly (zero-copy),
+# the zero-copied slices must not be retained beyond current block's execution.
+zero-copy = {{ .MemIAVL.ZeroCopy }}
+
+# AsyncCommit defines if the memiavl should commit asynchronously, this greatly improve block catching-up performance.
+async-commit = {{ .MemIAVL.AsyncCommit }}
+`
diff --git a/app/memiavl.go b/app/memiavl.go
@@ -0,0 +1,32 @@
+package app
+
+import (
+	"path/filepath"
+
+	"github.com/spf13/cast"
+	"github.com/tendermint/tendermint/libs/log"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	servertypes "github.com/cosmos/cosmos-sdk/server/types"
+
+	"github.com/crypto-org-chain/cronos/store/rootmulti"
+)
+
+const (
+	FlagMemIAVL     = "memiavl.enable"
+	FlagAsyncCommit = "memiavl.async-commit"
+	FlagZeroCopy    = "memiavl.zero-copy"
+)
+
+func SetupMemIAVL(logger log.Logger, homePath string, appOpts servertypes.AppOptions, baseAppOptions []func(*baseapp.BaseApp)) []func(*baseapp.BaseApp) {
+	if cast.ToBool(appOpts.Get(FlagMemIAVL)) {
+		// cms must be overridden before the other options, because they may use the cms,
+		// make sure the cms aren't be overridden by the other options later on.
+		cms := rootmulti.NewStore(filepath.Join(homePath, "data", "memiavl.db"), logger)
+		cms.SetAsyncWAL(cast.ToBool(appOpts.Get(FlagAsyncCommit)))
+		cms.SetZeroCopy(cast.ToBool(appOpts.Get(FlagZeroCopy)))
+		baseAppOptions = append([]func(*baseapp.BaseApp){setCMS(cms)}, baseAppOptions...)
+	}
+
+	return baseAppOptions
+}
diff --git a/cmd/cronosd/cmd/root.go b/cmd/cronosd/cmd/root.go
@@ -39,6 +39,7 @@ import (
 	ethermint "github.com/evmos/ethermint/types"
 
 	"github.com/crypto-org-chain/cronos/v2/app"
+	cronoscfg "github.com/crypto-org-chain/cronos/v2/app/config"
 	"github.com/crypto-org-chain/cronos/v2/cmd/cronosd/opendb"
 	"github.com/crypto-org-chain/cronos/v2/x/cronos"
 	// this line is used by starport scaffolding # stargate/root/import
@@ -210,7 +211,11 @@ func txCommand() *cobra.Command {
 // initAppConfig helps to override default appConfig template and configs.
 // return "", nil if no custom configuration is required for the application.
 func initAppConfig() (string, interface{}) {
-	return servercfg.AppConfig(ethermint.AttoPhoton)
+	tpl, cfg := servercfg.AppConfig(ethermint.AttoPhoton)
+	return tpl + cronoscfg.DefaultConfigTemplate, cronoscfg.Config{
+		Config:  cfg.(servercfg.Config),
+		MemIAVL: cronoscfg.DefaultMemIAVLConfig(),
+	}
 }
 
 type appCreator struct {

diff --git a/integration_tests/configs/cosmovisor.jsonnet b/integration_tests/configs/cosmovisor.jsonnet
@@ -5,6 +5,7 @@ config {
     'app-config'+: {
       'app-db-backend': 'rocksdb',
       'minimum-gas-prices': '100000000000basetcro',
+      memiavl:: super.memiavl,
       store:: super.store,
       streamers:: super.streamers,
       'iavl-lazy-loading':: super['iavl-lazy-loading'],

diff --git a/integration_tests/configs/cosmovisor_gravity.jsonnet b/integration_tests/configs/cosmovisor_gravity.jsonnet
@@ -5,6 +5,7 @@ config {
     'app-config'+: {
       'app-db-backend': 'rocksdb',
       'minimum-gas-prices': '100000000000basetcro',
+      memiavl:: super.memiavl,
       store:: super.store,
       streamers:: super.streamers,
       'iavl-lazy-loading':: super['iavl-lazy-loading'],

diff --git a/integration_tests/configs/default.jsonnet b/integration_tests/configs/default.jsonnet
@@ -27,9 +27,11 @@
       staked: '1000000000000000000stake',
       mnemonic: '${VALIDATOR1_MNEMONIC}',
       'app-config': {
+        memiavl: {
+          enable: true,
+          'zero-copy': true,
+        },
         store: {
-          memiavl: true,
-          'memiavl-zero-copy': true,
           streamers: ['versiondb'],
         },
       },