Class LNClient

constructor

• new LNClient(credentials: LNClientCredentials): LNClient

  Create a new LNClient

  Parameters

  • credentials: LNClientCredentials

    credentials to connect to a NWC-based wallet. This can be a NWC connection string e.g. nostr+walletconnect://... or an existing NWC Client. Learn more at https://nwc.dev

  Returns LNClient

ReadonlynwcClient

close

• close(): void

  Returns void

pay

• pay(
      recipient: string,
      amount?: Amount,
      args?: Omit<Nip47PayInvoiceRequest, "invoice" | "amount">,
  ): Promise<{ fees_paid: number; invoice: Invoice; preimage: string }>

  Make a payment

  Parameters

  • recipient: string

    a BOLT-11 invoice or lightning address
  • Optionalamount: Amount

    the amount to pay, only required if paying to a lightning address or the amount is not specified in the BOLT 11 invoice.
  • Optionalargs: Omit<Nip47PayInvoiceRequest, "invoice" | "amount">

    additional options, e.g. to store metadata on the payment

  Returns Promise<{ fees_paid: number; invoice: Invoice; preimage: string }>

  the receipt of the payment, and details of the paid invoice.

requestPayment

• requestPayment(
      amount: Amount,
      args?: Omit<Nip47MakeInvoiceRequest, "amount">,
  ): Promise<ReceiveInvoice>

  Request to receive a payment

  Parameters

  • amount: Amount

    the amount requested, either in sats (e.g. {satoshi: 21}) or fiat (e.g. new FiatAmount(21, "USD")).
  • Optionalargs: Omit<Nip47MakeInvoiceRequest, "amount">

    additional options, e.g. to set a description on the payment request, or store metadata for the received payment

  Returns Promise<ReceiveInvoice>

  the invoice to be paid, along with methods to easily listen for a payment and act upon it.