imp(transfer)!: use AddressCodec instead of Bech32 (backport #8573)

* imp: added address codec to transfer

* imp: address codec used in transfer

* fix: tests

* imp: test passing

* imp: added addressCodec to PFM

* imp: added receiver test

* test: transfer cov

* test: added cases

* test: more cov

* test: more cov

* style: single line func def

* test: new test works

* imp: add basic test

* imp: added migration guide

* doc: added changelog

* refactor: address codec moved

Author: yihuang

CHANGELOG.md

@@ -34,6 +34,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
+## [Unreleased]
+
+* [\#8573](https://github.com/cosmos/ibc-go/pull/8573) Support custom address codecs in transfer.
+
 ## [v10.3.0](https://github.com/cosmos/ibc-go/releases/tag/v10.3.0) - 2025-06-06
 
 ### Features

modules/apps/transfer/keeper/keeper.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strings"
 
+	"cosmossdk.io/core/address"
 	corestore "cosmossdk.io/core/store"
 	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
@@ -28,6 +29,7 @@ type Keeper struct {
 	storeService   corestore.KVStoreService
 	cdc            codec.BinaryCodec
 	legacySubspace types.ParamSubspace
+	addressCodec   address.Codec
 
 	ics4Wrapper   porttypes.ICS4Wrapper
 	channelKeeper types.ChannelKeeper
@@ -91,6 +93,16 @@ func (k Keeper) GetAuthority() string {
 	return k.authority
 }
 
+// SetAddressCodec sets the address codec used by the keeper.
+func (k *Keeper) SetAddressCodec(addressCodec address.Codec) {
+	k.addressCodec = addressCodec
+}
+
+// GetAddressCodec returns the address codec used by the keeper.
+func (k *Keeper) GetAddressCodec() address.Codec {
+	return k.addressCodec
+}
+
 // Logger returns a module-specific logger.
 func (Keeper) Logger(ctx sdk.Context) log.Logger {
 	return ctx.Logger().With("module", "x/"+exported.ModuleName+"-"+types.ModuleName)

modules/apps/transfer/keeper/msg_server.go

@@ -27,7 +27,13 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.
 		return nil, types.ErrSendDisabled
 	}
 
-	sender, err := sdk.AccAddressFromBech32(msg.Sender)
+	var sender sdk.AccAddress
+	var err error
+	if k.addressCodec != nil {
+		sender, err = k.addressCodec.StringToBytes(msg.Sender)
+	} else {
+		sender, err = sdk.AccAddressFromBech32(msg.Sender)
+	}
 	if err != nil {
 		return nil, err
 	}
@@ -47,7 +53,7 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.
 		return nil, err
 	}
 
-	packetData := types.NewFungibleTokenPacketData(token.Denom.Path(), token.Amount, sender.String(), msg.Receiver, msg.Memo)
+	packetData := types.NewFungibleTokenPacketData(token.Denom.Path(), token.Amount, msg.Sender, msg.Receiver, msg.Memo)
 
 	if err := packetData.ValidateBasic(); err != nil {
 		return nil, errorsmod.Wrapf(err, "failed to validate %s packet data", types.V1)
@@ -60,7 +66,7 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.
 	var sequence uint64
 	if isIBCV1 {
 		// if a V1 channel exists for the source channel, then use IBC V1 protocol
-		sequence, err = k.transferV1Packet(ctx, msg.SourceChannel, token, msg.TimeoutHeight, msg.TimeoutTimestamp, packetData)
+		sequence, err = k.transferV1Packet(ctx, msg.SourceChannel, token, msg.TimeoutHeight, msg.TimeoutTimestamp, sender, packetData)
 		// telemetry for transfer occurs here, in IBC V2 this is done in the onSendPacket callback
 		telemetry.ReportTransfer(msg.SourcePort, msg.SourceChannel, channel.Counterparty.PortId, channel.Counterparty.ChannelId, token)
 	} else {
@@ -77,8 +83,8 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.
 	return &types.MsgTransferResponse{Sequence: sequence}, nil
 }
 
-func (k Keeper) transferV1Packet(ctx sdk.Context, sourceChannel string, token types.Token, timeoutHeight clienttypes.Height, timeoutTimestamp uint64, packetData types.FungibleTokenPacketData) (uint64, error) {
-	if err := k.SendTransfer(ctx, types.PortID, sourceChannel, token, sdk.MustAccAddressFromBech32(packetData.Sender)); err != nil {
+func (k *Keeper) transferV1Packet(ctx sdk.Context, sourceChannel string, token types.Token, timeoutHeight clienttypes.Height, timeoutTimestamp uint64, sender sdk.AccAddress, packetData types.FungibleTokenPacketData) (uint64, error) {
+	if err := k.SendTransfer(ctx, types.PortID, sourceChannel, token, sender); err != nil {
 		return 0, err
 	}
 

modules/apps/transfer/keeper/msg_server_test.go

@@ -61,6 +61,13 @@ func (suite *KeeperTestSuite) TestMsgTransfer() {
 			},
 			types.ErrSendDisabled,
 		},
+		{
+			"failure: zero amount",
+			func() {
+				msg.Token = sdk.NewInt64Coin(sdk.DefaultBondDenom, 0)
+			},
+			types.ErrInvalidAmount,
+		},
 		{
 			"failure: invalid sender",
 			func() {

modules/apps/transfer/keeper/relay.go

@@ -127,7 +127,13 @@ func (k Keeper) OnRecvPacket(
 		return types.ErrReceiveDisabled
 	}
 
-	receiver, err := sdk.AccAddressFromBech32(data.Receiver)
+	var receiver sdk.AccAddress
+	var err error
+	if k.addressCodec != nil {
+		receiver, err = k.addressCodec.StringToBytes(data.Receiver)
+	} else {
+		receiver, err = sdk.AccAddressFromBech32(data.Receiver)
+	}
 	if err != nil {
 		return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "failed to decode receiver address: %s", data.Receiver)
 	}
@@ -195,7 +201,7 @@ func (k Keeper) OnRecvPacket(
 		if err := k.BankKeeper.SendCoins(
 			ctx, moduleAddr, receiver, sdk.NewCoins(voucher),
 		); err != nil {
-			return errorsmod.Wrapf(err, "failed to send coins to receiver %s", receiver.String())
+			return errorsmod.Wrapf(err, "failed to send coins to receiver %s", data.Receiver)
 		}
 
 	}
@@ -253,7 +259,13 @@ func (k Keeper) refundPacketTokens(
 ) error {
 	// NOTE: packet data type already checked in handler.go
 
-	sender, err := sdk.AccAddressFromBech32(data.Sender)
+	var sender sdk.AccAddress
+	var err error
+	if k.addressCodec != nil {
+		sender, err = k.addressCodec.StringToBytes(data.Sender)
+	} else {
+		sender, err = sdk.AccAddressFromBech32(data.Sender)
+	}
 	if err != nil {
 		return err
 	}

modules/apps/transfer/keeper/relay_test.go

@@ -1,6 +1,7 @@
 package keeper_test
 
 import (
+	"encoding/hex"
 	"errors"
 	"fmt"
 	"strings"
@@ -47,19 +48,19 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
 		expError error
 	}{
 		{
-			"successful transfer of native token",
+			"success: transfer of native token",
 			func() {},
 			nil,
 		},
 		{
-			"successful transfer of native token with memo",
+			"success: transfer of native token with memo",
 			func() {
 				memo = "memo" //nolint:goconst
 			},
 			nil,
 		},
 		{
-			"successful transfer of IBC token",
+			"success: transfer of IBC token",
 			func() {
 				// send IBC token back to chainB
 				denom := types.NewDenom(ibctesting.TestCoin.Denom, types.NewHop(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID))
@@ -70,7 +71,7 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
 			nil,
 		},
 		{
-			"successful transfer of IBC token with memo",
+			"success: transfer of IBC token with memo",
 			func() {
 				// send IBC token back to chainB
 				denom := types.NewDenom(ibctesting.TestCoin.Denom, types.NewHop(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID))
@@ -82,7 +83,7 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
 			nil,
 		},
 		{
-			"successful transfer of entire balance",
+			"success: transfer of entire balance",
 			func() {
 				coin = sdk.NewCoin(coin.Denom, types.UnboundedSpendLimit())
 				var ok bool
@@ -92,7 +93,7 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
 			nil,
 		},
 		{
-			"successful transfer of entire spendable balance with vesting account",
+			"success: transfer of entire spendable balance with vesting account",
 			func() {
 				// create vesting account
 				vestingAccPrivKey := secp256k1.GenPrivKey()
@@ -325,17 +326,27 @@ func (suite *KeeperTestSuite) TestOnRecvPacket_ReceiverIsNotSource() {
 		expError error
 	}{
 		{
-			"successful receive",
+			"success: receive",
 			func() {},
 			nil,
 		},
 		{
-			"successful receive with memo",
+			"success: receive with memo",
 			func() {
 				packetData.Memo = "memo"
 			},
 			nil,
 		},
+		{
+			"success: receive with hex receiver address",
+			func() {
+				s.chainB.GetSimApp().TransferKeeper.SetAddressCodec(ibcmock.TestAddressCodec{})
+
+				receiver := sdk.MustAccAddressFromBech32(packetData.Receiver)
+				packetData.Receiver = hex.EncodeToString(receiver.Bytes())
+			},
+			nil,
+		},
 		{
 			"failure: mint zero coin",
 			func() {

modules/apps/transfer/types/msgs.go

@@ -34,9 +34,8 @@ func NewMsgUpdateParams(signer string, params Params) *MsgUpdateParams {
 
 // ValidateBasic implements sdk.Msg
 func (msg MsgUpdateParams) ValidateBasic() error {
-	_, err := sdk.AccAddressFromBech32(msg.Signer)
-	if err != nil {
-		return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
+	if strings.TrimSpace(msg.Signer) == "" {
+		return errorsmod.Wrap(ibcerrors.ErrInvalidAddress, "missing sender address")
 	}
 
 	return nil
@@ -96,9 +95,8 @@ func (msg MsgTransfer) ValidateBasic() error {
 		return errorsmod.Wrap(ibcerrors.ErrInvalidCoins, msg.Token.String())
 	}
 
-	_, err := sdk.AccAddressFromBech32(msg.Sender)
-	if err != nil {
-		return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
+	if strings.TrimSpace(msg.Sender) == "" {
+		return errorsmod.Wrap(ibcerrors.ErrInvalidAddress, "missing sender address")
 	}
 	if strings.TrimSpace(msg.Receiver) == "" {
 		return errorsmod.Wrap(ibcerrors.ErrInvalidAddress, "missing recipient address")

modules/apps/transfer/types/msgs_test.go

@@ -111,7 +111,6 @@ func TestMsgUpdateParamsValidateBasic(t *testing.T) {
 		expError error
 	}{
 		{"success: valid signer and valid params", types.NewMsgUpdateParams(ibctesting.TestAccAddress, types.DefaultParams()), nil},
-		{"failure: invalid signer with valid params", types.NewMsgUpdateParams(invalidAddress, types.DefaultParams()), ibcerrors.ErrInvalidAddress},
 		{"failure: empty signer with valid params", types.NewMsgUpdateParams(emptyAddr, types.DefaultParams()), ibcerrors.ErrInvalidAddress},
 	}
 

modules/apps/transfer/v2/ibc_module.go

@@ -52,12 +52,12 @@ func (im *IBCModule) OnSendPacket(ctx sdk.Context, sourceChannel string, destina
 		return err
 	}
 
-	sender, err := sdk.AccAddressFromBech32(data.Sender)
+	sender, err := im.keeper.GetAddressCodec().StringToBytes(data.Sender)
 	if err != nil {
 		return err
 	}
 
-	if !signer.Equals(sender) {
+	if !bytes.Equal(sender, signer) {
 		return errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "sender %s is different from signer %s", sender, signer)
 	}
 
@@ -76,7 +76,7 @@ func (im *IBCModule) OnSendPacket(ctx sdk.Context, sourceChannel string, destina
 		return err
 	}
 
-	events.EmitTransferEvent(ctx, sender.String(), data.Receiver, data.Token, data.Memo)
+	events.EmitTransferEvent(ctx, data.Sender, data.Receiver, data.Token, data.Memo)
 
 	telemetry.ReportTransfer(payload.SourcePort, sourceChannel, payload.DestinationPort, destinationChannel, data.Token)
 

testing/mock/address_codec.go

@@ -0,0 +1,27 @@
+package mock
+
+import (
+	"errors"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+type TestAddressCodec struct{}
+
+func (t TestAddressCodec) StringToBytes(text string) ([]byte, error) {
+	hexBytes, err := sdk.AccAddressFromHexUnsafe(text)
+	if err == nil {
+		return hexBytes, nil
+	}
+
+	bech32Bytes, err := sdk.AccAddressFromBech32(text)
+	if err == nil {
+		return bech32Bytes, nil
+	}
+
+	return nil, errors.New("invalid address format")
+}
+
+func (t TestAddressCodec) BytesToString(bz []byte) (string, error) {
+	return sdk.AccAddress(bz).String(), nil
+}