Merge pull request #160 from getAlby/feat/nwc-get-info

feat: add NWC getInfo method

Author: rolznz

examples/nwc/get-info.js

@@ -0,0 +1,25 @@
+import * as crypto from "node:crypto"; // required in node.js
+global.crypto = crypto; // required in node.js
+import "websocket-polyfill"; // required in node.js
+
+import * as readline from "node:readline/promises";
+import { stdin as input, stdout as output } from "node:process";
+
+import { webln as providers } from "../../dist/index.module.js";
+
+const rl = readline.createInterface({ input, output });
+
+const nwcUrl =
+  process.env.NWC_URL ||
+  (await rl.question("Nostr Wallet Connect URL (nostr+walletconnect://...): "));
+rl.close();
+
+const webln = new providers.NostrWebLNProvider({
+  nostrWalletConnectUrl: nwcUrl,
+});
+await webln.enable();
+const response = await webln.getInfo();
+
+console.info(response);
+
+webln.close();

src/webln/NostrWeblnProvider.ts

@@ -48,7 +48,18 @@ type Nip07Provider = {
   signEvent(event: UnsignedEvent): Promise<Event>;
 };
 
+type Nip47GetInfoResponse = {
+  alias: string;
+  color: string;
+  pubkey: string;
+  network: string;
+  block_height: number;
+  block_hash: string;
+  methods: string[];
+};
+
 const nip47ToWeblnRequestMap = {
+  get_info: "getInfo",
   get_balance: "getBalance",
   make_invoice: "makeInvoice",
   pay_invoice: "sendPayment",
@@ -215,18 +226,41 @@ export class NostrWebLNProvider implements WebLNProvider, Nip07Provider {
   // WebLN compatible response
   // TODO: use NIP-47 get_info call
   async getInfo(): Promise<GetInfoResponse> {
-    return {
-      methods: [
-        "getInfo",
-        "sendPayment",
-        "makeInvoice",
-        "getBalance",
-        "lookupInvoice",
-      ],
-      node: {} as WebLNNode,
-      supports: ["lightning"],
-      version: "NWC",
-    };
+    this.checkConnected();
+
+    const supports = ["lightning", "nostr"];
+    const version = "Alby JS SDK";
+
+    try {
+      return this.executeNip47Request<GetInfoResponse, Nip47GetInfoResponse>(
+        "get_info",
+        undefined,
+        (result) => !!result.methods,
+        (result) => ({
+          methods: result.methods.map(
+            (key) =>
+              nip47ToWeblnRequestMap[
+                key as keyof typeof nip47ToWeblnRequestMap
+              ],
+          ),
+          node: {
+            alias: result.alias,
+            pubkey: result.pubkey,
+            color: result.color,
+          } as WebLNNode,
+          supports,
+          version,
+        }),
+      );
+    } catch (error) {
+      console.error("Failed to request get_info", error);
+      return {
+        methods: ["sendPayment"],
+        node: {} as WebLNNode,
+        supports,
+        version,
+      };
+    }
   }
 
   getBalance() {