@arkade-os/skill 0.1.0

package/dist/esm/skills/lightning.js

@@ -0,0 +1,282 @@
+/**
+ * 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
+ */
+import { ArkadeLightning, BoltzSwapProvider, decodeInvoice, } from "@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);
+ * ```
+ */
+export 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 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 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 = 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 = 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,
+        };
+    }
+}
+/**
+ * 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
+ */
+export function createLightningSkill(wallet, network, options) {
+    return new ArkaLightningSkill({
+        wallet,
+        network,
+        ...options,
+    });
+}
+//# sourceMappingURL=lightning.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lightning.js","sourceRoot":"","sources":["../../../src/skills/lightning.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,aAAa,GAGd,MAAM,uBAAuB,CAAC;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,MAAM,OAAO,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,iBAAiB,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,eAAe,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,aAAa,CAAC,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,aAAa,CAAC,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;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,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/esm/skills/types.js

@@ -0,0 +1,10 @@
+/**
+ * Type definitions for Arkade SDK skills.
+ *
+ * These types define the interfaces for Bitcoin and Lightning skills
+ * designed for agent integration.
+ *
+ * @module skills/types
+ */
+export {};
+//# sourceMappingURL=types.js.map

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

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

package/dist/types/index.d.ts

@@ -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
+ */
+export * from "./skills";
+export type { Wallet, ArkTransaction, WalletBalance, ExtendedCoin, ExtendedVirtualCoin, FeeInfo, SettlementEvent, NetworkName, } from "@arkade-os/sdk";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAGH,cAAc,UAAU,CAAC;AAGzB,YAAY,EACV,MAAM,EACN,cAAc,EACd,aAAa,EACb,YAAY,EACZ,mBAAmB,EACnB,OAAO,EACP,eAAe,EACf,WAAW,GACZ,MAAM,gBAAgB,CAAC"}

package/dist/types/skills/arkadeBitcoin.d.ts

@@ -0,0 +1,218 @@
+/**
+ * ArkadeBitcoinSkill - Send and receive Bitcoin over Arkade protocol.
+ *
+ * This skill provides a unified interface for Bitcoin operations
+ * designed for agent integration (CLI-friendly for agents like MoltBot).
+ *
+ * @module skills/arkadeBitcoin
+ */
+import { Wallet, ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "@arkade-os/sdk";
+import type { BitcoinSkill, RampSkill, BitcoinAddress, SendParams, SendResult, BalanceInfo, IncomingFundsEvent, OnboardParams, OffboardParams, RampResult } from "./types";
+/**
+ * ArkadeBitcoinSkill provides a unified interface for sending and receiving
+ * Bitcoin over the Arkade protocol.
+ *
+ * This skill wraps the core wallet functionality and provides:
+ * - Offchain Bitcoin transactions via Ark
+ * - Get paid onchain via boarding address + onboard
+ * - Pay onchain via offboard to any Bitcoin address
+ * - Balance management
+ * - Transaction history
+ *
+ * @example
+ * ```typescript
+ * import { Wallet, SingleKey } from "@arkade-os/sdk";
+ * import { ArkadeBitcoinSkill } from "@arkade-os/skill";
+ *
+ * // Create a wallet
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex(privateKeyHex),
+ *   arkServerUrl: "https://arkade.computer",
+ * });
+ *
+ * // Create the skill
+ * const bitcoinSkill = new ArkadeBitcoinSkill(wallet);
+ *
+ * // Get addresses for receiving
+ * const addresses = await bitcoinSkill.getReceiveAddresses();
+ * console.log("Ark Address:", addresses[0].address);
+ *
+ * // Check balance
+ * const balance = await bitcoinSkill.getBalance();
+ * console.log("Available:", balance.offchain.available, "sats");
+ *
+ * // Send Bitcoin offchain
+ * const result = await bitcoinSkill.send({
+ *   address: recipientArkAddress,
+ *   amount: 10000, // 10,000 sats
+ * });
+ * console.log("Sent! Txid:", result.txid);
+ * ```
+ */
+export declare class ArkadeBitcoinSkill implements BitcoinSkill, RampSkill {
+    private readonly wallet;
+    readonly name = "arkade-bitcoin";
+    readonly description = "Send and receive Bitcoin over Arkade offchain, get paid onchain (onboard), pay onchain (offboard)";
+    readonly version = "1.0.0";
+    private readonly ramps;
+    /**
+     * Creates a new ArkadeBitcoinSkill instance.
+     *
+     * @param wallet - The Arkade wallet to use for operations.
+     *                 Must be a full wallet (not readonly) for send/settle operations.
+     */
+    constructor(wallet: Wallet);
+    /**
+     * Get all available addresses for receiving Bitcoin.
+     *
+     * Returns both the Ark address (for offchain receipts) and the
+     * boarding address (for onchain deposits that can be onboarded).
+     *
+     * @returns Array of addresses with their types and descriptions
+     */
+    getReceiveAddresses(): Promise<BitcoinAddress[]>;
+    /**
+     * Get the Ark address for receiving offchain Bitcoin.
+     *
+     * This is the primary address for receiving Bitcoin via Arkade.
+     * Funds sent to this address are immediately available offchain.
+     *
+     * @returns The bech32m-encoded Ark address
+     */
+    getArkAddress(): Promise<string>;
+    /**
+     * Get the boarding address for receiving onchain Bitcoin.
+     *
+     * Funds sent to this address appear as boarding UTXOs and must be
+     * onboarded to become offchain VTXOs before they can be spent.
+     *
+     * @returns The Bitcoin boarding address
+     */
+    getBoardingAddress(): Promise<string>;
+    /**
+     * Get the current balance with detailed breakdown.
+     *
+     * @returns Balance information including offchain and onchain amounts
+     */
+    getBalance(): Promise<BalanceInfo>;
+    /**
+     * Send Bitcoin to an address.
+     *
+     * For Ark addresses, this creates an offchain transaction that is
+     * instantly confirmed. The recipient must also be using an Ark-compatible
+     * wallet connected to the same Ark server.
+     *
+     * @param params - Send parameters including address and amount
+     * @returns Result containing the transaction ID and details
+     * @throws Error if the address is invalid or insufficient balance
+     */
+    send(params: SendParams): Promise<SendResult>;
+    /**
+     * Get the transaction history.
+     *
+     * @returns Array of transactions with type, amount, and status
+     */
+    getTransactionHistory(): Promise<ArkTransaction[]>;
+    /**
+     * Wait for incoming funds.
+     *
+     * This method blocks until either:
+     * - New VTXOs are received (offchain)
+     * - New UTXOs are received at the boarding address (onchain)
+     * - The timeout expires
+     *
+     * @param timeoutMs - Optional timeout in milliseconds (default: no timeout)
+     * @returns Information about the received funds
+     * @throws Error if timeout expires without receiving funds
+     */
+    waitForIncomingFunds(timeoutMs?: number): Promise<IncomingFundsEvent>;
+    /**
+     * Get paid onchain: Convert received onchain BTC to offchain.
+     *
+     * Use this after receiving onchain Bitcoin to your boarding address.
+     * This converts boarding UTXOs into VTXOs through a cooperative
+     * settlement with the Ark server. After onboarding, funds are
+     * available for instant offchain transactions.
+     *
+     * Flow: Someone pays you onchain → funds arrive at boarding address → onboard → funds available offchain
+     *
+     * @param params - Onboard parameters
+     * @returns Result containing the commitment transaction ID
+     * @throws Error if no boarding UTXOs are available or fees exceed value
+     *
+     * @example
+     * ```typescript
+     * // Step 1: Give your boarding address to receive onchain payment
+     * const boardingAddress = await bitcoinSkill.getBoardingAddress();
+     *
+     * // Step 2: After receiving payment, onboard the funds
+     * const arkInfo = await arkProvider.getInfo();
+     * const result = await bitcoinSkill.onboard({
+     *   feeInfo: arkInfo.feeInfo,
+     *   eventCallback: (event) => console.log("Settlement event:", event.type),
+     * });
+     * console.log("Onboarded! Commitment:", result.commitmentTxid);
+     * ```
+     */
+    onboard(params: OnboardParams): Promise<RampResult>;
+    /**
+     * Pay onchain: Send offchain BTC to any onchain Bitcoin address.
+     *
+     * Use this to pay someone who needs onchain Bitcoin. This performs a
+     * collaborative exit, converting your VTXOs back to regular onchain
+     * Bitcoin UTXOs at the recipient's destination address.
+     *
+     * Flow: You have offchain funds → offboard to recipient's onchain address → they receive onchain BTC
+     *
+     * @param params - Offboard parameters including destination address
+     * @returns Result containing the commitment transaction ID
+     * @throws Error if no VTXOs are available or fees exceed value
+     *
+     * @example
+     * ```typescript
+     * // Pay someone at an onchain Bitcoin address
+     * const arkInfo = await arkProvider.getInfo();
+     * const result = await bitcoinSkill.offboard({
+     *   destinationAddress: "bc1q...", // recipient's onchain address
+     *   feeInfo: arkInfo.feeInfo,
+     *   eventCallback: (event) => console.log("Settlement event:", event.type),
+     * });
+     * console.log("Paid onchain! Commitment:", result.commitmentTxid);
+     * ```
+     */
+    offboard(params: OffboardParams): Promise<RampResult>;
+    /**
+     * Get the underlying wallet instance.
+     *
+     * Use this for advanced operations not covered by the skill interface.
+     *
+     * @returns The wallet instance
+     */
+    getWallet(): Wallet;
+    /**
+     * Get detailed information about available VTXOs.
+     *
+     * @param filter - Optional filter for VTXO types to include
+     * @returns Array of extended virtual coins with full details
+     */
+    getVtxos(filter?: {
+        withRecoverable?: boolean;
+        withUnrolled?: boolean;
+    }): Promise<ExtendedVirtualCoin[]>;
+    /**
+     * Get detailed information about boarding UTXOs.
+     *
+     * @returns Array of extended coins with full details
+     */
+    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+}
+/**
+ * Create an ArkadeBitcoinSkill from a wallet.
+ *
+ * This is a convenience function for creating the skill.
+ *
+ * @param wallet - The Arkade wallet to use
+ * @returns A new ArkadeBitcoinSkill instance
+ */
+export declare function createArkadeBitcoinSkill(wallet: Wallet): ArkadeBitcoinSkill;
+//# sourceMappingURL=arkadeBitcoin.d.ts.map

package/dist/types/skills/arkadeBitcoin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkadeBitcoin.d.ts","sourceRoot":"","sources":["../../../src/skills/arkadeBitcoin.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,MAAM,EAEN,cAAc,EACd,YAAY,EACZ,mBAAmB,EAEpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,cAAc,EACd,UAAU,EACV,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,UAAU,EACX,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,kBAAmB,YAAW,YAAY,EAAE,SAAS;IAcpD,OAAO,CAAC,QAAQ,CAAC,MAAM;IAbnC,QAAQ,CAAC,IAAI,oBAAoB;IACjC,QAAQ,CAAC,WAAW,uGACkF;IACtG,QAAQ,CAAC,OAAO,WAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAE9B;;;;;OAKG;gBAC0B,MAAM,EAAE,MAAM;IAI3C;;;;;;;OAOG;IACG,mBAAmB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAqBtD;;;;;;;OAOG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;;;;;OAOG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IAmBxC;;;;;;;;;;OAUG;IACG,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAenD;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAIxD;;;;;;;;;;;OAWG;IACG,oBAAoB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAkE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IAsBzD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAsB3D;;;;;;OAMG;IACH,SAAS,IAAI,MAAM;IAInB;;;;;OAKG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE;QACtB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIlC;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;CAGlD;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAE3E"}

package/dist/types/skills/index.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Skills module for the Arkade SDK.
+ *
+ * Skills are modular capabilities that provide specific functionality for agents
+ * and applications. This module provides skills for:
+ *
+ * - **ArkadeBitcoinSkill**: Send and receive Bitcoin over Arkade
+ * - **ArkaLightningSkill**: Lightning Network payments via Boltz swaps
+ * - **LendaSwapSkill**: USDC/USDT stablecoin swaps via LendaSwap
+ *
+ * @example
+ * ```typescript
+ * import { Wallet, SingleKey } from "@arkade-os/sdk";
+ * import {
+ *   ArkadeBitcoinSkill,
+ *   ArkaLightningSkill,
+ *   LendaSwapSkill,
+ * } from "@arkade-os/skill";
+ *
+ * // Create a wallet
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex(privateKeyHex),
+ *   arkServerUrl: "https://arkade.computer",
+ * });
+ *
+ * // === Bitcoin Skill ===
+ * const bitcoin = new ArkadeBitcoinSkill(wallet);
+ *
+ * // Get addresses for receiving
+ * const arkAddress = await bitcoin.getArkAddress();
+ * console.log("Ark address:", arkAddress);
+ *
+ * // Check balance
+ * const balance = await bitcoin.getBalance();
+ * console.log("Balance:", balance.total, "sats");
+ *
+ * // === Lightning Skill ===
+ * const lightning = new ArkaLightningSkill({
+ *   wallet,
+ *   network: "bitcoin",
+ * });
+ *
+ * // Create invoice to receive Lightning payment
+ * const invoice = await lightning.createInvoice({
+ *   amount: 25000,
+ *   description: "Coffee payment",
+ * });
+ * console.log("Invoice:", invoice.bolt11);
+ *
+ * // === LendaSwap Skill ===
+ * const lendaswap = new LendaSwapSkill({
+ *   wallet,
+ *   apiKey: process.env.LENDASWAP_API_KEY,
+ * });
+ *
+ * // Get quote for BTC to USDC
+ * const quote = await lendaswap.getQuoteBtcToStablecoin(100000, "usdc_pol");
+ * console.log("Quote:", quote.targetAmount, "USDC");
+ * ```
+ *
+ * @module skills
+ */
+export type { Skill, BitcoinSkill, RampSkill, LightningSkill, StablecoinSwapSkill, BitcoinAddress, SendParams, SendResult, BalanceInfo, IncomingFundsEvent, OnboardParams, OffboardParams, RampResult, LightningInvoice, CreateInvoiceParams, PayInvoiceParams, PaymentResult, LightningFees, LightningLimits, SwapStatus, SwapInfo, EvmChain, StablecoinToken, BtcSource, BtcToStablecoinParams, StablecoinToBtcParams, StablecoinSwapResult, StablecoinSwapStatus, StablecoinSwapInfo, StablecoinQuote, StablecoinPair, } from "./types";
+export { ArkadeBitcoinSkill, createArkadeBitcoinSkill } from "./arkadeBitcoin";
+export { ArkaLightningSkill, createLightningSkill, type ArkaLightningSkillConfig, } from "./lightning";
+export { LendaSwapSkill, createLendaSwapSkill, type LendaSwapSkillConfig, } from "./lendaswap";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/skills/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/skills/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AAGH,YAAY,EACV,KAAK,EACL,YAAY,EACZ,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,eAAe,EACf,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,cAAc,GACf,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAG/E,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,wBAAwB,GAC9B,MAAM,aAAa,CAAC;AAGrB,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC"}