@arkade-os/boltz-swap 0.3.29 → 0.3.31

package/dist/swapsPollProcessor-BF3uTFae.d.cts

@@ -0,0 +1,93 @@
+import { AsyncStorageTaskQueue, TaskProcessor } from '@arkade-os/sdk/worker/expo';
+import { ArkProvider, IndexerProvider, Identity, IWallet } from '@arkade-os/sdk';
+import { m as SwapRepository, p as BoltzSwapProvider, N as Network, A as ArkadeSwapsConfig } from './types-BBI7-KJ0.cjs';
+
+/**
+ * Dependencies injected into every swap processor at runtime.
+ *
+ * Unlike the wallet's `TaskDependencies`, these are swap-specific:
+ * we need the Boltz provider, swap repository, and identity to
+ * poll status and attempt claim/refund.
+ */
+interface SwapTaskDependencies {
+    swapRepository: SwapRepository;
+    swapProvider: BoltzSwapProvider;
+    arkProvider: ArkProvider;
+    indexerProvider: IndexerProvider;
+    identity: Identity;
+    wallet: IWallet;
+}
+/**
+ * Minimal config persisted to AsyncStorage for background rehydration.
+ *
+ * The background handler runs in a fresh JS context without access to
+ * the foreground's in-memory state, so we persist just enough to
+ * reconstruct providers and identity.
+ */
+interface PersistedSwapBackgroundConfig {
+    boltzApiUrl: string;
+    arkServerUrl: string;
+    network: Network;
+}
+/**
+ * Background scheduling configuration for {@link ExpoArkadeSwaps}.
+ *
+ * OS-level task registration is **not** part of this config — call
+ * `registerExpoSwapBackgroundTask` from `@arkade-os/boltz-swap/expo/background`
+ * explicitly. Splitting that step out keeps `/expo` free of the
+ * `expo-task-manager` / `expo-background-task` dependencies.
+ */
+interface ExpoSwapBackgroundConfig {
+    /** Persistence layer for foreground ↔ background handoff. */
+    taskQueue: AsyncStorageTaskQueue;
+    /** If set, acknowledges background results at this interval (ms) while the app is in the foreground. */
+    foregroundIntervalMs?: number;
+}
+/**
+ * Options for {@link defineExpoSwapBackgroundTask}.
+ */
+interface DefineSwapBackgroundTaskOptions {
+    /** AsyncStorage-backed queue (must match the one passed to ExpoArkadeSwaps.setup). */
+    taskQueue: AsyncStorageTaskQueue;
+    /** Swap repository (fresh instance is fine — connects to the same DB). */
+    swapRepository: SwapRepository;
+    /** Factory to reconstruct Identity from secure storage in the background. */
+    identityFactory: () => Promise<Identity>;
+}
+/**
+ * Configuration for {@link ExpoArkadeSwaps.setup}.
+ */
+interface ExpoArkadeSwapsConfig extends ArkadeSwapsConfig {
+    /**
+     * Ark server base URL (e.g. "https://ark.example.com").
+     *
+     * Recommended for type-safe background rehydration. If omitted,
+     * ExpoArkadeSwaps will attempt to derive it from the ArkProvider.
+     */
+    arkServerUrl?: string;
+    background: ExpoSwapBackgroundConfig;
+}
+/** @deprecated Use ExpoArkadeSwapsConfig instead */
+type ExpoArkadeLightningConfig = ExpoArkadeSwapsConfig;
+
+/**
+ * Task type identifier for {@link swapsPollProcessor}.
+ */
+declare const SWAP_POLL_TASK_TYPE = "swap-poll";
+/**
+ * Stateless processor that polls Boltz for swap status updates and
+ * attempts best-effort claim/refund for actionable swaps.
+ *
+ * Designed for Expo background tasks (~30s window) and follows the
+ * same `TaskProcessor` pattern as `contractPollProcessor` in ts-sdk.
+ *
+ * Steps:
+ * 1. Read all non-final swaps from SwapRepository
+ * 2. Poll Boltz HTTP API for each swap's current status
+ * 3. Persist status changes immediately
+ * 4. For actionable statuses: attempt claimVHTLC / refundVHTLC (best-effort)
+ * 5. Return summary metrics
+ */
+declare const swapsPollProcessor: TaskProcessor<SwapTaskDependencies>;
+
+export { type DefineSwapBackgroundTaskOptions as D, type ExpoArkadeSwapsConfig as E, type PersistedSwapBackgroundConfig as P, SWAP_POLL_TASK_TYPE as S, type SwapTaskDependencies as a, type ExpoSwapBackgroundConfig as b, type ExpoArkadeLightningConfig as c, swapsPollProcessor as s };

