@covalenthq/client-sdk 0.7.6 → 0.8.0

package/dist/services/XykService.d.ts

@@ -1,4 +1,4 @@
-import { Chain, Quote, Response } from "./CovalentClient";
+import { Chain, Quote, Response, ChainID, Source } from "./CovalentClient";
 import { Chains } from "../util/Chains";
 declare class PoolResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -395,6 +395,113 @@ declare class TokenV2Volume {
     total_volume_24h_quote: number;
     constructor(data: TokenV2Volume);
 }
+declare class NetworkExchangeTokenViewResponse {
+    /** * 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: TokenV2VolumeWithChartData[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: NetworkExchangeTokenViewResponse);
+}
+declare class TokenV2VolumeWithChartData {
+    /** * 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;
+    /** * The total liquidity unscaled value. */
+    total_liquidity: number;
+    /** * The total volume 24h unscaled value. */
+    total_volume_24h: 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;
+    /** * The total amount of swaps in the last 24h. */
+    swap_count_24h: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * The 24h exchange rate for the requested quote currency. */
+    quote_rate_24h: number;
+    /** * A prettier version of the exchange rate for rendering purposes. */
+    pretty_quote_rate: string;
+    /** * A prettier version of the 24h exchange rate for rendering purposes. */
+    pretty_quote_rate_24h: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the 24h volume quote for rendering purposes. */
+    pretty_total_volume_24h_quote: string;
+    /** * The total liquidity converted to fiat in `quote-currency`. */
+    total_liquidity_quote: number;
+    /** * The total volume 24h converted to fiat in `quote-currency`. */
+    total_volume_24h_quote: number;
+    /** * The number of transactions in the last 24h. */
+    transactions_24h: number;
+    volume_timeseries_7d: VolumeTokenTimeseries[];
+    volume_timeseries_30d: VolumeTokenTimeseries[];
+    liquidity_timeseries_7d: LiquidityTokenTimeseries[];
+    liquidity_timeseries_30d: LiquidityTokenTimeseries[];
+    price_timeseries_7d: PriceTokenTimeseries[];
+    price_timeseries_30d: PriceTokenTimeseries[];
+    constructor(data: TokenV2VolumeWithChartData);
+}
+declare class VolumeTokenTimeseries {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The current date. */
+    dt: string;
+    /** * The total volume unscaled for this day. */
+    total_volume: string;
+    /** * The volume in `quote-currency` denomination. */
+    volume_quote: number;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
+    constructor(data: VolumeTokenTimeseries);
+}
+declare class LiquidityTokenTimeseries {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The current date. */
+    dt: string;
+    /** * The total liquidity unscaled up to this day. */
+    total_liquidity: string;
+    /** * The liquidity in `quote-currency` denomination. */
+    liquidity_quote: number;
+    /** * A prettier version of the liquidity quote for rendering purposes. */
+    pretty_liquidity_quote: string;
+    constructor(data: LiquidityTokenTimeseries);
+}
+declare class PriceTokenTimeseries {
+    /** * The name of the DEX, eg: `uniswap_v2`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The current date. */
+    dt: string;
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quote_currency: string;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * A prettier version of the exchange rate for rendering purposes. */
+    pretty_quote_rate: string;
+    constructor(data: PriceTokenTimeseries);
+}
 declare class SupportedDexesResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -536,6 +643,19 @@ declare class TransactionsForExchangeResponse {
     pagination: Pagination;
     constructor(data: TransactionsForExchangeResponse);
 }
