1.8.4 upgrade handler

Author: akobrin1

Makefile.devnet

@@ -274,9 +274,12 @@ devnet-update-scripts:
 		echo "No containers were updated. Ensure the devnet is running."; \
 	fi
 
-.PHONY: devnet-new-172 devnet-upgrade_180
-devnet-upgrade_180:
-	@cd devnet/scripts && ./upgrade.sh v1.8.0 120 ../bin-v1.8.0
+.PHONY: devnet-new-172 devnet-upgrade-180 devnet-upgrade-184
+devnet-upgrade-180:
+	@cd devnet/scripts && ./upgrade.sh v1.8.0 auto-height ../bin-v1.8.0
+
+devnet-upgrade-184:
+	@cd devnet/scripts && ./upgrade.sh v1.8.4 auto-height ../bin-v1.8.4
 
 devnet-new-172:
 	$(MAKE) devnet-down

app/app.go

@@ -78,6 +78,8 @@ import (
 	ibcporttypes "github.com/cosmos/ibc-go/v10/modules/core/05-port/types"
 	ibckeeper "github.com/cosmos/ibc-go/v10/modules/core/keeper"
 
+	upgrades "github.com/LumeraProtocol/lumera/app/upgrades"
+	appParams "github.com/LumeraProtocol/lumera/app/upgrades/params"
 	actionmodulekeeper "github.com/LumeraProtocol/lumera/x/action/v1/keeper"
 	claimmodulekeeper "github.com/LumeraProtocol/lumera/x/claim/keeper"
 	lumeraidmodulekeeper "github.com/LumeraProtocol/lumera/x/lumeraid/keeper"
@@ -86,12 +88,6 @@ import (
 	// this line is used by starport scaffolding # stargate/app/moduleImport
 
 	"github.com/LumeraProtocol/lumera/docs"
-
-	upgrade_v1_6_1 "github.com/LumeraProtocol/lumera/app/upgrades/v1_6_1"
-	upgrade_v1_7_0 "github.com/LumeraProtocol/lumera/app/upgrades/v1_7_0"
-	upgrade_v1_7_2 "github.com/LumeraProtocol/lumera/app/upgrades/v1_7_2"
-	upgrade_v1_8_0 "github.com/LumeraProtocol/lumera/app/upgrades/v1_8_0"
-	upgrade_v1_8_2 "github.com/LumeraProtocol/lumera/app/upgrades/v1_8_2"
 )
 
 const (
@@ -279,13 +275,9 @@ func New(
 		panic(err)
 	}
 
-	// **** SETUP UPGRADE HANDLER ****
+	// **** SETUP UPGRADES (upgrade handlers and store loaders) ****
 	// This needs to be done after keepers are initialized but before loading state.
-	app.setupUpgradeHandlers()
-
-	// **** SETUP STORE LOADER ****
-	// This must be done BEFORE LoadLatestVersion/LoadVersion
-	app.setupUpgradeStoreLoaders()
+	app.setupUpgrades()
 
 	/****  Module Options ****/
 	app.ModuleManager.RegisterInvariants(app.CrisisKeeper)
@@ -328,9 +320,9 @@ func (app *App) GetSubspace(moduleName string) paramstypes.Subspace {
 	return subspace
 }
 
-// setupUpgradeStoreLoaders configures the store loader for upcoming upgrades.
+// setupUpgrades configures the store loader for upcoming upgrades and registers upgrade handlers.
 // This needs to be called BEFORE app.Load()
-func (app *App) setupUpgradeStoreLoaders() {
+func (app *App) setupUpgrades() {
 	upgradeInfo, err := app.UpgradeKeeper.ReadUpgradeInfoFromDisk()
 	// No upgrade scheduled, skip
 	if err != nil {
@@ -341,82 +333,36 @@ func (app *App) setupUpgradeStoreLoaders() {
 		return // No upgrade info file, normal startup
 	}
 
-	// Map of upgrade names to their corresponding StoreUpgrades
-	storeUpgradesMap := map[string]*storetypes.StoreUpgrades{
-		upgrade_v1_6_1.UpgradeName: &upgrade_v1_6_1.StoreUpgrades,
-		upgrade_v1_7_0.UpgradeName: &upgrade_v1_7_0.StoreUpgrades,
-		upgrade_v1_7_2.UpgradeName: &upgrade_v1_7_2.StoreUpgrades,
-		upgrade_v1_8_0.UpgradeName: &upgrade_v1_8_0.StoreUpgrades,
-		upgrade_v1_8_2.UpgradeName: &upgrade_v1_8_2.StoreUpgrades,
-	}
+	upgradeConfig, found := upgrades.SetupUpgrades(upgradeInfo.Name, appParams.AppUpgradeParams{
+		ChainID:       app.ChainID(),
+		Logger:        app.Logger(),
+		ModuleManager: app.ModuleManager,
+		Configurator:  app.Configurator(),
+	})
 
-	// Check for the planned upgrades
-	if !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
-		if upgrades, exists := storeUpgradesMap[upgradeInfo.Name]; exists {
-			app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, upgrades))
-			app.Logger().Info("Configured store loader for upgrade", "name", upgradeInfo.Name, "height", upgradeInfo.Height)
-		} else {
-			app.Logger().Info("No store upgrades registered for pending plan", "name", upgradeInfo.Name)
-		}
+	if !found {
+		panic(fmt.Sprintf("upgrade plan %q is scheduled at height %d but not registered in this binary", upgradeInfo.Name, upgradeInfo.Height))
 	}
-}
 
-type UpgradeHandlerConfig struct {
-	Name    string
-	Handler upgradetypes.UpgradeHandler
-}
+	if upgradeConfig.Handler != nil {
+		app.UpgradeKeeper.SetUpgradeHandler(upgradeInfo.Name, upgradeConfig.Handler)
+		app.Logger().Info("Registered upgrade handler", "name", upgradeInfo.Name)
+	} else {
+		app.Logger().Info("Skipping upgrade handler registration", "name", upgradeInfo.Name)
+	}
 
-// setupUpgradeHandlers registers the upgrade handlers for specific upgrade names.
-func (app *App) setupUpgradeHandlers() {
-	handlers := []UpgradeHandlerConfig{
-		{
-			Name: upgrade_v1_6_1.UpgradeName,
-			Handler: upgrade_v1_6_1.CreateUpgradeHandler(
-				app.Logger(),
-				app.ModuleManager,
-				app.Configurator(),
-			),
-		},
-		{
-			Name: upgrade_v1_7_0.UpgradeName,
-			Handler: upgrade_v1_7_0.CreateUpgradeHandler(
-				app.Logger(),
-				app.ModuleManager,
-				app.Configurator(),
-			),
-		},
-		{
-			Name: upgrade_v1_7_2.UpgradeName,
-			Handler: upgrade_v1_7_2.CreateUpgradeHandler(
-				app.Logger(),
-				app.ModuleManager,
-				app.Configurator(),
-			),
-		},
-		{
-			Name: upgrade_v1_8_0.UpgradeName,
-			Handler: upgrade_v1_8_0.CreateUpgradeHandler(
-				app.Logger(),
-				app.ModuleManager,
-				app.Configurator(),
-			),
-		},
-		{
-			Name: upgrade_v1_8_2.UpgradeName,
-			Handler: upgrade_v1_8_2.CreateUpgradeHandler(
-				app.Logger(),
-				app.ModuleManager,
-				app.Configurator(),
-			),
-		},
-		// Add future upgrades here
+	if upgradeConfig.StoreUpgrade == nil {
+		app.Logger().Info("No store upgrades registered for pending plan", "name", upgradeInfo.Name)
+		return
 	}
 
-	// Register the upgrade handlers
-	for _, h := range handlers {
-		app.UpgradeKeeper.SetUpgradeHandler(h.Name, h.Handler)
-		app.Logger().Info("Registered upgrade handler", "name", h.Name)
+	if app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
+		app.Logger().Info("Skipping store loader because height is flagged to skip", "name", upgradeInfo.Name, "height", upgradeInfo.Height)
+		return
 	}
+
+	app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, upgradeConfig.StoreUpgrade))
+	app.Logger().Info("Configured store loader for upgrade", "name", upgradeInfo.Name, "height", upgradeInfo.Height)
 }
 
 // LegacyAmino returns App's amino codec.

app/upgrades/params/params.go

@@ -0,0 +1,14 @@
+package params
+
+import (
+	"cosmossdk.io/log"
+	"github.com/cosmos/cosmos-sdk/types/module"
+)
+
+type AppUpgradeParams struct {
+	ChainID string
+
+	Logger log.Logger
+	ModuleManager *module.Manager
+	Configurator module.Configurator
+}

app/upgrades/upgrades.go

@@ -0,0 +1,65 @@
+package upgrades
+
+import (
+	"strings"
+
+	storetypes "cosmossdk.io/store/types"
+	upgradetypes "cosmossdk.io/x/upgrade/types"
+
+	appParams "github.com/LumeraProtocol/lumera/app/upgrades/params"
+	upgrade_v1_6_1 "github.com/LumeraProtocol/lumera/app/upgrades/v1_6_1"
+	upgrade_v1_7_0 "github.com/LumeraProtocol/lumera/app/upgrades/v1_7_0"
+	upgrade_v1_7_2 "github.com/LumeraProtocol/lumera/app/upgrades/v1_7_2"
+	upgrade_v1_8_0 "github.com/LumeraProtocol/lumera/app/upgrades/v1_8_0"
+	upgrade_v1_8_4 "github.com/LumeraProtocol/lumera/app/upgrades/v1_8_4"
+)
+
+type UpgradeConfig struct {
+	StoreUpgrade *storetypes.StoreUpgrades
+	Handler      upgradetypes.UpgradeHandler
+}
+
+var NoUpgradeConfig = UpgradeConfig{
+	StoreUpgrade: nil,
+	Handler:      nil,
+}
+
+// SetupUpgrades returns the configuration for the requested upgrade (if any).
+// Do not define StoreUpgrades if there are no store changes for that upgrade.
+// Do not define an UpgradeHandler if no custom logic is needed beyond module migrations.
+func SetupUpgrades(upgradeName string, params appParams.AppUpgradeParams) (UpgradeConfig, bool) {
+	switch upgradeName {
+	case upgrade_v1_6_1.UpgradeName:
+		return UpgradeConfig{
+			Handler: upgrade_v1_6_1.CreateUpgradeHandler(params),
+		}, true
+	case upgrade_v1_7_0.UpgradeName:
+		return UpgradeConfig{
+			Handler: upgrade_v1_7_0.CreateUpgradeHandler(params),
+		}, true
+	case upgrade_v1_7_2.UpgradeName:
+		return UpgradeConfig{
+			Handler: upgrade_v1_7_2.CreateUpgradeHandler(params),
+		}, true
+	case upgrade_v1_8_0.UpgradeName:
+		if strings.HasPrefix(params.ChainID, "lumera-testnet") || strings.HasPrefix(params.ChainID, "lumera-devnet") {
+			return UpgradeConfig{
+				StoreUpgrade: &upgrade_v1_8_0.StoreUpgrades,
+				Handler:      upgrade_v1_8_0.CreateUpgradeHandler(params),
+			}, true
+		}
+		return NoUpgradeConfig, true
+	case upgrade_v1_8_4.UpgradeName:
+		config := UpgradeConfig{
+			Handler: upgrade_v1_8_4.CreateUpgradeHandler(params),
+		}
+		if strings.HasPrefix(params.ChainID, "lumera-mainnet") {
+			config.StoreUpgrade = &upgrade_v1_8_4.StoreUpgrades
+		}
+		return config, true
+
+	// add future upgrades here
+	default:
+		return UpgradeConfig{}, false
+	}
+}

app/upgrades/v1_6_1/upgrade.go

@@ -3,49 +3,40 @@ package v1_6_1
 import (
 	"context"
 	"fmt"
-	storetypes "cosmossdk.io/store/types"
-	"github.com/LumeraProtocol/lumera/x/action/v1/types"
 
-	"cosmossdk.io/log"
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+
+	appParams "github.com/LumeraProtocol/lumera/app/upgrades/params"
+	"github.com/LumeraProtocol/lumera/x/action/v1/types"
 )
 
 const UpgradeName = "v1.6.1"
 
 // CreateUpgradeHandler creates an upgrade handler for v1_6_1
-func CreateUpgradeHandler(
-	logger log.Logger,
-	mm *module.Manager,
-	configurator module.Configurator,
-) upgradetypes.UpgradeHandler {
+func CreateUpgradeHandler(p appParams.AppUpgradeParams) upgradetypes.UpgradeHandler {
 	return func(goCtx context.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		logger.Info(fmt.Sprintf("Starting upgrade %s...", UpgradeName))
+		p.Logger.Info(fmt.Sprintf("Starting upgrade %s...", UpgradeName))
 
 		ctx := sdk.UnwrapSDKContext(goCtx)
 
 		// 1. Run Migrations for Existing Modules (if any needed for this upgrade)
 		// Use the unwrapped sdk.Context (ctx)
-		logger.Info("Running module migrations...")
-		newVM, err := mm.RunMigrations(ctx, configurator, fromVM)
+		p.Logger.Info("Running module migrations...")
+		newVM, err := p.ModuleManager.RunMigrations(ctx, p.Configurator, fromVM)
 		if err != nil {
-			logger.Error("Failed to run migrations", "error", err)
+			p.Logger.Error("Failed to run migrations", "error", err)
 			return nil, fmt.Errorf("failed to run migrations: %w", err)
 		}
-		logger.Info("Module migrations completed.")
+		p.Logger.Info("Module migrations completed.")
 
 		// 3. Add the New Module to the Version Map
 		newVM[types.ModuleName] = types.ConsensusVersion
 
-		logger.Info(fmt.Sprintf("Successfully completed upgrade %s", UpgradeName))
+		p.Logger.Info(fmt.Sprintf("Successfully completed upgrade %s", UpgradeName))
 
 		// Return the UPDATED version map
 		return newVM, nil
 	}
 }
-
-var StoreUpgrades = storetypes.StoreUpgrades{
-	Added: []string{},
-	// Deleted: []string{...},
-}

app/upgrades/v1_7_0/upgrade.go

@@ -2,48 +2,38 @@ package v1_7_0
 
 import (
 	"context"
-	storetypes "cosmossdk.io/store/types"
 	"fmt"
 
-	"cosmossdk.io/log"
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+
+	appParams "github.com/LumeraProtocol/lumera/app/upgrades/params"
 )
 
 const UpgradeName = "v1.7.0"
 
 // CreateUpgradeHandler creates an upgrade handler for v1_7_0
-func CreateUpgradeHandler(
-	logger log.Logger,
-	mm *module.Manager,
-	configurator module.Configurator,
-) upgradetypes.UpgradeHandler {
+func CreateUpgradeHandler(p appParams.AppUpgradeParams) upgradetypes.UpgradeHandler {
 	return func(goCtx context.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		logger.Info(fmt.Sprintf("Starting upgrade %s...", UpgradeName))
+		p.Logger.Info(fmt.Sprintf("Starting upgrade %s...", UpgradeName))
 
 		ctx := sdk.UnwrapSDKContext(goCtx)
 
 		// 1. Run Migrations for Existing Modules (if any needed for this upgrade)
 		// Use the unwrapped sdk.Context (ctx)
-		logger.Info("Running module migrations...")
-		newVM, err := mm.RunMigrations(ctx, configurator, fromVM)
+		p.Logger.Info("Running module migrations...")
+		newVM, err := p.ModuleManager.RunMigrations(ctx, p.Configurator, fromVM)
 		if err != nil {
-			logger.Error("Failed to run migrations", "error", err)
+			p.Logger.Error("Failed to run migrations", "error", err)
 			return nil, fmt.Errorf("failed to run migrations: %w", err)
 		}
-		logger.Info("Module migrations completed.")
+		p.Logger.Info("Module migrations completed.")
 
 		// No new modules to add to the version map for v1.7.0
 
-		logger.Info(fmt.Sprintf("Successfully completed upgrade %s", UpgradeName))
-
+		p.Logger.Info(fmt.Sprintf("Successfully completed upgrade %s", UpgradeName))
 		// Return the UPDATED version map
 		return newVM, nil
 	}
 }
-
-var StoreUpgrades = storetypes.StoreUpgrades{
-	Added: []string{},
-	// Deleted: []string{...},
-}