x/ibc-transfer: ADR001 source tracing implementation

docs/architecture/adr-001-coin-source-tracing.md

@@ -220,16 +220,16 @@ func (msg MsgTransfer) ValidateBasic() error {
   if err := msg.Trace.Validate(); err != nil {
     return err
   }
-  if err := ValidateIBCDenom(msg.Token.Denom, msg.Trace); err != nil {
+  if err := ValidatePrefixedDenom(msg.Token.Denom, msg.Trace); err != nil {
     return err
   }
   // ...
 }
 ```
 
 ```golang
-// ValidateIBCDenom checks that the denomination for an IBC fungible token is valid. It returns error if the trace `hash` is invalid
-func ValidateIBCDenom(denom string, trace DenomTrace) error {
+// ValidatePrefixedDenom checks that the denomination for an IBC fungible token is valid. It returns error if the trace `hash` is invalid
+func ValidatePrefixedDenom(denom string, trace DenomTrace) error {
   // Validate that base denominations are equal if the trace info is not provided
   if trace.Trace == "" {
     if trace.BaseDenom != denom {
@@ -277,19 +277,13 @@ The denomination trace info only needs to be updated when token is received:
 // NOTE: We use SourcePort and SourceChannel here, because the counterparty
 // chain would have prefixed with DestPort and DestChannel when originally
 // receiving this coin as seen in the "sender chain is the source" condition.
-voucherPrefix := GetDenomPrefix(packet.GetSourcePort(), packet.GetSourceChannel())
-
 if ReceiverChainIsSource(packet.GetSourcePort(), packet.GetSourceChannel(), data.Denom) {
   // sender chain is not the source, unescrow tokens
 
   // remove prefix added by sender chain
-  if err := denomTrace.RemovePrefix(); err != nil {
-    return err
-  }
-
-  // NOTE: since the sender is a sink chain, we already know the unprefixed denomination trace info
-
-  token := sdk.NewCoin(denomTrace.IBCDenom(), sdk.NewIntFromUint64(data.Amount))
+  voucherPrefix := types.GetDenomPrefix(packet.GetSourcePort(), packet.GetSourceChannel())
+  unprefixedDenom := data.Denom[len(voucherPrefix):]
+  token := sdk.NewCoin(unprefixedDenom, sdk.NewIntFromUint64(data.Amount))
 
   // unescrow tokens
   escrowAddress := types.GetEscrowAddress(packet.GetDestPort(), packet.GetDestChannel())
@@ -299,7 +293,7 @@ if ReceiverChainIsSource(packet.GetSourcePort(), packet.GetSourceChannel(), data
 // sender chain is the source, mint vouchers
 
 // construct the denomination trace from the full raw denomination
-denomTrace := NewDenomTraceFromRawDenom(data.Denom)
+denomTrace := NewDenomTrace(data.Denom)
 
 // since SendPacket did not prefix the denomination with the voucherPrefix, we must add it here
 denomTrace.AddPrefix(packet.GetDestPort(), packet.GetDestChannel())

proto/ibc/transfer/genesis.proto

@@ -4,12 +4,17 @@ package ibc.transfer;
 option go_package = "github.com/cosmos/cosmos-sdk/x/ibc-transfer/types";
 
 import "gogoproto/gogo.proto";
+import "ibc/transfer/transfer.proto";
 
-// GenesisState is currently only used to ensure that the InitGenesis gets run
-// by the module manager
-message GenesisState {
-  string port_id = 1 [
-    (gogoproto.customname) = "PortID",
-    (gogoproto.moretags)   = "yaml:\"port_id\""
-  ];
+// GenesisState defines the ibc-transfer genesis state
+message GenesisState{
+	string port_id  = 1 [
+	  (gogoproto.customname) = "PortID",
+	  (gogoproto.moretags) = "yaml:\"port_id\""
+	];
+	repeated DenomTrace denom_traces = 2 [
+		(gogoproto.castrepeated) = "Traces",
+		(gogoproto.nullable) = false,
+		(gogoproto.moretags) = "yaml:\"denom_traces\""
+	];
 }

proto/ibc/transfer/query.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+package ibc.transfer;
+
+import "gogoproto/gogo.proto";
+import "cosmos/query/pagination.proto";
+import "ibc/transfer/transfer.proto";
+
+option go_package = "github.com/cosmos/cosmos-sdk/x/ibc-transfer/types";
+
+// Query provides defines the gRPC querier service
+service Query {
+  // DenomTrace queries a denomination trace info.
+  rpc DenomTrace(QueryDenomTraceRequest) returns (QueryDenomTraceResponse) {}
+
+  // DenomTraces queries all denomination traces.
+  rpc DenomTraces(QueryDenomTracesRequest) returns (QueryDenomTracesResponse) {}
+}
+
+// QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC method
+message QueryDenomTraceRequest {
+  // hex hash of the denomination trace info
+  string hash = 1;
+}
+
+// QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC method.
+message QueryDenomTraceResponse {
+  // denomination trace associated with the request hash
+  DenomTrace denom_trace = 1;
+}
+
+// QueryConnectionsRequest is the request type for the Query/DenomTraces RPC method
+message QueryDenomTracesRequest {
+  cosmos.query.PageRequest pagination = 1;
+}
+
+// QueryConnectionsResponse is the response type for the Query/DenomTraces RPC method.
+message QueryDenomTracesResponse {
+  // list of stored connections of the chain.
+  repeated DenomTrace denom_traces = 1 [
+    (gogoproto.castrepeated) = "Traces",
+    (gogoproto.nullable) = false
+  ];
+  // pagination response
+  cosmos.query.PageResponse pagination = 2;
+}

proto/ibc/transfer/transfer.proto

@@ -17,17 +17,15 @@ message MsgTransfer {
   // the tokens to be transferred
   cosmos.Coin token = 3 [(gogoproto.nullable) = false];
   // the sender address
-  bytes sender = 4
-      [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
+  bytes sender = 4 [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
   // the recipient address on the destination chain
   string receiver = 5;
   // Timeout height relative to the current block height.
   // The timeout is disabled when set to 0.
   uint64 timeout_height = 6 [(gogoproto.moretags) = "yaml:\"timeout_height\""];
   // Timeout timestamp (in nanoseconds) relative to the current block timestamp.
   // The timeout is disabled when set to 0.
-  uint64 timeout_timestamp = 7
-      [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
+  uint64 timeout_timestamp = 7 [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
 }
 
 // FungibleTokenPacketData defines a struct for the packet payload
@@ -52,3 +50,12 @@ message FungibleTokenPacketAcknowledgement {
   bool success = 1;
   string error = 2;
 }
+
+// DenomTrace contains the base denomination for ICS20 fungible tokens and the source tracing
+// information
+message DenomTrace {
+  // chain of port/channel identifiers used for tracing the source of the fungible token
+  string trace = 1;
+  // base denomination of the relayed fungible token
+  string base_denom = 2;
+}

types/coin.go

@@ -51,10 +51,7 @@ func validate(denom string, amount Int) error {
 
 // IsValid returns true if the Coin has a non-negative amount and the denom is vaild.
 func (coin Coin) IsValid() bool {
-	if err := validate(coin.Denom, coin.Amount); err != nil {
-		return false
-	}
-	return true
+	return validate(coin.Denom, coin.Amount) == nil
 }
 
 // IsZero returns if this represents no money
@@ -91,7 +88,7 @@ func (coin Coin) IsEqual(other Coin) bool {
 	return coin.Amount.Equal(other.Amount)
 }
 
-// Adds amounts of two coins with same denom. If the coins differ in denom then
+// Add adds amounts of two coins with same denom. If the coins differ in denom then
 // it panics.
 func (coin Coin) Add(coinB Coin) Coin {
 	if coin.Denom != coinB.Denom {
@@ -101,7 +98,7 @@ func (coin Coin) Add(coinB Coin) Coin {
 	return Coin{coin.Denom, coin.Amount.Add(coinB.Amount)}
 }
 
-// Subtracts amounts of two coins with same denom. If the coins differ in denom
+// Sub subtracts amounts of two coins with same denom. If the coins differ in denom
 // then it panics.
 func (coin Coin) Sub(coinB Coin) Coin {
 	if coin.Denom != coinB.Denom {
@@ -201,7 +198,7 @@ func (coins Coins) IsValid() bool {
 
 		lowDenom := coins[0].Denom
 		for _, coin := range coins[1:] {
-			if strings.ToLower(coin.Denom) != coin.Denom {
+			if err := ValidateDenom(coin.Denom); err != nil {
 				return false
 			}
 			if coin.Denom <= lowDenom {
@@ -463,7 +460,7 @@ func (coins Coins) Empty() bool {
 	return len(coins) == 0
 }
 
-// Returns the amount of a denom from coins
+// AmountOf returns the amount of a denom from coins
 func (coins Coins) AmountOf(denom string) Int {
 	mustValidateDenom(denom)
 
@@ -576,8 +573,8 @@ func (coins Coins) Sort() Coins {
 // Parsing
 
 var (
-	// Denominations can be 3 ~ 64 characters long.
-	reDnmString = `[a-z][a-z0-9/]{2,63}`
+	// Denominations can be 3 ~ 128 characters long.
+	reDnmString = `[a-z][a-zA-Z0-9/]{2,127}`
 	reAmt       = `[[:digit:]]+`
 	reDecAmt    = `[[:digit:]]*\.[[:digit:]]+`
 	reSpc       = `[[:space:]]*`

types/coin_test.go

@@ -67,7 +67,8 @@ func TestCoinIsValid(t *testing.T) {
 		{Coin{"Atom", NewInt(1)}, false},
 		{Coin{"a", NewInt(1)}, false},
 		{Coin{"a very long coin denom", NewInt(1)}, false},
-		{Coin{"atOm", NewInt(1)}, false},
+		{Coin{"atOm", NewInt(1)}, true},
+		{Coin{"ibc/7F1D3FCF4AE79E1554D670D1AD949A9BA4E4A3C76C63093E17E446A46061A7A2", NewInt(1)}, true},
 		{Coin{"     ", NewInt(1)}, false},
 	}
 
@@ -403,6 +404,10 @@ func TestCoins(t *testing.T) {
 	mixedCase3 := Coins{
 		{"gAs", NewInt(1)},
 	}
+	multipleIBCDenoms := Coins{
+		{"ibc/7F1D3FCF4AE79E1554D670D1AD949A9BA4E4A3C76C63093E17E446A46061A7A2", NewInt(1)},
+		{"ibc/876563AAAACF739EB061C67CDB5EDF2B7C9FD4AA9D876450CC21210807C2820A", NewInt(2)},
+	}
 	empty := NewCoins()
 	badSort1 := Coins{
 		{"tree", NewInt(1)},
@@ -433,8 +438,9 @@ func TestCoins(t *testing.T) {
 
 	assert.True(t, good.IsValid(), "Coins are valid")
 	assert.False(t, mixedCase1.IsValid(), "Coins denoms contain upper case characters")
-	assert.False(t, mixedCase2.IsValid(), "First Coins denoms contain upper case characters")
-	assert.False(t, mixedCase3.IsValid(), "Single denom in Coins contains upper case characters")
+	assert.True(t, mixedCase2.IsValid(), "First Coins denoms contain upper case characters")
+	assert.True(t, mixedCase3.IsValid(), "Single denom in Coins contains upper case characters")
+	assert.True(t, multipleIBCDenoms.IsValid(), "IBC denominations as per ADR001 should be valid")
 	assert.True(t, good.IsAllPositive(), "Expected coins to be positive: %v", good)
 	assert.False(t, empty.IsAllPositive(), "Expected coins to not be positive: %v", empty)
 	assert.True(t, good.IsAllGTE(empty), "Expected %v to be >= %v", good, empty)

x/ibc-transfer/client/cli/cli.go

@@ -6,6 +6,23 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 )
 
+// GetQueryCmd returns the query commands for IBC connections
+func GetQueryCmd() *cobra.Command {
+	queryCmd := &cobra.Command{
+		Use:                        "ibc-transfer",
+		Short:                      "IBC fungible token transfer query subcommands",
+		DisableFlagParsing:         true,
+		SuggestionsMinimumDistance: 2,
+	}
+
+	queryCmd.AddCommand(
+		GetCmdQueryDenomTrace(),
+		GetCmdQueryDenomTraces(),
+	)
+
+	return queryCmd
+}
+
 // NewTxCmd returns the transaction commands for IBC fungible token transfer
 func NewTxCmd() *cobra.Command {
 	txCmd := &cobra.Command{

x/ibc-transfer/client/cli/query.go

@@ -0,0 +1,87 @@
+package cli
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+	"github.com/cosmos/cosmos-sdk/version"
+	"github.com/cosmos/cosmos-sdk/x/ibc-transfer/types"
+)
+
+// GetCmdQueryDenomTraces defines the command to query all the denomination trace infos
+// that this chain mantains.
+func GetCmdQueryDenomTraces() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "denom-traces",
+		Short:   "Query the trace info for all token denominations",
+		Long:    "Query the trace info for all token denominations",
+		Example: fmt.Sprintf("%s query ibc-transfer denom-traces", version.AppName),
+		Args:    cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			clientCtx, err := client.ReadQueryCommandFlags(clientCtx, cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			queryClient := types.NewQueryClient(clientCtx)
+
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			req := &types.QueryDenomTracesRequest{
+				Pagination: pageReq,
+			}
+
+			res, err := queryClient.DenomTraces(context.Background(), req)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintOutput(res)
+		},
+	}
+	flags.AddQueryFlagsToCmd(cmd)
+	flags.AddPaginationFlagsToCmd(cmd, "denominations trace")
+
+	return cmd
+}
+
+// GetCmdQueryDenomTrace defines the command to query a a denomination trace from a given hash.
+func GetCmdQueryDenomTrace() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "denom-trace [hash]",
+		Short:   "Query the denom trace info from a given trace hash",
+		Long:    "Query the denom trace info from a given trace hash",
+		Example: fmt.Sprintf("%s query ibc-transfer denom-trace [hash]", version.AppName),
+		Args:    cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			clientCtx, err := client.ReadQueryCommandFlags(clientCtx, cmd.Flags())
+			if err != nil {
+				return err
+			}
+			queryClient := types.NewQueryClient(clientCtx)
+
+			req := &types.QueryDenomTraceRequest{
+				Hash: args[0],
+			}
+
+			res, err := queryClient.DenomTrace(context.Background(), req)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintOutput(res)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+	return cmd
+}

x/ibc-transfer/client/rest/rest.go

@@ -21,7 +21,7 @@ func RegisterRoutes(clientCtx client.Context, r *mux.Router) {
 // TransferTxReq defines the properties of a transfer tx request's body.
 type TransferTxReq struct {
 	BaseReq          rest.BaseReq `json:"base_req" yaml:"base_req"`
-	Amount           sdk.Coin     `json:"amount" yaml:"amount"`
+	Token            sdk.Coin     `json:"token" yaml:"token"`
 	Receiver         string       `json:"receiver" yaml:"receiver"`
 	TimeoutHeight    uint64       `json:"timeout_height" yaml:"timeout_height"`
 	TimeoutTimestamp uint64       `json:"timeout_timestamp" yaml:"timeout_timestamp"`

x/ibc-transfer/client/rest/tx.go

@@ -56,7 +56,7 @@ func transferHandlerFn(clientCtx client.Context) http.HandlerFunc {
 		msg := types.NewMsgTransfer(
 			portID,
 			channelID,
-			req.Amount,
+			req.Token,
 			fromAddr,
 			req.Receiver,
 			req.TimeoutHeight,