+declare class NetworkTransactionsResponse {
+    /** * 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: NetworkTransactionsResponse);
+}
 declare class EcosystemChartDataResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -617,11 +737,19 @@ declare class HealthData {
     latest_block_signed_at: Date;
     constructor(data: HealthData);
 }
+export interface GetPoolsQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
 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;
     /** * The DEX name eg: `uniswap_v2`. */
     dexName?: string;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
 }
 export interface GetPoolsForWalletAddressQueryParamOpts {
     /** * The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. */
@@ -630,6 +758,44 @@ export interface GetPoolsForWalletAddressQueryParamOpts {
     quoteCurrency?: Quote;
     /** * The DEX name eg: `uniswap_v2`. */
     dexName?: string;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+}
+export interface GetNetworkExchangeTokensQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetLpTokenViewQueryParamOpts {
+    /** * 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 GetSingleNetworkExchangeTokenQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetTransactionsForTokenAddressQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetTransactionsForExchangeQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetTransactionsForDexQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
 }
 /**
  * XYK APIs
@@ -641,17 +807,21 @@ export declare class XykService {
     private threadCount;
     private is_key_valid;
     private enableRetry;
+    private source;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry: boolean, source: Source);
     /**
      *
      * 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`.
+     * @param {GetPoolsQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getPools(chainName: Chain | Chains, dexName: string): Promise<Response<PoolResponse>>;
+    getPools(chainName: Chain | Chains | ChainID, dexName: string, queryParamOpts?: GetPoolsQueryParamOpts): 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.
@@ -660,7 +830,7 @@ export declare class XykService {
      * @param {string} poolAddress - The requested pool address.
      *
      */
-    getDexForPoolAddress(chainName: Chain | Chains, poolAddress: string): Promise<Response<PoolToDexResponse>>;
+    getDexForPoolAddress(chainName: Chain | Chains | ChainID, 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.
@@ -670,7 +840,7 @@ export declare class XykService {
      * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getPoolByAddress(chainName: Chain | Chains, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    getPoolByAddress(chainName: Chain | Chains | ChainID, 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.
@@ -680,9 +850,11 @@ export declare class XykService {
      * @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`.
+     *   - `dexName`: The DEX name eg: `uniswap_v2`.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
      *
      */
-    getPoolsForTokenAddress(chainName: Chain | Chains, tokenAddress: string, page: number, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    getPoolsForTokenAddress(chainName: Chain | Chains | ChainID, tokenAddress: string, page: number, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
     /**
      *
      * Commonly used to return balance of a wallet/contract address on a specific DEX.
@@ -692,7 +864,7 @@ export declare class XykService {
      * @param {string} accountAddress - The account address.
      *
      */
-    getAddressExchangeBalances(chainName: Chain | Chains, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
+    getAddressExchangeBalances(chainName: Chain | Chains | ChainID, 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.
@@ -703,18 +875,35 @@ export declare class XykService {
      * @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`.
+     *   - `dexName`: The DEX name eg: `uniswap_v2`.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
      *
      */
-    getPoolsForWalletAddress(chainName: Chain | Chains, walletAddress: string, page: number, queryParamOpts?: GetPoolsForWalletAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    getPoolsForWalletAddress(chainName: Chain | Chains | ChainID, 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`.
+     * @param {GetNetworkExchangeTokensQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getNetworkExchangeTokens(chainName: Chain | Chains, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
+    getNetworkExchangeTokens(chainName: Chain | Chains | ChainID, dexName: string, queryParamOpts?: GetNetworkExchangeTokensQueryParamOpts): Promise<Response<NetworkExchangeTokensResponse>>;
+    /**
+     *
+     * Commonly used to get a detailed view for a single liquidity pool token. Includes time series data.
+     *
+     * @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.
+     * @param {GetLpTokenViewQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *
+     */
+    getLpTokenView(chainName: Chain | Chains | ChainID, dexName: string, tokenAddress: string, queryParamOpts?: GetLpTokenViewQueryParamOpts): Promise<Response<NetworkExchangeTokenViewResponse>>;
     /**
      *
      * Commonly used to get all the supported DEXs available for the xy=k endpoints, along with the swap fees and factory addresses.
@@ -729,9 +918,12 @@ export declare class XykService {
      * @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.
+     * @param {GetSingleNetworkExchangeTokenQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getSingleNetworkExchangeToken(chainName: Chain | Chains, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
+    getSingleNetworkExchangeToken(chainName: Chain | Chains | ChainID, dexName: string, tokenAddress: string, queryParamOpts?: GetSingleNetworkExchangeTokenQueryParamOpts): Promise<Response<SingleNetworkExchangeTokenResponse>>;
     /**
      *
      * Commonly used to get all the DEX transactions of a wallet. Useful for building tables of DEX activity segmented by wallet.
@@ -741,7 +933,7 @@ export declare class XykService {
      * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
      *
      */
-    getTransactionsForAccountAddress(chainName: Chain | Chains, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
+    getTransactionsForAccountAddress(chainName: Chain | Chains | ChainID, 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.
@@ -749,9 +941,12 @@ export declare class XykService {
      * @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.
+     * @param {GetTransactionsForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getTransactionsForTokenAddress(chainName: Chain | Chains, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
+    getTransactionsForTokenAddress(chainName: Chain | Chains | ChainID, dexName: string, tokenAddress: string, queryParamOpts?: GetTransactionsForTokenAddressQueryParamOpts): 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.
@@ -759,9 +954,25 @@ export declare class XykService {
      * @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.
+     * @param {GetTransactionsForExchangeQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *
+     */
+    getTransactionsForExchange(chainName: Chain | Chains | ChainID, dexName: string, poolAddress: string, queryParamOpts?: GetTransactionsForExchangeQueryParamOpts): Promise<Response<TransactionsForExchangeResponse>>;
+    /**
+     *
+     * Commonly used to get all the the transactions for a given DEX. Useful for building DEX activity views.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     * @param {GetTransactionsForDexQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getTransactionsForExchange(chainName: Chain | Chains, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
+    getTransactionsForDex(chainName: Chain | Chains | ChainID, dexName: string, queryParamOpts?: GetTransactionsForDexQueryParamOpts): Promise<Response<NetworkTransactionsResponse>>;
     /**
      *
      * Commonly used to get a 7d and 30d time-series chart of DEX activity. Includes volume and swap count.
@@ -770,7 +981,7 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getEcosystemChartData(chainName: Chain | Chains, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
+    getEcosystemChartData(chainName: Chain | Chains | ChainID, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
     /**
      *
      * Commonly used to ping the health of xy=k endpoints to get the synced block height per chain.
@@ -779,6 +990,6 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getHealthData(chainName: Chain | Chains, dexName: string): Promise<Response<HealthDataResponse>>;
+    getHealthData(chainName: Chain | Chains | ChainID, dexName: string): Promise<Response<HealthDataResponse>>;
 }
 export {};