Skip to content

Commit

Permalink
feat: increment consensus ver and register migration (#1295)
Browse files Browse the repository at this point in the history
* increment consensus ver and register migration

* Update CHANGELOG.md

* Update migration.go

* Update module.go

(cherry picked from commit 27ef1d2)
  • Loading branch information
shaspitz authored and mergify[bot] committed Sep 19, 2023
1 parent 27e7368 commit 61d9523
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Note:

Changes:

* (feat) [#1295](https://github.com/cosmos/interchain-security/pull/1295) increment consumer consensus version and register consumer packet migration.
* (fix!) [#1262](https://github.com/cosmos/interchain-security/pull/1262) Remove incorrect address validation on `ProviderFeePoolAddrStr` param.
* (feature!) [#1244](https://github.com/cosmos/interchain-security/pull/1244) Update the default consumer unbonding period to 2 weeks.
* (fix!) [#1244](https://github.com/cosmos/interchain-security/pull/1244) Validate token transfer messages before calling `Transfer()`.
Expand Down
13 changes: 9 additions & 4 deletions x/ccv/consumer/keeper/migration.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,27 @@ func NewMigrator(ccvConsumerKeeper Keeper, ccvConsumerParamSpace paramtypes.Subs
return Migrator{ccvConsumerKeeper: ccvConsumerKeeper, ccvConsumerParamSpace: ccvConsumerParamSpace}
}

// Migrate1to2 migrates x/ccvconsumer state from consensus version 1 to 2.
func (m Migrator) Migrate1to2(ctx sdk.Context) error {
return m.ccvConsumerKeeper.MigrateConsumerPacketData(ctx)
}

// MigrateConsumerPacketData migrates consumer packet data according to
// https://github.com/cosmos/interchain-security/pull/1037
//
// Note an equivalent migration is not required for providers.
func (k Keeper) MigrateConsumerPacketData(ctx sdk.Context) {
func (k Keeper) MigrateConsumerPacketData(ctx sdk.Context) error {
// deserialize packet data from old format
var depreciatedType ccvtypes.ConsumerPacketDataList
store := ctx.KVStore(k.storeKey)
bz := store.Get([]byte{consumertypes.PendingDataPacketsBytePrefix})
if bz == nil {
ctx.Logger().Info("no pending data packets to migrate")
return
return nil
}
err := depreciatedType.Unmarshal(bz)
if err != nil {
// An error here would indicate something is very wrong
panic(fmt.Errorf("failed to unmarshal pending data packets: %w", err))
return fmt.Errorf("failed to unmarshal pending data packets: %w", err)
}

// Delete old data
Expand All @@ -48,6 +52,7 @@ func (k Keeper) MigrateConsumerPacketData(ctx sdk.Context) {
for _, data := range depreciatedType.List {
k.AppendPendingPacket(ctx, data.Type, data.Data)
}
return nil
}

// TODO: the following hackyness could be removed if we're able to reference older versions of ICS.
Expand Down
12 changes: 6 additions & 6 deletions x/ccv/consumer/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,11 @@ func (AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {
// RegisterServices registers module services.
func (am AppModule) RegisterServices(cfg module.Configurator) {
consumertypes.RegisterQueryServer(cfg.QueryServer(), am.keeper)

m := keeper.NewMigrator(am.keeper, am.paramSpace)
if err := cfg.RegisterMigration(consumertypes.ModuleName, 1, m.Migrate1to2); err != nil {
panic(fmt.Sprintf("failed to register migrator for %s: %s", consumertypes.ModuleName, err))
}
}

// InitGenesis performs genesis initialization for the consumer module. It returns
Expand All @@ -126,12 +131,7 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.Raw

// ConsensusVersion implements AppModule/ConsensusVersion.
func (AppModule) ConsensusVersion() uint64 {
// Note that v1.0.0 consumers should technically be on a different consensus version
// than v1.2.0-multiden and v2.0.0. However, Neutron was the first consumer to launch
// in prod, and they've started on v1.2.0-multiden (which has a ConsensusVersion of 1).
//
// v1.2.0-multiden and v2.0.0 are consensus compatible, so they need return the same ConsensusVersion of 1.
return 1
return 2
}

// BeginBlock implements the AppModule interface
Expand Down

0 comments on commit 61d9523

Please sign in to comment.