@atomiqlabs/sdk 8.1.8 → 8.3.5

package/src/prices/abstract/ISwapPrice.ts

@@ -4,7 +4,8 @@ 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> {
 
@@ -15,46 +16,55 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
     }
 
     /**
-     * Gets the decimal places for a given token, returns -1 if token should be ignored & null if token is not found
-     * @param chainIdentifier
-     * @param token
+     * Gets the decimal places for a given token, returns `-1` if token should be ignored & `null` if token is not found
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param tokenAddress Token address
      * @protected
      */
-    protected abstract getDecimals<C extends ChainIds<T>>(chainIdentifier: C, token: string): number | null;
+    protected abstract getDecimals<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number | null;
 
     /**
      * Returns the price of the token in BTC uSats (microSats)
      *
-     * @param chainIdentifier
-     * @param token
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param tokenAddress Token address
      * @param abortSignal
      * @protected
      */
-    protected abstract getPrice<C extends ChainIds<T>>(chainIdentifier: C, token: string, abortSignal?: AbortSignal): Promise<bigint>;
+    protected abstract getPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint>;
 
     /**
-     * Returns the price of bitcoin in USD, (sats/USD)
+     * Returns the price of bitcoin in USD (sats/USD)
      *
      * @param abortSignal
      * @protected
      */
     protected abstract getUsdPrice(abortSignal?: AbortSignal): Promise<number>;
 
-    protected getDecimalsThrowing<C extends ChainIds<T>>(chainIdentifier: C, token: string): number {
-        const decimals = this.getDecimals(chainIdentifier, token);
-        if(decimals==null) throw new Error(`Cannot get decimal count for token ${chainIdentifier}:${token}!`);
+    /**
+     * Gets the decimal places for a given token, returns `-1` if token should be ignored & throws if token is not found
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param tokenAddress Token address
+     * @throws {Error} When token is not known
+     * @protected
+     */
+    protected getDecimalsThrowing<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number {
+        const decimals = this.getDecimals(chainIdentifier, tokenAddress);
+        if(decimals==null) throw new Error(`Cannot get decimal count for token ${chainIdentifier}:${tokenAddress}!`);
         return decimals;
     }
 
     /**
      * Recomputes pricing info without fetching the current price
      *
-     * @param chainIdentifier
-     * @param amountSats
-     * @param satsBaseFee
-     * @param feePPM
-     * @param paidToken
-     * @param token
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param amountSats Amount of sats (BTC) to be received from the swap
+     * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
+     * @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
      */
     public recomputePriceInfoSend<C extends ChainIds<T>>(
         chainIdentifier: C,
@@ -62,19 +72,19 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         satsBaseFee: bigint,
         feePPM: bigint,
         paidToken: bigint,
-        token: string
+        tokenAddress: string
     ): PriceInfoType {
         const totalSats = (amountSats * (1000000n + feePPM) / 1000000n)
             + satsBaseFee;
         const totalUSats = totalSats * 1000000n;
-        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / paidToken;
+        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
 
         return {
             isValid: true,
             differencePPM: 0n,
             satsBaseFee,
             feePPM,
-            realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, token) ? undefined : swapPriceUSatPerToken,
+            realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
             swapPriceUSatPerToken
         };
     }
@@ -82,14 +92,14 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
     /**
      * Checks whether the swap amounts are valid given the current market rate for a given pair
      *
-     * @param chainIdentifier
+     * @param chainIdentifier Chain identifier of the smart chain
      * @param amountSats Amount of sats (BTC) to be received from the swap
      * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
      * @param feePPM PPM fee rate as reported by the intermediary
      * @param paidToken Amount of token to be paid to the swap
-     * @param token
+     * @param tokenAddress Token address to be paid
      * @param abortSignal
-     * @param preFetchedPrice Already pre-fetched price
+     * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      */
     public async isValidAmountSend<C extends ChainIds<T>>(
         chainIdentifier: C,
@@ -97,16 +107,16 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         satsBaseFee: bigint,
         feePPM: bigint,
         paidToken: bigint,
-        token: string,
+        tokenAddress: string,
         abortSignal?: AbortSignal,
         preFetchedPrice?: bigint | null
     ): Promise<PriceInfoType> {
         const totalSats = (amountSats * (1000000n + feePPM) / 1000000n)
             + satsBaseFee;
         const totalUSats = totalSats * 1000000n;
-        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / paidToken;
+        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
 
-        if(this.shouldIgnore(chainIdentifier, token)) return {
+        if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
             isValid: true,
             differencePPM: 0n,
             satsBaseFee,
@@ -115,8 +125,8 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
             swapPriceUSatPerToken
         };
 
-        const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, token, abortSignal, preFetchedPrice);
-        const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / calculatedAmtInToken;
+        const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
+        const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
 
         const difference = paidToken - calculatedAmtInToken; //Will be >0 if we need to pay more than we should've
         const differencePPM = difference * 1000000n / calculatedAmtInToken;
