@arkade-os/boltz-swap 0.2.13 → 0.2.14

package/dist/index.d.cts

@@ -69,6 +69,52 @@ type CreateReverseSwapResponse = {
         unilateralRefundWithoutReceiver: number;
     };
 };
+type Leaf = {
+    version: number;
+    output: string;
+};
+type Tree = {
+    claimLeaf: Leaf;
+    refundLeaf: Leaf;
+    refundWithoutBoltzLeaf: Leaf;
+    unilateralClaimLeaf: Leaf;
+    unilateralRefundLeaf: Leaf;
+    unilateralRefundWithoutBoltzLeaf: Leaf;
+};
+type Details = {
+    tree: Tree;
+    amount?: number;
+    keyIndex: number;
+    transaction?: {
+        id: string;
+        vout: number;
+    };
+    lockupAddress: string;
+    serverPublicKey: string;
+    timeoutBlockHeight: number;
+    preimageHash?: string;
+};
+type RestoredSubmarineSwap = {
+    to: "BTC";
+    id: string;
+    from: "ARK";
+    type: "submarine";
+    createdAt: number;
+    preimageHash: string;
+    status: BoltzSwapStatus;
+    refundDetails: Details;
+};
+type RestoredReverseSwap = {
+    to: "ARK";
+    id: string;
+    from: "BTC";
+    type: "reverse";
+    createdAt: number;
+    preimageHash: string;
+    status: BoltzSwapStatus;
+    claimDetails: Details;
+};
+type CreateSwapsRestoreResponse = (RestoredReverseSwap | RestoredSubmarineSwap)[];
 declare class BoltzSwapProvider {
     private readonly wsUrl;
     private readonly apiUrl;
@@ -90,6 +136,7 @@ declare class BoltzSwapProvider {
         checkpoint: Transaction;
     }>;
     monitorSwap(swapId: string, update: (type: BoltzSwapStatus, data?: any) => void): Promise<void>;
+    restoreSwaps(publicKey: string): Promise<CreateSwapsRestoreResponse>;
     private request;
 }
 
