refactor(upgrades): simplify upgrade hanlder code to use less abstractions and combine micro-packages (#2413)

* fix(evm-rpc): remove unsafe debug API methods.

* refactor: make code organization suggestion from Gemini input

* refactor(upgrades): simplify upgrade hanlder code to use less abstractions and combine micro-packages

* fix tests and add feedback

* refactor: last bit of changes from self-review

Author: Unique-Divine

CHANGELOG.md

@@ -66,6 +66,7 @@ address when Wasm contract addresses are queried because 32-byte address space
 (wasm contract length) is not uniquely identified in 20-byte space (EOA length).
 - [#2412](https://github.com/NibiruChain/nibiru/pull/2412) - fix(evm-rpc): remove
   unsafe debug API methods. 
+- [#2413](https://github.com/NibiruChain/nibiru/pull/2413) - refactor(upgrades): simplify upgrade handler code to use less abstractions and combine micro-packages
 
 ### Dependencies
 - Bump `cipher-base` from 1.0.4 to 1.0.6 ([#2390](https://github.com/NibiruChain/nibiru/pull/2390))

app/ante/handler_opts.go

@@ -15,9 +15,6 @@ import (
 	evmstate "github.com/NibiruChain/nibiru/v2/x/evm/evmstate"
 )
 
-// TODO: Refactor to add compile-time safety for the following interface.
-// var _ evmante.AnteOptionsEVM = (*AnteHandlerOptions)(nil)
-
 type AnteHandlerOptions struct {
 	sdkante.HandlerOptions
 	IBCKeeper        *ibckeeper.Keeper

app/upgrades.go

@@ -15,44 +15,9 @@ import (
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 
 	"github.com/NibiruChain/nibiru/v2/app/upgrades"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_0_1"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_0_2"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_0_3"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_1_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_2_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_3_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_4_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v1_5_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_0_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_1_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_2_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_3_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_4_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_5_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_6_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_7_0"
-	"github.com/NibiruChain/nibiru/v2/app/upgrades/v2_8_0"
 )
 
-var Upgrades = []upgrades.Upgrade{
-	v1_0_1.Upgrade,
-	v1_0_2.Upgrade,
-	v1_0_3.Upgrade,
-	v1_1_0.Upgrade,
-	v1_2_0.Upgrade,
-	v1_3_0.Upgrade,
-	v1_4_0.Upgrade,
-	v1_5_0.Upgrade,
-	v2_0_0.Upgrade,
-	v2_1_0.Upgrade,
-	v2_2_0.Upgrade,
-	v2_3_0.Upgrade,
-	v2_4_0.Upgrade,
-	v2_5_0.Upgrade,
-	v2_6_0.Upgrade,
-	v2_7_0.Upgrade,
-	v2_8_0.Upgrade,
-}
+var Upgrades = upgrades.AllUpgrades
 
 func (app *NibiruApp) setupUpgrades() {
 	// see https://github.com/cosmos/cosmos-sdk/blob/666c345ad23ddda9523cc5cd1b71187d91c26f34/simapp/upgrades.go#L35-L57

app/upgrades/types.go app/upgrades/all_upgrades.goapp/upgrades/types.go renamed to app/upgrades/all_upgrades.go

@@ -20,9 +20,31 @@ type Upgrade struct {
 		ibcKeeperClientKeeper clientkeeper.Keeper,
 	) upgradetypes.UpgradeHandler
 
+	// StoreUpgrades defines a series of transformations to apply the multistore db
+	// upon load
 	StoreUpgrades store.StoreUpgrades
 }
 
+var AllUpgrades = []Upgrade{
+	Upgrade1_0_1,
+	Upgrade1_0_2,
+	Upgrade1_0_3,
+	Upgrade1_1_0,
+	Upgrade1_2_0,
+	Upgrade1_3_0,
+	Upgrade1_4_0,
+	Upgrade1_5_0,
+	Upgrade2_0_0,
+	Upgrade2_1_0,
+	Upgrade2_2_0,
+	Upgrade2_3_0,
+	Upgrade2_4_0,
+	Upgrade2_5_0,
+	Upgrade2_6_0,
+	Upgrade2_7_0,
+	Upgrade2_8_0,
+}
+
 // DefaultUpgradeHandler runs module manager migrations without running any other
 // logic that uses the Nibiru keepers. This is the most common value for
 // the "CreateUpgradeHandler" field of an [Upgrade].

app/upgrades/v1.go

@@ -0,0 +1,120 @@
+package upgrades
+
+import (
+	store "github.com/cosmos/cosmos-sdk/store/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
+	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	ica "github.com/cosmos/ibc-go/v7/modules/apps/27-interchain-accounts"
+	icacontrollertypes "github.com/cosmos/ibc-go/v7/modules/apps/27-interchain-accounts/controller/types"
+	icahosttypes "github.com/cosmos/ibc-go/v7/modules/apps/27-interchain-accounts/host/types"
+	icatypes "github.com/cosmos/ibc-go/v7/modules/apps/27-interchain-accounts/types"
+	ibctransfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types"
+	clientkeeper "github.com/cosmos/ibc-go/v7/modules/core/02-client/keeper"
+
+	"github.com/NibiruChain/nibiru/v2/app/keepers"
+	inflationtypes "github.com/NibiruChain/nibiru/v2/x/inflation/types"
+)
+
+var (
+	// Tests the upgrade process and move to newer version of rocksdb
+	Upgrade1_0_1 = Upgrade{
+		UpgradeName:          "v1.0.1",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+
+	// Newer version of the Cosmos-SDK
+	Upgrade1_0_2 = Upgrade{
+		UpgradeName:          "v1.0.2",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+
+	// Newer version of the Cosmos-SDK
+	Upgrade1_0_3 = Upgrade{
+		UpgradeName:          "v1.0.3",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+
+	Upgrade1_1_0 = Upgrade{
+		UpgradeName:          "v1.1.0",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades: store.StoreUpgrades{
+			Added: []string{inflationtypes.ModuleName},
+		},
+	}
+
+	Upgrade1_2_0 = Upgrade{
+		UpgradeName:          "v1.2.0",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+
+	Upgrade1_3_0 = Upgrade{
+		UpgradeName: "v1.3.0",
+		CreateUpgradeHandler: func(
+			mm *module.Manager,
+			cfg module.Configurator,
+			nibiru *keepers.PublicKeepers,
+			clientKeeper clientkeeper.Keeper,
+		) upgradetypes.UpgradeHandler {
+			return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
+				// set the ICS27 consensus version so InitGenesis is not run
+				fromVM[icatypes.ModuleName] = mm.GetVersionMap()[icatypes.ModuleName]
+
+				// create ICS27 Controller submodule params, controller module not enabled.
+				controllerParams := icacontrollertypes.Params{
+					ControllerEnabled: true,
+				}
+
+				// create ICS27 Host submodule params
+				hostParams := icahosttypes.Params{
+					HostEnabled: true,
+					AllowMessages: []string{
+						sdk.MsgTypeURL(&banktypes.MsgSend{}),
+						sdk.MsgTypeURL(&stakingtypes.MsgDelegate{}),
+						sdk.MsgTypeURL(&stakingtypes.MsgUndelegate{}),
+						sdk.MsgTypeURL(&stakingtypes.MsgBeginRedelegate{}),
+						sdk.MsgTypeURL(&distrtypes.MsgWithdrawDelegatorReward{}),
+						sdk.MsgTypeURL(&distrtypes.MsgSetWithdrawAddress{}),
+						sdk.MsgTypeURL(&distrtypes.MsgFundCommunityPool{}),
+						sdk.MsgTypeURL(&authz.MsgExec{}),
+						sdk.MsgTypeURL(&authz.MsgGrant{}),
+						sdk.MsgTypeURL(&authz.MsgRevoke{}),
+						sdk.MsgTypeURL(&ibctransfertypes.MsgTransfer{}),
+					},
+				}
+
+				// initialize ICS27 module
+				icamodule, correctTypecast := mm.Modules[icatypes.ModuleName].(ica.AppModule)
+				if !correctTypecast {
+					panic("mm.Modules[icatypes.ModuleName] is not of type ica.AppModule")
+				}
+				icamodule.InitModule(ctx, controllerParams, hostParams)
+
+				return mm.RunMigrations(ctx, cfg, fromVM)
+			}
+		},
+		StoreUpgrades: store.StoreUpgrades{
+			Added: []string{icacontrollertypes.StoreKey, icahosttypes.StoreKey},
+		},
+	}
+
+	Upgrade1_4_0 = Upgrade{
+		UpgradeName:          "v1.4.0",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+
+	Upgrade1_5_0 = Upgrade{
+		UpgradeName:          "v1.5.0",
+		CreateUpgradeHandler: DefaultUpgradeHandler,
+		StoreUpgrades:        store.StoreUpgrades{},
+	}
+)