@covalenthq/client-sdk 0.2.6 → 0.2.8

package/dist/services/XykService.d.ts

@@ -1,4 +1,4 @@
-import { Chains, Response } from "./Client";
+import { Chains, Quotes, Response } from "./Client";
 declare class PoolResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -13,8 +13,10 @@ declare class PoolResponse {
     constructor(data: PoolResponse);
 }
 declare class Pool {
+    /** * The pair address. */
     exchange: string;
     swap_count_24h: string;
+    /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: string;
     volume_24h_quote: string;
     fee_24h_quote: string;
@@ -26,7 +28,7 @@ declare class Pool {
     chain_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     volume_7d_quote: string;
     annualized_fee: string;
@@ -65,6 +67,36 @@ declare class Token {
     volume_out_7d: string;
     constructor(data: Token);
 }
+declare class PoolToDexResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested address. */
+    address: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: PoolToDexItem[];
+    constructor(data: PoolToDexResponse);
+}
+declare class SupportedDex {
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    factory_contract_address: string;
+    router_contract_addresses: string;
+    swap_fee: number;
+    constructor(data: SupportedDex);
+}
+declare class PoolToDexItem extends SupportedDex {
+    /** * The dex logo URL */
+    logo_url: string;
+    constructor(data: PoolToDexItem);
+}
 declare class PoolByAddressResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -79,8 +111,10 @@ declare class PoolByAddressResponse {
     constructor(data: PoolByAddressResponse);
 }
 declare class PoolWithTimeseries {
+    /** * The pair address. */
     exchange: string;
     swap_count_24h: string;
+    /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: string;
     volume_24h_quote: string;
     fee_24h_quote: string;
@@ -90,7 +124,7 @@ declare class PoolWithTimeseries {
     quote_rate: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     volume_7d_quote: string;
     annualized_fee: string;
@@ -107,11 +141,12 @@ declare class PoolWithTimeseries {
     constructor(data: PoolWithTimeseries);
 }
 declare class VolumeTimeseries {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     dt: string;
+    /** * The pair address. */
     exchange: string;
     sum_amount_0_in: string;
     sum_amount_0_out: string;
@@ -124,11 +159,12 @@ declare class VolumeTimeseries {
     constructor(data: VolumeTimeseries);
 }
 declare class LiquidityTimeseries {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     dt: string;
+    /** * The pair address. */
     exchange: string;
     r0_c: string;
     r1_c: string;
@@ -138,11 +174,12 @@ declare class LiquidityTimeseries {
     constructor(data: LiquidityTimeseries);
 }
 declare class PriceTimeseries {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     dt: string;
+    /** * The pair address. */
     exchange: string;
     price_of_token_0_in_token_1: string;
     price_of_token_0_in_token_1_description: string;
@@ -154,6 +191,57 @@ declare class PriceTimeseries {
     price_of_token_1_in_quote_currency: string;
     constructor(data: PriceTimeseries);
 }
+declare class PoolsDexDataResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested address. */
+    address: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    /** * List of response items. */
+    items: PoolsDexDataItem[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: PoolsDexDataResponse);
+}
+declare class PoolsDexDataItem {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The pair address. */
+    exchange: string;
+    /** * The combined ticker symbol of token0 and token1 separated with a hypen. */
+    exchange_ticker_symbol: string;
+    /** * The dex logo URL for the pair address. */
+    exchange_logo_url: string;
+    /** * The total liquidity converted to fiat in `quote-currency`. */
+    total_liquidity_quote: number;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * Token0's contract metadata and reserve data. */
+    token_0: PoolsDexToken;
+    /** * Token1's contract metadata and reserve data. */
+    token_1: PoolsDexToken;
+    constructor(data: PoolsDexDataItem);
+}
+declare class PoolsDexToken {
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The reserves for the token. */
+    reserve: string;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    constructor(data: PoolsDexToken);
+}
 declare class AddressExchangeBalancesResponse {
     /** * The requested address. */
     address: string;
@@ -225,7 +313,7 @@ declare class TokenV2Volume {
     chain_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
@@ -242,6 +330,7 @@ declare class TokenV2Volume {
     swap_count_24h: number;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
+    /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: number;
     total_volume_24h_quote: number;
     constructor(data: TokenV2Volume);
@@ -255,18 +344,6 @@ declare class SupportedDexesResponse {
     pagination: Pagination;
     constructor(data: SupportedDexesResponse);
 }
-declare class SupportedDex {
-    /** * The requested chain ID eg: `1`. */
-    chain_id: string;
-    /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
-    /** * The name of the DEX, eg: `uniswap`. */
-    dex_name: string;
-    factory_contract_address: string;
-    router_contract_addresses: string;
-    swap_fee: number;
-    constructor(data: SupportedDex);
-}
 declare class SingleNetworkExchangeTokenResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -371,7 +448,7 @@ declare class EcosystemChartDataResponse {
     constructor(data: EcosystemChartDataResponse);
 }
 declare class UniswapLikeEcosystemCharts {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
@@ -388,7 +465,7 @@ declare class UniswapLikeEcosystemCharts {
     constructor(data: UniswapLikeEcosystemCharts);
 }
 declare class VolumeEcosystemChart {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
@@ -400,7 +477,7 @@ declare class VolumeEcosystemChart {
     constructor(data: VolumeEcosystemChart);
 }
 declare class LiquidityEcosystemChart {
-    /** * The name of the DEX, eg: `uniswap`. */
+    /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
@@ -430,6 +507,10 @@ declare class HealthData {
     latest_block_signed_at: Date;
     constructor(data: HealthData);
 }
+export interface GetPoolsForTokenAddressQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quotes;
+}
 /**
  * XYK APIs
  *
@@ -444,6 +525,13 @@ export declare class XykService {
      *
      */
     getPools(chainName: Chains, dexName: string): Promise<Response<PoolResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} poolAddress - The requested pool address.
+     *
+     */
+    getDexForPoolAddress(chainName: Chains, poolAddress: string): Promise<Response<PoolToDexResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -452,6 +540,15 @@ export declare class XykService {
      *
      */
     getPoolByAddress(chainName: Chains, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetPoolsForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *
+     */
+    getPoolsForTokenAddress(chainName: Chains, tokenAddress: string, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -463,7 +560,7 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     getNetworkExchangeTokens(chainName: Chains, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
@@ -476,7 +573,7 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -484,7 +581,7 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
      *
      */
@@ -492,7 +589,7 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -500,7 +597,7 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -508,14 +605,14 @@ export declare class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     getEcosystemChartData(chainName: Chains, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     getHealthData(chainName: Chains, dexName: string): Promise<Response<HealthDataResponse>>;

package/dist/services/XykService.js

@@ -55,6 +55,31 @@ class Token {
         this.volume_out_7d = data.volume_out_7d;
     }
 }
+class PoolToDexResponse {
+    constructor(data) {
+        this.updated_at = data.updated_at && data.updated_at !== null ? (0, date_fns_1.parseISO)(data.updated_at.toString()) : null;
+        this.address = data.address;
+        this.chain_id = data.chain_id;
+        this.chain_name = data.chain_name;
+        this.items = data.items && data.items !== null ? data.items.map((itemData) => new PoolToDexItem(itemData)) : null;
+    }
+}
+class SupportedDex {
+    constructor(data) {
+        this.chain_id = data.chain_id;
+        this.chain_name = data.chain_name;
+        this.dex_name = data.dex_name;
+        this.factory_contract_address = data.factory_contract_address;
+        this.router_contract_addresses = data.router_contract_addresses;
+        this.swap_fee = data.swap_fee;
+    }
+}
+class PoolToDexItem extends SupportedDex {
+    constructor(data) {
+        super(data);
+        this.logo_url = data.logo_url;
+    }
+}
 class PoolByAddressResponse {
     constructor(data) {
         this.updated_at = data.updated_at && data.updated_at !== null ? (0, date_fns_1.parseISO)(data.updated_at.toString()) : null;
@@ -133,6 +158,39 @@ class PriceTimeseries {
         this.price_of_token_1_in_quote_currency = data.price_of_token_1_in_quote_currency;
     }
 }
+class PoolsDexDataResponse {
+    constructor(data) {
+        this.updated_at = data.updated_at && data.updated_at !== null ? (0, date_fns_1.parseISO)(data.updated_at.toString()) : null;
+        this.address = data.address;
+        this.chain_id = data.chain_id;
+        this.chain_name = data.chain_name;
+        this.quote_currency = data.quote_currency;
+        this.items = data.items && data.items !== null ? data.items.map((itemData) => new PoolsDexDataItem(itemData)) : null;
+        this.pagination = data.pagination && data.pagination !== null ? new Pagination(data.pagination) : null;
+    }
+}
+class PoolsDexDataItem {
+    constructor(data) {
+        this.dex_name = data.dex_name;
+        this.exchange = data.exchange;
+        this.exchange_ticker_symbol = data.exchange_ticker_symbol;
+        this.exchange_logo_url = data.exchange_logo_url;
+        this.total_liquidity_quote = data.total_liquidity_quote;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.token_0 = data.token_0 && data.token_0 !== null ? new PoolsDexToken(data.token_0) : null;
+        this.token_1 = data.token_1 && data.token_1 !== null ? new PoolsDexToken(data.token_1) : null;
+    }
+}
+class PoolsDexToken {
+    constructor(data) {
+        this.contract_decimals = data.contract_decimals;
+        this.contract_ticker_symbol = data.contract_ticker_symbol;
+        this.contract_address = data.contract_address;
+        this.logo_url = data.logo_url;
+        this.reserve = data.reserve;
+        this.quote_rate = data.quote_rate;
+    }
+}
 class AddressExchangeBalancesResponse {
     constructor(data) {
         this.address = data.address;
@@ -206,16 +264,6 @@ class SupportedDexesResponse {
         this.pagination = data.pagination && data.pagination !== null ? new Pagination(data.pagination) : null;
     }
 }
-class SupportedDex {
-    constructor(data) {
-        this.chain_id = data.chain_id;
-        this.chain_name = data.chain_name;
-        this.dex_name = data.dex_name;
-        this.factory_contract_address = data.factory_contract_address;
-        this.router_contract_addresses = data.router_contract_addresses;
-        this.swap_fee = data.swap_fee;
-    }
-}
 class SingleNetworkExchangeTokenResponse {
     constructor(data) {
         this.updated_at = data.updated_at && data.updated_at !== null ? (0, date_fns_1.parseISO)(data.updated_at.toString()) : null;
@@ -409,6 +457,64 @@ class XykService {
             }
         }
     }
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} poolAddress - The requested pool address.
+     *
+     */
+    async getDexForPoolAddress(chainName, poolAddress) {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new backoff_1.ExponentialBackoff();
+        while (!success) {
+            try {
+                const urlParams = new URLSearchParams();
+                response = await fetch(`https://api.covalenthq.com/v1/${chainName}/xy=k/address/${poolAddress}/dex_name/?${urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this.apiKey}`,
+                        "X-Requested-With": Client_1.userAgent
+                    }
+                });
+                data = await response.json();
+                if (data.error && data.error_code === 429) {
+                    try {
+                        await backoff.backOff();
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: data.error,
+                            error_code: data ? data.error_code : response.status,
+                            error_message: data ? data.error_message : "401 Authorization Required"
+                        };
+                    }
+                }
+                else {
+                    const dataClass = new PoolToDexResponse(data.data);
+                    (0, ApiHelpers_1.checkAndModifyResponse)(dataClass);
+                    success = true;
+                    return {
+                        data: dataClass,
+                        error: data.error,
+                        error_code: data ? data.error_code : response.status,
+                        error_message: data ? data.error_message : "401 Authorization Required"
+                    };
+                }
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : "401 Authorization Required"
+                };
+            }
+        }
+    }
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -468,6 +574,69 @@ class XykService {
             }
         }
     }
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetPoolsForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *
+     */
+    async getPoolsForTokenAddress(chainName, tokenAddress, queryParamOpts) {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new backoff_1.ExponentialBackoff();
+        while (!success) {
+            try {
+                const urlParams = new URLSearchParams();
+                if (queryParamOpts?.quoteCurrency !== undefined) {
+                    urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
+                }
+                response = await fetch(`https://api.covalenthq.com/v1/${chainName}/xy=k/address/${tokenAddress}/pools/?${urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this.apiKey}`,
+                        "X-Requested-With": Client_1.userAgent
+                    }
+                });
+                data = await response.json();
+                if (data.error && data.error_code === 429) {
+                    try {
+                        await backoff.backOff();
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: data.error,
+                            error_code: data ? data.error_code : response.status,
+                            error_message: data ? data.error_message : "401 Authorization Required"
+                        };
+                    }
+                }
+                else {
+                    const dataClass = new PoolsDexDataResponse(data.data);
+                    (0, ApiHelpers_1.checkAndModifyResponse)(dataClass);
+                    success = true;
+                    return {
+                        data: dataClass,
+                        error: data.error,
+                        error_code: data ? data.error_code : response.status,
+                        error_message: data ? data.error_message : "401 Authorization Required"
+                    };
+                }
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : "401 Authorization Required"
+                };
+            }
+        }
+    }
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -530,7 +699,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     async getNetworkExchangeTokens(chainName, dexName) {
@@ -645,7 +814,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -704,7 +873,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
      *
      */
@@ -763,7 +932,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -822,7 +991,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
@@ -881,7 +1050,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     async getEcosystemChartData(chainName, dexName) {
@@ -939,7 +1108,7 @@ class XykService {
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
     async getHealthData(chainName, dexName) {