fix: throw error when all CLN payment attempts failed

lib/lightning/cln/ClnClient.ts

@@ -49,6 +49,7 @@ class ClnClient
   public static readonly moddedVersionSuffix = '-';
 
   public static readonly paymentPendingError = 'payment already pending';
+  public static readonly paymentAllAttemptsFailed = 'all attempts failed';
 
   private static readonly paymentMinFee = 121;
   private static readonly paymentTimeout = 300;
@@ -535,9 +536,16 @@ class ClnClient
     _?: string,
     maxPaymentFeeRatio?: number,
   ): Promise<PaymentResponse> => {
-    const payStatus = await this.checkPayStatus(invoice);
-    if (payStatus !== undefined) {
-      return payStatus;
+    try {
+      const payStatus = await this.checkPayStatus(invoice);
+      if (payStatus !== undefined) {
+        return payStatus;
+      }
+    } catch (e) {
+      // When all attempts failed, we are ready for another try
+      if (e !== ClnClient.paymentAllAttemptsFailed) {
+        throw e;
+      }
     }
 
     const decoded = await this.decodeInvoice(invoice);
@@ -662,7 +670,7 @@ class ClnClient
       >('listPays', listPayReq, false)
     ).getPaysList();
 
-    // Check if the payment succeeded...
+    // Check if the payment succeeded, ...
     const completedAttempts = pays.filter(
       (attempt) => attempt.getStatus() === ListpaysPaysStatus.COMPLETE,
     );
@@ -680,7 +688,7 @@ class ClnClient
       };
     }
 
-    // ... or is still pending
+    // ... is still pending ...
     const hasPendingPayments = pays.some(
       (pay) => pay.getStatus() === ListpaysPaysStatus.PENDING,
     );
@@ -708,6 +716,15 @@ class ClnClient
       }
     }
 
+    // ... or has failed
+    // TODO: update when xpay persists errors from previous attempts
+    if (
+      pays.length > 0 &&
+      pays.every((pay) => pay.getStatus() === ListpaysPaysStatus.FAILED)
+    ) {
+      throw ClnClient.paymentAllAttemptsFailed;
+    }
+
     return undefined;
   };
 

test/integration/lightning/cln/ClnClient.spec.ts

@@ -3,6 +3,7 @@ import { randomBytes } from 'crypto';
 import { getHexString, getUnixTime } from '../../../../lib/Utils';
 import Errors from '../../../../lib/lightning/Errors';
 import { InvoiceFeature } from '../../../../lib/lightning/LightningClient';
+import ClnClient from '../../../../lib/lightning/cln/ClnClient';
 import * as noderpc from '../../../../lib/proto/cln/node_pb';
 import * as primitivesrpc from '../../../../lib/proto/cln/primitives_pb';
 import Sidecar from '../../../../lib/sidecar/Sidecar';
@@ -298,6 +299,30 @@ describe('ClnClient', () => {
     });
   });
 
+  describe('checkPayStatus', () => {
+    test('should throw when all attempts failed', async () => {
+      const invoice = await bitcoinLndClient.addInvoice(10_000);
+      await bitcoinLndClient.cancelHoldInvoice(
+        Buffer.from(invoice.rHash as string, 'base64'),
+      );
+
+      await expect(
+        clnClient.sendPayment(invoice.paymentRequest),
+      ).rejects.toEqual(expect.anything());
+
+      await expect(
+        clnClient.checkPayStatus(invoice.paymentRequest),
+      ).rejects.toEqual(ClnClient.paymentAllAttemptsFailed);
+    });
+
+    test('should not throw when no attempts have been made', async () => {
+      const invoice = await bitcoinLndClient.addInvoice(10_000);
+      await expect(
+        clnClient.checkPayStatus(invoice.paymentRequest),
+      ).resolves.toBeUndefined();
+    });
+  });
+
   test('should subscribe to single invoices', async () => {
     expect.assertions(4);