@covalenthq/client-sdk 0.7.2 → 0.7.4

package/README.md

@@ -181,8 +181,9 @@ The `TransactionService` class refers to the [transactions API endpoints](https:
 - `getTransaction()`: Fetch and render a single transaction including its decoded log events. Additionally return semantically decoded information for DEX trades, lending and NFT sales.
 - `getTransactionsForBlock()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
 - `getTransactionSummary()`: Fetch the earliest and latest transactions, and the transaction count for a wallet. Calculate the age of the wallet and the time it has been idle and quickly gain insights into their engagement with web3.
+- `getTimeBucketTransactionsForAddress()`: Fetch all transactions including their decoded log events in a 15-minute time bucket interval.
 
-The functions `getAllTransactionsForAddressByPage()` and `getTransactionsForAddressV3()` have been enhanced with the introduction of `next()` and `prev()` support functions. These functions facilitate a smoother transition for developers navigating through our links object, which includes `prev` and `next` fields. Instead of requiring developers to manually extract values from these fields and create JavaScript API fetch calls for the URL values, the new `next()` and `prev()` functions provide a streamlined approach, allowing developers to simulate this behavior more efficiently.
+The functions `getAllTransactionsForAddressByPage()`, `getTransactionsForAddressV3()`, and `getTimeBucketTransactionsForAddress()` have been enhanced with the introduction of `next()` and `prev()` support functions. These functions facilitate a smoother transition for developers navigating through our links object, which includes `prev` and `next` fields. Instead of requiring developers to manually extract values from these fields and create JavaScript API fetch calls for the URL values, the new `next()` and `prev()` functions provide a streamlined approach, allowing developers to simulate this behavior more efficiently.
 
 ```ts
 import { CovalentClient } from "@covalenthq/client-sdk";

package/dist/cjs/index.js

@@ -4789,6 +4789,155 @@ class TransactionsResponse {
         }
     }
 }
