@arkade-os/boltz-swap 0.3.13 → 0.3.15

package/dist/{types-NXkA-o9j.d.ts → types-C-2sBQWJ.d.ts}

@@ -51,20 +51,20 @@ declare const isChainRefundableStatus: (status: BoltzSwapStatus) => boolean;
 declare const isChainSignableStatus: (status: BoltzSwapStatus) => boolean;
 /** Returns true if the chain swap completed successfully. */
 declare const isChainSuccessStatus: (status: BoltzSwapStatus) => boolean;
-/** Type guard: narrows PendingSwap to PendingReverseSwap. */
-declare const isPendingReverseSwap: (swap: PendingSwap) => swap is PendingReverseSwap;
-/** Type guard: narrows PendingSwap to PendingSubmarineSwap. */
-declare const isPendingSubmarineSwap: (swap: PendingSwap) => swap is PendingSubmarineSwap;
-/** Type guard: narrows PendingSwap to PendingChainSwap. */
-declare const isPendingChainSwap: (swap: PendingSwap) => swap is PendingChainSwap;
+/** Type guard: narrows BoltzSwap to BoltzReverseSwap. */
+declare const isPendingReverseSwap: (swap: BoltzSwap) => swap is BoltzReverseSwap;
+/** Type guard: narrows BoltzSwap to BoltzSubmarineSwap. */
+declare const isPendingSubmarineSwap: (swap: BoltzSwap) => swap is BoltzSubmarineSwap;
+/** Type guard: narrows BoltzSwap to BoltzChainSwap. */
+declare const isPendingChainSwap: (swap: BoltzSwap) => swap is BoltzChainSwap;
 /** Type guard: checks if swap is a refundable submarine swap (failed + not yet refunded). */
-declare const isSubmarineSwapRefundable: (swap: PendingSwap) => swap is PendingSubmarineSwap;
+declare const isSubmarineSwapRefundable: (swap: BoltzSwap) => swap is BoltzSubmarineSwap;
 /** Type guard: checks if swap is a refundable chain swap (expired ARK → BTC). */
-declare const isChainSwapRefundable: (swap: PendingSwap) => swap is PendingChainSwap;
+declare const isChainSwapRefundable: (swap: BoltzSwap) => swap is BoltzChainSwap;
 /** Type guard: checks if swap is a claimable reverse swap. */
-declare const isReverseSwapClaimable: (swap: PendingSwap) => swap is PendingReverseSwap;
+declare const isReverseSwapClaimable: (swap: BoltzSwap) => swap is BoltzReverseSwap;
 /** Type guard: checks if swap is a claimable chain swap. */
