@arkade-os/skill 0.1.0

package/dist/cjs/skills/lightning.js

@@ -0,0 +1,287 @@
+"use strict";
+/**
+ * ArkaLightningSkill - Lightning Network payments via Boltz submarine swaps.
+ *
+ * This skill provides Lightning Network capabilities for Arkade wallets
+ * designed for agent integration (CLI-friendly for agents like MoltBot).
+ *
+ * @module skills/lightning
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArkaLightningSkill = void 0;
+exports.createLightningSkill = createLightningSkill;
+const boltz_swap_1 = require("@arkade-os/boltz-swap");
+/**
+ * Default Boltz API URLs by network.
+ */
+const BOLTZ_API_URLS = {
+    bitcoin: "https://api.boltz.exchange",
+    mainnet: "https://api.boltz.exchange",
+    testnet: "https://testnet.boltz.exchange/api",
+    signet: "https://testnet.boltz.exchange/api",
+    regtest: "http://localhost:9001",
+    mutinynet: "https://mutinynet.boltz.exchange/api",
+};
+/**
+ * ArkaLightningSkill provides Lightning Network payment capabilities
+ * for Arkade wallets using Boltz submarine swaps.
+ *
+ * This skill enables:
+ * - Receiving Lightning payments into your Arkade wallet (reverse swaps)
+ * - Sending Lightning payments from your Arkade wallet (submarine swaps)
+ *
+ * @example
+ * ```typescript
+ * import { Wallet, SingleKey } from "@arkade-os/sdk";
+ * import { ArkaLightningSkill } from "@arkade-os/skill";
+ *
+ * // Create a wallet
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex(privateKeyHex),
+ *   arkServerUrl: "https://arkade.computer",
+ * });
+ *
+ * // Create the Lightning skill
+ * const lightning = new ArkaLightningSkill({
+ *   wallet,
+ *   network: "bitcoin",
+ * });
+ *
+ * // Create an invoice to receive Lightning payment
+ * const invoice = await lightning.createInvoice({
+ *   amount: 50000, // 50,000 sats
+ *   description: "Payment for coffee",
+ * });
+ * console.log("Pay this invoice:", invoice.bolt11);
+ *
+ * // Pay a Lightning invoice
+ * const result = await lightning.payInvoice({
+ *   bolt11: "lnbc...",
+ * });
+ * console.log("Paid! Preimage:", result.preimage);
+ * ```
+ */
+class ArkaLightningSkill {
+    /**
+     * Creates a new ArkaLightningSkill instance.
+     *
+     * @param config - Configuration options
+     */
+    constructor(config) {
+        this.name = "arka-lightning";
+        this.description = "Lightning Network payments via Boltz submarine swaps for Arkade wallets";
+        this.version = "1.0.0";
+        this.network = config.network;
+        const boltzApiUrl = config.boltzApiUrl ||
+            BOLTZ_API_URLS[config.network] ||
+            BOLTZ_API_URLS.bitcoin;
+        this.swapProvider = new boltz_swap_1.BoltzSwapProvider({
+            apiUrl: boltzApiUrl,
+            network: config.network,
+            referralId: config.referralId,
+        });
+        // Cast wallet to any since boltz-swap expects Wallet from @arkade-os/sdk
+        // but we have the local Wallet type - they are structurally identical
+        this.arkadeLightning = new boltz_swap_1.ArkadeLightning({
+            wallet: config.wallet,
+            swapProvider: this.swapProvider,
+            arkProvider: config.arkProvider,
+            indexerProvider: config.indexerProvider,
+            swapManager: config.enableSwapManager
+                ? { enableAutoActions: true, autoStart: true }
+                : undefined,
+        });
+    }
+    /**
+     * Check if the Lightning skill is available.
+     *
+     * @returns true if the skill is properly configured
+     */
+    async isAvailable() {
+        try {
+            await this.swapProvider.getFees();
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Create a Lightning invoice for receiving payment.
+     *
+     * This creates a Boltz reverse swap, which locks funds on Boltz's side
+     * when someone pays the invoice. The funds are then claimed into your
+     * Arkade wallet as VTXOs.
+     *
+     * @param params - Invoice parameters
+     * @returns The created invoice with payment details
+     */
+    async createInvoice(params) {
+        const response = await this.arkadeLightning.createLightningInvoice({
+            amount: params.amount,
+            description: params.description,
+        });
+        // Extract expiry from invoice
+        const decoded = (0, boltz_swap_1.decodeInvoice)(response.invoice);
+        return {
+            bolt11: response.invoice,
+            paymentHash: response.paymentHash,
+            amount: response.amount,
+            description: params.description,
+            expirySeconds: decoded.expiry,
+            createdAt: new Date(),
+            preimage: response.preimage,
+        };
+    }
+    /**
+     * Pay a Lightning invoice.
+     *
+     * This creates a Boltz submarine swap, which sends funds from your
+     * Arkade wallet to a swap address. Boltz then pays the Lightning invoice
+     * and you receive the preimage as proof of payment.
+     *
+     * @param params - Payment parameters
+     * @returns Result containing the preimage and transaction details
+     */
+    async payInvoice(params) {
+        const response = await this.arkadeLightning.sendLightningPayment({
+            invoice: params.bolt11,
+        });
+        return {
+            preimage: response.preimage,
+            amount: response.amount,
+            txid: response.txid,
+        };
+    }
+    /**
+     * Get fee information for Lightning swaps.
+     *
+     * @returns Fee structure for submarine and reverse swaps
+     */
+    async getFees() {
+        return this.arkadeLightning.getFees();
+    }
+    /**
+     * Get limits for Lightning swaps.
+     *
+     * @returns Min and max amounts for swaps
+     */
+    async getLimits() {
+        return this.arkadeLightning.getLimits();
+    }
+    /**
+     * Get pending swaps.
+     *
+     * @returns Array of pending swap information
+     */
+    async getPendingSwaps() {
+        const [reverseSwaps, submarineSwaps] = await Promise.all([
+            this.arkadeLightning.getPendingReverseSwaps(),
+            this.arkadeLightning.getPendingSubmarineSwaps(),
+        ]);
+        return [
+            ...reverseSwaps.map((swap) => this.mapReverseSwap(swap)),
+            ...submarineSwaps.map((swap) => this.mapSubmarineSwap(swap)),
+        ];
+    }
+    /**
+     * Get swap history.
+     *
+     * @returns Array of all swaps (pending and completed)
+     */
+    async getSwapHistory() {
+        const history = await this.arkadeLightning.getSwapHistory();
+        return history.map((swap) => swap.type === "reverse"
+            ? this.mapReverseSwap(swap)
+            : this.mapSubmarineSwap(swap));
+    }
+    /**
+     * Wait for an invoice to be paid and claim the funds.
+     *
+     * @param pendingSwap - The pending reverse swap from createInvoice
+     * @returns Transaction ID of the claimed funds
+     */
+    async waitAndClaim(pendingSwap) {
+        return this.arkadeLightning.waitAndClaim(pendingSwap);
+    }
+    /**
+     * Get the underlying ArkadeLightning instance for advanced operations.
+     *
+     * @returns The ArkadeLightning instance
+     */
+    getArkadeLightning() {
+        return this.arkadeLightning;
+    }
+    /**
+     * Get the swap provider for direct Boltz API access.
+     *
+     * @returns The BoltzSwapProvider instance
+     */
+    getSwapProvider() {
+        return this.swapProvider;
+    }
+    /**
+     * Start the background swap manager if enabled.
+     */
+    async startSwapManager() {
+        await this.arkadeLightning.startSwapManager();
+    }
+    /**
+     * Stop the background swap manager.
+     */
+    async stopSwapManager() {
+        await this.arkadeLightning.stopSwapManager();
+    }
+    /**
+     * Dispose of resources and stop the swap manager.
+     */
+    async dispose() {
+        await this.arkadeLightning.dispose();
+    }
+    mapReverseSwap(swap) {
+        return {
+            id: swap.id,
+            type: "reverse",
+            status: swap.status,
+            amount: swap.response.onchainAmount,
+            createdAt: new Date(swap.createdAt),
+            invoice: swap.response.invoice,
+        };
+    }
+    mapSubmarineSwap(swap) {
+        // Decode invoice to get amount
+        let amount = 0;
+        try {
+            const decoded = (0, boltz_swap_1.decodeInvoice)(swap.request.invoice);
+            amount = decoded.amountSats;
+        }
+        catch {
+            amount = swap.response.expectedAmount;
+        }
+        return {
+            id: swap.id,
+            type: "submarine",
+            status: swap.status,
+            amount,
+            createdAt: new Date(swap.createdAt),
+            invoice: swap.request.invoice,
+        };
+    }
+}
+exports.ArkaLightningSkill = ArkaLightningSkill;
+/**
+ * Create an ArkaLightningSkill from a wallet and network.
+ *
+ * @param wallet - The Arkade wallet to use
+ * @param network - The network name
+ * @param options - Optional configuration
+ * @returns A new ArkaLightningSkill instance
+ */
+function createLightningSkill(wallet, network, options) {
+    return new ArkaLightningSkill({
+        wallet,
+        network,
+        ...options,
+    });
+}
+//# sourceMappingURL=lightning.js.map

package/dist/cjs/skills/lightning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lightning.js","sourceRoot":"","sources":["../../../src/skills/lightning.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAsVH,oDAUC;AA9VD,sDAM+B;AAe/B;;GAEG;AACH,MAAM,cAAc,GAA2B;IAC7C,OAAO,EAAE,4BAA4B;IACrC,OAAO,EAAE,4BAA4B;IACrC,OAAO,EAAE,oCAAoC;IAC7C,MAAM,EAAE,oCAAoC;IAC5C,OAAO,EAAE,uBAAuB;IAChC,SAAS,EAAE,sCAAsC;CAClD,CAAC;AAsBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAa,kBAAkB;IAU7B;;;;OAIG;IACH,YAAY,MAAgC;QAdnC,SAAI,GAAG,gBAAgB,CAAC;QACxB,gBAAW,GAClB,yEAAyE,CAAC;QACnE,YAAO,GAAG,OAAO,CAAC;QAYzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAE9B,MAAM,WAAW,GACf,MAAM,CAAC,WAAW;YAClB,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC;YAC9B,cAAc,CAAC,OAAO,CAAC;QAEzB,IAAI,CAAC,YAAY,GAAG,IAAI,8BAAiB,CAAC;YACxC,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC,CAAC;QAEH,yEAAyE;QACzE,sEAAsE;QACtE,IAAI,CAAC,eAAe,GAAG,IAAI,4BAAe,CAAC;YACzC,MAAM,EAAE,MAAM,CAAC,MAAa;YAC5B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,WAAW,EAAE,MAAM,CAAC,iBAAiB;gBACnC,CAAC,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;gBAC9C,CAAC,CAAC,SAAS;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC;YACjE,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAC,CAAC;QAEH,8BAA8B;QAC9B,MAAM,OAAO,GAAG,IAAA,0BAAa,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEhD,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,OAAO;YACxB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,aAAa,EAAE,OAAO,CAAC,MAAM;YAC7B,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;SAC5B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC;YAC/D,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB,CAAC,CAAC;QAEH,OAAO;YACL,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,CAAC,YAAY,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACvD,IAAI,CAAC,eAAe,CAAC,sBAAsB,EAAE;YAC7C,IAAI,CAAC,eAAe,CAAC,wBAAwB,EAAE;SAChD,CAAC,CAAC;QAEH,OAAO;YACL,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACxD,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;SAC7D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,CAAC;QAC5D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1B,IAAI,CAAC,IAAI,KAAK,SAAS;YACrB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAA0B,CAAC;YACjD,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAA4B,CAAC,CACxD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAChB,WAA+B;QAE/B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB;QACpB,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEO,cAAc,CAAC,IAAwB;QAC7C,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,IAAI,CAAC,MAAoB;YACjC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;YACnC,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;SAC/B,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,IAA0B;QACjD,+BAA+B;QAC/B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAA,0BAAa,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;QACxC,CAAC;QAED,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,IAAI,CAAC,MAAoB;YACjC,MAAM;YACN,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SAC9B,CAAC;IACJ,CAAC;CACF;AA9OD,gDA8OC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,MAAc,EACd,OAAoB,EACpB,OAAuE;IAEvE,OAAO,IAAI,kBAAkB,CAAC;QAC5B,MAAM;QACN,OAAO;QACP,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/skills/types.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Type definitions for Arkade SDK skills.
+ *
+ * These types define the interfaces for Bitcoin and Lightning skills
+ * designed for agent integration.
+ *
+ * @module skills/types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/skills/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/skills/types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG"}

package/dist/esm/index.js

@@ -0,0 +1,72 @@
+/**
+ * @arkade-os/skill - Arkade SDK Skills for Agent Integration
+ *
+ * This package provides skills for sending and receiving Bitcoin over
+ * Arkade and Lightning, designed for agent integration (CLI-friendly
+ * for agents like MoltBot).
+ *
+ * ## Available Skills
+ *
+ * - **ArkadeBitcoinSkill**: Send/receive Bitcoin via Arkade with on/off ramp support
+ * - **ArkaLightningSkill**: Lightning Network payments via Boltz submarine swaps
+ * - **LendaSwapSkill**: USDC/USDT stablecoin swaps via LendaSwap
+ *
+ * ## Quick Start
+ *
+ * ```typescript
+ * import { Wallet, SingleKey } from "@arkade-os/sdk";
+ * import {
+ *   ArkadeBitcoinSkill,
+ *   ArkaLightningSkill,
+ *   LendaSwapSkill,
+ * } from "@arkade-os/skill";
+ *
+ * // Create a wallet (default server: arkade.computer)
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex(privateKeyHex),
+ *   arkServerUrl: "https://arkade.computer",
+ * });
+ *
+ * // Bitcoin operations
+ * const bitcoin = new ArkadeBitcoinSkill(wallet);
+ * const balance = await bitcoin.getBalance();
+ *
+ * // Lightning operations
+ * const lightning = new ArkaLightningSkill({ wallet, network: "bitcoin" });
+ * const invoice = await lightning.createInvoice({ amount: 50000 });
+ *
+ * // Stablecoin swaps
+ * const lendaswap = new LendaSwapSkill({ wallet, apiKey: "..." });
+ * const quote = await lendaswap.getQuoteBtcToStablecoin(100000, "usdc_pol");
+ * ```
+ *
+ * ## CLI Usage
+ *
+ * ```bash
+ * # Initialize wallet (default server: arkade.computer)
+ * arkade init <private-key-hex>
+ *
+ * # Show addresses
+ * arkade address
+ * arkade boarding-address
+ *
+ * # Check balance
+ * arkade balance
+ *
+ * # Send Bitcoin
+ * arkade send <ark-address> <amount-sats>
+ *
+ * # Lightning
+ * arkade ln-invoice <amount> [description]
+ * arkade ln-pay <bolt11>
+ *
+ * # Stablecoins
+ * arkade swap-quote <amount> <from> <to>
+ * arkade swap-pairs
+ * ```
+ *
+ * @packageDocumentation
+ */
+// Re-export all skills and types
+export * from "./skills";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,iCAAiC;AACjC,cAAc,UAAU,CAAC"}