@atomiqlabs/sdk 8.3.1 → 8.3.6

package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts

@@ -111,6 +111,13 @@ export class SingleAddressBitcoinWallet extends BitcoinWallet {
         return this.address;
     }
 
+    /**
+     * Returns the public key of the wallet
+     */
+    getPublicKey(): string {
+        return Buffer.from(this.pubkey).toString("hex");
+    }
+
     /**
      * @inheritDoc
      */

package/src/enums/FeeType.ts

@@ -2,7 +2,7 @@
 /**
  * Enum representing types of fees in a swap
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export enum FeeType {
     /**

package/src/index.ts

@@ -3,6 +3,8 @@ export {
     BitcoinRpc,
     BitcoinRpcWithAddressIndex,
     BitcoinNetwork,
+    BtcHeader,
+    BtcStoredHeader,
     BtcRelay,
     ChainData,
     ChainInterface,
@@ -30,6 +32,10 @@ export {
     MempoolApiError
 } from "@atomiqlabs/btc-mempool";
 
+export {
+    NostrMessenger
+} from "@atomiqlabs/messenger-nostr";
+
 export * from "./bitcoin/wallet/BitcoinWallet";
 export * from "./bitcoin/wallet/IBitcoinWallet";
 export * from "./bitcoin/wallet/SingleAddressBitcoinWallet";

package/src/intermediaries/Intermediary.ts

@@ -7,7 +7,7 @@ import {tryWithRetries} from "../utils/RetryUtils";
 /**
  * Services offered by an intermediary
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type ServicesType = {
     [key in SwapType]?: SwapHandlerInfoType
@@ -16,7 +16,7 @@ export type ServicesType = {
 /**
  * Reputation data for an intermediary on a single chain
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type SingleChainReputationType = {
     [token: string]: {
@@ -34,7 +34,7 @@ export type SingleChainReputationType = {
 /**
  * Smart chain liquidity data
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type SCLiquidity = {
     [token: string]: bigint
@@ -43,7 +43,7 @@ export type SCLiquidity = {
 /**
  * Represents an intermediary (liquidity provider)
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export class Intermediary {
 

package/src/intermediaries/IntermediaryDiscovery.ts

@@ -12,7 +12,7 @@ import {tryWithRetries} from "../utils/RetryUtils";
 /**
  * Swap handler type mapping for intermediary communication
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export enum SwapHandlerType {
     TO_BTC = "TO_BTC",
@@ -28,7 +28,7 @@ export enum SwapHandlerType {
 /**
  * Swap handler information type
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type SwapHandlerInfoType = {
     swapFeePPM: number,
@@ -50,7 +50,7 @@ type InfoHandlerResponseEnvelope = {
 /**
  * Token bounds (min/max) for swaps
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type TokenBounds = {
     [token: string]: {
@@ -62,7 +62,7 @@ export type TokenBounds = {
 /**
  * Multi-chain token bounds (min/max) for swaps
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type MultichainTokenBounds = {
     [chainId: string]: TokenBounds
@@ -71,7 +71,7 @@ export type MultichainTokenBounds = {
 /**
  * Swap bounds by swap protocol type
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type SwapBounds = {
     [key in SwapType]?: TokenBounds
@@ -80,7 +80,7 @@ export type SwapBounds = {
 /**
  * Multi-chain swap bounds
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export type MultichainSwapBounds = {
     [key in SwapType]?: MultichainTokenBounds
@@ -110,6 +110,8 @@ function swapHandlerTypeToSwapType(swapHandlerType: SwapHandlerType): SwapType {
             return SwapType.SPV_VAULT_FROM_BTC;
         case SwapHandlerType.FROM_BTCLN_AUTO:
             return SwapType.FROM_BTCLN_AUTO;
+        default:
+            return SwapType.TRUSTED_FROM_BTCLN;
     }
 }
 
@@ -155,7 +157,7 @@ const DEFAULT_CHAIN = "SOLANA";
 /**
  * Discovery service for available intermediaries (liquidity providers)
  *
- * @category Pricing and LPs
+ * @category LPs
  */
 export class IntermediaryDiscovery extends EventEmitter {
 

package/src/prices/RedundantSwapPrice.ts

@@ -14,7 +14,7 @@ import {tryWithRetries} from "../utils/RetryUtils";
 /**
  * Asset configuration for redundant swap pricing
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type RedundantSwapPriceAssets<T extends MultiChain> = {
     binancePair?: string,
@@ -51,7 +51,7 @@ const logger = getLogger("RedundantSwapPrice: ");
  * Swap price API using multiple price sources, handles errors on the APIs and automatically switches between them, such
  *  that there always is a functional API
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class RedundantSwapPrice<T extends MultiChain> extends ICachedSwapPrice<T> {
 

package/src/prices/SingleSwapPrice.ts

@@ -5,7 +5,7 @@ import {ChainIds, MultiChain} from "../swapper/Swapper";
 /**
  * Swap price API using a single price source
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class SingleSwapPrice<T extends MultiChain> extends ICachedSwapPrice<T> {
 

package/src/prices/SwapPriceWithChain.ts

@@ -7,7 +7,7 @@ import {PriceInfoType} from "../types/PriceInfoType";
 /**
  * Chain-specific wrapper for swap pricing
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class SwapPriceWithChain<T extends MultiChain, ChainIdentifier extends ChainIds<T>> {
 
@@ -29,7 +29,7 @@ export class SwapPriceWithChain<T extends MultiChain, ChainIdentifier extends Ch
      * @param feePPM PPM fee rate as reported by the intermediary
      * @param paidToken Amount of token to be paid to the swap
      * @param tokenAddress Token address to be paid
-     * @param abortSignal
+     * @param abortSignal Abort signal
      * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      */
     public async isValidAmountSend(
@@ -54,7 +54,7 @@ export class SwapPriceWithChain<T extends MultiChain, ChainIdentifier extends Ch
      * @param feePPM PPM fee rate as reported by the intermediary
      * @param receiveToken Amount of token to be received from the swap
      * @param tokenAddress Token address to be received
-     * @param abortSignal
+     * @param abortSignal Abort signal
      * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      */
     public async isValidAmountReceive(
@@ -75,12 +75,11 @@ export class SwapPriceWithChain<T extends MultiChain, ChainIdentifier extends Ch
      * Pre-fetches the pricing data for a given token, such that further calls to {@link isValidAmountReceive} or
      *  {@link isValidAmountSend} are quicker and don't need to wait for the price fetch
      *
-     * @param chainIdentifier Chain identifier of the smart chain
      * @param tokenAddress Token address
-     * @param abortSignal
+     * @param abortSignal Abort signal
      */
-    public preFetchPrice(token: string, abortSignal?: AbortSignal): Promise<bigint> {
-        return this.swapPrice.preFetchPrice<ChainIdentifier>(this.chainIdentifier, token, abortSignal);
+    public preFetchPrice(tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint> {
+        return this.swapPrice.preFetchPrice<ChainIdentifier>(this.chainIdentifier, tokenAddress, abortSignal);
     }
 
     /**

package/src/prices/abstract/IPriceProvider.ts

@@ -2,7 +2,7 @@ import {ChainIds, MultiChain} from "../../swapper/Swapper";
 
 /**
  * Coin type definition for price providers
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type CoinType = {
     coinId: string;
@@ -11,7 +11,7 @@ export type CoinType = {
 
 /**
  * Constructor coin types for price providers
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type CtorCoinTypes<T extends MultiChain> = {
     coinId?: string,
@@ -25,7 +25,7 @@ export type CtorCoinTypes<T extends MultiChain> = {
 
 /**
  * Coin types mapping by chain
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type CoinTypes<T extends MultiChain> = {
     [chainId in keyof T]?: {
@@ -35,7 +35,7 @@ export type CoinTypes<T extends MultiChain> = {
 
 /**
  * Abstract base class for price provider implementations
- * @category Pricing and LPs
+ * @category Pricing
  */
 export abstract class IPriceProvider<T extends MultiChain> {
 

package/src/prices/abstract/ISwapPrice.ts

@@ -5,7 +5,7 @@ import {PriceInfoType} from "../../types/PriceInfoType";
 /**
  * Abstract base class for swap pricing implementations
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
 

package/src/prices/providers/BinancePriceProvider.ts

@@ -11,7 +11,7 @@ export type BinanceResponse = {
 /**
  * Price provider using Binance exchange API
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class BinancePriceProvider<T extends MultiChain> extends ExchangePriceProvider<T> {
 

package/src/prices/providers/CoinGeckoPriceProvider.ts

@@ -9,7 +9,7 @@ export type CoinGeckoResponse<Currency extends string> = {
 
 /**
  * Price provider using CoinGecko API
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class CoinGeckoPriceProvider<T extends MultiChain> extends HttpPriceProvider<T> {
 

package/src/prices/providers/CoinPaprikaPriceProvider.ts

@@ -13,7 +13,7 @@ export type CoinPaprikaResponse<Currency extends string> = {
 
 /**
  * Price provider using CoinPaprika API
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class CoinPaprikaPriceProvider<T extends MultiChain> extends HttpPriceProvider<T> {
 

package/src/prices/providers/CustomPriceProvider.ts

@@ -5,7 +5,7 @@ import {CustomPriceFunction} from "../../types/CustomPriceFunction";
 /**
  * Price provider using custom pricing function
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class CustomPriceProvider<T extends MultiChain> extends IPriceProvider<T> {
 

package/src/prices/providers/KrakenPriceProvider.ts

@@ -22,7 +22,7 @@ export type KrakenResponse = {
 
 /**
  * Price provider using Kraken exchange API
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class KrakenPriceProvider<T extends MultiChain> extends ExchangePriceProvider<T> {
 

package/src/prices/providers/OKXPriceProvider.ts

@@ -22,7 +22,7 @@ export type OKXResponse = {
 
 /**
  * Price provider using OKX exchange API
- * @category Pricing and LPs
+ * @category Pricing
  */
 export class OKXPriceProvider<T extends MultiChain> extends ExchangePriceProvider<T> {
 

package/src/swapper/Swapper.ts

@@ -1,10 +1,10 @@
 import {ISwapPrice} from "../prices/abstract/ISwapPrice";
 import {
-    BitcoinNetwork,
+    BitcoinNetwork, BitcoinRpc, BitcoinRpcWithAddressIndex, BtcBlock,
     BtcRelay,
     ChainData,
     ChainSwapType,
-    ChainType,
+    ChainType, LightningNetworkApi,
     Messenger,
     RelaySynchronizer
 } from "@atomiqlabs/base";
@@ -62,7 +62,6 @@ import {isLNURLWithdraw, LNURLWithdraw} from "../types/lnurl/LNURLWithdraw";
 import {isLNURLPay, LNURLPay} from "../types/lnurl/LNURLPay";
 import {tryWithRetries} from "../utils/RetryUtils";
 import {NotNever} from "../utils/TypeUtils";
-import {MempoolApi, MempoolBitcoinBlock, MempoolBitcoinRpc, MempoolBtcRelaySynchronizer} from "@atomiqlabs/btc-mempool";
 import {IEscrowSwap} from "../swaps/escrow_swaps/IEscrowSwap";
 import {LightningInvoiceCreateService, isLightningInvoiceCreateService} from "../types/wallets/LightningInvoiceCreateService";
 
@@ -71,25 +70,96 @@ import {LightningInvoiceCreateService, isLightningInvoiceCreateService} from "..
  * @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},
-    storagePrefix?: string
+    /**
+     * 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,
-    saveUninitializedSwaps?: boolean, //automatically persist all created swaps - by default only initiated swaps are persisted
+    /**
+     * 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
 };
 
@@ -116,8 +186,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>
@@ -182,7 +252,7 @@ export 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
@@ -220,8 +290,13 @@ export class Swapper<T extends MultiChain> extends EventEmitter<{
      */
     readonly Utils: SwapperUtils<T>;
 
+    /**
+     * @internal
+     */
     constructor(
-        bitcoinRpc: MempoolBitcoinRpc,
+        bitcoinRpc: BitcoinRpcWithAddressIndex<any>,
+        lightningApi: LightningNetworkApi,
+        bitcoinSynchronizer: (btcRelay: BtcRelay<any, any, any>) => RelaySynchronizer<any, any, any>,
         chainsData: CtorMultiChainData<T>,
         pricing: ISwapPrice<T>,
         tokens: WrapperCtorTokens<T>,
@@ -279,7 +354,7 @@ export class Swapper<T extends MultiChain> extends EventEmitter<{
                 swapContract, chainEvents, btcRelay,
                 chainInterface, spvVaultContract, spvVaultWithdrawalDataConstructor
             } = chainData;
-            const synchronizer = new MempoolBtcRelaySynchronizer(btcRelay, bitcoinRpc);
+            const synchronizer = bitcoinSynchronizer(btcRelay);
 
             const storageHandler = swapStorage(storagePrefix + chainData.chainId);
             const unifiedSwapStorage = new UnifiedSwapStorage<T[InputKey]>(storageHandler, this.options.noSwapCache);
@@ -326,7 +401,7 @@ export class Swapper<T extends MultiChain> extends EventEmitter<{
                 pricing,
                 tokens,
                 chainData.swapDataConstructor,
-                bitcoinRpc,
+                lightningApi,
                 {
                     getRequestTimeout: this.options.getRequestTimeout,
                     postRequestTimeout: this.options.postRequestTimeout,
@@ -409,7 +484,7 @@ export class Swapper<T extends MultiChain> extends EventEmitter<{
                     pricing,
                     tokens,
                     chainData.swapDataConstructor,
-                    bitcoinRpc,
+                    lightningApi,
                     this.messenger,
                     {
                         getRequestTimeout: this.options.getRequestTimeout,

package/src/swapper/SwapperFactory.ts

@@ -3,7 +3,7 @@ import {
     BitcoinNetwork,
     ChainType,
     StorageObject,
-    IStorageManager, Messenger, ChainInitializer
+    IStorageManager, Messenger, ChainInitializer, BtcRelay
 } from "@atomiqlabs/base";
 import {SmartChainAssets, SmartChainAssetTickers} from "../SmartChainAssets";
 import {NostrMessenger} from "@atomiqlabs/messenger-nostr";
@@ -16,7 +16,7 @@ import {RedundantSwapPrice, RedundantSwapPriceAssets} from "../prices/RedundantS
 import {LocalStorageManager} from "../storage-browser/LocalStorageManager";
 import {SingleSwapPrice} from "../prices/SingleSwapPrice";
 import {CustomPriceFunction} from "../types/CustomPriceFunction";
-import {MempoolApi, MempoolBitcoinRpc} from "@atomiqlabs/btc-mempool";
+import {MempoolApi, MempoolBitcoinRpc, MempoolBtcRelaySynchronizer} from "@atomiqlabs/btc-mempool";
 
 //Helper types
 /**
@@ -63,11 +63,35 @@ type GetAllOptions<T extends readonly ChainInitializer<any, any, any>[]> =
  * @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;
 
@@ -252,6 +276,8 @@ export class SwapperFactory<T extends readonly ChainInitializer<any, ChainType,
 
         return new Swapper<ToMultichain<T>>(
             bitcoinRpc,
+            bitcoinRpc,
+            (btcRelay: BtcRelay<any, any, any>) => new MempoolBtcRelaySynchronizer(btcRelay, bitcoinRpc),
             chains as any,
             swapPricing,
             pricingAssets,

package/src/swaps/IAddressSwap.ts

@@ -1,7 +1,7 @@
 /**
  * Type guard to check if an object is an {@link IAddressSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export function isIAddressSwap(obj: any): obj is IAddressSwap {
     return obj!=null &&
@@ -12,7 +12,7 @@ export 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/src/swaps/IBTCWalletSwap.ts

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

package/src/swaps/IClaimableSwap.ts

@@ -5,7 +5,7 @@ import {ISwapWrapper, SwapTypeDefinition} from "./ISwapWrapper";
 /**
  * Type guard to check if an object is an {@link IClaimableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export function isIClaimableSwap(obj: any): obj is IClaimableSwap {
     return obj!=null &&
@@ -18,7 +18,7 @@ export 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,
@@ -37,7 +37,7 @@ export interface IClaimableSwap<
      *  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/src/swaps/IClaimableSwapWrapper.ts

@@ -5,7 +5,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/src/swaps/IRefundableSwap.ts

@@ -5,7 +5,7 @@ import {ISwapWrapper, SwapTypeDefinition} from "./ISwapWrapper";
 /**
  * Type guard to check if an object is an {@link IRefundableSwap}
  *
- * @category Swaps
+ * @category Swaps/Types
  */
 export function isIRefundableSwap(obj: any): obj is IRefundableSwap {
     return typeof(obj.isRefundable) === "function" &&
@@ -16,7 +16,7 @@ export 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,