@arkade-os/boltz-swap 0.3.40 → 0.3.42

package/dist/{types-D97i1LFu.d.cts → types-8NrCdOpS.d.cts}

@@ -25,6 +25,27 @@ declare const isSubmarineFinalStatus: (status: BoltzSwapStatus) => boolean;
 declare const isSubmarinePendingStatus: (status: BoltzSwapStatus) => boolean;
 /** Returns true if the submarine swap is eligible for refund. */
 declare const isSubmarineRefundableStatus: (status: BoltzSwapStatus) => boolean;
+/**
+ * Canonical progression of a successful submarine swap, in order. Failure
+ * statuses are intentionally absent. This defines relative ordering, NOT a
+ * guaranteed sequence: statuses can be skipped (e.g. "transaction.mempool"
+ * jumps straight to "invoice.pending" when Boltz accepts 0-conf, and a
+ * subscription only ever reports the current status). Consumers must treat
+ * any later status as implying the earlier ones — which is exactly what
+ * hasSubmarineStatusReached does.
+ */
+declare const SUBMARINE_STATUS_PROGRESSION: readonly ["swap.created", "invoice.set", "transaction.mempool", "transaction.confirmed", "invoice.pending", "invoice.paid", "transaction.claim.pending", "transaction.claimed"];
+/**
+ * A status in the successful submarine swap progression — the only valid
+ * targets for optimistic settlement resolution.
+ */
+type SubmarineProgressionStatus = (typeof SUBMARINE_STATUS_PROGRESSION)[number];
+/**
+ * Returns true if `status` is at or beyond `target` in the successful
+ * submarine swap progression. Returns false when the observed status is not
+ * part of the progression (e.g. failure statuses like "swap.expired").
+ */
+declare const hasSubmarineStatusReached: (status: BoltzSwapStatus, target: SubmarineProgressionStatus) => boolean;
 /** Returns true if the submarine swap completed successfully. */
 declare const isSubmarineSuccessStatus: (status: BoltzSwapStatus) => boolean;
 /** Returns true if the reverse swap failed. */
