@covalenthq/client-sdk 2.1.1 → 2.2.0

package/README.md

@@ -208,6 +208,14 @@ if (resp.data !== null) {
 
    You can explore more examples [here](./test/unit/is-valid-api-key.test.ts)
 
+5. **timestampParser**: Convert ISO timestamps to various human-readable formats
+
+   ```ts
+   timestampParser("2024-10-16T12:39:23.000Z", "descriptive"); // "October 16 2024 at 18:09:23"
+   ```
+
+   You can explore more examples [here](./test/unit/timestamp-parser.test.ts)
+
 ### 8. Standardized (Error) Responses
 
 All the responses are of the same standardized format
@@ -227,7 +235,15 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-    1. <strong>Security Service</strong>: Access to the token approvals API endpoints
+   1. <strong>All Chains Service</strong>: Access to the data across multiple chains and addresses.
+  </summary>
+
+- `getMultiChainAndMultiAddressTransactions()`: Fetch and render the transactions across multiple chains and addresses
+</details>
+
+<details>
+  <summary>
+    2. <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.
@@ -236,7 +252,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-    2. <strong>Balance Service</strong>: Access to the balances endpoints
+    3. <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.
@@ -251,7 +267,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-    3. <strong>Balance Service</strong>: Access to the address activity, log events, chain status, and block retrieval endpoints
+    4. <strong>Base 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.
@@ -271,7 +287,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-    4. <strong>NFT Service</strong>: Access to the NFT endpoints
+    5. <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)
@@ -290,7 +306,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-    5. <strong>Pricing Service</strong>: Access to the historical token prices endpoint
+    6. <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.
@@ -298,7 +314,7 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 <details>
   <summary>
-   6. <strong>Transaction Service</strong>: Access to the transactions endpoints
+   7. <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)

package/dist/cjs/index.d.ts

