@atomiqlabs/lp-lib 16.1.0 → 16.1.1

package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.d.ts

@@ -1,28 +1,28 @@
-import { SwapData } from "@atomiqlabs/base";
-import { ToBtcBaseSwap } from "../ToBtcBaseSwap";
-export declare enum ToBtcSwapState {
-    REFUNDED = -3,
-    CANCELED = -2,
-    NON_PAYABLE = -1,
-    SAVED = 0,
-    COMMITED = 1,
-    BTC_SENDING = 2,
-    BTC_SENT = 3,
-    CLAIMED = 4
-}
-export declare class ToBtcSwapAbs<T extends SwapData = SwapData> extends ToBtcBaseSwap<T, ToBtcSwapState> {
-    sending: boolean;
-    readonly address: string;
-    readonly satsPerVbyte: bigint;
-    readonly nonce: bigint;
-    readonly requiredConfirmations: number;
-    readonly preferedConfirmationTarget: number;
-    btcRawTx: string;
-    txId: string;
-    constructor(chainIdentifier: string, address: string, amount: bigint, swapFee: bigint, swapFeeInToken: bigint, networkFee: bigint, networkFeeInToken: bigint, satsPerVbyte: bigint, nonce: bigint, requiredConfirmations: number, preferedConfirmationTarget: number);
-    constructor(obj: any);
-    serialize(): any;
-    isInitiated(): boolean;
-    isFailed(): boolean;
-    isSuccess(): boolean;
-}
+import { SwapData } from "@atomiqlabs/base";
+import { ToBtcBaseSwap } from "../ToBtcBaseSwap";
+export declare enum ToBtcSwapState {
+    REFUNDED = -3,
+    CANCELED = -2,
+    NON_PAYABLE = -1,
+    SAVED = 0,
+    COMMITED = 1,
+    BTC_SENDING = 2,
+    BTC_SENT = 3,
+    CLAIMED = 4
+}
+export declare class ToBtcSwapAbs<T extends SwapData = SwapData> extends ToBtcBaseSwap<T, ToBtcSwapState> {
+    sending: boolean;
+    readonly address: string;
+    readonly satsPerVbyte: bigint;
+    readonly nonce: bigint;
+    readonly requiredConfirmations: number;
+    readonly preferedConfirmationTarget: number;
+    btcRawTx: string;
+    txId: string;
+    constructor(chainIdentifier: string, address: string, amount: bigint, swapFee: bigint, swapFeeInToken: bigint, networkFee: bigint, networkFeeInToken: bigint, satsPerVbyte: bigint, nonce: bigint, requiredConfirmations: number, preferedConfirmationTarget: number);
+    constructor(obj: any);
+    serialize(): any;
+    isInitiated(): boolean;
+    isFailed(): boolean;
+    isSuccess(): boolean;
+}

package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.js

