@covalenthq/client-sdk 0.2.9 → 0.4.2

package/README.md

@@ -1,6 +1,6 @@
 # covalent-api-sdk-ts
 
-The Covalent API SDK supported for TypeScript.
+The Covalent API SDK supported for TypeScript. Use `Node v18` and above for best results.
 
 The Covalent SDK supports all chains across Mainnets and Testnets. List of supported Networks can be found on our [Supported Networks page](https://www.covalenthq.com/docs/networks/)
 
@@ -21,10 +21,10 @@ yarn add @covalenthq/client-sdk
 After installing the app, you can then import and use the SDK:
 
 ```ts
-import { Client } from "@covalenthq/client-sdk";
+import { CovalentClient } from "@covalenthq/client-sdk";
 
 const ApiServices = async () => {
-    const client = new Client("YOUR_API_KEY"); // Replace with your Covalent API key.
+    const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
     const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS"); // Example call, refer to API Docs for required paramaters or click into the method `getTokenBalancesForWalletAddress` to see the accepted parameter arguments
     if (!resp.error) {
         console.log(resp.data);
@@ -40,7 +40,7 @@ const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-m
 
 All of our types are also available for import! For example:
 ```ts
-import { Client, BalancesResponse,  BalanceItem } from "@covalenthq/client-sdk";
+import { CovalentClient, BalancesResponse,  BalanceItem } from "@covalenthq/client-sdk";
 const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS", {quoteCurrency: "CAD", nft: true});
 const data: BalancesResponse = resp.data; // `resp.data` in this case is of type `BalancesResponse`
 const items: BalanceItem[] = resp.data.items; // `resp.data.items` is of type `BalanceItem[]`
@@ -57,7 +57,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 - `SecurityService`: Access to the Covalent's getApprovals endpoint
 - `BalanceService`: Access to the Covalent's balances endpoints
-- `BaseServices`: Access to the Covalent's log events, chain, and block endpoints
+- `BaseService`: Access to the Covalent's log events, chain, and block endpoints
 - `NftService`: Access to the Covalent's NFT endpoints
 - `PricingService`: Access to the Covalent's get historical token prices endpoint
 - `TransactionService`: Access to the Covalent's transactions endpoints
@@ -79,9 +79,9 @@ The `BalanceService` class contains the balances endpoints. Listed below are the
 - `getErc20TransfersForWalletAddress()`: Render the transfer-in and transfer-out of a token along with historical prices from an address.
 - `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.
 
-### BaseServices
+### BaseService
 
-The `BaseServices` class contains the log events, chain, and block endpoints. Listed below are the supported endpoints, also refer to our api docs under the Base section in our class A endpoints.
+The `BaseService` class contains the log events, chain, and block endpoints. Listed below are the supported endpoints, also refer to our api docs under the Base section in our class A endpoints.
 
 - `getBlock()`: Fetch and render a single block for a block explorer.
 - `getLogs()`: Get all the event logs of the latest block, or for a range of blocks. Includes sender contract metadata as well as decoded logs.
@@ -107,7 +107,6 @@ The `NftService` class contains the NFT endpoints. Listed below are the supporte
 - `getCollectionTraitsSummary()`: Used to calculate rarity scores for a collection based on its traits.
 - `checkOwnershipInNft()`: Used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.
 - `checkOwnershipInNftForSpecificTokenId()`: Used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.
-- `getNftExternalMetadataForContract()`: Get a single NFT with metadata by token ID from a collection. Useful for building NFT card displays.
 
 ### PricingService
 
@@ -131,8 +130,9 @@ The `XykService` class contains the Xy=k endpoints. Listed below are the support
 - `getPools()`: 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).
 - `getPoolByAddress()`: 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.
 - `getPoolsForTokenAddress()`: 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.
+- `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()`: Get the balance of a wallet address in a DEX. Useful for finding out user balances locked up in DEX pools.
+- `getNetworkExchangeTokens()`: Retrieve all network exchange tokens for a specific DEX. Useful for building a top tokens table by total liquidity within a particular DEX.
 - `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.
@@ -157,23 +157,73 @@ The `XykService` class contains the Xy=k endpoints. Listed below are the support
 
 The listed endpoints above are currently the only endpoints that support pagination which return 100 results per page. To get the next page, it uses a `link url` or the `page-number` provided in the endpoint response. Here's an example of how to paginate through all recent transactions on the ethereum blockchain for the demo's ENS address:
 ```ts
-import { Client } from "@covalenthq/client-sdk";
+import { CovalentClient } from "@covalenthq/client-sdk";
 
 const ApiServices = async () => {
-    const client = new Client("YOUR_API_KEY"); // Replace with your Covalent API key.
-    for await (const tx of client.TransactionService.getAllTransactionsForAddress("eth-mainnet", "demo.eth")) {
-        console.log("tx", tx);
+    const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
+    try {
+        for await (const tx of client.TransactionService.getAllTransactionsForAddress("eth-mainnet", "demo.eth")) {
+            console.log("tx", tx);
+        }
+    } catch (error) {
+        console.log(error.message);
     }
 }
 ```
 The paginated endpoints exclusively returns their response items without the response wrapper, enabling developers to access the list seamlessly, ensuring efficient and straightforward item retrieval.
 
+### Concurrency Mechanism
+
+Developers have the flexibility to specify the desired number of concurrent API calls they wish to execute, with a default value of `3` applied if no input is provided.
+
+```ts
+import { CovalentClient, CovalentClientSettings } from "@covalenthq/client-sdk";
+
+const settings: CovalentClientSettings = {
+    threadCount: 5
+}
+
+const ApiServices = async () => {
+    const client = new CovalentClient("YOUR_API_KEY", settings); // Replace with your Covalent API key and add set debugger
+    const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
+    if (!resp.error) {
+        console.log(resp.data);
+    } else {
+        console.log(resp.error_message);
+    }
+}
+```
+
+### Debugger Mode
+
+Developers have the option to enable a debugger mode that provides response times, the URLs of called endpoints, and the HTTP statuses of those endpoints. This feature helps users identify which endpoints may have encountered failures. The default will be `debug = false` if no input is provided.
+
+```ts
+import { CovalentClient, CovalentClientSettings } from "@covalenthq/client-sdk";
+
+const settings: CovalentClientSettings = {
+    debug: true
+}
+
+const ApiServices = async () => {
+    const client = new CovalentClient("YOUR_API_KEY", settings); // Replace with your Covalent API key and add set debugger
+    const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
+    if (!resp.error) {
+        console.log(resp.data);
+    } else {
+        console.log(resp.error_message);
+    }
+}
+```
+
+![example result image](https://github.com/covalenthq/covalent-api-sdk-ts/assets/58843979/a4f6b024-2663-4820-9ac1-204c668da399)
+
 ### Retry Mechanism
 
 Each endpoint is equipped with an exponential backoff algorithm that exponentially extends the wait time between retries, making up to a `maximum of 5` retry attempts only.
 
 ### Error Handling
-The paginated endpoints will throw an error message in this format: `An error occurred {error_code}: {error_message}`, when an error occurs. The developer would need to make sure to catch those errors if any. This endpoint does not follow our default response format unlike our other endpoints, shown below.
+The paginated endpoints will throw an error message in this format: `An error occurred {error_code}: {error_message}`, when an error occurs. The developer would need to make sure to `catch` those errors if any. This endpoint does not follow our default response format unlike our other endpoints, shown below.
 ```ts
 ❴ 
     "data": ...,

package/dist/cjs/index.d.ts

@@ -0,0 +1,9 @@
+export { CovalentClient, Client, Chain, Quote, Chains, Quotes, CovalentClientSettings } from "./services/CovalentClient";
+export * from "./util/types/BalanceServiceTypes";
+export * from "./util/types/BaseServiceTypes";
+export * from "./util/types/NftServiceTypes";
+export * from "./util/types/PricingServiceTypes";
+export * from "./util/types/SecurityServiceTypes";
+export * from "./util/types/XykServiceTypes";
+export * from "./util/types/GenericTypes";
+export * from "./util/types/TransactionServiceTypes";