@atomiqlabs/sdk 8.3.1 → 8.3.5

package/dist/swapper/Swapper.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { ISwapPrice } from "../prices/abstract/ISwapPrice";
-import { BitcoinNetwork, BtcRelay, ChainData, ChainType, Messenger, RelaySynchronizer } from "@atomiqlabs/base";
+import { BitcoinNetwork, BitcoinRpcWithAddressIndex, BtcBlock, BtcRelay, ChainData, ChainType, LightningNetworkApi, Messenger, RelaySynchronizer } from "@atomiqlabs/base";
 import { ToBTCLNOptions, ToBTCLNWrapper } from "../swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper";
 import { ToBTCOptions, ToBTCWrapper } from "../swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper";
 import { FromBTCLNOptions, FromBTCLNWrapper } from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper";
@@ -38,30 +38,100 @@ import { BtcToken, SCToken, Token } from "../types/Token";
 import { LNURLWithdraw } from "../types/lnurl/LNURLWithdraw";
 import { LNURLPay } from "../types/lnurl/LNURLPay";
 import { NotNever } from "../utils/TypeUtils";
-import { MempoolBitcoinBlock, MempoolBitcoinRpc } from "@atomiqlabs/btc-mempool";
 import { LightningInvoiceCreateService } from "../types/wallets/LightningInvoiceCreateService";
 /**
  * Configuration options for the Swapper
  * @category Core
  */
 export type SwapperOptions = {
+    /**
+     * Manual override for the intermediary (LP) URLs for the SDK to use, by default these are fetched automatically
+     * from the registry
+     */
     intermediaryUrl?: string | string[];
+    /**
+     * Registry URL for where to look for active intermediary (LP) endpoint URLs
+     */
     registryUrl?: string;
+    /**
+     * Bitcoin network to use for the swaps,
+     */
     bitcoinNetwork?: BitcoinNetwork;
+    /**
+     * Timeout (in milliseconds) for HTTP GET requests done by the SDK
+     */
     getRequestTimeout?: number;
+    /**
+     * Timeout (in milliseconds) for HTTP POST requests done by the SDK
+     */
     postRequestTimeout?: number;
+    /**
+     * Additional parameters to be sent to the intermediaries (LPs), when requesting quotes from them
+     */
     defaultAdditionalParameters?: {
         [key: string]: any;
     };
+    /**
+     * Optional name prefix to use when creating a swap storage, you can use this to create separate storage
+     *  instances that don't overlap.
+     */
     storagePrefix?: string;
+    /**
+     * Sets the default intermediary (LP) to use for the trusted gas swaps, if not set the SDK uses a default one
+     */
     defaultTrustedIntermediaryUrl?: string;
-    swapStorage?: <T extends ChainType>(chainId: T["ChainId"]) => IUnifiedStorage<UnifiedSwapStorageIndexes, UnifiedSwapStorageCompositeIndexes>;
+    /**
+     * A function callback to retrieve a specific named storage container for swap persistency. If not present, the
+     *  default IndexedDB storage adapter is used. When you use the SDK in non-browser based environments you need to
+     *  provide this callback such that the SDK is able to use a custom storage adapter.
+     *
+     * @param storageName Name of the container to retrieve
+     */
+    swapStorage?: (storageName: string) => IUnifiedStorage<UnifiedSwapStorageIndexes, UnifiedSwapStorageCompositeIndexes>;
+    /**
+     * By setting this flag, the swapper doesn't schedule automatic tick timers. To make sure the swap states are
+     * properly updated (e.g. the expired swaps properly move to the expired state), you should call the
+     *  {@link Swapper._syncSwaps} function periodically. This flag should be set when you run an environment that
+     *  doesn't support long-running timers - e.g. serverless environments like Azure Function Apps or AWS Lambda
+     */
     noTimers?: boolean;
+    /**
+     * By setting this flag, the swapper doesn't subscribe to on-chain events. To make sure the swap states are
+     *  properly updated you should call the {@link Swapper._syncSwaps} function periodically. This flag should be
+     *  set when you run an environment that doesn't support long-running timers and websocket connections - e.g.
+     *  serverless environments like Azure Function Apps or AWS Lambda
+     */
     noEvents?: boolean;
+    /**
+     * By setting this flag, the swap objects will not be cached in the SDK and instead will always be loaded from
+     *  the persistent storage. By default, the SDK uses a `WeakRef` mapping of swaps, to ensure that when the same
+     *  swap is loaded concurrently, it returns the same object reference to both, making the changes on the object
+     *  atomic. This flag should be set to `true` when running in an environment where multiple instances of the SDK
+     *  access the same swap database - e.g. serverless environments like Azure Function Apps or AWS Lambda
+     */
     noSwapCache?: boolean;
+    /**
+     * Skip checking past swaps when the swapper is initiated with {@link Swapper.init}, you can call the
+     * {@link Swapper._syncSwaps} function later, to check the swaps. By default, the SDK checks the state
+     * of all the known swaps during init.
+     */
     dontCheckPastSwaps?: boolean;
+    /**
+     * Skip fetching the LPs when the swapper is initiated with {@link Swapper.init}, this means the list of available
+     *  tokens and swap limits won't be available immediately. LPs will be fetched automatically later, when a swap
+     *  is requested
+     */
     dontFetchLPs?: boolean;
+    /**
+     * By setting this flag the SDK persists all created swaps. By default, the SDK only saves and persists swaps that
+     *  are considered initiated, i.e. when `commit()`, `execute()` or `waitTillPayment` is called (or their respective
+     *  txs... prefixed variations).
+     */
     saveUninitializedSwaps?: boolean;
+    /**
+     * Automatically checks system time on initialize, if the system time drifts too far from the actual time
+     *  (as checked from multiple server sources) it adjusts the `Date.now()` function to return proper actual time.
+     */
     automaticClockDriftCorrection?: boolean;
 };
 /**
@@ -86,8 +156,8 @@ type ChainSpecificData<T extends ChainType> = {
     swapContract: T["Contract"];
     spvVaultContract: T["SpvVaultContract"];
     chainInterface: T["ChainInterface"];
-    btcRelay: BtcRelay<any, T["TX"], MempoolBitcoinBlock, T["Signer"]>;
-    synchronizer: RelaySynchronizer<any, T["TX"], MempoolBitcoinBlock>;
+    btcRelay: BtcRelay<any, T["TX"], BtcBlock, T["Signer"]>;
+    synchronizer: RelaySynchronizer<any, T["TX"], BtcBlock>;
     unifiedChainEvents: UnifiedSwapEventListener<T>;
     unifiedSwapStorage: UnifiedSwapStorage<T>;
     reviver: (val: any) => ISwap<T>;
@@ -137,7 +207,7 @@ export declare class Swapper<T extends MultiChain> extends EventEmitter<{
      * Bitcoin RPC for fetching bitcoin chain data
      * @internal
      */