package/dist/swapsPollProcessor-wYOMzldd.d.ts

@@ -0,0 +1,93 @@
+import { AsyncStorageTaskQueue, TaskProcessor } from '@arkade-os/sdk/worker/expo';
+import { ArkProvider, IndexerProvider, Identity, IWallet } from '@arkade-os/sdk';
+import { m as SwapRepository, p as BoltzSwapProvider, N as Network, A as ArkadeSwapsConfig } from './types-BBI7-KJ0.js';
+
+/**
+ * Dependencies injected into every swap processor at runtime.
+ *
+ * Unlike the wallet's `TaskDependencies`, these are swap-specific:
+ * we need the Boltz provider, swap repository, and identity to
+ * poll status and attempt claim/refund.
+ */
+interface SwapTaskDependencies {
+    swapRepository: SwapRepository;
+    swapProvider: BoltzSwapProvider;
+    arkProvider: ArkProvider;
+    indexerProvider: IndexerProvider;
+    identity: Identity;
+    wallet: IWallet;
+}
+/**
+ * Minimal config persisted to AsyncStorage for background rehydration.
+ *
+ * The background handler runs in a fresh JS context without access to
+ * the foreground's in-memory state, so we persist just enough to
+ * reconstruct providers and identity.
+ */
+interface PersistedSwapBackgroundConfig {
+    boltzApiUrl: string;
+    arkServerUrl: string;
+    network: Network;
+}
+/**
+ * Background scheduling configuration for {@link ExpoArkadeSwaps}.
+ *
+ * OS-level task registration is **not** part of this config — call
+ * `registerExpoSwapBackgroundTask` from `@arkade-os/boltz-swap/expo/background`
+ * explicitly. Splitting that step out keeps `/expo` free of the
+ * `expo-task-manager` / `expo-background-task` dependencies.
+ */
+interface ExpoSwapBackgroundConfig {
+    /** Persistence layer for foreground ↔ background handoff. */
+    taskQueue: AsyncStorageTaskQueue;
+    /** If set, acknowledges background results at this interval (ms) while the app is in the foreground. */
+    foregroundIntervalMs?: number;
+}
+/**
+ * Options for {@link defineExpoSwapBackgroundTask}.
+ */
+interface DefineSwapBackgroundTaskOptions {
+    /** AsyncStorage-backed queue (must match the one passed to ExpoArkadeSwaps.setup). */
+    taskQueue: AsyncStorageTaskQueue;
+    /** Swap repository (fresh instance is fine — connects to the same DB). */
+    swapRepository: SwapRepository;
+    /** Factory to reconstruct Identity from secure storage in the background. */
+    identityFactory: () => Promise<Identity>;
+}
+/**
+ * Configuration for {@link ExpoArkadeSwaps.setup}.
+ */
+interface ExpoArkadeSwapsConfig extends ArkadeSwapsConfig {
+    /**
+     * Ark server base URL (e.g. "https://ark.example.com").
+     *
+     * Recommended for type-safe background rehydration. If omitted,
+     * ExpoArkadeSwaps will attempt to derive it from the ArkProvider.
+     */
+    arkServerUrl?: string;
+    background: ExpoSwapBackgroundConfig;
+}
+/** @deprecated Use ExpoArkadeSwapsConfig instead */
+type ExpoArkadeLightningConfig = ExpoArkadeSwapsConfig;
+
+/**
+ * Task type identifier for {@link swapsPollProcessor}.
+ */
+declare const SWAP_POLL_TASK_TYPE = "swap-poll";
+/**
+ * Stateless processor that polls Boltz for swap status updates and
+ * attempts best-effort claim/refund for actionable swaps.
+ *
+ * Designed for Expo background tasks (~30s window) and follows the
+ * same `TaskProcessor` pattern as `contractPollProcessor` in ts-sdk.
+ *
+ * Steps:
+ * 1. Read all non-final swaps from SwapRepository
+ * 2. Poll Boltz HTTP API for each swap's current status
+ * 3. Persist status changes immediately
+ * 4. For actionable statuses: attempt claimVHTLC / refundVHTLC (best-effort)
+ * 5. Return summary metrics
+ */
+declare const swapsPollProcessor: TaskProcessor<SwapTaskDependencies>;
+
+export { type DefineSwapBackgroundTaskOptions as D, type ExpoArkadeSwapsConfig as E, type PersistedSwapBackgroundConfig as P, SWAP_POLL_TASK_TYPE as S, type SwapTaskDependencies as a, type ExpoSwapBackgroundConfig as b, type ExpoArkadeLightningConfig as c, swapsPollProcessor as s };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/boltz-swap",
-  "version": "0.3.29",
+  "version": "0.3.31",
   "type": "module",
   "description": "A production-ready TypeScript package that brings Boltz submarine-swaps to Arkade.",
   "main": "./dist/index.js",
