feat: format known addresses for consensus txes

test: cover consensusaccounts.Undelegate PrettyPrint

Author: uniyalabhishek

client-sdk/go/modules/consensusaccounts/types.go

@@ -65,8 +65,8 @@ type Undelegate struct {
 }
 
 // PrettyPrint writes a pretty-printed representation of the transaction to the given writer.
-func (ud *Undelegate) PrettyPrint(_ context.Context, prefix string, w io.Writer) {
-	_, _ = fmt.Fprintf(w, "%sFrom: %s\n", prefix, ud.From)
+func (ud *Undelegate) PrettyPrint(ctx context.Context, prefix string, w io.Writer) {
+	_, _ = fmt.Fprintf(w, "%sFrom: %s\n", prefix, types.FormatNamedAddress(ctx, ud.From))
 	_, _ = fmt.Fprintf(w, "%sShares: %s\n", prefix, ud.Shares)
 }
 

client-sdk/go/modules/consensusaccounts/types_test.go

@@ -0,0 +1,41 @@
+package consensusaccounts
+
+import (
+	"bytes"
+	"context"
+	"encoding/hex"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/types"
+
+	"github.com/oasisprotocol/oasis-core/go/common/quantity"
+)
+
+func TestUndelegatePrettyPrintFromNamedAddress(t *testing.T) {
+	require := require.New(t)
+
+	ethHex := "0x60a6321ea71d37102dbf923aae2e08d005c4e403"
+	ethBytes, err := hex.DecodeString(ethHex[2:])
+	require.NoError(err)
+
+	addr := types.NewAddressFromEth(ethBytes)
+	native := addr.String()
+
+	shares := *quantity.NewFromUint64(1234)
+
+	ctx := context.Background()
+	ctx = context.WithValue(ctx, types.ContextKeyAccountNames, types.AccountNames{native: "my"})
+	ctx = context.WithValue(ctx, types.ContextKeyAccountEthMap, map[string]string{native: ethHex})
+
+	ud := Undelegate{
+		From:   addr,
+		Shares: shares,
+	}
+
+	var buf bytes.Buffer
+	ud.PrettyPrint(ctx, "", &buf)
+
+	require.Equal("From: my ("+ethHex+")\nShares: "+shares.String()+"\n", buf.String())
+}

client-sdk/go/types/address.go

@@ -44,6 +44,10 @@ type contextKey string
 // ContextKeyAccountNames is the key to retrieve the public key to account name map from context.
 const ContextKeyAccountNames = contextKey("runtime/account-names")
 
+// ContextKeyAccountEthMap is the key to retrieve a mapping from native (Bech32)
+// Oasis addresses to their corresponding Ethereum hex addresses.
+const ContextKeyAccountEthMap = contextKey("runtime/account-eth-map")
+
 // AccountNames maps public key or address to user-defined account name for pretty printing.
 type AccountNames map[string]string
 

client-sdk/go/types/token.go

@@ -87,17 +87,57 @@ func NewBaseUnits(amount quantity.Quantity, denomination Denomination) BaseUnits
 	}
 }
 
