@getalby/lightning-tools 6.1.0 → 7.0.2

package/README.md

@@ -6,6 +6,8 @@
 
 An npm package that provides useful and common tools and helpers to build lightning web applications.
 
+Before you start coding, look at example scenarios in our **[Developer Sandbox](https://sandbox.albylabs.com/)**
+
 ## 🤖 🚀 ⚡ For Developers using Agents / LLMs / Vibe Coding
 
 Skip the rest of this README and use the [Alby Bitcoin Payments Agent Skill](https://github.com/getAlby/alby-agent-skill) instead. It will handle the rest!
@@ -179,7 +181,7 @@ This library includes a `fetchWithL402` function to consume L402 protected resou
 - url: the L402 protected URL
 - fetchArgs: arguments are passed to the underlying `fetch()` function used to do the HTTP request
 - options:
-  - webln: the webln object used to call `sendPayment()` defaults to globalThis.webln
+  - wallet: any object that implements `sendPayment(paymentRequest)` and returns `{ preimage }`. Used to pay the L402 invoice.
   - store: a key/value store object to persiste the l402 for each URL. The store must implement a `getItem()`/`setItem()` function as the browser's localStorage. By default a memory storage is used.
   - headerKey: defaults to L402 but if you need to consume an old LSAT API set this to LSAT
 
@@ -188,12 +190,12 @@ This library includes a `fetchWithL402` function to consume L402 protected resou
 ```js
 import { fetchWithL402 } from "@getalby/lightning-tools/l402";
 
-// this will fetch the resource and pay the invoice with window.webln.
+// pass a wallet that implements sendPayment()
 // the tokens/preimage data will be stored in the browser's localStorage and used for any following request
 await fetchWithL402(
   "https://lsat-weather-api.getalby.repl.co/kigali",
   {},
-  { store: window.localStorage },
+  { wallet: myWallet, store: window.localStorage },
 )
   .then((res) => res.json())
   .then(console.log);
@@ -203,16 +205,16 @@ await fetchWithL402(
 import { fetchWithL402 } from "@getalby/lightning-tools/l402";
 import { NostrWebLNProvider } from "@getalby/sdk";
 
-// use a NWC WebLN provide to do the payments
+// use a NWC provider as the wallet to do the payments
 const nwc = new NostrWebLNProvider({
   nostrWalletConnectUrl: loadNWCUrl(),
 });
 
-// this will fetch the resource and pay the invoice with a NWC webln object
+// this will fetch the resource and pay the invoice using the NWC wallet
 await fetchWithL402(
   "https://lsat-weather-api.getalby.repl.co/kigali",
   {},
-  { webln: nwc },
+  { wallet: nwc },
 )
   .then((res) => res.json())
   .then(console.log);

package/dist/cjs/index.cjs

@@ -1693,17 +1693,21 @@ const parseL402 = (input) => {
     }
     return keyValuePairs;
 };
+const makeAuthenticateHeader = (args) => {
+    const key = args.key || "L402";
+    return `${key} macaroon="${args.macaroon}", invoice="${args.invoice}"`;
+};
 
 const memoryStorage = new MemoryStorage();
-const HEADER_KEY = "L402"; // we have to update this to L402 at some point
+const HEADER_KEY = "L402";
 const fetchWithL402 = async (url, fetchArgs, options) => {
     if (!options) {
         options = {};
     }
     const headerKey = options.headerKey || HEADER_KEY;
-    const webln = options.webln || globalThis.webln;
-    if (!webln) {
-        throw new Error("WebLN is missing");
+    const wallet = options.wallet;
+    if (!wallet) {
+        throw new Error("wallet is missing");
     }
     const store = options.store || memoryStorage;
     if (!fetchArgs) {
@@ -1730,8 +1734,7 @@ const fetchWithL402 = async (url, fetchArgs, options) => {
     const details = parseL402(header);
     const token = details.token || details.macaroon;
     const inv = details.invoice;
-    await webln.enable();
-    const invResp = await webln.sendPayment(inv);
+    const invResp = await wallet.sendPayment(inv);
     store.setItem(url, JSON.stringify({
         token: token,
         preimage: invResp.preimage,
@@ -1808,6 +1811,7 @@ exports.getFormattedFiatValue = getFormattedFiatValue;
 exports.getSatoshiValue = getSatoshiValue;
 exports.isUrl = isUrl;
 exports.isValidAmount = isValidAmount;
+exports.makeAuthenticateHeader = makeAuthenticateHeader;
 exports.parseKeysendResponse = parseKeysendResponse;
 exports.parseL402 = parseL402;
 exports.parseLnUrlPayResponse = parseLnUrlPayResponse;