@covalenthq/client-sdk 0.7.5 → 0.8.0

package/README.md

@@ -1,3 +1,13 @@
+<p align="center">
+  <a href="https://www.npmjs.com/package/@covalenthq/client-sdk">
+    <img src="https://img.shields.io/npm/v/@covalenthq/client-sdk" alt="NPM">
+  </a>
+  <a href="https://www.npmjs.com/package/@covalenthq/client-sdk">
+    <img src="https://img.shields.io/npm/dm/@covalenthq/client-sdk" alt="npm downloads">
+  </a>
+</p>
+
+
 # Covalent SDK for TypeScript
 
 The Covalent SDK is the fastest way to integrate the Covalent Unified API for working with blockchain data. The SDK works with all [supported chains](https://www.covalenthq.com/docs/networks/) including Mainnets and Testnets. 
@@ -182,6 +192,9 @@ The `TransactionService` class refers to the [transactions API endpoints](https:
 - `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.
+- `getTransactionsForBlockHashByPage()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+- `getTransactionsForBlockHash()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+
 
 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.
 
@@ -207,12 +220,14 @@ The `XykService` refers to the [Xy=k API endpoints](https://www.covalenthq.com/d
 - `getPoolsForWalletAddress()`: 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.
 - `getAddressExchangeBalances()`: Return balance of a wallet/contract address on a specific DEX.
 - `getNetworkExchangeTokens()`: Retrieve all network exchange tokens for a specific DEX. Useful for building a top tokens table by total liquidity within a particular DEX.
+- `getLpTokenView()`: Get a detailed view for a single liquidity pool token. Includes time series data.
 - `getSupportedDEXes()`: Get all the supported DEXs available for the xy=k endpoints, along with the swap fees and factory addresses.
 - `getDexForPoolAddress()`: Get the 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.
 - `getSingleNetworkExchangeToken()`: Get historical daily swap count for a single network exchange token.
 - `getTransactionsForAccountAddress()`: Get all the DEX transactions of a wallet. Useful for building tables of DEX activity segmented by wallet.
 - `getTransactionsForTokenAddress()`: Get all the transactions of a token within a particular DEX. Useful for getting a per-token view of DEX activity.
 - `getTransactionsForExchange()`: Get all the transactions of a particular DEX liquidity pool. Useful for building a transactions history table for an individual pool.
+- `getTransactionsForDex()`: Get all the the transactions for a given DEX. Useful for building DEX activity views.
 - `getEcosystemChartData()`: Get a 7d and 30d time-series chart of DEX activity. Includes volume and swap count.
 - `getHealthData()`: Ping the health of xy=k endpoints to get the synced block height per chain.
 
@@ -297,6 +312,16 @@ const ApiServices = async () => {
 
 Each endpoint is equipped with an exponential backoff algorithm that exponentially extends the wait time between retries, up to a `maximum of 5` retry attempts.
 
+Users have the ability to control the retry feature through the enableRetry configuration setting. By default, this feature is enabled `true`. However, users can deactivate it by setting `enableRetry` to `false`.
+
+```ts
+import { CovalentClient, CovalentClientSettings } from "@covalenthq/client-sdk";
+
+const settings: CovalentClientSettings = {
+    enableRetry: false
+}
+```
+
 ### Error Handling
 The paginated endpoints throw an error message in this format: `An error occurred {error_code}: {error_message}`. The developer will need to `catch` these errors. Note - these endpoints do not follow the default response format which is:
 ```ts