optimize ibc error handling for bridge

Author: keithsue

api/side/btcbridge/params.pulsar.go

@@ -166,10 +166,8 @@ message TSSParams {
 
 // IBCParams defines the params related to IBC
 message IBCParams {
-  // Id of the IBC port used to transfer sBTC
-  string port_id = 1;
   // Timeout height offset relative to the current client height
-  uint64 timeout_height_offset = 2;
+  uint64 timeout_height_offset = 1;
   // Timeout duration relative to the current time
-  google.protobuf.Duration timeout_duration = 3 [(gogoproto.nullable) = false, (gogoproto.stdduration) = true];
+  google.protobuf.Duration timeout_duration = 2 [(gogoproto.nullable) = false, (gogoproto.stdduration) = true];
 }

proto/side/btcbridge/params.proto

@@ -20,25 +20,28 @@ func (k Keeper) AfterDeposit(ctx sdk.Context, addr string, amount sdk.Coin, tx *
 	// perform IBC transfer if enabled
 	script := types.GetIBCTransferScript(tx)
 	if len(script) != 0 {
-		var sequence uint64
-		var errMsg string
-
+		// parse channel id and recipient
 		channelId, recipient, err := types.ParseIBCTransferScript(script)
-		if err == nil {
-			sequence, err = k.IBCTransfer(ctx, addr, recipient, amount, channelId)
-		}
-
 		if err != nil {
-			errMsg = err.Error()
+			// no error
+			return nil
 		}
 
-		ctx.EventManager().EmitEvent(
-			sdk.NewEvent(
-				types.EventTypeIBCTransfer,
-				sdk.NewAttribute(types.AttributeKeyPacketSequence, fmt.Sprintf("%d", sequence)),
-				sdk.NewAttribute(types.AttributeKeyErrorMsg, errMsg),
-			),
+		// transfer
+		sequence, err := k.IBCTransfer(ctx, addr, recipient, amount, channelId)
+
+		// emit event
+		event := sdk.NewEvent(
+			types.EventTypeIBCTransfer,
+			sdk.NewAttribute(types.AttributeKeyChannelId, channelId),
 		)
+		if err == nil {
+			event = event.AppendAttributes(sdk.NewAttribute(types.AttributeKeyPacketSequence, fmt.Sprintf("%d", sequence)))
+		} else {
+			event = event.AppendAttributes(sdk.NewAttribute(types.AttributeKeyErrorMsg, err.Error()))
+		}
+
+		ctx.EventManager().EmitEvent(event)
 	}
 
 	return nil

x/btcbridge/keeper/hooks.go

@@ -19,13 +19,15 @@ import (
 
 // IBCTransfer performs the IBC transfer by the given params
 func (k Keeper) IBCTransfer(ctx sdk.Context, sender string, recipient string, token sdk.Coin, channelId string) (uint64, error) {
-	clientHeight, err := k.GetClientHeight(ctx, k.IBCPortId(ctx), channelId)
+	portId := k.ibctransferKeeper.GetPort(ctx)
+
+	clientHeight, err := k.GetClientHeight(ctx, portId, channelId)
 	if err != nil {
 		return 0, err
 	}
 
 	msg := &transfertypes.MsgTransfer{
-		SourcePort:       k.IBCPortId(ctx),
+		SourcePort:       portId,
 		SourceChannel:    channelId,
 		Token:            token,
 		Sender:           sender,
@@ -35,8 +37,20 @@ func (k Keeper) IBCTransfer(ctx sdk.Context, sender string, recipient string, to
 		Memo:             types.DefaultMemo,
 	}
 
+	// total escrow before transfer
+	totalEscrowBefore := k.ibctransferKeeper.GetTotalEscrowForDenom(ctx, token.Denom)
+
 	resp, err := k.ibctransferKeeper.Transfer(ctx, msg)
 	if err != nil {
+		// total escrow after transfer
+		totalEscrowAfter := k.ibctransferKeeper.GetTotalEscrowForDenom(ctx, token.Denom)
+		if totalEscrowBefore.IsLT(totalEscrowAfter) {
+			// unescrow token
+			if err := k.UnescrowToken(ctx, portId, channelId, sender, token); err != nil {
+				panic(err)
+			}
+		}
+
 		return 0, err
 	}
 
@@ -141,6 +155,21 @@ func (k Keeper) GetClientHeight(ctx sdk.Context, sourcePort string, sourceChanne
 	return clientState.GetLatestHeight(), nil
 }
 
+// UnescrowToken unescrows the given token from the IBC transfer module
+// NOTE: This method is called only if the IBC transfer failed while the token is escrowed
+func (k Keeper) UnescrowToken(ctx sdk.Context, portId string, channelId string, recipient string, token sdk.Coin) error {
+	escrowAddress := transfertypes.GetEscrowAddress(portId, channelId)
+	if err := k.bankKeeper.SendCoins(ctx, escrowAddress, sdk.MustAccAddressFromBech32(recipient), sdk.NewCoins(token)); err != nil {
+		return errorsmod.Wrap(err, "failed to unescrow token")
+	}
+
+	currentTotalEscrow := k.ibctransferKeeper.GetTotalEscrowForDenom(ctx, token.Denom)
+	newTotalEscrow := currentTotalEscrow.Sub(token)
+	k.ibctransferKeeper.SetTotalEscrowForDenom(ctx, newTotalEscrow)
+
+	return nil
+}
+
 // IBCSendPacketCallback implements IBC callbacks
 func (k Keeper) IBCSendPacketCallback(
 	ctx sdk.Context,

x/btcbridge/keeper/ibc.go

@@ -104,11 +104,6 @@ func (k Keeper) AddressRateLimitQuota(ctx sdk.Context) int64 {
 	return k.GetParams(ctx).RateLimitParams.AddressRateLimitParams.Quota
 }
 
-// IBCPortId gets the IBC port id
-func (k Keeper) IBCPortId(ctx sdk.Context) string {
-	return k.GetParams(ctx).IbcParams.PortId
-}
-
 // IBCTimeoutHeightOffset gets the IBC timeout height offset
 func (k Keeper) IBCTimeoutHeightOffset(ctx sdk.Context) uint64 {
 	return k.GetParams(ctx).IbcParams.TimeoutHeightOffset

x/btcbridge/keeper/params.go

@@ -88,5 +88,10 @@ type IBCChannelKeeper interface {
 
 // IBCTransferKeeper defines the expected IBC transfer interfaces
 type IBCTransferKeeper interface {
+	GetPort(ctx sdk.Context) string
+
+	GetTotalEscrowForDenom(ctx sdk.Context, denom string) sdk.Coin
+	SetTotalEscrowForDenom(ctx sdk.Context, coin sdk.Coin)
+
 	Transfer(goCtx context.Context, msg *ibctransfertypes.MsgTransfer) (*ibctransfertypes.MsgTransferResponse, error)
 }