feat(textual): Add Tx envelope Value Renderer

go.mod

@@ -8,6 +8,7 @@ require (
 	cosmossdk.io/depinject v1.0.0-alpha.2
 	cosmossdk.io/errors v1.0.0-beta.7
 	cosmossdk.io/math v1.0.0-beta.3
+	cosmossdk.io/tx v0.0.0-00010101000000-000000000000
 	github.com/99designs/keyring v1.2.1
 	github.com/armon/go-metrics v0.4.1
 	github.com/bgentry/speakeasy v0.1.0
@@ -160,6 +161,8 @@ require (
 )
 
 replace (
+	// temporary until we tag a new go module
+	cosmossdk.io/tx => ./tx
 	github.com/99designs/keyring => github.com/cosmos/keyring v1.2.0
 	// dgrijalva/jwt-go is deprecated and doesn't receive security updates.
 	// TODO: remove it: https://github.com/cosmos/cosmos-sdk/issues/13134

tx/signing/sign_mode_handler.go

@@ -0,0 +1,32 @@
+package signing
+
+// SignerData is the specific information needed to sign a transaction that generally
+// isn't included in the transaction body itself
+type SignerData struct {
+	// The address of the signer.
+	//
+	// In case of multisigs, this should be the multisig's address.
+	Address string
+
+	// ChainID is the chain that this transaction is targeted
+	ChainID string
+
+	// AccountNumber is the account number of the signer.
+	//
+	// In case of multisigs, this should be the multisig account number.
+	AccountNumber uint64
+
+	// Sequence is the account sequence number of the signer that is used
+	// for replay protection. This field is only useful for Legacy Amino signing,
+	// since in SIGN_MODE_DIRECT the account sequence is already in the signer
+	// info.
+	//
+	// In case of multisigs, this should be the multisig sequence.
+	Sequence uint64
+
+	// PubKey is the public key of the signer.
+	//
+	// In case of multisigs, this should be the pubkey of the member of the
+	// multisig that is signing the current sign doc.
+	PubKey cryptotypes.PubKey
+}

tx/textual/valuerenderer/bytes_test.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"testing"
 
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/valuerenderer"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/protobuf/reflect/protoreflect"
@@ -21,7 +22,7 @@ func TestBytesJsonTestCases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier)
+	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier, signing.SignerData{})
 
 	for _, tc := range testcases {
 		data, err := base64.StdEncoding.DecodeString(tc.base64)

tx/textual/valuerenderer/coin_test.go

@@ -12,6 +12,7 @@ import (
 
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/valuerenderer"
 )
 
@@ -33,7 +34,7 @@ func mockCoinMetadataQuerier(ctx context.Context, denom string) (*bankv1beta1.Me
 
 func TestMetadataQuerier(t *testing.T) {
 	// Errors on nil metadata querier
-	textual := valuerenderer.NewTextual(nil)
+	textual := valuerenderer.NewTextual(nil, signing.SignerData{})
 	vr, err := textual.GetValueRenderer(fieldDescriptorFromName("COIN"))
 	require.NoError(t, err)
 	_, err = vr.Format(context.Background(), protoreflect.ValueOf((&basev1beta1.Coin{}).ProtoReflect()))
@@ -43,7 +44,7 @@ func TestMetadataQuerier(t *testing.T) {
 	expErr := fmt.Errorf("mock error")
 	textual = valuerenderer.NewTextual(func(_ context.Context, _ string) (*bankv1beta1.Metadata, error) {
 		return nil, expErr
-	})
+	}, signing.SignerData{})
 	vr, err = textual.GetValueRenderer(fieldDescriptorFromName("COIN"))
 	require.NoError(t, err)
 	_, err = vr.Format(context.Background(), protoreflect.ValueOf((&basev1beta1.Coin{}).ProtoReflect()))
@@ -59,7 +60,7 @@ func TestCoinJsonTestcases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier)
+	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier, signing.SignerData{})
 	vr, err := textual.GetValueRenderer(fieldDescriptorFromName("COIN"))
 	require.NoError(t, err)
 