@@ -134,12 +144,12 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
     /**
      * Recomputes pricing info without fetching the current price
      *
-     * @param chainIdentifier
-     * @param amountSats
-     * @param satsBaseFee
-     * @param feePPM
-     * @param receiveToken
-     * @param token
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param amountSats Amount of sats (BTC) to be paid to the swap
+     * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
+     * @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
      */
     public recomputePriceInfoReceive<C extends ChainIds<T>>(
         chainIdentifier: C,
@@ -147,19 +157,19 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         satsBaseFee: bigint,
         feePPM: bigint,
         receiveToken: bigint,
-        token: string,
+        tokenAddress: string,
     ): PriceInfoType {
         const totalSats = (amountSats * (1000000n - feePPM) / 1000000n)
             - satsBaseFee;
         const totalUSats = totalSats * 1000000n;
-        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / receiveToken;
+        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
 
         return {
             isValid: true,
             differencePPM: 0n,
             satsBaseFee,
             feePPM,
-            realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, token) ? undefined : swapPriceUSatPerToken,
+            realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
             swapPriceUSatPerToken
         };
     }
@@ -167,14 +177,14 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
     /**
      * Checks whether the swap amounts are valid given the current market rate for a given pair
      *
-     * @param chainIdentifier
+     * @param chainIdentifier Chain identifier of the smart chain
      * @param amountSats Amount of sats (BTC) to be paid to the swap
      * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
      * @param feePPM PPM fee rate as reported by the intermediary
      * @param receiveToken Amount of token to be received from the swap
-     * @param token
+     * @param tokenAddress Token address to be received
      * @param abortSignal
-     * @param preFetchedPrice Already pre-fetched price
+     * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      */
     public async isValidAmountReceive<C extends ChainIds<T>>(
         chainIdentifier: C,
@@ -182,16 +192,16 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         satsBaseFee: bigint,
         feePPM: bigint,
         receiveToken: bigint,
-        token: string,
+        tokenAddress: string,
         abortSignal?: AbortSignal,
         preFetchedPrice?: bigint | null
     ): Promise<PriceInfoType> {
         const totalSats = (amountSats * (1000000n - feePPM) / 1000000n)
             - satsBaseFee;
         const totalUSats = totalSats * 1000000n;
-        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / receiveToken;
+        const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
 
-        if(this.shouldIgnore(chainIdentifier, token)) return {
+        if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
             isValid: true,
             differencePPM: 0n,
             satsBaseFee,
@@ -200,8 +210,8 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
             swapPriceUSatPerToken
         };
 
-        const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, token, abortSignal, preFetchedPrice);
-        const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, token))) / calculatedAmtInToken;
+        const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
+        const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
 
         const difference = calculatedAmtInToken - receiveToken; //Will be >0 if we receive less than we should've
         const differencePPM = difference * 100000n / calculatedAmtInToken;
@@ -216,22 +226,36 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         };
     }
 
