@arkade-os/skill 0.1.0

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

@@ -0,0 +1,152 @@
+/**
+ * LendaSwapSkill - Swap USDC/USDT from/to Arkade via LendaSwap.
+ *
+ * This skill provides stablecoin swap capabilities for Arkade wallets
+ * using the LendaSwap SDK for non-custodial BTC/stablecoin exchanges.
+ *
+ * @module skills/lendaswap
+ */
+import type { Wallet } from "@arkade-os/sdk";
+import type { StablecoinSwapSkill, StablecoinToken, BtcToStablecoinParams, StablecoinToBtcParams, StablecoinSwapResult, StablecoinSwapInfo, StablecoinQuote, StablecoinPair } from "./types";
+/**
+ * Configuration for the LendaSwapSkill.
+ */
+export interface LendaSwapSkillConfig {
+    /** The Arkade wallet to use */
+    wallet: Wallet;
+    /** LendaSwap API key */
+    apiKey: string;
+    /** Optional custom API URL (default: https://apilendaswap.lendasat.com/) */
+    apiUrl?: string;
+    /** Optional Esplora URL for Bitcoin queries */
+    esploraUrl?: string;
+    /** Optional mnemonic for HD wallet key derivation */
+    mnemonic?: string;
+    /** Optional referral code for fee discounts */
+    referralCode?: string;
+}
+/**
+ * LendaSwapSkill provides stablecoin swap capabilities for Arkade wallets
+ * using the LendaSwap SDK.
+ *
+ * This skill enables:
+ * - Swapping BTC from Arkade to USDC/USDT on Polygon, Ethereum, or Arbitrum
+ * - Receiving USDC/USDT and converting to BTC in your Arkade wallet
+ *
+ * @example
+ * ```typescript
+ * import { Wallet, SingleKey } from "@arkade-os/sdk";
+ * import { LendaSwapSkill } from "@arkade-os/skill";
+ *
+ * // Create a wallet
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex(privateKeyHex),
+ *   arkServerUrl: "https://arkade.computer",
+ * });
+ *
+ * // Create the LendaSwap skill
+ * const lendaswap = new LendaSwapSkill({
+ *   wallet,
+ *   apiKey: process.env.LENDASWAP_API_KEY,
+ * });
+ *
+ * // Get a quote for BTC to USDC
+ * const quote = await lendaswap.getQuoteBtcToStablecoin(100000, "usdc_pol");
+ * console.log("You'll receive:", quote.targetAmount, "USDC");
+ *
+ * // Execute the swap
+ * const result = await lendaswap.swapBtcToStablecoin({
+ *   targetAddress: "0x...",
+ *   targetToken: "usdc_pol",
+ *   targetChain: "polygon",
+ *   sourceAmount: 100000,
+ * });
+ * console.log("Swap created:", result.swapId);
+ * ```
+ */
+export declare class LendaSwapSkill implements StablecoinSwapSkill {
+    readonly name = "lendaswap";
+    readonly description = "Swap USDC/USDT from/to Arkade via LendaSwap non-custodial exchange";
+    readonly version = "1.0.0";
+    private readonly wallet;
+    private readonly apiUrl;
+    private readonly apiKey;
+    private readonly referralCode?;
+    private readonly swapStorage;
+    /**
+     * Creates a new LendaSwapSkill instance.
+     *
+     * @param config - Configuration options
+     */
+    constructor(config: LendaSwapSkillConfig);
+    /**
+     * Check if the skill is available and properly configured.
+     */
+    isAvailable(): Promise<boolean>;
+    /**
+     * Get a quote for swapping BTC to stablecoins.
+     */
+    getQuoteBtcToStablecoin(sourceAmount: number, targetToken: StablecoinToken): Promise<StablecoinQuote>;
+    /**
+     * Get a quote for swapping stablecoins to BTC.
+     */
+    getQuoteStablecoinToBtc(sourceAmount: number, sourceToken: StablecoinToken): Promise<StablecoinQuote>;
+    /**
+     * Swap BTC from Arkade to stablecoins on EVM.
+     */
+    swapBtcToStablecoin(params: BtcToStablecoinParams): Promise<StablecoinSwapResult>;
+    /**
+     * Swap stablecoins from EVM to BTC on Arkade.
+     */
+    swapStablecoinToBtc(params: StablecoinToBtcParams): Promise<StablecoinSwapResult>;
+    /**
+     * Get the status of a swap.
+     */
+    getSwapStatus(swapId: string): Promise<StablecoinSwapInfo>;
+    /**
+     * Get pending stablecoin swaps.
+     */
+    getPendingSwaps(): Promise<StablecoinSwapInfo[]>;
+    /**
+     * Get stablecoin swap history.
+     */
+    getSwapHistory(): Promise<StablecoinSwapInfo[]>;
+    /**
+     * Get available trading pairs.
+     */
+    getAvailablePairs(): Promise<StablecoinPair[]>;
+    /**
+     * Claim funds from a completed swap.
+     */
+    claimSwap(swapId: string): Promise<{
+        txid: string;
+    }>;
+    /**
+     * Refund an expired or failed swap.
+     */
+    refundSwap(swapId: string): Promise<{
+        txid: string;
+    }>;
+    /**
+     * Get the underlying wallet instance.
+     */
+    getWallet(): Wallet;
+    /**
+     * Get token decimals for a stablecoin.
+     */
+    getTokenDecimals(token: StablecoinToken): number;
+    /**
+     * Helper to fetch from LendaSwap API.
+     */
+    private fetchApi;
+}
+/**
+ * Create a LendaSwapSkill from a wallet and API key.
+ *
+ * @param wallet - The Arkade wallet to use
+ * @param apiKey - LendaSwap API key
+ * @param options - Optional configuration
+ * @returns A new LendaSwapSkill instance
+ */
+export declare function createLendaSwapSkill(wallet: Wallet, apiKey: string, options?: Partial<Omit<LendaSwapSkillConfig, "wallet" | "apiKey">>): LendaSwapSkill;
+//# sourceMappingURL=lendaswap.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lendaswap.d.ts","sourceRoot":"","sources":["../../../src/skills/lendaswap.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EAEf,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAElB,eAAe,EACf,cAAc,EACf,MAAM,SAAS,CAAC;AAoCjB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,WAAW,wEACmD;IACvE,QAAQ,CAAC,OAAO,WAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsC;IAElE;;;;OAIG;gBACS,MAAM,EAAE,oBAAoB;IAOxC;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IASrC;;OAEG;IACG,uBAAuB,CAC3B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,eAAe,GAC3B,OAAO,CAAC,eAAe,CAAC;IA8B3B;;OAEG;IACG,uBAAuB,CAC3B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,eAAe,GAC3B,OAAO,CAAC,eAAe,CAAC;IA8B3B;;OAEG;IACG,mBAAmB,CACvB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAyDhC;;OAEG;IACG,mBAAmB,CACvB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAuDhC;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAkChE;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAiCtD;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAwBrD;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAkBpD;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB1D;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAqB3D;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM;IAIhD;;OAEG;YACW,QAAQ;CAevB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,QAAQ,GAAG,QAAQ,CAAC,CAAC,GACjE,cAAc,CAMhB"}

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