@@ -1,64 +1,64 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToBtcSwapAbs = exports.ToBtcSwapState = void 0;
-const index_1 = require("../../../index");
-const ToBtcBaseSwap_1 = require("../ToBtcBaseSwap");
-const Utils_1 = require("../../../utils/Utils");
-var ToBtcSwapState;
-(function (ToBtcSwapState) {
-    ToBtcSwapState[ToBtcSwapState["REFUNDED"] = -3] = "REFUNDED";
-    ToBtcSwapState[ToBtcSwapState["CANCELED"] = -2] = "CANCELED";
-    ToBtcSwapState[ToBtcSwapState["NON_PAYABLE"] = -1] = "NON_PAYABLE";
-    ToBtcSwapState[ToBtcSwapState["SAVED"] = 0] = "SAVED";
-    ToBtcSwapState[ToBtcSwapState["COMMITED"] = 1] = "COMMITED";
-    ToBtcSwapState[ToBtcSwapState["BTC_SENDING"] = 2] = "BTC_SENDING";
-    ToBtcSwapState[ToBtcSwapState["BTC_SENT"] = 3] = "BTC_SENT";
-    ToBtcSwapState[ToBtcSwapState["CLAIMED"] = 4] = "CLAIMED";
-})(ToBtcSwapState = exports.ToBtcSwapState || (exports.ToBtcSwapState = {}));
-class ToBtcSwapAbs extends ToBtcBaseSwap_1.ToBtcBaseSwap {
-    constructor(chainIdOrObj, address, amount, swapFee, swapFeeInToken, networkFee, networkFeeInToken, satsPerVbyte, nonce, requiredConfirmations, preferedConfirmationTarget) {
-        if (typeof (chainIdOrObj) === "string") {
-            super(chainIdOrObj, amount, swapFee, swapFeeInToken, networkFee, networkFeeInToken);
-            this.state = ToBtcSwapState.SAVED;
-            this.address = address;
-            this.satsPerVbyte = satsPerVbyte;
-            this.nonce = nonce;
-            this.requiredConfirmations = requiredConfirmations;
-            this.preferedConfirmationTarget = preferedConfirmationTarget;
-        }
-        else {
-            super(chainIdOrObj);
-            this.address = chainIdOrObj.address;
-            this.satsPerVbyte = BigInt(chainIdOrObj.satsPerVbyte);
-            this.nonce = BigInt(chainIdOrObj.nonce);
-            this.requiredConfirmations = chainIdOrObj.requiredConfirmations;
-            this.preferedConfirmationTarget = chainIdOrObj.preferedConfirmationTarget;
-            this.txId = chainIdOrObj.txId;
-            this.btcRawTx = chainIdOrObj.btcRawTx;
-            //Compatibility
-            this.quotedNetworkFee ?? (this.quotedNetworkFee = (0, Utils_1.deserializeBN)(chainIdOrObj.networkFee));
-        }
-        this.type = index_1.SwapHandlerType.TO_BTC;
-    }
-    serialize() {
-        const partialSerialized = super.serialize();
-        partialSerialized.address = this.address;
-        partialSerialized.satsPerVbyte = this.satsPerVbyte.toString(10);
-        partialSerialized.requiredConfirmations = this.requiredConfirmations;
-        partialSerialized.nonce = this.nonce.toString(10);
-        partialSerialized.preferedConfirmationTarget = this.preferedConfirmationTarget;
-        partialSerialized.txId = this.txId;
-        partialSerialized.btcRawTx = this.btcRawTx;
-        return partialSerialized;
-    }
-    isInitiated() {
-        return this.state !== ToBtcSwapState.SAVED;
-    }
-    isFailed() {
-        return this.state === ToBtcSwapState.NON_PAYABLE || this.state === ToBtcSwapState.REFUNDED || this.state === ToBtcSwapState.CANCELED;
-    }
-    isSuccess() {
-        return this.state === ToBtcSwapState.CLAIMED;
-    }
-}
-exports.ToBtcSwapAbs = ToBtcSwapAbs;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToBtcSwapAbs = exports.ToBtcSwapState = void 0;
+const index_1 = require("../../../index");
+const ToBtcBaseSwap_1 = require("../ToBtcBaseSwap");
+const Utils_1 = require("../../../utils/Utils");
+var ToBtcSwapState;
+(function (ToBtcSwapState) {
+    ToBtcSwapState[ToBtcSwapState["REFUNDED"] = -3] = "REFUNDED";
+    ToBtcSwapState[ToBtcSwapState["CANCELED"] = -2] = "CANCELED";
+    ToBtcSwapState[ToBtcSwapState["NON_PAYABLE"] = -1] = "NON_PAYABLE";
+    ToBtcSwapState[ToBtcSwapState["SAVED"] = 0] = "SAVED";
+    ToBtcSwapState[ToBtcSwapState["COMMITED"] = 1] = "COMMITED";
+    ToBtcSwapState[ToBtcSwapState["BTC_SENDING"] = 2] = "BTC_SENDING";
+    ToBtcSwapState[ToBtcSwapState["BTC_SENT"] = 3] = "BTC_SENT";
+    ToBtcSwapState[ToBtcSwapState["CLAIMED"] = 4] = "CLAIMED";
+})(ToBtcSwapState = exports.ToBtcSwapState || (exports.ToBtcSwapState = {}));
+class ToBtcSwapAbs extends ToBtcBaseSwap_1.ToBtcBaseSwap {
+    constructor(chainIdOrObj, address, amount, swapFee, swapFeeInToken, networkFee, networkFeeInToken, satsPerVbyte, nonce, requiredConfirmations, preferedConfirmationTarget) {
+        if (typeof (chainIdOrObj) === "string") {
+            super(chainIdOrObj, amount, swapFee, swapFeeInToken, networkFee, networkFeeInToken);
+            this.state = ToBtcSwapState.SAVED;
+            this.address = address;
+            this.satsPerVbyte = satsPerVbyte;
+            this.nonce = nonce;
+            this.requiredConfirmations = requiredConfirmations;
+            this.preferedConfirmationTarget = preferedConfirmationTarget;
+        }
+        else {
+            super(chainIdOrObj);
+            this.address = chainIdOrObj.address;
+            this.satsPerVbyte = BigInt(chainIdOrObj.satsPerVbyte);
+            this.nonce = BigInt(chainIdOrObj.nonce);
+            this.requiredConfirmations = chainIdOrObj.requiredConfirmations;
+            this.preferedConfirmationTarget = chainIdOrObj.preferedConfirmationTarget;
+            this.txId = chainIdOrObj.txId;
+            this.btcRawTx = chainIdOrObj.btcRawTx;
+            //Compatibility
+            this.quotedNetworkFee ?? (this.quotedNetworkFee = (0, Utils_1.deserializeBN)(chainIdOrObj.networkFee));
+        }
+        this.type = index_1.SwapHandlerType.TO_BTC;
+    }
+    serialize() {
+        const partialSerialized = super.serialize();
+        partialSerialized.address = this.address;
+        partialSerialized.satsPerVbyte = this.satsPerVbyte.toString(10);
+        partialSerialized.requiredConfirmations = this.requiredConfirmations;
+        partialSerialized.nonce = this.nonce.toString(10);
+        partialSerialized.preferedConfirmationTarget = this.preferedConfirmationTarget;
+        partialSerialized.txId = this.txId;
+        partialSerialized.btcRawTx = this.btcRawTx;
+        return partialSerialized;
+    }
+    isInitiated() {
+        return this.state !== ToBtcSwapState.SAVED;
+    }
+    isFailed() {
+        return this.state === ToBtcSwapState.NON_PAYABLE || this.state === ToBtcSwapState.REFUNDED || this.state === ToBtcSwapState.CANCELED;
+    }
+    isSuccess() {
+        return this.state === ToBtcSwapState.CLAIMED;
+    }
+}
+exports.ToBtcSwapAbs = ToBtcSwapAbs;