@@ -3,6 +3,7 @@ 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 { timestampParser } from "./src/utils/functions/timestamp-parser";
 export * from "./src/utils/types/BalanceService.types";
 export * from "./src/utils/types/BaseService.types";
 export * from "./src/utils/types/Generic.types";

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "2.1.1";
+var version = "2.2.0";
 
 const bigIntParser = (val) => {
     if (val === null || val === undefined) {
@@ -27,6 +27,93 @@ const endpointGenerator = (extension = "", params = []) => {
     return new URL(`${baseUrl}/${extension}?${urlParams}`);
 };
 
+/**
+ * Cross Chain API
+ *
+ */
+class AllChainsService {
+    constructor(execution) {
+        this.execution = execution;
+    }
+    /**
+     *
+     * Commonly used to get transactions cross chains and addresses.
+     *
+     * @param {Chain[]} chains - An array of the chain names or IDs to retrieve transactions from. Defaults to all foundational chains.
+     * @param {string[]} addresses - An array of addresses for which transactions are fetched. Does not support name resolution.
+     * @param {number} limit - Number of transactions to return per page, up to the default max of 100 items.
+     * @param {string} before - Pagination cursor pointing to fetch transactions before a certain point.
+     * @param {string} after - Pagination cursor pointing to fetch transactions after a certain point.
+     * @param {boolean} withLogs - Whether to include raw logs in the response.
+     * @param {boolean} withDecodedLogs - Whether to include decoded logs in the response.
+     * @param {Quote | "BTC" | "ETH"} quoteCurrency - The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, "BTC" and "ETH".
+     *
+     */
+    async getMultiChainAndMultiAddressTransactions(queryParamOpts) {
+        const endpoint = endpointGenerator(`allchains/transactions`, [
+            {
+                key: "chains",
+                value: queryParamOpts?.chains,
+            },
+            {
+                key: "addresses",
+                value: queryParamOpts?.addresses,
+            },
+            {
+                key: "limit",
+                value: queryParamOpts?.limit,
+            },
+            {
+                key: "before",
+                value: queryParamOpts?.before,
+            },
+            {
+                key: "after",
+                value: queryParamOpts?.after,
+            },
+            {
+                key: "with-logs",
+                value: queryParamOpts?.withLogs,
+            },
+            {
+                key: "with-decoded-logs",
+                value: queryParamOpts?.withDecodedLogs,
+            },
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quoteCurrency,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((txItem) => ({
+                        ...txItem,
+                        value: bigIntParser(txItem.value),
+                        fees_paid: bigIntParser(txItem.fees_paid),
+                        block_signed_at: txItem.block_signed_at
+                            ? new Date(txItem.block_signed_at)
+                            : null,
+                        log_events: txItem.log_events
+                            ? txItem.log_events.map((logItem) => ({
+                                ...logItem,
+                                block_signed_at: logItem.block_signed_at
+                                    ? new Date(logItem.block_signed_at)
+                                    : null,
+                            }))
+                            : null,
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
+}
+
 async function* paginateEndpoint(endpoint, execution, parseData, implementation) {
     let _endpoint = new URL(endpoint);
     let hasMore = true;
@@ -178,8 +265,8 @@ class BalanceService {
                         ...portfolioItem,
                         holdings: portfolioItem.holdings?.map((holdingItem) => ({
                             ...holdingItem,
-                            timestamp: holdingItem.timestamp && data.data?.updated_at
-                                ? new Date(data.data.updated_at)
+                            timestamp: holdingItem.timestamp
+                                ? new Date(holdingItem.timestamp)
                                 : null,
                             close: {
                                 ...holdingItem.close,
@@ -2518,6 +2605,7 @@ class GoldRushClient {
                 ? `${settings.source} (${this.userAgent})`
                 : this.userAgent,
         });
+        this.AllChainsService = new AllChainsService(execution);
         this.BalanceService = new BalanceService(execution);
         this.BaseService = new BaseService(execution);
         this.NftService = new NftService(execution);
@@ -3622,6 +3710,86 @@ const prettifyCurrency = (value, decimals = 2, currency = "USD", ignoreSmallValu
     return minus + formattedValue + currencySuffix;
 };
 
+const months = [
+    "January",
+    "February",
+    "March",
+    "April",
+    "May",
+    "June",
+    "July",
+    "August",
+    "September",
+    "October",
+    "November",
+    "December",
+];
+const timestampParser = (timestamp, type) => {
+    const _unix = new Date(timestamp);
+    switch (type) {
+        case "descriptive": {
+            const _minutes = _unix.getMinutes();
+            const _hours = _unix.getHours();
+            const _seconds = _unix.getSeconds();
+            const _parsedSeconds = `${_seconds <= 9 ? "0" : ""}${_seconds}`;
+            const _parsedMinutes = `${_minutes <= 9 ? "0" : ""}${_minutes}`;
+            const _parsedHours = `${_hours <= 9 ? "0" : ""}${_hours}`;
+            return `${months[_unix.getMonth()]} ${_unix.getDate()} ${_unix.getFullYear()} at ${_parsedHours}:${_parsedMinutes}:${_parsedSeconds}`;
+        }
+        case "DD MMM YY": {
+            const day = _unix.getDate().toString().padStart(2, "0");
+            const month = months[_unix.getMonth()].substring(0, 3);
+            const year = _unix.getFullYear();
+            return `${day} ${month} ${year}`;
+        }
+        case "relative": {
+            const currentTime = new Date();
+            const unixTime = new Date(_unix);
+            const timeDifference = currentTime.getTime() - unixTime.getTime();
+            const secondsDifference = Math.floor(timeDifference / 1000);
+            const minutesDifference = Math.floor(secondsDifference / 60);
+            const hoursDifference = Math.floor(minutesDifference / 60);
+            const daysDifference = Math.floor(hoursDifference / 24);
+            const monthsDifference = Math.floor(daysDifference / 30);
+            const yearsDifference = Math.floor(daysDifference / 365);
+            if (yearsDifference > 0) {
+                return `${yearsDifference} year${yearsDifference > 1 ? "s" : ""} ago`;
+            }
+            else if (monthsDifference > 0) {
+                return `${monthsDifference} month${monthsDifference > 1 ? "s" : ""} ago`;
+            }
+            else if (daysDifference > 0) {
+                return `${daysDifference} day${daysDifference > 1 ? "s" : ""} ago`;
+            }
+            else if (hoursDifference > 0) {
+                return `${hoursDifference} hour${hoursDifference > 1 ? "s" : ""} ago`;
+            }
+            else if (minutesDifference > 0) {
+                return `${minutesDifference} minute${minutesDifference > 1 ? "s" : ""} ago`;
+            }
+            else if (secondsDifference > 0) {
+                return `${secondsDifference} second${secondsDifference > 1 ? "s" : ""} ago`;
+            }
+            else {
+                return `just now`;
+            }
+        }
+        case "YYYY-MM-DD": {
+            const offsetMinutes = _unix.getTimezoneOffset();
+            const offsetMilliseconds = offsetMinutes * 60 * 1000;
+            const utcTime = _unix.getTime() + offsetMilliseconds;
+            const _utc_unix = new Date(utcTime);
+            const year = _utc_unix.getFullYear();
+            const month = String(_utc_unix.getMonth() + 1).padStart(2, "0");
+            const day = String(_utc_unix.getDate()).padStart(2, "0");
+            return `${year}-${month}-${day}`;
+        }
+        default: {
+            return _unix.toISOString();
+        }
+    }
+};
+
 exports.ChainName = void 0;
 (function (ChainName) {
     ChainName["ETH_MAINNET"] = "eth-mainnet";
@@ -3962,4 +4130,5 @@ exports.bigIntParser = bigIntParser;
 exports.calculatePrettyBalance = calculatePrettyBalance;
 exports.isValidApiKey = isValidApiKey;
 exports.prettifyCurrency = prettifyCurrency;
+exports.timestampParser = timestampParser;
 //# sourceMappingURL=index.js.map