+class TransactionsTimeBucketResponse {
+    constructor(data, _debug, _apiKey, _threadCount, _urlParams) {
+        this._debug = _debug;
+        this._apiKey = _apiKey;
+        this._threadCount = _threadCount;
+        this._urlParams = _urlParams;
+        this.address = data.address;
+        this.updated_at = data.updated_at && data.updated_at !== null ? dateFns.parseISO(data.updated_at.toString()) : null;
+        this.quote_currency = data.quote_currency;
+        this.chain_id = data.chain_id;
+        this.chain_name = data.chain_name;
+        this.complete = data.complete;
+        this.current_bucket = data.current_bucket;
+        this.links = data.links && data.links !== null ? new PaginationLinks(data.links) : null;
+        this.items = data.items && data.items !== null ? data.items.map((itemData) => new Transaction(itemData)) : null;
+    }
+    async prev() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.prev === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.prev}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status ?? 429, startTime);
+                if (response.status === null || response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status ?? 429,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsTimeBucketResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "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 : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
+    async next() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.next === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.next}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status ?? 429, startTime);
+                if (response.status === null || response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status ?? 429,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsTimeBucketResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "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 : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
+}
 /**
  * Transactions APIs
  *
@@ -5293,12 +5442,12 @@ class TransactionService {
                 if (this.debug) {
                     startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
                 }
-                response = await fetch(`https://api.covalenthq.com/v1/${chainName}/address/${walletAddress}/transactions_v3/page/${page}/?${urlParams}`, {
+                response = await this.LIMIT(() => fetch(`https://api.covalenthq.com/v1/${chainName}/address/${walletAddress}/transactions_v3/page/${page}/?${urlParams}`, {
                     headers: {
                         "Authorization": `Bearer ${this.apiKey}`,
                         "X-Requested-With": userAgent
                     }
-                });
+                }));
                 debugOutput(response.url, response.status ?? 429, startTime);
                 if (response.status === null || response.status === 429) {
                     try {
@@ -5338,6 +5487,91 @@ class TransactionService {
             }
         }
     }
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {number} timeBucket - The 0-indexed 15-minute time bucket. E.g. 27 Feb 2023 05:23 GMT = 1677475383 (Unix time). 1677475383/900=1863861 timeBucket.
+     * @param {GetTimeBucketTransactionsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    async getTimeBucketTransactionsForAddress(chainName, walletAddress, timeBucket, queryParamOpts) {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this.apiKey, this.debug);
+        while (!success) {
+            try {
+                const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
+                if (queryParamOpts?.quoteCurrency !== undefined) {
+                    urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
+                }
+                if (queryParamOpts?.noLogs !== undefined) {
+                    urlParams.append("no-logs", queryParamOpts?.noLogs.toString());
+                }
+                if (queryParamOpts?.withSafe !== undefined) {
+                    urlParams.append("with-safe", queryParamOpts?.withSafe.toString());
+                }
+                let startTime;
+                if (this.debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                response = await this.LIMIT(() => fetch(`https://api.covalenthq.com/v1/${chainName}/bulk/transactions/${walletAddress}/${timeBucket}/?${urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this.apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status ?? 429, startTime);
+                if (response.status === null || response.status === 429) {
+                    try {
+                        data = await this.LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status ?? 429,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsTimeBucketResponse(data.data, this.debug, this.apiKey, this.threadCount, urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "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 : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
 }
 
 class PoolResponse {
@@ -5358,6 +5592,10 @@ class Pool {
         this.fee_24h_quote = data.fee_24h_quote;
         this.total_supply = data.total_supply && data.total_supply !== null ? BigInt(data.total_supply) : null;
         this.quote_rate = data.quote_rate;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_volume_24h_quote = data.pretty_volume_24h_quote;
+        this.pretty_fee_24h_quote = data.pretty_fee_24h_quote;
+        this.pretty_volume_7d_quote = data.pretty_volume_7d_quote;
         this.chain_name = data.chain_name;
         this.chain_id = data.chain_id;
         this.dex_name = data.dex_name;
@@ -5404,6 +5642,8 @@ class SupportedDex {
         this.chain_id = data.chain_id;
         this.chain_name = data.chain_name;
         this.dex_name = data.dex_name;
+        this.display_name = data.display_name;
+        this.logo_url = data.logo_url;
         this.factory_contract_address = data.factory_contract_address;
         this.router_contract_addresses = data.router_contract_addresses;
         this.swap_fee = data.swap_fee;
@@ -5437,6 +5677,10 @@ class PoolWithTimeseries {
         this.dex_name = data.dex_name;
         this.volume_7d_quote = data.volume_7d_quote;
         this.annualized_fee = data.annualized_fee;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_volume_24h_quote = data.pretty_volume_24h_quote;
+        this.pretty_fee_24h_quote = data.pretty_fee_24h_quote;
+        this.pretty_volume_7d_quote = data.pretty_volume_7d_quote;
         this.token_0_reserve_quote = data.token_0_reserve_quote;
         this.token_1_reserve_quote = data.token_1_reserve_quote;
         this.token_0 = data.token_0 && data.token_0 !== null ? new Token(data.token_0) : null;
@@ -5455,11 +5699,12 @@ class VolumeTimeseries {
         this.chain_id = data.chain_id;
         this.dt = data.dt;
         this.exchange = data.exchange;
-        this.sum_amount_0_in = data.sum_amount_0_in;
-        this.sum_amount_0_out = data.sum_amount_0_out;
-        this.sum_amount_1_in = data.sum_amount_1_in;
-        this.sum_amount_1_out = data.sum_amount_1_out;
+        this.sum_amount0in = data.sum_amount0in;
+        this.sum_amount0out = data.sum_amount0out;
+        this.sum_amount1in = data.sum_amount1in;
+        this.sum_amount1out = data.sum_amount1out;
         this.volume_quote = data.volume_quote;
+        this.pretty_volume_quote = data.pretty_volume_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
         this.swap_count_24 = data.swap_count_24;
@@ -5474,6 +5719,7 @@ class LiquidityTimeseries {
         this.r0_c = data.r0_c;
         this.r1_c = data.r1_c;
         this.liquidity_quote = data.liquidity_quote;
+        this.pretty_liquidity_quote = data.pretty_liquidity_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
     }
@@ -5484,13 +5730,15 @@ class PriceTimeseries {
         this.chain_id = data.chain_id;
         this.dt = data.dt;
         this.exchange = data.exchange;
-        this.price_of_token_0_in_token_1 = data.price_of_token_0_in_token_1;
-        this.price_of_token_0_in_token_1_description = data.price_of_token_0_in_token_1_description;
-        this.price_of_token_1_in_token_0 = data.price_of_token_1_in_token_0;
-        this.price_of_token_1_in_token_0_description = data.price_of_token_1_in_token_0_description;
+        this.price_of_token0_in_token1 = data.price_of_token0_in_token1;
+        this.pretty_price_of_token0_in_token1 = data.pretty_price_of_token0_in_token1;
+        this.price_of_token0_in_token1_description = data.price_of_token0_in_token1_description;
+        this.price_of_token1_in_token0 = data.price_of_token1_in_token0;
+        this.pretty_price_of_token1_in_token0 = data.pretty_price_of_token1_in_token0;
+        this.price_of_token1_in_token0_description = data.price_of_token1_in_token0_description;
         this.quote_currency = data.quote_currency;
-        this.price_of_token_0_in_quote_currency = data.price_of_token_0_in_quote_currency;
-        this.price_of_token_1_in_quote_currency = data.price_of_token_1_in_quote_currency;
+        this.price_of_token0_in_quote_currency = data.price_of_token0_in_quote_currency;
+        this.price_of_token1_in_quote_currency = data.price_of_token1_in_quote_currency;
     }
 }
 class PoolsDexDataResponse {
@@ -5595,6 +5843,11 @@ class TokenV2Volume {
         this.contract_decimals = data.contract_decimals;
         this.swap_count_24h = data.swap_count_24h;
         this.quote_rate = data.quote_rate;
+        this.quote_rate_24h = data.quote_rate_24h;
+        this.pretty_quote_rate = data.pretty_quote_rate;
+        this.pretty_quote_rate_24h = data.pretty_quote_rate_24h;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_total_volume_24h_quote = data.pretty_total_volume_24h_quote;
         this.total_liquidity_quote = data.total_liquidity_quote;
         this.total_volume_24h_quote = data.total_volume_24h_quote;
     }
@@ -5639,6 +5892,7 @@ class ExchangeTransaction {
         this.from_address = data.from_address;
         this.sender_address = data.sender_address;
         this.total_quote = data.total_quote;
+        this.pretty_total_quote = data.pretty_total_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
         this.token_0 = data.token_0 && data.token_0 !== null ? new PoolToken(data.token_0) : null;
@@ -6795,7 +7049,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.7.2";
+const userAgent = "com.covalenthq.sdk.typescript/0.7.4";
 /**
  * CovalentClient Class
  */