@@ -914,6 +935,22 @@ interface CreateLightningInvoiceResponse {
 interface SendLightningPaymentRequest {
     /** BOLT11-encoded Lightning invoice to pay. */
     invoice: string;
+    /**
+     * When the returned promise resolves (default "settled").
+     *
+     * - "settled": at the terminal "transaction.claimed" status, once Boltz
+     *   has swept the HTLC. The preimage is included in the response.
+     * - "funded": optimistically, as soon as the lockup transaction is
+     *   observed ("transaction.mempool" or any later status — statuses can be
+     *   skipped since subscriptions report only the current one). The sender's
+     *   funds are committed and the swap is refundable from this point, so
+     *   most wallets show the payment as "sent" here. No preimage is available
+     *   yet; monitoring continues in the background and keeps persisting
+     *   status updates until a terminal status, but a late failure no longer
+     *   rejects — keep the SwapManager enabled so refunds are handled
+     *   automatically.
+     */
+    waitFor?: "settled" | "funded";
 }
 /** Response after a successful Lightning payment. */
 interface SendLightningPaymentResponse {
@@ -924,6 +961,19 @@ interface SendLightningPaymentResponse {
     /** Transaction ID of the Arkade payment. */
     txid: string;
 }
+/**
+ * Response after a Lightning payment sent with `waitFor: "funded"` — the
+ * payment is in flight but may not be settled yet, so the preimage may not
+ * be available.
+ */
+interface OptimisticSendLightningPaymentResponse {
+    /** Amount paid in satoshis. */
+    amount: number;
+    /** Payment preimage (hex-encoded). Undefined when the call resolved before the swap settled. */
+    preimage?: string;
+    /** Transaction ID of the Arkade payment. */
+    txid: string;
+}
 /** Tracks an in-progress reverse swap (Lightning → Arkade). */
 interface BoltzReverseSwap {
     /** Unique swap ID from Boltz. */
@@ -1180,4 +1230,4 @@ interface ChainFeesResponse {
     };
 }
 
-export { isReverseFinalStatus as $, type ArkadeSwapsConfig as A, type BoltzSwap as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, type SwapManagerEvents as E, type FeesResponse as F, type GetSwapStatusResponse as G, isChainClaimableStatus as H, type IncomingPaymentSubscription as I, isChainFailedStatus as J, isChainFinalStatus as K, type LimitsResponse as L, isChainPendingStatus as M, type Network as N, isChainRefundableStatus as O, type PendingChainSwap as P, isChainSignableStatus as Q, isChainSuccessStatus as R, type SendLightningPaymentRequest as S, isChainSwapClaimable as T, isChainSwapRefundable as U, type Vtxo as V, isPendingChainSwap as W, isPendingReverseSwap as X, isPendingSubmarineSwap as Y, isReverseClaimableStatus as Z, isReverseFailedStatus as _, type BoltzChainSwap as a, isReversePendingStatus as a0, isReverseSuccessStatus as a1, isReverseSwapClaimable as a2, isSubmarineFailedStatus as a3, isSubmarineFinalStatus as a4, isSubmarinePendingStatus as a5, isSubmarineRefundableStatus as a6, isSubmarineSuccessStatus as a7, isSubmarineSwapRefundable as a8, type BoltzReverseSwap as b, type BoltzSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SendLightningPaymentResponse as f, type SubmarineRefundOutcome as g, type SubmarineRecoveryInfo as h, type SubmarineRecoveryResult as i, type ChainFeesResponse as j, type ArkToBtcResponse as k, type BtcToArkResponse as l, type ChainArkRefundOutcome as m, type SwapRepository as n, type SwapManagerClient as o, type GetSwapsFilter as p, type ArkadeSwapsCreateConfig as q, BoltzSwapProvider as r, type BoltzSwapStatus as s, type PendingReverseSwap as t, type PendingSubmarineSwap as u, type PendingSwap as v, type SubmarineRecoveryStatus as w, SwapManager as x, type SwapManagerCallbacks as y, type SwapManagerConfig as z };
+export { isPendingSubmarineSwap as $, type ArkadeSwapsConfig as A, type BoltzSwap as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, type SwapManagerConfig as E, type FeesResponse as F, type GetSwapStatusResponse as G, type SwapManagerEvents as H, type IncomingPaymentSubscription as I, hasSubmarineStatusReached as J, isChainClaimableStatus as K, type LimitsResponse as L, isChainFailedStatus as M, type Network as N, type OptimisticSendLightningPaymentResponse as O, type PendingChainSwap as P, isChainFinalStatus as Q, isChainPendingStatus as R, type SendLightningPaymentRequest as S, isChainRefundableStatus as T, isChainSignableStatus as U, type Vtxo as V, isChainSuccessStatus as W, isChainSwapClaimable as X, isChainSwapRefundable as Y, isPendingChainSwap as Z, isPendingReverseSwap as _, type BoltzChainSwap as a, isReverseClaimableStatus as a0, isReverseFailedStatus as a1, isReverseFinalStatus as a2, isReversePendingStatus as a3, isReverseSuccessStatus as a4, isReverseSwapClaimable as a5, isSubmarineFailedStatus as a6, isSubmarineFinalStatus as a7, isSubmarinePendingStatus as a8, isSubmarineRefundableStatus as a9, isSubmarineSuccessStatus as aa, isSubmarineSwapRefundable as ab, type BoltzReverseSwap as b, type BoltzSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SubmarineRefundOutcome as f, type SubmarineRecoveryInfo as g, type SubmarineRecoveryResult as h, type ChainFeesResponse as i, type ArkToBtcResponse as j, type BtcToArkResponse as k, type ChainArkRefundOutcome as l, type SwapRepository as m, type SwapManagerClient as n, type SendLightningPaymentResponse as o, type GetSwapsFilter as p, type ArkadeSwapsCreateConfig as q, BoltzSwapProvider as r, type BoltzSwapStatus as s, type PendingReverseSwap as t, type PendingSubmarineSwap as u, type PendingSwap as v, type SubmarineProgressionStatus as w, type SubmarineRecoveryStatus as x, SwapManager as y, type SwapManagerCallbacks as z };

package/dist/{types-D97i1LFu.d.ts → types-8NrCdOpS.d.ts}

@@ -25,6 +25,27 @@ declare const isSubmarineFinalStatus: (status: BoltzSwapStatus) => boolean;
 declare const isSubmarinePendingStatus: (status: BoltzSwapStatus) => boolean;
 /** Returns true if the submarine swap is eligible for refund. */
 declare const isSubmarineRefundableStatus: (status: BoltzSwapStatus) => boolean;
+/**
+ * Canonical progression of a successful submarine swap, in order. Failure
+ * statuses are intentionally absent. This defines relative ordering, NOT a
+ * guaranteed sequence: statuses can be skipped (e.g. "transaction.mempool"
+ * jumps straight to "invoice.pending" when Boltz accepts 0-conf, and a
+ * subscription only ever reports the current status). Consumers must treat
+ * any later status as implying the earlier ones — which is exactly what
+ * hasSubmarineStatusReached does.
+ */
+declare const SUBMARINE_STATUS_PROGRESSION: readonly ["swap.created", "invoice.set", "transaction.mempool", "transaction.confirmed", "invoice.pending", "invoice.paid", "transaction.claim.pending", "transaction.claimed"];
+/**
+ * A status in the successful submarine swap progression — the only valid
+ * targets for optimistic settlement resolution.
+ */
+type SubmarineProgressionStatus = (typeof SUBMARINE_STATUS_PROGRESSION)[number];
+/**
+ * Returns true if `status` is at or beyond `target` in the successful
+ * submarine swap progression. Returns false when the observed status is not
+ * part of the progression (e.g. failure statuses like "swap.expired").
+ */
+declare const hasSubmarineStatusReached: (status: BoltzSwapStatus, target: SubmarineProgressionStatus) => boolean;
 /** Returns true if the submarine swap completed successfully. */
 declare const isSubmarineSuccessStatus: (status: BoltzSwapStatus) => boolean;
 /** Returns true if the reverse swap failed. */
@@ -914,6 +935,22 @@ interface CreateLightningInvoiceResponse {
 interface SendLightningPaymentRequest {
     /** BOLT11-encoded Lightning invoice to pay. */
     invoice: string;
+    /**
+     * When the returned promise resolves (default "settled").
+     *
+     * - "settled": at the terminal "transaction.claimed" status, once Boltz
+     *   has swept the HTLC. The preimage is included in the response.
+     * - "funded": optimistically, as soon as the lockup transaction is
+     *   observed ("transaction.mempool" or any later status — statuses can be
+     *   skipped since subscriptions report only the current one). The sender's
+     *   funds are committed and the swap is refundable from this point, so
+     *   most wallets show the payment as "sent" here. No preimage is available
+     *   yet; monitoring continues in the background and keeps persisting
+     *   status updates until a terminal status, but a late failure no longer
+     *   rejects — keep the SwapManager enabled so refunds are handled
+     *   automatically.
+     */
+    waitFor?: "settled" | "funded";
 }
 /** Response after a successful Lightning payment. */
 interface SendLightningPaymentResponse {
@@ -924,6 +961,19 @@ interface SendLightningPaymentResponse {
     /** Transaction ID of the Arkade payment. */
     txid: string;
 }
+/**
+ * Response after a Lightning payment sent with `waitFor: "funded"` — the
+ * payment is in flight but may not be settled yet, so the preimage may not
+ * be available.
+ */
+interface OptimisticSendLightningPaymentResponse {
+    /** Amount paid in satoshis. */
+    amount: number;
+    /** Payment preimage (hex-encoded). Undefined when the call resolved before the swap settled. */
+    preimage?: string;
+    /** Transaction ID of the Arkade payment. */
+    txid: string;
+}
 /** Tracks an in-progress reverse swap (Lightning → Arkade). */
 interface BoltzReverseSwap {
     /** Unique swap ID from Boltz. */
@@ -1180,4 +1230,4 @@ interface ChainFeesResponse {
     };
 }
 
-export { isReverseFinalStatus as $, type ArkadeSwapsConfig as A, type BoltzSwap as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, type SwapManagerEvents as E, type FeesResponse as F, type GetSwapStatusResponse as G, isChainClaimableStatus as H, type IncomingPaymentSubscription as I, isChainFailedStatus as J, isChainFinalStatus as K, type LimitsResponse as L, isChainPendingStatus as M, type Network as N, isChainRefundableStatus as O, type PendingChainSwap as P, isChainSignableStatus as Q, isChainSuccessStatus as R, type SendLightningPaymentRequest as S, isChainSwapClaimable as T, isChainSwapRefundable as U, type Vtxo as V, isPendingChainSwap as W, isPendingReverseSwap as X, isPendingSubmarineSwap as Y, isReverseClaimableStatus as Z, isReverseFailedStatus as _, type BoltzChainSwap as a, isReversePendingStatus as a0, isReverseSuccessStatus as a1, isReverseSwapClaimable as a2, isSubmarineFailedStatus as a3, isSubmarineFinalStatus as a4, isSubmarinePendingStatus as a5, isSubmarineRefundableStatus as a6, isSubmarineSuccessStatus as a7, isSubmarineSwapRefundable as a8, type BoltzReverseSwap as b, type BoltzSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SendLightningPaymentResponse as f, type SubmarineRefundOutcome as g, type SubmarineRecoveryInfo as h, type SubmarineRecoveryResult as i, type ChainFeesResponse as j, type ArkToBtcResponse as k, type BtcToArkResponse as l, type ChainArkRefundOutcome as m, type SwapRepository as n, type SwapManagerClient as o, type GetSwapsFilter as p, type ArkadeSwapsCreateConfig as q, BoltzSwapProvider as r, type BoltzSwapStatus as s, type PendingReverseSwap as t, type PendingSubmarineSwap as u, type PendingSwap as v, type SubmarineRecoveryStatus as w, SwapManager as x, type SwapManagerCallbacks as y, type SwapManagerConfig as z };
+export { isPendingSubmarineSwap as $, type ArkadeSwapsConfig as A, type BoltzSwap as B, type CreateLightningInvoiceRequest as C, type DecodedInvoice as D, type SwapManagerConfig as E, type FeesResponse as F, type GetSwapStatusResponse as G, type SwapManagerEvents as H, type IncomingPaymentSubscription as I, hasSubmarineStatusReached as J, isChainClaimableStatus as K, type LimitsResponse as L, isChainFailedStatus as M, type Network as N, type OptimisticSendLightningPaymentResponse as O, type PendingChainSwap as P, isChainFinalStatus as Q, isChainPendingStatus as R, type SendLightningPaymentRequest as S, isChainRefundableStatus as T, isChainSignableStatus as U, type Vtxo as V, isChainSuccessStatus as W, isChainSwapClaimable as X, isChainSwapRefundable as Y, isPendingChainSwap as Z, isPendingReverseSwap as _, type BoltzChainSwap as a, isReverseClaimableStatus as a0, isReverseFailedStatus as a1, isReverseFinalStatus as a2, isReversePendingStatus as a3, isReverseSuccessStatus as a4, isReverseSwapClaimable as a5, isSubmarineFailedStatus as a6, isSubmarineFinalStatus as a7, isSubmarinePendingStatus as a8, isSubmarineRefundableStatus as a9, isSubmarineSuccessStatus as aa, isSubmarineSwapRefundable as ab, type BoltzReverseSwap as b, type BoltzSubmarineSwap as c, type Chain as d, type CreateLightningInvoiceResponse as e, type SubmarineRefundOutcome as f, type SubmarineRecoveryInfo as g, type SubmarineRecoveryResult as h, type ChainFeesResponse as i, type ArkToBtcResponse as j, type BtcToArkResponse as k, type ChainArkRefundOutcome as l, type SwapRepository as m, type SwapManagerClient as n, type SendLightningPaymentResponse as o, type GetSwapsFilter as p, type ArkadeSwapsCreateConfig as q, BoltzSwapProvider as r, type BoltzSwapStatus as s, type PendingReverseSwap as t, type PendingSubmarineSwap as u, type PendingSwap as v, type SubmarineProgressionStatus as w, type SubmarineRecoveryStatus as x, SwapManager as y, type SwapManagerCallbacks as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/boltz-swap",
-  "version": "0.3.40",
+  "version": "0.3.42",
   "type": "module",
   "description": "A production-ready TypeScript package that brings Boltz submarine-swaps to Arkade.",
   "main": "./dist/index.js",
@@ -76,7 +76,7 @@
     "@scure/btc-signer": "2.0.1",
     "bip68": "1.0.4",
     "light-bolt11-decoder": "3.2.0",
-    "@arkade-os/sdk": "0.4.35"
+    "@arkade-os/sdk": "0.4.37"
   },
   "peerDependencies": {
     "expo-task-manager": ">=3.0.0",