ICS 20 Cleanup and Tests

x/ibc/04-channel/keeper/handshake.go

@@ -331,7 +331,7 @@ func (k Keeper) ChanCloseInit(
 
 	channel.State = exported.CLOSED
 	k.SetChannel(ctx, portID, channelID, channel)
-
+	k.Logger(ctx).Info("channel close initialized: portID (%s), channelID (%s)", portID, channelID)
 	return nil
 }
 

x/ibc/04-channel/types/msgs.go

@@ -446,7 +446,7 @@ func (msg MsgPacket) GetSigners() []sdk.AccAddress {
 
 var _ sdk.Msg = MsgTimeout{}
 
-// MsgTimeout receives timeouted packet
+// MsgTimeout receives timed-out packet
 type MsgTimeout struct {
 	Packet           `json:"packet" yaml:"packet"`
 	NextSequenceRecv uint64            `json:"next_sequence_recv" yaml:"next_sequence_recv"`

x/ibc/20-transfer/alias.go

@@ -42,6 +42,5 @@ type (
 	ConnectionKeeper   = types.ConnectionKeeper
 	SupplyKeeper       = types.SupplyKeeper
 	MsgTransfer        = types.MsgTransfer
-	MsgRecvPacket      = types.MsgRecvPacket
 	PacketDataTransfer = types.PacketDataTransfer
 )

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

@@ -30,7 +30,6 @@ func GetTxCmd(cdc *codec.Codec) *cobra.Command {
 
 	ics20TransferTxCmd.AddCommand(flags.PostCommands(
 		GetTransferTxCmd(cdc),
-		// GetMsgRecvPacketCmd(cdc),
 	)...)
 
 	return ics20TransferTxCmd

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

@@ -17,11 +17,4 @@ type (
 		Signatures []auth.StdSignature `json:"signatures" yaml:"signatures"`
 		Memo       string              `json:"memo" yaml:"memo"`
 	}
-
-	PostRecvPacket struct {
-		Msgs       []types.MsgRecvPacket `json:"msg" yaml:"msg"`
-		Fee        auth.StdFee           `json:"fee" yaml:"fee"`
-		Signatures []auth.StdSignature   `json:"signatures" yaml:"signatures"`
-		Memo       string                `json:"memo" yaml:"memo"`
-	}
 )

x/ibc/20-transfer/handler.go

@@ -9,6 +9,7 @@ import (
 )
 
 // NewHandler returns sdk.Handler for IBC token transfer module messages
+// See NewHandler function in ADR15: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
 func NewHandler(k Keeper) sdk.Handler {
 	return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
 		switch msg := msg.(type) {
@@ -19,24 +20,26 @@ func NewHandler(k Keeper) sdk.Handler {
 			case PacketDataTransfer: // i.e fulfills the Data interface
 				return handlePacketDataTransfer(ctx, k, msg, data)
 			default:
-				return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ics20 packet data type: %T", msg)
+				return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ICS-20 transfer packet data type: %T", msg)
 			}
 		case channeltypes.MsgTimeout:
 			switch data := msg.Data.(type) {
 			case PacketDataTransfer:
 				return handleTimeoutDataTransfer(ctx, k, msg, data)
 			default:
-				return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ics20 packet data type: %T", data)
+				return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ICS-20 transfer packet data type: %T", data)
 			}
 		default:
-			return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ics20 message type: %T", msg)
+			return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized ICS-20 transfer message type: %T", msg)
 		}
 	}
 }
 
+// See createOutgoingPacket in spec:https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
 func handleMsgTransfer(ctx sdk.Context, k Keeper, msg MsgTransfer) (*sdk.Result, error) {
-	err := k.SendTransfer(ctx, msg.SourcePort, msg.SourceChannel, msg.Amount, msg.Sender, msg.Receiver, msg.Source)
-	if err != nil {
+	if err := k.SendTransfer(
+		ctx, msg.SourcePort, msg.SourceChannel, msg.Amount, msg.Sender, msg.Receiver, msg.Source,
+	); err != nil {
 		return nil, err
 	}
 
@@ -54,19 +57,27 @@ func handleMsgTransfer(ctx sdk.Context, k Keeper, msg MsgTransfer) (*sdk.Result,
 	}, nil
 }
 
-func handlePacketDataTransfer(ctx sdk.Context, k Keeper, msg channeltypes.MsgPacket, data types.PacketDataTransfer) (*sdk.Result, error) {
+// See onRecvPacket in spec: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
+func handlePacketDataTransfer(
+	ctx sdk.Context, k Keeper, msg channeltypes.MsgPacket, data types.PacketDataTransfer,
+) (*sdk.Result, error) {
 	packet := msg.Packet
-	err := k.ReceiveTransfer(ctx, packet.SourcePort, packet.SourceChannel, packet.DestinationPort, packet.DestinationChannel, data)
-	if err != nil {
-		panic(err)
-		// TODO: Source chain sent invalid packet, shutdown channel
+	if err := k.ReceiveTransfer(
+		ctx, packet.SourcePort, packet.SourceChannel, packet.DestinationPort, packet.DestinationChannel, data,
+	); err != nil {
+		// TODO: handle packet receipt that due to an error (specify)
+		// the receiving chain couldn't process the transfer
+
+		// source chain sent invalid packet, shutdown our channel end
+		if err := k.ChanCloseInit(ctx, packet.DestinationPort, packet.DestinationChannel); err != nil {
+			return nil, err
+		}
+		return nil, err
 	}
 
 	acknowledgement := types.AckDataTransfer{}
-	err = k.PacketExecuted(ctx, packet, acknowledgement)
-	if err != nil {
-		panic(err)
-		// TODO: This should not happen
+	if err := k.PacketExecuted(ctx, packet, acknowledgement); err != nil {
+		return nil, err
 	}
 
 	ctx.EventManager().EmitEvent(
@@ -83,13 +94,15 @@ func handlePacketDataTransfer(ctx sdk.Context, k Keeper, msg channeltypes.MsgPac
 	}, nil
 }
 
+// See onTimeoutPacket in spec: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
 func handleTimeoutDataTransfer(ctx sdk.Context, k Keeper, msg channeltypes.MsgTimeout, data types.PacketDataTransfer) (*sdk.Result, error) {
 	packet := msg.Packet
-	err := k.TimeoutTransfer(ctx, packet.SourcePort, packet.SourceChannel, packet.DestinationPort, packet.DestinationChannel, data)
-	if err != nil {
-		// This chain sent invalid packet
-		panic(err)
+	if err := k.TimeoutTransfer(
+		ctx, packet.SourcePort, packet.SourceChannel, packet.DestinationPort, packet.DestinationChannel, data,
+	); err != nil {
+		return nil, err
 	}
+
 	// packet timeout should not fail
 	return &sdk.Result{
 		Events: ctx.EventManager().Events(),

x/ibc/20-transfer/keeper/keeper.go

@@ -68,3 +68,9 @@ func (k Keeper) GetTransferAccount(ctx sdk.Context) supplyexported.ModuleAccount
 func (k Keeper) PacketExecuted(ctx sdk.Context, packet channelexported.PacketI, acknowledgement channelexported.PacketDataI) error {
 	return k.channelKeeper.PacketExecuted(ctx, packet, acknowledgement)
 }
+
+// ChanCloseInit defines a wrapper function for the channel Keeper's function
+// in order to expose it to the ICS20 trasfer handler.
+func (k Keeper) ChanCloseInit(	ctx sdk.Context, portID, channelID string) error {
+	return k.channelKeeper.ChanCloseInit(ctx,portID, channelID)
+}