@covalenthq/client-sdk 1.0.2 → 2.0.1

package/README.md

@@ -1,3 +1,11 @@
+<div align="center">
+  <a href="https://goldrush.dev/products/goldrush/"  target="_blank" rel="noopener noreferrer">
+    <img alt="GoldRush Kit Logo" src="./assets/ts-sdk-banner.png" style="max-width: 100%;"/>
+  </a>
+</div>
+
+<br/>
+
 <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">
@@ -5,128 +13,231 @@
   <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>
-  <a>
-   <img src="https://img.shields.io/badge/node-20.x-green">
-  <a>
+  <img src="https://img.shields.io/github/license/covalenthq/client-sdk" alt="Apache-2.0">
 </p>
 
+# GoldRush SDK for TypeScript
 
-# Covalent SDK for TypeScript
+The GoldRush SDK is the fastest way to integrate the GoldRush API for working with blockchain data. The SDK works with all [supported chains](https://www.covalenthq.com/docs/networks/) including Mainnets and Testnets.
 
-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. 
+> Use with [`NodeJS v18`](https://nodejs.org/en) or above for best results.
 
-**Note - Require `Node v18` and above for best results.**
+> The GoldRush API is required. You can register for a free key on [GoldRush's website](https://goldrush.dev/platform/apikey)
 
-> **Sign up for an API Key**
->
-> To get your own Covalent API key, **[sign up here](https://www.covalenthq.com/platform/auth/register/)** and create your key from the *API Keys* tab.
+## Using the SDK
 
-## Getting started
+> You can also follow the [video tutorial](https://www.youtube.com/watch?v=XSpPJP2w62E&ab_channel=Covalent)
 
-```
-npm install @covalenthq/client-sdk
-```
-or
-```
-yarn add @covalenthq/client-sdk
-```
+1. Install the dependencies
 
-## How to use the Covalent SDK
+   ```bash
+   npm install @covalenthq/client-sdk
+   ```
 
-**Video Tutorial**: https://www.youtube.com/watch?v=XSpPJP2w62E&ab_channel=Covalent
+2. Create a client using the `GoldRushClient`
 
-After installing, you can import and use the SDK with:
+   ```ts
+   import { GoldRushClient, Chains } from "@covalenthq/client-sdk";
 
-```ts
-import { CovalentClient, Chains } from "@covalenthq/client-sdk";
+   const client = new GoldRushClient("<YOUR_API_KEY>");
 
-const ApiServices = async () => {
-    const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
+   const ApiServices = async () => {
+     try {
+       const balanceResp =
+         await client.BalanceService.getTokenBalancesForWalletAddress(
+           "eth-mainnet",
+           "demo.eth"
+         );
 
-    const balanceResp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
-    if (!balanceResp.error) {
-        console.log(balanceResp.data);
-    } else {
-        console.log(balanceResp.error_message);
-    }
-}
-```
-> **Name Resolution**
->
-> The Covalent SDK natively supports ENS domains (e.g. `demo.eth`), Lens Handles (e.g. `@demo.lens`) and Unstoppable Domains (e.g. `demo.x`) which automatically resolve to the underlying user address (e.g. `0xfC43f5F9dd45258b3AFf31Bdbe6561D97e8B71de`)
-
-**ℹ️ BREAKING CHANGE**
-> If you have been importing with `Client`: 
-```ts 
-import { Client } from "@covalenthq/client-sdk";
-```
->
-> Please change to `CovalentClient`:
-```ts
-import { CovalentClient } from "@covalenthq/client-sdk";
-```
+       if (balanceResp.error) {
+         throw balanceResp;
+       }
+
+       console.log(balanceResp.data);
+     } catch (error) {
+       console.error(error);
+     }
+   };
+   ```
+
+   The `GoldRushClient` can be configured with a second object argument, `settings`. The settings offered are
 
-### How to apply supported query parameters to endpoints
-Query parameters are handled using `typed objects`. To pass in query parameters, developers can define an object that follows the type listed in the provided `tsdocs` under `src/util/types/`. Additionally, developers can reference the `tsdocs` for autocomplete suggestions for the supported parameters. These supported parameters can be passed in any order. 
+   1. **debug**: A boolean that enables server logs of the API calls, enhanced with the request URL, response time and code, and other settings. It is set as `false` by default.
+   2. **threadCount**: A number that sets the number of concurrent requests allowed. It is set as `2` by default.
+   3. **enableRetry**: A boolean that enables retrying the API endpoint in case of a `429 - rate limit` error. It is set as `true` by default.
+   4. **maxRetries**: A number that sets the number of retries to be made in case of `429 - rate limit` error. To be in effect, it requires `enableRetry` to be enabled. It is set as `2` by default.
+   5. **retryDelay**: A number that sets the delay in `ms` for retrying the API endpoint in case of `429 - rate limit` error. To be in effect, it requires `enableRetry` to be enabled. It is set as `2` by default.
+   6. **source**: A string that defines the `source` of the request of better analytics.
+
+## Features
+
+### 1. Name Resolution
+
+The GoldRush SDK natively resolves the underlying wallet address for the following
+
+1. ENS Domains (e.g. `demo.eth`)
+2. Lens Handles (e.g. `@demo.lens`)
+3. Unstoppable Domains (e.g. `demo.x`)
+4. RNS Domains (e.g. `demo.ron`)
+
+### 2. Query Parameters
+
+All the API call arguments have an option to pass `typed objects` as Query parameters.
 
 For example, the following sets the `quoteCurrency` query parameter to `CAD` and the parameter `nft` to `true` for fetching all the token balances, including NFTs, for a wallet address:
+
 ```ts
-const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS", {quoteCurrency: "CAD", nft: true});
+const resp = await client.BalanceService.getTokenBalancesForWalletAddress(
+  "eth-mainnet",
+  "demo.eth",
+  {
+    quoteCurrency: "CAD",
+    nft: true,
+  }
+);
 ```
-### Assign Types
-You can import types for each endpoint, found here `src/util/types/`. Here is an example:
+
+### 3. Exported Types
+
+All the `interface`s used, for arguments, query parameters and responses are also exported from the package which can be used for custom usage.
+
+For example, explicitly typecasting the response
+
 ```ts
-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[]`
+import {
+  GoldRushClient,
+  BalancesResponse,
+  BalanceItem,
+} from "@covalenthq/client-sdk";
+
+const resp = await client.BalanceService.getTokenBalancesForWalletAddress(
+  "eth-mainnet",
+  "demo.eth",
+  {
+    quoteCurrency: "CAD",
+    nft: true,
+  }
+);
+
+const data: BalancesResponse = resp.data;
+const items: BalanceItem[] = resp.data.items;
 ```
 
-### Different ways to input chains in chain fields
-We offer users three options for specifying a chain in the designated field:
+### 4. Multiple Chain input formats
+
+The SDK supports the following formats for the chain input:
+
+1. Chain Name (e.g. `eth-mainnet`)
+2. Chain ID (e.g. `1`)
+3. Chain Name Enum (e.g. `ChainName.ETH_MAINNET`)
+4. Chain ID Enum (e.g. `ChainID.ETH_MAINNET`)
 
-1. String literal - directly inputting the chain name, such as `eth-mainnet`, with auto-completion functionality as the user types.
-2. Chain Enum - utilizing the Chain enum `Chains.ETH_MAINNET`, which provides auto-suggestions as the user types in the chain field.
-3. Chain Id - entering the ChainId as a numerical value.
+### 5. Additional Non-Paginated methods
+
+For paginated responses, the GoldRush API can at max support 100 items per page. However, the Covalent SDK leverages generators to _seamlessly fetch all items without the user having to deal with pagination_.
+
+For example, the following fetches ALL transactions for `demo.eth` on Ethereum:
 
-Example with string literal
 ```ts
-// Example call with string literal  ("eth-mainnet")
-const respWithStringLiteral = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
+import { GoldRushClient } from "@covalenthq/client-sdk";
+
+const ApiServices = async () => {
+  const client = new GoldRushClient("<YOUR_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);
+  }
+};
 ```
-Example with Chain Enum
+
+### 6. Executable pagination functions
+
+Paginated methods 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
-// Example call with enum  (Chains.ETH_MAINNET)
-const respWithEnum = await client.BalanceService.getTokenBalancesForWalletAddress(Chains.ETH_MAINNET, "WALLET_ADDRESS");
+import { GoldRushClient } from "@covalenthq/client-sdk";
+
+const client = new GoldRushClient("<YOUR_API_KEY>");
+const resp = await client.TransactionService.getAllTransactionsForAddressByPage(
+  "eth-mainnet",
+  "demo.eth"
+); // assuming resp.data.current_page is 10
+if (resp.data !== null) {
+  const prevPage = await resp.data.prev(); // will retrieve page 9
+  console.log(prevPage.data);
+}
 ```
-Example with Chain Id
+
+### 7. Utility Functions
+
+1. **bigIntParser**: Formats input as a `bigint` value. For example
+
+   ```ts
+   bigIntParser("-123"); // -123n
+   ```
+
+   You can explore more examples [here](./test/unit/bigint-parser.test.ts)
+
+2. **calculatePrettyBalance**: Formats large and raw numbers and bigints to human friendly format. For example
+
+   ```ts
+   calculatePrettyBalance(1.5, 3, true, 4); // "0.0015"
+   ```
+
+   You can explore more examples [here](./test/unit/calculate-pretty-balance.test.ts)
+
+3. **isValidApiKey**: Checks for the input as a valid GoldRush API Key. For example
+
+   ```ts
+   isValidApiKey(cqt_wF123); // false
+   ```
+
+   You can explore more examples [here](./test/unit/is-valid-api-key.test.ts)
+
+4. **prettifyCurrency**: Formats large and raw numbers and bigints to human friendly currency format. For example
+
+   ```ts
+   prettifyCurrency(89.0, 2, "CAD"); // "CA$89.00"
+   ```
+
+   You can explore more examples [here](./test/unit/is-valid-api-key.test.ts)
+
+### 8. Standardized (Error) Responses
+
+All the responses are of the same standardized format
+
 ```ts
-// Example call with chain Id  (1)
-const respWithChainId = await client.BalanceService.getTokenBalancesForWalletAddress(1, "WALLET_ADDRESS");
+❴
+    "data": <object>,
+    "error": <boolean>,
+    "error_message": <string>,
+    "error_code": <number>
+❵
 ```
 
 ## Supported Endpoints
 
-The Covalent SDK provides comprehensive support for all Class A, Class B, and Pricing endpoints that are grouped under the following *Service* namespaces:
+The Covalent SDK provides comprehensive support for all Class A, Class B, and Pricing endpoints that are grouped under the following _Service_ namespaces:
 
-- [`SecurityService`](#securityservice): Access to the token approvals endpoints
-- [`BalanceService`](#balanceservice): Access to the balances endpoints
-- [`BaseService`](#baseservice): Access to the address activity, log events, chain status, and block retrieval endpoints
-- [`NftService`](#nftservice): Access to the  NFT endpoints
-- [`PricingService`](#pricingservice): Access to the historical token prices endpoint
-- [`TransactionService`](#transactionservice): Access to the transactions endpoints
-- [`XykService`](#xykservice): Access to the XY=K suite of endpoints
-
-### SecurityService
-
-The `SecurityService` class refers to the [token approvals API endpoints](https://www.covalenthq.com/docs/api/security/get-token-approvals-for-address/):
+<details>
+  <summary>
+    1. <strong>Security Service</strong>: Access to the token approvals API endpoints
+  </summary>
 
 - `getApprovals()`: Get a list of approvals across all ERC20 token contracts categorized by spenders for a wallet’s assets.
 - `getNftApprovals()`: Get a list of approvals across all NFT contracts categorized by spenders for a wallet’s assets.
+</details>
 
-### BalanceService
-
-The `BalanceService` class refers to the [balances API endpoints](https://www.covalenthq.com/docs/api/balances/get-token-balances-for-address/):
+<details>
+  <summary>
+    2. <strong>Balance Service</strong>: Access to the balances endpoints
+  </summary>
 
 - `getTokenBalancesForWalletAddress()`: Fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.
 - `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.
@@ -136,10 +247,12 @@ The `BalanceService` class refers to the [balances API endpoints](https://www.co
 - `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. (Paginated)
 - `getTokenHoldersV2ForTokenAddressByPage()`: 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. (Nonpaginated)
 - `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.
+</details>
 
-### BaseService
-
-The `BaseService` class refers to the [address activity, log events, chain status and block retrieval API endpoints](https://www.covalenthq.com/docs/api/base/get-address-activity/):
+<details>
+  <summary>
+    3. <strong>Balance Service</strong>: Access to the address activity, log events, chain status, and block retrieval endpoints
+  </summary>
 
 - `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.
@@ -154,10 +267,12 @@ The `BaseService` class refers to the [address activity, log events, chain statu
 - `getAllChainStatus()`: Used to build internal status dashboards of all supported chains.
 - `getAddressActivity()`: Locate chains where an address is active on with a single API call.
 - `getGasPrices()`: Get real-time gas estimates for different transaction speeds on a specific network, enabling users to optimize transaction costs and confirmation times.
+</details>
 
-### NftService
-
-The `NftService` class refers to the [NFT API endpoints](https://www.covalenthq.com/docs/api/nft/get-nfts-for-address/):
+<details>
+  <summary>
+    4. <strong>NFT Service</strong>: Access to the NFT endpoints
+  </summary>
 
 - `getChainCollections()`: Used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files. (Paginated)
 - `getChainCollectionsByPage()`: Used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files. (Nonpaginated)
@@ -171,19 +286,20 @@ The `NftService` class refers to the [NFT API endpoints](https://www.covalenthq.
 - `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.
-- `getNftMarketSaleCount()`: Used to build a time-series chart of the sales count of an NFT collection.
-- `getNftMarketVolume()`: Used to build a time-series chart of the transaction volume of an NFT collection.
-- `getNftMarketFloorPrice()`: Used to render a price floor chart for an NFT collection.
-
-### PricingService
+</details>
 
-The `PricingService` class refers to the [historical token prices API endpoint](https://www.covalenthq.com/docs/api/pricing/get-historical-token-prices/):
+<details>
+  <summary>
+    5. <strong>Pricing Service</strong>: Access to the historical token prices endpoint
+  </summary>
 
 - `getTokenPrices()`: Get historic prices of a token between date ranges. Supports native tokens.
+</details>
 
-### TransactionService
-
-The `TransactionService` class refers to the [transactions API endpoints](https://www.covalenthq.com/docs/api/transactions/get-a-transaction/):
+<details>
+  <summary>
+   6. <strong>Transaction Service</strong>: Access to the transactions endpoints
+  </summary>
 
 - `getAllTransactionsForAddress()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Paginated)
 - `getAllTransactionsForAddressByPage()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Nonpaginated)
@@ -194,192 +310,17 @@ The `TransactionService` class refers to the [transactions API endpoints](https:
 - `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.
+</details>
 
+## Contributing
 
-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";
-
-const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
-const resp = await client.TransactionService.getAllTransactionsForAddressByPage("eth-mainnet", "WALLET_ADDRESS");
-// assuming resp.data.current_page is 10
-if (resp.data !== null) {
-    const prevPage = await resp.data.prev() // will retrieve page 9
-    console.log(prevPage.data)
-}
-```
-
-### XykService
-
-The `XykService` refers to the [Xy=k API endpoints](https://www.covalenthq.com/docs/api/xyk/get-xyk-pools/):
-
-- `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()`: 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.
-
-## Additional Helper Functions
-### calculatePrettyBalance
-The `calculatePrettyBalance` function is designed to take up to 4 inputs: the `balance` field obtained from the `tokenBalance` endpoint and the `contract_decimals`. The function also includes two optional fields, `roundOff` and `precision`, to allow developers to round the unscaled balance to a certain decimal precision. The primary purpose of this function is to convert the scaled token balance (the balance parameter) into its unscaled, human-readable form. The scaled balance needs to be divided by 10^(contractDecimals) to remove the scaling factor.
-
-```ts
-import { CovalentClient, calculatePrettyBalance } from "@covalenthq/client-sdk";
-
-const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
-const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
-const prettyBalance = calculatePrettyBalance(resp.data.items[0].balance, resp.data.items[0].contract_decimals);
-```
-### prettifyCurrency
-The `prettifyCurrency` function refines the presentation of a monetary value, accepting a numerical amount and a fiat currency code as parameters (with USD as the default currency). It simplifies currency formatting for developers, ensuring visually polished representations of financial information in user interfaces for an enhanced user experience.
-
-```ts
-import { CovalentClient, prettifyCurrency } from "@covalenthq/client-sdk";
-
-const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
-const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
-const prettyCurrency = prettifyCurrency(resp.data.items[0].quote_rate);
-```
-
-## Built-in SDK Features
-### Explaining Pagination Mechanism Within the SDK
-
-The following endpoints support pagination:
-
-- `getErc20TransfersForWalletAddress()`
-- `getTokenHoldersV2ForTokenAddress()`
-- `getBlockHeights()`
-- `getLogEventsByAddress()`
-- `getLogEventsByTopicHash()`
-- `getChainCollections()`
-- `getTokenIdsForContractWithMetadata()`
-- `getAllTransactionsForAddress()`
+Contributions, issues and feature requests are welcome!
+Feel free to check [issues](https://github.com/covalenthq/covalent-api-sdk-ts/issues) page.
 
-Using the Covalent API, paginated supported endpoints return only 100 items, such as transactions or log events, per page. However, the Covalent SDK leverages generators to *seamlessly fetch all items without the user having to deal with pagination*. 
+## Show your support
 
-For example, the following fetches ALL transactions for `demo.eth` on Ethereum:
-```ts
-import { CovalentClient } from "@covalenthq/client-sdk";
-
-const ApiServices = async () => {
-    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);
-    }
-}
-```
-
-### Concurrency Mechanism
-
-Developers have the flexibility to specify the desired number of concurrent API calls they wish to execute using the `threadCount` settings parameter, with a default value of `3`. For example:
-
-```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 is `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://www.datocms-assets.com/86369/1697154621-sdk-debugger-output.png)
-
-### Retry Mechanism
-
-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
-❴ 
-    "data": ...,
-    "error": false,
-    "error_message": null,
-    "error_code": null
-❵
-```
-
-### Error codes
-Covalent uses standard HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with Covalent's servers (these are rare).
-
-| Code      | Description |
-| ----------- | ----------- |
-| 200      | OK	Everything worked as expected.       |
-| 400   | Bad Request	The request could not be accepted, usually due to a missing required parameter.        |
-| 401   | Unauthorized	No valid API key was provided.        |
-| 404   | Not Found	The request path does not exist.        |
-| 429   | Too Many Requests	You are being rate-limited. Please see the rate limiting section for more information.        |
-| 500, 502, 503   | Server Errors	Something went wrong on Covalent's servers. These are rare.        |
-
-## Tests
-to run all tests, you need to input your api key first shown below
-```
-COVALENT_API_KEY=YOUR_KEY npm test
-```
-OR
-
-you can run individual tests for each service, for example
-```
-COVALENT_API_KEY=YOUR_KEY npm test -- security-service.test.ts
-```
+Give a ⭐️ if this project helped you!
 
-## Documentation
+## License
 
-The Covalent API SDK documentation is integrated within the source code through `tsdoc` comments. When utilizing an Integrated Development Environment (IDE), the SDK provides generated types and accompanying documentation for seamless reference and usage.
+This project is [Apache-2.0](./LICENSE) licensed.

package/dist/cjs/index.d.ts

@@ -1,20 +1,17 @@
-export { CovalentClient, Client, Chain, Quote, CovalentClientSettings, ChainID, Response } from "./services/CovalentClient";
-export { Response as PriceResponse } from "./services/PricingService";
-export * from "./services/BalanceService";
-export * from "./services/BaseService";
-export * from "./services/NftService";
-export * from "./services/PricingService";
-export * from "./services/SecurityService";
-export * from "./services/XykService";
-export * from "./services/TransactionService";
-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";
-export { calculatePrettyBalance } from "./util/CalculatePrettyBalance";
-export { prettifyCurrency } from "./util/prettifyCurrency";
-export { Chains } from "./util/Chains";
+export { 
+/**
+ * @deprecated Please use `GoldRushClient` going forward!
+ * `CovalentClient` will be removed after Aug 30, 2024.
+ */
+GoldRushClient as CovalentClient, GoldRushClient, } from "./src/GoldRushClient";
+export { bigIntParser } from "./src/utils/functions/bigIntParser";
+export { calculatePrettyBalance } from "./src/utils/functions/calculatePrettyBalance";
+export { isValidApiKey } from "./src/utils/functions/isValidApiKey";
+export { prettifyCurrency } from "./src/utils/functions/prettifyCurrency";
+export * from "./src/utils/types/BalanceService.types";
+export * from "./src/utils/types/BaseService.types";
+export * from "./src/utils/types/Generic.types";
+export * from "./src/utils/types/NftService.types";
+export * from "./src/utils/types/PricingService.types";
+export * from "./src/utils/types/SecurityService.types";
+export * from "./src/utils/types/TransactionService.types";