-    public preFetchPrice<C extends ChainIds<T>>(chainIdentifier: C, token: string, abortSignal?: AbortSignal): Promise<bigint> {
-        return this.getPrice(chainIdentifier, token, abortSignal);
+    /**
+     * 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
+     */
+    public preFetchPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint> {
+        return this.getPrice(chainIdentifier, tokenAddress, abortSignal);
     }
 
+    /**
+     * Pre-fetches the Bitcoin USD price data, such that further calls to {@link getBtcUsdValue},
+     *  {@link getTokenUsdValue} or {@link getUsdValue} are quicker and don't need to wait for the price fetch
+     *
+     * @param abortSignal
+     */
     public preFetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         return this.getUsdPrice(abortSignal);
     }
 
     /**
-     * Returns amount of {toToken} that are equivalent to {fromAmount} satoshis
+     * Returns amount of `toToken` that is equivalent to `fromAmount` satoshis
      *
-     * @param chainIdentifier
-     * @param fromAmount        Amount of satoshis
-     * @param toToken           Token
+     * @param chainIdentifier Chain identifier string for the smart chain
+     * @param fromAmount Amount of satoshis
+     * @param toToken Token address
      * @param abortSignal
-     * @param preFetchedPrice
+     * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      * @throws {Error} when token is not found
      */
     public async getFromBtcSwapAmount<C extends ChainIds<T>>(
@@ -252,13 +276,13 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
     }
 
     /**
-     * Returns amount of satoshis that are equivalent to {fromAmount} of {fromToken}
+     * Returns amount of satoshis that are equivalent to `fromAmount` of `fromToken`
      *
-     * @param chainIdentifier
+     * @param chainIdentifier Chain identifier string for the smart chain
      * @param fromAmount Amount of the token
-     * @param fromToken Token
+     * @param fromToken Token address
      * @param abortSignal
-     * @param preFetchedPrice Pre-fetched swap price if available
+     * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
      * @throws {Error} when token is not found
      */
     public async getToBtcSwapAmount<C extends ChainIds<T>>(
@@ -280,8 +304,9 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
 
     /**
      * Returns whether the token should be ignored and pricing for it not calculated
-     * @param chainIdentifier
-     * @param tokenAddress
+     *
+     * @param chainIdentifier Chain identifier string for the smart chain
+     * @param tokenAddress Token address
      * @throws {Error} if token is not found
      */
     public shouldIgnore<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): boolean {
@@ -290,28 +315,52 @@ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
         return coin===-1;
     }
 
+    /**
+     * Returns the USD value of the bitcoin amount
+     *
+     * @param btcSats Bitcoin amount in satoshis
+     * @param abortSignal
+     * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
+     */
     public async getBtcUsdValue(
         btcSats: bigint,
         abortSignal?: AbortSignal,
-        preFetchedPrice?: number
+        preFetchedUsdPrice?: number
     ): Promise<number> {
-        return Number(btcSats)*(preFetchedPrice || await this.getUsdPrice(abortSignal));
+        return Number(btcSats)*(preFetchedUsdPrice || await this.getUsdPrice(abortSignal));
     }
 
+    /**
+     * Returns the USD value of the smart chain token amount
+     *
+     * @param chainIdentifier Chain identifier string for the smart chain
+     * @param tokenAmount Amount of the token in base units
+     * @param tokenAddress Token address
+     * @param abortSignal
+     * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
+     */
     public async getTokenUsdValue<C extends ChainIds<T>>(
-        chainId: C,
+        chainIdentifier: C,
         tokenAmount: bigint,
-        token: string,
+        tokenAddress: string,
         abortSignal?: AbortSignal,
-        preFetchedPrice?: number
+        preFetchedUsdPrice?: number
     ): Promise<number> {
         const [btcAmount, usdPrice] = await Promise.all([
-            this.getToBtcSwapAmount(chainId, tokenAmount, token, abortSignal),
-            preFetchedPrice==null ? this.preFetchUsdPrice(abortSignal) : Promise.resolve(preFetchedPrice)
+            this.getToBtcSwapAmount(chainIdentifier, tokenAmount, tokenAddress, abortSignal),
+            preFetchedUsdPrice==null ? this.preFetchUsdPrice(abortSignal) : Promise.resolve(preFetchedUsdPrice)
         ]);
         return Number(btcAmount)*usdPrice;
     }
 
