feat: migration for mainnet rollapps (nim + mande) to upgrade to 3D

app/app.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 
+	errorsmod "cosmossdk.io/errors"
 	"github.com/cosmos/cosmos-sdk/x/authz"
 	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
 	authzmodule "github.com/cosmos/cosmos-sdk/x/authz/module"
@@ -164,6 +165,7 @@ import (
 	drs3 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-3"
 	drs4 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-4"
 	drs5 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-5"
+	drs5from2d "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-5-from2d"
 )
 
 const (
@@ -189,7 +191,7 @@ var (
 		erc20types.StoreKey,
 	}
 	// Upgrades contains the upgrade handlers for the application
-	Upgrades = []upgrades.Upgrade{drs2.Upgrade, drs3.Upgrade, drs4.Upgrade, drs5.Upgrade}
+	Upgrades = []upgrades.Upgrade{drs2.Upgrade, drs3.Upgrade, drs4.Upgrade, drs5.Upgrade, drs5from2d.Upgrade}
 )
 
 func getGovProposalHandlers() []govclient.ProposalHandler {
@@ -343,6 +345,9 @@ type App struct {
 	configurator module.Configurator
 
 	consensusMessageAdmissionHandler consensus.AdmissionHandler
+
+	// optionally override the way to query the dymint version
+	dymintVersionGetter func() (uint32, error)
 }
 
 // NewRollapp returns a reference to an initialized blockchain app
@@ -838,6 +843,7 @@ func NewRollapp(
 
 	if loadLatest {
 		if err := app.LoadLatestVersion(); err != nil {
+			err = errorsmod.Wrap(err, "new rollapp: load latest version")
 			tmos.Exit(err.Error())
 		}
 	}
@@ -874,6 +880,9 @@ func (app *App) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.R
 	resp.ConsensusMessagesResponses = consensusResponses
 
 	drsVersion, err := dymintversion.GetDRSVersion()
+	if app.dymintVersionGetter != nil {
+		drsVersion, err = app.dymintVersionGetter()
+	}
 	if err != nil {
 		panic(fmt.Errorf("Unable to get DRS version from binary: %w", err))
 	}
@@ -1142,12 +1151,15 @@ func (app *App) setupUpgradeHandlers() {
 	}
 }
 
-func (app *App) setupUpgradeHandler(upgrade upgrades.Upgrade) {
+func (app *App) setupUpgradeHandler(u upgrades.Upgrade) {
 	app.UpgradeKeeper.SetUpgradeHandler(
-		upgrade.Name,
-		upgrade.CreateHandler(
-			app.RollappParamsKeeper,
-			app.EvmKeeper,
+		u.Name,
+		u.CreateHandler(
+			upgrades.UpgradeKeepers{
+				RpKeeper:  app.RollappParamsKeeper,
+				EvmKeeper: app.EvmKeeper,
+				HubgenK:   app.HubGenesisKeeper,
+			},
 			app.mm,
 			app.configurator,
 		),
@@ -1158,8 +1170,14 @@ func (app *App) setupUpgradeHandler(upgrade upgrades.Upgrade) {
 		panic(fmt.Errorf("failed to read upgrade info from disk: %w", err))
 	}
 
-	if upgradeInfo.Name == upgrade.Name && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
+	if upgradeInfo.Name == u.Name && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
 		// configure store loader with the store upgrades
-		app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, &upgrade.StoreUpgrades))
+		app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, &u.StoreUpgrades))
+
+		app.Logger().Info("SetupUpgradeHandler Set store loader.")
 	}
 }
+
+func (app *App) SetDymintVersionGetter(getter func() (uint32, error)) {
+	app.dymintVersionGetter = getter
+}

app/upgrades/drs-2/upgrade.go

