Move codec.RegisterCrypto and codec.Cdc to new packages (#6330)

* Move codec.Cdc to legacy_global.Cdc * Update CHANGELOG.md * Updates * nit * Fix imports * Updates * Use cosmos multisig instead of tendermint multisig everywhere * Fix tests * Rename legacy_global -> legacy * Add doc.go * Linting, move all RegisterCrypto calls to crypto/codec * Update crypto/codec/amino.go Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
cosmos · Jun 4, 2020 · 81d647e · 81d647e
1 parent dcbf152
commit 81d647e
Show file tree

Hide file tree

Showing 62 changed files with 216 additions and 133 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -129,6 +129,7 @@ be used to retrieve the actual proposal `Content`. Also the `NewMsgSubmitProposa
 * (client/rpc) [\#6290](https://github.com/cosmos/cosmos-sdk/pull/6290) `RegisterRoutes` of rpc is moved from package client to client/rpc and client/rpc.RegisterRPCRoutes is removed.
 * (client/lcd) [\#6290](https://github.com/cosmos/cosmos-sdk/pull/6290) `CliCtx` of struct `RestServer` in package client/lcd has been renamed to `ClientCtx`.
 * (types) [\#6327](https://github.com/cosmos/cosmos-sdk/pull/6327) `sdk.Msg` now inherits `proto.Message`, as a result all `sdk.Msg` types now use pointer semantics.
+* (codec) [\#6330](https://github.com/cosmos/cosmos-sdk/pull/6330) `codec.RegisterCrypto` has been moved to the `crypto/codec` package and the global `codec.Cdc` Amino instance has been deprecated and moved to the `codec/legacy_global` package. 
 
 ### Features
 

diff --git a/client/keys/add.go b/client/keys/add.go
@@ -14,13 +14,13 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/input"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
 	"github.com/tendermint/tendermint/crypto"
-	"github.com/tendermint/tendermint/crypto/multisig"
 	"github.com/tendermint/tendermint/libs/cli"
 )
 

diff --git a/client/keys/codec.go b/client/keys/codec.go
@@ -2,14 +2,15 @@ package keys
 
 import (
 	"github.com/cosmos/cosmos-sdk/codec"
+	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
 )
 
 // KeysCdc defines codec to be used with key operations
 var KeysCdc *codec.Codec
 
 func init() {
 	KeysCdc = codec.New()
-	codec.RegisterCrypto(KeysCdc)
+	cryptocodec.RegisterCrypto(KeysCdc)
 	KeysCdc.Seal()
 }
 

diff --git a/client/keys/show.go b/client/keys/show.go
@@ -8,12 +8,12 @@ import (
 	"github.com/spf13/viper"
 
 	tmcrypto "github.com/tendermint/tendermint/crypto"
-	"github.com/tendermint/tendermint/crypto/multisig"
 	"github.com/tendermint/tendermint/libs/cli"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/crypto"
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 

diff --git a/client/keys/show_test.go b/client/keys/show_test.go
@@ -7,12 +7,12 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/tendermint/tendermint/crypto"
-	"github.com/tendermint/tendermint/crypto/multisig"
 	"github.com/tendermint/tendermint/crypto/secp256k1"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	"github.com/cosmos/cosmos-sdk/tests"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/client/rpc/block.go b/client/rpc/block.go
@@ -11,7 +11,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
-	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/codec/legacy"
 	"github.com/cosmos/cosmos-sdk/types/rest"
 
 	tmliteProxy "github.com/tendermint/tendermint/lite/proxy"
@@ -65,10 +65,10 @@ func getBlock(clientCtx client.Context, height *int64) ([]byte, error) {
 	}
 
 	if clientCtx.Indent {
-		return codec.Cdc.MarshalJSONIndent(res, "", "  ")
+		return legacy.Cdc.MarshalJSONIndent(res, "", "  ")
 	}
 
-	return codec.Cdc.MarshalJSON(res)
+	return legacy.Cdc.MarshalJSON(res)
 }
 
 // get the current blockchain height

diff --git a/client/rpc/status.go b/client/rpc/status.go
@@ -11,7 +11,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
-	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/codec/legacy"
 	"github.com/cosmos/cosmos-sdk/types/rest"
 	"github.com/cosmos/cosmos-sdk/version"
 
@@ -55,9 +55,9 @@ func printNodeStatus(_ *cobra.Command, _ []string) error {
 
 	var output []byte
 	if clientCtx.Indent {
-		output, err = codec.Cdc.MarshalJSONIndent(status, "", "  ")
+		output, err = legacy.Cdc.MarshalJSONIndent(status, "", "  ")
 	} else {
-		output, err = codec.Cdc.MarshalJSON(status)
+		output, err = legacy.Cdc.MarshalJSON(status)
 	}
 	if err != nil {
 		return err

diff --git a/codec/amino.go b/codec/amino.go
@@ -4,27 +4,14 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"io"
 
 	amino "github.com/tendermint/go-amino"
-	cryptoamino "github.com/tendermint/tendermint/crypto/encoding/amino"
 	tmtypes "github.com/tendermint/tendermint/types"
 
 	"github.com/cosmos/cosmos-sdk/codec/types"
 )
 
-// Cdc defines a global generic sealed Amino codec to be used throughout sdk. It
-// has all Tendermint crypto and evidence types registered.
-//
-// TODO: Consider removing this global.
-var Cdc *Codec
-
-func init() {
-	Cdc = New()
-	RegisterCrypto(Cdc)
-	RegisterEvidences(Cdc)
-	Cdc.Seal()
-}
-
 // deprecated: Codec defines a wrapper for an Amino codec that properly handles protobuf
 // types with Any's
 type Codec struct {
@@ -41,12 +28,6 @@ func New() *Codec {
 	return &Codec{amino.NewCodec()}
 }
 
-// RegisterCrypto registers all crypto dependency types with the provided Amino
-// codec.
-func RegisterCrypto(cdc *Codec) {
-	cryptoamino.RegisterAmino(cdc.Amino)
-}
-
 // RegisterEvidences registers Tendermint evidence types with the provided Amino
 // codec.
 func RegisterEvidences(cdc *Codec) {
@@ -208,3 +189,7 @@ func (cdc *Codec) MarshalJSONIndent(o interface{}, prefix, indent string) ([]byt
 	}
 	return cdc.Amino.MarshalJSONIndent(o, prefix, indent)
 }
+
+func (cdc *Codec) PrintTypes(out io.Writer) error {
+	return cdc.Amino.PrintTypes(out)
+}
diff --git a/codec/legacy/codec.go b/codec/legacy/codec.go
@@ -0,0 +1,19 @@
+package legacy
+
+import (
+	"github.com/cosmos/cosmos-sdk/codec"
+	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
+)
+
+// Deprecated: Cdc defines a global generic sealed Amino codec to be used throughout sdk. It
+// has all Tendermint crypto and evidence types registered.
+//
+// TODO: remove this global.
+var Cdc *codec.Codec
+
+func init() {
+	Cdc = codec.New()
+	cryptocodec.RegisterCrypto(Cdc)
+	codec.RegisterEvidences(Cdc)
+	Cdc.Seal()
+}
diff --git a/codec/legacy/doc.go b/codec/legacy/doc.go
@@ -0,0 +1,4 @@
+// Package legacy contains a global amino Cdc which is deprecated but
+// still used in several places within the SDK. This package is intended
+// to be removed at some point in the future when the global Cdc is removed.
+package legacy
diff --git a/crypto/amino.go b/crypto/amino.go
@@ -1,19 +1,19 @@
 package crypto
 
 import (
-	amino "github.com/tendermint/go-amino"
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
+	"github.com/cosmos/cosmos-sdk/codec"
+	cryptoAmino "github.com/cosmos/cosmos-sdk/crypto/codec"
 )
 
-var cdc = amino.NewCodec()
+var cdc = codec.New()
 
 func init() {
 	RegisterAmino(cdc)
-	cryptoAmino.RegisterAmino(cdc)
+	cryptoAmino.RegisterCrypto(cdc)
 }
 
 // RegisterAmino registers all go-crypto related types in the given (amino) codec.
-func RegisterAmino(cdc *amino.Codec) {
+func RegisterAmino(cdc *codec.Codec) {
 	cdc.RegisterConcrete(PrivKeyLedgerSecp256k1{},
 		"tendermint/PrivKeyLedgerSecp256k1", nil)
 }
diff --git a/crypto/armor.go b/crypto/armor.go
@@ -5,12 +5,11 @@ import (
 	"fmt"
 
 	"github.com/tendermint/crypto/bcrypt"
-
 	"github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/crypto/armor"
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
 	"github.com/tendermint/tendermint/crypto/xsalsa20symmetric"
 
+	cryptoAmino "github.com/cosmos/cosmos-sdk/crypto/codec"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 )
 

diff --git a/crypto/armor_test.go b/crypto/armor_test.go
@@ -11,13 +11,12 @@ import (
 	"github.com/tendermint/crypto/bcrypt"
 	tmcrypto "github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/crypto/armor"
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
 	"github.com/tendermint/tendermint/crypto/secp256k1"
 	"github.com/tendermint/tendermint/crypto/xsalsa20symmetric"
 
-	"github.com/cosmos/cosmos-sdk/crypto/hd"
-
 	"github.com/cosmos/cosmos-sdk/crypto"
+	cryptoAmino "github.com/cosmos/cosmos-sdk/crypto/codec"
+	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
 	"github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/crypto/codec/amino.go b/crypto/codec/amino.go
@@ -0,0 +1,52 @@
+package codec
+
+import (
+	"github.com/tendermint/tendermint/crypto"
+	"github.com/tendermint/tendermint/crypto/ed25519"
+	"github.com/tendermint/tendermint/crypto/secp256k1"
+	"github.com/tendermint/tendermint/crypto/sr25519"
+
+	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
+)
+
+var amino *codec.Codec
+
+func init() {
+	amino = codec.New()
+	RegisterCrypto(amino)
+}
+
+// RegisterCrypto registers all crypto dependency types with the provided Amino
+// codec.
+func RegisterCrypto(cdc *codec.Codec) {
+	cdc.RegisterInterface((*crypto.PubKey)(nil), nil)
+	cdc.RegisterConcrete(ed25519.PubKeyEd25519{},
+		ed25519.PubKeyAminoName, nil)
+	cdc.RegisterConcrete(sr25519.PubKeySr25519{},
+		sr25519.PubKeyAminoName, nil)
+	cdc.RegisterConcrete(secp256k1.PubKeySecp256k1{},
+		secp256k1.PubKeyAminoName, nil)
+	cdc.RegisterConcrete(multisig.PubKeyMultisigThreshold{},
+		multisig.PubKeyAminoRoute, nil)
+
+	cdc.RegisterInterface((*crypto.PrivKey)(nil), nil)
+	cdc.RegisterConcrete(ed25519.PrivKeyEd25519{},
+		ed25519.PrivKeyAminoName, nil)
+	cdc.RegisterConcrete(sr25519.PrivKeySr25519{},
+		sr25519.PrivKeyAminoName, nil)
+	cdc.RegisterConcrete(secp256k1.PrivKeySecp256k1{},
+		secp256k1.PrivKeyAminoName, nil)
+}
+
+// PrivKeyFromBytes unmarshals private key bytes and returns a PrivKey
+func PrivKeyFromBytes(privKeyBytes []byte) (privKey crypto.PrivKey, err error) {
+	err = amino.UnmarshalBinaryBare(privKeyBytes, &privKey)
+	return
+}
+
+// PubKeyFromBytes unmarshals public key bytes and returns a PubKey
+func PubKeyFromBytes(pubKeyBytes []byte) (pubKey crypto.PubKey, err error) {
+	err = amino.UnmarshalBinaryBare(pubKeyBytes, &pubKey)
+	return
+}
diff --git a/crypto/keyring/codec.go b/crypto/keyring/codec.go
@@ -1,9 +1,8 @@
 package keyring
 
 import (
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
-
 	"github.com/cosmos/cosmos-sdk/codec"
+	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 )
 
@@ -12,7 +11,7 @@ var CryptoCdc *codec.Codec
 
 func init() {
 	CryptoCdc = codec.New()
-	cryptoAmino.RegisterAmino(CryptoCdc.Amino)
+	cryptocodec.RegisterCrypto(CryptoCdc)
 	RegisterCodec(CryptoCdc)
 	CryptoCdc.Seal()
 }

diff --git a/crypto/keyring/info.go b/crypto/keyring/info.go
@@ -4,9 +4,9 @@ import (
 	"fmt"
 
 	"github.com/tendermint/tendermint/crypto"
-	"github.com/tendermint/tendermint/crypto/multisig"
 
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	"github.com/cosmos/cosmos-sdk/types"
 )
 

diff --git a/crypto/keyring/keyring.go b/crypto/keyring/keyring.go
@@ -14,12 +14,13 @@ import (
 	"github.com/99designs/keyring"
 	"github.com/cosmos/go-bip39"
 	"github.com/pkg/errors"
+
 	"github.com/tendermint/crypto/bcrypt"
 	tmcrypto "github.com/tendermint/tendermint/crypto"
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
 
 	"github.com/cosmos/cosmos-sdk/client/input"
 	"github.com/cosmos/cosmos-sdk/crypto"
+	cryptoAmino "github.com/cosmos/cosmos-sdk/crypto/codec"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"

diff --git a/crypto/keyring/keyring_test.go b/crypto/keyring/keyring_test.go
@@ -10,11 +10,11 @@ import (
 	"github.com/stretchr/testify/require"
 	tmcrypto "github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/crypto/ed25519"
-	"github.com/tendermint/tendermint/crypto/multisig"
 	"github.com/tendermint/tendermint/crypto/secp256k1"
 
 	"github.com/cosmos/cosmos-sdk/crypto"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	"github.com/cosmos/cosmos-sdk/tests"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/crypto/keyring/output_test.go b/crypto/keyring/output_test.go
@@ -5,9 +5,9 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"github.com/tendermint/tendermint/crypto"
-	"github.com/tendermint/tendermint/crypto/multisig"
 	"github.com/tendermint/tendermint/crypto/secp256k1"
 
+	"github.com/cosmos/cosmos-sdk/crypto/types/multisig"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 

diff --git a/crypto/ledger_test.go b/crypto/ledger_test.go
@@ -7,8 +7,8 @@ import (
 	"github.com/stretchr/testify/require"
 
 	tmcrypto "github.com/tendermint/tendermint/crypto"
-	cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino"
 
+	cryptoAmino "github.com/cosmos/cosmos-sdk/crypto/codec"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	"github.com/cosmos/cosmos-sdk/tests"
 	sdk "github.com/cosmos/cosmos-sdk/types"

diff --git a/crypto/types/multisig/codec.go b/crypto/types/multisig/codec.go
@@ -19,7 +19,7 @@ var cdc = amino.NewCodec()
 
 func init() {
 	cdc.RegisterInterface((*crypto.PubKey)(nil), nil)
-	cdc.RegisterConcrete(PubKey{},
+	cdc.RegisterConcrete(PubKeyMultisigThreshold{},
 		PubKeyAminoRoute, nil)
 	cdc.RegisterConcrete(ed25519.PubKeyEd25519{},
 		ed25519.PubKeyAminoName, nil)