+// FormatNamedAddress returns a human-friendly representation of an address.
+//
+// It prints the name (if known) followed by the preferred form of the address
+// in parentheses. If an Ethereum hex address mapping is provided for the native
+// address, it is used; otherwise the native Bech32 address is used.
+func FormatNamedAddress(ctx context.Context, addr Address) string {
+	var (
+		names  AccountNames
+		ethMap map[string]string
+	)
+	if v, ok := ctx.Value(ContextKeyAccountNames).(AccountNames); ok {
+		names = v
+	}
+	if v, ok := ctx.Value(ContextKeyAccountEthMap).(map[string]string); ok {
+		ethMap = v
+	}
+	return FormatNamedAddressWith(names, ethMap, addr)
+}
+
+// FormatNamedAddressWith is a pure helper for address formatting to make testing easier.
+func FormatNamedAddressWith(names AccountNames, ethMap map[string]string, addr Address) string {
+	native := addr.String()
+
+	name := ""
+	if names != nil {
+		name = names[native]
+	}
+	if name == "" {
+		return native
+	}
+
+	preferred := native
+	if ethMap != nil {
+		if hex := ethMap[native]; hex != "" {
+			preferred = hex
+		}
+	}
+
+	// Guard against redundant "name (name)" output.
+	if name == preferred {
+		return preferred
+	}
+
+	return fmt.Sprintf("%s (%s)", name, preferred)
+}
+
 // PrettyPrintToAmount is a helper for printing To-Amount transaction bodies (e.g. transfer, deposit, withdraw).
 func PrettyPrintToAmount(ctx context.Context, prefix string, w io.Writer, to *Address, amount BaseUnits) {
 	toStr := "Self"
 	if to != nil {
-		toStr = to.String()
-		an, ok := ctx.Value(ContextKeyAccountNames).(AccountNames)
-		if ok {
-			if name, ok := an[to.String()]; ok {
-				toStr = fmt.Sprintf("%s (%s)", name, to)
-			}
-		}
+		toStr = FormatNamedAddress(ctx, *to)
 	}
 	_, _ = fmt.Fprintf(w, "%sTo: %s\n", prefix, toStr)
 	_, _ = fmt.Fprintf(w, "%sAmount: ", prefix)

client-sdk/go/types/token_test.go

@@ -82,3 +82,44 @@ func TestPrettyPrintToAmount(t *testing.T) {
 	PrettyPrintToAmount(ctx, "", &buf, &to, amt)
 	require.Equal("To: test:dave (oasis1qrk58a6j2qn065m6p06jgjyt032f7qucy5wqeqpt)\nAmount: <error: ParaTime information not available>\n", buf.String())
 }
+
+func TestFormatNamedAddressWith(t *testing.T) {
+	require := require.New(t)
+
+	ethHex := "0x60a6321ea71d37102dbf923aae2e08d005c4e403"
+	ethBytes, err := hex.DecodeString(ethHex[2:])
+	require.NoError(err)
+
+	addr := NewAddressFromEth(ethBytes)
+	native := addr.String()
+
+	t.Run("unknown returns native", func(_ *testing.T) {
+		require.Equal(native, FormatNamedAddressWith(nil, nil, addr))
+		require.Equal(native, FormatNamedAddressWith(AccountNames{}, map[string]string{}, addr))
+	})
+
+	t.Run("native fallback when eth unknown", func(_ *testing.T) {
+		names := AccountNames{native: "my"}
+		require.Equal("my ("+native+")", FormatNamedAddressWith(names, nil, addr))
+		require.Equal("my ("+native+")", FormatNamedAddressWith(names, map[string]string{}, addr))
+		require.Equal("my ("+native+")", FormatNamedAddressWith(names, map[string]string{native: ""}, addr))
+	})
+
+	t.Run("eth preferred when known", func(_ *testing.T) {
+		names := AccountNames{native: "my"}
+		ethMap := map[string]string{native: ethHex}
+		require.Equal("my ("+ethHex+")", FormatNamedAddressWith(names, ethMap, addr))
+	})
+
+	t.Run("name equals preferred yields preferred", func(_ *testing.T) {
+		names := AccountNames{native: native}
+		require.Equal(native, FormatNamedAddressWith(names, nil, addr))
+	})
+
+	t.Run("ctx wrapper reads maps", func(_ *testing.T) {
+		ctx := context.Background()
+		ctx = context.WithValue(ctx, ContextKeyAccountNames, AccountNames{native: "my"})
+		ctx = context.WithValue(ctx, ContextKeyAccountEthMap, map[string]string{native: ethHex})
+		require.Equal("my ("+ethHex+")", FormatNamedAddress(ctx, addr))
+	})
+}