@atomiqlabs/sdk 8.1.8 → 8.3.1

package/dist/bitcoin/wallet/BitcoinWallet.d.ts

@@ -8,6 +8,7 @@ import { Buffer } from "buffer";
 import { BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
 /**
  * UTXO data structure for Bitcoin wallets
+ *
  * @category Bitcoin
  */
 export type BitcoinWalletUtxo = {
@@ -25,26 +26,61 @@ export type BitcoinWalletUtxo = {
 };
 /**
  * Identifies the address type of a Bitcoin address
+ *
  * @category Bitcoin
  */
 export declare function identifyAddressType(address: string, network: BTC_NETWORK): CoinselectAddressTypes;
 /**
- * Abstract base class for Bitcoin wallet implementations
+ * Abstract base class for Bitcoin wallet implementations, using bitcoin rpc with address index
+ *  as a backend for fetching balances, UTXOs, etc.
+ *
  * @category Bitcoin
  */
 export declare abstract class BitcoinWallet implements IBitcoinWallet {
-    rpc: BitcoinRpcWithAddressIndex<any>;
-    network: BTC_NETWORK;
-    feeMultiplier: number;
-    feeOverride?: number;
+    protected readonly rpc: BitcoinRpcWithAddressIndex<any>;
+    protected readonly network: BTC_NETWORK;
+    protected feeMultiplier: number;
+    protected feeOverride?: number;
     constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, network: BTC_NETWORK, feeMultiplier?: number, feeOverride?: number);
+    /**
+     * @inheritDoc
+     */
     getFeeRate(): Promise<number>;
+    /**
+     * Internal helper function for sending a raw transaction through the underlying RPC
+     *
+     * @param rawHex Serialized bitcoin transaction in hexadecimal format
+     * @returns txId Transaction ID of the submitted bitcoin transaction
+     *
+     * @protected
+     */
     protected _sendTransaction(rawHex: string): Promise<string>;
+    /**
+     * Internal helper function for fetching the balance of the wallet given a specific bitcoin wallet address
+     *
+     * @param address
+     * @protected
+     */
     protected _getBalance(address: string): Promise<{
         confirmedBalance: bigint;
         unconfirmedBalance: bigint;
     }>;
+    /**
+     * Internal helper function for fetching the UTXO set of a given wallet address
+     *
+     * @param sendingAddress
+     * @param sendingAddressType
+     * @protected
+     */
     protected _getUtxoPool(sendingAddress: string, sendingAddressType: CoinselectAddressTypes): Promise<BitcoinWalletUtxo[]>;
+    /**
+     *
+     * @param sendingAccounts
+     * @param recipient
+     * @param amount
+     * @param feeRate
+     * @protected
+     */
     protected _getPsbt(sendingAccounts: {
         pubkey: string;
         address: string;

package/dist/bitcoin/wallet/BitcoinWallet.js

@@ -9,6 +9,7 @@ const BitcoinUtils_1 = require("../../utils/BitcoinUtils");
 const Logger_1 = require("../../utils/Logger");
 /**
  * Identifies the address type of a Bitcoin address
+ *
  * @category Bitcoin
  */
 function identifyAddressType(address, network) {
@@ -30,7 +31,9 @@ function identifyAddressType(address, network) {
 exports.identifyAddressType = identifyAddressType;
 const logger = (0, Logger_1.getLogger)("BitcoinWallet: ");
 /**
- * Abstract base class for Bitcoin wallet implementations
+ * Abstract base class for Bitcoin wallet implementations, using bitcoin rpc with address index
+ *  as a backend for fetching balances, UTXOs, etc.
+ *
  * @category Bitcoin
  */
 class BitcoinWallet {
@@ -40,18 +43,42 @@ class BitcoinWallet {
         this.feeMultiplier = feeMultiplier;
         this.feeOverride = feeOverride;
     }
+    /**
+     * @inheritDoc
+     */
     async getFeeRate() {
         if (this.feeOverride != null) {
             return this.feeOverride;
         }
         return Math.floor((await this.rpc.getFeeRate()) * this.feeMultiplier);
     }
+    /**
+     * Internal helper function for sending a raw transaction through the underlying RPC
+     *
+     * @param rawHex Serialized bitcoin transaction in hexadecimal format
+     * @returns txId Transaction ID of the submitted bitcoin transaction
+     *
+     * @protected
+     */
     _sendTransaction(rawHex) {
         return this.rpc.sendRawTransaction(rawHex);
     }
+    /**
+     * Internal helper function for fetching the balance of the wallet given a specific bitcoin wallet address
+     *
+     * @param address
+     * @protected
+     */
     _getBalance(address) {
         return this.rpc.getAddressBalances(address);
     }
+    /**
+     * Internal helper function for fetching the UTXO set of a given wallet address
+     *
+     * @param sendingAddress
+     * @param sendingAddressType
+     * @protected
+     */
     async _getUtxoPool(sendingAddress, sendingAddressType) {
         const utxos = await this.rpc.getAddressUTXOs(sendingAddress);
         let totalSpendable = 0;
@@ -81,6 +108,14 @@ class BitcoinWallet {
         logger.debug("_getUtxoPool(): Total spendable value: " + totalSpendable + " num utxos: " + utxoPool.length);
         return utxoPool;
     }
+    /**
+     *
+     * @param sendingAccounts
+     * @param recipient
+     * @param amount
+     * @param feeRate
+     * @protected
+     */
     async _getPsbt(sendingAccounts, recipient, amount, feeRate) {
         const psbt = new btc_signer_1.Transaction({ PSBTVersion: 0 });
         psbt.addOutput({

package/dist/bitcoin/wallet/IBitcoinWallet.d.ts

@@ -1,25 +1,75 @@
 import { Transaction } from "@scure/btc-signer";
 /**
- * Type guard to check if an object implements IBitcoinWallet
+ * Type guard to check if an object implements {@link IBitcoinWallet}
+ *
  * @category Bitcoin
  */
 export declare function isIBitcoinWallet(val: any): val is IBitcoinWallet;
 /**
- * Interface for Bitcoin wallet operations
+ * Interface to be implemented by Bitcoin wallets
+ *
  * @category Bitcoin
  */
 export interface IBitcoinWallet {
+    /**
+     * Signs and broadcasts a transaction sending `amount` of sats to `address`, optionally with the
+     *  `feeRate` sats/vB fee rate.
+     *
+     * @param address Destination address of the transaction
+     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
     sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
+    /**
+     * Funds (populates the inputs) for a given PSBT from wallet's UTXO set
+     *
+     * @param psbt PSBT to add the inputs to
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
     fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
+    /**
+     * Signs inputs in the provided PSBT
+     *
+     * @param psbt A PSBT to sign
+     * @param signInputs Indices of the inputs to sign
+     */
     signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
+    /**
+     * Returns the current fee rate in sats/vB
+     */
     getFeeRate(): Promise<number>;
+    /**
+     * Estimates a total fee in satoshis for a given transaction
+     *
+     * @param address Destination address of the transaction
+     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
     getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
+    /**
+     * Estimates a total fee in satoshis for a given transaction as identified by the PSBT
+     *
+     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
     getFundedPsbtFee(psbt: Transaction, feeRate?: number): Promise<number>;
+    /**
+     * Returns the bitcoin address suitable for receiving funds
+     */
     getReceiveAddress(): string;
+    /**
+     * Returns confirmed and unconfirmed balance in satoshis of the wallet
+     */
     getBalance(): Promise<{
         confirmedBalance: bigint;
         unconfirmedBalance: bigint;
     }>;
+    /**
+     * Returns the maximum spendable balance in satoshis given a specific PSBT that should be funded
+     *
+     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
     getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
         balance: bigint;
         feeRate: number;

package/dist/bitcoin/wallet/IBitcoinWallet.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isIBitcoinWallet = void 0;
 /**
- * Type guard to check if an object implements IBitcoinWallet
+ * Type guard to check if an object implements {@link IBitcoinWallet}
+ *
  * @category Bitcoin
  */
 function isIBitcoinWallet(val) {

package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts

@@ -4,37 +4,72 @@ import { Transaction } from "@scure/btc-signer";
 import { BitcoinWallet } from "./BitcoinWallet";
 import { BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
 /**
- * Bitcoin wallet implementation for single-address scenarios
+ * Bitcoin wallet implementation deriving a single address from a WIF encoded private key
+ *
  * @category Bitcoin
  */
 export declare class SingleAddressBitcoinWallet extends BitcoinWallet {
-    readonly privKey?: Uint8Array;
-    readonly pubkey: Uint8Array;
-    readonly address: string;
-    readonly addressType: CoinselectAddressTypes;
+    protected readonly privKey?: Uint8Array;
+    protected readonly pubkey: Uint8Array;
+    protected readonly address: string;
+    protected readonly addressType: CoinselectAddressTypes;
     constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, network: BTC_NETWORK, addressDataOrWIF: string | {
         address: string;
         publicKey: string;
     }, feeMultiplier?: number, feeOverride?: number);
-    protected toBitcoinWalletAccounts(): {
+    /**
+     * Returns all the wallet addresses controlled by the wallet
+     *
+     * @protected
+     */
+    protected toBitcoinWalletAccounts(): [{
         pubkey: string;
         address: string;
         addressType: CoinselectAddressTypes;
-    }[];
+    }];
+    /**
+     * @inheritDoc
+     */
     sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
+    /**
+     * @inheritDoc
+     */
     fundPsbt(inputPsbt: Transaction, feeRate?: number): Promise<Transaction>;
+    /**
+     * @inheritDoc
+     */
     signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
+    /**
+     * @inheritDoc
+     */
     getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
+    /**
+     * @inheritDoc
+     */
     getFundedPsbtFee(basePsbt: Transaction, feeRate?: number): Promise<number>;
+    /**
+     * @inheritDoc
+     */
     getReceiveAddress(): string;
+    /**
+     * @inheritDoc
+     */
     getBalance(): Promise<{
         confirmedBalance: bigint;
         unconfirmedBalance: bigint;
     }>;
+    /**
+     * @inheritDoc
+     */
     getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
         balance: bigint;
         feeRate: number;
         totalFee: number;
     }>;
+    /**
+     * Generates a new random private key WIF that can be used to instantiate the bitcoin wallet instance
+     *
+     * @returns A WIF encoded bitcoin private key
+     */
     static generateRandomPrivateKey(network?: BTC_NETWORK): string;
 }

package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js

@@ -6,7 +6,8 @@ const btc_signer_1 = require("@scure/btc-signer");
 const buffer_1 = require("buffer");
 const BitcoinWallet_1 = require("./BitcoinWallet");
 /**
- * Bitcoin wallet implementation for single-address scenarios
+ * Bitcoin wallet implementation deriving a single address from a WIF encoded private key
+ *
  * @category Bitcoin
  */
 class SingleAddressBitcoinWallet extends BitcoinWallet_1.BitcoinWallet {
@@ -31,11 +32,19 @@ class SingleAddressBitcoinWallet extends BitcoinWallet_1.BitcoinWallet {
         }
         this.addressType = (0, BitcoinWallet_1.identifyAddressType)(this.address, network);
     }
+    /**
+     * Returns all the wallet addresses controlled by the wallet
+     *
+     * @protected
+     */
     toBitcoinWalletAccounts() {
         return [{
                 pubkey: buffer_1.Buffer.from(this.pubkey).toString("hex"), address: this.address, addressType: this.addressType
             }];
     }
+    /**
+     * @inheritDoc
+     */
     async sendTransaction(address, amount, feeRate) {
         if (!this.privKey)
             throw new Error("Not supported.");
@@ -47,6 +56,9 @@ class SingleAddressBitcoinWallet extends BitcoinWallet_1.BitcoinWallet {
         const txHex = buffer_1.Buffer.from(psbt.extract()).toString("hex");
         return await super._sendTransaction(txHex);
     }
+    /**
+     * @inheritDoc
+     */
     async fundPsbt(inputPsbt, feeRate) {
         const { psbt } = await super._fundPsbt(this.toBitcoinWalletAccounts(), inputPsbt, feeRate);
         if (psbt == null) {
@@ -54,6 +66,9 @@ class SingleAddressBitcoinWallet extends BitcoinWallet_1.BitcoinWallet {
         }
         return psbt;
     }
+    /**
+     * @inheritDoc
+     */
     async signPsbt(psbt, signInputs) {
         if (!this.privKey)
             throw new Error("Not supported.");
@@ -62,23 +77,43 @@ class SingleAddressBitcoinWallet extends BitcoinWallet_1.BitcoinWallet {
         }
         return psbt;
     }
+    /**
+     * @inheritDoc
+     */
     async getTransactionFee(address, amount, feeRate) {
         const { fee } = await super._getPsbt(this.toBitcoinWalletAccounts(), address, Number(amount), feeRate);
         return fee;
     }
+    /**
+     * @inheritDoc
+     */
     async getFundedPsbtFee(basePsbt, feeRate) {
         const { fee } = await super._fundPsbt(this.toBitcoinWalletAccounts(), basePsbt, feeRate);
         return fee;
     }
+    /**
+     * @inheritDoc
+     */
     getReceiveAddress() {
         return this.address;
     }
+    /**
+     * @inheritDoc
+     */
     getBalance() {
         return this._getBalance(this.address);
     }
+    /**
+     * @inheritDoc
+     */
     getSpendableBalance(psbt, feeRate) {
         return this._getSpendableBalance([{ address: this.address, addressType: this.addressType }], psbt, feeRate);
     }
+    /**
+     * Generates a new random private key WIF that can be used to instantiate the bitcoin wallet instance
+     *
+     * @returns A WIF encoded bitcoin private key
+     */
     static generateRandomPrivateKey(network) {
         return (0, btc_signer_1.WIF)(network).encode((0, utils_1.randomPrivateKeyBytes)());
     }

package/dist/enums/FeeType.d.ts

@@ -1,8 +1,15 @@
 /**
  * Enum representing types of fees in a swap
+ *
  * @category Pricing and LPs
  */
 export declare enum FeeType {
+    /**
+     * Swap fee taken by the LP
+     */
     SWAP = 0,
+    /**
+     * Network fee to cover the transactions on the destination (output) network
+     */
     NETWORK_OUTPUT = 1
 }

package/dist/enums/FeeType.js

@@ -3,10 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FeeType = void 0;
 /**
  * Enum representing types of fees in a swap
+ *
  * @category Pricing and LPs
  */
 var FeeType;
 (function (FeeType) {
+    /**
+     * Swap fee taken by the LP
+     */
     FeeType[FeeType["SWAP"] = 0] = "SWAP";
+    /**
+     * Network fee to cover the transactions on the destination (output) network
+     */
     FeeType[FeeType["NETWORK_OUTPUT"] = 1] = "NETWORK_OUTPUT";
 })(FeeType = exports.FeeType || (exports.FeeType = {}));

package/dist/enums/SwapAmountType.d.ts

@@ -1,8 +1,15 @@
 /**
  * Enum representing whether the swap amount is exact input or exact output
+ *
  * @category Core
  */
 export declare enum SwapAmountType {
+    /**
+     * Swap amount specified in the input token
+     */
     EXACT_IN = 1,
+    /**
+     * Swap amount specified in the output token
+     */
     EXACT_OUT = 0
 }

package/dist/enums/SwapAmountType.js

@@ -3,10 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwapAmountType = void 0;
 /**
  * Enum representing whether the swap amount is exact input or exact output
+ *
  * @category Core
  */
 var SwapAmountType;
 (function (SwapAmountType) {
+    /**
+     * Swap amount specified in the input token
+     */
     SwapAmountType[SwapAmountType["EXACT_IN"] = 1] = "EXACT_IN";
+    /**
+     * Swap amount specified in the output token
+     */
     SwapAmountType[SwapAmountType["EXACT_OUT"] = 0] = "EXACT_OUT";
 })(SwapAmountType = exports.SwapAmountType || (exports.SwapAmountType = {}));

package/dist/enums/SwapDirection.d.ts

@@ -1,8 +1,15 @@
 /**
  * Enum representing the direction of a swap (from or to Bitcoin)
+ *
  * @category Core
  */
 export declare enum SwapDirection {
+    /**
+     * Swaps from bitcoin to smart chains (Solana, Starknet, EVM, etc.)
+     */
     FROM_BTC = 0,
+    /**
+     * Swaps from smart chains (Solana, Starknet, EVM, etc.) to bitcoin
+     */
     TO_BTC = 1
 }

package/dist/enums/SwapDirection.js

@@ -3,10 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwapDirection = void 0;
 /**
  * Enum representing the direction of a swap (from or to Bitcoin)
+ *
  * @category Core
  */
 var SwapDirection;
 (function (SwapDirection) {
+    /**
+     * Swaps from bitcoin to smart chains (Solana, Starknet, EVM, etc.)
+     */
     SwapDirection[SwapDirection["FROM_BTC"] = 0] = "FROM_BTC";
+    /**
+     * Swaps from smart chains (Solana, Starknet, EVM, etc.) to bitcoin
+     */
     SwapDirection[SwapDirection["TO_BTC"] = 1] = "TO_BTC";
 })(SwapDirection = exports.SwapDirection || (exports.SwapDirection = {}));

package/dist/enums/SwapType.d.ts

@@ -1,14 +1,75 @@
 /**
- * Enum representing different types of swaps
+ * Enum representing different types of swap protocols used by atomiq.
+ *
  * @category Core
  */
 export declare enum SwapType {
+    /**
+     * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation of the swap
+     *  on the destination chain.
+     *
+     * Handled by {@link FromBTCWrapper} & {@link FromBTCSwap}.
+     *
+     * Legacy swaps are only used on Solana!
+     */
     FROM_BTC = 0,
+    /**
+     * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement of the swap on the
+     *  destination network once the lightning network payment is received by the LP
+     *
+     * Handled by {@link FromBTCLNWrapper} & {@link FromBTCLNSwap}.
+     *
+     * Legacy swaps are only used on Solana!
+     */
     FROM_BTCLN = 1,
+    /**
+     * Escrow based (PrTLC) swap for Smart chains -> Bitcoin
+     *
+     * Handled by {@link ToBTCWrapper} & {@link ToBTCSwap}.
+     */
     TO_BTC = 2,
+    /**
+     * Escrow based (HTLC) swap for Smart chains -> Bitcoin Lightning
+     *
+     * Handled by {@link ToBTCLNWrapper} & {@link ToBTCLNSwap}.
+     */
     TO_BTCLN = 3,
+    /**
+     * 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 and doesn't support newer
+     *  {@link SPV_VAULT_FROM_BTC} & {@link FROM_BTCLN_AUTO} swaps.
+     *
+     * Handled by {@link OnchainForGasWrapper} & {@link OnchainForGasSwap}.
+     */
     TRUSTED_FROM_BTC = 4,
+    /**
+     * Trusted swap for Bitcoin Lightning -> 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 and doesn't support newer
+     *  {@link SPV_VAULT_FROM_BTC} & {@link FROM_BTCLN_AUTO} swaps.
+     *
+     * Handled by {@link LnForGasWrapper} & {@link LnForGasSwap}.
+     */
     TRUSTED_FROM_BTCLN = 5,
+    /**
+     * New spv vault (UTXO-controlled vault) based swaps for Bitcoin -> Smart chain swaps not requiring any
+     *  initiation on the destination chain, and with the added possibility for the user to receive a
+     *  native token on the destination chain as part of the swap (a "gas drop" feature).
+     *
+     * Handled by {@link SpvFromBTCWrapper} & {@link SpvFromBTCSwap}.
+     *
+     * Used on all the supported chains except Solana!
+     */
     SPV_VAULT_FROM_BTC = 6,
+    /**
+     * New escrow based (HTLC) swaps for Bitcoin Lightning -> Smart chain swaps not requiring manual
+     *  settlement on the destination by the user, and instead letting the LP initiate the escrow,
+     *  with the permissionless watchtower network managing the claiming of HTLC, with the swap secret
+     *  broadcasted over Nostr. Also adds a possibility for the user to receive a native token on the
+     *  destination chain as part of the swap (a "gas drop" feature).
+     *
+     * Handled by {@link FromBTCLNAutoWrapper} & {@link FromBTCLNAutoSwap}.
+     *
+     * Used on all the supported chains except Solana!
+     */
     FROM_BTCLN_AUTO = 7
 }

package/dist/enums/SwapType.js

@@ -2,17 +2,78 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwapType = void 0;
 /**
- * Enum representing different types of swaps
+ * Enum representing different types of swap protocols used by atomiq.
+ *
  * @category Core
  */
 var SwapType;
 (function (SwapType) {
+    /**
+     * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation of the swap
+     *  on the destination chain.
+     *
+     * Handled by {@link FromBTCWrapper} & {@link FromBTCSwap}.
+     *
+     * Legacy swaps are only used on Solana!
+     */
     SwapType[SwapType["FROM_BTC"] = 0] = "FROM_BTC";
+    /**
+     * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement of the swap on the
+     *  destination network once the lightning network payment is received by the LP
+     *
+     * Handled by {@link FromBTCLNWrapper} & {@link FromBTCLNSwap}.
+     *
+     * Legacy swaps are only used on Solana!
+     */
     SwapType[SwapType["FROM_BTCLN"] = 1] = "FROM_BTCLN";
+    /**
+     * Escrow based (PrTLC) swap for Smart chains -> Bitcoin
+     *
+     * Handled by {@link ToBTCWrapper} & {@link ToBTCSwap}.
+     */
     SwapType[SwapType["TO_BTC"] = 2] = "TO_BTC";
+    /**
+     * Escrow based (HTLC) swap for Smart chains -> Bitcoin Lightning
+     *
+     * Handled by {@link ToBTCLNWrapper} & {@link ToBTCLNSwap}.
+     */
     SwapType[SwapType["TO_BTCLN"] = 3] = "TO_BTCLN";
+    /**
+     * 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 and doesn't support newer
+     *  {@link SPV_VAULT_FROM_BTC} & {@link FROM_BTCLN_AUTO} swaps.
+     *
+     * Handled by {@link OnchainForGasWrapper} & {@link OnchainForGasSwap}.
+     */
     SwapType[SwapType["TRUSTED_FROM_BTC"] = 4] = "TRUSTED_FROM_BTC";
+    /**
+     * Trusted swap for Bitcoin Lightning -> 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 and doesn't support newer
+     *  {@link SPV_VAULT_FROM_BTC} & {@link FROM_BTCLN_AUTO} swaps.
+     *
+     * Handled by {@link LnForGasWrapper} & {@link LnForGasSwap}.
+     */
     SwapType[SwapType["TRUSTED_FROM_BTCLN"] = 5] = "TRUSTED_FROM_BTCLN";
+    /**
+     * New spv vault (UTXO-controlled vault) based swaps for Bitcoin -> Smart chain swaps not requiring any
+     *  initiation on the destination chain, and with the added possibility for the user to receive a
+     *  native token on the destination chain as part of the swap (a "gas drop" feature).
+     *
+     * Handled by {@link SpvFromBTCWrapper} & {@link SpvFromBTCSwap}.
+     *
+     * Used on all the supported chains except Solana!
+     */
     SwapType[SwapType["SPV_VAULT_FROM_BTC"] = 6] = "SPV_VAULT_FROM_BTC";
+    /**
+     * New escrow based (HTLC) swaps for Bitcoin Lightning -> Smart chain swaps not requiring manual
+     *  settlement on the destination by the user, and instead letting the LP initiate the escrow,
+     *  with the permissionless watchtower network managing the claiming of HTLC, with the swap secret
+     *  broadcasted over Nostr. Also adds a possibility for the user to receive a native token on the
+     *  destination chain as part of the swap (a "gas drop" feature).
+     *
+     * Handled by {@link FromBTCLNAutoWrapper} & {@link FromBTCLNAutoSwap}.
+     *
+     * Used on all the supported chains except Solana!
+     */
     SwapType[SwapType["FROM_BTCLN_AUTO"] = 7] = "FROM_BTCLN_AUTO";
 })(SwapType = exports.SwapType || (exports.SwapType = {}));