package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.d.ts

@@ -1,178 +1,178 @@
-import { Express } from "express";
-import { ToBtcLnSwapAbs, ToBtcLnSwapState } from "./ToBtcLnSwapAbs";
-import { MultichainData, SwapHandlerType } from "../../SwapHandler";
-import { ISwapPrice } from "../../../prices/ISwapPrice";
-import { ChainSwapType, ClaimEvent, InitializeEvent, RefundEvent, SwapData } from "@atomiqlabs/base";
-import { IIntermediaryStorage } from "../../../storage/IIntermediaryStorage";
-import { ToBtcBaseConfig, ToBtcBaseSwapHandler } from "../ToBtcBaseSwapHandler";
-import { ILightningWallet, ParsedPaymentRequest } from "../../../wallets/ILightningWallet";
-import { LightningAssertions } from "../../assertions/LightningAssertions";
-export type ToBtcLnConfig = ToBtcBaseConfig & {
-    routingFeeMultiplier: bigint;
-    minSendCltv: bigint;
-    allowProbeFailedSwaps: boolean;
-    allowShortExpiry: boolean;
-    minLnRoutingFeePPM?: bigint;
-    minLnBaseFee?: bigint;
-    exactInExpiry?: number;
-    lnSendBitcoinBlockTimeSafetyFactorPPM?: bigint;
-};
-type ExactInAuthorization = {
-    chainIdentifier: string;
-    reqId: string;
-    expiry: number;
-    amount: bigint;
-    initialInvoice: ParsedPaymentRequest;
-    quotedNetworkFeeInToken: bigint;
-    swapFeeInToken: bigint;
-    total: bigint;
-    confidence: number;
-    quotedNetworkFee: bigint;
-    swapFee: bigint;
-    token: string;
-    swapExpiry: bigint;
-    offerer: string;
-    preFetchSignData: any;
-    metadata: {
-        request: any;
-        probeRequest?: any;
-        probeResponse?: any;
-        routeResponse?: any;
-        times: {
-            [key: string]: number;
-        };
-    };
-};
-export type ToBtcLnRequestType = {
-    pr: string;
-    maxFee: bigint;
-    expiryTimestamp: bigint;
-    token: string;
-    offerer: string;
-    exactIn?: boolean;
-    amount?: bigint;
-};
-/**
- * Swap handler handling to BTCLN swaps using submarine swaps
- */
-export declare class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwapState> {
-    readonly type = SwapHandlerType.TO_BTCLN;
-    readonly swapType = ChainSwapType.HTLC;
-    readonly inflightSwapStates: Set<ToBtcLnSwapState>;
-    activeSubscriptions: Set<string>;
-    readonly config: ToBtcLnConfig & {
-        minTsSendCltv: bigint;
-    };
-    readonly exactInAuths: {
-        [reqId: string]: ExactInAuthorization;
-    };
-    readonly lightning: ILightningWallet;
-    readonly LightningAssertions: LightningAssertions;
-    constructor(storageDirectory: IIntermediaryStorage<ToBtcLnSwapAbs>, path: string, chainData: MultichainData, lightning: ILightningWallet, swapPricing: ISwapPrice, config: ToBtcLnConfig);
-    /**
-     * Cleans up exactIn authorization that are already past their expiry
-     *
-     * @protected
-     */
-    private cleanExpiredExactInAuthorizations;
-    protected processPastSwap(swap: ToBtcLnSwapAbs): Promise<void>;
-    /**
-     * Checks past swaps, deletes ones that are already expired, and tries to process ones that are committed.
-     */
-    protected processPastSwaps(): Promise<void>;
-    /**
-     * Tries to claim the swap funds on the SC side, returns false if the swap is already locked (claim tx is already being sent)
-     *
-     * @param swap
-     * @private
-     * @returns Whether the transaction was successfully sent
-     */
-    private tryClaimSwap;
-    /**
-     * Process the result of attempted lightning network payment
-     *
-     * @param swap
-     * @param lnPaymentStatus
-     */
-    private processPaymentResult;
-    /**
-     * Subscribe to a pending lightning network payment attempt
-     *
-     * @param invoiceData
-     */
-    private subscribeToPayment;
-    private sendLightningPayment;
-    /**
-     * Begins a lightning network payment attempt, if not attempted already
-     *
-     * @param swap
-     */
-    private processInitialized;
-    protected processInitializeEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: InitializeEvent<SwapData>): Promise<void>;
-    protected processClaimEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: ClaimEvent<SwapData>): Promise<void>;
-    protected processRefundEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: RefundEvent<SwapData>): Promise<void>;
-    /**
-     * Checks if the amount was supplied in the exactIn request
-     *
-     * @param amount
-     * @param exactIn
-     * @throws {DefinedRuntimeError} will throw an error if the swap was exactIn, but amount not specified
-     */
-    private checkAmount;
-    /**
-     * Checks if the maxFee parameter is in valid range (>0)
-     *
-     * @param maxFee
-     * @throws {DefinedRuntimeError} will throw an error if the maxFee is zero or negative
-     */
-    private checkMaxFee;
-    /**
-     * Checks and parses a payment request (bolt11 invoice), additionally also checks expiration time of the invoice
-     *
-     * @param chainIdentifier
-     * @param pr
-     * @throws {DefinedRuntimeError} will throw an error if the pr is invalid, without amount or expired
-     */
-    private checkPaymentRequest;
-    /**
-     * Checks if the request specified too short of an expiry
-     *
-     * @param expiryTimestamp
-     * @param currentTimestamp
-     * @throws {DefinedRuntimeError} will throw an error if the expiry time is too short
-     */
-    private checkExpiry;
-    /**
-     * Estimates the routing fee & confidence by either probing or routing (if probing fails), the fee is also adjusted
-     *  according to routing fee multiplier, and subject to minimums set in config
-     *
-     * @param amountBD
-     * @param maxFee
-     * @param expiryTimestamp
-     * @param currentTimestamp
-     * @param pr
-     * @param metadata
-     * @param abortSignal
-     * @throws {DefinedRuntimeError} will throw an error if the destination is unreachable
-     */
-    private checkAndGetNetworkFee;
-    /**
-     * Checks and consumes (deletes & returns) exactIn authorizaton with a specific reqId
-     *
-     * @param reqId
-     * @throws {DefinedRuntimeError} will throw an error if the authorization doesn't exist
-     */
-    private checkExactInAuthorization;
-    /**
-     * Checks if the newly submitted PR has the same parameters (destination, cltv_delta, routes) as the initial dummy
-     *  invoice sent for exactIn swap quote
-     *
-     * @param parsedRequest
-     * @param parsedAuth
-     */
-    private isPaymentRequestMatchingInitial;
-    startRestServer(restServer: Express): void;
-    init(): Promise<void>;
-    getInfoData(): any;
-}
-export {};
+import { Express } from "express";
+import { ToBtcLnSwapAbs, ToBtcLnSwapState } from "./ToBtcLnSwapAbs";
+import { MultichainData, SwapHandlerType } from "../../SwapHandler";
+import { ISwapPrice } from "../../../prices/ISwapPrice";
+import { ChainSwapType, ClaimEvent, InitializeEvent, RefundEvent, SwapData } from "@atomiqlabs/base";
+import { IIntermediaryStorage } from "../../../storage/IIntermediaryStorage";
+import { ToBtcBaseConfig, ToBtcBaseSwapHandler } from "../ToBtcBaseSwapHandler";
+import { ILightningWallet, ParsedPaymentRequest } from "../../../wallets/ILightningWallet";
+import { LightningAssertions } from "../../assertions/LightningAssertions";
+export type ToBtcLnConfig = ToBtcBaseConfig & {
+    routingFeeMultiplier: bigint;
+    minSendCltv: bigint;
+    allowProbeFailedSwaps: boolean;
+    allowShortExpiry: boolean;
+    minLnRoutingFeePPM?: bigint;
+    minLnBaseFee?: bigint;
+    exactInExpiry?: number;
+    lnSendBitcoinBlockTimeSafetyFactorPPM?: bigint;
+};
+type ExactInAuthorization = {
+    chainIdentifier: string;
+    reqId: string;
+    expiry: number;
+    amount: bigint;
+    initialInvoice: ParsedPaymentRequest;
+    quotedNetworkFeeInToken: bigint;
+    swapFeeInToken: bigint;
+    total: bigint;
+    confidence: number;
+    quotedNetworkFee: bigint;
+    swapFee: bigint;
+    token: string;
+    swapExpiry: bigint;
+    offerer: string;
+    preFetchSignData: any;
+    metadata: {
+        request: any;
+        probeRequest?: any;
+        probeResponse?: any;
+        routeResponse?: any;
+        times: {
+            [key: string]: number;
+        };
+    };
+};
+export type ToBtcLnRequestType = {
+    pr: string;
+    maxFee: bigint;
+    expiryTimestamp: bigint;
+    token: string;
+    offerer: string;
+    exactIn?: boolean;
+    amount?: bigint;
+};
+/**
+ * Swap handler handling to BTCLN swaps using submarine swaps
+ */
+export declare class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwapState> {
+    readonly type = SwapHandlerType.TO_BTCLN;
+    readonly swapType = ChainSwapType.HTLC;
+    readonly inflightSwapStates: Set<ToBtcLnSwapState>;
+    activeSubscriptions: Set<string>;
+    readonly config: ToBtcLnConfig & {
+        minTsSendCltv: bigint;
+    };
+    readonly exactInAuths: {
+        [reqId: string]: ExactInAuthorization;
+    };
+    readonly lightning: ILightningWallet;
+    readonly LightningAssertions: LightningAssertions;
+    constructor(storageDirectory: IIntermediaryStorage<ToBtcLnSwapAbs>, path: string, chainData: MultichainData, lightning: ILightningWallet, swapPricing: ISwapPrice, config: ToBtcLnConfig);
+    /**
+     * Cleans up exactIn authorization that are already past their expiry
+     *
+     * @protected
+     */
+    private cleanExpiredExactInAuthorizations;
+    protected processPastSwap(swap: ToBtcLnSwapAbs): Promise<void>;
+    /**
+     * Checks past swaps, deletes ones that are already expired, and tries to process ones that are committed.
+     */
+    protected processPastSwaps(): Promise<void>;
+    /**
+     * Tries to claim the swap funds on the SC side, returns false if the swap is already locked (claim tx is already being sent)
+     *
+     * @param swap
+     * @private
+     * @returns Whether the transaction was successfully sent
+     */
+    private tryClaimSwap;
+    /**
+     * Process the result of attempted lightning network payment
+     *
+     * @param swap
+     * @param lnPaymentStatus
+     */
+    private processPaymentResult;
+    /**
+     * Subscribe to a pending lightning network payment attempt
+     *
+     * @param invoiceData
+     */
+    private subscribeToPayment;
+    private sendLightningPayment;
+    /**
+     * Begins a lightning network payment attempt, if not attempted already
+     *
+     * @param swap
+     */
+    private processInitialized;
+    protected processInitializeEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: InitializeEvent<SwapData>): Promise<void>;
+    protected processClaimEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: ClaimEvent<SwapData>): Promise<void>;
+    protected processRefundEvent(chainIdentifier: string, swap: ToBtcLnSwapAbs, event: RefundEvent<SwapData>): Promise<void>;
+    /**
+     * Checks if the amount was supplied in the exactIn request
+     *
+     * @param amount
+     * @param exactIn
+     * @throws {DefinedRuntimeError} will throw an error if the swap was exactIn, but amount not specified
+     */
+    private checkAmount;
+    /**
+     * Checks if the maxFee parameter is in valid range (>0)
+     *
+     * @param maxFee
+     * @throws {DefinedRuntimeError} will throw an error if the maxFee is zero or negative
+     */
+    private checkMaxFee;
+    /**
+     * Checks and parses a payment request (bolt11 invoice), additionally also checks expiration time of the invoice
+     *
+     * @param chainIdentifier
+     * @param pr
+     * @throws {DefinedRuntimeError} will throw an error if the pr is invalid, without amount or expired
+     */
+    private checkPaymentRequest;
+    /**
+     * Checks if the request specified too short of an expiry
+     *
+     * @param expiryTimestamp
+     * @param currentTimestamp
+     * @throws {DefinedRuntimeError} will throw an error if the expiry time is too short
+     */
+    private checkExpiry;
+    /**
+     * Estimates the routing fee & confidence by either probing or routing (if probing fails), the fee is also adjusted
+     *  according to routing fee multiplier, and subject to minimums set in config
+     *
+     * @param amountBD
+     * @param maxFee
+     * @param expiryTimestamp
+     * @param currentTimestamp
+     * @param pr
+     * @param metadata
+     * @param abortSignal
+     * @throws {DefinedRuntimeError} will throw an error if the destination is unreachable
+     */
+    private checkAndGetNetworkFee;
+    /**
+     * Checks and consumes (deletes & returns) exactIn authorizaton with a specific reqId
+     *
+     * @param reqId
+     * @throws {DefinedRuntimeError} will throw an error if the authorization doesn't exist
+     */
+    private checkExactInAuthorization;
+    /**
+     * Checks if the newly submitted PR has the same parameters (destination, cltv_delta, routes) as the initial dummy
+     *  invoice sent for exactIn swap quote
+     *
+     * @param parsedRequest
+     * @param parsedAuth
+     */
+    private isPaymentRequestMatchingInitial;
+    startRestServer(restServer: Express): void;
+    init(): Promise<void>;
+    getInfoData(): any;
+}
+export {};