feat: Add roller migrate for Configuration Upgrades

Makefile

@@ -13,9 +13,9 @@ ifeq (,$(VERSION))
 endif
 
 
-ldflags = -X github.com/dymensionxyz/roller/cmd/version.BuildVersion=$(VERSION) \
-		  -X github.com/dymensionxyz/roller/cmd/version.BuildCommit=$(COMMIT) \
-		  -X github.com/dymensionxyz/roller/cmd/version.BuildTime=$(TIME)"
+ldflags = -X github.com/dymensionxyz/roller/version.BuildVersion=$(VERSION) \
+		  -X github.com/dymensionxyz/roller/version.BuildCommit=$(COMMIT) \
+		  -X github.com/dymensionxyz/roller/version.BuildTime=$(TIME)"
 
 BUILD_FLAGS := -ldflags '$(ldflags)'
 # ---------------------------------------------------------------------------- #

cmd/config/init/flags.go

@@ -2,6 +2,7 @@ package initconfig
 
 import (
 	"fmt"
+	"github.com/dymensionxyz/roller/version"
 	"strings"
 
 	"github.com/dymensionxyz/roller/cmd/consts"
@@ -36,7 +37,9 @@ func addFlags(cmd *cobra.Command) error {
 }
 
 func GetInitConfig(initCmd *cobra.Command, args []string) (config.RollappConfig, error) {
-	cfg := config.RollappConfig{}
+	cfg := config.RollappConfig{
+		RollerVersion: version.BuildVersion,
+	}
 	cfg.Home = initCmd.Flag(utils.FlagNames.Home).Value.String()
 	cfg.RollappBinary = initCmd.Flag(FlagNames.RollappBinary).Value.String()
 	// Error is ignored because the flag is validated in the cobra preRun hook

cmd/config/init/rollapp.go

@@ -54,7 +54,7 @@ func initializeRollappConfig(initConfig config.RollappConfig) error {
 	if err != nil {
 		return err
 	}
-	if err = sequencer.SetDefaultDymintConfig(initConfig.Home, initConfig); err != nil {
+	if err = sequencer.SetDefaultDymintConfig(initConfig); err != nil {
 		return err
 	}
 	return nil

cmd/migrate/migrate.go

@@ -0,0 +1,78 @@
+package migrate
+
+import (
+	"fmt"
+	"github.com/dymensionxyz/roller/cmd/utils"
+	"github.com/dymensionxyz/roller/config"
+	"github.com/dymensionxyz/roller/version"
+	"github.com/spf13/cobra"
+	"strings"
+)
+
+var migrationsRegistry = []VersionMigrator{
+	&VersionMigratorV014{},
+}
+
+func Cmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "migrate",
+		Short: "Migrates the roller configuration to the newly installed version.",
+		Run: func(cmd *cobra.Command, args []string) {
+			home := cmd.Flag(utils.FlagNames.Home).Value.String()
+			rlpCfg, err := config.LoadConfigFromTOML(home)
+			utils.PrettifyErrorIfExists(err)
+			prevVersionData, err := GetPrevVersionData(rlpCfg)
+			utils.PrettifyErrorIfExists(err)
+			for _, migrator := range migrationsRegistry {
+				if migrator.ShouldMigrate(*prevVersionData) {
+					utils.PrettifyErrorIfExists(migrator.PerformMigration(rlpCfg))
+				}
+			}
+			trimmedCurrentVersion := trimVersionStr(version.BuildVersion)
+			fmt.Printf("💈 Roller has migrated successfully to %s!\n", trimmedCurrentVersion)
+		},
+	}
+	return cmd
+}
+
+func trimVersionStr(versionStr string) string {
+	return strings.Split(versionStr, "-")[0]
+}
+
+func GetPrevVersionData(rlpCfg config.RollappConfig) (*VersionData, error) {
+	rollerPrevVersion := rlpCfg.RollerVersion
+	var major, minor, patch int
+	// Special case for the first version of roller, that didn't have a version field.
+	if rollerPrevVersion == "" {
+		return &VersionData{
+			Major: 0,
+			Minor: 1,
+			Patch: 3,
+		}, nil
+	}
+	trimmedVersionStr := trimVersionStr(rollerPrevVersion)
+	n, err := fmt.Sscanf(trimmedVersionStr, "v%d.%d.%d", &major, &minor, &patch)
+	if err != nil {
+		return nil, err
+	}
+	if n != 3 {
+		return nil, fmt.Errorf("failed to extract all version components from version %s",
+			rollerPrevVersion)
+	}
+	return &VersionData{
+		Major: major,
+		Minor: minor,
+		Patch: patch,
+	}, nil
+}
+
+type VersionMigrator interface {
+	PerformMigration(rlpCfg config.RollappConfig) error
+	ShouldMigrate(prevVersion VersionData) bool
+}
+
+type VersionData struct {
+	Major int
+	Minor int
+	Patch int
+}

cmd/migrate/v_0_1_4.go

@@ -0,0 +1,22 @@
+package migrate
+
+import (
+	"github.com/dymensionxyz/roller/config"
+	"github.com/dymensionxyz/roller/sequencer"
+	"github.com/dymensionxyz/roller/version"
+)
+
+type VersionMigratorV014 struct{}
+
+func (v *VersionMigratorV014) ShouldMigrate(prevVersion VersionData) bool {
+	return prevVersion.Major < 1 && prevVersion.Minor < 2 && prevVersion.Patch < 4
+}
+
+func (v *VersionMigratorV014) PerformMigration(rlpCfg config.RollappConfig) error {
+	err := sequencer.SetDefaultDymintConfig(rlpCfg)
+	if err != nil {
+		return err
+	}
+	rlpCfg.RollerVersion = trimVersionStr(version.BuildVersion)
+	return config.WriteConfigToTOML(rlpCfg)
+}

cmd/root.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/dymensionxyz/roller/cmd/migrate"
 	"github.com/dymensionxyz/roller/cmd/run"
 	"github.com/dymensionxyz/roller/cmd/services"
 	"github.com/dymensionxyz/roller/cmd/utils"
@@ -33,13 +34,14 @@ func Execute() {
 
 func init() {
 	rootCmd.AddCommand(config.ConfigCmd())
-	rootCmd.AddCommand(version.VersionCmd())
+	rootCmd.AddCommand(version.Cmd())
 	rootCmd.AddCommand(register.Cmd())
 	rootCmd.AddCommand(da_light_client.DALightClientCmd())
 	rootCmd.AddCommand(sequencer.SequencerCmd())
 	rootCmd.AddCommand(relayer.Cmd())
 	rootCmd.AddCommand(keys.Cmd())
 	rootCmd.AddCommand(run.Cmd())
 	rootCmd.AddCommand(services.Cmd())
+	rootCmd.AddCommand(migrate.Cmd())
 	utils.AddGlobalFlags(rootCmd)
 }

cmd/version/version.go

@@ -2,24 +2,19 @@ package version
 
 import (
 	"fmt"
+	"github.com/dymensionxyz/roller/version"
 
 	"github.com/spf13/cobra"
 )
 
-var (
-	BuildVersion = "<version>"
-	BuildTime    = "<build-time>"
-	BuildCommit  = "<build-commit>"
-)
-
-func VersionCmd() *cobra.Command {
+func Cmd() *cobra.Command {
 	versionCmd := &cobra.Command{
 		Use:   "version",
 		Short: "Print the version of roller",
 		Run: func(cmd *cobra.Command, args []string) {
-			fmt.Println("💈 Roller version", BuildVersion)
-			fmt.Println("💈 Build time:", BuildTime)
-			fmt.Println("💈 Git commit:", BuildCommit)
+			fmt.Println("💈 Roller version", version.BuildVersion)
+			fmt.Println("💈 Build time:", version.BuildTime)
+			fmt.Println("💈 Git commit:", version.BuildCommit)
 		},
 	}
 	return versionCmd

config/config.go

@@ -34,6 +34,7 @@ type RollappConfig struct {
 	Decimals      uint
 	HubData       HubData
 	DA            DAType
+	RollerVersion string
 }
 
 type HubData = struct {

config/toml.go

@@ -12,12 +12,7 @@ func WriteConfigToTOML(InitConfig RollappConfig) error {
 	if err != nil {
 		return err
 	}
-	err = ioutil.WriteFile(filepath.Join(InitConfig.Home, RollerConfigFileName), tomlBytes, 0644)
-	if err != nil {
-		return err
-	}
-
-	return nil
+	return ioutil.WriteFile(filepath.Join(InitConfig.Home, RollerConfigFileName), tomlBytes, 0644)
 }
 
 // TODO: should be called from root command

sequencer/dymint_toml.go

@@ -9,8 +9,8 @@ import (
 	"path/filepath"
 )
 
-func SetDefaultDymintConfig(root string, rlpCfg config.RollappConfig) error {
-	dymintTomlPath := GetDymintFilePath(root)
+func SetDefaultDymintConfig(rlpCfg config.RollappConfig) error {
+	dymintTomlPath := GetDymintFilePath(rlpCfg.Home)
 	dymintCfg, err := toml.LoadFile(dymintTomlPath)
 	if err != nil {
 		return err
@@ -21,8 +21,6 @@ func SetDefaultDymintConfig(root string, rlpCfg config.RollappConfig) error {
 	if daConfig != "" {
 		dymintCfg.Set("da_config", daConfig)
 	}
-	dymintCfg.Set("instrumentation.prometheus", true)
-	dymintCfg.Set("instrumentation.prometheus_listen_addr", ":2112")
 	hubKeysDir := filepath.Join(rlpCfg.Home, consts.ConfigDirName.HubKeys)
 	dymintCfg.Set("settlement_layer", "dymension")
 	dymintCfg.Set("block_batch_size", "500")
@@ -35,13 +33,12 @@ func SetDefaultDymintConfig(root string, rlpCfg config.RollappConfig) error {
 	dymintCfg.Set("dym_account_name", consts.KeysIds.HubSequencer)
 	dymintCfg.Set("keyring_home_dir", hubKeysDir)
 	dymintCfg.Set("gas_prices", rlpCfg.HubData.GAS_PRICE+consts.Denoms.Hub)
+	dymintCfg.Set("instrumentation.prometheus", true)
+	dymintCfg.Set("instrumentation.prometheus_listen_addr", ":2112")
 	file, err := os.Create(dymintTomlPath)
 	if err != nil {
 		return err
 	}
 	_, err = file.WriteString(dymintCfg.String())
-	if err != nil {
-		return err
-	}
-	return nil
+	return err
 }

version/version.go

@@ -0,0 +1,7 @@
+package version
+
+var (
+	BuildVersion = "<version>"
+	BuildTime    = "<build-time>"
+	BuildCommit  = "<build-commit>"
+)