@@ -393,6 +440,8 @@ interface PendingSubmarineSwap {
     type: "submarine";
     createdAt: number;
     preimage?: string;
+    /** Original preimage hash from Boltz (available for restored swaps) */
+    preimageHash?: string;
     refunded?: boolean;
     refundable?: boolean;
     status: BoltzSwapStatus;
@@ -562,6 +611,46 @@ declare class ArkadeLightning {
     waitForSwapSettlement(pendingSwap: PendingSubmarineSwap): Promise<{
         preimage: string;
     }>;
+    /**
+     * Restore swaps from Boltz API.
+     *
+     * Note: restored swaps may lack local-only data such as the original
+     * Lightning invoice or preimage. They are intended primarily for
+     * display/monitoring and are not automatically wired into the SwapManager.
+     * Do not call `claimVHTLC` / `refundVHTLC` on them unless you have
+     * enriched the objects with the missing fields.
+     *
+     * @param boltzFees - Optional fees response to use for restoration.
+     * @returns An object containing arrays of restored reverse and submarine swaps.
+     */
+    restoreSwaps(boltzFees?: FeesResponse): Promise<{
+        reverseSwaps: PendingReverseSwap[];
+        submarineSwaps: PendingSubmarineSwap[];
+    }>;
+    /**
+     * Enrich a restored reverse swap with its preimage.
+     * This makes the swap claimable via `claimVHTLC`.
+     * Validates that the preimage hash matches the swap's expected preimageHash.
+     *
+     * @param swap - The restored reverse swap to enrich.
+     * @param preimage - The preimage (hex-encoded) for the swap.
+     * @returns The enriched swap object (same reference, mutated).
+     * @throws Error if the preimage does not match the swap's preimageHash.
+     */
+    enrichReverseSwapPreimage(swap: PendingReverseSwap, preimage: string): PendingReverseSwap;
+    /**
+     * Enrich a restored submarine swap with its invoice.
+     * This makes the swap refundable via `refundVHTLC`.
+     * Validates that the invoice is well-formed and its payment hash can be extracted.
+     * If the swap has a preimageHash (from restoration), validates that the invoice's
+     * payment hash matches.
+     *
+     * @param swap - The restored submarine swap to enrich.
+     * @param invoice - The Lightning invoice for the swap.
+     * @returns The enriched swap object (same reference, mutated).
+     * @throws Error if the invoice is invalid, cannot be decoded, or payment hash doesn't match.
+     */
+    enrichSubmarineSwapInvoice(swap: PendingSubmarineSwap, invoice: string): PendingSubmarineSwap;
     private claimVHTLCwithOffchainTx;
     private refundVHTLCwithOffchainTx;
     /**

package/dist/index.d.ts

@@ -69,6 +69,52 @@ type CreateReverseSwapResponse = {
         unilateralRefundWithoutReceiver: number;
     };
 };
+type Leaf = {
+    version: number;
+    output: string;
+};
+type Tree = {
+    claimLeaf: Leaf;
+    refundLeaf: Leaf;
+    refundWithoutBoltzLeaf: Leaf;
+    unilateralClaimLeaf: Leaf;
+    unilateralRefundLeaf: Leaf;
+    unilateralRefundWithoutBoltzLeaf: Leaf;
+};
+type Details = {
+    tree: Tree;
+    amount?: number;
+    keyIndex: number;
+    transaction?: {
+        id: string;
+        vout: number;
+    };
+    lockupAddress: string;
+    serverPublicKey: string;
+    timeoutBlockHeight: number;
+    preimageHash?: string;
+};
+type RestoredSubmarineSwap = {
+    to: "BTC";
+    id: string;
+    from: "ARK";
+    type: "submarine";
+    createdAt: number;
+    preimageHash: string;
+    status: BoltzSwapStatus;
+    refundDetails: Details;
+};
+type RestoredReverseSwap = {
+    to: "ARK";
+    id: string;
+    from: "BTC";
+    type: "reverse";
+    createdAt: number;
+    preimageHash: string;
+    status: BoltzSwapStatus;
+    claimDetails: Details;
+};
+type CreateSwapsRestoreResponse = (RestoredReverseSwap | RestoredSubmarineSwap)[];
 declare class BoltzSwapProvider {
     private readonly wsUrl;
     private readonly apiUrl;
@@ -90,6 +136,7 @@ declare class BoltzSwapProvider {
         checkpoint: Transaction;
     }>;
     monitorSwap(swapId: string, update: (type: BoltzSwapStatus, data?: any) => void): Promise<void>;
+    restoreSwaps(publicKey: string): Promise<CreateSwapsRestoreResponse>;
     private request;
 }
 
@@ -393,6 +440,8 @@ interface PendingSubmarineSwap {
     type: "submarine";
     createdAt: number;
     preimage?: string;
+    /** Original preimage hash from Boltz (available for restored swaps) */
+    preimageHash?: string;
     refunded?: boolean;
     refundable?: boolean;
     status: BoltzSwapStatus;
@@ -562,6 +611,46 @@ declare class ArkadeLightning {
     waitForSwapSettlement(pendingSwap: PendingSubmarineSwap): Promise<{
         preimage: string;
     }>;
+    /**
+     * Restore swaps from Boltz API.
+     *
+     * Note: restored swaps may lack local-only data such as the original
+     * Lightning invoice or preimage. They are intended primarily for
+     * display/monitoring and are not automatically wired into the SwapManager.
+     * Do not call `claimVHTLC` / `refundVHTLC` on them unless you have
+     * enriched the objects with the missing fields.
+     *
+     * @param boltzFees - Optional fees response to use for restoration.
+     * @returns An object containing arrays of restored reverse and submarine swaps.
+     */
+    restoreSwaps(boltzFees?: FeesResponse): Promise<{
+        reverseSwaps: PendingReverseSwap[];
+        submarineSwaps: PendingSubmarineSwap[];
+    }>;
+    /**
+     * Enrich a restored reverse swap with its preimage.
+     * This makes the swap claimable via `claimVHTLC`.
+     * Validates that the preimage hash matches the swap's expected preimageHash.
+     *
+     * @param swap - The restored reverse swap to enrich.
+     * @param preimage - The preimage (hex-encoded) for the swap.
+     * @returns The enriched swap object (same reference, mutated).
+     * @throws Error if the preimage does not match the swap's preimageHash.
+     */
+    enrichReverseSwapPreimage(swap: PendingReverseSwap, preimage: string): PendingReverseSwap;
+    /**
+     * Enrich a restored submarine swap with its invoice.
+     * This makes the swap refundable via `refundVHTLC`.
+     * Validates that the invoice is well-formed and its payment hash can be extracted.
+     * If the swap has a preimageHash (from restoration), validates that the invoice's
+     * payment hash matches.
+     *
+     * @param swap - The restored submarine swap to enrich.
+     * @param invoice - The Lightning invoice for the swap.
+     * @returns The enriched swap object (same reference, mutated).
+     * @throws Error if the invoice is invalid, cannot be decoded, or payment hash doesn't match.
+     */
+    enrichSubmarineSwapInvoice(swap: PendingSubmarineSwap, invoice: string): PendingSubmarineSwap;
     private claimVHTLCwithOffchainTx;
     private refundVHTLCwithOffchainTx;
     /**