Merge pull request #665 from hieblmi/finalize-insuff-funds-loop-in

Finalize swap if wallet holds insufficient confirmed funds

Author: hieblmi

client.go

@@ -43,6 +43,10 @@ var (
 	// is too soon for us.
 	ErrExpiryTooFar = errors.New("swap expiry too far")
 
+	// ErrInsufficientBalance indicates insufficient confirmed balance to
+	// publish a swap.
+	ErrInsufficientBalance = errors.New("insufficient confirmed balance")
+
 	// serverRPCTimeout is the maximum time a gRPC request to the server
 	// should be allowed to take.
 	serverRPCTimeout = 30 * time.Second

loopd/swapclient_server.go

@@ -291,6 +291,9 @@ func (s *swapClientServer) marshallSwap(loopSwap *loop.SwapInfo) (
 	case loopdb.StateFailAbandoned:
 		failureReason = clientrpc.FailureReason_FAILURE_REASON_ABANDONED
 
+	case loopdb.StateFailInsufficientConfirmedBalance:
+		failureReason = clientrpc.FailureReason_FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE
+
 	default:
 		return nil, fmt.Errorf("unknown swap state: %v", loopSwap.State)
 	}

loopdb/swapstate.go

@@ -68,6 +68,10 @@ const (
 	// StateFailAbandoned indicates that a swap has been abandoned. Its
 	// execution has been canceled. It won't further be processed.
 	StateFailAbandoned SwapState = 11
+
+	// StateFailInsufficientConfirmedBalance indicates that the swap wasn't
+	// published due to insufficient confirmed balance.
+	StateFailInsufficientConfirmedBalance SwapState = 12
 )
 
 // SwapStateType defines the types of swap states that exist. Every swap state
@@ -153,6 +157,9 @@ func (s SwapState) String() string {
 	case StateFailAbandoned:
 		return "FailAbandoned"
 
+	case StateFailInsufficientConfirmedBalance:
+		return "InsufficientConfirmedBalance"
+
 	default:
 		return "Unknown"
 	}

loopin.go

@@ -530,6 +530,13 @@ func (s *loopInSwap) execute(mainCtx context.Context,
 	// error occurs.
 	err = s.executeSwap(mainCtx)
 
+	// If there are insufficient confirmed funds to publish the swap, we
+	// finalize its state so a new swap will be published if funds become
+	// available.
+	if errors.Is(err, ErrInsufficientBalance) {
+		return err
+	}
+
 	// Stop the execution if the swap has been abandoned.
 	if err != nil && s.state == loopdb.StateFailAbandoned {
 		return err
@@ -781,7 +788,14 @@ func (s *loopInSwap) publishOnChainHtlc(ctx context.Context) (bool, error) {
 		}}, feeRate, labels.LoopInHtlcLabel(swap.ShortHash(&s.hash)),
 	)
 	if err != nil {
-		return false, fmt.Errorf("send outputs: %v", err)
+		s.log.Errorf("send outputs: %v", err)
+		s.setState(loopdb.StateFailInsufficientConfirmedBalance)
+
+		// If we cannot send out this update, there is nothing we can
+		// do.
+		_ = s.persistAndAnnounceState(ctx)
+
+		return false, ErrInsufficientBalance
 	}
 
 	txHash := tx.TxHash()

looprpc/client.pb.go

@@ -535,6 +535,12 @@ enum FailureReason {
     the client manually abandoned the swap.
     */
     FAILURE_REASON_ABANDONED = 7;
+
+    /*
+    FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE indicates that a swap
+    wasn't published due to insufficient confirmed balance.
+    */
+    FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE = 8;
 }
 
 message ListSwapsRequest {

looprpc/client.proto

@@ -555,10 +555,11 @@
         "FAILURE_REASON_INSUFFICIENT_VALUE",
         "FAILURE_REASON_TEMPORARY",
         "FAILURE_REASON_INCORRECT_AMOUNT",
-        "FAILURE_REASON_ABANDONED"
+        "FAILURE_REASON_ABANDONED",
+        "FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE"
       ],
       "default": "FAILURE_REASON_NONE",
-      "description": " - FAILURE_REASON_NONE: FAILURE_REASON_NONE is set when the swap did not fail, it is either in\nprogress or succeeded.\n - FAILURE_REASON_OFFCHAIN: FAILURE_REASON_OFFCHAIN indicates that a loop out failed because it wasn't\npossible to find a route for one or both off chain payments that met the fee\nand timelock limits required.\n - FAILURE_REASON_TIMEOUT: FAILURE_REASON_TIMEOUT indicates that the swap failed because on chain htlc\ndid not confirm before its expiry, or it confirmed too late for us to reveal\nour preimage and claim.\n - FAILURE_REASON_SWEEP_TIMEOUT: FAILURE_REASON_SWEEP_TIMEOUT indicates that a loop out permanently failed\nbecause the on chain htlc wasn't swept before the server revoked the\nhtlc.\n - FAILURE_REASON_INSUFFICIENT_VALUE: FAILURE_REASON_INSUFFICIENT_VALUE indicates that a loop out has failed\nbecause the on chain htlc had a lower value than requested.\n - FAILURE_REASON_TEMPORARY: FAILURE_REASON_TEMPORARY indicates that a swap cannot continue due to an\ninternal error. Manual intervention such as a restart is required.\n - FAILURE_REASON_INCORRECT_AMOUNT: FAILURE_REASON_INCORRECT_AMOUNT indicates that a loop in permanently failed\nbecause the amount extended by an external loop in htlc is insufficient.\n - FAILURE_REASON_ABANDONED: FAILURE_REASON_ABANDONED indicates that a swap permanently failed because\nthe client manually abandoned the swap."
+      "description": " - FAILURE_REASON_NONE: FAILURE_REASON_NONE is set when the swap did not fail, it is either in\nprogress or succeeded.\n - FAILURE_REASON_OFFCHAIN: FAILURE_REASON_OFFCHAIN indicates that a loop out failed because it wasn't\npossible to find a route for one or both off chain payments that met the fee\nand timelock limits required.\n - FAILURE_REASON_TIMEOUT: FAILURE_REASON_TIMEOUT indicates that the swap failed because on chain htlc\ndid not confirm before its expiry, or it confirmed too late for us to reveal\nour preimage and claim.\n - FAILURE_REASON_SWEEP_TIMEOUT: FAILURE_REASON_SWEEP_TIMEOUT indicates that a loop out permanently failed\nbecause the on chain htlc wasn't swept before the server revoked the\nhtlc.\n - FAILURE_REASON_INSUFFICIENT_VALUE: FAILURE_REASON_INSUFFICIENT_VALUE indicates that a loop out has failed\nbecause the on chain htlc had a lower value than requested.\n - FAILURE_REASON_TEMPORARY: FAILURE_REASON_TEMPORARY indicates that a swap cannot continue due to an\ninternal error. Manual intervention such as a restart is required.\n - FAILURE_REASON_INCORRECT_AMOUNT: FAILURE_REASON_INCORRECT_AMOUNT indicates that a loop in permanently failed\nbecause the amount extended by an external loop in htlc is insufficient.\n - FAILURE_REASON_ABANDONED: FAILURE_REASON_ABANDONED indicates that a swap permanently failed because\nthe client manually abandoned the swap.\n - FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE: FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE indicates that a swap\nwasn't published due to insufficient confirmed balance."
     },
     "looprpcGetInfoResponse": {
       "type": "object",