WIP: handle factory/ tokens

receive fixes

change separator

prefixfix

skip receive ParseDenomTrace

CLI factory/ support

Move prefix config to params

fix validation

bump ConsensusVersion

docs/ibc/proto-docs.md

@@ -544,6 +544,7 @@ parameter for the denomination to false.
 | ----- | ---- | ----- | ----------- |
 | `send_enabled` | [bool](#bool) |  | send_enabled enables or disables all cross-chain token transfers from this chain. |
 | `receive_enabled` | [bool](#bool) |  | receive_enabled enables or disables all cross-chain token transfers to this chain. |
+| `slash_prefix` | [string](#string) |  | In order to provide backward compatibility with IBC transfers to other IBCv3 chains, we can provide a prefix for denoms containing `/` so that they are escaped on send and receive with `:` |
 
 
 

modules/apps/transfer/client/cli/tx.go

@@ -53,7 +53,7 @@ corresponding to the counterparty channel. Any timeout set to 0 is disabled.`),
 				return err
 			}
 
-			if !strings.HasPrefix(coin.Denom, "ibc/") {
+			if !strings.HasPrefix(coin.Denom, "ibc/") && !strings.HasPrefix(coin.Denom, "factory/") {
 				denomTrace := types.ParseDenomTrace(coin.Denom)
 				coin.Denom = denomTrace.IBCDenom()
 			}

modules/apps/transfer/keeper/params.go

@@ -20,9 +20,16 @@ func (k Keeper) GetReceiveEnabled(ctx sdk.Context) bool {
 	return res
 }
 
+// GetSlashPrefix retrieves the slash prefix from the paramstore
+func (k Keeper) GetSlashPrefix(ctx sdk.Context) string {
+	var res string
+	k.paramSpace.Get(ctx, types.KeySlashPrefix, &res)
+	return res
+}
+
 // GetParams returns the total set of ibc-transfer parameters.
 func (k Keeper) GetParams(ctx sdk.Context) types.Params {
-	return types.NewParams(k.GetSendEnabled(ctx), k.GetReceiveEnabled(ctx))
+	return types.NewParams(k.GetSendEnabled(ctx), k.GetReceiveEnabled(ctx), k.GetSlashPrefix(ctx))
 }
 
 // SetParams sets the total set of ibc-transfer parameters.

modules/apps/transfer/keeper/relay.go

@@ -157,6 +157,10 @@ func (k Keeper) sendTransfer(
 		); err != nil {
 			return 0, err
 		}
+		prefix := k.GetSlashPrefix(ctx)
+		if prefix != "" && strings.HasPrefix(fullDenomPath, prefix+"/") {
+			fullDenomPath = strings.ReplaceAll(fullDenomPath, "/", ":")
+		}
 
 	} else {
 		labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "false"))
@@ -265,14 +269,20 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
 		unprefixedDenom := data.Denom[len(voucherPrefix):]
 
 		// coin denomination used in sending from the escrow address
-		denom := unprefixedDenom
-
-		// The denomination used to send the coins is either the native denom or the hash of the path
-		// if the denomination is not native.
-		denomTrace := types.ParseDenomTrace(unprefixedDenom)
-		if denomTrace.Path != "" {
-			denom = denomTrace.IBCDenom()
+		var denom string
+		prefix := k.GetSlashPrefix(ctx)
+		if prefix != "" && strings.HasPrefix(unprefixedDenom, prefix+":") {
+			denom = strings.ReplaceAll(unprefixedDenom, ":", "/")
+		} else {
+			denom = unprefixedDenom
+			// The denomination used to send the coins is either the native denom or the hash of the path
+			// if the denomination is not native.
+			denomTrace := types.ParseDenomTrace(unprefixedDenom)
+			if denomTrace.Path != "" {
+				denom = denomTrace.IBCDenom()
+			}
 		}
+
 		token := sdk.NewCoin(denom, transferAmount)
 
 		if k.bankKeeper.BlockedAddr(receiver) {

modules/apps/transfer/simulation/genesis.go

@@ -20,6 +20,10 @@ func RadomEnabled(r *rand.Rand) bool {
 	return r.Int63n(101) <= 75
 }
 
+func RandomPrefix(r *rand.Rand) string {
+	return simtypes.RandStringOfLength(r, 10)
+}
+
 // RandomizedGenState generates a random GenesisState for transfer.
 func RandomizedGenState(simState *module.SimulationState) {
 	var portID string
@@ -40,10 +44,16 @@ func RandomizedGenState(simState *module.SimulationState) {
 		func(r *rand.Rand) { receiveEnabled = RadomEnabled(r) },
 	)
 
+	var slashPrefix string
+	simState.AppParams.GetOrGenerate(
+		simState.Cdc, string(types.KeySlashPrefix), &slashPrefix, simState.Rand,
+		func(r *rand.Rand) { slashPrefix = RandomPrefix(r) },
+	)
+
 	transferGenesis := types.GenesisState{
 		PortId:      portID,
 		DenomTraces: types.Traces{},
-		Params:      types.NewParams(sendEnabled, receiveEnabled),
+		Params:      types.NewParams(sendEnabled, receiveEnabled, slashPrefix),
 	}
 
 	bz, err := json.MarshalIndent(&transferGenesis, "", " ")

modules/apps/transfer/types/params.go

@@ -2,7 +2,9 @@ package types
 
 import (
 	"fmt"
+	"strings"
 
+	sdk "github.com/cosmos/cosmos-sdk/types"
 	paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
 )
 
@@ -11,13 +13,17 @@ const (
 	DefaultSendEnabled = true
 	// DefaultReceiveEnabled enabled
 	DefaultReceiveEnabled = true
+	// DefaultSlashPrefix factory
+	DefaultSlashPrefix = "factory"
 )
 
 var (
 	// KeySendEnabled is store's key for SendEnabled Params
 	KeySendEnabled = []byte("SendEnabled")
 	// KeyReceiveEnabled is store's key for ReceiveEnabled Params
 	KeyReceiveEnabled = []byte("ReceiveEnabled")
+	// KeySlashPrefix is store's key for SlashPrefix Params
+	KeySlashPrefix = []byte("SlashPrefix")
 )
 
 // ParamKeyTable type declaration for parameters
@@ -26,16 +32,17 @@ func ParamKeyTable() paramtypes.KeyTable {
 }
 
 // NewParams creates a new parameter configuration for the ibc transfer module
-func NewParams(enableSend, enableReceive bool) Params {
+func NewParams(enableSend, enableReceive bool, slashPrefix string) Params {
 	return Params{
 		SendEnabled:    enableSend,
 		ReceiveEnabled: enableReceive,
+		SlashPrefix:    slashPrefix,
 	}
 }
 
 // DefaultParams is the default parameter configuration for the ibc-transfer module
 func DefaultParams() Params {
-	return NewParams(DefaultSendEnabled, DefaultReceiveEnabled)
+	return NewParams(DefaultSendEnabled, DefaultReceiveEnabled, DefaultSlashPrefix)
 }
 
 // Validate all ibc-transfer module parameters
@@ -44,6 +51,10 @@ func (p Params) Validate() error {
 		return err
 	}
 
+	if err := validatePrefix(p.SlashPrefix); err != nil {
+		return err
+	}
+
 	return validateEnabled(p.ReceiveEnabled)
 }
 
@@ -52,6 +63,7 @@ func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
 	return paramtypes.ParamSetPairs{
 		paramtypes.NewParamSetPair(KeySendEnabled, p.SendEnabled, validateEnabled),
 		paramtypes.NewParamSetPair(KeyReceiveEnabled, p.ReceiveEnabled, validateEnabled),
+		paramtypes.NewParamSetPair(KeySlashPrefix, p.SlashPrefix, validatePrefix),
 	}
 }
 
@@ -63,3 +75,21 @@ func validateEnabled(i interface{}) error {
 
 	return nil
 }
+
+func validatePrefix(i interface{}) error {
+	p, ok := i.(string)
+	if !ok {
+		return fmt.Errorf("invalid parameter type: %T", i)
+	}
+
+	err := sdk.ValidateDenom(p)
+	if err != nil {
+		return err
+	}
+
+	if strings.Contains(p, "/") {
+		return fmt.Errorf("invalid parameter type: %T", i)
+	}
+
+	return nil
+}

modules/apps/transfer/types/params_test.go

@@ -8,5 +8,6 @@ import (
 
 func TestValidateParams(t *testing.T) {
 	require.NoError(t, DefaultParams().Validate())
-	require.NoError(t, NewParams(true, false).Validate())
+	require.NoError(t, NewParams(true, false, "factory").Validate())
+	require.Error(t, NewParams(true, false, "factory/").Validate())
 }

proto/ibc/applications/transfer/v1/transfer.proto

@@ -27,4 +27,8 @@ message Params {
   // receive_enabled enables or disables all cross-chain token transfers to this
   // chain.
   bool receive_enabled = 2 [(gogoproto.moretags) = "yaml:\"receive_enabled\""];
+  // In order to provide backward compatibility with IBC transfers to other 
+  // IBCv3 chains, we can provide a prefix for denoms containing `/` so that they
+  // are escaped on send and receive with `:`
+  string slash_prefix = 3 [(gogoproto.moretags) = "yaml:\"slash_prefix\""];
 }