chore: prevent WalletInvoice deletion

core/api/src/app/wallets/update-pending-invoices.ts

@@ -116,10 +116,11 @@ export const declineHeldInvoice = wrapAsyncToRunInSpan({
     })
 
     if (lnInvoiceLookup instanceof InvoiceNotFoundError) {
-      const isDeleted = await walletInvoicesRepo.deleteByPaymentHash(paymentHash)
-      if (isDeleted instanceof Error) {
-        pendingInvoiceLogger.error("impossible to delete WalletInvoice entry")
-        return isDeleted
+      const processingCompletedInvoice =
+        await walletInvoicesRepo.markAsProcessingCompleted(paymentHash)
+      if (processingCompletedInvoice instanceof Error) {
+        pendingInvoiceLogger.error("Unable to mark invoice as processingCompleted")
+        return processingCompletedInvoice
       }
       return false
     }
@@ -148,9 +149,10 @@ export const declineHeldInvoice = wrapAsyncToRunInSpan({
     const invoiceSettled = await lndService.cancelInvoice({ pubkey, paymentHash })
     if (invoiceSettled instanceof Error) return invoiceSettled
 
-    const isDeleted = await walletInvoicesRepo.deleteByPaymentHash(paymentHash)
-    if (isDeleted instanceof Error) {
-      pendingInvoiceLogger.error("impossible to delete WalletInvoice entry")
+    const processingCompletedInvoice =
+      await walletInvoicesRepo.markAsProcessingCompleted(paymentHash)
+    if (processingCompletedInvoice instanceof Error) {
+      pendingInvoiceLogger.error("Unable to mark invoice as processingCompleted")
     }
 
     return true
@@ -211,10 +213,11 @@ const updatePendingInvoiceBeforeFinally = async ({
 
   const lnInvoiceLookup = await lndService.lookupInvoice({ pubkey, paymentHash })
   if (lnInvoiceLookup instanceof InvoiceNotFoundError) {
-    const isDeleted = await walletInvoicesRepo.deleteByPaymentHash(paymentHash)
-    if (isDeleted instanceof Error) {
-      pendingInvoiceLogger.error("impossible to delete WalletInvoice entry")
-      return isDeleted
+    const processingCompletedInvoice =
+      await walletInvoicesRepo.markAsProcessingCompleted(paymentHash)
+    if (processingCompletedInvoice instanceof Error) {
+      pendingInvoiceLogger.error("Unable to mark invoice as processingCompleted")
+      return processingCompletedInvoice
     }
     return false
   }
@@ -230,6 +233,17 @@ const updatePendingInvoiceBeforeFinally = async ({
     return true
   }
 
+  if (lnInvoiceLookup.isCanceled) {
+    pendingInvoiceLogger.info("invoice has been canceled")
+    const processingCompletedInvoice =
+      await walletInvoicesRepo.markAsProcessingCompleted(paymentHash)
+    if (processingCompletedInvoice instanceof Error) {
+      pendingInvoiceLogger.error("Unable to mark invoice as processingCompleted")
+      return processingCompletedInvoice
+    }
+    return false
+  }
+
   if (!lnInvoiceLookup.isHeld && !lnInvoiceLookup.isSettled) {
     pendingInvoiceLogger.info("invoice has not been paid yet")
     return false
@@ -302,6 +316,7 @@ const updatePendingInvoiceBeforeFinally = async ({
       "invoices.finalRecipient": JSON.stringify(recipientWalletDescriptor),
     })
 
+    // Is this crossing the lock boundary?
     if (!lnInvoiceLookup.isSettled) {
       const invoiceSettled = await lndService.settleInvoice({ pubkey, secret })
       if (invoiceSettled instanceof Error) return invoiceSettled

core/api/src/debug/migrate-ln-payments-trackpaymentsv2.ts

@@ -102,23 +102,23 @@ const migrateLnPayment = async (
         payment.status === PaymentStatus.Pending
           ? partialLnPayment
           : payment.status === PaymentStatus.Failed
-            ? {
-                ...partialLnPayment,
-                status: PaymentStatus.Failed,
-                confirmedDetails: undefined,
-                attempts: undefined,
-                isCompleteRecord: true,
-              }
-            : {
-                ...partialLnPayment,
-                createdAt: payment.createdAt,
-                status: payment.status,
-                milliSatsAmount: payment.milliSatsAmount,
-                roundedUpAmount: payment.roundedUpAmount,
-                confirmedDetails: payment.confirmedDetails,
-                attempts: payment.attempts, // will be null, only comes from getPayments
-                isCompleteRecord: true,
-              }
+          ? {
+              ...partialLnPayment,
+              status: PaymentStatus.Failed,
+              confirmedDetails: undefined,
+              attempts: undefined,
+              isCompleteRecord: true,
+            }
+          : {
+              ...partialLnPayment,
+              createdAt: payment.createdAt,
+              status: payment.status,
+              milliSatsAmount: payment.milliSatsAmount,
+              roundedUpAmount: payment.roundedUpAmount,
+              confirmedDetails: payment.confirmedDetails,
+              attempts: payment.attempts, // will be null, only comes from getPayments
+              isCompleteRecord: true,
+            }
 
       const updatedPaymentLookup = await LnPaymentsRepository().persistNew(newLnPayment)
       if (updatedPaymentLookup instanceof Error) {

core/api/src/domain/payments/payment-flow-builder.ts

@@ -44,8 +44,8 @@ export const LightningPaymentFlowBuilder = <S extends WalletCurrency>(
       destination === undefined
         ? SettlementMethod.IntraLedger
         : config.localNodeIds.includes(destination)
-          ? SettlementMethod.IntraLedger
-          : SettlementMethod.Lightning
+        ? SettlementMethod.IntraLedger
+        : SettlementMethod.Lightning
     return {
       settlementMethod,
       btcProtocolAndBankFee:
@@ -533,8 +533,8 @@ const LPFBWithConversion = <S extends WalletCurrency, R extends WalletCurrency>(
     const hash = state.paymentHash
       ? { paymentHash: state.paymentHash }
       : state.intraLedgerHash
-        ? { intraLedgerHash: state.intraLedgerHash }
-        : new InvalidLightningPaymentFlowStateError()
+      ? { intraLedgerHash: state.intraLedgerHash }
+      : new InvalidLightningPaymentFlowStateError()
     if (hash instanceof Error) return hash
 
     return PaymentFlow({

core/api/src/domain/shared/error-parsers-unknown.ts

@@ -5,9 +5,9 @@ export const parseUnknownDomainErrorFromUnknown = (error: unknown): DomainError
     error instanceof Error
       ? error
       : typeof error === "string"
-        ? new UnknownDomainError(error)
-        : error instanceof Object
-          ? new UnknownDomainError(JSON.stringify(error))
-          : new UnknownDomainError("Unknown error")
+      ? new UnknownDomainError(error)
+      : error instanceof Object
+      ? new UnknownDomainError(JSON.stringify(error))
+      : new UnknownDomainError("Unknown error")
   return err
 }

core/api/src/domain/shared/error-parsers.ts

@@ -3,10 +3,10 @@ export const parseErrorMessageFromUnknown = (error: unknown): string => {
     error instanceof Error
       ? error.message
       : typeof error === "string"
-        ? error
-        : error instanceof Object
-          ? JSON.stringify(error)
-          : "Unknown error"
+      ? error
+      : error instanceof Object
+      ? JSON.stringify(error)
+      : "Unknown error"
   return errMsg
 }
 
@@ -15,9 +15,9 @@ export const parseErrorFromUnknown = (error: unknown): Error => {
     error instanceof Error
       ? error
       : typeof error === "string"
-        ? new Error(error)
-        : error instanceof Object
-          ? new Error(JSON.stringify(error))
-          : new Error("Unknown error")
+      ? new Error(error)
+      : error instanceof Object
+      ? new Error(JSON.stringify(error))
+      : new Error("Unknown error")
   return err
 }

core/api/src/domain/wallet-invoices/index.types.d.ts

@@ -93,6 +93,7 @@ type WalletInvoiceWithOptionalLnInvoice = {
   recipientWalletDescriptor: PartialWalletDescriptor<WalletCurrency>
   paid: boolean
   createdAt: Date
+  processingCompleted?: boolean
   lnInvoice?: LnInvoice // LnInvoice is optional because some older invoices don't have it
 }
 
@@ -197,7 +198,7 @@ interface IWalletInvoicesRepository {
 
   yieldPending: () => AsyncGenerator<WalletInvoiceWithOptionalLnInvoice> | RepositoryError
 
-  deleteByPaymentHash: (paymentHash: PaymentHash) => Promise<boolean | RepositoryError>
-
-  deleteUnpaidOlderThan: (before: Date) => Promise<number | RepositoryError>
+  markAsProcessingCompleted: (
+    paymentHash: PaymentHash,
+  ) => Promise<WalletInvoiceWithOptionalLnInvoice | RepositoryError>
 }

core/api/src/graphql/admin/root/query/lightning-payment.ts

@@ -23,8 +23,8 @@ const LightningPaymentQuery = GT.Field({
       const paymentRequest = !(lightningPayment instanceof Error)
         ? lightningPayment.paymentRequest
         : "paymentRequest" in lightningPaymentFromLnd
-          ? lightningPaymentFromLnd.paymentRequest
-          : undefined
+        ? lightningPaymentFromLnd.paymentRequest
+        : undefined
 
       return {
         ...lightningPaymentFromLnd,

core/api/src/servers/cron.ts

@@ -12,7 +12,6 @@ import {
 } from "@/services/tracing"
 import {
   deleteExpiredLightningPaymentFlows,
-  deleteExpiredWalletInvoice,
   deleteFailedPaymentsAttemptAllLnds,
   updateEscrows,
   updateRoutingRevenues,
@@ -40,10 +39,6 @@ const updateLegacyOnChainReceipt = async () => {
   if (txNumber instanceof Error) throw txNumber
 }
 
-const deleteExpiredInvoices = async () => {
-  await deleteExpiredWalletInvoice()
-}
-
 const deleteExpiredPaymentFlows = async () => {
   await deleteExpiredLightningPaymentFlows()
 }
@@ -85,7 +80,6 @@ const main = async () => {
     ...(cronConfig.rebalanceEnabled ? [rebalance] : []),
     ...(cronConfig.swapEnabled ? [swapOutJob] : []),
     deleteExpiredPaymentFlows,
-    deleteExpiredInvoices,
     deleteLndPaymentsBefore2Months,
     deleteFailedPaymentsAttemptAllLnds,
   ]

core/api/src/services/lnd/utils.ts

@@ -35,29 +35,11 @@ import {
   updateLndEscrow,
 } from "@/services/ledger/admin-legacy"
 import { baseLogger } from "@/services/logger"
-import { PaymentFlowStateRepository, WalletInvoicesRepository } from "@/services/mongoose"
+import { PaymentFlowStateRepository } from "@/services/mongoose"
 import { DbMetadata } from "@/services/mongoose/schema"
 
 import { timestampDaysAgo } from "@/utils"
 
-export const deleteExpiredWalletInvoice = async (): Promise<number> => {
-  const walletInvoicesRepo = WalletInvoicesRepository()
-
-  // this should be longer than the invoice validity time
-  const delta = 90 // days
-
-  const date = new Date()
-  date.setDate(date.getDate() - delta)
-
-  const result = await walletInvoicesRepo.deleteUnpaidOlderThan(date)
-  if (result instanceof Error) {
-    baseLogger.error({ error: result }, "error deleting expired invoices")
-    return 0
-  }
-
-  return result
-}
-
 export const deleteFailedPaymentsAttemptAllLnds = async () => {
   const lnds = offchainLnds
   for (const { lnd, socket } of lnds) {

core/api/src/services/mongoose/payment-flow.ts

@@ -46,8 +46,8 @@ export const PaymentFlowStateRepository = (
     const hash = paymentHash
       ? { paymentHash }
       : intraLedgerHash
-        ? { intraLedgerHash }
-        : new BadInputsForFindError(JSON.stringify(args))
+      ? { intraLedgerHash }
+      : new BadInputsForFindError(JSON.stringify(args))
     if (hash instanceof Error) return hash
 
     try {
@@ -192,10 +192,10 @@ const paymentFlowFromRaw = <S extends WalletCurrency, R extends WalletCurrency>(
   const hash = paymentHash
     ? { paymentHash: paymentHash as PaymentHash }
     : intraLedgerHash
-      ? { intraLedgerHash: intraLedgerHash as IntraLedgerHash }
-      : new InvalidLightningPaymentFlowStateError(
-          "Missing valid 'paymentHash' or 'intraLedgerHash'",
-        )
+    ? { intraLedgerHash: intraLedgerHash as IntraLedgerHash }
+    : new InvalidLightningPaymentFlowStateError(
+        "Missing valid 'paymentHash' or 'intraLedgerHash'",
+      )
   if (hash instanceof Error) return hash
 
   const btcPaymentAmount = paymentAmountFromNumber({
@@ -262,10 +262,10 @@ const rawFromPaymentFlow = <S extends WalletCurrency, R extends WalletCurrency>(
   const hash = paymentHash
     ? { paymentHash }
     : intraLedgerHash
-      ? { intraLedgerHash }
-      : new InvalidLightningPaymentFlowStateError(
-          "Missing valid 'paymentHash' or 'intraLedgerHash'",
-        )
+    ? { intraLedgerHash }
+    : new InvalidLightningPaymentFlowStateError(
+        "Missing valid 'paymentHash' or 'intraLedgerHash'",
+      )
   if (hash instanceof Error) return hash
 
   return {
@@ -307,10 +307,10 @@ const rawIndexFromPaymentFlowIndex = (
   const hash = paymentHash
     ? { paymentHash }
     : intraLedgerHash
-      ? { intraLedgerHash }
-      : new InvalidLightningPaymentFlowStateError(
-          "Missing valid 'paymentHash' or 'intraLedgerHash'",
-        )
+    ? { intraLedgerHash }
+    : new InvalidLightningPaymentFlowStateError(
+        "Missing valid 'paymentHash' or 'intraLedgerHash'",
+      )
   if (hash instanceof Error) return hash
 
   return {

core/api/src/services/mongoose/schema.ts

@@ -78,6 +78,11 @@ const walletInvoiceSchema = new Schema<WalletInvoiceRecord>({
     default: false,
   },
 
+  processingCompleted: {
+    type: Boolean,
+    default: false,
+  },
+
   paymentRequest: {
     type: String,
   },

core/api/src/services/mongoose/schema.types.d.ts

@@ -69,6 +69,7 @@ interface WalletInvoiceRecord {
   currency: string
   timestamp: Date
   selfGenerated: boolean
+  processingCompleted?: boolean
   pubkey: string
   paid: boolean
   paymentRequest?: string // optional because we historically did not store it