Update auth types

CHANGELOG.md

@@ -75,15 +75,15 @@ is the latest height, we'll use the store's `lastCommitInfo`. Otherwise, we fetc
   * Callers to `NewBaseVestingAccount` are responsible for verifying account balance in relation to
   the original vesting amount.
   * The `SendKeeper` and `ViewKeeper` interfaces in `x/bank` have been modified to account for changes.
-* (staking) [\#5600](https://github.com/cosmos/cosmos-sdk/pull/5600) Migrate the `x/staking` module to use Protocol Buffer for state
+* (x/staking) [\#5600](https://github.com/cosmos/cosmos-sdk/pull/5600) Migrate the `x/staking` 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.
   * `BondStatus` is now of type `int32` instead of `byte`.
   * Types of `int16` in the `Params` type are now of type `int32`.
   * 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`.
-* (distr) [\#5610](https://github.com/cosmos/cosmos-sdk/pull/5610) Migrate the `x/distribution` module to use Protocol Buffer for state
+* (x/distribution) [\#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.
   * `ValidatorHistoricalRewards.ReferenceCount` is now of types `uint32` instead of `uint16`.
@@ -92,6 +92,15 @@ for JSON encoding.
   * `ValidatorAccumulatedCommission` is now a struct with `commission`.
   * The `Keeper` constructor now takes a `codec.Marshaler` instead of a concrete Amino codec. This exact type
   provided is specified by `ModuleCdc`.
+* (x/auth) [\#5533](https://github.com/cosmos/cosmos-sdk/pull/5533) Migrate the `x/auth` module to use Protocol Buffer for state
+serialization instead of Amino.
+  * The `BaseAccount.PubKey` field is now represented as a Bech32 string instead of a `crypto.Pubkey`.
+  * `NewBaseAccountWithAddress` now returns a reference to a `BaseAccount`.
+  * Rename `Account` interface to `AccountI`.
+  * The `x/auth` module now accepts an `AuthCodec` which extends the `codec.Marshaler` interface by
+  requiring a concrete codec to know to serialize accounts.
+  * The `AccountRetriever` type now accepts an `AuthCodec` in its constructor in order to know how to
+  serialize accounts.
 
 ### Improvements
 

x/auth/types/account.go

@@ -2,8 +2,8 @@ package types
 
 import (
 	"bytes"
-	"encoding/json"
 	"errors"
+	"fmt"
 
 	"github.com/tendermint/tendermint/crypto"
 	yaml "gopkg.in/yaml.v2"
@@ -15,38 +15,32 @@ import (
 //-----------------------------------------------------------------------------
 // BaseAccount
 
-var _ exported.Account = (*BaseAccount)(nil)
+var _ exported.AccountI = (*BaseAccount)(nil)
 var _ exported.GenesisAccount = (*BaseAccount)(nil)
 
-// BaseAccount - a base account structure.
-// This can be extended by embedding within in your AppAccount.
-// However one doesn't have to use BaseAccount as long as your struct
-// implements Account.
-type BaseAccount struct {
-	Address       sdk.AccAddress `json:"address" yaml:"address"`
-	PubKey        crypto.PubKey  `json:"public_key" yaml:"public_key"`
-	AccountNumber uint64         `json:"account_number" yaml:"account_number"`
-	Sequence      uint64         `json:"sequence" yaml:"sequence"`
-}
-
 // NewBaseAccount creates a new BaseAccount object
 func NewBaseAccount(address sdk.AccAddress, pubKey crypto.PubKey, accountNumber, sequence uint64) *BaseAccount {
+	var pkStr string
+	if pubKey != nil {
+		pkStr = sdk.MustBech32ifyPubKey(sdk.Bech32PubKeyTypeAccPub, pubKey)
+	}
+
 	return &BaseAccount{
 		Address:       address,
-		PubKey:        pubKey,
+		PubKey:        pkStr,
 		AccountNumber: accountNumber,
 		Sequence:      sequence,
 	}
 }
 
 // ProtoBaseAccount - a prototype function for BaseAccount
-func ProtoBaseAccount() exported.Account {
+func ProtoBaseAccount() exported.AccountI {
 	return &BaseAccount{}
 }
 
 // NewBaseAccountWithAddress - returns a new base account with a given address
-func NewBaseAccountWithAddress(addr sdk.AccAddress) BaseAccount {
-	return BaseAccount{
+func NewBaseAccountWithAddress(addr sdk.AccAddress) *BaseAccount {
+	return &BaseAccount{
 		Address: addr,
 	}
 }
@@ -61,23 +55,40 @@ func (acc *BaseAccount) SetAddress(addr sdk.AccAddress) error {
 	if len(acc.Address) != 0 {
 		return errors.New("cannot override BaseAccount address")
 	}
+
 	acc.Address = addr
 	return nil
 }
 
 // GetPubKey - Implements sdk.Account.
 func (acc BaseAccount) GetPubKey() crypto.PubKey {
-	return acc.PubKey
+	if acc.PubKey == "" {
+		return nil
+	}
+
+	return sdk.MustGetPubKeyFromBech32(sdk.Bech32PubKeyTypeAccPub, acc.PubKey)
 }
 
 // SetPubKey - Implements sdk.Account.
 func (acc *BaseAccount) SetPubKey(pubKey crypto.PubKey) error {
-	acc.PubKey = pubKey
+	var (
+		pkStr string
+		err   error
+	)
+
+	if pubKey != nil {
+		pkStr, err = sdk.Bech32ifyPubKey(sdk.Bech32PubKeyTypeAccPub, pubKey)
+		if err != nil {
+			return err
+		}
+	}
+
+	acc.PubKey = pkStr
 	return nil
 }
 
 // GetAccountNumber - Implements Account
-func (acc *BaseAccount) GetAccountNumber() uint64 {
+func (acc BaseAccount) GetAccountNumber() uint64 {
 	return acc.AccountNumber
 }
 
@@ -88,7 +99,7 @@ func (acc *BaseAccount) SetAccountNumber(accNumber uint64) error {
 }
 
 // GetSequence - Implements sdk.Account.
-func (acc *BaseAccount) GetSequence() uint64 {
+func (acc BaseAccount) GetSequence() uint64 {
 	return acc.Sequence
 }
 
@@ -100,90 +111,41 @@ func (acc *BaseAccount) SetSequence(seq uint64) error {
 
 // Validate checks for errors on the account fields
 func (acc BaseAccount) Validate() error {
-	if acc.PubKey != nil && acc.Address != nil &&
-		!bytes.Equal(acc.PubKey.Address().Bytes(), acc.Address.Bytes()) {
+	if acc.PubKey != "" && acc.Address != nil &&
+		!bytes.Equal(acc.GetPubKey().Address().Bytes(), acc.Address.Bytes()) {
 		return errors.New("pubkey and address pair is invalid")
 	}
 
 	return nil
 }
 
-type baseAccountPretty struct {
-	Address       sdk.AccAddress `json:"address" yaml:"address"`
-	PubKey        string         `json:"public_key" yaml:"public_key"`
-	AccountNumber uint64         `json:"account_number" yaml:"account_number"`
-	Sequence      uint64         `json:"sequence" yaml:"sequence"`
-}
-
 func (acc BaseAccount) String() string {
-	out, _ := acc.MarshalYAML()
-	return out.(string)
+	out, _ := yaml.Marshal(acc)
+	return string(out)
 }
 
-// MarshalYAML returns the YAML representation of an account.
-func (acc BaseAccount) MarshalYAML() (interface{}, error) {
-	alias := baseAccountPretty{
-		Address:       acc.Address,
-		AccountNumber: acc.AccountNumber,
-		Sequence:      acc.Sequence,
+// SetAccountI sets the Account's oneof sum type to the provided AccountI type.
+// The provided AccountI type must be a reference to a BaseAccount.
+func (acc *Account) SetAccountI(value exported.AccountI) error {
+	if value == nil {
+		acc.Sum = nil
+		return nil
 	}
 
-	if acc.PubKey != nil {
-		pks, err := sdk.Bech32ifyPubKey(sdk.Bech32PubKeyTypeAccPub, acc.PubKey)
-		if err != nil {
-			return nil, err
-		}
-
-		alias.PubKey = pks
+	baseAcc, ok := value.(*BaseAccount)
+	if ok {
+		acc.Sum = &Account_BaseAccount{baseAcc}
+		return nil
 	}
 
-	bz, err := yaml.Marshal(alias)
-	if err != nil {
-		return nil, err
-	}
-
-	return string(bz), err
-}
-
-// MarshalJSON returns the JSON representation of a BaseAccount.
-func (acc BaseAccount) MarshalJSON() ([]byte, error) {
-	alias := baseAccountPretty{
-		Address:       acc.Address,
-		AccountNumber: acc.AccountNumber,
-		Sequence:      acc.Sequence,
-	}
-
-	if acc.PubKey != nil {
-		pks, err := sdk.Bech32ifyPubKey(sdk.Bech32PubKeyTypeAccPub, acc.PubKey)
-		if err != nil {
-			return nil, err
-		}
-
-		alias.PubKey = pks
-	}
-
-	return json.Marshal(alias)
+	return fmt.Errorf("failed to encode value of type %T as message AccountI", value)
 }
 
-// UnmarshalJSON unmarshals raw JSON bytes into a BaseAccount.
-func (acc *BaseAccount) UnmarshalJSON(bz []byte) error {
-	var alias baseAccountPretty
-	if err := json.Unmarshal(bz, &alias); err != nil {
-		return err
+// GetAccountI returns an AccountI based on the internal oneof sum type.
+func (acc *Account) GetAccountI() exported.AccountI {
+	if x := acc.GetBaseAccount(); x != nil {
+		return x
 	}
 
-	if alias.PubKey != "" {
-		pk, err := sdk.GetPubKeyFromBech32(sdk.Bech32PubKeyTypeAccPub, alias.PubKey)
-		if err != nil {
-			return err
-		}
-
-		acc.PubKey = pk
-	}
-
-	acc.Address = alias.Address
-	acc.AccountNumber = alias.AccountNumber
-	acc.Sequence = alias.Sequence
-
 	return nil
 }

x/auth/types/account_retriever_test.go

@@ -1,7 +1,6 @@
 package types
 
 import (
-	"encoding/json"
 	"errors"
 	"testing"
 
@@ -18,9 +17,9 @@ func TestAccountRetriever(t *testing.T) {
 	defer mockCtrl.Finish()
 
 	mockNodeQuerier := mocks.NewMockNodeQuerier(mockCtrl)
-	accRetr := NewAccountRetriever(NewCodec(nil), mockNodeQuerier)
+	accRetr := NewAccountRetriever(ModuleCdc, mockNodeQuerier)
 	addr := []byte("test")
-	bs, err := json.Marshal(NewQueryAccountParams(addr))
+	bs, err := ModuleCdc.MarshalJSON(NewQueryAccountParams(addr))
 	require.NoError(t, err)
 
 	mockNodeQuerier.EXPECT().QueryWithData(gomock.Eq("custom/acc/account"),

x/auth/types/account_test.go

@@ -1,7 +1,6 @@
 package types
 
 import (
-	"encoding/json"
 	"errors"
 	"testing"
 
@@ -115,27 +114,3 @@ func TestGenesisAccountValidate(t *testing.T) {
 		})
 	}
 }
-
-func TestBaseAccountJSON(t *testing.T) {
-	pubkey := secp256k1.GenPrivKey().PubKey()
-	addr := sdk.AccAddress(pubkey.Address())
-	baseAcc := NewBaseAccount(addr, pubkey, 10, 50)
-
-	bz, err := json.Marshal(baseAcc)
-	require.NoError(t, err)
-
-	bz1, err := baseAcc.MarshalJSON()
-	require.NoError(t, err)
-	require.Equal(t, string(bz1), string(bz))
-
-	var a BaseAccount
-	require.NoError(t, json.Unmarshal(bz, &a))
-	require.Equal(t, baseAcc.String(), a.String())
-
-	bz, err = ModuleCdc.MarshalJSON(baseAcc)
-	require.NoError(t, err)
-
-	var b BaseAccount
-	require.NoError(t, ModuleCdc.UnmarshalJSON(bz, &b))
-	require.Equal(t, baseAcc.String(), b.String())
-}

x/auth/types/codec.go

@@ -28,7 +28,7 @@ type Codec struct {
 }
 
 func NewCodec(amino *codec.Codec) *Codec {
-	return &Codec{Marshaler: codec.NewBaseCodec(amino), amino: amino}
+	return &Codec{Marshaler: codec.NewHybridCodec(amino), amino: amino}
 }
 
 // MarshalAccount marshals an AccountI interface. If the given type implements
@@ -72,7 +72,7 @@ func (c *Codec) UnmarshalAccountJSON(bz []byte) (exported.AccountI, error) {
 //
 // NOTE: This codec is deprecated, where a codec via NewCodec without an Amino
 // codec should be used.
-var ModuleCDC = NewCodec(codec.New())
+var ModuleCdc = NewCodec(codec.New())
 
 // RegisterCodec registers concrete types on the codec
 func RegisterCodec(cdc *codec.Codec) {
@@ -85,10 +85,10 @@ func RegisterCodec(cdc *codec.Codec) {
 // RegisterAccountTypeCodec registers an external account type defined in
 // another module for the internal ModuleCdc.
 func RegisterAccountTypeCodec(o interface{}, name string) {
-	ModuleCDC.amino.RegisterConcrete(o, name, nil)
+	ModuleCdc.amino.RegisterConcrete(o, name, nil)
 }
 
 func init() {
-	RegisterCodec(ModuleCDC.amino)
-	codec.RegisterCrypto(ModuleCDC.amino)
+	RegisterCodec(ModuleCdc.amino)
+	codec.RegisterCrypto(ModuleCdc.amino)
 }

x/auth/types/genesis.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"sort"
 
-	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/x/auth/exported"
 )
 
@@ -30,7 +29,7 @@ func DefaultGenesisState() GenesisState {
 
 // GetGenesisStateFromAppState returns x/auth GenesisState given raw application
 // genesis state.
-func GetGenesisStateFromAppState(cdc *codec.Codec, appState map[string]json.RawMessage) GenesisState {
+func GetGenesisStateFromAppState(cdc AuthCodec, appState map[string]json.RawMessage) GenesisState {
 	var genesisState GenesisState
 	if appState[ModuleName] != nil {
 		cdc.MustUnmarshalJSON(appState[ModuleName], &genesisState)
@@ -86,7 +85,7 @@ type GenesisAccountIterator struct{}
 // appGenesis and invokes a callback on each genesis account. If any call
 // returns true, iteration stops.
 func (GenesisAccountIterator) IterateGenesisAccounts(
-	cdc *codec.Codec, appGenesis map[string]json.RawMessage, cb func(exported.Account) (stop bool),
+	cdc AuthCodec, appGenesis map[string]json.RawMessage, cb func(exported.AccountI) (stop bool),
 ) {
 
 	for _, genAcc := range GetGenesisStateFromAppState(cdc, appGenesis).Accounts {