@atomiqlabs/sdk 8.1.8 → 8.3.5

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 = {}));

package/dist/errors/IntermediaryError.d.ts

@@ -1,8 +1,12 @@
 /**
  * An error or inconsistency in the intermediary's returned data, this will blacklist the intermediary
+ *
  * @category Errors
  */
 export declare class IntermediaryError extends Error {
+    /**
+     * Whether the error is recoverable and intermediary (LP) shouldn't be blacklisted for it
+     */
     recoverable: boolean;
     originalStack?: string;
     constructor(msg: string, originalError?: any, recoverable?: boolean);

package/dist/errors/IntermediaryError.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntermediaryError = void 0;
 /**
  * An error or inconsistency in the intermediary's returned data, this will blacklist the intermediary
+ *
  * @category Errors
  */
 class IntermediaryError extends Error {

package/dist/errors/RequestError.d.ts

@@ -1,18 +1,32 @@
 /**
  * An error returned by the intermediary in a http response
+ *
  * @category Errors
  */
 export declare class RequestError extends Error {
     httpCode: number;
     constructor(msg: string, httpCode: number);
-    static parse(msg: string, httpCode: number): RequestError;
+    /**
+     * Parses a message + a response code returned by the intermediary (LP) as an error
+     *
+     * @param msg Raw response
+     * @param httpCode HTTP response status code
+     */
+    static parse(msg: string, httpCode: number): RequestError | OutOfBoundsError;
 }
 /**
  * An error indicating out of bounds (amount too high or too low) on swap initialization
+ *
  * @category Errors
  */
 export declare class OutOfBoundsError extends RequestError {
+    /**
+     * Swap minimum in base units of the token in which the quote was requested
+     */
     min: bigint;
+    /**
+     * Swap maximum in base units of the token in which the quote was requested
+     */
     max: bigint;
     constructor(msg: string, httpCode: number, min: bigint, max: bigint);
 }

package/dist/errors/RequestError.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutOfBoundsError = exports.RequestError = void 0;
 /**
  * An error returned by the intermediary in a http response
+ *
  * @category Errors
  */
 class RequestError extends Error {
@@ -18,6 +19,12 @@ class RequestError extends Error {
         Object.setPrototypeOf(this, RequestError.prototype);
         this.httpCode = httpCode;
     }
+    /**
+     * Parses a message + a response code returned by the intermediary (LP) as an error
+     *
+     * @param msg Raw response
+     * @param httpCode HTTP response status code
+     */
     static parse(msg, httpCode) {
         try {
             const parsed = JSON.parse(msg);
@@ -33,6 +40,7 @@ class RequestError extends Error {
 exports.RequestError = RequestError;
 /**
  * An error indicating out of bounds (amount too high or too low) on swap initialization
+ *
  * @category Errors
  */
 class OutOfBoundsError extends RequestError {

package/dist/errors/UserError.d.ts

@@ -1,5 +1,6 @@
 /**
  * An error on the user side, such as invalid address provided
+ *
  * @category Errors
  */
 export declare class UserError extends Error {

package/dist/errors/UserError.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserError = void 0;
 /**
  * An error on the user side, such as invalid address provided
+ *
  * @category Errors
  */
 class UserError extends Error {

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-export { LightningNetworkApi, BitcoinRpc, BitcoinRpcWithAddressIndex, BitcoinNetwork, BtcRelay, ChainData, ChainInterface, ChainType, CannotInitializeATAError, SignatureVerificationError, SwapDataVerificationError, TransactionRevertedError, ChainEvents, Messenger, SpvVaultContract, SpvVaultData, SpvWithdrawalTransactionData, ExecutionData, IStorageManager, StorageObject, SwapContract, SwapData } from "@atomiqlabs/base";
+export { LightningNetworkApi, BitcoinRpc, BitcoinRpcWithAddressIndex, BitcoinNetwork, BtcHeader, BtcStoredHeader, BtcRelay, ChainData, ChainInterface, ChainType, CannotInitializeATAError, SignatureVerificationError, SwapDataVerificationError, TransactionRevertedError, ChainEvents, Messenger, SpvVaultContract, SpvVaultData, SpvWithdrawalTransactionData, ExecutionData, IStorageManager, StorageObject, SwapContract, SwapData, AbstractSigner } from "@atomiqlabs/base";
 export { MempoolApi, MempoolBitcoinRpc, MempoolApiError } from "@atomiqlabs/btc-mempool";
+export { NostrMessenger } from "@atomiqlabs/messenger-nostr";
 export * from "./bitcoin/wallet/BitcoinWallet";
 export * from "./bitcoin/wallet/IBitcoinWallet";
-export * from "./types/wallets/MinimalBitcoinWalletInterface";
-export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
 export * from "./bitcoin/wallet/SingleAddressBitcoinWallet";
 export { CoinselectAddressTypes } from "./bitcoin/coinselect2";
 export * from "./enums/FeeType";
@@ -11,7 +10,6 @@ export * from "./enums/SwapAmountType";
 export * from "./enums/SwapDirection";
 export * from "./enums/SwapType";
 export * from "./errors/IntermediaryError";
-export * from "./errors/PaymentAuthError";
 export * from "./errors/RequestError";
 export * from "./errors/UserError";
 export { Intermediary } from "./intermediaries/Intermediary";
@@ -72,9 +70,11 @@ export * from "./types/fees/FeeBreakdown";
 export * from "./types/fees/PercentagePPM";
 export * from "./types/lnurl/LNURLPay";
 export * from "./types/lnurl/LNURLWithdraw";
+export * from "./types/wallets/MinimalBitcoinWalletInterface";
+export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
+export * from "./types/wallets/LightningInvoiceCreateService";
 export * from "./types/AmountData";
 export * from "./types/CustomPriceFunction";
-export * from "./types/PriceInfoType";
 export * from "./types/SwapExecutionAction";
 export * from "./types/SwapWithSigner";
 export * from "./types/Token";

package/dist/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LnForGasWrapper = exports.LnForGasSwapState = exports.LnForGasSwap = exports.SpvFromBTCWrapper = exports.SpvFromBTCSwapState = exports.SpvFromBTCSwap = exports.IEscrowSwapWrapper = exports.IEscrowSwap = exports.IEscrowSelfInitSwap = exports.IToBTCWrapper = exports.ToBTCSwapState = exports.IToBTCSwap = exports.ToBTCWrapper = exports.ToBTCSwap = exports.ToBTCLNWrapper = exports.ToBTCLNSwap = exports.IFromBTCWrapper = exports.IFromBTCSelfInitSwap = exports.IFromBTCLNWrapper = exports.FromBTCWrapper = exports.FromBTCSwapState = exports.FromBTCSwap = exports.FromBTCLNAutoWrapper = exports.FromBTCLNAutoSwapState = exports.FromBTCLNAutoSwap = exports.FromBTCLNWrapper = exports.FromBTCLNSwapState = exports.FromBTCLNSwap = exports.Swapper = exports.IndexedDBUnifiedStorage = exports.CustomPriceProvider = exports.OKXPriceProvider = exports.KrakenPriceProvider = exports.CoinPaprikaPriceProvider = exports.CoinGeckoPriceProvider = exports.BinancePriceProvider = exports.RedundantSwapPrice = exports.IntermediaryDiscovery = exports.Intermediary = exports.MempoolApiError = exports.MempoolBitcoinRpc = exports.MempoolApi = exports.SwapData = exports.SpvWithdrawalTransactionData = exports.SpvVaultData = exports.TransactionRevertedError = exports.SwapDataVerificationError = exports.SignatureVerificationError = exports.CannotInitializeATAError = exports.BitcoinNetwork = void 0;
-exports.ISwapWrapper = exports.ISwap = exports.OnchainForGasWrapper = exports.OnchainForGasSwapState = exports.OnchainForGasSwap = void 0;
+exports.LnForGasSwapState = exports.LnForGasSwap = exports.SpvFromBTCWrapper = exports.SpvFromBTCSwapState = exports.SpvFromBTCSwap = exports.IEscrowSwapWrapper = exports.IEscrowSwap = exports.IEscrowSelfInitSwap = exports.IToBTCWrapper = exports.ToBTCSwapState = exports.IToBTCSwap = exports.ToBTCWrapper = exports.ToBTCSwap = exports.ToBTCLNWrapper = exports.ToBTCLNSwap = exports.IFromBTCWrapper = exports.IFromBTCSelfInitSwap = exports.IFromBTCLNWrapper = exports.FromBTCWrapper = exports.FromBTCSwapState = exports.FromBTCSwap = exports.FromBTCLNAutoWrapper = exports.FromBTCLNAutoSwapState = exports.FromBTCLNAutoSwap = exports.FromBTCLNWrapper = exports.FromBTCLNSwapState = exports.FromBTCLNSwap = exports.Swapper = exports.IndexedDBUnifiedStorage = exports.CustomPriceProvider = exports.OKXPriceProvider = exports.KrakenPriceProvider = exports.CoinPaprikaPriceProvider = exports.CoinGeckoPriceProvider = exports.BinancePriceProvider = exports.RedundantSwapPrice = exports.IntermediaryDiscovery = exports.Intermediary = exports.NostrMessenger = exports.MempoolApiError = exports.MempoolBitcoinRpc = exports.MempoolApi = exports.SwapData = exports.SpvWithdrawalTransactionData = exports.SpvVaultData = exports.TransactionRevertedError = exports.SwapDataVerificationError = exports.SignatureVerificationError = exports.CannotInitializeATAError = exports.BitcoinNetwork = void 0;
+exports.ISwapWrapper = exports.ISwap = exports.OnchainForGasWrapper = exports.OnchainForGasSwapState = exports.OnchainForGasSwap = exports.LnForGasWrapper = void 0;
 var base_1 = require("@atomiqlabs/base");
 Object.defineProperty(exports, "BitcoinNetwork", { enumerable: true, get: function () { return base_1.BitcoinNetwork; } });
 Object.defineProperty(exports, "CannotInitializeATAError", { enumerable: true, get: function () { return base_1.CannotInitializeATAError; } });
@@ -29,17 +29,16 @@ var btc_mempool_1 = require("@atomiqlabs/btc-mempool");
 Object.defineProperty(exports, "MempoolApi", { enumerable: true, get: function () { return btc_mempool_1.MempoolApi; } });
 Object.defineProperty(exports, "MempoolBitcoinRpc", { enumerable: true, get: function () { return btc_mempool_1.MempoolBitcoinRpc; } });
 Object.defineProperty(exports, "MempoolApiError", { enumerable: true, get: function () { return btc_mempool_1.MempoolApiError; } });
+var messenger_nostr_1 = require("@atomiqlabs/messenger-nostr");
+Object.defineProperty(exports, "NostrMessenger", { enumerable: true, get: function () { return messenger_nostr_1.NostrMessenger; } });
 __exportStar(require("./bitcoin/wallet/BitcoinWallet"), exports);
 __exportStar(require("./bitcoin/wallet/IBitcoinWallet"), exports);
-__exportStar(require("./types/wallets/MinimalBitcoinWalletInterface"), exports);
-__exportStar(require("./types/wallets/MinimalLightningNetworkWalletInterface"), exports);
 __exportStar(require("./bitcoin/wallet/SingleAddressBitcoinWallet"), exports);
 __exportStar(require("./enums/FeeType"), exports);
 __exportStar(require("./enums/SwapAmountType"), exports);
 __exportStar(require("./enums/SwapDirection"), exports);
 __exportStar(require("./enums/SwapType"), exports);
 __exportStar(require("./errors/IntermediaryError"), exports);
-__exportStar(require("./errors/PaymentAuthError"), exports);
 __exportStar(require("./errors/RequestError"), exports);
 __exportStar(require("./errors/UserError"), exports);
 var Intermediary_1 = require("./intermediaries/Intermediary");
@@ -144,9 +143,11 @@ __exportStar(require("./types/fees/FeeBreakdown"), exports);
 __exportStar(require("./types/fees/PercentagePPM"), exports);
 __exportStar(require("./types/lnurl/LNURLPay"), exports);
 __exportStar(require("./types/lnurl/LNURLWithdraw"), exports);
+__exportStar(require("./types/wallets/MinimalBitcoinWalletInterface"), exports);
+__exportStar(require("./types/wallets/MinimalLightningNetworkWalletInterface"), exports);
+__exportStar(require("./types/wallets/LightningInvoiceCreateService"), exports);
 __exportStar(require("./types/AmountData"), exports);
 __exportStar(require("./types/CustomPriceFunction"), exports);
-__exportStar(require("./types/PriceInfoType"), exports);
 __exportStar(require("./types/SwapExecutionAction"), exports);
 __exportStar(require("./types/SwapWithSigner"), exports);
 __exportStar(require("./types/Token"), exports);

package/dist/intermediaries/Intermediary.d.ts

@@ -3,14 +3,16 @@ import { SwapHandlerInfoType } from "./IntermediaryDiscovery";
 import { ChainSwapType, LNNodeLiquidity, SwapContract } from "@atomiqlabs/base";
 /**
  * Services offered by an intermediary
- * @category Pricing and LPs
+ *
+ * @category LPs
  */
 export type ServicesType = {
     [key in SwapType]?: SwapHandlerInfoType;
 };
 /**
  * Reputation data for an intermediary on a single chain
- * @category Pricing and LPs
+ *
+ * @category LPs
  */
 export type SingleChainReputationType = {
     [token: string]: {
@@ -26,21 +28,35 @@ export type SingleChainReputationType = {
 };
 /**
  * Smart chain liquidity data
- * @category Pricing and LPs
+ *
+ * @category LPs
  */
 export type SCLiquidity = {
     [token: string]: bigint;
 };
 /**
- * Represents a liquidity provider/intermediary
- * @category Pricing and LPs
+ * Represents an intermediary (liquidity provider)
+ *
+ * @category LPs
  */
 export declare class Intermediary {
+    /**
+     * Base URL where the intermediary is listening for HTTP requests
+     */
     readonly url: string;
+    /**
+     * Addresses of the intermediary on smart chains, used for checking the provided signatures
+     */
     readonly addresses: {
         [chainIdentifier: string]: string;
     };
+    /**
+     * Swap protocol services offered by the intermediary
+     */
     readonly services: ServicesType;
+    /**
+     * Input/output swap bounds for various swap protocols offered by the intermediary
+     */
     readonly swapBounds: {
         [swapType in SwapType]?: {
             [chainIdentifier: string]: {
@@ -57,18 +73,38 @@ export declare class Intermediary {
             };
         };
     };
+    /**
+     * Reputation of the intermediary on different smart chains, this is only fetched
+     *  on-demand when creating a swap where reputation is checked
+     */
     reputation: {
         [chainIdentifier: string]: SingleChainReputationType;
     };
+    /**
+     * Liquidity of the intermediary across different smart chains, this is only fetched
+     *  on-demand when creating a swap where intermediary's liquidity is checked
+     */
     liquidity: {
         [chainIdentifier: string]: SCLiquidity;
     };
+    /**
+     * Data about a lightning network node used by this intermediary, if it offers lightning
+     *  network swaps, this is only fetched on-demand when creating a Bitcoin Lightning -> Smart chain
+     *  swap through the intermediary (which necessitates checking intermediary's channel capacities)
+     */
     lnData?: LNNodeLiquidity;
     constructor(url: string, addresses: {
         [chainIdentifier: string]: string;
     }, services: ServicesType, reputation?: {
         [chainIdentifier: string]: SingleChainReputationType;
     });
+    /**
+     * Returns the input/output swap limit for given swap type, chain and token
+     *
+     * @param swapType Swap protocol service to check
+     * @param chainId Chain identifier of the smart chain to check
+     * @param tokenAddress Address of the token to check
+     */
     getSwapLimits(swapType: SwapType, chainId: string, tokenAddress: string): {
         input: {
             min?: bigint;
@@ -82,29 +118,40 @@ export declare class Intermediary {
     /**
      * Returns tokens supported by the intermediary, optionally constrained to the specific swap types
      *
-     * @param chainIdentifier
-     * @param swapTypesArr
+     * @param chainIdentifier Chain identifier of the smart chain to check
+     * @param swapTypesArr An array of swap type services to check
      * @private
      */
     private getSupportedTokens;
     /**
      * Fetches, returns and saves the reputation of the intermediary, either for all or just for a single token
      *
-     * @param chainIdentifier
-     * @param swapContract
-     * @param tokens
+     * @param chainIdentifier Chain identifier of the chain on which to fetch the reputation
+     * @param swapContract Swap contract for the requested smart chain
+     * @param tokens An optional array of tokens to fetch the data for (by default it uses all tokens supported
+     *  by the intermediary)
      * @param abortSignal
      */
     getReputation(chainIdentifier: string, swapContract: SwapContract<any>, tokens?: string[], abortSignal?: AbortSignal): Promise<SingleChainReputationType>;
     /**
-     * Fetches, returns and saves the liquidity of the intermediaryfor a specific token
+     * Fetches, returns and saves the liquidity of the intermediary for a specific token
      *
-     * @param chainIdentifier
-     * @param swapContract
-     * @param token
+     * @param chainIdentifier Chain identifier of the chain on which to fetch the reputation
+     * @param swapContract Swap contract for the requested smart chain
+     * @param token Token address of the token to fetch the liquidity for
      * @param abortSignal
      */
     getLiquidity(chainIdentifier: string, swapContract: SwapContract<any>, token: string, abortSignal?: AbortSignal): Promise<bigint>;
+    /**
+     * Checks whether the intermediary supports swaps of any tokens on the smart chain
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     */
     supportsChain(chainIdentifier: string): boolean;
+    /**
+     * Returns intermediary's address on a given smart chain
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     */
     getAddress(chainIdentifier: string): string;
 }

package/dist/intermediaries/Intermediary.js

@@ -4,12 +4,21 @@ exports.Intermediary = void 0;
 const SwapType_1 = require("../enums/SwapType");
 const RetryUtils_1 = require("../utils/RetryUtils");
 /**
- * Represents a liquidity provider/intermediary
- * @category Pricing and LPs
+ * Represents an intermediary (liquidity provider)
+ *
+ * @category LPs
  */
 class Intermediary {
     constructor(url, addresses, services, reputation = {}) {
+        /**
+         * Reputation of the intermediary on different smart chains, this is only fetched
+         *  on-demand when creating a swap where reputation is checked
+         */
         this.reputation = {};
+        /**
+         * Liquidity of the intermediary across different smart chains, this is only fetched
+         *  on-demand when creating a swap where intermediary's liquidity is checked
+         */
         this.liquidity = {};
         this.url = url;
         this.addresses = addresses;
@@ -33,14 +42,21 @@ class Intermediary {
             }
         }
     }
+    /**
+     * Returns the input/output swap limit for given swap type, chain and token
+     *
+     * @param swapType Swap protocol service to check
+     * @param chainId Chain identifier of the smart chain to check
+     * @param tokenAddress Address of the token to check
+     */
     getSwapLimits(swapType, chainId, tokenAddress) {
         return this.swapBounds[swapType]?.[chainId]?.[tokenAddress];
     }
     /**
      * Returns tokens supported by the intermediary, optionally constrained to the specific swap types
      *
-     * @param chainIdentifier
-     * @param swapTypesArr
+     * @param chainIdentifier Chain identifier of the smart chain to check
+     * @param swapTypesArr An array of swap type services to check
      * @private
      */
     getSupportedTokens(chainIdentifier, swapTypesArr = [
@@ -63,9 +79,10 @@ class Intermediary {
     /**
      * Fetches, returns and saves the reputation of the intermediary, either for all or just for a single token
      *
-     * @param chainIdentifier
-     * @param swapContract
-     * @param tokens
+     * @param chainIdentifier Chain identifier of the chain on which to fetch the reputation
+     * @param swapContract Swap contract for the requested smart chain
+     * @param tokens An optional array of tokens to fetch the data for (by default it uses all tokens supported
+     *  by the intermediary)
      * @param abortSignal
      */
     async getReputation(chainIdentifier, swapContract, tokens, abortSignal) {
@@ -89,11 +106,11 @@ class Intermediary {
         return reputation;
     }
     /**
-     * Fetches, returns and saves the liquidity of the intermediaryfor a specific token
+     * Fetches, returns and saves the liquidity of the intermediary for a specific token
      *
-     * @param chainIdentifier
-     * @param swapContract
-     * @param token
+     * @param chainIdentifier Chain identifier of the chain on which to fetch the reputation
+     * @param swapContract Swap contract for the requested smart chain
+     * @param token Token address of the token to fetch the liquidity for
      * @param abortSignal
      */
     async getLiquidity(chainIdentifier, swapContract, token, abortSignal) {
@@ -103,11 +120,21 @@ class Intermediary {
         this.liquidity[chainIdentifier][token] = result;
         return result;
     }
+    /**
+     * Checks whether the intermediary supports swaps of any tokens on the smart chain
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     */
     supportsChain(chainIdentifier) {
         if (this.addresses[chainIdentifier] == null)
             return false;
         return this.getSupportedTokens(chainIdentifier).size !== 0;
     }
+    /**
+     * Returns intermediary's address on a given smart chain
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     */
     getAddress(chainIdentifier) {
         return this.addresses[chainIdentifier];
     }