@getalby/lightning-tools 5.2.1 → 6.1.0

package/README.md

@@ -6,7 +6,11 @@
 
 An npm package that provides useful and common tools and helpers to build lightning web applications.
 
-## 🚀 Quick Start
+## 🤖 🚀 ⚡ 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!
+
+## Manual Installation
 
 ```
 npm install @getalby/lightning-tools
@@ -44,7 +48,7 @@ or for use without any build tools:
 The `LightningAddress` class provides helpers to work with lightning addresses
 
 ```js
-import { LightningAddress } from "@getalby/lightning-tools";
+import { LightningAddress } from "@getalby/lightning-tools/lnurl";
 
 const ln = new LightningAddress("hello@getalby.com");
 
@@ -60,7 +64,7 @@ console.log(ln.keysendData);
 #### Get an invoice:
 
 ```js
-import { LightningAddress } from "@getalby/lightning-tools";
+import { LightningAddress } from "@getalby/lightning-tools/lnurl";
 
 const ln = new LightningAddress("hello@getalby.com");
 
@@ -76,7 +80,7 @@ console.log(invoice.paymentHash); // print the payment hash
 #### Verify a payment
 
 ```js
-import { LightningAddress } from "@getalby/lightning-tools";
+import { LightningAddress } from "@getalby/lightning-tools/lnurl";
 const ln = new LightningAddress("hello@getalby.com");
 await ln.fetch();
 
@@ -96,14 +100,14 @@ if (paid) {
   console.log("paid");
 }
 
-// or use the convenenice method:
+// or use the convenient method:
 await invoice.isPaid();
 ```
 
 It is also possible to manually initialize the `Invoice`
 
 ```js
-const { Invoice } = require("alby-tools");
+import { Invoice } from "@getalby/lightning-tools/bolt11";
 
 const invoice = new Invoice({ pr: pr, preimage: preimage });
 await invoice.isPaid();
@@ -114,7 +118,7 @@ await invoice.isPaid();
 You can also attach additional metadata information like app name, version, name of the podcast which is boosted etc. to the keysend payment.
 
 ```js
-import { LightningAddress } from "@getalby/lightning-tools";
+import { LightningAddress } from "@getalby/lightning-tools/lnurl";
 const ln = new LightningAddress("hello@getalby.com");
 await ln.fetch();
 
@@ -141,7 +145,7 @@ Nostr is a simple, open protocol that enables truly censorship-resistant and glo
 This librarys provides helpers to create [zaps](https://github.com/nostr-protocol/nips/blob/master/57.md).
 
 ```js
-import { LightningAddress } from "@getalby/lightning-tools";
+import { LightningAddress } from "@getalby/lightning-tools/lnurl";
 const ln = new LightningAddress("hello@getalby.com");
 await ln.fetch();
 
@@ -182,7 +186,7 @@ This library includes a `fetchWithL402` function to consume L402 protected resou
 ##### Examples
 
 ```js
-import { fetchWithL402 } from "@getalby/lightning-tools";
+import { fetchWithL402 } from "@getalby/lightning-tools/l402";
 
 // this will fetch the resource and pay the invoice with window.webln.
 // the tokens/preimage data will be stored in the browser's localStorage and used for any following request
@@ -196,11 +200,11 @@ await fetchWithL402(
 ```
 
 ```js
-import { fetchWithL402 } from "@getalby/lightning-tools";
-import { webln } from "@getalby/sdk";
+import { fetchWithL402 } from "@getalby/lightning-tools/l402";
+import { NostrWebLNProvider } from "@getalby/sdk";
 
 // use a NWC WebLN provide to do the payments
-const nwc = new webln.NostrWebLNProvider({
+const nwc = new NostrWebLNProvider({
   nostrWalletConnectUrl: loadNWCUrl(),
 });
 
@@ -215,14 +219,13 @@ await fetchWithL402(
 ```
 
 ```js
-import { l402 } from "@getalby/lightning-tools";
-import { fiat } from "@getalby/lightning-tools";
+import { fetchWithL402, NoStorage } from "@getalby/lightning-tools/l402";
 
 // do not store the tokens
-await l402.fetchWithL402(
+await fetchWithL402(
   "https://lsat-weather-api.getalby.repl.co/kigali",
   {},
-  { store: new l402.storage.NoStorage() },
+  { store: new NoStorage() },
 );
 ```
 
@@ -231,10 +234,9 @@ await l402.fetchWithL402(
 You can initialize an `Invoice` to decode a payment request.
 
 ```js
-const { Invoice } = require("alby-tools");
+import { Invoice } from "@getalby/lightning-tools/bolt11";
 
 const invoice = new Invoice({ pr });
-
 const { paymentHash, satoshi, description, createdDate, expiryDate } = invoice;
 ```
 
@@ -244,6 +246,10 @@ const { paymentHash, satoshi, description, createdDate, expiryDate } = invoice;
 
 Helpers to convert sats values to fiat and fiat values to sats.
 
+##### getFiatCurrencies(): Promise<FiatCurrency[]>
+
+Returns the list of available fiat currencies sorted by priority
+
 ##### getFiatValue(satoshi: number, currency: string): number
 
 Returns the fiat value for a specified currency of a satoshi amount
@@ -259,6 +265,7 @@ Like `getFiatValue` but returns a formatted string for a given locale using Java
 #### Examples
 
 ```js
+await fiat.getFiatCurrencies();
 await fiat.getFiatValue({ satoshi: 2100, currency: "eur" });
 await fiat.getSatoshiValue({ amount: 100, currency: "eur" }); // for 1 EUR
 await fiat.getFormattedFiatValue({