-declare const isChainSwapClaimable: (swap: PendingSwap) => swap is PendingChainSwap;
+declare const isChainSwapClaimable: (swap: BoltzSwap) => swap is BoltzChainSwap;
 type TimeoutBlockHeights = {
     refund: number;
     unilateralClaim: number;
@@ -81,6 +81,7 @@ type GetSwapStatusResponse = {
     transaction?: {
         id: string;
         hex?: string;
+        confirmed?: boolean;
         eta?: number;
         preimage?: string;
     };
@@ -96,16 +97,18 @@ type CreateSubmarineSwapRequest = {
 type CreateSubmarineSwapResponse = {
     /** Unique swap ID. */
     id: string;
-    /** ARK lockup address to send funds to. */
-    address: string;
     /** Amount in satoshis to send. */
     expectedAmount: number;
+    /** ARK lockup address to send funds to. */
+    address?: string;
     /** Boltz's public key for the claim path. */
-    claimPublicKey: string;
+    claimPublicKey?: string;
     /** Whether zero-conf transactions are accepted. */
-    acceptZeroConf: boolean;
+    acceptZeroConf?: boolean;
+    /** Block height for the onchain HTLC timeout. */
+    timeoutBlockHeight?: number;
     /** Block heights for various timeout/refund scenarios. */
-    timeoutBlockHeights: TimeoutBlockHeights;
+    timeoutBlockHeights?: TimeoutBlockHeights;
 };
 type GetSwapPreimageResponse = {
     preimage: string;
@@ -128,13 +131,15 @@ type CreateReverseSwapResponse = {
     /** BOLT11-encoded Lightning invoice to be paid. */
     invoice: string;
     /** On-chain amount in satoshis (after Boltz fees). */
-    onchainAmount: number;
+    onchainAmount?: number;
     /** ARK lockup address where Boltz will lock funds. */
-    lockupAddress: string;
+    lockupAddress?: string;
     /** Boltz's public key for the refund path. */
-    refundPublicKey: string;
+    refundPublicKey?: string;
+    /** Block height for the onchain HTLC timeout. */
+    timeoutBlockHeight?: number;
     /** Block heights for various timeout/refund scenarios. */
-    timeoutBlockHeights: TimeoutBlockHeights;
+    timeoutBlockHeights?: TimeoutBlockHeights;
 };
 type SwapTree = {
     claimLeaf: {
@@ -223,10 +228,11 @@ type Leaf = {
 type Tree = {
     claimLeaf: Leaf;
     refundLeaf: Leaf;
-    refundWithoutBoltzLeaf: Leaf;
-    unilateralClaimLeaf: Leaf;
-    unilateralRefundLeaf: Leaf;
-    unilateralRefundWithoutBoltzLeaf: Leaf;
+    covenantClaimLeaf?: Leaf;
+    refundWithoutBoltzLeaf?: Leaf;
+    unilateralClaimLeaf?: Leaf;
+    unilateralRefundLeaf?: Leaf;
+    unilateralRefundWithoutBoltzLeaf?: Leaf;
 };
 type Details = {
     tree: Tree;
@@ -238,7 +244,7 @@ type Details = {
     };
     lockupAddress: string;
     serverPublicKey: string;
-    timeoutBlockHeight: number;
+    timeoutBlockHeight?: number;
     timeoutBlockHeights?: TimeoutBlockHeights;
     preimageHash?: string;
 };
@@ -249,19 +255,10 @@ type RestoredChainSwap = {
     createdAt: number;
     from: "ARK" | "BTC";
     to: "ARK" | "BTC";
-    preimageHash: string;
-    refundDetails: {
-        amount: number;
-        keyIndex: number;
-        lockupAddress: string;
-        serverPublicKey: string;
-        timeoutBlockHeight: number;
-        transaction?: {
-            id: string;
-            vout: number;
-        };
-        tree: Tree;
-    };
+    preimageHash?: string;
+    invoice?: string;
+    refundDetails?: Details;
+    claimDetails?: Details;
 };
 type RestoredSubmarineSwap = {
     to: "BTC";
@@ -269,7 +266,7 @@ type RestoredSubmarineSwap = {
     from: "ARK";
     type: "submarine";
     createdAt: number;
-    preimageHash: string;
+    preimageHash?: string;
     status: BoltzSwapStatus;
     refundDetails: Details;
     invoice?: string;
@@ -280,7 +277,7 @@ type RestoredReverseSwap = {
     from: "BTC";
     type: "reverse";
     createdAt: number;
-    preimageHash: string;
+    preimageHash?: string;
     status: BoltzSwapStatus;
     claimDetails: Details;
     invoice?: string;
@@ -392,39 +389,39 @@ interface SwapManagerConfig {
 }
 /** Event callbacks for swap lifecycle events. Can be provided in config or registered via on/off methods. */
 interface SwapManagerEvents {
-    onSwapUpdate?: (swap: PendingSwap, oldStatus: BoltzSwapStatus) => void;
-    onSwapCompleted?: (swap: PendingSwap) => void;
-    onSwapFailed?: (swap: PendingSwap, error: Error) => void;
-    onActionExecuted?: (swap: PendingSwap, action: Actions) => void;
+    onSwapUpdate?: (swap: BoltzSwap, oldStatus: BoltzSwapStatus) => void;
+    onSwapCompleted?: (swap: BoltzSwap) => void;
+    onSwapFailed?: (swap: BoltzSwap, error: Error) => void;
+    onActionExecuted?: (swap: BoltzSwap, action: Actions) => void;
     onWebSocketConnected?: () => void;
     onWebSocketDisconnected?: (error?: Error) => void;
 }
 /** Callback for swap status changes. Receives the updated swap and its previous status. */
-type SwapUpdateListener = (swap: PendingSwap, oldStatus: BoltzSwapStatus) => void;
+type SwapUpdateListener = (swap: BoltzSwap, oldStatus: BoltzSwapStatus) => void;
 /** Callback for swap completions (final success state reached). */
-type SwapCompletedListener = (swap: PendingSwap) => void;
+type SwapCompletedListener = (swap: BoltzSwap) => void;
 /** Callback for swap failures. Includes the error that caused the failure. */
-type SwapFailedListener = (swap: PendingSwap, error: Error) => void;
+type SwapFailedListener = (swap: BoltzSwap, error: Error) => void;
 /** Callback after a swap action (claim/refund) has been executed. */
-type ActionExecutedListener = (swap: PendingSwap, action: Actions) => void;
+type ActionExecutedListener = (swap: BoltzSwap, action: Actions) => void;
 /** Callback when the WebSocket connection is established. */
 type WebSocketConnectedListener = () => void;
 /** Callback when the WebSocket disconnects. Includes the error if disconnection was not clean. */
 type WebSocketDisconnectedListener = (error?: Error) => void;
 /** Per-swap update callback used with subscribeToSwapUpdates. */
-type SwapUpdateCallback = (swap: PendingSwap, oldStatus: BoltzSwapStatus) => void;
+type SwapUpdateCallback = (swap: BoltzSwap, oldStatus: BoltzSwapStatus) => void;
 /** Public interface for SwapManager consumers. Provides swap monitoring, event subscription, and lifecycle control. */
 interface SwapManagerClient {
     /** Starts the manager, loading initial swaps and connecting WebSocket. */
-    start(pendingSwaps: PendingSwap[]): Promise<void>;
+    start(pendingSwaps: BoltzSwap[]): Promise<void>;
     /** Stops the manager, closes WebSocket, and clears all timers. */
     stop(): Promise<void>;
     /** Adds a new swap to be monitored. Immediately subscribes via WebSocket. */
-    addSwap(swap: PendingSwap): Promise<void>;
+    addSwap(swap: BoltzSwap): Promise<void>;
     /** Removes a swap from monitoring. */
     removeSwap(swapId: string): Promise<void>;
     /** Returns all currently monitored (non-final) swaps. */
-    getPendingSwaps(): Promise<PendingSwap[]>;
+    getPendingSwaps(): Promise<BoltzSwap[]>;
     /** Subscribes to status updates for a specific swap. @returns Unsubscribe function. */
     subscribeToSwapUpdates(swapId: string, callback: SwapUpdateCallback): Promise<() => void>;
     /** Returns a promise that resolves with { txid } when the swap completes, or rejects on failure. */
@@ -459,13 +456,13 @@ interface SwapManagerClient {
 }
 /** Internal callbacks wired by ArkadeSwaps to perform claim/refund/save operations. */
 interface SwapManagerCallbacks {
-    claim: (swap: PendingReverseSwap) => Promise<void>;
-    refund: (swap: PendingSubmarineSwap) => Promise<void>;
-    claimArk: (swap: PendingChainSwap) => Promise<void>;
-    claimBtc: (swap: PendingChainSwap) => Promise<void>;
-    refundArk: (swap: PendingChainSwap) => Promise<void>;
-    signServerClaim?: (swap: PendingChainSwap) => Promise<void>;
-    saveSwap: (swap: PendingSwap) => Promise<void>;
+    claim: (swap: BoltzReverseSwap) => Promise<void>;
+    refund: (swap: BoltzSubmarineSwap) => Promise<void>;
+    claimArk: (swap: BoltzChainSwap) => Promise<void>;
+    claimBtc: (swap: BoltzChainSwap) => Promise<void>;
+    refundArk: (swap: BoltzChainSwap) => Promise<void>;
+    signServerClaim?: (swap: BoltzChainSwap) => Promise<void>;
+    saveSwap: (swap: BoltzSwap) => Promise<void>;
 }
 /**
  * Background swap monitor with WebSocket + polling fallback.
@@ -564,7 +561,7 @@ declare class SwapManager implements SwapManagerClient {
      * 3. Poll all swaps after connection
      * 4. Resume any actionable swaps
      */
-    start(pendingSwaps: PendingSwap[]): Promise<void>;
+    start(pendingSwaps: BoltzSwap[]): Promise<void>;
     /**
      * Stop the swap manager
      * Cleanup: close WebSocket, stop all timers
@@ -580,7 +577,7 @@ declare class SwapManager implements SwapManagerClient {
      * If fallback polling is active, this triggers an immediate poll and resets
      * fallback delay so newly-added swaps are checked without waiting.
      */
-    addSwap(swap: PendingSwap): Promise<void>;
+    addSwap(swap: BoltzSwap): Promise<void>;
     /**
      * Remove a swap from monitoring
      */
@@ -588,7 +585,7 @@ declare class SwapManager implements SwapManagerClient {
     /**
      * Get all currently monitored swaps
      */
-    getPendingSwaps(): Promise<PendingSwap[]>;
+    getPendingSwaps(): Promise<BoltzSwap[]>;
     /**
      * Subscribe to updates for a specific swap
      * Returns an unsubscribe function
@@ -727,15 +724,15 @@ declare class SwapManager implements SwapManagerClient {
 type GetSwapsFilter = {
     id?: string | string[];
     status?: BoltzSwapStatus | BoltzSwapStatus[];
-    type?: PendingSwap["type"] | PendingSwap["type"][];
+    type?: BoltzSwap["type"] | BoltzSwap["type"][];
     orderBy?: "createdAt";
     orderDirection?: "asc" | "desc";
 };
 interface SwapRepository extends AsyncDisposable {
     readonly version: 1;
-    saveSwap<T extends PendingSwap>(swap: T): Promise<void>;
+    saveSwap<T extends BoltzSwap>(swap: T): Promise<void>;
     deleteSwap(id: string): Promise<void>;
-    getAllSwaps<T extends PendingSwap>(filter?: GetSwapsFilter): Promise<T[]>;
+    getAllSwaps<T extends BoltzSwap>(filter?: GetSwapsFilter): Promise<T[]>;
     clear(): Promise<void>;
 }
 
@@ -770,7 +767,7 @@ interface ArkToBtcResponse {
     /** Amount in satoshis to send to the lockup address. */
     amountToPay: number;
     /** The pending chain swap object for monitoring. */
-    pendingSwap: PendingChainSwap;
+    pendingSwap: BoltzChainSwap;
 }
 /** Response from creating a BTC → ARK chain swap. */
 interface BtcToArkResponse {
@@ -779,7 +776,7 @@ interface BtcToArkResponse {
     /** Amount in satoshis to send to the lockup address. */
     amountToPay: number;
     /** The pending chain swap object for monitoring. */
-    pendingSwap: PendingChainSwap;
+    pendingSwap: BoltzChainSwap;
 }
 /** Request to create a Lightning invoice (reverse swap: Lightning → Arkade). */
 interface CreateLightningInvoiceRequest {
@@ -799,7 +796,7 @@ interface CreateLightningInvoiceResponse {
     /** The payment hash (hex-encoded). */
     paymentHash: string;
     /** The pending reverse swap for monitoring. */
-    pendingSwap: PendingReverseSwap;
+    pendingSwap: BoltzReverseSwap;
     /** The preimage (hex-encoded). Keep secret until claiming. */
     preimage: string;
 }
@@ -818,7 +815,7 @@ interface SendLightningPaymentResponse {
     txid: string;
 }
 /** Tracks an in-progress reverse swap (Lightning → Arkade). */
-interface PendingReverseSwap {
+interface BoltzReverseSwap {
     /** Unique swap ID from Boltz. */
     id: string;
     /** Discriminator — always "reverse". */
@@ -835,7 +832,7 @@ interface PendingReverseSwap {
     response: CreateReverseSwapResponse;
 }
 /** Tracks an in-progress submarine swap (Arkade → Lightning). */
-interface PendingSubmarineSwap {
+interface BoltzSubmarineSwap {
     /** Unique swap ID from Boltz. */
     id: string;
     /** Discriminator — always "submarine". */
@@ -858,7 +855,7 @@ interface PendingSubmarineSwap {
     response: CreateSubmarineSwapResponse;
 }
 /** Tracks an in-progress chain swap (ARK ↔ BTC). */
-interface PendingChainSwap {
+interface BoltzChainSwap {
     /** Unique swap ID from Boltz. */
     id: string;
     /** Discriminator — always "chain". */
@@ -883,7 +880,7 @@ interface PendingChainSwap {
     amount: number;
 }
 /** Union type of all pending swap types. */
-type PendingSwap = PendingReverseSwap | PendingSubmarineSwap | PendingChainSwap;
+type BoltzSwap = BoltzReverseSwap | BoltzSubmarineSwap | BoltzChainSwap;
 /** Configuration for initializing ArkadeSwaps via the constructor (swapProvider is required). */
 interface ArkadeSwapsConfig {
     /** An IWallet instance from @arkade-os/sdk (must expose arkProvider and indexerProvider). */
@@ -992,4 +989,4 @@ interface ChainFeesResponse {
     };
 }
 
-export { type SwapManagerCallbacks as $, type ArkadeSwapsConfig as A, type BtcToArkResponse as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, isReverseFailedStatus as E, type FeesResponse as F, type GetSwapStatusResponse as G, isReverseFinalStatus as H, isReversePendingStatus as I, isReverseSuccessStatus as J, isReverseSwapClaimable as K, type LimitsResponse as L, isSubmarineFailedStatus as M, type Network as N, isSubmarineFinalStatus as O, type PendingSwap as P, isSubmarinePendingStatus as Q, isSubmarineSuccessStatus as R, type SendLightningPaymentRequest as S, isSubmarineRefundableStatus as T, isSubmarineSwapRefundable as U, SwapManager as V, type IncomingPaymentSubscription as W, type ArkadeSwapsCreateConfig as X, type Vtxo as Y, type SwapManagerConfig as Z, type SwapManagerEvents as _, type PendingChainSwap as a, type PendingReverseSwap as b, type PendingSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SendLightningPaymentResponse as f, type ChainFeesResponse as g, type ArkToBtcResponse as h, type SwapRepository as i, type SwapManagerClient as j, type GetSwapsFilter as k, BoltzSwapProvider as l, type BoltzSwapStatus as m, isChainClaimableStatus as n, isChainFailedStatus as o, isChainFinalStatus as p, isChainPendingStatus as q, isChainRefundableStatus as r, isChainSignableStatus as s, isChainSuccessStatus as t, isChainSwapClaimable as u, isChainSwapRefundable as v, isPendingChainSwap as w, isPendingReverseSwap as x, isPendingSubmarineSwap as y, isReverseClaimableStatus as z };
+export { type SwapManagerCallbacks as $, type ArkadeSwapsConfig as A, type BoltzSwap as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, isReverseClaimableStatus as E, type FeesResponse as F, type GetSwapStatusResponse as G, isReverseFailedStatus as H, isReverseFinalStatus as I, isReversePendingStatus as J, isReverseSuccessStatus as K, type LimitsResponse as L, isReverseSwapClaimable as M, type Network as N, isSubmarineFailedStatus as O, isSubmarineFinalStatus as P, isSubmarinePendingStatus as Q, isSubmarineSuccessStatus as R, type SendLightningPaymentRequest as S, isSubmarineRefundableStatus as T, isSubmarineSwapRefundable as U, SwapManager as V, type IncomingPaymentSubscription as W, type ArkadeSwapsCreateConfig as X, type Vtxo as Y, type SwapManagerConfig as Z, type SwapManagerEvents as _, type BoltzChainSwap as a, type BoltzReverseSwap as b, type BoltzSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SendLightningPaymentResponse as f, type ChainFeesResponse as g, type ArkToBtcResponse as h, type BtcToArkResponse as i, type SwapRepository as j, type SwapManagerClient as k, type GetSwapsFilter as l, BoltzSwapProvider as m, type BoltzSwapStatus as n, isChainClaimableStatus as o, isChainFailedStatus as p, isChainFinalStatus as q, isChainPendingStatus as r, isChainRefundableStatus as s, isChainSignableStatus as t, isChainSuccessStatus as u, isChainSwapClaimable as v, isChainSwapRefundable as w, isPendingChainSwap as x, isPendingReverseSwap as y, isPendingSubmarineSwap as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/boltz-swap",
-  "version": "0.3.13",
+  "version": "0.3.15",
   "type": "module",
   "description": "A production-ready TypeScript package that brings Boltz submarine-swaps to Arkade.",
   "main": "./dist/index.js",
@@ -60,7 +60,7 @@
   "author": "Arkade-OS",
   "license": "MIT",
   "dependencies": {
-    "@arkade-os/sdk": "0.4.14",
+    "@arkade-os/sdk": "0.4.15",
     "@noble/hashes": "2.0.1",
     "@scure/base": "2.0.0",
     "@scure/btc-signer": "2.0.1",
@@ -96,21 +96,15 @@
     "lint": "prettier --check src test",
     "test": "vitest run",
     "test:unit": "vitest run --exclude test/e2e",
-    "test:setup": "test/setupRegtestEnv.sh",
     "test:integration": "vitest run test/e2e/**",
-    "test:down": "test/setupRegtestEnv.sh down",
-    "test:build-docker": "docker compose -f test.docker-compose.yml build --no-cache",
-    "test:up-docker": "docker compose -f test.docker-compose.yml up arkd arkd-wallet nbxplorer pgnbxplorer -d",
     "test:setup-docker": "node test/e2e/setup.mjs",
     "test:integration-docker": "vitest run test/e2e/**",
-    "test:down-docker": "docker compose -f test.docker-compose.yml down -v",
     "release": "pnpm run build && bash scripts/release.sh",
     "release:dry-run": "bash scripts/release.sh --dry-run",
     "release:cleanup": "bash scripts/release.sh --cleanup",
-    "regtest": "pnpm regtest:down && pnpm regtest:build && pnpm regtest:up && pnpm regtest:setup",
-    "regtest:build": "docker compose -f test.docker-compose.yml build",
-    "regtest:up": "docker compose -f test.docker-compose.yml up arkd arkd-wallet nbxplorer pgnbxplorer -d",
-    "regtest:down": "docker compose -f test.docker-compose.yml down -v",
-    "regtest:setup": "node test/e2e/setup.mjs"
+    "regtest:start": "./regtest/start-env.sh",
+    "regtest:stop": "./regtest/stop-env.sh",
+    "regtest:clean": "./regtest/clean-env.sh",
+    "regtest": "pnpm regtest:clean && pnpm regtest:start && pnpm test:setup-docker"
   }
 }