chore!: add signing-info migration

.changelog/unreleased/state-breaking/2866-migrate-signing-infos.md

@@ -0,0 +1,6 @@
+Migrate the signing infos of validators for which the consensus address
+ is missing, see https://github.com/cosmos/gaia/issues/1734
+ ([\#2866](https://github.com/cosmos/gaia/pull/2866))
+
+
+

app/upgrades/v15/upgrades.go

@@ -3,11 +3,17 @@ package v15
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+	slashingkeeper "github.com/cosmos/cosmos-sdk/x/slashing/keeper"
+	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
 	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 
 	"github.com/cosmos/gaia/v15/app/keepers"
 )
 
+// CreateUpgradeHandler returns a upgrade handler for Gaia v15
+// which executes the following migrations:
+//   - update the slashing module SigningInfos for which the consensus address is empty,
+//     see https://github.com/cosmos/gaia/issues/1734.
 func CreateUpgradeHandler(
 	mm *module.Manager,
 	configurator module.Configurator,
@@ -21,7 +27,34 @@ func CreateUpgradeHandler(
 			return vm, err
 		}
 
-		ctx.Logger().Info("Upgrade complete")
+		UpgradeSigningInfos(ctx, keepers.SlashingKeeper)
+
+		ctx.Logger().Info("Upgrade v15 complete")
 		return vm, err
 	}
 }
+
+// UpgradeSigningInfos updates the signing infos of validators for which
+// the consensus address is missing
+func UpgradeSigningInfos(ctx sdk.Context, sk slashingkeeper.Keeper) {
+	signingInfos := []slashingtypes.ValidatorSigningInfo{}
+
+	// update consensus address in signing info
+	// using the store key of validators
+	sk.IterateValidatorSigningInfos(ctx, func(address sdk.ConsAddress, info slashingtypes.ValidatorSigningInfo) (stop bool) {
+		if info.Address == "" {
+			info.Address = address.String()
+			signingInfos = append(signingInfos, info)
+		}
+
+		return false
+	})
+
+	for _, si := range signingInfos {
+		addr, err := sdk.ConsAddressFromBech32(si.Address)
+		if err != nil {
+			panic(err)
+		}
+		sk.SetValidatorSigningInfo(ctx, addr, si)
+	}
+}

app/upgrades/v15/upgrades_test.go

@@ -0,0 +1,71 @@
+package v15_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
+
+	"github.com/cosmos/cosmos-sdk/testutil/mock"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
+
+	"github.com/cosmos/gaia/v15/app/helpers"
+	v15 "github.com/cosmos/gaia/v15/app/upgrades/v15"
+)
+
+func TestUpgradeSigningInfos(t *testing.T) {
+	gaiaApp := helpers.Setup(t)
+	ctx := gaiaApp.NewUncachedContext(true, tmproto.Header{})
+	slashingKeeper := gaiaApp.SlashingKeeper
+
+	signingInfosNum := 8
+	emptyAddrCtr := 0
+
+	// create some dummy signing infos, half of which with an empty address field
+	for i := 0; i < signingInfosNum; i++ {
+		pubKey, err := mock.NewPV().GetPubKey()
+		require.NoError(t, err)
+
+		consAddr := sdk.ConsAddress(pubKey.Address())
+		info := slashingtypes.NewValidatorSigningInfo(
+			consAddr,
+			0,
+			0,
+			time.Unix(0, 0),
+			false,
+			0,
+		)
+
+		if i <= signingInfosNum/2 {
+			info.Address = ""
+			emptyAddrCtr++
+		}
+
+		slashingKeeper.SetValidatorSigningInfo(ctx, consAddr, info)
+		require.NoError(t, err)
+	}
+
+	// check signing info were correctly created
+	slashingKeeper.IterateValidatorSigningInfos(ctx, func(address sdk.ConsAddress, info slashingtypes.ValidatorSigningInfo) (stop bool) {
+		if info.Address == "" {
+			emptyAddrCtr--
+		}
+
+		return false
+	})
+	require.Zero(t, emptyAddrCtr)
+
+	// upgrade signing infos
+	v15.UpgradeSigningInfos(ctx, slashingKeeper)
+
+	// check that all signing info have the address field correctly updated
+	slashingKeeper.IterateValidatorSigningInfos(ctx, func(address sdk.ConsAddress, info slashingtypes.ValidatorSigningInfo) (stop bool) {
+		require.NotEmpty(t, info.Address)
+		require.Equal(t, address.String(), info.Address)
+
+		return false
+	})
+}