Extend ClientConn on TxBuilder

CHANGELOG.md

@@ -50,6 +50,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
   * Updated iavl dependency to v0.15-rc2
 * (version) [\#7848](https://github.com/cosmos/cosmos-sdk/pull/7848) [\#7941](https://github.com/cosmos/cosmos-sdk/pull/7941) `version --long` output now shows the list of build dependencies and replaced build dependencies.
 * (x/genutil) [\#8099](https://github.com/cosmos/cosmos-sdk/pull/8099) `init` now supports a `--recover` flag to recover the private validator key from a given mnemonic
+* (tx) [\#7630](https://github.com/cosmos/cosmos-sdk/pull/7630) TxBuilder now extends gogogrpc.ClientConn to support ADR-031 service Msgs.
 
 ### State Machine Breaking Changes
 

client/tx_config.go

@@ -1,6 +1,8 @@
 package client
 
 import (
+	gogogrpc "github.com/gogo/protobuf/grpc"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	signingtypes "github.com/cosmos/cosmos-sdk/types/tx/signing"
 	"github.com/cosmos/cosmos-sdk/x/auth/signing"
@@ -34,6 +36,7 @@ type (
 	// signatures, and provide canonical bytes to sign over. The transaction must
 	// also know how to encode itself.
 	TxBuilder interface {
+		gogogrpc.ClientConn
 		GetTx() signing.Tx
 
 		SetMsgs(msgs ...sdk.Msg) error

codec/types/any.go

@@ -69,11 +69,25 @@ func NewAnyWithValue(value proto.Message) (*Any, error) {
 	return any, nil
 }
 
-// Pack packs the value x in the Any or returns an error. This also caches
-// the packed value so that it can be retrieved from GetCachedValue without
-// unmarshaling
-func (any *Any) Pack(x proto.Message) error {
-	any.TypeUrl = "/" + proto.MessageName(x)
+// NewAnyWithTypeURL constructs a new Any packed with the value provided
+// and a custom TypeURL. It returns an error if that value couldn't be packed.
+// This also cachesthe packed value so that it can be retrieved from
+// GetCachedValue without unmarshaling.
+//
+// Ex:
+// This will allow us to pack service methods in Any's using the full method name
+// as the type URL and the request body as the value.
+func NewAnyWithTypeURL(typeURL string, value proto.Message) (*Any, error) {
+	any := &Any{}
+
+	return any, any.packWithCustomTypeURL(typeURL, value)
+}
+
+// PackWithCustomTypeURL packs the value x in the Any or returns an error,
+// allowing for a custom TypeUrl. This also caches the packed value so that it
+// can be retrieved fromGetCachedValue without unmarshaling.
+func (any *Any) packWithCustomTypeURL(typeURL string, x proto.Message) error {
+	any.TypeUrl = typeURL
 	bz, err := proto.Marshal(x)
 	if err != nil {
 		return err
@@ -85,6 +99,13 @@ func (any *Any) Pack(x proto.Message) error {
 	return nil
 }
 
+// Pack packs the value x in the Any or returns an error. This also caches
+// the packed value so that it can be retrieved from GetCachedValue without
+// unmarshaling
+func (any *Any) Pack(x proto.Message) error {
+	return any.packWithCustomTypeURL("/"+proto.MessageName(x), x)
+}
+
 // UnsafePackAny packs the value x in the Any and instead of returning the error
 // in the case of a packing failure, keeps the cached value. This should only
 // be used in situations where compatibility is needed with amino. Amino-only

x/auth/legacy/legacytx/msg_service.go

@@ -0,0 +1,40 @@
+package legacytx
+
+import (
+	gocontext "context"
+	"fmt"
+
+	"google.golang.org/grpc"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+)
+
+// Invoke implements the grpc ClientConn.Invoke method. This is so that we can
+// use ADR-031 service `Msg`s with StdTxBuilder. Invoking this method will
+// **append** the service Msg into the TxBuilder's Msgs array.
+// TODO Full amino support still needs to be added as part of https://github.com/cosmos/cosmos-sdk/issues/7541.
+func (s *StdTxBuilder) Invoke(_ gocontext.Context, method string, args, reply interface{}, _ ...grpc.CallOption) error {
+	req, ok := args.(sdk.MsgRequest)
+	if !ok {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidType, "%T should implement %T", args, (*sdk.MsgRequest)(nil))
+	}
+
+	err := req.ValidateBasic()
+	if err != nil {
+		return err
+	}
+
+	msgs := append(s.Msgs, sdk.ServiceMsg{
+		MethodName: method,
+		Request:    req,
+	})
+	s.SetMsgs(msgs...)
+
+	return nil
+}
+
+// NewStream implements the grpc ClientConn.NewStream method.
+func (s *StdTxBuilder) NewStream(gocontext.Context, *grpc.StreamDesc, string, ...grpc.CallOption) (grpc.ClientStream, error) {
+	return nil, fmt.Errorf("not supported")
+}

x/auth/tx/builder.go

@@ -197,6 +197,7 @@ func (w *wrapper) GetSignaturesV2() ([]signing.SignatureV2, error) {
 	return res, nil
 }
 
+// SetMsgs implemented the TxBuilder.SetMsgs method.
 func (w *wrapper) SetMsgs(msgs ...sdk.Msg) error {
 	anys := make([]*codectypes.Any, len(msgs))
 
@@ -205,14 +206,10 @@ func (w *wrapper) SetMsgs(msgs ...sdk.Msg) error {
 		switch msg := msg.(type) {
 		case sdk.ServiceMsg:
 			{
-				bz, err := proto.Marshal(msg.Request)
+				anys[i], err = codectypes.NewAnyWithTypeURL(msg.MethodName, msg.Request)
 				if err != nil {
 					return err
 				}
-				anys[i] = &codectypes.Any{
-					TypeUrl: msg.MethodName,
-					Value:   bz,
-				}
 			}
 		default:
 			{

x/auth/tx/msg_service.go

@@ -0,0 +1,39 @@
+package tx
+
+import (
+	gocontext "context"
+	"fmt"
+
+	"google.golang.org/grpc"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+)
+
+// Invoke implements the grpc ClientConn.Invoke method. This is so that we can
+// use ADR-031 service `Msg`s with wrapper. Invoking this method will
+// **append** the service Msg into the TxBuilder's Msgs array.
+func (w *wrapper) Invoke(_ gocontext.Context, method string, args, reply interface{}, _ ...grpc.CallOption) error {
+	req, ok := args.(sdk.MsgRequest)
+	if !ok {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidType, "%T should implement %T", args, (*sdk.MsgRequest)(nil))
+	}
+
+	err := req.ValidateBasic()
+	if err != nil {
+		return err
+	}
+
+	msgs := append(w.GetMsgs(), sdk.ServiceMsg{
+		MethodName: method,
+		Request:    req,
+	})
+	w.SetMsgs(msgs...)
+
+	return nil
+}
+
+// NewStream implements the grpc ClientConn.NewStream method.
+func (w *wrapper) NewStream(gocontext.Context, *grpc.StreamDesc, string, ...grpc.CallOption) (grpc.ClientStream, error) {
+	return nil, fmt.Errorf("not supported")
+}