feat(store/v2): build the migration manager in the root store factory

store/v2/commitment/metadata.go

@@ -11,9 +11,9 @@ import (
 )
 
 const (
-	commitInfoKeyFmt      = "c/%d" // c/<version>
-	latestVersionKey      = "c/latest"
-	removedStoreKeyPrefix = "c/removed/" // c/removed/<version>/<store-name>
+	commitInfoKeyFmt      = "s/%d" // c/<version>
+	latestVersionKey      = "s/latest"
+	removedStoreKeyPrefix = "s/removed/" // c/removed/<version>/<store-name>
 )
 
 // MetadataStore is a store for metadata related to the commitment store.

store/v2/root/factory.go

@@ -13,7 +13,9 @@ import (
 	"cosmossdk.io/store/v2/commitment/mem"
 	"cosmossdk.io/store/v2/db"
 	"cosmossdk.io/store/v2/internal"
+	"cosmossdk.io/store/v2/migration"
 	"cosmossdk.io/store/v2/pruning"
+	"cosmossdk.io/store/v2/snapshots"
 	"cosmossdk.io/store/v2/storage"
 	"cosmossdk.io/store/v2/storage/pebbledb"
 	"cosmossdk.io/store/v2/storage/rocksdb"
@@ -33,6 +35,8 @@ const (
 	SCTypeIavlV2 SCType = "iavl-v2"
 )
 
+const storePrefixTpl = "s/k:%s/" // s/k:<storeKey>
+
 // Options are the options for creating a root store.
 type Options struct {
 	SSType          SSType               `mapstructure:"ss-type" toml:"ss-type" comment:"State storage database type. Currently we support: \"sqlite\", \"pebble\" and \"rocksdb\""`
@@ -139,13 +143,13 @@ func CreateRootStore(opts *FactoryOptions) (store.RootStore, error) {
 		return nil, err
 	}
 
-	newTreeFn := func(key string) (commitment.Tree, error) {
+	newTreeFn := func(key string, scType SCType) (commitment.Tree, error) {
 		if internal.IsMemoryStoreKey(key) {
 			return mem.New(), nil
 		} else {
-			switch storeOpts.SCType {
+			switch scType {
 			case SCTypeIavl:
-				return iavl.NewIavlTree(db.NewPrefixDB(opts.SCRawDB, []byte(key)), opts.Logger, storeOpts.IavlConfig), nil
+				return iavl.NewIavlTree(db.NewPrefixDB(opts.SCRawDB, []byte(fmt.Sprintf(storePrefixTpl, key))), opts.Logger, storeOpts.IavlConfig), nil
 			case SCTypeIavlV2:
 				return nil, errors.New("iavl v2 not supported")
 			default:
@@ -154,17 +158,31 @@ func CreateRootStore(opts *FactoryOptions) (store.RootStore, error) {
 		}
 	}
 
+	// check if we need to migrate the store
+	isMigrating := false
+	scType := storeOpts.SCType
+	ssLatestVersion, err := ss.GetLatestVersion()
+	if err != nil {
+		return nil, err
+	}
+	if ssLatestVersion != latestVersion {
+		isMigrating = true // need to migrate
+		if scType != SCTypeIavl {
+			scType = SCTypeIavl // only support iavl v1 for migration
+		}
+	}
+
 	trees := make(map[string]commitment.Tree, len(opts.StoreKeys))
 	for _, key := range opts.StoreKeys {
-		tree, err := newTreeFn(key)
+		tree, err := newTreeFn(key, scType)
 		if err != nil {
 			return nil, err
 		}
 		trees[key] = tree
 	}
 	oldTrees := make(map[string]commitment.Tree, len(opts.StoreKeys))
 	for _, key := range removedStoreKeys {
-		tree, err := newTreeFn(string(key))
+		tree, err := newTreeFn(string(key), scType)
 		if err != nil {
 			return nil, err
 		}
@@ -176,6 +194,31 @@ func CreateRootStore(opts *FactoryOptions) (store.RootStore, error) {
 		return nil, err
 	}
 
+	var mm *migration.Manager
+	if isMigrating {
+		snapshotDB, err := snapshots.NewStore(fmt.Sprintf("%s/data/snapshots/store.db", opts.RootDir))
+		if err != nil {
+			return nil, err
+		}
+		snapshotMgr := snapshots.NewManager(snapshotDB, snapshots.SnapshotOptions{}, sc, nil, nil, opts.Logger)
+		var newSC *commitment.CommitStore
+		if scType != storeOpts.SCType {
+			newTrees := make(map[string]commitment.Tree, len(opts.StoreKeys))
+			for _, key := range opts.StoreKeys {
+				tree, err := newTreeFn(key, storeOpts.SCType)
+				if err != nil {
+					return nil, err
+				}
+				newTrees[key] = tree
+			}
+			newSC, err = commitment.NewCommitStore(newTrees, nil, opts.SCRawDB, opts.Logger)
+			if err != nil {
+				return nil, err
+			}
+		}
+		mm = migration.NewManager(opts.SCRawDB, snapshotMgr, ss, newSC, opts.Logger)
+	}
+
 	pm := pruning.NewManager(sc, ss, storeOpts.SCPruningOption, storeOpts.SSPruningOption)
-	return New(opts.SCRawDB, opts.Logger, ss, sc, pm, nil, nil)
+	return New(opts.SCRawDB, opts.Logger, ss, sc, pm, mm, nil)
 }

store/v2/root/factory_test.go

@@ -1,12 +1,15 @@
 package root
 
 import (
+	"bytes"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 
+	corestore "cosmossdk.io/core/store"
 	coretesting "cosmossdk.io/core/testing"
 	"cosmossdk.io/store/v2/db"
+	"cosmossdk.io/store/v2/internal/encoding"
 )
 
 func TestFactory(t *testing.T) {
@@ -26,4 +29,20 @@ func TestFactory(t *testing.T) {
 	f, err = CreateRootStore(&fop)
 	require.Error(t, err)
 	require.Nil(t, f)
+
+	require.NoError(t, setLatestVersion(fop.SCRawDB, 1))
+	fop.Options.SCType = SCTypeIavl
+	f, err = CreateRootStore(&fop)
+	require.NoError(t, err)
+	require.NotNil(t, f)
+	require.True(t, f.(*Store).isMigrating)
+}
+
+func setLatestVersion(db corestore.KVStoreWithBatch, version uint64) error {
+	var buf bytes.Buffer
+	buf.Grow(encoding.EncodeUvarintSize(version))
+	if err := encoding.EncodeUvarint(&buf, version); err != nil {
+		return err
+	}
+	return db.Set([]byte("c/latest"), buf.Bytes())
 }