-    readonly _bitcoinRpc: MempoolBitcoinRpc;
+    readonly _bitcoinRpc: BitcoinRpcWithAddressIndex<any>;
     /**
      * Bitcoin network specification
      * @internal
@@ -173,7 +243,10 @@ export declare class Swapper<T extends MultiChain> extends EventEmitter<{
      * Miscellaneous utility functions
      */
     readonly Utils: SwapperUtils<T>;
-    constructor(bitcoinRpc: MempoolBitcoinRpc, chainsData: CtorMultiChainData<T>, pricing: ISwapPrice<T>, tokens: WrapperCtorTokens<T>, messenger: Messenger, options?: SwapperOptions);
+    /**
+     * @internal
+     */
+    constructor(bitcoinRpc: BitcoinRpcWithAddressIndex<any>, lightningApi: LightningNetworkApi, bitcoinSynchronizer: (btcRelay: BtcRelay<any, any, any>) => RelaySynchronizer<any, any, any>, chainsData: CtorMultiChainData<T>, pricing: ISwapPrice<T>, tokens: WrapperCtorTokens<T>, messenger: Messenger, options?: SwapperOptions);
     private _init;
     private initPromise?;
     private initialized;

package/dist/swapper/Swapper.js

@@ -33,7 +33,6 @@ const Logger_1 = require("../utils/Logger");
 const LNURLWithdraw_1 = require("../types/lnurl/LNURLWithdraw");
 const LNURLPay_1 = require("../types/lnurl/LNURLPay");
 const RetryUtils_1 = require("../utils/RetryUtils");
