Make JSONMarshaler methods require proto.Message

client/context.go

@@ -66,7 +66,7 @@ func (ctx Context) WithJSONMarshaler(m codec.JSONMarshaler) Context {
 	return ctx
 }
 
-// WithCodec returns a copy of the context with an updated codec.
+// WithLegacyAmino returns a copy of the context with an updated LegacyAmino codec.
 // TODO: Deprecated (remove).
 func (ctx Context) WithLegacyAmino(cdc *codec.LegacyAmino) Context {
 	ctx.LegacyAmino = cdc
@@ -212,27 +212,30 @@ func (ctx Context) PrintString(str string) error {
 // either text or json. If text, toPrint will be YAML encoded. Otherwise, toPrint
 // will be JSON encoded using ctx.JSONMarshaler. An error is returned upon failure.
 func (ctx Context) PrintOutput(toPrint proto.Message) error {
-	return ctx.printOutput(toPrint)
+	// always serialize JSON initially because proto json can't be directly YAML encoded
+	out, err := ctx.JSONMarshaler.MarshalJSON(toPrint)
+	if err != nil {
+		return err
+	}
+	return ctx.printOutput(out)
 }
 
 // PrintOutputLegacy is a variant of PrintOutput that doesn't require a proto type
 // and uses amino JSON encoding. It will be removed in the near future!
 func (ctx Context) PrintOutputLegacy(toPrint interface{}) error {
-	return ctx.WithJSONMarshaler(ctx.LegacyAmino).printOutput(toPrint)
-}
-
-func (ctx Context) printOutput(toPrint interface{}) error {
-	// always serialize JSON initially because proto json can't be directly YAML encoded
-	out, err := ctx.JSONMarshaler.MarshalJSON(toPrint)
+	out, err := ctx.LegacyAmino.MarshalJSON(toPrint)
 	if err != nil {
 		return err
 	}
+	return ctx.printOutput(out)
+}
 
+func (ctx Context) printOutput(out []byte) error {
 	if ctx.OutputFormat == "text" {
 		// handle text format by decoding and re-encoding JSON as YAML
 		var j interface{}
 
-		err = json.Unmarshal(out, &j)
+		err := json.Unmarshal(out, &j)
 		if err != nil {
 			return err
 		}
@@ -248,7 +251,7 @@ func (ctx Context) printOutput(toPrint interface{}) error {
 		writer = os.Stdout
 	}
 
-	_, err = writer.Write(out)
+	_, err := writer.Write(out)
 	if err != nil {
 		return err
 	}

client/context_test.go

@@ -71,13 +71,13 @@ x: "10"
 	// amino
 	//
 	amino := testdata.NewTestAmino()
-	ctx = ctx.WithJSONMarshaler(codec.NewAminoCodec(&codec.LegacyAmino{Amino: amino}))
+	ctx = ctx.WithLegacyAmino(&codec.LegacyAmino{Amino: amino})
 
 	// json
 	buf = &bytes.Buffer{}
 	ctx = ctx.WithOutput(buf)
 	ctx.OutputFormat = "json"
-	err = ctx.PrintOutput(hasAnimal)
+	err = ctx.PrintOutputLegacy(hasAnimal)
 	require.NoError(t, err)
 	require.Equal(t,
 		`{"type":"testdata/HasAnimal","value":{"animal":{"type":"testdata/Dog","value":{"size":"big","name":"Spot"}},"x":"10"}}
@@ -87,7 +87,7 @@ x: "10"
 	buf = &bytes.Buffer{}
 	ctx = ctx.WithOutput(buf)
 	ctx.OutputFormat = "text"
-	err = ctx.PrintOutput(hasAnimal)
+	err = ctx.PrintOutputLegacy(hasAnimal)
 	require.NoError(t, err)
 	require.Equal(t,
 		`type: testdata/HasAnimal

client/debug/main.go

@@ -90,7 +90,7 @@ $ %s debug pubkey cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 				return fmt.Errorf("invalid pubkey type; expected ED25519")
 			}
 
-			pubKeyJSONBytes, err := clientCtx.JSONMarshaler.MarshalJSON(edPK)
+			pubKeyJSONBytes, err := clientCtx.LegacyAmino.MarshalJSON(edPK)
 			if err != nil {
 				return err
 			}

client/tx/tx.go

@@ -100,7 +100,7 @@ func BroadcastTx(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error {
 	}
 
 	if !clientCtx.SkipConfirm {
-		out, err := clientCtx.JSONMarshaler.MarshalJSON(tx)
+		out, err := clientCtx.TxConfig.TxJSONEncoder()(tx.GetTx())
 		if err != nil {
 			return err
 		}

codec/amino.go

@@ -13,14 +13,12 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec/types"
 )
 
-// deprecated: Codec defines a wrapper for an Amino codec that properly handles protobuf
+// deprecated: LegacyAmino defines a wrapper for an Amino codec that properly handles protobuf
 // types with Any's
 type LegacyAmino struct {
 	Amino *amino.Codec
 }
 
-var _ JSONMarshaler = &LegacyAmino{}
-
 func (cdc *LegacyAmino) Seal() {
 	cdc.Amino.Seal()
 }
@@ -43,8 +41,8 @@ func RegisterEvidences(cdc *LegacyAmino) {
 // MarshalJSONIndent provides a utility for indented JSON encoding of an object
 // via an Amino codec. It returns an error if it cannot serialize or indent as
 // JSON.
-func MarshalJSONIndent(m JSONMarshaler, obj interface{}) ([]byte, error) {
-	bz, err := m.MarshalJSON(obj)
+func MarshalJSONIndent(cdc *LegacyAmino, obj interface{}) ([]byte, error) {
+	bz, err := cdc.MarshalJSON(obj)
 	if err != nil {
 		return nil, err
 	}
@@ -58,8 +56,8 @@ func MarshalJSONIndent(m JSONMarshaler, obj interface{}) ([]byte, error) {
 }
 
 // MustMarshalJSONIndent executes MarshalJSONIndent except it panics upon failure.
-func MustMarshalJSONIndent(m JSONMarshaler, obj interface{}) []byte {
-	bz, err := MarshalJSONIndent(m, obj)
+func MustMarshalJSONIndent(cdc *LegacyAmino, obj interface{}) []byte {
+	bz, err := MarshalJSONIndent(cdc, obj)
 	if err != nil {
 		panic(fmt.Sprintf("failed to marshal JSON: %s", err))
 	}

codec/amino_codec.go

@@ -1,5 +1,7 @@
 package codec
 
+import "github.com/gogo/protobuf/proto"
+
 // AminoCodec defines a codec that utilizes Codec for both binary and JSON
 // encoding.
 type AminoCodec struct {
@@ -43,3 +45,19 @@ func (ac *AminoCodec) UnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMarshale
 func (ac *AminoCodec) MustUnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMarshaler) {
 	ac.LegacyAmino.MustUnmarshalBinaryLengthPrefixed(bz, ptr)
 }
+
+func (ac *AminoCodec) MarshalJSON(o proto.Message) ([]byte, error) {
+	return ac.LegacyAmino.MarshalJSON(o)
+}
+
+func (ac *AminoCodec) MustMarshalJSON(o proto.Message) []byte {
+	return ac.LegacyAmino.MustMarshalJSON(o)
+}
+
+func (ac *AminoCodec) UnmarshalJSON(bz []byte, ptr proto.Message) error {
+	return ac.LegacyAmino.UnmarshalJSON(bz, ptr)
+}
+
+func (ac *AminoCodec) MustUnmarshalJSON(bz []byte, ptr proto.Message) {
+	ac.LegacyAmino.MustUnmarshalJSON(bz, ptr)
+}

codec/amino_codec_test.go

@@ -29,7 +29,7 @@ func TestAminoCodec(t *testing.T) {
 
 	testCases := []struct {
 		name         string
-		codec        codec.Marshaler
+		codec        *codec.AminoCodec
 		input        codec.ProtoMarshaler
 		recv         codec.ProtoMarshaler
 		marshalErr   bool
@@ -175,7 +175,7 @@ func TestAminoCodecMarshalJSONIndent(t *testing.T) {
 
 			if tc.marshalErr {
 				require.Error(t, err)
-				require.Panics(t, func() { codec.MustMarshalJSONIndent(cdc, tc.input) })
+				require.Panics(t, func() { codec.MustMarshalJSONIndent(cdc.LegacyAmino, tc.input) })
 				return
 			}
 
@@ -184,7 +184,7 @@ func TestAminoCodecMarshalJSONIndent(t *testing.T) {
 			require.Equal(t, bz, []byte(tc.wantJSON))
 
 			var bz2 []byte
-			require.NotPanics(t, func() { bz2 = codec.MustMarshalJSONIndent(cdc, tc.input) })
+			require.NotPanics(t, func() { bz2 = codec.MustMarshalJSONIndent(cdc.LegacyAmino, tc.input) })
 			require.Equal(t, bz2, []byte(tc.wantJSON))
 		})
 	}

codec/codec.go

@@ -10,7 +10,7 @@ type (
 	// Marshaler defines the interface module codecs must implement in order to support
 	// backwards compatibility with Amino while allowing custom Protobuf-based
 	// serialization. Note, Amino can still be used without any dependency on
-	// Protobuf. There are three typical implementations that fulfill this contract:
+	// Protobuf. There are two typical implementations that fulfill this contract:
 	//
 	// 1. AminoCodec: Provides full Amino serialization compatibility.
 	// 2. ProtoCodec: Provides full Protobuf serialization compatibility.
@@ -36,11 +36,11 @@ type (
 	}
 
 	JSONMarshaler interface {
-		MarshalJSON(o interface{}) ([]byte, error)
-		MustMarshalJSON(o interface{}) []byte
+		MarshalJSON(o proto.Message) ([]byte, error)
+		MustMarshalJSON(o proto.Message) []byte
 
-		UnmarshalJSON(bz []byte, ptr interface{}) error
-		MustUnmarshalJSON(bz []byte, ptr interface{})
+		UnmarshalJSON(bz []byte, ptr proto.Message) error
+		MustUnmarshalJSON(bz []byte, ptr proto.Message)
 	}
 
 	// ProtoMarshaler defines an interface a type must implement as protocol buffer

codec/proto_codec.go

@@ -8,6 +8,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec/types"
 
 	"github.com/gogo/protobuf/jsonpb"
+	"github.com/gogo/protobuf/proto"
 )
 
 // ProtoCodec defines a codec that utilizes Protobuf for both binary and JSON
@@ -95,7 +96,7 @@ func (pc *ProtoCodec) MustUnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMars
 	}
 }
 
-func (pc *ProtoCodec) MarshalJSON(o interface{}) ([]byte, error) {
+func (pc *ProtoCodec) MarshalJSON(o proto.Message) ([]byte, error) {
 	m, ok := o.(ProtoMarshaler)
 	if !ok {
 		return nil, fmt.Errorf("cannot protobuf JSON encode unsupported type: %T", o)
@@ -104,7 +105,7 @@ func (pc *ProtoCodec) MarshalJSON(o interface{}) ([]byte, error) {
 	return ProtoMarshalJSON(m)
 }
 
-func (pc *ProtoCodec) MustMarshalJSON(o interface{}) []byte {
+func (pc *ProtoCodec) MustMarshalJSON(o proto.Message) []byte {
 	bz, err := pc.MarshalJSON(o)
 	if err != nil {
 		panic(err)
@@ -113,7 +114,7 @@ func (pc *ProtoCodec) MustMarshalJSON(o interface{}) []byte {
 	return bz
 }
 
-func (pc *ProtoCodec) UnmarshalJSON(bz []byte, ptr interface{}) error {
+func (pc *ProtoCodec) UnmarshalJSON(bz []byte, ptr proto.Message) error {
 	m, ok := ptr.(ProtoMarshaler)
 	if !ok {
 		return fmt.Errorf("cannot protobuf JSON decode unsupported type: %T", ptr)
@@ -127,7 +128,7 @@ func (pc *ProtoCodec) UnmarshalJSON(bz []byte, ptr interface{}) error {
 	return types.UnpackInterfaces(ptr, pc.anyUnpacker)
 }
 
-func (pc *ProtoCodec) MustUnmarshalJSON(bz []byte, ptr interface{}) {
+func (pc *ProtoCodec) MustUnmarshalJSON(bz []byte, ptr proto.Message) {
 	if err := pc.UnmarshalJSON(bz, ptr); err != nil {
 		panic(err)
 	}

codec/proto_codec_test.go

@@ -122,26 +122,6 @@ func TestProtoCodec(t *testing.T) {
 	}
 }
 
-func TestProtoCodecMarshalAnyNonProtoErrors(t *testing.T) {
-	cdc := codec.NewProtoCodec(createTestInterfaceRegistry())
-
-	input := "this one that one"
-	_, err := cdc.MarshalJSON(input)
-	require.Error(t, err)
-	require.Equal(t, err, errors.New("cannot protobuf JSON encode unsupported type: string"))
-
-	require.Panics(t, func() { cdc.MustMarshalJSON(input) })
-}
-
-func TestProtoCodecUnmarshalAnyNonProtoErrors(t *testing.T) {
-	cdc := codec.NewProtoCodec(createTestInterfaceRegistry())
-
-	recv := new(int)
-	err := cdc.UnmarshalJSON([]byte("foo"), recv)
-	require.Error(t, err)
-	require.Equal(t, err, errors.New("cannot protobuf JSON decode unsupported type: *int"))
-}
-
 type lyingProtoMarshaler struct {
 	codec.ProtoMarshaler
 	falseSize int

go.sum

@@ -762,17 +762,14 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/cheggaaa/pb.v1 v1.0.25/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw=
 gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
-gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
 gopkg.in/gcfg.v1 v1.2.3/go.mod h1:yesOnuUOFQAhST5vPY4nbZsb/huCgGGXlipJsBn0b3o=
 gopkg.in/ini.v1 v1.51.0 h1:AQvPpx3LzTDM0AjnIRlVFwFFGC+npRopjZxLJj6gdno=
 gopkg.in/ini.v1 v1.51.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
-gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
 gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
 gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74=

server/start.go

@@ -232,7 +232,6 @@ func startInProcess(ctx *Context, legacyAminoCdc *codec.LegacyAmino, appCreator
 		clientCtx := client.Context{}.
 			WithHomeDir(home).
 			WithChainID(genDoc.ChainID).
-			WithJSONMarshaler(legacyAminoCdc).
 			// amino is needed here for backwards compatibility of REST routes
 			WithLegacyAmino(legacyAminoCdc).
 			WithClient(local.New(tmNode))

server/util.go

@@ -196,15 +196,15 @@ func AddCommands(rootCmd *cobra.Command, defaultNodeHome string, appCreator type
 //
 // NOTE: The ordering of the keys returned as the resulting JSON message is
 // non-deterministic, so the client should not rely on key ordering.
-func InsertKeyJSON(cdc codec.JSONMarshaler, baseJSON []byte, key string, value json.RawMessage) ([]byte, error) {
+func InsertKeyJSON(legacyAminoCdc *codec.LegacyAmino, baseJSON []byte, key string, value json.RawMessage) ([]byte, error) {
 	var jsonMap map[string]json.RawMessage
 
-	if err := cdc.UnmarshalJSON(baseJSON, &jsonMap); err != nil {
+	if err := legacyAminoCdc.UnmarshalJSON(baseJSON, &jsonMap); err != nil {
 		return nil, err
 	}
 
 	jsonMap[key] = value
-	bz, err := codec.MarshalJSONIndent(cdc, jsonMap)
+	bz, err := codec.MarshalJSONIndent(legacyAminoCdc, jsonMap)
 
 	return json.RawMessage(bz), err
 }

simapp/app.go

@@ -329,7 +329,7 @@ func NewSimApp(
 	)
 
 	app.mm.RegisterInvariants(&app.CrisisKeeper)
-	app.mm.RegisterRoutes(app.Router(), app.QueryRouter(), codec.NewAminoCodec(encodingConfig.Amino))
+	app.mm.RegisterRoutes(app.Router(), app.QueryRouter(), encodingConfig.Amino)
 	app.mm.RegisterQueryServices(app.GRPCQueryRouter())
 
 	// add test gRPC service for testing gRPC queries in isolation
@@ -446,7 +446,7 @@ func (app *SimApp) BlockedAddrs() map[string]bool {
 	return blockedAddrs
 }
 
-// Codec returns SimApp's codec.
+// LegacyAmino returns SimApp's legacy amino codec.
 //
 // NOTE: This is solely to be used for testing purposes as it may be desirable
 // for modules to register their own custom testing types.
@@ -505,8 +505,6 @@ func (app *SimApp) SimulationManager() *module.SimulationManager {
 // API server.
 func (app *SimApp) RegisterAPIRoutes(apiSvr *api.Server) {
 	clientCtx := apiSvr.ClientCtx
-	// amino is needed here for backwards compatibility of REST routes
-	clientCtx = clientCtx.WithJSONMarshaler(clientCtx.LegacyAmino)
 	rpc.RegisterRoutes(clientCtx, apiSvr.Router)
 	authrest.RegisterTxRoutes(clientCtx, apiSvr.Router)
 	ModuleBasics.RegisterRESTRoutes(clientCtx, apiSvr.Router)

simapp/simd/cmd/genaccounts.go

@@ -114,7 +114,7 @@ contain valid denominations. Accounts may optionally be supplied with vesting pa
 			}
 
 			genFile := config.GenesisFile()
-			appState, genDoc, err := genutiltypes.GenesisStateFromGenFile(depCdc, genFile)
+			appState, genDoc, err := genutiltypes.GenesisStateFromGenFile(genFile)
 			if err != nil {
 				return fmt.Errorf("failed to unmarshal genesis state: %w", err)
 			}