@atomiqlabs/sdk 8.9.1 → 8.9.2

package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts

@@ -1,252 +1,252 @@
-/// <reference types="node" />
-import { ToBTCLNSwap } from "./ToBTCLNSwap";
-import { IToBTCDefinition, IToBTCWrapper } from "../IToBTCWrapper";
-import { ChainType, SwapCommitState } from "@atomiqlabs/base";
-import { Intermediary } from "../../../../intermediaries/Intermediary";
-import { ISwapWrapperOptions, WrapperCtorTokens } from "../../../ISwapWrapper";
-import { ISwapPrice } from "../../../../prices/abstract/ISwapPrice";
-import { EventEmitter } from "events";
-import { SwapType } from "../../../../enums/SwapType";
-import { IntermediaryAPI } from "../../../../intermediaries/apis/IntermediaryAPI";
-import { UnifiedSwapEventListener } from "../../../../events/UnifiedSwapEventListener";
-import { UnifiedSwapStorage } from "../../../../storage/UnifiedSwapStorage";
-import { ISwap } from "../../../ISwap";
-import { AmountData } from "../../../../types/AmountData";
-import { LNURLPayParamsWithUrl } from "../../../../types/lnurl/LNURLPay";
-import { AllOptional } from "../../../../utils/TypeUtils";
-import { LightningInvoiceCreateService } from "../../../../types/wallets/LightningInvoiceCreateService";
-export type ToBTCLNOptions = {
-    /**
-     * HTLC expiration timeout in seconds to use when offering the HTLC to the LP. Larger expirations mean that more
-     *  lightning network payment paths can be considered (every hop in the lightning network payment adds additional
-     *  timeout requirement). On the other side, larger expiration also means that user's funds are locked for longer
-     *  in case of a non-cooperative LP.
-     *
-     * Uses 5 days as default.
-     */
-    expirySeconds?: number;
-    /**
-     * Maximum fee for routing the swap output payment through the lightning network. Higher fee percentages means that
-     *  more payment routes can be considered (every hop in the lightning network payment adds additional fee
-     *  requirements).
-     *
-     * The fee is express as percentage of the swap value, uses `0.2` by default which means the maximum
-     *  routing fee is capped at 0.2% of the swap value.
-     *
-     * The full fee also contains the base component (set by `maxRoutingBaseFee` option), the resulting maximum routing
-     *  fee rate is:
-     *
-     * `maxRoutingFee` = `maxRoutingBaseFee` sats + `value` * `maxRoutingFeePercentage`%
-     */
-    maxRoutingFeePercentage?: number;
-    /**
-     *
-     * Maximum base fee (in sats) for routing the swap output payment through the lightning network. Higher fee
-     *  percentages means that more payment routes can be considered (every hop in the lightning network payment adds additional fee
-     *  requirements).
-     *
-     * Uses 10 sats as a default.
-     *
-     * The full fee also contains the value percentage component (set by `maxRoutingFeePercentage` option), the
-     *  resulting maximum routing fee rate is:
-     *
-     * `maxRoutingFee` = `maxRoutingBaseFee` sats + (`value` * `maxRoutingFeePercentage`%)
-     */
-    maxRoutingBaseFee?: bigint;
-    /**
-     * @deprecated Use `maxRoutingFeePercentage` and express the routing fee in percentage instead!
-     */
-    maxRoutingPPM?: bigint;
-    /**
-     * @deprecated Adjust fee with `maxRoutingFeePercentage` & `maxRoutingBaseFee` params!
-     */
-    maxFee?: bigint | Promise<bigint>;
-    /**
-     * @deprecated Pass desired HTLC expiration timeout as `expirySeconds`
-     */
-    expiryTimestamp?: bigint;
-};
-export type ToBTCLNWrapperOptions = ISwapWrapperOptions & {
-    lightningBaseFee: number;
-    lightningFeePPM: number;
-    paymentTimeoutSeconds: number;
-};
-export type ToBTCLNDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCLNWrapper<T>, ToBTCLNSwap<T>>;
-/**
- * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
- *
- * @category Swaps/Smart chain → Lightning
- */
-export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCLNDefinition<T>, ToBTCLNWrapperOptions> {
-    readonly TYPE: SwapType.TO_BTCLN;
-    /**
-     * @internal
-     */
-    readonly _swapDeserializer: typeof ToBTCLNSwap;
-    constructor(chainIdentifier: string, unifiedStorage: UnifiedSwapStorage<T>, unifiedChainEvents: UnifiedSwapEventListener<T>, chain: T["ChainInterface"], prices: ISwapPrice, tokens: WrapperCtorTokens, versionedContracts: {
-        [version: string]: {
-            swapContract: T["Contract"];
-            swapDataConstructor: new (data: any) => T["Data"];
-        };
-    }, lpApi: IntermediaryAPI, options?: AllOptional<ToBTCLNWrapperOptions>, events?: EventEmitter<{
-        swapState: [ISwap];
-    }>);
-    private toRequiredSwapOptions;
-    /**
-     * Verifies whether a given payment hash was already paid by checking the local
-     *  storage of known swaps
-     *
-     * @param paymentHash Payment hash to check
-     *
-     * @private
-     */
-    private checkPaymentHashWasPaid;
-    /**
-     * Calculates maximum lightning network routing fee based on amount
-     *
-     * @param amount BTC amount of the swap in satoshis
-     * @param overrideBaseFee Override wrapper's default base fee
-     * @param overrideFeePPM Override wrapper's default PPM
-     *
-     * @returns Maximum lightning routing fee in sats
-     *
-     * @private
-     */
-    private calculateFeeForAmount;
-    /**
-     * Verifies returned LP data
-     *
-     * @param signer
-     * @param resp Response as returned by the LP
-     * @param parsedPr Parsed bolt11 lightning invoice
-     * @param token Smart chain token to be used in the swap
-     * @param lp
-     * @param calculatedOptions Swap options computed from the swap create options
-     * @param data Parsed swap data returned by the LP
-     * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
-     *
-     * @throws {IntermediaryError} In case the response is not valid
-     *
-     * @private
-     */
-    private verifyReturnedData;
-    /**
-     * Returns the quote/swap from a given intermediary
-     *
-     * @param signer Smartchain signer initiating the swap
-     * @param amountData
-     * @param lp Intermediary
-     * @param pr bolt11 lightning network invoice
-     * @param parsedPr Parsed bolt11 lightning network invoice
-     * @param calculatedOptions Swap options computed from the swap create options
-     * @param preFetches
-     * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
-     *  it is extended with extendAbortController and then used
-     * @param additionalParams Additional params that should be sent to the LP
-     *
-     * @private
-     */
-    private getIntermediaryQuote;
-    /**
-     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol,
-     *  the amount is parsed from the provided lightning network payment request (bolt11 invoice)
-     *
-     * @param signer Source chain signer address initiating the swap
-     * @param recipient BOLT11 payment request (bitcoin lightning invoice) you wish to pay
-     * @param amountData Token to swap
-     * @param lps An array of intermediaries (LPs) to get the quotes from
-     * @param options Optional additional quote options
-     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
-     * @param abortSignal Abort signal
-     * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
-     */
-    create(signer: string, recipient: string, amountData: Omit<AmountData, "amount"> & {
-        exactIn: false;
-    }, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal, preFetches?: {
-        feeRatePromise: {
-            [contractVersion: string]: Promise<string | undefined>;
-        };
-        pricePreFetchPromise: Promise<bigint | undefined>;
-        usdPricePrefetchPromise: Promise<number | undefined>;
-        signDataPrefetchPromise?: {
-            [contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined;
-        };
-    }): Promise<{
-        quote: Promise<ToBTCLNSwap<T>>;
-        intermediary: Intermediary;
-    }[]>;
-    /**
-     * Parses and fetches lnurl pay params from the specified lnurl
-     *
-     * @param lnurl LNURL to be parsed and fetched
-     * @param abortSignal Abort signal
-     * @throws {UserError} if the LNURL is invalid or if it's not a LNURL-pay
-     *
-     * @private
-     */
-    private getLNURLPay;
-    /**
-     * Returns the quote/swap from the given LP
-     *
-     * @param signer Source chain signer address initiating the swap
-     * @param amountData Token to swap
-     * @param invoiceCreateService Service for creating fixed amount invoices
-     * @param lp Intermediary (LPs) to get the quote from
-     * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
-     *  network fees for an actual invoice
-     * @param calculatedOptions Swap options computed from the swap create options
-     * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
-     * @param abortSignal Abort signal
-     * @param additionalParams Additional params to be sent to the intermediary
-     *
-     * @private
-     */
-    private getIntermediaryQuoteExactIn;
-    /**
-     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol via
-     *  invoice creation service. This allows exactIn swaps by requesting the desired fixed amount lightning
-     *  network invoice from the service.
-     *
-     * @param signer Source chain signer address initiating the swap
-     * @param invoiceCreateServicePromise Service to request destination lightning network invoices from
-     * @param amountData Amount, token and exact input/output data for to swap
-     * @param lps An array of intermediaries (LPs) to get the quotes from
-     * @param options Optional additional quote options
-     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
-     * @param abortSignal Abort signal
-     */
-    createViaInvoiceCreateService(signer: string, invoiceCreateServicePromise: Promise<LightningInvoiceCreateService>, amountData: AmountData, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal): Promise<{
-        quote: Promise<ToBTCLNSwap<T>>;
-        intermediary: Intermediary;
-    }[]>;
-    /**
-     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol. Pays to
-     *  an LNURL-pay link. This allows exactIn swaps by requesting the desired fixed amount lightning
-     *  network invoice from the LNURL service.
-     *
-     * @param signer Source chain signer address initiating the swap
-     * @param lnurl LNURL-pay link of the recipient
-     * @param amountData Amount, token and exact input/output data for to swap
-     * @param lps An array of intermediaries (LPs) to get the quotes from
-     * @param options Optional additional quote options
-     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
-     * @param abortSignal Abort signal
-     */
-    createViaLNURL(signer: string, lnurl: string | LNURLPayParamsWithUrl, amountData: AmountData, lps: Intermediary[], options?: ToBTCLNOptions & {
-        comment?: string;
-    }, additionalParams?: Record<string, any>, abortSignal?: AbortSignal): Promise<{
-        quote: Promise<ToBTCLNSwap<T>>;
-        intermediary: Intermediary;
-    }[]>;
-    /**
-     * @inheritDoc
-     */
-    recoverFromSwapDataAndState(init: {
-        data: T["Data"];
-        getInitTxId: () => Promise<string>;
-        getTxBlock: () => Promise<{
-            blockTime: number;
-            blockHeight: number;
-        }>;
-    }, state: SwapCommitState, contractVersion: string, lp?: Intermediary): Promise<ToBTCLNSwap<T> | null>;
-}
+/// <reference types="node" />
+import { ToBTCLNSwap } from "./ToBTCLNSwap";
+import { IToBTCDefinition, IToBTCWrapper } from "../IToBTCWrapper";
+import { ChainType, SwapCommitState } from "@atomiqlabs/base";
+import { Intermediary } from "../../../../intermediaries/Intermediary";
+import { ISwapWrapperOptions, WrapperCtorTokens } from "../../../ISwapWrapper";
+import { ISwapPrice } from "../../../../prices/abstract/ISwapPrice";
+import { EventEmitter } from "events";
+import { SwapType } from "../../../../enums/SwapType";
+import { IntermediaryAPI } from "../../../../intermediaries/apis/IntermediaryAPI";
+import { UnifiedSwapEventListener } from "../../../../events/UnifiedSwapEventListener";
+import { UnifiedSwapStorage } from "../../../../storage/UnifiedSwapStorage";
+import { ISwap } from "../../../ISwap";
+import { AmountData } from "../../../../types/AmountData";
+import { LNURLPayParamsWithUrl } from "../../../../types/lnurl/LNURLPay";
+import { AllOptional } from "../../../../utils/TypeUtils";
+import { LightningInvoiceCreateService } from "../../../../types/wallets/LightningInvoiceCreateService";
+export type ToBTCLNOptions = {
+    /**
+     * HTLC expiration timeout in seconds to use when offering the HTLC to the LP. Larger expirations mean that more
+     *  lightning network payment paths can be considered (every hop in the lightning network payment adds additional
+     *  timeout requirement). On the other side, larger expiration also means that user's funds are locked for longer
+     *  in case of a non-cooperative LP.
+     *
+     * Uses 5 days as default.
+     */
+    expirySeconds?: number;
+    /**
+     * Maximum fee for routing the swap output payment through the lightning network. Higher fee percentages means that
+     *  more payment routes can be considered (every hop in the lightning network payment adds additional fee
+     *  requirements).
+     *
+     * The fee is express as percentage of the swap value, uses `0.2` by default which means the maximum
+     *  routing fee is capped at 0.2% of the swap value.
+     *
+     * The full fee also contains the base component (set by `maxRoutingBaseFee` option), the resulting maximum routing
+     *  fee rate is:
+     *
+     * `maxRoutingFee` = `maxRoutingBaseFee` sats + `value` * `maxRoutingFeePercentage`%
+     */
+    maxRoutingFeePercentage?: number;
+    /**
+     *
+     * Maximum base fee (in sats) for routing the swap output payment through the lightning network. Higher fee
+     *  percentages means that more payment routes can be considered (every hop in the lightning network payment adds additional fee
+     *  requirements).
+     *
+     * Uses 10 sats as a default.
+     *
+     * The full fee also contains the value percentage component (set by `maxRoutingFeePercentage` option), the
+     *  resulting maximum routing fee rate is:
+     *
+     * `maxRoutingFee` = `maxRoutingBaseFee` sats + (`value` * `maxRoutingFeePercentage`%)
+     */
+    maxRoutingBaseFee?: bigint;
+    /**
+     * @deprecated Use `maxRoutingFeePercentage` and express the routing fee in percentage instead!
+     */
+    maxRoutingPPM?: bigint;
+    /**
+     * @deprecated Adjust fee with `maxRoutingFeePercentage` & `maxRoutingBaseFee` params!
+     */
+    maxFee?: bigint | Promise<bigint>;
+    /**
+     * @deprecated Pass desired HTLC expiration timeout as `expirySeconds`
+     */
+    expiryTimestamp?: bigint;
+};
+export type ToBTCLNWrapperOptions = ISwapWrapperOptions & {
+    lightningBaseFee: number;
+    lightningFeePPM: number;
+    paymentTimeoutSeconds: number;
+};
+export type ToBTCLNDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCLNWrapper<T>, ToBTCLNSwap<T>>;
+/**
+ * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
+ *
+ * @category Swaps/Smart chain → Lightning
+ */
+export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCLNDefinition<T>, ToBTCLNWrapperOptions> {
+    readonly TYPE: SwapType.TO_BTCLN;
+    /**
+     * @internal
+     */
+    readonly _swapDeserializer: typeof ToBTCLNSwap;
+    constructor(chainIdentifier: string, unifiedStorage: UnifiedSwapStorage<T>, unifiedChainEvents: UnifiedSwapEventListener<T>, chain: T["ChainInterface"], prices: ISwapPrice, tokens: WrapperCtorTokens, versionedContracts: {
+        [version: string]: {
+            swapContract: T["Contract"];
+            swapDataConstructor: new (data: any) => T["Data"];
+        };
+    }, lpApi: IntermediaryAPI, options?: AllOptional<ToBTCLNWrapperOptions>, events?: EventEmitter<{
+        swapState: [ISwap];
+    }>);
+    private toRequiredSwapOptions;
+    /**
+     * Verifies whether a given payment hash was already paid by checking the local
+     *  storage of known swaps
+     *
+     * @param paymentHash Payment hash to check
+     *
+     * @private
+     */
+    private checkPaymentHashWasPaid;
+    /**
+     * Calculates maximum lightning network routing fee based on amount
+     *
+     * @param amount BTC amount of the swap in satoshis
+     * @param overrideBaseFee Override wrapper's default base fee
+     * @param overrideFeePPM Override wrapper's default PPM
+     *
+     * @returns Maximum lightning routing fee in sats
+     *
+     * @private
+     */
+    private calculateFeeForAmount;
+    /**
+     * Verifies returned LP data
+     *
+     * @param signer
+     * @param resp Response as returned by the LP
+     * @param parsedPr Parsed bolt11 lightning invoice
+     * @param token Smart chain token to be used in the swap
+     * @param lp
+     * @param calculatedOptions Swap options computed from the swap create options
+     * @param data Parsed swap data returned by the LP
+     * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
+     *
+     * @throws {IntermediaryError} In case the response is not valid
+     *
+     * @private
+     */
+    private verifyReturnedData;
+    /**
+     * Returns the quote/swap from a given intermediary
+     *
+     * @param signer Smartchain signer initiating the swap
+     * @param amountData
+     * @param lp Intermediary
+     * @param pr bolt11 lightning network invoice
+     * @param parsedPr Parsed bolt11 lightning network invoice
+     * @param calculatedOptions Swap options computed from the swap create options
+     * @param preFetches
+     * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
+     *  it is extended with extendAbortController and then used
+     * @param additionalParams Additional params that should be sent to the LP
+     *
+     * @private
+     */
+    private getIntermediaryQuote;
+    /**
+     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol,
+     *  the amount is parsed from the provided lightning network payment request (bolt11 invoice)
+     *
+     * @param signer Source chain signer address initiating the swap
+     * @param recipient BOLT11 payment request (bitcoin lightning invoice) you wish to pay
+     * @param amountData Token to swap
+     * @param lps An array of intermediaries (LPs) to get the quotes from
+     * @param options Optional additional quote options
+     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
+     * @param abortSignal Abort signal
+     * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
+     */
+    create(signer: string, recipient: string, amountData: Omit<AmountData, "amount"> & {
+        exactIn: false;
+    }, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal, preFetches?: {
+        feeRatePromise: {
+            [contractVersion: string]: Promise<string | undefined>;
+        };
+        pricePreFetchPromise: Promise<bigint | undefined>;
+        usdPricePrefetchPromise: Promise<number | undefined>;
+        signDataPrefetchPromise?: {
+            [contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined;
+        };
+    }): Promise<{
+        quote: Promise<ToBTCLNSwap<T>>;
+        intermediary: Intermediary;
+    }[]>;
+    /**
+     * Parses and fetches lnurl pay params from the specified lnurl
+     *
+     * @param lnurl LNURL to be parsed and fetched
+     * @param abortSignal Abort signal
+     * @throws {UserError} if the LNURL is invalid or if it's not a LNURL-pay
+     *
+     * @private
+     */
+    private getLNURLPay;
+    /**
+     * Returns the quote/swap from the given LP
+     *
+     * @param signer Source chain signer address initiating the swap
+     * @param amountData Token to swap
+     * @param invoiceCreateService Service for creating fixed amount invoices
+     * @param lp Intermediary (LPs) to get the quote from
+     * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
+     *  network fees for an actual invoice
+     * @param calculatedOptions Swap options computed from the swap create options
+     * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
+     * @param abortSignal Abort signal
+     * @param additionalParams Additional params to be sent to the intermediary
+     *
+     * @private
+     */
+    private getIntermediaryQuoteExactIn;
+    /**
+     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol via
+     *  invoice creation service. This allows exactIn swaps by requesting the desired fixed amount lightning
+     *  network invoice from the service.
+     *
+     * @param signer Source chain signer address initiating the swap
+     * @param invoiceCreateServicePromise Service to request destination lightning network invoices from
+     * @param amountData Amount, token and exact input/output data for to swap
+     * @param lps An array of intermediaries (LPs) to get the quotes from
+     * @param options Optional additional quote options
+     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
+     * @param abortSignal Abort signal
+     */
+    createViaInvoiceCreateService(signer: string, invoiceCreateServicePromise: Promise<LightningInvoiceCreateService>, amountData: AmountData, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal): Promise<{
+        quote: Promise<ToBTCLNSwap<T>>;
+        intermediary: Intermediary;
+    }[]>;
+    /**
+     * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol. Pays to
+     *  an LNURL-pay link. This allows exactIn swaps by requesting the desired fixed amount lightning
+     *  network invoice from the LNURL service.
+     *
+     * @param signer Source chain signer address initiating the swap
+     * @param lnurl LNURL-pay link of the recipient
+     * @param amountData Amount, token and exact input/output data for to swap
+     * @param lps An array of intermediaries (LPs) to get the quotes from
+     * @param options Optional additional quote options
+     * @param additionalParams Optional additional parameters sent to the LP when creating the swap
+     * @param abortSignal Abort signal
+     */
+    createViaLNURL(signer: string, lnurl: string | LNURLPayParamsWithUrl, amountData: AmountData, lps: Intermediary[], options?: ToBTCLNOptions & {
+        comment?: string;
+    }, additionalParams?: Record<string, any>, abortSignal?: AbortSignal): Promise<{
+        quote: Promise<ToBTCLNSwap<T>>;
+        intermediary: Intermediary;
+    }[]>;
+    /**
+     * @inheritDoc
+     */
+    recoverFromSwapDataAndState(init: {
+        data: T["Data"];
+        getInitTxId: () => Promise<string>;
+        getTxBlock: () => Promise<{
+            blockTime: number;
+            blockHeight: number;
+        }>;
+    }, state: SwapCommitState, contractVersion: string, lp?: Intermediary): Promise<ToBTCLNSwap<T> | null>;
+}