@@ -7111,6 +7365,24 @@ exports.Chains = void 0;
     Chains["BNB_OPBNB_MAINNET"] = "bnb-opbnb-mainnet";
     Chains["TELOS_MAINNET"] = "telos-mainnet";
     Chains["TELOS_TESTNET"] = "telos-testnet";
+    Chains["AVALANCHE_HUBBLE_EXCHANGE_TESTNET"] = "avalanche-hubble-exchange-testnet";
+    Chains["AVALANCHE_MIHO_TESTNET"] = "avalanche-miho-testnet";
+    Chains["AVALANCHE_BULLETIN_TESTNET"] = "avalanche-bulletin-testnet";
+    Chains["AVALANCHE_KIWI_TESTNET"] = "avalanche-kiwi-testnet";
+    Chains["AVALANCHE_HERO_TESTNET"] = "avalanche-hero-testnet";
+    Chains["AVALANCHE_AVACLOUD_TESTNET"] = "avalanche-avacloud-testnet";
+    Chains["AVALANCHE_THIRDWEB_TESTNET"] = "avalanche-thirdweb-testnet";
+    Chains["AVALANCHE_MONDRIAN_TESTNET"] = "avalanche-mondrian-testnet";
+    Chains["AVALANCHE_CONDUIT_TESTNET"] = "avalanche-conduit-testnet";
+    Chains["AVALANCHE_NMAC_TESTNET"] = "avalanche-nmac-testnet";
+    Chains["AVALANCHE_ORDERLY_TESTNET"] = "avalanche-orderly-testnet";
+    Chains["AVALANCHE_AMPLIFY_TESTNET"] = "avalanche-amplify-testnet";
+    Chains["AVALANCHE_MIRAI_TESTNET"] = "avalanche-mirai-testnet";
+    Chains["AVALANCHE_WAGMI_TESTNET"] = "avalanche-wagmi-testnet";
+    Chains["AVALANCHE_PLAYA3ULL_TESTNET"] = "avalanche-playa3ull-testnet";
+    Chains["AVALANCHE_BEAM_MAINNET"] = "avalanche-beam-mainnet";
+    Chains["SCROLL_MAINNET"] = "scroll-mainnet";
+    Chains["ETH_HOLESKY"] = "eth-holesky";
 })(exports.Chains || (exports.Chains = {}));
 
 exports.Client = Client;