payLightningInvoice

interface PayLightningInvoiceParams {
  invoice: string;
  maxFeeSats: number;
  preferSpark?: boolean;
  amountSatsToSend?: number;
  idempotencyKey?: string;
}

async payLightningInvoice(params: PayLightningInvoiceParams): Promise<LightningSendRequest | WalletTransfer>

// Pay a regular invoice via Lightning
const payment_response = await wallet.payLightningInvoice({
  invoice: "lnbc100n...", // Regular Lightning invoice with amount
  maxFeeSats: 5,
});
console.log("Payment Response:", payment_response);

// Pay a zero-amount invoice
const zeroAmountPayment = await wallet.payLightningInvoice({
  invoice: "lnbc...", // Zero-amount Lightning invoice
  maxFeeSats: 5,
  amountSatsToSend: 1000, // Specify amount for zero-amount invoice
});
console.log("Zero-amount Payment Response:", zeroAmountPayment);

// Prefer Spark transfer if invoice has Spark fallback address
const sparkPreferred = await wallet.payLightningInvoice({
  invoice: "lnbc100n...", // Invoice with Spark fallback
  maxFeeSats: 5,
  preferSpark: true, // Will use Spark transfer if available
});
// Returns WalletTransfer if Spark used, LightningSendRequest otherwise

// Use idempotency key to prevent duplicate payments
const idempotentPayment = await wallet.payLightningInvoice({
  invoice: "lnbc100n...",
  maxFeeSats: 5,
  idempotencyKey: "unique-payment-id-123", // Prevents duplicate if retried
});
// Safe to retry with same key - won't create duplicate payment