Class LightningScheme

constructor

• new LightningScheme(signer: ClientLightningSigner): LightningScheme

  Creates a new LightningScheme instance.

  Parameters

  • signer: ClientLightningSigner

    The Lightning signer for client operations

  Returns LightningScheme

Readonlyscheme

createPaymentPayload

• createPaymentPayload(
      t402Version: number,
      paymentRequirements: PaymentRequirements,
  ): Promise<Pick<PaymentPayload, "t402Version" | "payload">>

  Creates a payment payload for the Lightning scheme.

  1. Extracts the BOLT11 invoice from requirements.extra.bolt11Invoice
  2. Pays the invoice using the Lightning signer
  3. Returns the preimage and payment hash as proof of payment

  Parameters

  • t402Version: number

    The t402 protocol version

  • paymentRequirements: PaymentRequirements

    The payment requirements

  Returns Promise<Pick<PaymentPayload, "t402Version" | "payload">>

  Promise resolving to a payment payload