@@ -0,0 +1,181 @@
+/**
+ * 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, type PendingReverseSwap } from "@arkade-os/boltz-swap";
+import { Wallet, type ArkProvider, type NetworkName } from "@arkade-os/sdk";
+import type { IndexerProvider } from "@arkade-os/sdk";
+import type { LightningSkill, LightningInvoice, CreateInvoiceParams, PayInvoiceParams, PaymentResult, LightningFees, LightningLimits, SwapInfo } from "./types";
+/**
+ * Configuration for the ArkaLightningSkill.
+ */
+export interface ArkaLightningSkillConfig {
+    /** The Arkade wallet to use */
+    wallet: Wallet;
+    /** Network name */
+    network: NetworkName;
+    /** Optional Ark provider (will use wallet's provider if not specified) */
+    arkProvider?: ArkProvider;
+    /** Optional Indexer provider */
+    indexerProvider?: IndexerProvider;
+    /** Optional custom Boltz API URL */
+    boltzApiUrl?: string;
+    /** Optional Boltz referral ID */
+    referralId?: string;
+    /** Enable background swap monitoring (default: false) */
+    enableSwapManager?: boolean;
+}
+/**
+ * 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 declare class ArkaLightningSkill implements LightningSkill {
+    readonly name = "arka-lightning";
+    readonly description = "Lightning Network payments via Boltz submarine swaps for Arkade wallets";
+    readonly version = "1.0.0";
+    private readonly arkadeLightning;
+    private readonly swapProvider;
+    private readonly network;
+    /**
+     * Creates a new ArkaLightningSkill instance.
+     *
+     * @param config - Configuration options
+     */
+    constructor(config: ArkaLightningSkillConfig);
+    /**
+     * Check if the Lightning skill is available.
+     *
+     * @returns true if the skill is properly configured
+     */
+    isAvailable(): Promise<boolean>;
+    /**
+     * 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
+     */
+    createInvoice(params: CreateInvoiceParams): Promise<LightningInvoice>;
+    /**
+     * 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
+     */
+    payInvoice(params: PayInvoiceParams): Promise<PaymentResult>;
+    /**
+     * Get fee information for Lightning swaps.
+     *
+     * @returns Fee structure for submarine and reverse swaps
+     */
+    getFees(): Promise<LightningFees>;
+    /**
+     * Get limits for Lightning swaps.
+     *
+     * @returns Min and max amounts for swaps
+     */
+    getLimits(): Promise<LightningLimits>;
+    /**
+     * Get pending swaps.
+     *
+     * @returns Array of pending swap information
+     */
+    getPendingSwaps(): Promise<SwapInfo[]>;
+    /**
+     * Get swap history.
+     *
+     * @returns Array of all swaps (pending and completed)
+     */
+    getSwapHistory(): Promise<SwapInfo[]>;
+    /**
+     * 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
+     */
+    waitAndClaim(pendingSwap: PendingReverseSwap): Promise<{
+        txid: string;
+    }>;
+    /**
+     * Get the underlying ArkadeLightning instance for advanced operations.
+     *
+     * @returns The ArkadeLightning instance
+     */
+    getArkadeLightning(): ArkadeLightning;
+    /**
+     * Get the swap provider for direct Boltz API access.
+     *
+     * @returns The BoltzSwapProvider instance
+     */
+    getSwapProvider(): BoltzSwapProvider;
+    /**
+     * Start the background swap manager if enabled.
+     */
+    startSwapManager(): Promise<void>;
+    /**
+     * Stop the background swap manager.
+     */
+    stopSwapManager(): Promise<void>;
+    /**
+     * Dispose of resources and stop the swap manager.
+     */
+    dispose(): Promise<void>;
+    private mapReverseSwap;
+    private mapSubmarineSwap;
+}
+/**
+ * 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 declare function createLightningSkill(wallet: Wallet, network: NetworkName, options?: Partial<Omit<ArkaLightningSkillConfig, "wallet" | "network">>): ArkaLightningSkill;
+//# sourceMappingURL=lightning.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lightning.d.ts","sourceRoot":"","sources":["../../../src/skills/lightning.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,eAAe,EACf,iBAAiB,EAEjB,KAAK,kBAAkB,EAExB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,eAAe,EACf,QAAQ,EAET,MAAM,SAAS,CAAC;AAcjB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,gCAAgC;IAChC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,QAAQ,CAAC,IAAI,oBAAoB;IACjC,QAAQ,CAAC,WAAW,6EACwD;IAC5E,QAAQ,CAAC,OAAO,WAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkB;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAoB;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IAEtC;;;;OAIG;gBACS,MAAM,EAAE,wBAAwB;IA2B5C;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IASrC;;;;;;;;;OASG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAoB3E;;;;;;;;;OASG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAYlE;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC;IAIvC;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IAI3C;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAY5C;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAS3C;;;;;OAKG;IACG,YAAY,CAChB,WAAW,EAAE,kBAAkB,GAC9B,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAI5B;;;;OAIG;IACH,kBAAkB,IAAI,eAAe;IAIrC;;;;OAIG;IACH,eAAe,IAAI,iBAAiB;IAIpC;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvC;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAItC;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,gBAAgB;CAmBzB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,GACtE,kBAAkB,CAMpB"}