@@ -26,6 +26,16 @@
         "default": "./dist/expo/index.cjs"
       }
     },
+    "./expo/background": {
+      "import": {
+        "types": "./dist/expo/background.d.ts",
+        "default": "./dist/expo/background.js"
+      },
+      "require": {
+        "types": "./dist/expo/background.d.ts",
+        "default": "./dist/expo/background.cjs"
+      }
+    },
     "./repositories/sqlite": {
       "import": {
         "types": "./dist/repositories/sqlite/index.d.ts",
@@ -60,7 +70,7 @@
   "author": "Arkade-OS",
   "license": "MIT",
   "dependencies": {
-    "@arkade-os/sdk": "0.4.25",
+    "@arkade-os/sdk": "0.4.26",
     "@noble/hashes": "2.0.1",
     "@scure/base": "2.0.0",
     "@scure/btc-signer": "2.0.1",
@@ -68,6 +78,18 @@
     "@noble/curves": "^2.0.1",
     "light-bolt11-decoder": "3.2.0"
   },
+  "peerDependencies": {
+    "expo-task-manager": ">=3.0.0",
+    "expo-background-task": ">=0.1.0"
+  },
+  "peerDependenciesMeta": {
+    "expo-task-manager": {
+      "optional": true
+    },
+    "expo-background-task": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@eslint/js": "^9.35.0",
     "@types/node": "^24.3.1",
@@ -91,7 +113,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup src/index.ts src/expo/index.ts src/repositories/sqlite/index.ts src/repositories/realm/index.ts --format esm,cjs --dts --clean",
+    "build": "tsup src/index.ts src/expo/index.ts src/expo/background.ts src/repositories/sqlite/index.ts src/repositories/realm/index.ts --format esm,cjs --dts --clean",
     "format": "prettier --write src test",
     "lint": "prettier --check src test",
     "test": "vitest run",

package/dist/background-UQDFQCGM.js

@@ -1,12 +0,0 @@
-import {
-  defineExpoSwapBackgroundTask,
-  registerExpoSwapBackgroundTask,
-  unregisterExpoSwapBackgroundTask
-} from "./chunk-X3JNWDAR.js";
-import "./chunk-LWUXSE5N.js";
-import "./chunk-3RG5ZIWI.js";
-export {
-  defineExpoSwapBackgroundTask,
-  registerExpoSwapBackgroundTask,
-  unregisterExpoSwapBackgroundTask
-};

package/dist/chunk-3RG5ZIWI.js

@@ -1,10 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-export {
-  __require
-};

package/dist/chunk-X3JNWDAR.js

@@ -1,261 +0,0 @@
-import {
-  ArkadeSwaps,
-  BoltzSwapProvider,
-  isPendingReverseSwap,
-  isPendingSubmarineSwap,
-  isReverseClaimableStatus,
-  isReverseFinalStatus,
-  isSubmarineFinalStatus,
-  isSubmarineSwapRefundable,
-  logger
-} from "./chunk-LWUXSE5N.js";
-import {
-  __require
-} from "./chunk-3RG5ZIWI.js";
-
-// src/expo/background.ts
-import { runTasks } from "@arkade-os/sdk/worker/expo";
-import {
-  ExpoArkProvider,
-  ExpoIndexerProvider
-} from "@arkade-os/sdk/adapters/expo";
-
-// src/expo/swapsPollProcessor.ts
-var SWAP_POLL_TASK_TYPE = "swap-poll";
-var swapsPollProcessor = {
-  taskType: SWAP_POLL_TASK_TYPE,
-  async execute(item, deps) {
-    const {
-      swapRepository,
-      swapProvider,
-      wallet,
-      arkProvider,
-      indexerProvider
-    } = deps;
-    const allSwaps = await swapRepository.getAllSwaps();
-    const pendingSwaps = allSwaps.filter((swap) => {
-      if (isPendingReverseSwap(swap))
-        return !isReverseFinalStatus(swap.status);
-      if (isPendingSubmarineSwap(swap))
-        return !isSubmarineFinalStatus(swap.status);
-      return false;
-    });
-    let polled = 0;
-    let updated = 0;
-    let claimed = 0;
-    let refunded = 0;
-    let errors = 0;
-    const tempSwaps = new ArkadeSwaps({
-      wallet,
-      arkProvider,
-      indexerProvider,
-      swapProvider,
-      swapManager: false,
-      swapRepository
-    });
-    try {
-      for (const swap of pendingSwaps) {
-        try {
-          const { status: currentStatus } = await swapProvider.getSwapStatus(swap.id);
-          polled++;
-          if (currentStatus !== swap.status) {
-            await swapRepository.saveSwap({
-              ...swap,
-              status: currentStatus
-            });
-            updated++;
-          }
-          if (isPendingReverseSwap(swap) && isReverseClaimableStatus(currentStatus)) {
-            if (!swap.preimage) {
-              logger.warn(
-                `[swap-poll] Skipping claim for ${swap.id}: no preimage`
-              );
-              continue;
-            }
-            try {
-              await tempSwaps.claimVHTLC(swap);
-              claimed++;
-            } catch (claimError) {
-              logger.error(
-                `[swap-poll] Claim failed for ${swap.id}:`,
-                claimError
-              );
-              errors++;
-            }
-          }
-          const swapWithStatus = isPendingSubmarineSwap(swap) ? { ...swap, status: currentStatus } : null;
-          if (isPendingSubmarineSwap(swap) && isSubmarineSwapRefundable(swapWithStatus)) {
-            if (!swap.request.invoice && !swap.preimageHash) {
-              logger.warn(
-                `[swap-poll] Skipping refund for ${swap.id}: no invoice or preimageHash`
-              );
-              continue;
-            }
-            try {
-              await tempSwaps.refundVHTLC(swapWithStatus);
-              refunded++;
-            } catch (refundError) {
-              logger.error(
-                `[swap-poll] Refund failed for ${swap.id}:`,
-                refundError
-              );
-              errors++;
-            }
-          }
-        } catch (swapError) {
-          logger.error(
-            `[swap-poll] Error processing swap ${swap.id}:`,
-            swapError
-          );
-          errors++;
-        }
-      }
-    } finally {
-      await tempSwaps.dispose();
-    }
-    return {
-      taskItemId: item.id,
-      type: SWAP_POLL_TASK_TYPE,
-      status: errors > 0 && polled === 0 ? "failed" : "success",
-      data: { polled, updated, claimed, refunded, errors }
-    };
-  }
-};
-
-// src/expo/background.ts
-function requireTaskManager() {
-  try {
-    return __require("expo-task-manager");
-  } catch {
-    throw new Error(
-      "expo-task-manager is required for background tasks. Install it with: npx expo install expo-task-manager"
-    );
-  }
-}
-function requireBackgroundTask() {
-  try {
-    return __require("expo-background-task");
-  } catch {
-    throw new Error(
-      "expo-background-task is required for background tasks. Install it with: npx expo install expo-background-task"
-    );
-  }
-}
-function getRandomId() {
-  return Math.random().toString(36).slice(2) + Date.now().toString(36);
-}
-function createBackgroundWalletShim(args) {
-  const notImplemented = (method) => {
-    throw new Error(
-      `[boltz-swap] Background wallet shim: "${String(method)}" is not implemented`
-    );
-  };
-  return {
-    identity: args.identity,
-    getAddress: args.getAddress,
-    getBoardingAddress: async () => notImplemented("getBoardingAddress"),
-    getBalance: async () => notImplemented("getBalance"),
-    getVtxos: async () => notImplemented("getVtxos"),
-    getBoardingUtxos: async () => notImplemented("getBoardingUtxos"),
-    getTransactionHistory: async () => notImplemented("getTransactionHistory"),
-    getContractManager: async () => notImplemented("getContractManager"),
-    getDelegatorManager: async () => notImplemented("getDelegatorManager"),
-    sendBitcoin: async () => notImplemented("sendBitcoin"),
-    send: async () => notImplemented("send"),
-    settle: async () => notImplemented("settle"),
-    assetManager: new Proxy({}, {
-      get: () => notImplemented("assetManager")
-    })
-  };
-}
-function defineExpoSwapBackgroundTask(taskName, options) {
-  const TaskManager = requireTaskManager();
-  const BackgroundTask = requireBackgroundTask();
-  const { taskQueue, swapRepository, identityFactory } = options;
-  TaskManager.defineTask(taskName, async () => {
-    try {
-      const config = await taskQueue.loadConfig();
-      if (!config) {
-        return BackgroundTask.BackgroundTaskResult.Success;
-      }
-      const identity = await identityFactory();
-      const arkProvider = new ExpoArkProvider(config.arkServerUrl);
-      const indexerProvider = new ExpoIndexerProvider(
-        config.arkServerUrl
-      );
-      const swapProvider = new BoltzSwapProvider({
-        network: config.network,
-        apiUrl: config.boltzApiUrl
-      });
-      const wallet = createBackgroundWalletShim({
-        identity,
-        getAddress: async () => {
-          const { ArkAddress } = await import("@arkade-os/sdk");
-          const { hex } = await import("@scure/base");
-          const info = await arkProvider.getInfo();
-          const pubkey = await identity.xOnlyPublicKey();
-          const serverPubKey = hex.decode(info.signerPubkey);
-          const xOnlyServerPubKey = serverPubKey.length === 33 ? serverPubKey.slice(1) : serverPubKey;
-          const hrp = info.network === "bitcoin" ? "ark" : "tark";
-          return new ArkAddress(
-            xOnlyServerPubKey,
-            pubkey,
-            hrp
-          ).encode();
-        }
-      });
-      const deps = {
-        swapRepository,
-        swapProvider,
-        arkProvider,
-        indexerProvider,
-        identity,
-        wallet
-      };
-      await runTasks(taskQueue, [swapsPollProcessor], deps);
-      const results = await taskQueue.getResults();
-      if (results.length > 0) {
-        await taskQueue.acknowledgeResults(
-          results.map((r) => r.id)
-        );
-      }
-      const existing = await taskQueue.getTasks(SWAP_POLL_TASK_TYPE);
-      if (existing.length === 0) {
-        const task = {
-          id: getRandomId(),
-          type: SWAP_POLL_TASK_TYPE,
-          data: {},
-          createdAt: Date.now()
-        };
-        await taskQueue.addTask(task);
-      }
-      return BackgroundTask.BackgroundTaskResult.Success;
-    } catch (error) {
-      console.error(
-        "[boltz-swap] Background task failed:",
-        error instanceof Error ? error.message : error
-      );
-      return BackgroundTask.BackgroundTaskResult.Failed;
-    }
-  });
-}
-async function registerExpoSwapBackgroundTask(taskName, options) {
-  const BackgroundTask = requireBackgroundTask();
-  await BackgroundTask.registerTaskAsync(taskName, {
-    // expo-background-task expects minutes:
-    // https://docs.expo.dev/versions/latest/sdk/background-task/#backgroundtaskoptions
-    minimumInterval: options?.minimumInterval ?? 15
-  });
-}
-async function unregisterExpoSwapBackgroundTask(taskName) {
-  const BackgroundTask = requireBackgroundTask();
-  await BackgroundTask.unregisterTaskAsync(taskName);
-}
-
-export {
-  SWAP_POLL_TASK_TYPE,
-  swapsPollProcessor,
-  defineExpoSwapBackgroundTask,
-  registerExpoSwapBackgroundTask,
-  unregisterExpoSwapBackgroundTask
-};