Regen Network/Slashing protobuf

CHANGELOG.md

@@ -80,6 +80,11 @@ for JSON encoding.
   * Every reference of `crypto.Pubkey` in context of a `Validator` is now of type string. `GetPubKeyFromBech32` must be used to get the `crypto.Pubkey`.
   * The `Keeper` constructor now takes a `codec.Marshaler` instead of a concrete Amino codec. This exact type
   provided is specified by `ModuleCdc`.
+* (x/slashing) [\#5627](https://github.com/cosmos/cosmos-sdk/pull/5627) Migrate the `x/slashing` module to use Protocol Buffer for state
+serialization instead of Amino. The exact codec used is `codec.HybridCodec` which utilizes Protobuf for binary encoding and Amino
+for JSON encoding.
+  * The `Keeper` constructor now takes a `codec.Marshaler` instead of a concrete Amino codec. This exact type
+  provided is specified by `ModuleCdc`.
 * (distr) [\#5610](https://github.com/cosmos/cosmos-sdk/pull/5610) Migrate the `x/distribution` module to use Protocol Buffer for state
 serialization instead of Amino. The exact codec used is `codec.HybridCodec` which utilizes Protobuf for binary encoding and Amino
 for JSON encoding.

simapp/app.go

@@ -183,7 +183,7 @@ func NewSimApp(
 		app.SupplyKeeper, auth.FeeCollectorName, app.ModuleAccountAddrs(),
 	)
 	app.SlashingKeeper = slashing.NewKeeper(
-		app.cdc, keys[slashing.StoreKey], &stakingKeeper, app.subspaces[slashing.ModuleName],
+		appCodec.Slashing, keys[slashing.StoreKey], &stakingKeeper, app.subspaces[slashing.ModuleName],
 	)
 	app.CrisisKeeper = crisis.NewKeeper(
 		app.subspaces[crisis.ModuleName], invCheckPeriod, app.SupplyKeeper, auth.FeeCollectorName,

simapp/codec.go

@@ -6,6 +6,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
 	distr "github.com/cosmos/cosmos-sdk/x/distribution"
 	"github.com/cosmos/cosmos-sdk/x/params"
+	"github.com/cosmos/cosmos-sdk/x/slashing"
 	"github.com/cosmos/cosmos-sdk/x/staking"
 )
 
@@ -15,6 +16,7 @@ type AppCodec struct {
 	amino *codec.Codec
 
 	Params       *params.Codec
+	Slashing     *slashing.Codec
 	Staking      *staking.Codec
 	Distribution *distr.Codec
 }
@@ -26,6 +28,7 @@ func NewAppCodec() *AppCodec {
 		amino:        amino,
 		Params:       params.NewCodec(amino),
 		Staking:      staking.NewCodec(amino),
+		Slashing:     slashing.NewCodec(amino),
 		Distribution: distr.NewCodec(amino),
 	}
 }

types/proto.go

@@ -1,7 +1,7 @@
 package types
 
 import (
-	_ "github.com/gogo/protobuf/gogoproto" // nolint
+	_ "github.com/gogo/protobuf/gogoproto"    // nolint
 	_ "github.com/regen-network/cosmos-proto" // nolint
 )
 

x/slashing/alias.go

@@ -34,6 +34,7 @@ const (
 
 var (
 	// functions aliases
+
 	NewKeeper                                = keeper.NewKeeper
 	NewQuerier                               = keeper.NewQuerier
 	RegisterCodec                            = types.RegisterCodec
@@ -62,6 +63,7 @@ var (
 	NewValidatorSigningInfo                  = types.NewValidatorSigningInfo
 
 	// variable aliases
+	NewCodec                        = types.NewCodec
 	ModuleCdc                       = types.ModuleCdc
 	ValidatorSigningInfoKey         = types.ValidatorSigningInfoKey
 	ValidatorMissedBlockBitArrayKey = types.ValidatorMissedBlockBitArrayKey
@@ -79,6 +81,7 @@ var (
 type (
 	Hooks                   = keeper.Hooks
 	Keeper                  = keeper.Keeper
+	Codec                   = types.Codec
 	GenesisState            = types.GenesisState
 	MissedBlock             = types.MissedBlock
 	MsgUnjail               = types.MsgUnjail

x/slashing/app_test.go

@@ -85,4 +85,4 @@ func TestSlashingMsgs(t *testing.T) {
 	require.Error(t, err)
 	require.Nil(t, res)
 	require.True(t, errors.Is(slashing.ErrValidatorNotJailed, err))
-}
+}

x/slashing/client/cli/query.go

@@ -68,7 +68,11 @@ $ <appcli> query slashing signing-info cosmosvalconspub1zcjduepqfhvwcmt7p06fvdge
 			}
 
 			var signingInfo types.ValidatorSigningInfo
-			cdc.MustUnmarshalBinaryLengthPrefixed(res, &signingInfo)
+			signingInfo, err = types.UnmarshalValSigningInfo(types.ModuleCdc, res)
+			if err != nil {
+				return err
+			}
+
 			return cliCtx.PrintOutput(signingInfo)
 		},
 	}

x/slashing/handler.go

@@ -33,7 +33,7 @@ func handleMsgUnjail(ctx sdk.Context, msg MsgUnjail, k Keeper) (*sdk.Result, err
 		sdk.NewEvent(
 			sdk.EventTypeMessage,
 			sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
-			sdk.NewAttribute(sdk.AttributeKeySender, msg.ValidatorAddr.String()),
+			sdk.NewAttribute(sdk.AttributeKeySender, string(msg.ValidatorAddr)),
 		),
 	)
 

x/slashing/internal/keeper/keeper.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"fmt"
 
+	gogotypes "github.com/gogo/protobuf/types"
+
 	"github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/libs/log"
 
@@ -14,13 +16,13 @@ import (
 // Keeper of the slashing store
 type Keeper struct {
 	storeKey   sdk.StoreKey
-	cdc        *codec.Codec
+	cdc        codec.Marshaler
 	sk         types.StakingKeeper
 	paramspace types.ParamSubspace
 }
 
 // NewKeeper creates a slashing keeper
-func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, sk types.StakingKeeper, paramspace types.ParamSubspace) Keeper {
+func NewKeeper(cdc codec.Marshaler, key sdk.StoreKey, sk types.StakingKeeper, paramspace types.ParamSubspace) Keeper {
 	return Keeper{
 		storeKey:   key,
 		cdc:        cdc,
@@ -37,18 +39,31 @@ func (k Keeper) Logger(ctx sdk.Context) log.Logger {
 // AddPubkey sets a address-pubkey relation
 func (k Keeper) AddPubkey(ctx sdk.Context, pubkey crypto.PubKey) {
 	addr := pubkey.Address()
-	k.setAddrPubkeyRelation(ctx, addr, pubkey)
+
+	pkStr, err := sdk.Bech32ifyPubKey(sdk.Bech32PubKeyTypeConsPub, pubkey)
+	if err != nil {
+		panic(fmt.Errorf("error while setting address-pubkey relation: %s", addr))
+	}
+
+	k.setAddrPubkeyRelation(ctx, addr, pkStr)
 }
 
 // GetPubkey returns the pubkey from the adddress-pubkey relation
 func (k Keeper) GetPubkey(ctx sdk.Context, address crypto.Address) (crypto.PubKey, error) {
 	store := ctx.KVStore(k.storeKey)
-	var pubkey crypto.PubKey
+
+	var pubkey gogotypes.StringValue
 	err := k.cdc.UnmarshalBinaryLengthPrefixed(store.Get(types.GetAddrPubkeyRelationKey(address)), &pubkey)
 	if err != nil {
 		return nil, fmt.Errorf("address %s not found", sdk.ConsAddress(address))
 	}
-	return pubkey, nil
+
+	pkStr, err := sdk.GetPubKeyFromBech32(sdk.Bech32PubKeyTypeConsPub, pubkey.Value)
+	if err != nil {
+		return pkStr, err
+	}
+
+	return pkStr, nil
 }
 
 // Slash attempts to slash a validator. The slash is delegated to the staking
@@ -79,9 +94,10 @@ func (k Keeper) Jail(ctx sdk.Context, consAddr sdk.ConsAddress) {
 	k.sk.Jail(ctx, consAddr)
 }
 
-func (k Keeper) setAddrPubkeyRelation(ctx sdk.Context, addr crypto.Address, pubkey crypto.PubKey) {
+func (k Keeper) setAddrPubkeyRelation(ctx sdk.Context, addr crypto.Address, pubkey string) {
 	store := ctx.KVStore(k.storeKey)
-	bz := k.cdc.MustMarshalBinaryLengthPrefixed(pubkey)
+
+	bz := k.cdc.MustMarshalBinaryLengthPrefixed(&gogotypes.StringValue{Value: pubkey})
 	store.Set(types.GetAddrPubkeyRelationKey(addr), bz)
 }
 

x/slashing/internal/keeper/querier.go

@@ -76,7 +76,7 @@ func querySigningInfos(ctx sdk.Context, req abci.RequestQuery, k Keeper) ([]byte
 		return false
 	})
 
-	start, end := client.Paginate(len(signingInfos), params.Page, params.Limit, int(k.sk.MaxValidators(ctx)))
+	start, end := client.Paginate(len(signingInfos), int(params.Page), int(params.Limit), int(k.sk.MaxValidators(ctx)))
 	if start < 0 || end < 0 {
 		signingInfos = []types.ValidatorSigningInfo{}
 	} else {

x/slashing/internal/keeper/signing_info.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"time"
 
+	gogotypes "github.com/gogo/protobuf/types"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/slashing/internal/types"
 )
@@ -31,7 +33,7 @@ func (k Keeper) HasValidatorSigningInfo(ctx sdk.Context, consAddr sdk.ConsAddres
 // SetValidatorSigningInfo sets the validator signing info to a consensus address key
 func (k Keeper) SetValidatorSigningInfo(ctx sdk.Context, address sdk.ConsAddress, info types.ValidatorSigningInfo) {
 	store := ctx.KVStore(k.storeKey)
-	bz := k.cdc.MustMarshalBinaryLengthPrefixed(info)
+	bz := k.cdc.MustMarshalBinaryLengthPrefixed(&info)
 	store.Set(types.GetValidatorSigningInfoKey(address), bz)
 }
 
@@ -53,16 +55,17 @@ func (k Keeper) IterateValidatorSigningInfos(ctx sdk.Context,
 }
 
 // GetValidatorMissedBlockBitArray gets the bit for the missed blocks array
-func (k Keeper) GetValidatorMissedBlockBitArray(ctx sdk.Context, address sdk.ConsAddress, index int64) (missed bool) {
+func (k Keeper) GetValidatorMissedBlockBitArray(ctx sdk.Context, address sdk.ConsAddress, index int64) bool {
 	store := ctx.KVStore(k.storeKey)
 	bz := store.Get(types.GetValidatorMissedBlockBitArrayKey(address, index))
+	var missed gogotypes.BoolValue
 	if bz == nil {
 		// lazy: treat empty key as not missed
-		missed = false
-		return
+		return false
 	}
 	k.cdc.MustUnmarshalBinaryLengthPrefixed(bz, &missed)
-	return
+
+	return missed.Value
 }
 
 // IterateValidatorMissedBlockBitArray iterates over the signed blocks window
@@ -79,7 +82,7 @@ func (k Keeper) IterateValidatorMissedBlockBitArray(ctx sdk.Context,
 		if bz == nil {
 			continue
 		}
-		k.cdc.MustUnmarshalBinaryLengthPrefixed(bz, &missed)
+		k.cdc.MustUnmarshalBinaryLengthPrefixed(bz, &gogotypes.BoolValue{Value: missed})
 		if handler(index, missed) {
 			break
 		}
@@ -128,7 +131,7 @@ func (k Keeper) IsTombstoned(ctx sdk.Context, consAddr sdk.ConsAddress) bool {
 // missed a block in the current window
 func (k Keeper) SetValidatorMissedBlockBitArray(ctx sdk.Context, address sdk.ConsAddress, index int64, missed bool) {
 	store := ctx.KVStore(k.storeKey)
-	bz := k.cdc.MustMarshalBinaryLengthPrefixed(missed)
+	bz := k.cdc.MustMarshalBinaryLengthPrefixed(&gogotypes.BoolValue{Value: missed})
 	store.Set(types.GetValidatorMissedBlockBitArrayKey(address, index), bz)
 }
 

x/slashing/internal/keeper/test_common.go

@@ -121,7 +121,7 @@ func CreateTestInput(t *testing.T, defaults types.Params) (sdk.Context, bank.Kee
 	}
 
 	paramstore := paramsKeeper.Subspace(types.DefaultParamspace)
-	keeper := NewKeeper(cdc, keySlashing, &sk, paramstore)
+	keeper := NewKeeper(types.ModuleCdc, keySlashing, &sk, paramstore)
 
 	keeper.SetParams(ctx, defaults)
 	sk.SetHooks(keeper.Hooks())

x/slashing/internal/types/codec.go

@@ -9,12 +9,22 @@ func RegisterCodec(cdc *codec.Codec) {
 	cdc.RegisterConcrete(MsgUnjail{}, "cosmos-sdk/MsgUnjail", nil)
 }
 
-// ModuleCdc defines the module codec
-var ModuleCdc *codec.Codec
+type Codec struct {
+	codec.Marshaler
+	// Keep reference to the amino codec to allow backwards compatibility along
+	// with type, and interface registration.
+
+	amino *codec.Codec
+}
+
+func NewCodec(amino *codec.Codec) *Codec {
+	return &Codec{Marshaler: codec.NewHybridCodec(amino), amino: amino}
+}
+
+var ModuleCdc *Codec
 
 func init() {
-	ModuleCdc = codec.New()
-	RegisterCodec(ModuleCdc)
-	codec.RegisterCrypto(ModuleCdc)
-	ModuleCdc.Seal()
+	ModuleCdc = NewCodec(codec.New())
+	RegisterCodec(ModuleCdc.amino)
+	ModuleCdc.amino.Seal()
 }

x/slashing/internal/types/msg.go

@@ -7,11 +7,6 @@ import (
 // verify interface at compile time
 var _ sdk.Msg = &MsgUnjail{}
 
-// MsgUnjail - struct for unjailing jailed validator
-type MsgUnjail struct {
-	ValidatorAddr sdk.ValAddress `json:"address" yaml:"address"` // address of the validator operator
-}
-
 // NewMsgUnjail creates a new MsgUnjail instance
 func NewMsgUnjail(validatorAddr sdk.ValAddress) MsgUnjail {
 	return MsgUnjail{
@@ -37,5 +32,6 @@ func (msg MsgUnjail) ValidateBasic() error {
 	if msg.ValidatorAddr.Empty() {
 		return ErrBadValidatorAddr
 	}
+
 	return nil
 }

x/slashing/internal/types/signing_info.go

@@ -4,19 +4,11 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/cosmos/cosmos-sdk/codec"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-// ValidatorSigningInfo defines the signing info for a validator
-type ValidatorSigningInfo struct {
-	Address             sdk.ConsAddress `json:"address" yaml:"address"`                             // validator consensus address
-	StartHeight         int64           `json:"start_height" yaml:"start_height"`                   // height at which validator was first a candidate OR was unjailed
-	IndexOffset         int64           `json:"index_offset" yaml:"index_offset"`                   // index offset into signed block bit array
-	JailedUntil         time.Time       `json:"jailed_until" yaml:"jailed_until"`                   // timestamp validator cannot be unjailed until
-	Tombstoned          bool            `json:"tombstoned" yaml:"tombstoned"`                       // whether or not a validator has been tombstoned (killed out of validator set)
-	MissedBlocksCounter int64           `json:"missed_blocks_counter" yaml:"missed_blocks_counter"` // missed blocks counter (to avoid scanning the array every time)
-}
-
 // NewValidatorSigningInfo creates a new ValidatorSigningInfo instance
 func NewValidatorSigningInfo(
 	condAddr sdk.ConsAddress, startHeight, indexOffset int64,
@@ -45,3 +37,9 @@ func (i ValidatorSigningInfo) String() string {
 		i.Address, i.StartHeight, i.IndexOffset, i.JailedUntil,
 		i.Tombstoned, i.MissedBlocksCounter)
 }
+
+// unmarshal a validator signing info from a store value
+func UnmarshalValSigningInfo(cdc codec.Marshaler, value []byte) (signingInfo ValidatorSigningInfo, err error) {
+	err = cdc.UnmarshalBinaryLengthPrefixed(value, &signingInfo)
+	return signingInfo, err
+}