Update staking types

x/staking/types/errors.go

@@ -56,4 +56,5 @@ var (
 	ErrNeitherShareMsgsGiven           = sdkerrors.Register(ModuleName, 43, "neither shares amount nor shares percent provided")
 	ErrInvalidHistoricalInfo           = sdkerrors.Register(ModuleName, 44, "invalid historical info")
 	ErrNoHistoricalInfo                = sdkerrors.Register(ModuleName, 45, "no historical info found")
+	ErrEmptyValidatorPubKey            = sdkerrors.Register(ModuleName, 46, "empty validator public key")
 )

x/staking/types/historical_info.go

@@ -9,49 +9,19 @@ import (
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 )
 
-// HistoricalInfo contains the historical information that gets stored at each height
-type HistoricalInfo struct {
-	Header abci.Header `json:"header" yaml:"header"`
-	ValSet Validators  `json:"valset" yaml:"valset"`
-}
-
 // NewHistoricalInfo will create a historical information struct from header and valset
 // it will first sort valset before inclusion into historical info
 func NewHistoricalInfo(header abci.Header, valSet Validators) HistoricalInfo {
 	sort.Sort(valSet)
 	return HistoricalInfo{
 		Header: header,
-		ValSet: valSet,
-	}
-}
-
-// ToProto converts a HistoricalInfo into a HistoricalInfoProto type.
-func (hi HistoricalInfo) ToProto() HistoricalInfoProto {
-	valsetProto := make([]ValidatorProto, len(hi.ValSet))
-	for i, val := range hi.ValSet {
-		valsetProto[i] = val.ToProto()
-	}
-
-	return HistoricalInfoProto{
-		Header: hi.Header,
-		Valset: valsetProto,
+		Valset: valSet,
 	}
 }
 
-// ToHistoricalInfo converts a HistoricalInfoProto to a HistoricalInfo type.
-func (hip HistoricalInfoProto) ToHistoricalInfo() HistoricalInfo {
-	valset := make(Validators, len(hip.Valset))
-	for i, valProto := range hip.Valset {
-		valset[i] = valProto.ToValidator()
-	}
-
-	return NewHistoricalInfo(hip.Header, valset)
-}
-
 // MustMarshalHistoricalInfo wll marshal historical info and panic on error
 func MustMarshalHistoricalInfo(cdc codec.Marshaler, hi HistoricalInfo) []byte {
-	hiProto := hi.ToProto()
-	return cdc.MustMarshalBinaryLengthPrefixed(&hiProto)
+	return cdc.MustMarshalBinaryLengthPrefixed(&hi)
 }
 
 // MustUnmarshalHistoricalInfo wll unmarshal historical info and panic on error
