@covalenthq/client-sdk 2.1.2 → 2.2.1

package/dist/esm/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/esm/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/esm/src/services/BaseService.d.ts

@@ -32,26 +32,26 @@ export declare class BaseService {
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} startDate - The start date in YYYY-MM-DD format.
-     * @param {string} endDate - The end date in YYYY-MM-DD format.
+     * @param {string | "latest"} endDate - The end date in YYYY-MM-DD format. Also accepts "latest" for the latest block height
      * @param {GetBlockHeightsQueryParamOpts} queryParamOpts
      *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getBlockHeights(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): AsyncIterable<GoldRushResponse<BlockHeightsResponse>>;
+    getBlockHeights(chainName: Chain, startDate: string, endDate: string | "latest", queryParamOpts?: GetBlockHeightsQueryParamOpts): AsyncIterable<GoldRushResponse<BlockHeightsResponse>>;
     /**
      *
      * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} startDate - The start date in YYYY-MM-DD format.
-     * @param {string} endDate - The end date in YYYY-MM-DD format.
+     * @param {string | "latest"} endDate - The end date in YYYY-MM-DD format. Also accepts "latest" for the latest block height
      * @param {GetBlockHeightsQueryParamOpts} queryParamOpts
      *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getBlockHeightsByPage(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): Promise<GoldRushResponse<BlockHeightsResponse>>;
+    getBlockHeightsByPage(chainName: Chain, startDate: string, endDate: string | "latest", queryParamOpts?: GetBlockHeightsQueryParamOpts): Promise<GoldRushResponse<BlockHeightsResponse>>;
     /**
      *
      * Commonly used to get all the event logs of the latest block, or for a range of blocks. Includes sender contract metadata as well as decoded logs.

package/dist/esm/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/esm/src/utils/functions/timestamp-parser.d.ts

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

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

@@ -0,0 +1,38 @@
+import { type Chain, type ChainID, type ChainName, type Nullable, type Quote } from "./Generic.types";
+import { type Transaction } from "./TransactionService.types";
+export type MultiChainTransaction = Transaction & {
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+};
+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: MultiChainTransaction[];
+}>;
+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/esm/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/esm/src/utils/types/Generic.types.d.ts

@@ -1,7 +1,7 @@
 export declare enum ChainName {
     ETH_MAINNET = "eth-mainnet",
-    ETH_GOERLI = "eth-goerli",
     ETH_SEPOLIA = "eth-sepolia",
+    ETH_GOERLI = "eth-goerli",
     ETH_HOLESKY = "eth-holesky",
     MATIC_MAINNET = "matic-mainnet",
     MATIC_MUMBAI = "matic-mumbai",
@@ -33,6 +33,7 @@ export declare enum ChainName {
     CRONOS_MAINNET = "cronos-mainnet",
     CRONOS_TESTNET = "cronos-testnet",
     CRONOS_ZKEVM_TESTNET = "cronos-zkevm-testnet",
+    CRONOS_ZKEVM_MAINNET = "cronos-zkevm-mainnet",
     AURORA_MAINNET = "aurora-mainnet",
     AURORA_TESTNET = "aurora-testnet",
     EMERALD_PARATIME_MAINNET = "emerald-paratime-mainnet",
@@ -90,15 +91,15 @@ export declare enum ChainName {
     FLARENETWORKS_CANARY_TESTNET = "flarenetworks-canary-testnet",
     KCC_MAINNET = "kcc-mainnet",
     KCC_TESTNET = "kcc-testnet",
-    LINEA_MAINNET = "linea-mainnet",
     POLYGON_ZKEVM_MAINNET = "polygon-zkevm-mainnet",
-    LINEA_SEPOLIA_TESTNET = "linea-sepolia-testnet",
+    LINEA_MAINNET = "linea-mainnet",
     LINEA_GOERLI_TESTNET = "linea-goerli-testnet",
+    LINEA_SEPOLIA_TESTNET = "linea-sepolia-testnet",
     POLYGON_ZKEVM_TESTNET = "polygon-zkevm-testnet",
     POLYGON_AMOY_TESTNET = "polygon-amoy-testnet",
     MANTLE_MAINNET = "mantle-mainnet",
-    MANTLE_SEPOLIA_TESTNET = "mantle-sepolia-testnet",
     POLYGON_ZKEVM_CARDONA_TESTNET = "polygon-zkevm-cardona-testnet",
+    MANTLE_SEPOLIA_TESTNET = "mantle-sepolia-testnet",
     BASE_MAINNET = "base-mainnet",
     BASE_TESTNET = "base-testnet",
     BASE_SEPOLIA_TESTNET = "base-sepolia-testnet",
@@ -109,8 +110,8 @@ export declare enum ChainName {
     LUMOZ_STARK_SPORT = "lumoz-stark-sport",
     OASIS_SAPPHIRE_MAINNET = "oasis-sapphire-mainnet",
     OASIS_SAPPHIRE_TESTNET = "oasis-sapphire-testnet",
-    SYNDR_TESTNET = "syndr-testnet",
     XAI_MAINNET = "xai-mainnet",
+    SYNDR_TESTNET = "syndr-testnet",
     CELO_MAINNET = "celo-mainnet",
     X1_MAINNET = "x1-mainnet",
     CROSSFI_EVM_TESTNET = "crossfi-evm-testnet",
@@ -119,6 +120,7 @@ export declare enum ChainName {
     FRAXTAL_MAINNET = "fraxtal-mainnet",
     APECHAIN_TESTNET = "apechain-testnet",
     LISK_MAINNET = "lisk-mainnet",
+    BERACHAIN_TESTNET = "berachain-testnet",
     REDSTONE_MAINNET = "redstone-mainnet",
     SEI_MAINNET = "sei-mainnet",
     AVALANCHE_MELD_TESTNET = "avalanche-meld-testnet",
@@ -153,10 +155,10 @@ export declare enum ChainName {
     GNOSIS_TESTNET = "gnosis-testnet",
     TELOS_MAINNET = "telos-mainnet",
     TELOS_TESTNET = "telos-testnet",
-    TOMOCHAIN_MAINNET = "tomochain-mainnet",
-    TOMOCHAIN_TESTNET = "tomochain-testnet",
-    TAIKO_MAINNET = "taiko-mainnet",
+    VICTION_MAINNET = "viction-mainnet",
+    VICTION_TESTNET = "viction-testnet",
     TAIKO_HEKLA_TESTNET = "taiko-hekla-testnet",
+    TAIKO_MAINNET = "taiko-mainnet",
     MERLIN_MAINNET = "merlin-mainnet",
     MERLIN_TESTNET = "merlin-testnet",
     BLAST_MAINNET = "blast-mainnet",
@@ -166,8 +168,8 @@ export declare enum ChainName {
 }
 export declare enum ChainID {
     ETH_MAINNET = 1,
-    ETH_GOERLI = 5,
     ETH_SEPOLIA = 11155111,
+    ETH_GOERLI = 5,
     ETH_HOLESKY = 17000,
     MATIC_MAINNET = 137,
     MATIC_MUMBAI = 80001,
@@ -199,6 +201,7 @@ export declare enum ChainID {
     CRONOS_MAINNET = 25,
     CRONOS_TESTNET = 338,
     CRONOS_ZKEVM_TESTNET = 282,
+    CRONOS_ZKEVM_MAINNET = 388,
     AURORA_MAINNET = 1313161554,
     AURORA_TESTNET = 1313161555,
     EMERALD_PARATIME_MAINNET = 42262,
@@ -256,15 +259,15 @@ export declare enum ChainID {
     FLARENETWORKS_CANARY_TESTNET = 16,
     KCC_MAINNET = 321,
     KCC_TESTNET = 322,
-    LINEA_MAINNET = 59144,
     POLYGON_ZKEVM_MAINNET = 1101,
-    LINEA_SEPOLIA_TESTNET = 59141,
+    LINEA_MAINNET = 59144,
     LINEA_GOERLI_TESTNET = 59140,
+    LINEA_SEPOLIA_TESTNET = 59141,
     POLYGON_ZKEVM_TESTNET = 1422,
     POLYGON_AMOY_TESTNET = 80002,
     MANTLE_MAINNET = 5000,
-    MANTLE_SEPOLIA_TESTNET = 5003,
     POLYGON_ZKEVM_CARDONA_TESTNET = 2442,
+    MANTLE_SEPOLIA_TESTNET = 5003,
     BASE_MAINNET = 8453,
     BASE_TESTNET = 84531,
     BASE_SEPOLIA_TESTNET = 84532,
@@ -275,8 +278,8 @@ export declare enum ChainID {
     LUMOZ_STARK_SPORT = 12029,
     OASIS_SAPPHIRE_MAINNET = 23294,
     OASIS_SAPPHIRE_TESTNET = 23295,
-    SYNDR_TESTNET = 412346,
     XAI_MAINNET = 660279,
+    SYNDR_TESTNET = 412346,
     CELO_MAINNET = 42220,
     X1_MAINNET = 196,
     CROSSFI_EVM_TESTNET = 8545,
@@ -284,6 +287,7 @@ export declare enum ChainID {
     HORIZEN_GOBI_TESTNET = 1663,
     FRAXTAL_MAINNET = 252,
     APECHAIN_TESTNET = 1798,
+    BERACHAIN_TESTNET = 80084,
     LISK_MAINNET = 1135,
     REDSTONE_MAINNET = 690,
     SEI_MAINNET = 1329,
@@ -317,12 +321,12 @@ export declare enum ChainID {
     ROLLUX_TESTNET = 57000,
     GNOSIS_MAINNET = 100,
     GNOSIS_TESTNET = 10200,
+    VICTION_MAINNET = 88,
+    VICTION_TESTNET = 89,
     TELOS_MAINNET = 40,
     TELOS_TESTNET = 41,
-    TOMOCHAIN_MAINNET = 88,
-    TOMOCHAIN_TESTNET = 89,
-    TAIKO_MAINNET = 167000,
     TAIKO_HEKLA_TESTNET = 167009,
+    TAIKO_MAINNET = 167000,
     MERLIN_MAINNET = 4200,
     MERLIN_TESTNET = 686868,
     BLAST_MAINNET = 81457,
@@ -381,6 +385,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/esm/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/esm/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/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "@covalenthq/client-sdk",
-  "version": "2.1.2",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/covalenthq/covalent-api-sdk-ts.git"
-  },
-  "author": {
-    "name": "covalenthq",
-    "url": "https://covalenthq.com"
-  },
-  "bugs": {
-    "url": "https://github.com/covalenthq/covalent-api-sdk-ts/issues"
-  },
-  "homepage": "https://github.com/covalenthq/covalent-api-sdk-ts#readme",
-  "dependencies": {
-    "big.js": "^6.2.1"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.1",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@types/big.js": "^6.2.2",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20",
-    "@typescript-eslint/eslint-plugin": "^7.7.1",
-    "@typescript-eslint/parser": "^7.7.1",
-    "dotenv": "^16.4.5",
-    "eslint": "^8",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "jest": "^29.6.1",
-    "p-limit": "^3.1.0",
-    "prettier": "^3.3.2",
-    "rollup": "^3.29.1",
-    "rollup-plugin-typescript2": "^0.35.0",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5"
-  },
-  "scripts": {
-    "test": "jest",
-    "build": "rollup -c rollup.config.js",
-    "clean": "rm -rf dist",
-    "start": "rollup -c",
-    "lint": "eslint .",
-    "pretty": "prettier . --write",
-    "prepublishOnly": "npm run clean && npm run build"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "/dist"
-  ],
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "default": "./dist/esm/index.js"
-    },
-    "./cjs": "./cjs/index.js",
-    "./esm": "./esm/index.js",
-    "./types/cjs": "./types/cjs/index.d.ts",
-    "./types/esm": "./types/esm/index.d.ts",
-    "./package.json": "./package.json"
-  },
-  "types": "./dist/esm/index.d.ts"
-}
+{
+  "name": "@covalenthq/client-sdk",
+  "version": "2.2.1",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/covalenthq/covalent-api-sdk-ts.git"
+  },
+  "author": {
+    "name": "covalenthq",
+    "url": "https://covalenthq.com"
+  },
+  "bugs": {
+    "url": "https://github.com/covalenthq/covalent-api-sdk-ts/issues"
+  },
+  "homepage": "https://github.com/covalenthq/covalent-api-sdk-ts#readme",
+  "dependencies": {
+    "big.js": "^6.2.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.4",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/big.js": "^6.2.2",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "dotenv": "^16.4.5",
+    "eslint": "^8",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.6.1",
+    "p-limit": "^3.1.0",
+    "prettier": "^3.3.2",
+    "rollup": "^3.29.1",
+    "rollup-plugin-typescript2": "^0.35.0",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rollup -c rollup.config.js",
+    "clean": "([ ! -d dist ] || rm -r dist)",
+    "start": "rollup -c",
+    "lint": "eslint .",
+    "pretty": "prettier . --write",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./cjs": "./cjs/index.js",
+    "./esm": "./esm/index.js",
+    "./types/cjs": "./types/cjs/index.d.ts",
+    "./types/esm": "./types/esm/index.d.ts",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/esm/index.d.ts"
+}