Merge PR cosmos#6076: Proto Any init + evidence

Makefile

@@ -251,6 +251,10 @@ proto-all: proto-tools proto-gen proto-lint proto-check-breaking
 proto-gen:
 	@./scripts/protocgen.sh
 
+# This generates the SDK's custom wrapper for google.protobuf.Any. It should only be run manually when needed
+proto-gen-any:
+	@./scripts/protocgen-any.sh
+
 proto-lint:
 	@buf check lint --error-format=json
 

buf.yaml

@@ -1,6 +1,8 @@
 build:
   roots:
     - .
+  excludes:
+    - third_party/proto/google
 lint:
   use:
     - DEFAULT

codec/amino_codec.go

@@ -1,5 +1,11 @@
 package codec
 
+import (
+	"fmt"
+
+	"github.com/cosmos/cosmos-sdk/codec/types"
+)
+
 // AminoCodec defines a codec that utilizes Amino for both binary and JSON
 // encoding.
 type AminoCodec struct {
@@ -57,3 +63,7 @@ func (ac *AminoCodec) UnmarshalJSON(bz []byte, ptr interface{}) error {
 func (ac *AminoCodec) MustUnmarshalJSON(bz []byte, ptr interface{}) {
 	ac.amino.MustUnmarshalJSON(bz, ptr)
 }
+
+func (*AminoCodec) UnpackAny(*types.Any, interface{}) error {
+	return fmt.Errorf("AminoCodec can't handle unpack protobuf Any's")
+}

codec/codec.go

@@ -4,6 +4,8 @@ import (
 	"encoding/binary"
 	"io"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
+
 	"github.com/gogo/protobuf/proto"
 )
 
@@ -31,6 +33,7 @@ type (
 		MustUnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMarshaler)
 
 		JSONMarshaler
+		types.AnyUnpacker
 	}
 
 	JSONMarshaler interface {

codec/hybrid_codec.go

@@ -1,15 +1,17 @@
 package codec
 
+import "github.com/cosmos/cosmos-sdk/codec/types"
+
 // HybridCodec defines a codec that utilizes Protobuf for binary encoding
 // and Amino for JSON encoding.
 type HybridCodec struct {
 	proto Marshaler
 	amino Marshaler
 }
 
-func NewHybridCodec(amino *Codec) Marshaler {
+func NewHybridCodec(amino *Codec, unpacker types.AnyUnpacker) Marshaler {
 	return &HybridCodec{
-		proto: NewProtoCodec(),
+		proto: NewProtoCodec(unpacker),
 		amino: NewAminoCodec(amino),
 	}
 }
@@ -61,3 +63,7 @@ func (hc *HybridCodec) UnmarshalJSON(bz []byte, ptr interface{}) error {
 func (hc *HybridCodec) MustUnmarshalJSON(bz []byte, ptr interface{}) {
 	hc.amino.MustUnmarshalJSON(bz, ptr)
 }
+
+func (hc *HybridCodec) UnpackAny(any *types.Any, iface interface{}) error {
+	return hc.proto.UnpackAny(any, iface)
+}

codec/hybrid_codec_test.go

@@ -20,15 +20,15 @@ func TestHybridCodec(t *testing.T) {
 	}{
 		{
 			"valid encoding and decoding",
-			codec.NewHybridCodec(createTestCodec()),
+			codec.NewHybridCodec(createTestCodec(), createTestInterfaceRegistry()),
 			&testdata.Dog{Name: "rufus"},
 			&testdata.Dog{},
 			false,
 			false,
 		},
 		{
 			"invalid decode type",
-			codec.NewHybridCodec(createTestCodec()),
+			codec.NewHybridCodec(createTestCodec(), createTestInterfaceRegistry()),
 			&testdata.Dog{Name: "rufus"},
 			&testdata.Cat{},
 			false,

codec/proto_codec.go

@@ -6,15 +6,19 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
+
 	"github.com/gogo/protobuf/jsonpb"
 )
 
 // ProtoCodec defines a codec that utilizes Protobuf for both binary and JSON
 // encoding.
-type ProtoCodec struct{}
+type ProtoCodec struct {
+	anyUnpacker types.AnyUnpacker
+}
 
-func NewProtoCodec() Marshaler {
-	return &ProtoCodec{}
+func NewProtoCodec(anyUnpacker types.AnyUnpacker) Marshaler {
+	return &ProtoCodec{anyUnpacker: anyUnpacker}
 }
 
 func (pc *ProtoCodec) MarshalBinaryBare(o ProtoMarshaler) ([]byte, error) {
@@ -58,7 +62,15 @@ func (pc *ProtoCodec) MustMarshalBinaryLengthPrefixed(o ProtoMarshaler) []byte {
 }
 
 func (pc *ProtoCodec) UnmarshalBinaryBare(bz []byte, ptr ProtoMarshaler) error {
-	return ptr.Unmarshal(bz)
+	err := ptr.Unmarshal(bz)
+	if err != nil {
+		return err
+	}
+	err = types.UnpackInterfaces(ptr, pc.anyUnpacker)
+	if err != nil {
+		return err
+	}
+	return nil
 }
 
 func (pc *ProtoCodec) MustUnmarshalBinaryBare(bz []byte, ptr ProtoMarshaler) {
@@ -80,7 +92,7 @@ func (pc *ProtoCodec) UnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMarshale
 	}
 
 	bz = bz[n:]
-	return ptr.Unmarshal(bz)
+	return pc.UnmarshalBinaryBare(bz, ptr)
 }
 
 func (pc *ProtoCodec) MustUnmarshalBinaryLengthPrefixed(bz []byte, ptr ProtoMarshaler) {
@@ -121,3 +133,7 @@ func (pc *ProtoCodec) MustUnmarshalJSON(bz []byte, ptr interface{}) {
 		panic(err)
 	}
 }
+
+func (pc *ProtoCodec) UnpackAny(any *types.Any, iface interface{}) error {
+	return pc.anyUnpacker.UnpackAny(any, iface)
+}

codec/proto_codec_test.go

@@ -7,8 +7,20 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/codec/testdata"
+	"github.com/cosmos/cosmos-sdk/codec/types"
 )
 
+func createTestInterfaceRegistry() types.InterfaceRegistry {
+	interfaceRegistry := types.NewInterfaceRegistry()
+	interfaceRegistry.RegisterInterface("testdata.Animal",
+		(*testdata.Animal)(nil),
+		&testdata.Dog{},
+		&testdata.Cat{},
+	)
+
+	return interfaceRegistry
+}
+
 func TestProtoCodec(t *testing.T) {
 	testCases := []struct {
 		name         string
@@ -20,15 +32,15 @@ func TestProtoCodec(t *testing.T) {
 	}{
 		{
 			"valid encoding and decoding",
-			codec.NewProtoCodec(),
+			codec.NewProtoCodec(createTestInterfaceRegistry()),
 			&testdata.Dog{Name: "rufus"},
 			&testdata.Dog{},
 			false,
 			false,
 		},
 		{
 			"invalid decode type",
-			codec.NewProtoCodec(),
+			codec.NewProtoCodec(createTestInterfaceRegistry()),
 			&testdata.Dog{Name: "rufus"},
 			&testdata.Cat{},
 			false,

codec/testdata/animal.go

@@ -5,6 +5,8 @@ package testdata
 
 import (
 	"fmt"
+
+	"github.com/cosmos/cosmos-sdk/codec/types"
 )
 
 type Animal interface {
@@ -18,3 +20,10 @@ func (c Cat) Greet() string {
 func (d Dog) Greet() string {
 	return fmt.Sprintf("Roof, my name is %s", d.Name)
 }
+
+var _ types.UnpackInterfacesMessage = HasAnimal{}
+
+func (m HasAnimal) UnpackInterfaces(unpacker types.AnyUnpacker) error {
+	var animal Animal
+	return unpacker.UnpackAny(m.Animal, &animal)
+}