@@ -65,21 +35,18 @@ func MustUnmarshalHistoricalInfo(cdc codec.Marshaler, value []byte) HistoricalIn
 
 // UnmarshalHistoricalInfo will unmarshal historical info and return any error
 func UnmarshalHistoricalInfo(cdc codec.Marshaler, value []byte) (hi HistoricalInfo, err error) {
-	hip := HistoricalInfoProto{}
-	if err := cdc.UnmarshalBinaryLengthPrefixed(value, &hip); err != nil {
-		return HistoricalInfo{}, err
-	}
-
-	return hip.ToHistoricalInfo(), nil
+	err = cdc.UnmarshalBinaryLengthPrefixed(value, &hi)
+	return hi, err
 }
 
 // ValidateBasic will ensure HistoricalInfo is not nil and sorted
 func ValidateBasic(hi HistoricalInfo) error {
-	if len(hi.ValSet) == 0 {
+	if len(hi.Valset) == 0 {
 		return sdkerrors.Wrap(ErrInvalidHistoricalInfo, "validator set is empty")
 	}
-	if !sort.IsSorted(Validators(hi.ValSet)) {
+	if !sort.IsSorted(Validators(hi.Valset)) {
 		return sdkerrors.Wrap(ErrInvalidHistoricalInfo, "validator set is not sorted by address")
 	}
+
 	return nil
 }

x/staking/types/historical_info_test.go

@@ -23,7 +23,7 @@ var (
 
 func TestHistoricalInfo(t *testing.T) {
 	hi := NewHistoricalInfo(header, validators)
-	require.True(t, sort.IsSorted(Validators(hi.ValSet)), "Validators are not sorted")
+	require.True(t, sort.IsSorted(Validators(hi.Valset)), "Validators are not sorted")
 
 	var value []byte
 	require.NotPanics(t, func() {
@@ -35,7 +35,7 @@ func TestHistoricalInfo(t *testing.T) {
 	recv, err := UnmarshalHistoricalInfo(ModuleCdc, value)
 	require.Nil(t, err, "Unmarshalling HistoricalInfo failed")
 	require.Equal(t, hi, recv, "Unmarshalled HistoricalInfo is different from original")
-	require.True(t, sort.IsSorted(Validators(hi.ValSet)), "Validators are not sorted")
+	require.True(t, sort.IsSorted(Validators(hi.Valset)), "Validators are not sorted")
 }
 
 func TestValidateBasic(t *testing.T) {
@@ -56,7 +56,7 @@ func TestValidateBasic(t *testing.T) {
 
 	hi = HistoricalInfo{
 		Header: header,
-		ValSet: validators,
+		Valset: validators,
 	}
 	err = ValidateBasic(hi)
 	require.Error(t, err, "ValidateBasic passed on unsorted ValSet")

x/staking/types/msg.go

@@ -2,16 +2,13 @@ package types
 
 import (
 	"bytes"
-	"encoding/json"
 
 	"github.com/tendermint/tendermint/crypto"
-	yaml "gopkg.in/yaml.v2"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 )
 
-// ensure Msg interface compliance at compile time
 var (
 	_ sdk.Msg = &MsgCreateValidator{}
 	_ sdk.Msg = &MsgEditValidator{}
@@ -20,41 +17,23 @@ var (
 	_ sdk.Msg = &MsgBeginRedelegate{}
 )
 
-//______________________________________________________________________
-
-// MsgCreateValidator - struct for bonding transactions
-type MsgCreateValidator struct {
-	Description       Description     `json:"description" yaml:"description"`
-	Commission        CommissionRates `json:"commission" yaml:"commission"`
-	MinSelfDelegation sdk.Int         `json:"min_self_delegation" yaml:"min_self_delegation"`
-	DelegatorAddress  sdk.AccAddress  `json:"delegator_address" yaml:"delegator_address"`
-	ValidatorAddress  sdk.ValAddress  `json:"validator_address" yaml:"validator_address"`
-	PubKey            crypto.PubKey   `json:"pubkey" yaml:"pubkey"`
-	Value             sdk.Coin        `json:"value" yaml:"value"`
-}
-
-type msgCreateValidatorJSON struct {
-	Description       Description     `json:"description" yaml:"description"`
-	Commission        CommissionRates `json:"commission" yaml:"commission"`
-	MinSelfDelegation sdk.Int         `json:"min_self_delegation" yaml:"min_self_delegation"`
-	DelegatorAddress  sdk.AccAddress  `json:"delegator_address" yaml:"delegator_address"`
-	ValidatorAddress  sdk.ValAddress  `json:"validator_address" yaml:"validator_address"`
-	PubKey            string          `json:"pubkey" yaml:"pubkey"`
-	Value             sdk.Coin        `json:"value" yaml:"value"`
-}
-
 // NewMsgCreateValidator creates a new MsgCreateValidator instance.
 // Delegator address and validator address are the same.
 func NewMsgCreateValidator(
 	valAddr sdk.ValAddress, pubKey crypto.PubKey, selfDelegation sdk.Coin,
 	description Description, commission CommissionRates, minSelfDelegation sdk.Int,
 ) MsgCreateValidator {
 
+	var pkStr string
+	if pubKey != nil {
+		pkStr = sdk.MustBech32ifyPubKey(sdk.Bech32PubKeyTypeConsPub, pubKey)
+	}
+
 	return MsgCreateValidator{
 		Description:       description,
 		DelegatorAddress:  sdk.AccAddress(valAddr),
 		ValidatorAddress:  valAddr,
-		PubKey:            pubKey,
+		Pubkey:            pkStr,
 		Value:             selfDelegation,
 		Commission:        commission,
 		MinSelfDelegation: minSelfDelegation,
@@ -81,70 +60,6 @@ func (msg MsgCreateValidator) GetSigners() []sdk.AccAddress {
 	return addrs
 }
 
-// MarshalJSON implements the json.Marshaler interface to provide custom JSON
-// serialization of the MsgCreateValidator type.
-func (msg MsgCreateValidator) MarshalJSON() ([]byte, error) {
-	return json.Marshal(msgCreateValidatorJSON{
-		Description:       msg.Description,
-		Commission:        msg.Commission,
-		DelegatorAddress:  msg.DelegatorAddress,
-		ValidatorAddress:  msg.ValidatorAddress,
-		PubKey:            sdk.MustBech32ifyPubKey(sdk.Bech32PubKeyTypeConsPub, msg.PubKey),
-		Value:             msg.Value,
-		MinSelfDelegation: msg.MinSelfDelegation,
-	})
-}
-
-// UnmarshalJSON implements the json.Unmarshaler interface to provide custom
-// JSON deserialization of the MsgCreateValidator type.
-func (msg *MsgCreateValidator) UnmarshalJSON(bz []byte) error {
-	var msgCreateValJSON msgCreateValidatorJSON
-	if err := json.Unmarshal(bz, &msgCreateValJSON); err != nil {
-		return err
-	}
-
-	msg.Description = msgCreateValJSON.Description
-	msg.Commission = msgCreateValJSON.Commission
-	msg.DelegatorAddress = msgCreateValJSON.DelegatorAddress
-	msg.ValidatorAddress = msgCreateValJSON.ValidatorAddress
-	var err error
-	msg.PubKey, err = sdk.GetPubKeyFromBech32(sdk.Bech32PubKeyTypeConsPub, msgCreateValJSON.PubKey)
-	if err != nil {
-		return err
-	}
-	msg.Value = msgCreateValJSON.Value
-	msg.MinSelfDelegation = msgCreateValJSON.MinSelfDelegation
-
-	return nil
-}
-
-// MarshalYAML implements a custom marshal yaml function due to consensus pubkey.
-func (msg MsgCreateValidator) MarshalYAML() (interface{}, error) {
-	bs, err := yaml.Marshal(struct {
-		Description       Description
-		Commission        CommissionRates
-		MinSelfDelegation sdk.Int
-		DelegatorAddress  sdk.AccAddress
-		ValidatorAddress  sdk.ValAddress
-		PubKey            string
-		Value             sdk.Coin
-	}{
-		Description:       msg.Description,
-		Commission:        msg.Commission,
-		MinSelfDelegation: msg.MinSelfDelegation,
-		DelegatorAddress:  msg.DelegatorAddress,
-		ValidatorAddress:  msg.ValidatorAddress,
-		PubKey:            sdk.MustBech32ifyPubKey(sdk.Bech32PubKeyTypeConsPub, msg.PubKey),
-		Value:             msg.Value,
-	})
-
-	if err != nil {
-		return nil, err
-	}
-
-	return string(bs), nil
-}
-
 // GetSignBytes returns the message bytes to sign over.
 func (msg MsgCreateValidator) GetSignBytes() []byte {
 	bz := ModuleCdc.MustMarshalJSON(msg)
@@ -163,6 +78,9 @@ func (msg MsgCreateValidator) ValidateBasic() error {
 	if !sdk.AccAddress(msg.ValidatorAddress).Equals(msg.DelegatorAddress) {
 		return ErrBadValidatorAddr
 	}
+	if msg.Pubkey == "" {
+		return ErrEmptyValidatorPubKey
+	}
 	if !msg.Value.Amount.IsPositive() {
 		return ErrBadDelegationAmount
 	}
@@ -185,20 +103,6 @@ func (msg MsgCreateValidator) ValidateBasic() error {
 	return nil
 }
 
-// MsgEditValidator - struct for editing a validator
-type MsgEditValidator struct {
-	Description      Description    `json:"description" yaml:"description"`
-	ValidatorAddress sdk.ValAddress `json:"address" yaml:"address"`
-
-	// We pass a reference to the new commission rate and min self delegation as it's not mandatory to
-	// update. If not updated, the deserialized rate will be zero with no way to
-	// distinguish if an update was intended.
-	//
-	// REF: #2373
-	CommissionRate    *sdk.Dec `json:"commission_rate" yaml:"commission_rate"`
-	MinSelfDelegation *sdk.Int `json:"min_self_delegation" yaml:"min_self_delegation"`
-}
-
 // NewMsgEditValidator creates a new MsgEditValidator instance
 func NewMsgEditValidator(valAddr sdk.ValAddress, description Description, newRate *sdk.Dec, newMinSelfDelegation *sdk.Int) MsgEditValidator {
 	return MsgEditValidator{
@@ -246,13 +150,6 @@ func (msg MsgEditValidator) ValidateBasic() error {
 	return nil
 }
 
-// MsgDelegate - struct for bonding transactions
-type MsgDelegate struct {
-	DelegatorAddress sdk.AccAddress `json:"delegator_address" yaml:"delegator_address"`
-	ValidatorAddress sdk.ValAddress `json:"validator_address" yaml:"validator_address"`
-	Amount           sdk.Coin       `json:"amount" yaml:"amount"`
-}
-
 // NewMsgDelegate creates a new MsgDelegate instance.
 func NewMsgDelegate(delAddr sdk.AccAddress, valAddr sdk.ValAddress, amount sdk.Coin) MsgDelegate {
 	return MsgDelegate{
@@ -293,16 +190,6 @@ func (msg MsgDelegate) ValidateBasic() error {
 	return nil
 }
 
-//______________________________________________________________________
-
-// MsgBeginRedelegate defines the attributes of a bonding transaction.
-type MsgBeginRedelegate struct {
-	DelegatorAddress    sdk.AccAddress `json:"delegator_address" yaml:"delegator_address"`
-	ValidatorSrcAddress sdk.ValAddress `json:"validator_src_address" yaml:"validator_src_address"`
-	ValidatorDstAddress sdk.ValAddress `json:"validator_dst_address" yaml:"validator_dst_address"`
-	Amount              sdk.Coin       `json:"amount" yaml:"amount"`
-}
-
 // NewMsgBeginRedelegate creates a new MsgBeginRedelegate instance.
 func NewMsgBeginRedelegate(
 	delAddr sdk.AccAddress, valSrcAddr, valDstAddr sdk.ValAddress, amount sdk.Coin,
@@ -349,13 +236,6 @@ func (msg MsgBeginRedelegate) ValidateBasic() error {
 	return nil
 }
 
-// MsgUndelegate - struct for unbonding transactions
-type MsgUndelegate struct {
-	DelegatorAddress sdk.AccAddress `json:"delegator_address" yaml:"delegator_address"`
-	ValidatorAddress sdk.ValAddress `json:"validator_address" yaml:"validator_address"`
-	Amount           sdk.Coin       `json:"amount" yaml:"amount"`
-}
-
 // NewMsgUndelegate creates a new MsgUndelegate instance.
 func NewMsgUndelegate(delAddr sdk.AccAddress, valAddr sdk.ValAddress, amount sdk.Coin) MsgUndelegate {
 	return MsgUndelegate{

x/staking/types/msg_test.go

@@ -1,11 +1,8 @@
 package types
 
 import (
-	"fmt"
 	"testing"
 
-	yaml "gopkg.in/yaml.v2"
-
 	"github.com/stretchr/testify/require"
 	"github.com/tendermint/tendermint/crypto"
 
@@ -157,47 +154,3 @@ func TestMsgUndelegate(t *testing.T) {
 		}
 	}
 }
-
-//test to validate if NewMsgCreateValidator implements yaml marshaller
-func TestMsgMarshalYAML(t *testing.T) {
-	commission1 := NewCommissionRates(sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec())
-	tc := struct {
-		name, moniker, identity, website, securityContact, details string
-		CommissionRates                                            CommissionRates
-		minSelfDelegation                                          sdk.Int
-		validatorAddr                                              sdk.ValAddress
-		pubkey                                                     crypto.PubKey
-		bond                                                       sdk.Coin
-		expectPass                                                 bool
-	}{"basic good", "a", "b", "c", "d", "e", commission1, sdk.OneInt(), valAddr1, pk1, coinPos, true}
-
-	description := NewDescription(tc.moniker, tc.identity, tc.website, tc.securityContact, tc.details)
-	msg := NewMsgCreateValidator(tc.validatorAddr, tc.pubkey, tc.bond, description, tc.CommissionRates, tc.minSelfDelegation)
-	bs, err := yaml.Marshal(msg)
-	require.NoError(t, err)
-	bechifiedPub, err := sdk.Bech32ifyPubKey(sdk.Bech32PubKeyTypeConsPub, msg.PubKey)
-	require.NoError(t, err)
-
-	want := fmt.Sprintf(`|
-  description:
-    moniker: a
-    identity: b
-    website: c
-    security_contact: d
-    details: e
-  commission:
-    rate: "0.000000000000000000"
-    max_rate: "0.000000000000000000"
-    max_change_rate: "0.000000000000000000"
-  minselfdelegation: "1"
-  delegatoraddress: %s
-  validatoraddress: %s
-  pubkey: %s
-  value:
-    denom: stake
-    amount: "1000"
-`, msg.DelegatorAddress, msg.ValidatorAddress, bechifiedPub)
-
-	require.Equal(t, want, string(bs))
-
-}