@covalenthq/client-sdk 2.1.1 → 2.2.0

package/dist/cjs/src/GoldRushClient.d.ts

@@ -1,3 +1,4 @@
+import { AllChainsService } from "./services/AllChainsService";
 import { BalanceService } from "./services/BalanceService";
 import { BaseService } from "./services/BaseService";
 import { NftService } from "./services/NftService";
@@ -10,11 +11,12 @@ import { type GoldRushClientSettings } from "./utils/types/Generic.types";
  */
 export declare class GoldRushClient {
     private readonly userAgent;
-    SecurityService: SecurityService;
+    AllChainsService: AllChainsService;
     BalanceService: BalanceService;
     BaseService: BaseService;
     NftService: NftService;
     PricingService: PricingService;
+    SecurityService: SecurityService;
     TransactionService: TransactionService;
     constructor(apiKey: string, settings?: GoldRushClientSettings);
 }

package/dist/cjs/src/services/AllChainsService.d.ts

@@ -0,0 +1,26 @@
+import { type Execution } from "../utils/functions/execution";
+import { type GetMultiChainAndMultiAddressTransactionsParamOtps, type MultiChainMultiAddressTransactionsResponse } from "../utils/types/AllChainService.types";
+import { type GoldRushResponse } from "../utils/types/Generic.types";
+/**
+ * Cross Chain API
+ *
+ */
+export declare class AllChainsService {
+    private execution;
+    constructor(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".
+     *
+     */
+    getMultiChainAndMultiAddressTransactions(queryParamOpts?: GetMultiChainAndMultiAddressTransactionsParamOtps): Promise<GoldRushResponse<MultiChainMultiAddressTransactionsResponse>>;
+}

package/dist/cjs/src/services/TransactionService.d.ts

@@ -61,7 +61,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransactionsForBlock(chainName: Chain, blockHeight: number | string, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
+    getTransactionsForBlock(chainName: Chain, blockHeight: number | string | "latest", queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
     /**
      *
      * Commonly used to 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/src/utils/functions/endpointGenerator.d.ts

@@ -1,4 +1,4 @@
 export declare const endpointGenerator: (extension?: string, params?: {
     key: string;
-    value: boolean | null | string | number | undefined;
+    value: boolean | null | string | string[] | number | undefined;
 }[]) => URL;

package/dist/cjs/src/utils/functions/timestamp-parser.d.ts

@@ -0,0 +1 @@
+export declare const timestampParser: (timestamp: string | Date, type: "descriptive" | "DD MMM YY" | "relative" | "YYYY-MM-DD") => string;

package/dist/cjs/src/utils/types/AllChainService.types.d.ts

@@ -0,0 +1,32 @@
+import { type Chain, type Nullable, type Quote } from "./Generic.types";
+import { type Transaction } from "./TransactionService.types";
+export type MultiChainMultiAddressTransactionsResponse = Nullable<{
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The the pagination cursor to get the previous page of results */
+    cursor_before: string;
+    /** * The the pagination cursor to get the next page of results */
+    cursor_after: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote | "ETH" | "BTC";
+    /** * List of response items. */
+    items: Transaction[];
+}>;
+export type GetMultiChainAndMultiAddressTransactionsParamOtps = Nullable<{
+    /** * An array of the chain names or IDs to retrieve transactions from. Defaults to all foundational chains. */
+    chains?: Chain[];
+    /** * An array of addresses for which transactions are fetched. Does not support name resolution. */
+    addresses?: string[];
+    /** * Number of transactions to return per page, up to the default max of 100 items. */
+    limit?: number;
+    /** * Pagination cursor pointing to fetch transactions before a certain point. */
+    before?: string;
+    /** * Pagination cursor pointing to fetch transactions after a certain point. */
+    after?: string;
+    /** * Whether to include raw logs in the response. */
+    withLogs?: boolean;
+    /** * Whether to include decoded logs in the response. */
+    withDecodedLogs?: boolean;
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, "BTC" and "ETH". */
+    quoteCurrency?: Quote | "BTC" | "ETH";
+}>;

package/dist/cjs/src/utils/types/BaseService.types.d.ts

@@ -181,6 +181,8 @@ export type ChainItem = Nullable<{
     is_appchain: boolean;
     /** * The ChainItem the appchain is a part of. */
     appchain_of: ChainItem;
+    /** * A classification of the chain */
+    priority_label: "Foundational" | "Frontier" | "Community";
 }>;
 export type ColorTheme = Nullable<{
     /** * The red color code. */

package/dist/cjs/src/utils/types/Generic.types.d.ts

@@ -381,6 +381,14 @@ export interface NftExternalData {
     animation_url: string;
     external_url: string;
     attributes: NftCollectionAttribute[];
+    thumbnails: NFTThumbnails;
+}
+export interface NFTThumbnails {
+    image256: string;
+    image512: string;
+    image1024: string;
+    image_opengraph_url: string;
+    thumbhash: string;
 }
 export interface DecodedItem {
     name: string;

package/dist/cjs/src/utils/types/PricingService.types.d.ts

@@ -1,4 +1,4 @@
-import { type ContractMetadata, type LogoUrls, type Nullable } from "./Generic.types";
+import { type ContractMetadata, type LogoUrls, type Nullable, type Quote } from "./Generic.types";
 export type TokenPricesResponse = Nullable<{
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     contract_decimals: number;
@@ -12,9 +12,10 @@ export type TokenPricesResponse = Nullable<{
     supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     update_at: Date;
     /** * The requested quote currency eg: `USD`. */
-    quote_currency: string;
+    quote_currency: Quote;
     /** * The contract logo URLs. */
     logo_urls: LogoUrls;
     /** * List of response items. */

package/dist/cjs/src/utils/types/TransactionService.types.d.ts

@@ -40,6 +40,7 @@ export type Transaction = Nullable<{
     pretty_value_quote: string;
     /** * The requested chain native gas token metadata. */
     gas_metadata: ContractMetadata;
+    /** * The gas offered for this tx. */
     gas_offered: number;
     /** * The gas spent for this tx. */
     gas_spent: number;

package/dist/esm/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/esm/index.js

@@ -1,4 +1,4 @@
-var version = "2.1.1";
+var version = "2.2.0";
 
 const bigIntParser = (val) => {
     if (val === null || val === undefined) {
@@ -25,6 +25,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;
@@ -176,8 +263,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,
@@ -2516,6 +2603,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);
@@ -3620,6 +3708,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();
+        }
+    }
+};
+
 var ChainName;
 (function (ChainName) {
     ChainName["ETH_MAINNET"] = "eth-mainnet";
@@ -3955,5 +4123,5 @@ var ChainID;
     ChainID[ChainID["COVALENT_INTERNAL_NETWORK_V1"] = 1131378225] = "COVALENT_INTERNAL_NETWORK_V1";
 })(ChainID || (ChainID = {}));
 
-export { ChainID, ChainName, GoldRushClient, bigIntParser, calculatePrettyBalance, isValidApiKey, prettifyCurrency };
+export { ChainID, ChainName, GoldRushClient, bigIntParser, calculatePrettyBalance, isValidApiKey, prettifyCurrency, timestampParser };
 //# sourceMappingURL=index.js.map