@covalenthq/client-sdk 0.2.9 → 0.4.2

package/dist/cjs/services/XykService.d.ts

@@ -0,0 +1,682 @@
+import { Chain, Quote, Response } from "./CovalentClient";
+declare class PoolResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: Pool[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    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;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    volume_7d_quote: string;
+    annualized_fee: string;
+    token_0: Token;
+    token_1: Token;
+    constructor(data: Pool);
+}
+declare class Pagination {
+    /** * True is there is another page. */
+    has_more: boolean;
+    /** * The requested page number. */
+    page_number: number;
+    /** * The requested number of items on the current page. */
+    page_size: number;
+    /** * The total number of items across all pages for this request. */
+    total_count: number;
+    constructor(data: Pagination);
+}
+declare class Token {
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    volume_in_24h: string;
+    volume_out_24h: string;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    reserve: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: string;
+    volume_in_7d: string;
+    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;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: PoolWithTimeseries[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    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;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    volume_7d_quote: string;
+    annualized_fee: string;
+    token_0: Token;
+    token_1: Token;
+    token_0_reserve_quote: string;
+    token_1_reserve_quote: string;
+    volume_timeseries_7d: VolumeTimeseries[];
+    volume_timeseries_30d: VolumeTimeseries[];
+    liquidity_timeseries_7d: LiquidityTimeseries[];
+    liquidity_timeseries_30d: LiquidityTimeseries[];
+    price_timeseries_7d: PriceTimeseries[];
+    price_timeseries_30d: PriceTimeseries[];
+    constructor(data: PoolWithTimeseries);
+}
+declare class VolumeTimeseries {
+    /** * 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;
+    sum_amount_1_in: string;
+    sum_amount_1_out: string;
+    volume_quote: string;
+    token_0_quote_rate: string;
+    token_1_quote_rate: string;
+    swap_count_24: string;
+    constructor(data: VolumeTimeseries);
+}
+declare class LiquidityTimeseries {
+    /** * 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;
+    liquidity_quote: string;
+    token_0_quote_rate: string;
+    token_1_quote_rate: string;
+    constructor(data: LiquidityTimeseries);
+}
+declare class PriceTimeseries {
+    /** * 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;
+    price_of_token_1_in_token_0: string;
+    price_of_token_1_in_token_0_description: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    price_of_token_0_in_quote_currency: string;
+    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;
+    /** * The volume 24h converted to fiat in `quote-currency`. */
+    volume_24h_quote: number;
+    /** * The volume 7d converted to fiat in `quote-currency`. */
+    volume_7d_quote: number;
+    /** * The fee 24h converted to fiat in `quote-currency`. */
+    fee_24h_quote: number;
+    /** * A prettier version of the volume 24h quote for rendering purposes. */
+    pretty_volume_24h_quote: string;
+    /** * A prettier version of the volume 7d quote for rendering purposes. */
+    pretty_volume_7d_quote: string;
+    /** * A prettier version of the fee 24h quote for rendering purposes. */
+    pretty_fee_24h_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 {
+    /** * The reserves for the token. */
+    reserve: string;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    /** * 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 exchange rate for the requested quote currency. */
+    quote_rate: number;
+    constructor(data: PoolsDexToken);
+}
+declare class AddressExchangeBalancesResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: UniswapLikeBalanceItem[];
+    constructor(data: AddressExchangeBalancesResponse);
+}
+declare class UniswapLikeBalanceItem {
+    token_0: UniswapLikeToken;
+    token_1: UniswapLikeToken;
+    pool_token: UniswapLikeTokenWithSupply;
+    constructor(data: UniswapLikeBalanceItem);
+}
+declare class UniswapLikeToken {
+    /** * 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 asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    quote: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    constructor(data: UniswapLikeToken);
+}
+declare class UniswapLikeTokenWithSupply {
+    /** * 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 asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    quote: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    constructor(data: UniswapLikeTokenWithSupply);
+}
+declare class NetworkExchangeTokensResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: TokenV2Volume[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: NetworkExchangeTokensResponse);
+}
+declare class TokenV2Volume {
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * 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;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    total_liquidity: number;
+    total_volume24h: number;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    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);
+}
+declare class SupportedDexesResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * List of response items. */
+    items: SupportedDex[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: SupportedDexesResponse);
+}
+declare class SingleNetworkExchangeTokenResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: PoolWithTimeseries[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: SingleNetworkExchangeTokenResponse);
+}
+declare class TransactionsForAccountAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForAccountAddressResponse);
+}
+declare class ExchangeTransaction {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    act: string;
+    /** * The requested address. */
+    address: string;
+    amount0: number;
+    amount1: number;
+    amount0_in: number;
+    amount0_out: number;
+    amount1_out: number;
+    to_address: string;
+    from_address: string;
+    sender_address: string;
+    total_quote: number;
+    token_0: PoolToken;
+    token_1: PoolToken;
+    token_0_quote_rate: number;
+    token_1_quote_rate: number;
+    constructor(data: ExchangeTransaction);
+}
+declare class PoolToken {
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    /** * 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;
+    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
+    supports_erc: boolean;
+    /** * The contract logo URL. */
+    logo_url: string;
+    constructor(data: PoolToken);
+}
+declare class TransactionsForTokenAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForTokenAddressResponse);
+}
+declare class TransactionsForExchangeResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForExchangeResponse);
+}
+declare class EcosystemChartDataResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: UniswapLikeEcosystemCharts[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: EcosystemChartDataResponse);
+}
+declare class UniswapLikeEcosystemCharts {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    gas_token_price_quote: number;
+    total_swaps24h: number;
+    total_active_pairs7d: number;
+    total_fees24h: number;
+    volume_chart7d: VolumeEcosystemChart[];
+    volume_chart30d: VolumeEcosystemChart[];
+    liquidity_chart7d: LiquidityEcosystemChart[];
+    liquidity_chart30d: LiquidityEcosystemChart[];
+    constructor(data: UniswapLikeEcosystemCharts);
+}
+declare class VolumeEcosystemChart {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    volume_quote: number;
+    swap_count_24: number;
+    constructor(data: VolumeEcosystemChart);
+}
+declare class LiquidityEcosystemChart {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    liquidity_quote: number;
+    constructor(data: LiquidityEcosystemChart);
+}
+declare class HealthDataResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: HealthData[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: HealthDataResponse);
+}
+declare class HealthData {
+    synced_block_height: number;
+    synced_block_signed_at: Date;
+    latest_block_height: number;
+    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?: Quote;
+}
+export interface GetPoolsForWalletAddressQueryParamOpts {
+    /** * The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. */
+    tokenAddress?: string;
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+}
+/**
+ * XYK APIs
+ *
+ */
+export declare class XykService {
+    private apiKey;
+    private debug;
+    private threadCount;
+    private LIMIT;
+    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    /**
+     *
+     * Commonly used to get all the pools of a particular DEX. Supports most common DEXs (Uniswap, SushiSwap, etc), and returns detailed trading data (volume, liquidity, swap counts, fees, LP token prices).
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     *
+     */
+    getPools(chainName: Chain, dexName: string): Promise<Response<PoolResponse>>;
+    /**
+     *
+     * Commonly used to get the corresponding supported DEX given a pool address, along with the swap fees, DEX's logo url, and factory addresses. Useful to identifying the specific DEX to which a pair address is associated.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} poolAddress - The requested pool address.
+     *
+     */
+    getDexForPoolAddress(chainName: Chain, poolAddress: string): Promise<Response<PoolToDexResponse>>;
+    /**
+     *
+     * Commonly used to get the 7 day and 30 day time-series data (volume, liquidity, price) of a particular liquidity pool in a DEX. Useful for building time-series charts on DEX trading activity.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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.
+     *
+     */
+    getPoolByAddress(chainName: Chain, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    /**
+     *
+     * Commonly used to get all pools and the supported DEX for a token. Useful for building a table of top pairs across all supported DEXes that the token is trading on.
+     *
+     * @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 {number} page - The requested 0-indexed page number.
+     * @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: Chain, tokenAddress: string, page: number, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    /**
+     *
+     * Commonly used to return balance of a wallet/contract address on a specific DEX.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     * @param {string} accountAddress - The account address.
+     *
+     */
+    getAddressExchangeBalances(chainName: Chain, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
+    /**
+     *
+     * Commonly used to get all pools and supported DEX for a wallet. Useful for building a personal DEX UI showcasing pairs and supported DEXes associated to the wallet.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} walletAddress - The account address.
+     * @param {number} page - The requested 0-indexed page number.
+     * @param {GetPoolsForWalletAddressQueryParamOpts} queryParamOpts
+     *   - `tokenAddress`: The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *
+     */
+    getPoolsForWalletAddress(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: GetPoolsForWalletAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    /**
+     *
+     * Commonly used to retrieve all network exchange tokens for a specific DEX. Useful for building a top tokens table by total liquidity within a particular DEX.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     *
+     */
+    getNetworkExchangeTokens(chainName: Chain, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
+    /**
+     *
+     * Commonly used to get all the supported DEXs available for the xy=k endpoints, along with the swap fees and factory addresses.
+     *
+     *
+     */
+    getSupportedDEXes(): Promise<Response<SupportedDexesResponse>>;
+    /**
+     *
+     * Commonly used to get historical daily swap count for a single network exchange token.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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.
+     *
+     */
+    getSingleNetworkExchangeToken(chainName: Chain, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
+    /**
+     *
+     * Commonly used to get all the DEX transactions of a wallet. Useful for building tables of DEX activity segmented by wallet.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
+     *
+     */
+    getTransactionsForAccountAddress(chainName: Chain, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
+    /**
+     *
+     * Commonly used to get all the transactions of a token within a particular DEX. Useful for getting a per-token view of DEX activity.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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.
+     *
+     */
+    getTransactionsForTokenAddress(chainName: Chain, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
+    /**
+     *
+     * Commonly used for getting all the transactions of a particular DEX liquidity pool. Useful for building a transactions history table for an individual pool.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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.
+     *
+     */
+    getTransactionsForExchange(chainName: Chain, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
+    /**
+     *
+     * Commonly used to get a 7d and 30d time-series chart of DEX activity. Includes volume and swap count.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     *
+     */
+    getEcosystemChartData(chainName: Chain, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
+    /**
+     *
+     * Commonly used to ping the health of xy=k endpoints to get the synced block height per chain.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     *
+     */
+    getHealthData(chainName: Chain, dexName: string): Promise<Response<HealthDataResponse>>;
+}
+export {};

package/dist/cjs/util/ApiHelpers.d.ts

@@ -0,0 +1,5 @@
+export declare function checkAndModifyResponse(jsonObj: any): void;
+export declare function debugOutput(url: string, responseStatus: number, startTime: number | [number, number] | undefined): Promise<void>;
+type Constructor<T> = new (...args: any[]) => T;
+export declare function paginateEndpoint<T1, T2>(url: string, apiKey: string, urlsParams: URLSearchParams, dataClassConstructor: Constructor<T1>, debug: boolean, threadCount: number): AsyncIterable<T1>;
+export {};