@covalenthq/client-sdk 0.5.0 → 0.5.2

package/README.md

@@ -92,7 +92,7 @@ The `BalanceService` class refers to the [balances API endpoints](https://www.co
 - `getHistoricalTokenBalancesForWalletAddress()`: Fetch the historical native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address at a given block height or date. Response includes daily prices and other metadata.
 - `getHistoricalPortfolioForWalletAddress()`: Render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.
 - `getErc20TransfersForWalletAddress()`: Render the transfer-in and transfer-out of a token along with historical prices from an address. (Paginated)
-- `getErc20TransfersForWalletAddressByPage()`: Render the transfer-in and transfer-out of a token along with historical prices from an address. (By page)
+- `getErc20TransfersForWalletAddressByPage()`: Render the transfer-in and transfer-out of a token along with historical prices from an address. (NonPaginated)
 - `getTokenHoldersV2ForTokenAddress()`: Get a list of all the token holders for a specified ERC20 or ERC721 token. Returns historic token holders when block-height is set (defaults to latest). Useful for building pie charts of token holders.
 - `getNativeTokenBalance()`: Get the native token balance for an address. This endpoint is required because native tokens are usually not ERC20 tokens and sometimes you want something lightweight.
 
@@ -138,7 +138,8 @@ The `PricingService` class refers to the [historical token prices API endpoint](
 
 The `TransactionService` class refers to the [transactions API endpoints](https://www.covalenthq.com/docs/api/transactions/get-a-transaction/):
 
-- `getAllTransactionsForAddress()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+- `getAllTransactionsForAddress()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Paginated)
+- `getTransactionsForAddressV3()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Nonpaginated)
 - `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.

package/dist/cjs/index.js

@@ -1377,9 +1377,20 @@ class ChainItem {
         this.black_logo_url = data.black_logo_url;
         this.white_logo_url = data.white_logo_url;
         this.is_appchain = data.is_appchain;
+        this.color_theme = data.color_theme && data.color_theme !== null ? new ColorTheme(data.color_theme) : null;
         this.appchain_of = data.appchain_of && data.appchain_of !== null ? new ChainItem(data.appchain_of) : null;
     }
 }
+class ColorTheme {
+    constructor(data) {
+        this.red = data.red;
+        this.green = data.green;
+        this.blue = data.blue;
+        this.alpha = data.alpha;
+        this.hex = data.hex;
+        this.css_rgb = data.css_rgb;
+    }
+}
 class AllChainsStatusResponse {
     constructor(data) {
         this.updated_at = data.updated_at && data.updated_at !== null ? dateFns.parseISO(data.updated_at.toString()) : null;
@@ -3473,6 +3484,12 @@ class Param {
         this.value = data.value;
     }
 }
+class PaginationLinks {
+    constructor(data) {
+        this.prev = data.prev;
+        this.next = data.next;
+    }
+}
 class TransactionsBlockResponse {
     constructor(data) {
         this.updated_at = data.updated_at && data.updated_at !== null ? dateFns.parseISO(data.updated_at.toString()) : null;
@@ -3504,6 +3521,18 @@ class TransactionSummary {
         this.tx_detail_link = data.tx_detail_link;
     }
 }
+class TransactionsResponse {
+    constructor(data) {
+        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.current_page = data.current_page;
+        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;
+    }
+}
 /**
  * Transactions APIs
  *
@@ -3842,6 +3871,87 @@ 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} page - The requested page, 0-indexed.
+     * @param {GetTransactionsForAddressV3QueryParamOpts} 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.
+     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    async getTransactionsForAddressV3(chainName, walletAddress, page, queryParamOpts) {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this.apiKey, this.debug);
+        while (!success) {
+            try {
+                const urlParams = new URLSearchParams();
+                if (queryParamOpts?.quoteCurrency !== undefined) {
+                    urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
+                }
+                if (queryParamOpts?.noLogs !== undefined) {
+                    urlParams.append("no-logs", queryParamOpts?.noLogs.toString());
+                }
+                if (queryParamOpts?.blockSignedAtAsc !== undefined) {
+                    urlParams.append("block-signed-at-asc", queryParamOpts?.blockSignedAtAsc.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 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, startTime);
+                if (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,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsResponse(data.data);
+                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 {
@@ -5186,7 +5296,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.5.0";
+const userAgent = "com.covalenthq.sdk.typescript/0.5.2";
 /**
  * CovalentClient Class
  */