@getalby/cli 0.0.0

package/build/tools/nwc/get_budget.js

@@ -0,0 +1,14 @@
+export async function getBudget(client) {
+    const budget = await client.getBudget();
+    if (!("used_budget" in budget)) {
+        return {};
+    }
+    return {
+        used_budget_in_sats: Math.floor(budget.used_budget / 1000),
+        total_budget_in_sats: budget.total_budget
+            ? Math.floor(budget.total_budget / 1000)
+            : undefined,
+        renews_at: budget.renews_at,
+        renewal_period: budget.renewal_period,
+    };
+}

package/build/tools/nwc/get_info.js

@@ -0,0 +1,3 @@
+export async function getInfo(client) {
+    return await client.getInfo();
+}

package/build/tools/nwc/get_wallet_service_info.js

@@ -0,0 +1,3 @@
+export async function getWalletServiceInfo(client) {
+    return await client.getWalletServiceInfo();
+}

package/build/tools/nwc/list_transactions.js

@@ -0,0 +1,18 @@
+export async function listTransactions(client, params) {
+    const result = await client.listTransactions({
+        from: params.from,
+        until: params.until,
+        limit: params.limit,
+        type: params.type,
+        unpaid: params.unpaid,
+        offset: params.offset,
+    });
+    return {
+        ...result,
+        transactions: result.transactions.map(({ amount, fees_paid, ...transaction }) => ({
+            ...transaction,
+            amount_in_sats: Math.floor(amount / 1000),
+            fees_paid_in_sats: typeof fees_paid === "number" ? Math.ceil(fees_paid / 1000) : undefined,
+        })),
+    };
+}

package/build/tools/nwc/lookup_invoice.js

@@ -0,0 +1,11 @@
+export async function lookupInvoice(client, params) {
+    const { amount, fees_paid, ...result } = await client.lookupInvoice({
+        invoice: params.invoice,
+        payment_hash: params.payment_hash,
+    });
+    return {
+        ...result,
+        amount_in_sats: Math.floor(amount / 1000),
+        fees_paid_in_sats: typeof fees_paid === "number" ? Math.ceil(fees_paid / 1000) : undefined,
+    };
+}

package/build/tools/nwc/make_hold_invoice.js

@@ -0,0 +1,12 @@
+export async function makeHoldInvoice(client, params) {
+    const { amount, ...result } = await client.makeHoldInvoice({
+        amount: params.amount_in_sats * 1000,
+        payment_hash: params.payment_hash,
+        description: params.description,
+        expiry: params.expiry,
+    });
+    return {
+        ...result,
+        amount_in_sats: Math.floor(amount / 1000),
+    };
+}

package/build/tools/nwc/make_invoice.js

@@ -0,0 +1,14 @@
+export async function makeInvoice(client, params) {
+    const { amount, fees_paid, ...result } = await client.makeInvoice({
+        amount: params.amount_in_sats * 1000,
+        description: params.description,
+        description_hash: params.description_hash,
+        expiry: params.expiry,
+        metadata: params.metadata,
+    });
+    return {
+        ...result,
+        amount_in_sats: Math.floor(amount / 1000),
+        fees_paid_in_sats: typeof fees_paid === "number" ? Math.ceil(fees_paid / 1000) : undefined,
+    };
+}

package/build/tools/nwc/pay_invoice.js

@@ -0,0 +1,12 @@
+export async function payInvoice(client, params) {
+    const { fees_paid, preimage, ...result } = await client.payInvoice({
+        invoice: params.invoice,
+        amount: params.amount_in_sats ? params.amount_in_sats * 1000 : undefined,
+        metadata: params.metadata,
+    });
+    return {
+        ...result,
+        preimage: preimage || "",
+        fees_paid_in_sats: typeof fees_paid === "number" ? Math.ceil(fees_paid / 1000) : undefined,
+    };
+}

package/build/tools/nwc/pay_keysend.js

@@ -0,0 +1,12 @@
+export async function payKeysend(client, params) {
+    const { fees_paid, ...result } = await client.payKeysend({
+        pubkey: params.pubkey,
+        amount: params.amount_in_sats * 1000,
+        preimage: params.preimage,
+        tlv_records: params.tlv_records,
+    });
+    return {
+        ...result,
+        fees_paid_in_sats: typeof fees_paid === "number" ? Math.ceil(fees_paid / 1000) : undefined,
+    };
+}

package/build/tools/nwc/schemas/transaction.js

