fix v3 migrate

Author: JayT106

go.sum

@@ -614,8 +614,6 @@ cloud.google.com/go/workflows v1.7.0/go.mod h1:JhSrZuVZWuiDfKEFxU0/F1PQjmpnpcoIS
 cloud.google.com/go/workflows v1.8.0/go.mod h1:ysGhmEajwZxGn1OhGOGKsTXc5PyxOc0vfKf5Af+to4M=
 cloud.google.com/go/workflows v1.9.0/go.mod h1:ZGkj1aFIOd9c8Gerkjjq7OW7I5+l6cSvT3ujaO/WwSA=
 cloud.google.com/go/workflows v1.10.0/go.mod h1:fZ8LmRmZQWacon9UCX1r/g/DfAXx5VcPALq2CxzdePw=
-cosmossdk.io/api v1.0.0-rc.1 h1:KwZHIMveoeg6YVwvKZxJLp7be5uk6qmnqNAar2tPxVU=
-cosmossdk.io/api v1.0.0-rc.1/go.mod h1:8YOT+XjVFb9eZJk62YqjFILOm8MlLhbnkC9/jxIYri8=
 cosmossdk.io/collections v1.3.1 h1:09e+DUId2brWsNOQ4nrk+bprVmMUaDH9xvtZkeqIjVw=
 cosmossdk.io/collections v1.3.1/go.mod h1:ynvkP0r5ruAjbmedE+vQ07MT6OtJ0ZIDKrtJHK7Q/4c=
 cosmossdk.io/core v1.1.0-rc.1 h1:VhF5xd4uJZt/lQzbl8qT1W3Pcrklp4RSnugcWQZyf5M=

x/gov/types/config.go

@@ -1,6 +1,6 @@
 package types
 
-// Config is a config struct used for initialising the gov module to avoid using globals.
+// Config is a config struct used for initializing the gov module to avoid using globals.
 type Config struct {
 	// MaxMetadataLen defines the maximum proposal metadata length.
 	MaxMetadataLen uint64

x/mint/keeper/migrator.go

@@ -1,12 +1,10 @@
 package keeper
 
 import (
-	"context"
-
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/mint/exported"
 	v2 "github.com/cosmos/cosmos-sdk/x/mint/migrations/v2"
-	"github.com/cosmos/cosmos-sdk/x/mint/types"
+	v3 "github.com/cosmos/cosmos-sdk/x/mint/migrations/v3"
 )
 
 // Migrator is a struct for handling in-place state migrations.
@@ -33,21 +31,6 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error {
 
 // Migrate2to3 migrates the x/mint module state from the consensus version 2 to
 // version 3.
-func (m Migrator) Migrate2to3(ctx context.Context) error {
-	params, err := m.keeper.Params.Get(ctx)
-	if err != nil {
-		return err
-	}
-
-	// Initialize the new MaxSupply parameter with the default value
-	defaultParams := types.DefaultParams()
-	params.MaxSupply = defaultParams.MaxSupply
-
-	// Set the updated params
-	err = m.keeper.Params.Set(ctx, params)
-	if err != nil {
-		return err
-	}
-
-	return nil
+func (m Migrator) Migrate2to3(ctx sdk.Context) error {
+	return v3.Migrate(ctx, m.keeper.storeService.OpenKVStore(ctx), m.keeper.cdc, m.keeper.Params)
 }

x/mint/migrations/v3/migrate.go

@@ -0,0 +1,39 @@
+package v3
+
+import (
+	"cosmossdk.io/collections"
+	storetypes "cosmossdk.io/core/store"
+	"cosmossdk.io/math"
+
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/mint/types"
+)
+
+const (
+	ModuleName = "mint"
+)
+
+var ParamsKey = []byte{0x01}
+
+// Migrate migrates the x/mint module state from the consensus version 2 to
+// version 3.
+func Migrate(
+	ctx sdk.Context,
+	store storetypes.KVStore,
+	cdc codec.BinaryCodec,
+	params collections.Item[types.Params],
+) error {
+	currParams, err := params.Get(ctx)
+	if err != nil {
+		return err
+	}
+
+	currParams.MaxSupply = math.NewInt(0)
+	if err := currParams.Validate(); err != nil {
+		return err
+	}
+
+	bz := cdc.MustMarshal(&currParams)
+	return store.Set(ParamsKey, bz)
+}

x/mint/migrations/v3/migrator_test.go

@@ -0,0 +1,50 @@
+package v3_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"cosmossdk.io/collections"
+	storetypes "cosmossdk.io/store/types"
+
+	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/runtime"
+	"github.com/cosmos/cosmos-sdk/testutil"
+	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
+	"github.com/cosmos/cosmos-sdk/x/mint"
+	v3 "github.com/cosmos/cosmos-sdk/x/mint/migrations/v3"
+	"github.com/cosmos/cosmos-sdk/x/mint/types"
+)
+
+type mockSubspace struct {
+	ps types.Params
+}
+
+func newMockSubspace(ps types.Params) mockSubspace {
+	return mockSubspace{ps: ps}
+}
+
+func TestMigrate(t *testing.T) {
+	encCfg := moduletestutil.MakeTestEncodingConfig(mint.AppModuleBasic{})
+	cdc := encCfg.Codec
+
+	storeKey := storetypes.NewKVStoreKey(v3.ModuleName)
+	tKey := storetypes.NewTransientStoreKey("transient_test")
+	ctx := testutil.DefaultContext(storeKey, tKey)
+	kvStoreService := runtime.NewKVStoreService(storeKey)
+	store := kvStoreService.OpenKVStore(ctx)
+
+	sb := collections.NewSchemaBuilder(kvStoreService)
+	params := collections.NewItem(sb, v3.ParamsKey, "params", codec.CollValue[types.Params](cdc))
+
+	dp := newMockSubspace(types.DefaultParams())
+	require.NoError(t, params.Set(ctx, dp.ps))
+	require.NoError(t, v3.Migrate(ctx, store, cdc, params))
+
+	var res types.Params
+	bz, err := store.Get(v3.ParamsKey)
+	require.NoError(t, err)
+	require.NoError(t, cdc.Unmarshal(bz, &res))
+	require.Equal(t, dp.ps, res)
+}

x/mint/module.go

@@ -133,6 +133,10 @@ func (am AppModule) RegisterServices(cfg module.Configurator) {
 	if err := cfg.RegisterMigration(types.ModuleName, 1, m.Migrate1to2); err != nil {
 		panic(fmt.Sprintf("failed to migrate x/%s from version 1 to 2: %v", types.ModuleName, err))
 	}
+
+	if err := cfg.RegisterMigration(types.ModuleName, 2, m.Migrate2to3); err != nil {
+		panic(fmt.Sprintf("failed to migrate x/%s from version 2 to 3: %v", types.ModuleName, err))
+	}
 }
 
 // InitGenesis performs genesis initialization for the mint module. It returns