upgrade to v2.0.0-rc.13

Author: keithsue

api/side/dlc/dlc.pulsar.go

@@ -162,6 +162,7 @@ import (
 	upgradev2rc10 "github.com/sideprotocol/side/app/upgrades/v2_rc10"
 	upgradev2rc11 "github.com/sideprotocol/side/app/upgrades/v2_rc11"
 	upgradev2rc12 "github.com/sideprotocol/side/app/upgrades/v2_rc12"
+	upgradev2rc13 "github.com/sideprotocol/side/app/upgrades/v2_rc13"
 	upgradev2rc8 "github.com/sideprotocol/side/app/upgrades/v2_rc8"
 	upgradev2rc9 "github.com/sideprotocol/side/app/upgrades/v2_rc9"
 )
@@ -1338,6 +1339,7 @@ func (app *App) SetUpgradeHandlers() {
 	app.UpgradeKeeper.SetUpgradeHandler(upgradev2rc10.UpgradeName, upgradev2rc10.CreateUpgradeHandler(app.ModuleManager, app.configurator))
 	app.UpgradeKeeper.SetUpgradeHandler(upgradev2rc11.UpgradeName, upgradev2rc11.CreateUpgradeHandler(app.ModuleManager, app.configurator))
 	app.UpgradeKeeper.SetUpgradeHandler(upgradev2rc12.UpgradeName, upgradev2rc12.CreateUpgradeHandler(app.ModuleManager, app.configurator))
+	app.UpgradeKeeper.SetUpgradeHandler(upgradev2rc13.UpgradeName, upgradev2rc13.CreateUpgradeHandler(app.ModuleManager, app.configurator))
 
 	upgradeInfo, err := app.UpgradeKeeper.ReadUpgradeInfoFromDisk()
 	if err != nil {

app/app.go

@@ -0,0 +1,21 @@
+package v2_rc13
+
+import (
+	"context"
+
+	upgradetypes "cosmossdk.io/x/upgrade/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+)
+
+// UpgradeName is the upgrade version name
+const UpgradeName = "v2.0.0-rc.13"
+
+// CreateUpgradeHandler creates the upgrade handler
+func CreateUpgradeHandler(
+	mm *module.Manager,
+	configurator module.Configurator,
+) upgradetypes.UpgradeHandler {
+	return func(ctx context.Context, _ upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
+		return mm.RunMigrations(ctx, configurator, vm)
+	}
+}

app/upgrades/v2_rc13/upgrade.go

@@ -21,6 +21,15 @@ message DLCOracle {
     DLCOracleStatus status = 7;
 }
 
+message DLCOracleV1 {
+    uint64 id = 1;
+    string desc = 2;
+    string pubkey = 3;
+    uint64 nonce_index = 4;
+    google.protobuf.Timestamp time = 5 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
+    DLCOracleStatus status = 6;
+}
+
 enum DCMStatus {
     DCM_status_Enable = 0;
     DCM_status_Disable = 1;
@@ -35,6 +44,14 @@ message DCM {
     DCMStatus status = 6;
 }
 
+message DCMV1 {
+    uint64 id = 1;
+    string desc = 2;
+    string pubkey = 3;
+    google.protobuf.Timestamp time = 4 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
+    DCMStatus status = 5;
+}
+
 message DLCNonce {
     uint64 index = 1;
     string nonce = 2;

proto/side/dlc/dlc.proto

@@ -0,0 +1,24 @@
+package keeper
+
+import (
+	storetypes "cosmossdk.io/store/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	v2 "github.com/sideprotocol/side/x/dlc/migrations/v2"
+	tsstypes "github.com/sideprotocol/side/x/tss/types"
+)
+
+// Migrator is a struct for handling in-place store migrations
+type Migrator struct {
+	keeper Keeper
+}
+
+// NewMigrator returns a new Migrator
+func NewMigrator(keeper Keeper) Migrator {
+	return Migrator{keeper: keeper}
+}
+
+// Migrate1to2 migrates from version 1 to 2
+func (m Migrator) Migrate1to2(ctx sdk.Context) error {
+	return v2.MigrateStore(ctx, m.keeper.storeKey, storetypes.NewKVStoreKey(tsstypes.StoreKey), m.keeper.cdc)
+}

x/dlc/keeper/migrations.go

@@ -0,0 +1,121 @@
+package v2
+
+import (
+	"encoding/hex"
+
+	storetypes "cosmossdk.io/store/types"
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/sideprotocol/side/x/dlc/types"
+	tsstypes "github.com/sideprotocol/side/x/tss/types"
+)
+
+// MigrateStore migrates the x/dlc module state from the consensus version 1 to
+// version 2
+func MigrateStore(ctx sdk.Context, storeKey storetypes.StoreKey, tssStoreKey storetypes.StoreKey, cdc codec.BinaryCodec) error {
+	migrateDLCEvents(ctx, storeKey, cdc)
+	migrateDCMsAndOracles(ctx, storeKey, tssStoreKey, cdc)
+
+	return nil
+}
+
+// migrateDLCEvents performs the dlc events migration
+func migrateDLCEvents(ctx sdk.Context, storeKey storetypes.StoreKey, cdc codec.BinaryCodec) {
+	store := ctx.KVStore(storeKey)
+
+	iterator := storetypes.KVStorePrefixIterator(store, types.EventKeyPrefix)
+	defer iterator.Close()
+
+	for ; iterator.Valid(); iterator.Next() {
+		var dlcEvent types.DLCEvent
+		cdc.MustUnmarshal(iterator.Value(), &dlcEvent)
+
+		// set the DKG request by status
+		store.Set(types.EventByStatusKey(dlcEvent.HasTriggered, dlcEvent.Id), []byte{})
+	}
+}
+
+// migrateDCMsAndOracles performs the DCMs and oracles migration
+func migrateDCMsAndOracles(ctx sdk.Context, storeKey storetypes.StoreKey, tssStoreKey storetypes.StoreKey, cdc codec.BinaryCodec) {
+	tssStore := ctx.KVStore(tssStoreKey)
+
+	iterator := storetypes.KVStorePrefixIterator(tssStore, tsstypes.DKGRequestKeyPrefix)
+	defer iterator.Close()
+
+	for ; iterator.Valid(); iterator.Next() {
+		var dkgRequest tsstypes.DKGRequest
+		cdc.MustUnmarshal(iterator.Value(), &dkgRequest)
+
+		if dkgRequest.Status != tsstypes.DKGStatus_DKG_STATUS_COMPLETED {
+			continue
+		}
+
+		bz := tssStore.Get(tsstypes.DKGCompletionKey(dkgRequest.Id, dkgRequest.Participants[0]))
+		var dkgCompletion tsstypes.DKGCompletion
+		cdc.MustUnmarshal(bz, &dkgCompletion)
+
+		// DCM or oracle pub key
+		pubKey := dkgCompletion.PubKeys[0]
+		pubKeyBz, _ := hex.DecodeString(pubKey)
+
+		if dkgRequest.Type == types.DKG_TYPE_DCM {
+			updateDCM(ctx, storeKey, dkgRequest.Id, pubKeyBz, cdc)
+		} else if dkgRequest.Type == types.DKG_TYPE_NONCE {
+			updateOracle(ctx, storeKey, dkgRequest.Id, pubKeyBz, cdc)
+		}
+	}
+}
+
+// updateDCM updates the given dcm
+func updateDCM(ctx sdk.Context, storeKey storetypes.StoreKey, dkgId uint64, pubKey []byte, cdc codec.BinaryCodec) {
+	store := ctx.KVStore(storeKey)
+
+	bz := store.Get(types.DCMByPubKeyKey(pubKey))
+	id := sdk.BigEndianToUint64(bz)
+
+	// unmarshal to DCM v1
+	dcmBz := store.Get(types.DCMKey(id))
+	var dcmV1 types.DCMV1
+	cdc.MustUnmarshal(dcmBz, &dcmV1)
+
+	// build new DCM
+	dcm := &types.DCM{
+		Id:     id,
+		DkgId:  dkgId,
+		Desc:   dcmV1.Desc,
+		Pubkey: dcmV1.Pubkey,
+		Time:   dcmV1.Time,
+		Status: dcmV1.Status,
+	}
+
+	// update DCM
+	store.Set(types.DCMKey(id), cdc.MustMarshal(dcm))
+}
+
+// updateOracle updates the given oracle
+func updateOracle(ctx sdk.Context, storeKey storetypes.StoreKey, dkgId uint64, pubKey []byte, cdc codec.BinaryCodec) {
+	store := ctx.KVStore(storeKey)
+
+	bz := store.Get(types.OracleByPubKeyKey(pubKey))
+	id := sdk.BigEndianToUint64(bz)
+
+	// unmarshal to oracle v1
+	oracleBz := store.Get(types.OracleKey(id))
+	var oracleV1 types.DLCOracleV1
+	cdc.MustUnmarshal(oracleBz, &oracleV1)
+
+	// build new oracle
+	oracle := &types.DLCOracle{
+		Id:         id,
+		DkgId:      dkgId,
+		Desc:       oracleV1.Desc,
+		Pubkey:     oracleV1.Pubkey,
+		NonceIndex: oracleV1.NonceIndex,
+		Time:       oracleV1.Time,
+		Status:     oracleV1.Status,
+	}
+
+	// update oracle
+	store.Set(types.OracleKey(id), cdc.MustMarshal(oracle))
+}

x/dlc/migrations/v2/store.go

@@ -23,6 +23,9 @@ import (
 	"github.com/sideprotocol/side/x/dlc/types"
 )
 
+// ConsensusVersion defines the current x/dlc module consensus version.
+const ConsensusVersion = 2
+
 var (
 	_ module.AppModule      = AppModule{}
 	_ module.AppModuleBasic = AppModuleBasic{}
@@ -118,6 +121,11 @@ func (am AppModule) IsAppModule() {}
 func (am AppModule) RegisterServices(cfg module.Configurator) {
 	types.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
 	types.RegisterQueryServer(cfg.QueryServer(), am.keeper)
+
+	m := keeper.NewMigrator(am.keeper)
+	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))
+	}
 }
 
 // RegisterInvariants registers the invariants of the module. If an invariant deviates from its predicted value, the InvariantRegistry triggers appropriate logic (most often the chain will be halted)
@@ -141,7 +149,7 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.Raw
 }
 
 // ConsensusVersion is a sequence number for state-breaking change of the module. It should be incremented on each consensus-breaking change introduced by the module. To avoid wrong/empty versions, the initial version should be set to 1
-func (AppModule) ConsensusVersion() uint64 { return 1 }
+func (AppModule) ConsensusVersion() uint64 { return ConsensusVersion }
 
 // BeginBlock contains the logic that is automatically triggered at the beginning of each block
 func (am AppModule) BeginBlock(_ context.Context) error {