@@ -0,0 +1,26 @@
+import { z } from "zod";
+export const transactionSchema = {
+    type: z.enum(["incoming", "outgoing"]).describe("Transaction type"),
+    state: z
+        .enum(["settled", "pending", "failed"])
+        .nullish()
+        .describe("Transaction state"),
+    invoice: z.string().describe("BOLT-11 invoice"),
+    description: z.string().nullish().describe("Invoice description"),
+    description_hash: z.string().nullish().describe("Description hash"),
+    preimage: z.string().nullish().describe("Preimage of settled payment"),
+    payment_hash: z.string().describe("Payment hash"),
+    amount_in_sats: z.number().describe("Amount in sats"),
+    fees_paid_in_sats: z.number().nullish().describe("Fees paid in sats"),
+    settled_at: z.number().nullish().describe("Timestamp, of settled payment"),
+    created_at: z.number().describe("Creation unix timestamp"),
+    expires_at: z.number().nullish().describe("Expiry unix timestamp"), // TODO: remove nullish once Primal supports it
+    settle_deadline: z
+        .number()
+        .nullish()
+        .describe("HOLD invoice settle deadline"),
+    metadata: z
+        .unknown()
+        .nullish()
+        .describe("Additional metadata about the transaction"),
+};

package/build/tools/nwc/settle_hold_invoice.js

@@ -0,0 +1,8 @@
+export async function settleHoldInvoice(client, params) {
+    await client.settleHoldInvoice({
+        preimage: params.preimage,
+    });
+    return {
+        preimage: params.preimage,
+    };
+}

package/build/tools/nwc/sign_message.js

@@ -0,0 +1,6 @@
+export async function signMessage(client, params) {
+    const result = await client.signMessage({
+        message: params.message,
+    });
+    return result;
+}

package/build/tools/nwc/wait_for_payment.js

@@ -0,0 +1,43 @@
+export async function waitForPayment(client, params) {
+    return new Promise((resolve, reject) => {
+        let timeoutId;
+        let unsub;
+        const cleanup = () => {
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+            if (unsub) {
+                unsub();
+            }
+        };
+        if (params.timeout) {
+            timeoutId = setTimeout(() => {
+                cleanup();
+                reject(new Error(`Timeout waiting for payment after ${params.timeout}s`));
+            }, params.timeout * 1000);
+        }
+        const notificationTypes = params.type
+            ? [params.type]
+            : undefined;
+        client
+            .subscribeNotifications((notification) => {
+            const transaction = notification.notification;
+            if (transaction.payment_hash === params.payment_hash) {
+                cleanup();
+                const { amount, fees_paid, type, ...rest } = transaction;
+                resolve({
+                    notification_type: notification.notification_type,
+                    type,
+                    ...rest,
+                    amount_in_sats: Math.floor(amount / 1000),
+                    fees_paid_in_sats: typeof fees_paid === "number"
+                        ? Math.ceil(fees_paid / 1000)
+                        : undefined,
+                });
+            }
+        }, notificationTypes)
+            .then((unsubscribe) => {
+            unsub = unsubscribe;
+        });
+    });
+}

package/build/utils.js

@@ -0,0 +1,23 @@
+import { NWCClient } from "@getalby/sdk";
+export function getClient(program) {
+    const opts = program.opts();
+    const connectionSecret = opts.connectionSecret;
+    if (!connectionSecret) {
+        console.error("Error: --connection-secret is required for this command");
+        process.exit(1);
+    }
+    return new NWCClient({ nostrWalletConnectUrl: connectionSecret });
+}
+export function output(data) {
+    console.log(JSON.stringify(data, null, 2));
+}
+export async function handleError(fn) {
+    try {
+        await fn();
+        process.exit(0);
+    }
+    catch (error) {
+        console.error(JSON.stringify({ error: error instanceof Error ? error.message : String(error) }, null, 2));
+        process.exit(1);
+    }
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@getalby/cli",
+  "description": "CLI for Nostr Wallet Connect (NIP-47) with a few additional useful lightning tools",
+  "repository": "https://github.com/getAlby/cli.git",
+  "version": "0.0.0",
+  "type": "module",
+  "main": "build/index.js",
+  "bin": {
+    "cli": "build/index.js",
+    "alby-cli": "build/index.js"
+  },
+  "files": [
+    "build/**/*"
+  ],
+  "scripts": {
+    "prepack": "yarn build",
+    "build": "tsc && chmod 755 build/index.js",
+    "start": "node build/index.js",
+    "dev": "yarn build && node build/index.js",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "lightning",
+    "nostr",
+    "wallet",
+    "connect",
+    "nwc",
+    "ai",
+    "agent",
+    "cli",
+    "nip47"
+  ],
+  "author": "Alby contributors",
+  "license": "MIT",
+  "dependencies": {
+    "@getalby/lightning-tools": "^6.1.0",
+    "@getalby/sdk": "^7.0.0",
+    "commander": "^13.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.2.0",
+    "@webbtc/webln-types": "^3.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}