@atomiqlabs/sdk 8.1.8 → 8.3.5

package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts

@@ -14,10 +14,34 @@ export type OnchainForGasWrapperOptions = ISwapWrapperOptions & {
     bitcoinNetwork: BTC_NETWORK;
 };
 export type OnchainForGasSwapTypeDefinition<T extends ChainType> = SwapTypeDefinition<T, OnchainForGasWrapper<T>, OnchainForGasSwap<T>>;
+/**
+ * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
+ *  destination chain, which is only needed for Solana, which still uses legacy swaps
+ *
+ * @category Swaps/Trusted Gas Swaps
+ */
 export declare class OnchainForGasWrapper<T extends ChainType> extends ISwapWrapper<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasWrapperOptions> {
-    readonly TYPE = SwapType.TRUSTED_FROM_BTC;
-    readonly swapDeserializer: typeof OnchainForGasSwap;
-    readonly btcRpc: BitcoinRpcWithAddressIndex<any>;
+    readonly TYPE: SwapType.TRUSTED_FROM_BTC;
+    /**
+     * @internal
+     */
+    readonly _swapDeserializer: typeof OnchainForGasSwap;
+    /**
+     * @internal
+     */
+    readonly _pendingSwapStates: OnchainForGasSwapState[];
+    /**
+     * @internal
+     */
+    protected readonly tickSwapState: undefined;
+    /**
+     * @internal
+     */
+    protected processEvent: undefined;
+    /**
+     * @internal
+     */
+    readonly _btcRpc: BitcoinRpcWithAddressIndex<any>;
     /**
      * @param chainIdentifier
      * @param unifiedStorage Storage interface for the current environment
@@ -33,15 +57,13 @@ export declare class OnchainForGasWrapper<T extends ChainType> extends ISwapWrap
         swapState: [ISwap];
     }>);
     /**
-     * Returns a newly created swap, receiving 'amount' base units of gas token
+     * Returns a newly created trusted Bitcoin on-chain -> Smart chain swap, receiving
+     *  the specified amount of native token on the destination chain.
      *
-     * @param signer
-     * @param amount            Amount you wish to receive in base units
-     * @param lpOrUrl           Intermediary/Counterparty swap service Intermediary object or raw url
-     * @param refundAddress     Bitcoin address to receive refund on in case the counterparty cannot execute the swap
+     * @param recipient Address of the recipient on the smart chain destination chain
+     * @param amount Amount of native token to receive in base units
+     * @param lpOrUrl Intermediary (LP) to use for the swap
+     * @param refundAddress Bitcoin address to receive refund on in case the intermediary (LP) cannot execute the swap
      */
-    create(signer: string, amount: bigint, lpOrUrl: Intermediary | string, refundAddress?: string): Promise<OnchainForGasSwap<T>>;
-    readonly pendingSwapStates: OnchainForGasSwapState[];
-    readonly tickSwapState: undefined;
-    protected processEvent: undefined;
+    create(recipient: string, amount: bigint, lpOrUrl: Intermediary | string, refundAddress?: string): Promise<OnchainForGasSwap<T>>;
 }

package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js

