@covalenthq/client-sdk 2.2.5 → 2.2.6

package/dist/cjs/src/services/PricingService.d.ts

@@ -1,6 +1,6 @@
 import { type Execution } from "../utils/functions/execution";
-import { type Chain, type GoldRushResponse, type Quote } from "../utils/types/Generic.types";
-import { type GetTokenPricesQueryParamOpts, type TokenPricesResponse } from "../utils/types/PricingService.types";
+import type { Chain, GoldRushResponse, Quote } from "../utils/types/Generic.types";
+import type { GetTokenPricesQueryParamOpts, PoolSpotPriceQueryParamsOpts, PoolSpotPricesResponse, TokenPricesResponse } from "../utils/types/PricingService.types";
 /**
  * Pricing API
  *
@@ -22,4 +22,15 @@ export declare class PricingService {
      *
      */
     getTokenPrices(chainName: Chain, quoteCurrency: Quote, contractAddress: string, queryParamOpts?: GetTokenPricesQueryParamOpts): Promise<GoldRushResponse<TokenPricesResponse[]>>;
+    /**
+     *
+     * Get the spot token pair prices for a specified pool contract address. Supports pools on Uniswap V2, V3 and their forks.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} contractAddress - The pool contract address.
+     * @param {GetTokenPricesQueryParamOpts} queryParamOpts
+     *    - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`.
+     *
+     */
+    getPoolSpotPrices(chainName: Chain, contractAddress: string, queryParamOpts?: PoolSpotPriceQueryParamsOpts): Promise<GoldRushResponse<PoolSpotPricesResponse[]>>;
 }

package/dist/cjs/src/utils/types/PricingService.types.d.ts

@@ -38,3 +38,43 @@ export type GetTokenPricesQueryParamOpts = Nullable<{
     /** * Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order. */
     pricesAtAsc?: boolean;
 }>;
+export type PoolSpotPriceQueryParamsOpts = Nullable<{
+    /** * The currency to convert. */
+    quoteCurrency: string;
+}>;
+export type PoolSpotPricesResponse = Nullable<{
+    /** * The timestamp when the response was generated. */
+    updated_at: Date;
+    /** * The pool contract address. */
+    pool_address: string;
+    /** * The contract address of token_0 in the token pair making up the pool. */
+    token_0_address: string;
+    /** * The contract name of token_0 in the token pair making up the pool. */
+    token_0_name: string;
+    /** * The contract symbol of token_0 in the token pair making up the pool. */
+    token_0_ticker: string;
+    /** * Price of token_0 in units of token_1. */
+    token_0_price: string;
+    /** * Price of token_0 in units of token_1 as of 24 hours ago. */
+    token_0_price_24h: string;
+    /** * Price of token_0 in the selected quote currency (defaults to USD). */
+    token_0_price_quote: string;
+    /** * Price of token_0 in the selected quote currency (defaults to USD) as of 24 hours ago. */
+    token_0_price_24h_quote: string;
+    /** * The contract address of token_1 in the token pair making up the pool. */
+    token_1_address: string;
+    /** * The contract name of token_1 in the token pair making up the pool. */
+    token_1_name: string;
+    /** * The contract symbol of token_1 in the token pair making up the pool. */
+    token_1_ticker: string;
+    /** * Price of token_1 in units of token_0. */
+    token_1_price: string;
+    /** * Price of token_1 in units of token_0 as of 24 hours ago. */
+    token_1_price_24h: string;
+    /** * Price of token_1 in the selected quote currency (defaults to USD). */
+    token_1_price_quote: string;
+    /** * Price of token_1 in the selected quote currency (defaults to USD) as of 24 hours ago. */
+    token_1_price_24h_quote: string;
+    /** * The currency to convert. */
+    quote_currency: string;
+}>;

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-var version = "2.2.5";
+var version = "2.2.6";
 
 const bigIntParser = (val) => {
     if (val === null || val === undefined) {
@@ -2302,6 +2302,35 @@ class PricingService {
         };
         return await this.execution.execute(endpoint, parseData);
     }
+    /**
+     *
+     * Get the spot token pair prices for a specified pool contract address. Supports pools on Uniswap V2, V3 and their forks.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} contractAddress - The pool contract address.
+     * @param {GetTokenPricesQueryParamOpts} queryParamOpts
+     *    - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`.
+     *
+     */
+    async getPoolSpotPrices(chainName, contractAddress, queryParamOpts) {
+        const endpoint = endpointGenerator(`pricing/spot_prices/${chainName}/pools/${contractAddress}`, [
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quoteCurrency,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.forEach((dataItem) => {
+                    dataItem.updated_at = dataItem.updated_at
+                        ? new Date(dataItem.updated_at)
+                        : null;
+                });
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
 }
 
 /**