+    /**
+     * Returns the USD value of the token amount
+     *
+     * @param amount Amount in base units of the token
+     * @param token Token to fetch the usd price for
+     * @param abortSignal
+     * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
+     */
     public getUsdValue<C extends ChainIds<T>>(
         amount: bigint,
         token: Token<C>,

package/src/prices/providers/BinancePriceProvider.ts

@@ -10,7 +10,8 @@ export type BinanceResponse = {
 
 /**
  * Price provider using Binance exchange API
- * @category Pricing and LPs
+ *
+ * @category Pricing
  */
 export class BinancePriceProvider<T extends MultiChain> extends ExchangePriceProvider<T> {
 
@@ -18,6 +19,9 @@ export class BinancePriceProvider<T extends MultiChain> extends ExchangePricePro
         super(coinsMap, url, httpRequestTimeout);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPair(pair: string, abortSignal?: AbortSignal) {
         const response = await httpGet<BinanceResponse>(
             this.url+"/ticker/price?symbol="+pair,
@@ -28,6 +32,9 @@ export class BinancePriceProvider<T extends MultiChain> extends ExchangePricePro
         return parseFloat(response.price);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         const response = await httpGet<BinanceResponse>(
             this.url+"/ticker/price?symbol=BTCUSDC",

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> {
 
@@ -17,6 +17,9 @@ export class CoinGeckoPriceProvider<T extends MultiChain> extends HttpPriceProvi
         super(coinsMap, url, httpRequestTimeout);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPrice(token: CoinType, abortSignal?: AbortSignal): Promise<bigint> {
         let response = await httpGet<CoinGeckoResponse<"sats">>(
             this.url+"/simple/price?ids="+token.coinId+"&vs_currencies=sats&precision=6",
@@ -27,6 +30,9 @@ export class CoinGeckoPriceProvider<T extends MultiChain> extends HttpPriceProvi
         return BigInt(response[token.coinId].sats*1000000);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         let response = await httpGet<CoinGeckoResponse<"usd">>(
             this.url+"/simple/price?ids=bitcoin&vs_currencies=usd&precision=9",

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> {
 
@@ -21,6 +21,9 @@ export class CoinPaprikaPriceProvider<T extends MultiChain> extends HttpPricePro
         super(coinsMap, url, httpRequestTimeout);
     }
 
+    /**
+     * @inheritDoc
+     */
     async fetchPrice(token: CoinType, abortSignal?: AbortSignal) {
         const response = await httpGet<CoinPaprikaResponse<"BTC">>(
             this.url+"/tickers/"+token.coinId+"?quotes=BTC",
@@ -31,6 +34,9 @@ export class CoinPaprikaPriceProvider<T extends MultiChain> extends HttpPricePro
         return BigInt(Math.floor(response.quotes.BTC.price*100000000000000));
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         const response = await httpGet<CoinPaprikaResponse<"USD">>(
             this.url+"/tickers/btc-bitcoin?quotes=USD",

package/src/prices/providers/CustomPriceProvider.ts

@@ -4,23 +4,34 @@ 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> {
 
     readonly getUsdPriceFn: CustomPriceFunction;
 
+    /**
+     * @param coinsMap Mapping of token tickers to token addresses
+     * @param getUsdPriceFn Pricing function, used to retrieve USD prices of the tokens
+     */
     constructor(coinsMap: CtorCoinTypes<T>, getUsdPriceFn: CustomPriceFunction) {
         super(coinsMap);
         this.getUsdPriceFn = getUsdPriceFn;
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPrice(token: CoinType, abortSignal?: AbortSignal): Promise<bigint> {
         const [btcPrice, tokenPrice] = await this.getUsdPriceFn(["BTC",token.coinId], abortSignal);
         const priceInBtc = tokenPrice / btcPrice;
         return BigInt(Math.floor(priceInBtc*100_000_000*1_000_000));
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         const [btcPrice] = await this.getUsdPriceFn(["BTC"], abortSignal);
         return btcPrice / 100_000_000;

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> {
 
@@ -30,6 +30,9 @@ export class KrakenPriceProvider<T extends MultiChain> extends ExchangePriceProv
         super(coinsMap, url, httpRequestTimeout);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPair(pair: string, abortSignal?: AbortSignal) {
         const response = await httpGet<KrakenResponse>(
             this.url+"/public/Ticker?pair="+pair,
@@ -40,6 +43,9 @@ export class KrakenPriceProvider<T extends MultiChain> extends ExchangePriceProv
         return parseFloat(response.result[pair].c[0]);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         const response = await httpGet<KrakenResponse>(
             this.url+"/public/Ticker?pair=XBTUSDC",
@@ -50,6 +56,9 @@ export class KrakenPriceProvider<T extends MultiChain> extends ExchangePriceProv
         return parseFloat(response.result["XBTUSDC"].c[0])/100000000;
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPrice(token: CoinType, abortSignal?: AbortSignal): Promise<bigint> {
         const pairs: string[] = token.coinId.split(";");
 

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> {
 
@@ -30,6 +30,9 @@ export class OKXPriceProvider<T extends MultiChain> extends ExchangePriceProvide
         super(coinsMap, url, httpRequestTimeout);
     }
 
+    /**
+     * @inheritDoc
+     */
     async fetchPair(pair: string, abortSignal?: AbortSignal) {
         const response = await httpGet<OKXResponse>(
             this.url+"/market/index-tickers?instId="+pair,
@@ -40,6 +43,9 @@ export class OKXPriceProvider<T extends MultiChain> extends ExchangePriceProvide
         return parseFloat(response.data[0].idxPx);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
         const response = await httpGet<OKXResponse>(
             this.url+"/market/index-tickers?instId=BTC-USD",

package/src/prices/providers/abstract/ExchangePriceProvider.ts

@@ -13,6 +13,9 @@ export abstract class ExchangePriceProvider<T extends MultiChain> extends HttpPr
      */
     protected abstract fetchPair(pair: string, abortSignal?: AbortSignal): Promise<number>;
 
+    /**
+     * @inheritDoc
+     */
     protected async fetchPrice(token: CoinType, abortSignal?: AbortSignal): Promise<bigint> {
         const pairs: string[] = token.coinId.split(";");
         const prices: number[] = await Promise.all(pairs.map(pair => {

package/src/storage/IUnifiedStorage.ts

@@ -1,21 +1,30 @@
 
 /**
- * Query parameters for storage operations
+ * Params for querying the storage
+ *
  * @category Storage
  */
 export type QueryParams = {
+    /**
+     * Key that should be matched
+     */
     key: string,
+    /**
+     * A value that the key needs to have, if an array is passed, the conditions are `OR`-ed
+     */
     value: any | any[]
 };
 
 /**
- * Base type for stored objects
+ * Base type for stored objects, every storage object MUST have an `id` field
+ *
  * @category Storage
  */
 export type UnifiedStoredObject = {id: string} & any;
 
 /**
  * Defines simple indexes (for queries that use a single key)
+ *
  * @category Storage
  */
 export type UnifiedStorageIndexes = readonly {
@@ -27,6 +36,7 @@ export type UnifiedStorageIndexes = readonly {
 
 /**
  * Defines composite indexes (for queries that use multiple keys)
+ *
  * @category Storage
  */
 export type UnifiedStorageCompositeIndexes = readonly {
@@ -35,13 +45,15 @@ export type UnifiedStorageCompositeIndexes = readonly {
 }[];
 
 /**
- * Interface for unified storage implementations
+ * Interface for a generic unified storage implementations
+ *
  * @category Storage
  */
 export interface IUnifiedStorage<I extends UnifiedStorageIndexes, C extends UnifiedStorageCompositeIndexes> {
 
     /**
      * Initializes the storage with given indexes and composite indexes
+     *
      * @param indexes
      * @param compositeIndexes
      */
@@ -58,25 +70,25 @@ export interface IUnifiedStorage<I extends UnifiedStorageIndexes, C extends Unif
 
     /**
      * Saves an object to storage, updating indexes as needed
-     * @param value - Object to save (must have an id property)
+     * @param value Object to save (must have an id property)
      */
     save(value: UnifiedStoredObject): Promise<void>;
 
     /**
      * Saves multiple objects to storage in a batch operation
-     * @param value - Array of objects to save
+     * @param value Array of objects to save
      */
     saveAll(value: UnifiedStoredObject[]): Promise<void>;
 
     /**
      * Removes an object from storage
-     * @param value - Object to remove (must have an id property)
+     * @param value Object to remove (must have an id property)
      */
     remove(value: UnifiedStoredObject): Promise<void>;
 
     /**
      * Removes multiple objects from storage in a batch operation
-     * @param value - Array of objects to remove
+     * @param value Array of objects to remove
      */
     removeAll(value: UnifiedStoredObject[]): Promise<void>;