@atomiqlabs/sdk 8.8.3 → 8.8.4

package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts

@@ -1,68 +1,68 @@
-import { IToBTCSwap, ToBTCSwapState } from "./IToBTCSwap";
-import { ChainType, ClaimEvent, InitializeEvent, RefundEvent } from "@atomiqlabs/base";
-import { ISwapWrapperOptions, SwapTypeDefinition } from "../../ISwapWrapper";
-import { Intermediary, SingleChainReputationType } from "../../../intermediaries/Intermediary";
-import { IEscrowSwapWrapper } from "../IEscrowSwapWrapper";
-import { AmountData } from "../../../types/AmountData";
-export type IToBTCDefinition<T extends ChainType, W extends IToBTCWrapper<T, any>, S extends IToBTCSwap<T>> = SwapTypeDefinition<T, W, S>;
-/**
- * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
- *
- * @category Swaps/Smart chain → Bitcoin
- */
-export declare abstract class IToBTCWrapper<T extends ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends IEscrowSwapWrapper<T, D, O> {
-    /**
-     * @internal
-     */
-    protected readonly tickSwapState: ToBTCSwapState[];
-    /**
-     * @internal
-     */
-    readonly _pendingSwapStates: ToBTCSwapState[];
-    /**
-     * @internal
-     */
-    readonly _refundableSwapStates: ToBTCSwapState[];
-    /**
-     * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
-     *
-     * @param amountData
-     * @param lp Intermediary
-     * @param abortController
-     * @param contractVersion
-     * @returns Intermediary's reputation or null if failed
-     * @throws {IntermediaryError} If the intermediary vault doesn't exist
-     *
-     * @internal
-     */
-    protected preFetchIntermediaryReputation(amountData: Omit<AmountData, "amount">, lp: Intermediary, abortController: AbortController, contractVersion: string): Promise<SingleChainReputationType | undefined>;
-    /**
-     * Pre-fetches feeRate for a given swap
-     *
-     * @param signer Address of the swap initiator
-     * @param amountData
-     * @param claimHash optional hash of the swap or null
-     * @param abortController
-     * @param contractVersions
-     * @returns Fee rate
-     *
-     * @internal
-     */
-    protected preFetchFeeRate(signer: string, amountData: Omit<AmountData, "amount">, claimHash: {
-        [contractVersion: string]: string;
-    } | undefined, abortController: AbortController, contractVersions: string[]): {
-        [contractVersion: string]: Promise<string | undefined>;
-    };
-    /**
-     * @internal
-     */
-    protected processEventInitialize(swap: D["Swap"], event: InitializeEvent<T["Data"]>): Promise<boolean>;
-    /**
-     * @internal
-     */
-    protected processEventClaim(swap: D["Swap"], event: ClaimEvent<T["Data"]>): Promise<boolean>;
-    /**
-     * @internal
-     */
-    protected processEventRefund(swap: D["Swap"], event: RefundEvent<T["Data"]>): Promise<boolean>;
-}
+import { IToBTCSwap, ToBTCSwapState } from "./IToBTCSwap";
+import { ChainType, ClaimEvent, InitializeEvent, RefundEvent } from "@atomiqlabs/base";
+import { ISwapWrapperOptions, SwapTypeDefinition } from "../../ISwapWrapper";
+import { Intermediary, SingleChainReputationType } from "../../../intermediaries/Intermediary";
+import { IEscrowSwapWrapper } from "../IEscrowSwapWrapper";
+import { AmountData } from "../../../types/AmountData";
+export type IToBTCDefinition<T extends ChainType, W extends IToBTCWrapper<T, any>, S extends IToBTCSwap<T>> = SwapTypeDefinition<T, W, S>;
+/**
+ * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
+ *
+ * @category Swaps/Smart chain → Bitcoin
+ */
+export declare abstract class IToBTCWrapper<T extends ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends IEscrowSwapWrapper<T, D, O> {
+    /**
+     * @internal
+     */
+    protected readonly tickSwapState: ToBTCSwapState[];
+    /**
+     * @internal
+     */
+    readonly _pendingSwapStates: ToBTCSwapState[];
+    /**
+     * @internal
+     */
+    readonly _refundableSwapStates: ToBTCSwapState[];
+    /**
+     * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
+     *
+     * @param amountData
+     * @param lp Intermediary
+     * @param abortController
+     * @param contractVersion
+     * @returns Intermediary's reputation or null if failed
+     * @throws {IntermediaryError} If the intermediary vault doesn't exist
+     *
+     * @internal
+     */
+    protected preFetchIntermediaryReputation(amountData: Omit<AmountData, "amount">, lp: Intermediary, abortController: AbortController, contractVersion: string): Promise<SingleChainReputationType | undefined>;
+    /**
+     * Pre-fetches feeRate for a given swap
+     *
+     * @param signer Address of the swap initiator
+     * @param amountData
+     * @param claimHash optional hash of the swap or null
+     * @param abortController
+     * @param contractVersions
+     * @returns Fee rate
+     *
+     * @internal
+     */
+    protected preFetchFeeRate(signer: string, amountData: Omit<AmountData, "amount">, claimHash: {
+        [contractVersion: string]: string;
+    } | undefined, abortController: AbortController, contractVersions: string[]): {
+        [contractVersion: string]: Promise<string | undefined>;
+    };
+    /**
+     * @internal
+     */
+    protected processEventInitialize(swap: D["Swap"], event: InitializeEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * @internal
+     */
+    protected processEventClaim(swap: D["Swap"], event: ClaimEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * @internal
+     */
+    protected processEventRefund(swap: D["Swap"], event: RefundEvent<T["Data"]>): Promise<boolean>;
+}

package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js

@@ -1,117 +1,117 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IToBTCWrapper = void 0;
-const IToBTCSwap_1 = require("./IToBTCSwap");
-const IntermediaryError_1 = require("../../../errors/IntermediaryError");
-const IEscrowSwapWrapper_1 = require("../IEscrowSwapWrapper");
-const Utils_1 = require("../../../utils/Utils");
-/**
- * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
- *
- * @category Swaps/Smart chain → Bitcoin
- */
-class IToBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
-    constructor() {
-        super(...arguments);
-        /**
-         * @internal
-         */
-        this.tickSwapState = [IToBTCSwap_1.ToBTCSwapState.CREATED, IToBTCSwap_1.ToBTCSwapState.COMMITED, IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED];
-        /**
-         * @internal
-         */
-        this._pendingSwapStates = [
-            IToBTCSwap_1.ToBTCSwapState.CREATED,
-            IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED,
-            IToBTCSwap_1.ToBTCSwapState.COMMITED,
-            IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED,
-            IToBTCSwap_1.ToBTCSwapState.REFUNDABLE
-        ];
-        /**
-         * @internal
-         */
-        this._refundableSwapStates = [IToBTCSwap_1.ToBTCSwapState.REFUNDABLE];
-    }
-    /**
-     * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
-     *
-     * @param amountData
-     * @param lp Intermediary
-     * @param abortController
-     * @param contractVersion
-     * @returns Intermediary's reputation or null if failed
-     * @throws {IntermediaryError} If the intermediary vault doesn't exist
-     *
-     * @internal
-     */
-    preFetchIntermediaryReputation(amountData, lp, abortController, contractVersion) {
-        return lp.getReputation(this.chainIdentifier, this._contract(contractVersion), [amountData.token.toString()], abortController.signal).then(res => {
-            if (res == null)
-                throw new IntermediaryError_1.IntermediaryError("Invalid data returned - invalid LP vault");
-            return res;
-        }).catch(e => {
-            this.logger.warn("preFetchIntermediaryReputation(): Error: ", e);
-            abortController.abort(e);
-            return undefined;
-        });
-    }
-    /**
-     * Pre-fetches feeRate for a given swap
-     *
-     * @param signer Address of the swap initiator
-     * @param amountData
-     * @param claimHash optional hash of the swap or null
-     * @param abortController
-     * @param contractVersions
-     * @returns Fee rate
-     *
-     * @internal
-     */
-    preFetchFeeRate(signer, amountData, claimHash, abortController, contractVersions) {
-        return (0, Utils_1.mapArrayToObject)(contractVersions, (contractVersion) => {
-            return this._contract(contractVersion).getInitPayInFeeRate(signer, this._chain.randomAddress(), amountData.token, claimHash?.[contractVersion])
-                .catch(e => {
-                this.logger.warn("preFetchFeeRate(): Error: ", e);
-                abortController.abort(e);
-                return undefined;
-            });
-        });
-    }
-    /**
-     * @internal
-     */
-    async processEventInitialize(swap, event) {
-        if (swap._state === IToBTCSwap_1.ToBTCSwapState.CREATED || swap._state === IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED) {
-            swap._state = IToBTCSwap_1.ToBTCSwapState.COMMITED;
-            return true;
-        }
-        return false;
-    }
-    /**
-     * @internal
-     */
-    async processEventClaim(swap, event) {
-        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED && swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED) {
-            await swap._setPaymentResult({
-                secret: event.result,
-                txId: Buffer.from(event.result, "hex").reverse().toString("hex")
-            }).catch(e => {
-                this.logger.warn(`processEventClaim(): Failed to set payment result ${event.result}: `, e);
-            });
-            swap._state = IToBTCSwap_1.ToBTCSwapState.CLAIMED;
-            return true;
-        }
-        return false;
-    }
-    /**
-     * @internal
-     */
-    processEventRefund(swap, event) {
-        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED && swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED) {
-            swap._state = IToBTCSwap_1.ToBTCSwapState.REFUNDED;
-            return Promise.resolve(true);
-        }
-        return Promise.resolve(false);
-    }
-}
-exports.IToBTCWrapper = IToBTCWrapper;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IToBTCWrapper = void 0;
+const IToBTCSwap_1 = require("./IToBTCSwap");
+const IntermediaryError_1 = require("../../../errors/IntermediaryError");
+const IEscrowSwapWrapper_1 = require("../IEscrowSwapWrapper");
+const Utils_1 = require("../../../utils/Utils");
+/**
+ * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
+ *
+ * @category Swaps/Smart chain → Bitcoin
+ */
+class IToBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
+    constructor() {
+        super(...arguments);
+        /**
+         * @internal
+         */
+        this.tickSwapState = [IToBTCSwap_1.ToBTCSwapState.CREATED, IToBTCSwap_1.ToBTCSwapState.COMMITED, IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED];
+        /**
+         * @internal
+         */
+        this._pendingSwapStates = [
+            IToBTCSwap_1.ToBTCSwapState.CREATED,
+            IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED,
+            IToBTCSwap_1.ToBTCSwapState.COMMITED,
+            IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED,
+            IToBTCSwap_1.ToBTCSwapState.REFUNDABLE
+        ];
+        /**
+         * @internal
+         */
+        this._refundableSwapStates = [IToBTCSwap_1.ToBTCSwapState.REFUNDABLE];
+    }
+    /**
+     * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
+     *
+     * @param amountData
+     * @param lp Intermediary
+     * @param abortController
+     * @param contractVersion
+     * @returns Intermediary's reputation or null if failed
+     * @throws {IntermediaryError} If the intermediary vault doesn't exist
+     *
+     * @internal
+     */
+    preFetchIntermediaryReputation(amountData, lp, abortController, contractVersion) {
+        return lp.getReputation(this.chainIdentifier, this._contract(contractVersion), [amountData.token.toString()], abortController.signal).then(res => {
+            if (res == null)
+                throw new IntermediaryError_1.IntermediaryError("Invalid data returned - invalid LP vault");
+            return res;
+        }).catch(e => {
+            this.logger.warn("preFetchIntermediaryReputation(): Error: ", e);
+            abortController.abort(e);
+            return undefined;
+        });
+    }
+    /**
+     * Pre-fetches feeRate for a given swap
+     *
+     * @param signer Address of the swap initiator
+     * @param amountData
+     * @param claimHash optional hash of the swap or null
+     * @param abortController
+     * @param contractVersions
+     * @returns Fee rate
+     *
+     * @internal
+     */
+    preFetchFeeRate(signer, amountData, claimHash, abortController, contractVersions) {
+        return (0, Utils_1.mapArrayToObject)(contractVersions, (contractVersion) => {
+            return this._contract(contractVersion).getInitPayInFeeRate(signer, this._chain.randomAddress(), amountData.token, claimHash?.[contractVersion])
+                .catch(e => {
+                this.logger.warn("preFetchFeeRate(): Error: ", e);
+                abortController.abort(e);
+                return undefined;
+            });
+        });
+    }
+    /**
+     * @internal
+     */
+    async processEventInitialize(swap, event) {
+        if (swap._state === IToBTCSwap_1.ToBTCSwapState.CREATED || swap._state === IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED) {
+            swap._state = IToBTCSwap_1.ToBTCSwapState.COMMITED;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * @internal
+     */
+    async processEventClaim(swap, event) {
+        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED && swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED) {
+            await swap._setPaymentResult({
+                secret: event.result,
+                txId: Buffer.from(event.result, "hex").reverse().toString("hex")
+            }).catch(e => {
+                this.logger.warn(`processEventClaim(): Failed to set payment result ${event.result}: `, e);
+            });
+            swap._state = IToBTCSwap_1.ToBTCSwapState.CLAIMED;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * @internal
+     */
+    processEventRefund(swap, event) {
+        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED && swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED) {
+            swap._state = IToBTCSwap_1.ToBTCSwapState.REFUNDED;
+            return Promise.resolve(true);
+        }
+        return Promise.resolve(false);
+    }
+}
+exports.IToBTCWrapper = IToBTCWrapper;

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

@@ -1,127 +1,127 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { ToBTCLNDefinition, ToBTCLNWrapper } from "./ToBTCLNWrapper";
-import { IToBTCSwap, IToBTCSwapInit } from "../IToBTCSwap";
-import { SwapType } from "../../../../enums/SwapType";
-import { ChainType, SwapData } from "@atomiqlabs/base";
-import { Buffer } from "buffer";
-import { LNURLPaySuccessAction } from "../../../../lnurl/LNURL";
-import { TokenAmount } from "../../../../types/TokenAmount";
-import { BtcToken } from "../../../../types/Token";
-import { LoggerType } from "../../../../utils/Logger";
-import { LNURLDecodedSuccessAction } from "../../../../types/lnurl/LNURLPay";
-export type ToBTCLNSwapInit<T extends SwapData> = IToBTCSwapInit<T> & {
-    confidence: number;
-    pr?: string;
-    lnurl?: string;
-    successAction?: LNURLPaySuccessAction;
-};
-export declare function isToBTCLNSwapInit<T extends SwapData>(obj: any): obj is ToBTCLNSwapInit<T>;
-/**
- * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
- *
- * @category Swaps/Smart chain → Lightning
- */
-export declare class ToBTCLNSwap<T extends ChainType = ChainType> extends IToBTCSwap<T, ToBTCLNDefinition<T>> {
-    protected readonly TYPE = SwapType.TO_BTCLN;
-    /**
-     * @internal
-     */
-    protected readonly outputToken: BtcToken<true>;
-    /**
-     * @internal
-     */
-    protected readonly logger: LoggerType;
-    private readonly usesClaimHashAsId;
-    private readonly confidence;
-    private pr?;
-    private secret?;
-    private lnurl?;
-    private successAction?;
-    /**
-     * Sets the LNURL data for the swap
-     *
-     * @internal
-     */
-    _setLNURLData(lnurl: string, successAction?: LNURLPaySuccessAction): void;
-    constructor(wrapper: ToBTCLNWrapper<T>, init: ToBTCLNSwapInit<T["Data"]>);
-    constructor(wrapper: ToBTCLNWrapper<T>, obj: any);
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _setPaymentResult(result: {
-        secret?: string;
-        txId?: string;
-    }, check?: boolean): Promise<boolean>;
-    /**
-     * @inheritDoc
-     */
-    getOutputToken(): BtcToken<true>;
-    /**
-     * @inheritDoc
-     */
-    getOutput(): TokenAmount<BtcToken<true>>;
-    /**
-     * @inheritDoc
-     */
-    getOutputTxId(): string | null;
-    /**
-     * @inheritDoc
-     */
-    getOutputAddress(): string | null;
-    /**
-     * Returns payment secret (pre-image) as a proof of payment
-     */
-    getSecret(): string | null;
-    /**
-     * Returns the confidence of the intermediary that this payment will succeed.
-     *
-     * @returns Decimal value between 0 and 1, where 0 is not likely and 1 is very likely
-     */
-    getConfidence(): number;
-    /**
-     * Checks whether a swap is likely to fail, based on the confidence as reported by the intermediary (LP)
-     */
-    willLikelyFail(): boolean;
-    /**
-     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, extract care must be taken
-     *  for such a wallet **to be online** when attempting to make a swap sending to such a wallet
-     */
-    isPayingToNonCustodialWallet(): boolean;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    protected getIdentifierHash(): Buffer;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    protected getLpIdentifier(): string;
-    /**
-     * Returns the payment hash of the swap, i.e. a payment hash of the lightning network invoice that
-     *  is about to be paid
-     */
-    getPaymentHash(): Buffer | null;
-    /**
-     * Whether this is an LNURL-pay swap
-     */
-    isLNURL(): boolean;
-    /**
-     * Gets the used LNURL-pay link or `null` if this is not an LNURL-pay swap
-     */
-    getLNURL(): string | null;
-    /**
-     * Checks whether this LNURL-pay payment contains a success action
-     */
-    hasSuccessAction(): boolean;
-    /**
-     * Returns the success action after a successful payment, else `null`
-     */
-    getSuccessAction(): LNURLDecodedSuccessAction | null;
-    /**
-     * @inheritDoc
-     */
-    serialize(): any;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { ToBTCLNDefinition, ToBTCLNWrapper } from "./ToBTCLNWrapper";
+import { IToBTCSwap, IToBTCSwapInit } from "../IToBTCSwap";
+import { SwapType } from "../../../../enums/SwapType";
+import { ChainType, SwapData } from "@atomiqlabs/base";
+import { Buffer } from "buffer";
+import { LNURLPaySuccessAction } from "../../../../lnurl/LNURL";
+import { TokenAmount } from "../../../../types/TokenAmount";
+import { BtcToken } from "../../../../types/Token";
+import { LoggerType } from "../../../../utils/Logger";
+import { LNURLDecodedSuccessAction } from "../../../../types/lnurl/LNURLPay";
+export type ToBTCLNSwapInit<T extends SwapData> = IToBTCSwapInit<T> & {
+    confidence: number;
+    pr?: string;
+    lnurl?: string;
+    successAction?: LNURLPaySuccessAction;
+};
+export declare function isToBTCLNSwapInit<T extends SwapData>(obj: any): obj is ToBTCLNSwapInit<T>;
+/**
+ * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
+ *
+ * @category Swaps/Smart chain → Lightning
+ */
+export declare class ToBTCLNSwap<T extends ChainType = ChainType> extends IToBTCSwap<T, ToBTCLNDefinition<T>> {
+    protected readonly TYPE = SwapType.TO_BTCLN;
+    /**
+     * @internal
+     */
+    protected readonly outputToken: BtcToken<true>;
+    /**
+     * @internal
+     */
+    protected readonly logger: LoggerType;
+    private readonly usesClaimHashAsId;
+    private readonly confidence;
+    private pr?;
+    private secret?;
+    private lnurl?;
+    private successAction?;
+    /**
+     * Sets the LNURL data for the swap
+     *
+     * @internal
+     */
+    _setLNURLData(lnurl: string, successAction?: LNURLPaySuccessAction): void;
+    constructor(wrapper: ToBTCLNWrapper<T>, init: ToBTCLNSwapInit<T["Data"]>);
+    constructor(wrapper: ToBTCLNWrapper<T>, obj: any);
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _setPaymentResult(result: {
+        secret?: string;
+        txId?: string;
+    }, check?: boolean): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    getOutputToken(): BtcToken<true>;
+    /**
+     * @inheritDoc
+     */
+    getOutput(): TokenAmount<BtcToken<true>>;
+    /**
+     * @inheritDoc
+     */
+    getOutputTxId(): string | null;
+    /**
+     * @inheritDoc
+     */
+    getOutputAddress(): string | null;
+    /**
+     * Returns payment secret (pre-image) as a proof of payment
+     */
+    getSecret(): string | null;
+    /**
+     * Returns the confidence of the intermediary that this payment will succeed.
+     *
+     * @returns Decimal value between 0 and 1, where 0 is not likely and 1 is very likely
+     */
+    getConfidence(): number;
+    /**
+     * Checks whether a swap is likely to fail, based on the confidence as reported by the intermediary (LP)
+     */
+    willLikelyFail(): boolean;
+    /**
+     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, extract care must be taken
+     *  for such a wallet **to be online** when attempting to make a swap sending to such a wallet
+     */
+    isPayingToNonCustodialWallet(): boolean;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    protected getIdentifierHash(): Buffer;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    protected getLpIdentifier(): string;
+    /**
+     * Returns the payment hash of the swap, i.e. a payment hash of the lightning network invoice that
+     *  is about to be paid
+     */
+    getPaymentHash(): Buffer | null;
+    /**
+     * Whether this is an LNURL-pay swap
+     */
+    isLNURL(): boolean;
+    /**
+     * Gets the used LNURL-pay link or `null` if this is not an LNURL-pay swap
+     */
+    getLNURL(): string | null;
+    /**
+     * Checks whether this LNURL-pay payment contains a success action
+     */
+    hasSuccessAction(): boolean;
+    /**
+     * Returns the success action after a successful payment, else `null`
+     */
+    getSuccessAction(): LNURLDecodedSuccessAction | null;
+    /**
+     * @inheritDoc
+     */
+    serialize(): any;
+}