-const btc_mempool_1 = require("@atomiqlabs/btc-mempool");
 const IEscrowSwap_1 = require("../swaps/escrow_swaps/IEscrowSwap");
 const LightningInvoiceCreateService_1 = require("../types/wallets/LightningInvoiceCreateService");
 /**
@@ -42,7 +41,10 @@ const LightningInvoiceCreateService_1 = require("../types/wallets/LightningInvoi
  * @category Core
  */
 class Swapper extends events_1.EventEmitter {
-    constructor(bitcoinRpc, chainsData, pricing, tokens, messenger, options) {
+    /**
+     * @internal
+     */
+    constructor(bitcoinRpc, lightningApi, bitcoinSynchronizer, chainsData, pricing, tokens, messenger, options) {
         super();
         this.logger = (0, Logger_1.getLogger)(this.constructor.name + ": ");
         this.initialized = false;
@@ -99,7 +101,7 @@ class Swapper extends events_1.EventEmitter {
         };
         this._chains = (0, Utils_1.objectMap)(chainsData, (chainData, key) => {
             const { swapContract, chainEvents, btcRelay, chainInterface, spvVaultContract, spvVaultWithdrawalDataConstructor } = chainData;
-            const synchronizer = new btc_mempool_1.MempoolBtcRelaySynchronizer(btcRelay, bitcoinRpc);
+            const synchronizer = bitcoinSynchronizer(btcRelay);
             const storageHandler = swapStorage(storagePrefix + chainData.chainId);
             const unifiedSwapStorage = new UnifiedSwapStorage_1.UnifiedSwapStorage(storageHandler, this.options.noSwapCache);
             const unifiedChainEvents = new UnifiedSwapEventListener_1.UnifiedSwapEventListener(unifiedSwapStorage, chainEvents);
@@ -113,7 +115,7 @@ class Swapper extends events_1.EventEmitter {
                 postRequestTimeout: this.options.postRequestTimeout,
                 bitcoinNetwork: this._btcNetwork
             });
-            wrappers[SwapType_1.SwapType.FROM_BTCLN] = new FromBTCLNWrapper_1.FromBTCLNWrapper(key, unifiedSwapStorage, unifiedChainEvents, chainInterface, swapContract, pricing, tokens, chainData.swapDataConstructor, bitcoinRpc, {
+            wrappers[SwapType_1.SwapType.FROM_BTCLN] = new FromBTCLNWrapper_1.FromBTCLNWrapper(key, unifiedSwapStorage, unifiedChainEvents, chainInterface, swapContract, pricing, tokens, chainData.swapDataConstructor, lightningApi, {
                 getRequestTimeout: this.options.getRequestTimeout,
                 postRequestTimeout: this.options.postRequestTimeout,
                 unsafeSkipLnNodeCheck: this.bitcoinNetwork === base_1.BitcoinNetwork.TESTNET4 || this.bitcoinNetwork === base_1.BitcoinNetwork.REGTEST
@@ -140,7 +142,7 @@ class Swapper extends events_1.EventEmitter {
                 });
             }
             if (swapContract.supportsInitWithoutClaimer) {
-                wrappers[SwapType_1.SwapType.FROM_BTCLN_AUTO] = new FromBTCLNAutoWrapper_1.FromBTCLNAutoWrapper(key, unifiedSwapStorage, unifiedChainEvents, chainInterface, swapContract, pricing, tokens, chainData.swapDataConstructor, bitcoinRpc, this.messenger, {
+                wrappers[SwapType_1.SwapType.FROM_BTCLN_AUTO] = new FromBTCLNAutoWrapper_1.FromBTCLNAutoWrapper(key, unifiedSwapStorage, unifiedChainEvents, chainInterface, swapContract, pricing, tokens, chainData.swapDataConstructor, lightningApi, this.messenger, {
                     getRequestTimeout: this.options.getRequestTimeout,
                     postRequestTimeout: this.options.postRequestTimeout,
                     unsafeSkipLnNodeCheck: this.bitcoinNetwork === base_1.BitcoinNetwork.TESTNET4 || this.bitcoinNetwork === base_1.BitcoinNetwork.REGTEST

package/dist/swapper/SwapperFactory.d.ts

@@ -38,11 +38,35 @@ type GetAllOptions<T extends readonly ChainInitializer<any, any, any>[]> = (T ex
  * @category Core
  */
 export type TypedSwapperOptions<T extends readonly ChainInitializer<any, any, any>[]> = {
+    /**
+     * A dictionary with chain-specific settings, like RPC URLs and others
+     */
     chains: GetAllOptions<T>;
-    chainStorageCtor?: <T extends StorageObject>(name: string) => IStorageManager<T>;
+    /**
+     * A function callback to retrieve a specific named storage container for key-value persistency. If not present, the
+     *  default browser Local Storage adapter is used. When you use the SDK in non-browser based environments you need
+     *  to provide this callback such that the SDK is able to use a custom storage adapter.
+     *
+     * @param storageName Name of the container to retrieve
+     */
+    chainStorageCtor?: <T extends StorageObject>(storageName: string) => IStorageManager<T>;
+    /**
+     * Maximum allowed pricing difference between intermediary (LP) returned rate and current market rate. In
+     *  parts-per-million, e.g. 2% is written as `20000`.
+     */
     pricingFeeDifferencePPM?: bigint;
+    /**
+     * Optional pricing function to use instead of default pricing APIs. See {@link CustomPriceFunction} for details.
+     */
     getPriceFn?: CustomPriceFunction;
+    /**
+     * Mempool API instance or URLs to use, if not provided the defaults will be used for the specified bitcoin network
+     */
     mempoolApi?: MempoolApi | MempoolBitcoinRpc | string | string[];
+    /**
+     * Data propagation messenger instance to use for broadcasting data to watchtowers. By default, a Nostr-based
+     *  messenger is used.
+     */
     messenger?: Messenger;
 } & SwapperOptions;
 /**

package/dist/swapper/SwapperFactory.js

@@ -140,7 +140,7 @@ class SwapperFactory {
                 };
             }), options.getPriceFn)) :
             RedundantSwapPrice_1.RedundantSwapPrice.createFromTokenMap(options.pricingFeeDifferencePPM ?? 10000n, pricingAssets);
-        return new Swapper_1.Swapper(bitcoinRpc, chains, swapPricing, pricingAssets, options.messenger, options);
+        return new Swapper_1.Swapper(bitcoinRpc, bitcoinRpc, (btcRelay) => new btc_mempool_1.MempoolBtcRelaySynchronizer(btcRelay, bitcoinRpc), chains, swapPricing, pricingAssets, options.messenger, options);
     }
     /**
      * Returns a new and already initialized swapper instance with the passed options. There is no need

package/dist/swaps/IAddressSwap.d.ts

@@ -1,13 +1,13 @@
 /**
  * Type guard to check if an object is an {@link IAddressSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export declare function isIAddressSwap(obj: any): obj is IAddressSwap;
 /**
  * Interface for swaps which require a user to send funds to a specific address
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export interface IAddressSwap {
     /**

package/dist/swaps/IAddressSwap.js

@@ -4,7 +4,7 @@ exports.isIAddressSwap = void 0;
 /**
  * Type guard to check if an object is an {@link IAddressSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 function isIAddressSwap(obj) {
     return obj != null &&

package/dist/swaps/IBTCWalletSwap.d.ts

@@ -6,13 +6,13 @@ import { BtcToken } from "../types/Token";
 /**
  * Type guard to check if an object is an {@link IBTCWalletSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export declare function isIBTCWalletSwap(obj: any): obj is IBTCWalletSwap;
 /**
  * Interface for swaps requiring Bitcoin wallet interaction
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export interface IBTCWalletSwap {
     /**

package/dist/swaps/IBTCWalletSwap.js

@@ -4,7 +4,7 @@ exports.isIBTCWalletSwap = void 0;
 /**
  * Type guard to check if an object is an {@link IBTCWalletSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 function isIBTCWalletSwap(obj) {
     return obj != null &&

package/dist/swaps/IClaimableSwap.d.ts

@@ -4,14 +4,14 @@ import { ISwapWrapper, SwapTypeDefinition } from "./ISwapWrapper";
 /**
  * Type guard to check if an object is an {@link IClaimableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export declare function isIClaimableSwap(obj: any): obj is IClaimableSwap;
 /**
  * Interface for swaps that can end up in a claimable state, requiring the user to claim the
  *  assets on the destination chain.
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export interface IClaimableSwap<T extends ChainType = ChainType, D extends SwapTypeDefinition<T, ISwapWrapper<T, D>, IClaimableSwap<T, D, S>> = SwapTypeDefinition<T, ISwapWrapper<T, any>, IClaimableSwap<T, any, any>>, S extends number = number> extends ISwap<T, D, S> {
     /**
@@ -24,7 +24,7 @@ export interface IClaimableSwap<T extends ChainType = ChainType, D extends SwapT
      *  function to wait till the claim transaction is observed, processed by the SDK and state of the swap
      *  properly updated.
      *
-     * @param _signer Address of the signer to create the refund transactions for
+     * @param _signer Address of the signer to create the settlement (claim) transactions for
      */
     txsClaim(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
     /**

package/dist/swaps/IClaimableSwap.js

@@ -4,7 +4,7 @@ exports.isIClaimableSwap = void 0;
 /**
  * Type guard to check if an object is an {@link IClaimableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 function isIClaimableSwap(obj) {
     return obj != null &&

package/dist/swaps/IClaimableSwapWrapper.d.ts

@@ -4,7 +4,7 @@ import { IClaimableSwap } from "./IClaimableSwap";
  * Interface for a swap wrapper for swaps that can end up in a claimable state, requiring the user to claim the
  *  assets on the destination chain.
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export interface IClaimableSwapWrapper<T extends ISwap & IClaimableSwap = ISwap & IClaimableSwap> {
     /**

package/dist/swaps/IRefundableSwap.d.ts

@@ -4,13 +4,13 @@ import { ISwapWrapper, SwapTypeDefinition } from "./ISwapWrapper";
 /**
  * Type guard to check if an object is an {@link IRefundableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export declare function isIRefundableSwap(obj: any): obj is IRefundableSwap;
 /**
  * Interface for swaps that can be refunded in case of failure
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export interface IRefundableSwap<T extends ChainType = ChainType, D extends SwapTypeDefinition<T, ISwapWrapper<T, D>, IRefundableSwap<T, D, S>> = SwapTypeDefinition<T, ISwapWrapper<T, any>, IRefundableSwap<T, any, any>>, S extends number = number> extends ISwap<T, D, S> {
     /**

package/dist/swaps/IRefundableSwap.js

@@ -4,7 +4,7 @@ exports.isIRefundableSwap = void 0;
 /**
  * Type guard to check if an object is an {@link IRefundableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 function isIRefundableSwap(obj) {
     return typeof (obj.isRefundable) === "function" &&

package/dist/swaps/ISwap.d.ts

@@ -15,7 +15,7 @@ import { PriceInfoType } from "../types/PriceInfoType";
 /**
  * Initialization data for creating a swap
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export type ISwapInit = {
     pricingInfo: PriceInfoType;
@@ -28,13 +28,13 @@ export type ISwapInit = {
 /**
  * Type guard to check if an object is an ISwapInit
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export declare function isISwapInit(obj: any): obj is ISwapInit;
 /**
  * Base abstract class for all swap types
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export declare abstract class ISwap<T extends ChainType = ChainType, D extends SwapTypeDefinition<T, ISwapWrapper<T, D>, ISwap<T, D, S>> = SwapTypeDefinition<T, ISwapWrapper<T, any>, ISwap<T, any, any>>, S extends number = number> {
     /**

package/dist/swaps/ISwap.js

@@ -11,7 +11,7 @@ const PriceInfoType_1 = require("../types/PriceInfoType");
 /**
  * Type guard to check if an object is an ISwapInit
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 function isISwapInit(obj) {
     return typeof obj === 'object' &&
@@ -27,7 +27,7 @@ exports.isISwapInit = isISwapInit;
 /**
  * Base abstract class for all swap types
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 class ISwap {
     constructor(wrapper, swapInitOrObj) {

package/dist/swaps/ISwapWithGasDrop.d.ts

@@ -4,13 +4,13 @@ import { SCToken } from "../types/Token";
 /**
  * Type guard to check if a swap has gas drop functionality
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export declare function isSwapWithGasDrop(swap: any): swap is ISwapWithGasDrop<any>;
 /**
  * Interface for swaps with gas drop functionality
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export interface ISwapWithGasDrop<T extends ChainType> {
     /**

package/dist/swaps/ISwapWithGasDrop.js

@@ -4,7 +4,7 @@ exports.isSwapWithGasDrop = void 0;
 /**
  * Type guard to check if a swap has gas drop functionality
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 function isSwapWithGasDrop(swap) {
     return swap != null && typeof (swap.getGasDropOutput) === "function";

package/dist/swaps/ISwapWrapper.d.ts

@@ -13,7 +13,7 @@ import { PriceInfoType } from "../types/PriceInfoType";
 /**
  * Options for swap wrapper configuration
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export type ISwapWrapperOptions = {
     getRequestTimeout?: number;
@@ -22,7 +22,7 @@ export type ISwapWrapperOptions = {
 /**
  * Token configuration for wrapper constructors
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export type WrapperCtorTokens<T extends MultiChain = MultiChain> = {
     ticker: string;
@@ -38,7 +38,7 @@ export type WrapperCtorTokens<T extends MultiChain = MultiChain> = {
 /**
  * Type definition linking wrapper and swap types
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export type SwapTypeDefinition<T extends ChainType, W extends ISwapWrapper<T, any>, S extends ISwap<T>> = {
     Wrapper: W;
@@ -47,7 +47,7 @@ export type SwapTypeDefinition<T extends ChainType, W extends ISwapWrapper<T, an
 /**
  * Base abstract class for swap handler implementations
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export declare abstract class ISwapWrapper<T extends ChainType, D extends SwapTypeDefinition<T, ISwapWrapper<T, D>, ISwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> {
     /**

package/dist/swaps/ISwapWrapper.js

@@ -7,7 +7,7 @@ const Logger_1 = require("../utils/Logger");
 /**
  * Base abstract class for swap handler implementations
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 class ISwapWrapper {
     constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, options, events) {

package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts

@@ -14,7 +14,7 @@ export type IEscrowSelfInitSwapDefinition<T extends ChainType, W extends IEscrow
  * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
  *  user needs to initiate the escrow on the smart chain side
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export declare abstract class IEscrowSelfInitSwap<T extends ChainType = ChainType, D extends IEscrowSelfInitSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSelfInitSwap<T, D, S>> = IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, any>, IEscrowSelfInitSwap<T, any, any>>, S extends number = number> extends IEscrowSwap<T, D, S> {
     /**
@@ -57,7 +57,9 @@ export declare abstract class IEscrowSelfInitSwap<T extends ChainType = ChainTyp
         required: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
     }>;
     /**
-     * Returns transactions for initiating (committing) the escrow on the smart chain side
+     * Returns transactions for initiating (committing) the escrow on the smart chain side. After sending the
+     *  transactions manually be sure to call the {@link waitTillCommited} function to wait till the initiation
+     *  transaction is observed, processed by the SDK and state of the swap properly updated.
      *
      * @param skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
      *  (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)

package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js

@@ -19,7 +19,7 @@ exports.isIEscrowSelfInitSwapInit = isIEscrowSelfInitSwapInit;
  * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
  *  user needs to initiate the escrow on the smart chain side
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 class IEscrowSelfInitSwap extends IEscrowSwap_1.IEscrowSwap {
     constructor(wrapper, swapInitOrObj) {

package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts

@@ -11,7 +11,7 @@ export declare function isIEscrowSwapInit<T extends SwapData>(obj: any): obj is
 /**
  * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export declare abstract class IEscrowSwap<T extends ChainType = ChainType, D extends IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSwap<T, D, S>> = IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, any>, IEscrowSwap<T, any, any>>, S extends number = number> extends ISwap<T, D, S> {
     /**

package/dist/swaps/escrow_swaps/IEscrowSwap.js

@@ -14,7 +14,7 @@ exports.isIEscrowSwapInit = isIEscrowSwapInit;
 /**
  * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 class IEscrowSwap extends ISwap_1.ISwap {
     constructor(wrapper, swapInitOrObj) {

package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts

@@ -13,7 +13,7 @@ export type IEscrowSwapDefinition<T extends ChainType, W extends IEscrowSwapWrap
 /**
  * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export declare abstract class IEscrowSwapWrapper<T extends ChainType, D extends IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends ISwapWrapper<T, D, O> {
     readonly abstract TYPE: SwapType;

package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js

@@ -6,7 +6,7 @@ const base_1 = require("@atomiqlabs/base");
 /**
  * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 class IEscrowSwapWrapper extends ISwapWrapper_1.ISwapWrapper {
     constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, swapDataDeserializer, options, events) {

package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts

@@ -17,7 +17,7 @@ export type IFromBTCLNDefinition<T extends ChainType, W extends IFromBTCLNWrappe
 /**
  * Base class for wrappers of escrow-based Lightning -> Smart chain swaps
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export declare abstract class IFromBTCLNWrapper<T extends ChainType, D extends IFromBTCLNDefinition<T, IFromBTCLNWrapper<T, D>, IEscrowSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends IFromBTCWrapper<T, D, O> {
     /**

package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js

@@ -11,7 +11,7 @@ const sha256_1 = require("@noble/hashes/sha256");
 /**
  * Base class for wrappers of escrow-based Lightning -> Smart chain swaps
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 class IFromBTCLNWrapper extends IFromBTCWrapper_1.IFromBTCWrapper {
     /**

package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts

@@ -12,7 +12,7 @@ export type IFromBTCSelfInitDefinition<T extends ChainType, W extends IFromBTCWr
  * Base class for legacy escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps,
  *  which require the user to manually initiate the escrow on the destination smart chain
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 export declare abstract class IFromBTCSelfInitSwap<T extends ChainType = ChainType, D extends IFromBTCSelfInitDefinition<T, IFromBTCWrapper<T, D>, IFromBTCSelfInitSwap<T, D, S>> = IFromBTCSelfInitDefinition<T, IFromBTCWrapper<T, any>, IFromBTCSelfInitSwap<T, any, any>>, S extends number = number> extends IEscrowSelfInitSwap<T, D, S> implements IAddressSwap, IClaimableSwap<T, D, S> {
     /**
@@ -121,10 +121,11 @@ export declare abstract class IFromBTCSelfInitSwap<T extends ChainType = ChainTy
      */
     getTotalDeposit(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
     /**
-     * Creates the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP)
-     *  into an escrow.
+     * Returns transactions for initiating (committing) the escrow on the destination smart chain side, pre-locking the
+     *  tokens from the intermediary (LP) into an escrow.
      *
-     * @inheritDoc
+     * @param skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited
+     *  yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)
      *
      * @throws {Error} When in invalid state to commit the swap
      */
@@ -133,7 +134,10 @@ export declare abstract class IFromBTCSelfInitSwap<T extends ChainType = ChainTy
      * Creates the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP)
      *  into an escrow.
      *
-     * @inheritDoc
+     * @param signer Signer to sign the transactions with, must be the same as used in the initialization
+     * @param abortSignal Abort signal
+     * @param skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited
+     *  yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)
      *
      * @throws {Error} If invalid signer is provided that doesn't match the swap data
      */

package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js

@@ -10,7 +10,7 @@ const TokenAmount_1 = require("../../../types/TokenAmount");
  * Base class for legacy escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps,
  *  which require the user to manually initiate the escrow on the destination smart chain
  *
- * @category Swaps
+ * @category Swaps/Abstract
  */
 class IFromBTCSelfInitSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     constructor(wrapper, initOrObj) {
@@ -157,10 +157,11 @@ class IFromBTCSelfInitSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     //////////////////////////////
     //// Commit
     /**
-     * Creates the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP)
-     *  into an escrow.
+     * Returns transactions for initiating (committing) the escrow on the destination smart chain side, pre-locking the
+     *  tokens from the intermediary (LP) into an escrow.
      *
-     * @inheritDoc
+     * @param skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited
+     *  yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)
      *
      * @throws {Error} When in invalid state to commit the swap
      */