@covalenthq/client-sdk 0.2.9 → 0.5.0

package/dist/services/XykService.d.ts

@@ -1,4 +1,4 @@
-import { Chains, Quotes, Response } from "./Client";
+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;
@@ -93,7 +93,7 @@ declare class SupportedDex {
     constructor(data: SupportedDex);
 }
 declare class PoolToDexItem extends SupportedDex {
-    /** * The dex logo URL */
+    /** * The dex logo URL. */
     logo_url: string;
     constructor(data: PoolToDexItem);
 }
@@ -221,6 +221,18 @@ declare class PoolsDexDataItem {
     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. */
@@ -228,6 +240,10 @@ declare class PoolsDexDataItem {
     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. */
@@ -236,8 +252,6 @@ declare class PoolsDexToken {
     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);
@@ -509,7 +523,17 @@ declare class 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;
+    quoteCurrency?: Quote;
+    /** * The DEX name eg: `uniswap_v2`. */
+    dexName?: string;
+}
+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;
+    /** * The DEX name eg: `uniswap_v2`. */
+    dexName?: string;
 }
 /**
  * XYK APIs
@@ -517,104 +541,146 @@ export interface GetPoolsForTokenAddressQueryParamOpts {
  */
 export declare class XykService {
     private apiKey;
-    constructor(apiKey: string);
+    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: Chains, dexName: string): Promise<Response<PoolResponse>>;
+    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: Chains, poolAddress: string): Promise<Response<PoolToDexResponse>>;
+    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: Chains, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    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: Chains, tokenAddress: string, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    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: Chains, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
+    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: Chains, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
+    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: Chains, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
+    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: Chains, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
+    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: Chains, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
+    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: Chains, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
+    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: Chains, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
+    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: Chains, dexName: string): Promise<Response<HealthDataResponse>>;
+    getHealthData(chainName: Chain, dexName: string): Promise<Response<HealthDataResponse>>;
 }
 export {};