@@ -6,6 +6,12 @@ const TrustedIntermediaryAPI_1 = require("../../../intermediaries/apis/TrustedIn
 const IntermediaryError_1 = require("../../../errors/IntermediaryError");
 const OnchainForGasSwap_1 = require("./OnchainForGasSwap");
 const SwapType_1 = require("../../../enums/SwapType");
+/**
+ * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
+ *  destination chain, which is only needed for Solana, which still uses legacy swaps
+ *
+ * @category Swaps/Trusted Gas Swaps
+ */
 class OnchainForGasWrapper extends ISwapWrapper_1.ISwapWrapper {
     /**
      * @param chainIdentifier
@@ -21,43 +27,56 @@ class OnchainForGasWrapper extends ISwapWrapper_1.ISwapWrapper {
     constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, btcRpc, options, events) {
         super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, options, events);
         this.TYPE = SwapType_1.SwapType.TRUSTED_FROM_BTC;
-        this.swapDeserializer = OnchainForGasSwap_1.OnchainForGasSwap;
-        this.pendingSwapStates = [OnchainForGasSwap_1.OnchainForGasSwapState.PR_CREATED];
+        /**
+         * @internal
+         */
+        this._swapDeserializer = OnchainForGasSwap_1.OnchainForGasSwap;
+        /**
+         * @internal
+         */
+        this._pendingSwapStates = [OnchainForGasSwap_1.OnchainForGasSwapState.PR_CREATED];
+        /**
+         * @internal
+         */
         this.tickSwapState = undefined;
+        /**
+         * @internal
+         */
         this.processEvent = undefined;
-        this.btcRpc = btcRpc;
+        this._btcRpc = btcRpc;
     }
     /**
-     * Returns a newly created swap, receiving 'amount' base units of gas token
+     * Returns a newly created trusted Bitcoin on-chain -> Smart chain swap, receiving
+     *  the specified amount of native token on the destination chain.
      *
-     * @param signer
-     * @param amount            Amount you wish to receive in base units
-     * @param lpOrUrl           Intermediary/Counterparty swap service Intermediary object or raw url
-     * @param refundAddress     Bitcoin address to receive refund on in case the counterparty cannot execute the swap
+     * @param recipient Address of the recipient on the smart chain destination chain
+     * @param amount Amount of native token to receive in base units
+     * @param lpOrUrl Intermediary (LP) to use for the swap
+     * @param refundAddress Bitcoin address to receive refund on in case the intermediary (LP) cannot execute the swap
      */
-    async create(signer, amount, lpOrUrl, refundAddress) {
+    async create(recipient, amount, lpOrUrl, refundAddress) {
         if (!this.isInitialized)
             throw new Error("Not initialized, call init() first!");
         const lpUrl = typeof (lpOrUrl) === "string" ? lpOrUrl : lpOrUrl.url;
-        const token = this.chain.getNativeCurrencyAddress();
+        const token = this._chain.getNativeCurrencyAddress();
         const resp = await TrustedIntermediaryAPI_1.TrustedIntermediaryAPI.initTrustedFromBTC(this.chainIdentifier, lpUrl, {
-            address: signer,
+            address: recipient,
             amount,
             refundAddress,
             token
-        }, this.options.getRequestTimeout);
+        }, this._options.getRequestTimeout);
         if (resp.total !== amount)
             throw new IntermediaryError_1.IntermediaryError("Invalid total returned");
         const pricingInfo = await this.verifyReturnedPrice(typeof (lpOrUrl) === "string" || lpOrUrl.services[SwapType_1.SwapType.TRUSTED_FROM_BTC] == null ?
             { swapFeePPM: 10000, swapBaseFee: 10 } :
-            lpOrUrl.services[SwapType_1.SwapType.TRUSTED_FROM_BTC], false, resp.amountSats, amount, this.chain.getNativeCurrencyAddress(), {});
+            lpOrUrl.services[SwapType_1.SwapType.TRUSTED_FROM_BTC], false, resp.amountSats, amount, this._chain.getNativeCurrencyAddress(), {});
         const quote = new OnchainForGasSwap_1.OnchainForGasSwap(this, {
             paymentHash: resp.paymentHash,
             sequence: resp.sequence,
             address: resp.btcAddress,
             inputAmount: resp.amountSats,
             outputAmount: resp.total,
-            recipient: signer,
+            recipient,
             refundAddress,
             pricingInfo,
             url: lpUrl,

package/dist/types/AmountData.d.ts

@@ -1,5 +1,6 @@
 /**
- * Simple amount definition for swap operations
+ * Amount, token and exact input object for initiating swap operations
+ *
  * @category Tokens
  */
 export type AmountData = {

package/dist/types/CustomPriceFunction.d.ts

@@ -1,5 +1,11 @@
 /**
- * Custom pricing callback function type
- * @category Pricing and LPs
+ * Custom pricing callback function type, fetches the USD price for the provided array
+ *  of token tickers.
+ *
+ * @param tickers Tickers of the tokens to fetch USD price for
+ * @param abortSignal Abort signal
+ * @returns USD prices of the passed tickers in the order that they were passed
+ *
+ * @category Pricing
  */
 export type CustomPriceFunction = (tickers: string[], abortSignal?: AbortSignal) => Promise<number[]>;

package/dist/types/PriceInfoType.d.ts

@@ -1,6 +1,6 @@
 /**
  * Pricing information for swap validation
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type PriceInfoType = {
     isValid: boolean;
@@ -13,16 +13,16 @@ export type PriceInfoType = {
 };
 /**
  * Type guard for PriceInfoType
- * @category Pricing and LPs
+ * @category Pricing
  */
 export declare function isPriceInfoType(obj: any): obj is PriceInfoType;
 /**
  * Serializes PriceInfoType for storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 export declare function serializePriceInfoType(obj: PriceInfoType | undefined): any;
 /**
  * Deserializes PriceInfoType from storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 export declare function deserializePriceInfoType(obj: any): PriceInfoType | undefined;

package/dist/types/PriceInfoType.js

@@ -4,7 +4,7 @@ exports.deserializePriceInfoType = exports.serializePriceInfoType = exports.isPr
 const Utils_1 = require("../utils/Utils");
 /**
  * Type guard for PriceInfoType
- * @category Pricing and LPs
+ * @category Pricing
  */
 function isPriceInfoType(obj) {
     return obj != null &&
@@ -19,7 +19,7 @@ function isPriceInfoType(obj) {
 exports.isPriceInfoType = isPriceInfoType;
 /**
  * Serializes PriceInfoType for storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 function serializePriceInfoType(obj) {
     if (obj == null)
@@ -37,7 +37,7 @@ function serializePriceInfoType(obj) {
 exports.serializePriceInfoType = serializePriceInfoType;
 /**
  * Deserializes PriceInfoType from storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 function deserializePriceInfoType(obj) {
     if (obj == null)

package/dist/types/SwapExecutionAction.d.ts

@@ -1,7 +1,88 @@
 import { ChainType } from "@atomiqlabs/base";
-export type SwapExecutionAction<T extends ChainType> = {
-    name: "Payment" | "Commit" | "Claim";
+import { Transaction } from "@scure/btc-signer";
+/**
+ * Swap execution action requiring a payment of the provided bolt11 lightning network invoice
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionLightning = {
+    name: "Payment";
     description: string;
-    chain: "LIGHTNING" | "BITCOIN" | T["ChainId"];
-    txs: any[];
+    chain: "LIGHTNING";
+    txs: {
+        type: "BOLT11_PAYMENT_REQUEST";
+        address: string;
+        hyperlink: string;
+    }[];
 };
+/**
+ * Swap execution action on on-chain Bitcoin, has following types:
+ * - `"ADDRESS"` - Destination bitcoin address and BTC amount to be sent
+ * - `"FUNDED_PSBT"` - A ready to sign PSBT with the inputs populated from the provided bitcoin wallet address
+ * - `"RAW_PSBT"` - Raw PSBT without the inputs, the implementor needs to add the input UTXOs before signing
+ *  the transaction
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionBitcoin<T extends "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT" = "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT"> = {
+    name: "Payment";
+    description: string;
+    chain: "BITCOIN";
+    txs: (T extends "ADDRESS" ? {
+        type: "ADDRESS";
+        amount: number;
+        address: string;
+        hyperlink: string;
+    } : T extends "FUNDED_PSBT" ? {
+        type: "FUNDED_PSBT";
+        psbt: Transaction;
+        psbtHex: string;
+        psbtBase64: string;
+        signInputs: number[];
+    } : {
+        type: "RAW_PSBT";
+        psbt: Transaction;
+        psbtHex: string;
+        psbtBase64: string;
+        in1sequence: number;
+    })[];
+};
+/**
+ * Swap execution action for committing (initiating) the escrow on the smart chain side
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionCommit<T extends ChainType> = {
+    name: "Commit";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action for claiming (settling) the swap on the smart chain side
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionClaim<T extends ChainType> = {
+    name: "Claim";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action for refunding the swap on the smart chain side after it fails
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionRefund<T extends ChainType> = {
+    name: "Refund";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action, a single step in the swapping process
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionAction<T extends ChainType> = SwapExecutionActionLightning | SwapExecutionActionBitcoin | SwapExecutionActionCommit<T> | SwapExecutionActionClaim<T> | SwapExecutionActionRefund<T>;

package/dist/types/SwapWithSigner.d.ts

@@ -1,14 +1,17 @@
 import { ISwap } from "../swaps/ISwap";
 import { ChainType } from "@atomiqlabs/base";
 /**
- * Proxy type that auto-injects signer into swap methods
- * @category Swaps
+ * Proxy type that auto-injects a smart chain signer into swap methods
+ *
+ * @category Swaps/Base
  */
 export type SwapWithSigner<T extends ISwap> = {
     [K in keyof T]: K extends "commit" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : K extends "refund" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "claim" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "commitAndClaim" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : T[K];
 };
 /**
  * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
+ *
  * @category Swaps
+ * @internal
  */
 export declare function wrapSwapWithSigner<C extends ChainType, T extends ISwap<C>>(swap: T, signer: C["Signer"]): SwapWithSigner<T>;

package/dist/types/SwapWithSigner.js

@@ -4,14 +4,17 @@ exports.wrapSwapWithSigner = void 0;
 const IToBTCSwap_1 = require("../swaps/escrow_swaps/tobtc/IToBTCSwap");
 const IFromBTCSelfInitSwap_1 = require("../swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap");
 const FromBTCLNSwap_1 = require("../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap");
+const FromBTCLNAutoSwap_1 = require("../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap");
+const SpvFromBTCSwap_1 = require("../swaps/spv_swaps/SpvFromBTCSwap");
 /**
  * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
+ *
  * @category Swaps
+ * @internal
  */
 function wrapSwapWithSigner(swap, signer) {
     return new Proxy(swap, {
         get: (target, prop, receiver) => {
-            // Override the "sayGoodbye" method
             if (prop === "commit") {
                 if (swap instanceof IToBTCSwap_1.IToBTCSwap || swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap) {
                     return (abortSignal, skipChecks) => swap.commit(signer, abortSignal, skipChecks);
@@ -23,7 +26,7 @@ function wrapSwapWithSigner(swap, signer) {
                 }
             }
             if (prop === "claim") {
-                if (swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap) {
+                if (swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap || swap instanceof FromBTCLNAutoSwap_1.FromBTCLNAutoSwap || swap instanceof SpvFromBTCSwap_1.SpvFromBTCSwap) {
                     return (abortSignal) => swap.claim(signer, abortSignal);
                 }
             }

package/dist/types/Token.d.ts

@@ -1,5 +1,6 @@
 /**
- * Bitcoin token type (on-chain or lightning)
+ * Bitcoin token type (BTC on on-chain or lightning)
+ *
  * @category Tokens
  */
 export type BtcToken<L = boolean> = {
@@ -11,12 +12,14 @@ export type BtcToken<L = boolean> = {
     displayDecimals?: number;
 };
 /**
- * Type guard for BtcToken
+ * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
+ *
  * @category Tokens
  */
 export declare function isBtcToken(obj: any): obj is BtcToken;
 /**
  * Predefined Bitcoin token constants
+ *
  * @category Tokens
  */
 export declare const BitcoinTokens: {
@@ -24,7 +27,8 @@ export declare const BitcoinTokens: {
     BTCLN: BtcToken<true>;
 };
 /**
- * Smart Chain token type
+ * Token on the smart chain
+ *
  * @category Tokens
  */
 export type SCToken<ChainIdentifier extends string = string> = {
@@ -37,17 +41,19 @@ export type SCToken<ChainIdentifier extends string = string> = {
     name: string;
 };
 /**
- * Type guard for SCToken
+ * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
 export declare function isSCToken(obj: any): obj is SCToken;
 /**
  * Union type for all token types (BTC or smart chain)
+ *
  * @category Tokens
  */
 export type Token<ChainIdentifier extends string = string> = BtcToken | SCToken<ChainIdentifier>;
 /**
- * Type guard for Token
+ * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
  * @category Tokens
  */
 export declare function isToken(obj: any): obj is Token;

package/dist/types/Token.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isToken = exports.isSCToken = exports.BitcoinTokens = exports.isBtcToken = void 0;
 /**
- * Type guard for BtcToken
+ * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
+ *
  * @category Tokens
  */
 function isBtcToken(obj) {
@@ -16,6 +17,7 @@ function isBtcToken(obj) {
 exports.isBtcToken = isBtcToken;
 /**
  * Predefined Bitcoin token constants
+ *
  * @category Tokens
  */
 exports.BitcoinTokens = {
@@ -35,7 +37,7 @@ exports.BitcoinTokens = {
     }
 };
 /**
- * Type guard for SCToken
+ * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
 function isSCToken(obj) {
@@ -49,7 +51,8 @@ function isSCToken(obj) {
 }
 exports.isSCToken = isSCToken;
 /**
- * Type guard for Token
+ * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
  * @category Tokens
  */
 function isToken(obj) {

package/dist/types/TokenAmount.d.ts

@@ -3,6 +3,7 @@ import { Token } from "./Token";
 import { PriceInfoType } from "./PriceInfoType";
 /**
  * Represents a token amount along with its formatted values and USD valuation helpers
+ *
  * @category Tokens
  */
 export type TokenAmount<ChainIdentifier extends string = string, T extends Token<ChainIdentifier> = Token<ChainIdentifier>, Known extends boolean = boolean> = {
@@ -61,6 +62,8 @@ export type TokenAmount<ChainIdentifier extends string = string, T extends Token
 };
 /**
  * Factory function to create a TokenAmount
+ *
  * @category Tokens
+ * @internal
  */
 export declare function toTokenAmount<ChainIdentifier extends string = string, T extends Token<ChainIdentifier> = Token<ChainIdentifier>, Known extends boolean = boolean>(amount: Known extends true ? bigint : null, token: T, prices: ISwapPrice, pricingInfo?: PriceInfoType): TokenAmount<ChainIdentifier, T, Known>;

package/dist/types/TokenAmount.js

@@ -4,7 +4,9 @@ exports.toTokenAmount = void 0;
 const Utils_1 = require("../utils/Utils");
 /**
  * Factory function to create a TokenAmount
+ *
  * @category Tokens
+ * @internal
  */
 function toTokenAmount(amount, token, prices, pricingInfo) {
     if (amount == null)

package/dist/types/fees/Fee.d.ts

@@ -2,9 +2,10 @@ import { PercentagePPM } from "./PercentagePPM";
 import { TokenAmount } from "../TokenAmount";
 import { Token } from "../Token";
 /**
- * Represents a fee in both source and destination tokens, as well as providing USD valuation helpers and
+ * Fee represented in both, source and destination tokens, as well as providing USD valuation helpers and
  *  fee composition
- * @category Pricing and LPs
+ *
+ * @category Pricing
  */
 export type Fee<ChainIdentifier extends string = string, TSrc extends Token<ChainIdentifier> = Token<ChainIdentifier>, TDst extends Token<ChainIdentifier> = Token<ChainIdentifier>> = {
     /**

package/dist/types/fees/FeeBreakdown.d.ts

@@ -1,8 +1,9 @@
 import { FeeType } from "../../enums/FeeType";
 import { Fee } from "./Fee";
 /**
- * Breakdown of fees by type (swap fee vs network fee)
- * @category Pricing and LPs
+ * Breakdown of fees by type (swap fee, network fee, etc.)
+ *
+ * @category Pricing
  */
 export type FeeBreakdown<ChainIdentifier extends string = string> = {
     type: FeeType;

package/dist/types/fees/PercentagePPM.d.ts

@@ -1,6 +1,7 @@
 /**
  * Parts-per-million fee representation with conversion helpers
- * @category Pricing and LPs
+ *
+ * @category Pricing
  */
 export type PercentagePPM = {
     ppm: bigint;
@@ -10,6 +11,7 @@ export type PercentagePPM = {
 };
 /**
  * Converts parts-per-million to percentage representation
- * @category Pricing and LPs
+ *
+ * @category Pricing
  */
 export declare function ppmToPercentage(ppm: bigint): PercentagePPM;

package/dist/types/fees/PercentagePPM.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ppmToPercentage = void 0;
 /**
  * Converts parts-per-million to percentage representation
- * @category Pricing and LPs
+ *
+ * @category Pricing
  */
 function ppmToPercentage(ppm) {
     const percentage = Number(ppm) / 10000;

package/dist/types/lnurl/LNURLPay.d.ts

@@ -1,6 +1,7 @@
 /**
- * LNURL-pay request parameters
- * @category Bitcoin
+ * Response of the LNURL-pay link
+ *
+ * @category Lightning
  */
 export type LNURLPayParams = {
     tag: "payRequest";
@@ -13,15 +14,17 @@ export type LNURLPayParams = {
     commentAllowed: number;
 };
 /**
- * LNURL-pay parameters with URL
- * @category Bitcoin
+ * Response of the LNURL-pay link with the added original url
+ *
+ * @category Lightning
  */
 export type LNURLPayParamsWithUrl = LNURLPayParams & {
     url: string;
 };
 /**
- * LNURL-pay specification
- * @category Bitcoin
+ * Parsed LNURL-pay specification
+ *
+ * @category Lightning
  */
 export type LNURLPay = {
     type: "pay";
@@ -34,18 +37,23 @@ export type LNURLPay = {
     params: LNURLPayParamsWithUrl;
 };
 /**
- * Type guard for LNURL-pay parameters
- * @category Bitcoin
+ * Type guard for {@link LNURLPayParams}
+ *
+ * @category Lightning
+ * @internal
  */
 export declare function isLNURLPayParams(obj: any): obj is LNURLPayParams;
 /**
- * Type guard for LNURL-pay
- * @category Bitcoin
+ * Type guard for {@link LNURLPay}
+ *
+ * @category Lightning
+ * @internal
  */
 export declare function isLNURLPay(value: any): value is LNURLPay;
 /**
- * Decoded LNURL-pay success action
- * @category Bitcoin
+ * Decoded LNURL-pay success action, revealed after a lightning payment is finished
+ *
+ * @category Lightning
  */
 export type LNURLDecodedSuccessAction = {
     description: string;

package/dist/types/lnurl/LNURLPay.js

@@ -2,16 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLNURLPay = exports.isLNURLPayParams = void 0;
 /**
- * Type guard for LNURL-pay parameters
- * @category Bitcoin
+ * Type guard for {@link LNURLPayParams}
+ *
+ * @category Lightning
+ * @internal
  */
 function isLNURLPayParams(obj) {
     return obj.tag === "payRequest";
 }
 exports.isLNURLPayParams = isLNURLPayParams;
 /**
- * Type guard for LNURL-pay
- * @category Bitcoin
+ * Type guard for {@link LNURLPay}
+ *
+ * @category Lightning
+ * @internal
  */
 function isLNURLPay(value) {
     return (typeof value === "object" &&