tx/textual/valuerenderer/coins_test.go

@@ -8,6 +8,7 @@ import (
 
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/valuerenderer"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/protobuf/reflect/protoreflect"
@@ -20,7 +21,7 @@ func TestCoinsJsonTestcases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier)
+	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier, signing.SignerData{})
 	vr, err := textual.GetValueRenderer(fieldDescriptorFromName("COINS"))
 	require.NoError(t, err)
 

tx/textual/valuerenderer/dec_test.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"testing"
 
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/valuerenderer"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/protobuf/reflect/protoreflect"
@@ -18,7 +19,7 @@ func TestDecJsonTestcases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(nil)
+	textual := valuerenderer.NewTextual(nil, signing.SignerData{})
 
 	for _, tc := range testcases {
 		tc := tc

tx/textual/valuerenderer/int_test.go

@@ -11,6 +11,7 @@ import (
 	"google.golang.org/protobuf/reflect/protoreflect"
 
 	"cosmossdk.io/math"
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/valuerenderer"
 )
 
@@ -22,7 +23,7 @@ func TestIntJsonTestcases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(nil)
+	textual := valuerenderer.NewTextual(nil, signing.SignerData{})
 
 	for _, tc := range testcases {
 		// Parse test case strings as protobuf uint64

tx/textual/valuerenderer/tx.go

@@ -0,0 +1,60 @@
+package valuerenderer
+
+import (
+	"context"
+	"fmt"
+
+	"google.golang.org/protobuf/reflect/protoreflect"
+
+	txv1beta1 "cosmossdk.io/api/cosmos/tx/v1beta1"
+	"cosmossdk.io/tx/signing"
+)
+
+type txValueRenderer struct {
+	signerData signing.SignerData
+	t          *Textual
+}
+
+// NewTimestampValueRenderer returns a ValueRenderer for the protobuf Tx type,
+// as called the transaction envelope. It follows the specification defined
+// in ADR-050.
+func NewTxValueRenderer(t *Textual, signerData signing.SignerData) ValueRenderer {
+	return txValueRenderer{
+		t:          t,
+		signerData: signerData,
+	}
+}
+
+// Format implements the ValueRenderer interface.
+func (vr txValueRenderer) Format(ctx context.Context, v protoreflect.Value) ([]Screen, error) {
+	// Reify the reflected message as a proto Timestamp
+	msg := v.Message().Interface()
+	protoTx, ok := msg.(*txv1beta1.Tx)
+	if !ok {
+		return nil, fmt.Errorf("expected Tx, got %T", msg)
+	}
+
+	screens := make([]Screen, 3)
+	screens[0].Text = fmt.Sprintf("Chain ID: %s", vr.signerData.ChainID)
+	screens[1].Text = fmt.Sprintf("Account number: %d", vr.signerData.AccountNumber)
+	screens[2].Text = fmt.Sprintf("Public key: %s", &vr.signerData.PubKey)
+
+	// Get sdk.Msgs screens, from Tx.Body.Messages (field number 1).
+	msgVr, err := vr.t.GetValueRenderer(protoTx.Body.ProtoReflect().Descriptor().Fields().ByNumber(1))
+	if err != nil {
+		return nil, err
+	}
+	msgScreens, err := msgVr.Format(ctx, protoreflect.ValueOf(protoTx.Body.Messages))
+	if err != nil {
+		return nil, err
+	}
+
+	screens = append(screens, msgScreens...)
+
+	return screens, nil
+}
+
+// Parse implements the ValueRenderer interface.
+func (vr txValueRenderer) Parse(_ context.Context, screens []Screen) (protoreflect.Value, error) {
+	panic("TODO")
+}

tx/textual/valuerenderer/valuerenderer.go

@@ -11,6 +11,8 @@ import (
 
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
+	txv1beta1 "cosmossdk.io/api/cosmos/tx/v1beta1"
+	"cosmossdk.io/tx/signing"
 	cosmos_proto "github.com/cosmos/cosmos-proto"
 )
 
@@ -35,12 +37,14 @@ type Textual struct {
 	// - Protobuf timestamp
 	// - Protobuf duration
 	messages map[protoreflect.FullName]ValueRenderer
+	// signerData defines information on the signer
+	signerData signing.SignerData
 }
 
 // NewTextual returns a new Textual which provides
 // value renderers.
-func NewTextual(q CoinMetadataQueryFn) Textual {
-	t := Textual{coinMetadataQuerier: q}
+func NewTextual(q CoinMetadataQueryFn, signerData signing.SignerData) Textual {
+	t := Textual{coinMetadataQuerier: q, signerData: signerData}
 	t.init()
 	return t
 }
@@ -102,6 +106,7 @@ func (r *Textual) init() {
 		r.messages[(&basev1beta1.Coin{}).ProtoReflect().Descriptor().FullName()] = NewCoinsValueRenderer(r.coinMetadataQuerier)
 		r.messages[(&durationpb.Duration{}).ProtoReflect().Descriptor().FullName()] = NewDurationValueRenderer()
 		r.messages[(&timestamppb.Timestamp{}).ProtoReflect().Descriptor().FullName()] = NewTimestampValueRenderer()
+		r.messages[(&txv1beta1.Tx{}).ProtoReflect().Descriptor().FullName()] = NewTxValueRenderer(r, r.signerData)
 	}
 }
 

tx/textual/valuerenderer/valuerenderer_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"google.golang.org/protobuf/reflect/protoreflect"
 
+	"cosmossdk.io/tx/signing"
 	"cosmossdk.io/tx/textual/internal/testpb"
 	"cosmossdk.io/tx/textual/valuerenderer"
 )
@@ -32,7 +33,7 @@ func TestDispatcher(t *testing.T) {
 	for _, tc := range testcases {
 		tc := tc
 		t.Run(tc.name, func(t *testing.T) {
-			textual := valuerenderer.NewTextual(nil)
+			textual := valuerenderer.NewTextual(nil, signing.SignerData{})
 			rend, err := textual.GetValueRenderer(fieldDescriptorFromName(tc.name))
 
 			if tc.expErr {

x/auth/signing/sign_mode_handler.go

@@ -1,7 +1,7 @@
 package signing
 
 import (
-	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
+	txsigning "cosmossdk.io/tx/signing"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/tx/signing"
 )
@@ -21,33 +21,4 @@ type SignModeHandler interface {
 	GetSignBytes(mode signing.SignMode, data SignerData, tx sdk.Tx) ([]byte, error)
 }
 
-// SignerData is the specific information needed to sign a transaction that generally
-// isn't included in the transaction body itself
-type SignerData struct {
-	// The address of the signer.
-	//
-	// In case of multisigs, this should be the multisig's address.
-	Address string
-
-	// ChainID is the chain that this transaction is targeted
-	ChainID string
-
-	// AccountNumber is the account number of the signer.
-	//
-	// In case of multisigs, this should be the multisig account number.
-	AccountNumber uint64
-
-	// Sequence is the account sequence number of the signer that is used
-	// for replay protection. This field is only useful for Legacy Amino signing,
-	// since in SIGN_MODE_DIRECT the account sequence is already in the signer
-	// info.
-	//
-	// In case of multisigs, this should be the multisig sequence.
-	Sequence uint64
-
-	// PubKey is the public key of the signer.
-	//
-	// In case of multisigs, this should be the pubkey of the member of the
-	// multisig that is signing the current sign doc.
-	PubKey cryptotypes.PubKey
-}
+type SignerData txsigning.SignerData