Immediate Failure Propagation in LightningService.waitForReceive()

[sadeeqrabiu]

Located in LightningService.ts:

async waitForReceive(operationId: string, timeoutMs: number = 15000) {
  return new Promise<LnReceiveState>((resolve, reject) => {
    let unsubscribe: () => void
    const timeoutId = setTimeout(() => {
      reject(new Error('Timeout waiting for receive'))
    }, timeoutMs)

    unsubscribe = this.subscribeLnReceive(
      operationId,
      (res) => {
        if (res === 'claimed') { // Only resolves on 'claimed'
          clearTimeout(timeoutId)
          unsubscribe()
          resolve(res)
        }
      },
      (error) => {
        clearTimeout(timeoutId)
        unsubscribe()
        reject(error)
      },
    )
  })
}

---

Why This Is a Bug

The promise inside waitForReceive only resolves if the state strictly equals 'claimed'.

However, as defined in packages/core/src/types/wallet.ts, the LnReceiveState type union can also emit a { canceled: { reason: string } } object state on failure:

export type LnReceiveState =
  | 'created'
  | { waiting_for_payment: { invoice: string; timeout: number } }
  | { canceled: { reason: string } } // Emitted on failure
  | 'funded'
  | 'awaiting_funds'
  | 'claimed'

When a canceled event is emitted via the subscribe_ln_receive RPC stream, the success callback ignores it completely since it is not 'claimed'. As a result:

1. Poor UX: The promise hangs indefinitely until the timeoutMs threshold (default: 15 seconds) is exceeded.
2. Obscured Diagnostics: Instead of seeing the actual error reason from the gateway driver (e.g. "invoice expired"), the client is presented with a generic "Timeout waiting for receive" error.

---

Expected Behavior

When the subscribeLnReceive stream emits a { canceled: { reason: string } } state, the subscription should unsubscribe immediately and reject the promise with the specific cancellation reason.

[sadeeqrabiu]

Extend the success callback to detect the canceled

  unsubscribe = this.subscribeLnReceive(
    operationId,
    (res) => {
      if (res === 'claimed') {
        clearTimeout(timeoutId)
        unsubscribe()
        resolve(res)
+     } else if (typeof res === 'object' && res !== null && 'canceled' in res) {
+       clearTimeout(timeoutId)
+       unsubscribe()
+       reject(new Error(`Invoice receive canceled: ${res.canceled.reason}`))
      }
    },
    (error) => {
      clearTimeout(timeoutId)
      unsubscribe()
      reject(error)
    },
  )

view #299