@@ -4,20 +4,20 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
 	evmkeeper "github.com/evmos/evmos/v12/x/evm/keeper"
 
 	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
 	rollappparamstypes "github.com/dymensionxyz/dymension-rdk/x/rollappparams/types"
 )
 
 func CreateUpgradeHandler(
-	rpKeeper rollappparamskeeper.Keeper,
-	evmKeeper *evmkeeper.Keeper,
+	kk upgrades.UpgradeKeepers,
 	mm *module.Manager,
 	configurator module.Configurator,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx sdk.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		if err := HandleUpgrade(ctx, rpKeeper, evmKeeper); err != nil {
+		if err := HandleUpgrade(ctx, kk.RpKeeper, kk.EvmKeeper); err != nil {
 			return nil, err
 		}
 		return mm.RunMigrations(ctx, configurator, fromVM)

app/upgrades/drs-3/upgrade.go

@@ -5,19 +5,19 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/module"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
 	evmkeeper "github.com/evmos/evmos/v12/x/evm/keeper"
 
 	drs2 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-2"
 )
 
 func CreateUpgradeHandler(
-	rpKeeper rollappparamskeeper.Keeper,
-	evmKeeper *evmkeeper.Keeper,
+	kk upgrades.UpgradeKeepers,
 	mm *module.Manager,
 	configurator module.Configurator,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		if err := HandleUpgrade(ctx, rpKeeper, evmKeeper); err != nil {
+		if err := HandleUpgrade(ctx, kk.RpKeeper, kk.EvmKeeper); err != nil {
 			return nil, err
 		}
 		return mm.RunMigrations(ctx, configurator, fromVM)

app/upgrades/drs-4/upgrade.go

@@ -5,19 +5,19 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/module"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
 	evmkeeper "github.com/evmos/evmos/v12/x/evm/keeper"
 
 	drs3 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-3"
 )
 
 func CreateUpgradeHandler(
-	rpKeeper rollappparamskeeper.Keeper,
-	evmKeeper *evmkeeper.Keeper,
+	kk upgrades.UpgradeKeepers,
 	mm *module.Manager,
 	configurator module.Configurator,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		if err := HandleUpgrade(ctx, rpKeeper, evmKeeper); err != nil {
+		if err := HandleUpgrade(ctx, kk.RpKeeper, kk.EvmKeeper); err != nil {
 			return nil, err
 		}
 		return mm.RunMigrations(ctx, configurator, fromVM)

app/upgrades/drs-5-from2d/constants.go

@@ -0,0 +1,37 @@
+package drs5from2d
+
+import (
+	storetypes "github.com/cosmos/cosmos-sdk/store/types"
+	authztypes "github.com/cosmos/cosmos-sdk/x/authz"
+	"github.com/cosmos/cosmos-sdk/x/feegrant"
+	hubtypes "github.com/dymensionxyz/dymension-rdk/x/hub/types"
+	rollappparamstypes "github.com/dymensionxyz/dymension-rdk/x/rollappparams/types"
+	timeupgradetypes "github.com/dymensionxyz/dymension-rdk/x/timeupgrade/types"
+	claimstypes "github.com/evmos/evmos/v12/x/claims/types"
+
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
+)
+
+const (
+	UpgradeName        = "drs-5-from2D"
+	DRS         uint32 = 5
+	DA          string = "celestia"
+)
+
+var Upgrade = upgrades.Upgrade{
+	Name:          UpgradeName,
+	CreateHandler: CreateUpgradeHandler,
+	StoreUpgrades: storetypes.StoreUpgrades{
+		Deleted: []string{
+			claimstypes.ModuleName,
+			"denommetadata",
+		},
+		Added: []string{
+			authztypes.ModuleName,
+			feegrant.ModuleName,
+			timeupgradetypes.ModuleName,
+			hubtypes.ModuleName,
+			rollappparamstypes.ModuleName,
+		},
+	},
+}

app/upgrades/drs-5-from2d/doc.go

@@ -0,0 +1,2 @@
+// Package drs5mainnet (3D) provides a 3D upgrade for the apps Nim+Mande from mainnet (rollapp-evm v2.2.1) to a 3D compatible version.
+package drs5from2d

app/upgrades/drs-5-from2d/upgrade.go

@@ -0,0 +1,63 @@
+package drs5from2d
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	hubgenkeeper "github.com/dymensionxyz/dymension-rdk/x/hub-genesis/keeper"
+	hubgenesistypes "github.com/dymensionxyz/dymension-rdk/x/hub-genesis/types"
+	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
+)
+
+func CreateUpgradeHandler(
+	kk upgrades.UpgradeKeepers,
+	mm *module.Manager,
+	configurator module.Configurator,
+) upgradetypes.UpgradeHandler {
+	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
+
+		if err := migrateHubGenesis(ctx, kk.HubgenK); err != nil {
+			return nil, fmt.Errorf("migrate hub genesis: %w", err)
+		}
+
+		vmap, err := mm.RunMigrations(ctx, configurator, fromVM)
+		if err != nil {
+			return nil, fmt.Errorf("run migrations: %w", err)
+		}
+
+		// rollappparams is a new module so needs to go after RunMigrations to go after InitGenesis
+		if err := migrateRollappParams(ctx, kk.RpKeeper); err != nil {
+			return nil, fmt.Errorf("migrate rollapp params: %w", err)
+		}
+
+		return vmap, nil
+	}
+}
+
+func migrateHubGenesis(ctx sdk.Context, k hubgenkeeper.Keeper) error {
+	s := k.GetState(ctx)
+	s.OutboundTransfersEnabled = true
+	s.InFlight = false
+	s.HubPortAndChannel = &hubgenesistypes.PortAndChannel{
+		Port:    "transfer",
+		Channel: "channel-0",
+	}
+	k.SetState(ctx, s)
+	// Note: we won't populate genesis info. It has difficulties, such as missing checksum and denom metadata.
+	// It isn't needed for established chains.
+	return nil
+}
+
+func migrateRollappParams(ctx sdk.Context, k rollappparamskeeper.Keeper) error {
+	if err := k.SetVersion(ctx, DRS); err != nil {
+		return fmt.Errorf("set version: %w", err)
+	}
+	if err := k.SetDA(ctx, DA); err != nil {
+		return fmt.Errorf("set DA: %w", err)
+	}
+	// no need to set min gas prices, rollapp can do it when it likes
+	return nil
+}

app/upgrades/drs-5-from2d/upgrade_test.go

@@ -0,0 +1,55 @@
+package drs5from2d_test
+
+import (
+	"testing"
+
+	up "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-5-from2d"
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	"github.com/dymensionxyz/rollapp-evm/app"
+	"github.com/stretchr/testify/require"
+	"github.com/tendermint/tendermint/proto/tendermint/types"
+)
+
+func TestBeginBlocker(t *testing.T) {
+
+	app, _ := app.SetupWithOneValidator(t)
+	app.SetDymintVersionGetter(func() (uint32, error) {
+		return uint32(up.DRS), nil
+	})
+	h := int64(42)
+	ctx := app.NewUncachedContext(true, types.Header{
+		Height:  h - 1,
+		ChainID: "testchain_9000-1",
+	})
+	err := app.UpgradeKeeper.ScheduleUpgrade(ctx, upgradetypes.Plan{
+		Name:   up.UpgradeName,
+		Height: h,
+	})
+	require.NoError(t, err)
+
+	// simulate the upgrade process not panic.
+	require.NotPanics(t, func() {
+		defer func() {
+			if r := recover(); r != nil {
+				t.Fatalf("Upgrade panicked: %v", r)
+			}
+		}()
+		// simulate the upgrade process
+		ctx = ctx.WithBlockHeight(h)
+		app.BeginBlocker(ctx, abci.RequestBeginBlock{})
+	})
+
+	// Check if the upgrade was applied correctly
+	state := app.HubGenesisKeeper.GetState(ctx)
+	require.True(t, state.OutboundTransfersEnabled, "OutboundTransfersEnabled should be true")
+	require.False(t, state.InFlight, "InFlight should be false")
+	require.NotNil(t, state.HubPortAndChannel, "HubPortAndChannel should not be nil")
+	require.Equal(t, "transfer", state.HubPortAndChannel.Port, "Port should be 'transfer'")
+	require.Equal(t, "channel-0", state.HubPortAndChannel.Channel, "Channel should be 'channel-0'")
+
+	p := app.RollappParamsKeeper.GetParams(ctx)
+	require.Equal(t, up.DRS, p.DrsVersion, "Version should be set to DRS")
+	require.Equal(t, up.DA, p.Da, "Version should be set to DRS")
+}

app/upgrades/drs-5/upgrade.go

@@ -5,19 +5,19 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/module"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
+	"github.com/dymensionxyz/rollapp-evm/app/upgrades"
 	evmkeeper "github.com/evmos/evmos/v12/x/evm/keeper"
 
 	drs4 "github.com/dymensionxyz/rollapp-evm/app/upgrades/drs-4"
 )
 
 func CreateUpgradeHandler(
-	rpKeeper rollappparamskeeper.Keeper,
-	evmKeeper *evmkeeper.Keeper,
+	kk upgrades.UpgradeKeepers,
 	mm *module.Manager,
 	configurator module.Configurator,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		if err := HandleUpgrade(ctx, rpKeeper, evmKeeper); err != nil {
+		if err := HandleUpgrade(ctx, kk.RpKeeper, kk.EvmKeeper); err != nil {
 			return nil, err
 		}
 		return mm.RunMigrations(ctx, configurator, fromVM)

app/upgrades/types.go

@@ -4,10 +4,17 @@ import (
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	hubgenkeeper "github.com/dymensionxyz/dymension-rdk/x/hub-genesis/keeper"
 	rollappparamskeeper "github.com/dymensionxyz/dymension-rdk/x/rollappparams/keeper"
 	evmkeeper "github.com/evmos/evmos/v12/x/evm/keeper"
 )
 
+type UpgradeKeepers struct {
+	RpKeeper  rollappparamskeeper.Keeper
+	EvmKeeper *evmkeeper.Keeper
+	HubgenK   hubgenkeeper.Keeper
+}
+
 // Upgrade defines a struct containing necessary fields that a SoftwareUpgradeProposal
 // must have written, in order for the state migration to go smoothly.
 // An upgrade must implement this struct, and then set it in the app.go.
@@ -18,8 +25,7 @@ type Upgrade struct {
 
 	// CreateHandler defines the function that creates an upgrade handler
 	CreateHandler func(
-		rpKeeper rollappparamskeeper.Keeper,
-		evmKeeper *evmkeeper.Keeper,
+		kk UpgradeKeepers,
 		mm *module.Manager,
 		configurator module.Configurator,
 	) upgradetypes.UpgradeHandler

go.mod

@@ -366,3 +366,9 @@ replace (
 	github.com/osmosis-labs/osmosis/v15 => github.com/dymensionxyz/osmosis/v15 v15.2.0-dymension-v1.1.2
 	github.com/tendermint/tendermint => github.com/dymensionxyz/cometbft v0.34.29-0.20241128205759-2a9d5f015da5
 )
+
+// TODO: cleanup after rdk is merged
+//replace github.com/dymensionxyz/dymension-rdk => /Users/danwt/Documents/dym/d-dymension-rdk
+replace github.com/dymensionxyz/dymension-rdk => github.com/dymensionxyz/dymension-rdk v1.8.0-rc02.0.20250106141106-c4bf86e13eaf
+
+replace github.com/dymensionxyz/dymint => github.com/dymensionxyz/dymint v1.3.0-rc02.0.20250106124459-756b49ffdf0c

go.sum

@@ -577,10 +577,10 @@ github.com/dymensionxyz/cosmos-sdk v0.46.17-0.20241128210616-e9dfe47b8c73 h1:A0O
 github.com/dymensionxyz/cosmos-sdk v0.46.17-0.20241128210616-e9dfe47b8c73/go.mod h1:VPUuzF+l+ekSGPV7VVB8m0OMQfwp3QdKWNZjvkU3A1U=
 github.com/dymensionxyz/cosmosclient v0.4.2-beta.0.20241121093220-e0d7ad456fbd h1:V89QyOFM84o9w0iFdctMU6So8SS/Xt32JWAXGqJduT0=
 github.com/dymensionxyz/cosmosclient v0.4.2-beta.0.20241121093220-e0d7ad456fbd/go.mod h1:3weqpVj/TqTFpC0LjEB3H+HZSpm7BrQ1QkEg1Ahy6KY=
-github.com/dymensionxyz/dymension-rdk v1.8.0-rc02 h1:HLWcGucC0t325IsnTlgJDt0JuBqlfDLXFApj7JAvDjE=
-github.com/dymensionxyz/dymension-rdk v1.8.0-rc02/go.mod h1:p9rl2xNsbubJcxGnTIVF9D8aKAM+oPkCVdQ6Z6PM2Tw=
-github.com/dymensionxyz/dymint v1.3.0-rc03 h1:JRAGrLDMdM642lbcnIgRp3iuHhvLkq0z6LWKZlWLQyI=
-github.com/dymensionxyz/dymint v1.3.0-rc03/go.mod h1:C3VbfePK85aRCdA1iHzB2AYD+n1gKR9Pw+wm3wQUXvE=
+github.com/dymensionxyz/dymension-rdk v1.8.0-rc02.0.20250106141106-c4bf86e13eaf h1:jo12b6NffdTwP3IRWUmec0OVrlfuOx/wHAi0w20RbZ0=
+github.com/dymensionxyz/dymension-rdk v1.8.0-rc02.0.20250106141106-c4bf86e13eaf/go.mod h1:PgFH4LETkSRpSJDfxsvNs3VCb//O1nkbAM+cZWYkaVU=
+github.com/dymensionxyz/dymint v1.3.0-rc02.0.20250106124459-756b49ffdf0c h1:tTwBWY63JcfNqB32TKI5TyNZ2vGhwP8I4N0hzsJy9V8=
+github.com/dymensionxyz/dymint v1.3.0-rc02.0.20250106124459-756b49ffdf0c/go.mod h1:sqE+4imdASE9lm63jv+K2zmOnclLJNZLPYbL9m6vR3o=
 github.com/dymensionxyz/evmos/v12 v12.1.6-dymension-v0.5.0-rc02 h1:G6rtzFNnzeYOHN33rkw0kMQX+xRantRLTip1AMXYmBg=
 github.com/dymensionxyz/evmos/v12 v12.1.6-dymension-v0.5.0-rc02/go.mod h1:CI6D89pkoiIm4BjoMFNnEaCLdKBEobLuwvhS0c1zh7Y=
 github.com/dymensionxyz/gerr-cosmos v1.0.0 h1:oi91rgOkpJWr41oX9JOyjvvBnhGY54tj513x8VlDAEc=