@covalenthq/client-sdk 0.6.6 → 0.7.0

package/dist/es/services/BalanceService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Quote, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class BalancesResponse {
     /** * The requested address. */
     address: string;
@@ -482,8 +483,9 @@ export declare class BalanceService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.
@@ -498,7 +500,7 @@ export declare class BalanceService {
      *   - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
      *
      */
-    getTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<BalancesResponse>>;
+    getTokenBalancesForWalletAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<BalancesResponse>>;
     /**
      *
      * Commonly used to render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.
@@ -510,7 +512,7 @@ export declare class BalanceService {
      *   - `days`: The number of days to return data for. Defaults to 30 days.
      *
      */
-    getHistoricalPortfolioForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetHistoricalPortfolioForWalletAddressQueryParamOpts): Promise<Response<PortfolioResponse>>;
+    getHistoricalPortfolioForWalletAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetHistoricalPortfolioForWalletAddressQueryParamOpts): Promise<Response<PortfolioResponse>>;
     /**
      *
      * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
@@ -526,7 +528,7 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getErc20TransfersForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<BlockTransactionWithContractTransfers>;
+    getErc20TransfersForWalletAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<BlockTransactionWithContractTransfers>;
     /**
      *
      * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
@@ -542,7 +544,7 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getErc20TransfersForWalletAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): Promise<Response<Erc20TransfersResponse>>;
+    getErc20TransfersForWalletAddressByPage(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): Promise<Response<Erc20TransfersResponse>>;
     /**
      *
      * Commonly used to 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.
@@ -556,7 +558,7 @@ export declare class BalanceService {
      *   - `date`: Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.
      *
      */
-    getTokenHoldersV2ForTokenAddress(chainName: Chain, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): AsyncIterable<TokenHolder>;
+    getTokenHoldersV2ForTokenAddress(chainName: Chain | Chains, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): AsyncIterable<TokenHolder>;
     /**
      *
      * Commonly used to 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.
@@ -570,7 +572,7 @@ export declare class BalanceService {
      *   - `date`: Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.
      *
      */
-    getTokenHoldersV2ForTokenAddressByPage(chainName: Chain, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): Promise<Response<TokenHoldersResponse>>;
+    getTokenHoldersV2ForTokenAddressByPage(chainName: Chain | Chains, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): Promise<Response<TokenHoldersResponse>>;
     /**
      *
      * Commonly used to 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.
@@ -587,7 +589,7 @@ export declare class BalanceService {
      *   - `date`: Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.
      *
      */
-    getHistoricalTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetHistoricalTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<HistoricalBalancesResponse>>;
+    getHistoricalTokenBalancesForWalletAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetHistoricalTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<HistoricalBalancesResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -597,6 +599,6 @@ export declare class BalanceService {
      *   - `blockHeight`: Ending block to define a block range. Omitting this parameter defaults to the latest block height.
      *
      */
-    getNativeTokenBalance(chainName: Chain, walletAddress: string, queryParamOpts?: GetNativeTokenBalanceQueryParamOpts): Promise<Response<TokenBalanceNativeResponse>>;
+    getNativeTokenBalance(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetNativeTokenBalanceQueryParamOpts): Promise<Response<TokenBalanceNativeResponse>>;
 }
 export {};

package/dist/es/services/BaseService.d.ts

@@ -1,4 +1,5 @@
-import { Chain, Response } from "./CovalentClient";
+import { Chain, Quote, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class BlockResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -265,6 +266,45 @@ declare class ChainActivityEvent extends ChainItem {
     last_seen_at: Date;
     constructor(data: ChainActivityEvent);
 }
+declare class GasPricesResponse {
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested event type. */
+    event_type: string;
+    /** * The exchange rate for the requested quote currency. */
+    gas_quote_rate: number;
+    /** * List of response items. */
+    items: PriceItem[];
+    constructor(data: GasPricesResponse);
+}
+declare class PriceItem {
+    /** * The average gas price, in WEI, for the time interval. */
+    gas_price: string;
+    /** * The average gas spent for the time interval. */
+    gas_spent: string;
+    /** * The average gas spent in `quote-currency` denomination for the time interval. */
+    gas_quote: number;
+    /** * Other fees, when applicable. For example: OP chain L1 fees. */
+    other_fees: OtherFees;
+    /** * The sum of the L1 and L2 gas spent, in quote-currency, for the specified time interval. */
+    total_gas_quote: number;
+    /** * A prettier version of the total average gas spent, in quote-currency, for the specified time interval, for rendering purposes. */
+    pretty_total_gas_quote: string;
+    /** * The specified time interval. */
+    interval: string;
+    constructor(data: PriceItem);
+}
+declare class OtherFees {
+    /** * The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval. */
+    l1_gas_quote: number;
+    constructor(data: OtherFees);
+}
 export interface GetBlockHeightsQueryParamOpts {
     /** * Number of items per page. Omitting this parameter defaults to 100. */
     pageSize?: number;
@@ -311,6 +351,10 @@ export interface GetAddressActivityQueryParamOpts {
     /** * Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity. */
     testnets?: boolean;
 }
+export interface GetGasPricesQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+}
 /**
  * Class A - Base
  *
@@ -319,8 +363,9 @@ export declare class BaseService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to fetch and render a single block for a block explorer.
@@ -329,7 +374,7 @@ export declare class BaseService {
      * @param {string} blockHeight - The block height or `latest` for the latest block available.
      *
      */
-    getBlock(chainName: Chain, blockHeight: string): Promise<Response<BlockResponse>>;
+    getBlock(chainName: Chain | Chains, blockHeight: string): Promise<Response<BlockResponse>>;
     /**
      *
      * Commonly used to resolve ENS, RNS and Unstoppable Domains addresses.
@@ -338,7 +383,7 @@ export declare class BaseService {
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getResolvedAddress(chainName: Chain, walletAddress: string): Promise<Response<ResolvedAddress>>;
+    getResolvedAddress(chainName: Chain | Chains, walletAddress: string): Promise<Response<ResolvedAddress>>;
     /**
      *
      * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
@@ -351,7 +396,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getBlockHeights(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): AsyncIterable<Block>;
+    getBlockHeights(chainName: Chain | Chains, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): AsyncIterable<Block>;
     /**
      *
      * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
@@ -364,7 +409,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getBlockHeightsByPage(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): Promise<Response<BlockHeightsResponse>>;
+    getBlockHeightsByPage(chainName: Chain | Chains, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): Promise<Response<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.
@@ -379,7 +424,7 @@ export declare class BaseService {
      *   - `skipDecode`: Omit decoded log events.
      *
      */
-    getLogs(chainName: Chain, queryParamOpts?: GetLogsQueryParamOpts): Promise<Response<GetLogsResponse>>;
+    getLogs(chainName: Chain | Chains, queryParamOpts?: GetLogsQueryParamOpts): Promise<Response<GetLogsResponse>>;
     /**
      *
      * Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
@@ -393,7 +438,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getLogEventsByAddress(chainName: Chain, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): AsyncIterable<LogEvent>;
+    getLogEventsByAddress(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): AsyncIterable<LogEvent>;
     /**
      *
      * Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
@@ -407,7 +452,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getLogEventsByAddressByPage(chainName: Chain, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): Promise<Response<LogEventsByAddressResponse>>;
+    getLogEventsByAddressByPage(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): Promise<Response<LogEventsByAddressResponse>>;
     /**
      *
      * Commonly used to get all event logs of the same topic hash across all contracts within a particular chain. Useful for cross-sectional analysis of event logs that are emitted on-chain.
@@ -422,7 +467,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getLogEventsByTopicHash(chainName: Chain, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): AsyncIterable<LogEvent>;
+    getLogEventsByTopicHash(chainName: Chain | Chains, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): AsyncIterable<LogEvent>;
     /**
      *
      * Commonly used to get all event logs of the same topic hash across all contracts within a particular chain. Useful for cross-sectional analysis of event logs that are emitted on-chain.
@@ -437,7 +482,7 @@ export declare class BaseService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getLogEventsByTopicHashByPage(chainName: Chain, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): Promise<Response<LogEventsByTopicHashResponse>>;
+    getLogEventsByTopicHashByPage(chainName: Chain | Chains, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): Promise<Response<LogEventsByTopicHashResponse>>;
     /**
      *
      * Commonly used to build internal dashboards for all supported chains on Covalent.
@@ -462,5 +507,14 @@ export declare class BaseService {
      *
      */
     getAddressActivity(walletAddress: string, queryParamOpts?: GetAddressActivityQueryParamOpts): Promise<Response<ChainActivityResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} eventType - The desired event type to retrieve gas prices for. Supports `erc20` transfer events, `uniswapv3` swap events and `nativetokens` transfers.
+     * @param {GetGasPricesQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *
+     */
+    getGasPrices(chainName: Chains, eventType: string, queryParamOpts?: GetGasPricesQueryParamOpts): Promise<Response<GasPricesResponse>>;
 }
 export {};

package/dist/es/services/CovalentClient.d.ts

@@ -7,21 +7,7 @@ import { TransactionService } from "./TransactionService";
 import { XykService } from "./XykService";
 export type Chain = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-mainnet" | "avalanche-mainnet" | "optimism-mainnet" | "fantom-mainnet" | "moonbeam-mainnet" | "moonbeam-moonriver" | "rsk-mainnet" | "arbitrum-mainnet" | "palm-mainnet" | "klaytn-mainnet" | "heco-mainnet" | "nervos-godwoken-mainnet" | "axie-mainnet" | "evmos-mainnet" | "astar-mainnet" | "iotex-mainnet" | "harmony-mainnet" | "cronos-mainnet" | "aurora-mainnet" | "emerald-paratime-mainnet" | "boba-mainnet" | "eth-goerli" | "matic-mumbai" | "avalanche-testnet" | "bsc-testnet" | "moonbeam-moonbase-alpha" | "rsk-testnet" | "arbitrum-goerli" | "fantom-testnet" | "palm-testnet" | "heco-testnet" | "nervos-godwoken-testnet" | "evmos-testnet" | "astar-shiden" | "iotex-testnet" | "harmony-testnet" | "aurora-testnet" | "scroll-sepolia-testnet" | "covalent-internal-network-v1" | "defi-kingdoms-mainnet" | "swimmer-mainnet" | "boba-avalanche-mainnet" | "boba-bobabeam-mainnet" | "boba-bnb-mainnet" | "boba-rinkeby-testnet" | "boba-bobabase-testnet" | "boba-bnb-testnet" | "boba-avalanche-testnet" | "klaytn-testnet" | "gather-mainnet" | "gather-testnet" | "skale-calypso" | "skale-mainnet" | "skale-razor" | "avalanche-dexalot-mainnet" | "skale-omnus" | "avalanche-dexalot-testnet" | "astar-shibuya" | "cronos-testnet" | "defi-kingdoms-testnet" | "metis-mainnet" | "metis-stardust" | "milkomeda-a1-mainnet" | "milkomeda-a1-devnet" | "milkomeda-c1-mainnet" | "milkomeda-c1-devnet" | "swimmer-testnet" | "solana-mainnet" | "skale-europa" | "meter-mainnet" | "meter-testnet" | "skale-exorde" | "boba-goerli" | "neon-testnet" | "skale-staging-uum" | "skale-staging-lcc" | "arbitrum-nova-mainnet" | "canto-mainnet" | "bittorrent-mainnet" | "bittorrent-testnet" | "flarenetworks-flare-mainnet" | "flarenetworks-flare-testnet" | "flarenetworks-canary-mainnet" | "flarenetworks-canary-testnet" | "kcc-mainnet" | "kcc-testnet" | "polygon-zkevm-testnet" | "linea-testnet" | "base-testnet" | "mantle-testnet" | "scroll-alpha-testnet" | "oasys-mainnet" | "oasys-testnet" | "findora-mainnet" | "findora-forge-testnet" | "sx-mainnet" | "oasis-sapphire-mainnet" | "oasis-sapphire-testnet" | "optimism-goerli" | "polygon-zkevm-mainnet" | "horizen-yuma-testnet" | "clv-parachain" | "energi-mainnet" | "energi-testnet" | "horizen-gobi-testnet" | "eth-sepolia" | "skale-nebula" | "skale-battleground" | "avalanche-meld-testnet" | "gunzilla-testnet" | "ultron-mainnet" | "ultron-testnet" | "zora-mainnet" | "zora-testnet" | "neon-mainnet" | "avalanche-shrapnel-mainnet" | "base-mainnet" | "mantle-mainnet" | "avalanche-loco-legends-mainnet" | "linea-mainnet" | "horizen-eon-mainnet" | "avalanche-numbers" | "avalanche-dos" | "avalanche-step-network" | "avalanche-xplus" | "avalanche-xanachain" | "avalanche-meld-mainnet" | "opside-public-zkevm" | "opside-law-chain" | "avalanche-shrapnel-testnet" | "avalanche-loco-legends-testnet" | "opside-cb-zkevm" | "opside-pre-alpha-testnet" | "opside-era7" | "opside-xthrill" | "zksync-mainnet" | "metis-testnet" | "zksync-testnet" | "avalanche-blitz-testnet" | "avalanche-d-chain-testnet" | "avalanche-green-dot-testnet" | "avalanche-mintara-testnet" | "avalanche-beam-testnet" | "bnb-meta-apes-mainnet" | "bnb-antimatter-mainnet" | "bnb-antimatter-testnet" | "bnb-opbnb-testnet" | "opside-debox" | "opside-jackbot" | "opside-odx-zkevm-testnet" | "opside-readon-content-testnet" | "opside-relation" | "opside-soquest-zkevm" | "opside-vip3" | "opside-zkmeta" | "avalanche-pulsar-testnet" | "avalanche-uptn" | "bnb-fncy-mainnet" | "zetachain-testnet" | "kinto-testnet" | "mode-testnet" | "loot-mainnet" | "bnb-fncy-testnet" | "manta-testnet" | "pgn-mainnet" | "pgn-testnet" | "gnosis-mainnet" | "gnosis-testnet" | "rollux-mainnet" | "rollux-testnet" | "taiko-jolnir-testnet" | "optimism-sepolia" | "bnb-opbnb-mainnet" | "telos-mainnet" | "telos-testnet";
 export type Quote = "USD" | "CAD" | "EUR" | "SGD" | "INR" | "JPY" | "VND" | "CNY" | "KRW" | "RUB" | "TRY" | "NGN" | "ARS" | "AUD" | "CHF" | "GBP";
-/**
- * @deprecated
- * Please use {@link Chain}  going forward! This type will be removed after Oct 31, 2023.
- * @see #Chain
- * CovalentClient Class
- */
-export type Chains = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-mainnet" | "avalanche-mainnet" | "optimism-mainnet" | "fantom-mainnet" | "moonbeam-mainnet" | "moonbeam-moonriver" | "rsk-mainnet" | "arbitrum-mainnet" | "palm-mainnet" | "klaytn-mainnet" | "heco-mainnet" | "nervos-godwoken-mainnet" | "axie-mainnet" | "evmos-mainnet" | "astar-mainnet" | "iotex-mainnet" | "harmony-mainnet" | "cronos-mainnet" | "aurora-mainnet" | "emerald-paratime-mainnet" | "boba-mainnet" | "eth-goerli" | "matic-mumbai" | "avalanche-testnet" | "bsc-testnet" | "moonbeam-moonbase-alpha" | "rsk-testnet" | "arbitrum-goerli" | "fantom-testnet" | "palm-testnet" | "heco-testnet" | "nervos-godwoken-testnet" | "evmos-testnet" | "astar-shiden" | "iotex-testnet" | "harmony-testnet" | "aurora-testnet" | "scroll-sepolia-testnet" | "covalent-internal-network-v1" | "defi-kingdoms-mainnet" | "swimmer-mainnet" | "boba-avalanche-mainnet" | "boba-bobabeam-mainnet" | "boba-bnb-mainnet" | "boba-rinkeby-testnet" | "boba-bobabase-testnet" | "boba-bnb-testnet" | "boba-avalanche-testnet" | "klaytn-testnet" | "gather-mainnet" | "gather-testnet" | "skale-calypso" | "skale-mainnet" | "skale-razor" | "avalanche-dexalot-mainnet" | "skale-omnus" | "avalanche-dexalot-testnet" | "astar-shibuya" | "cronos-testnet" | "defi-kingdoms-testnet" | "metis-mainnet" | "metis-stardust" | "milkomeda-a1-mainnet" | "milkomeda-a1-devnet" | "milkomeda-c1-mainnet" | "milkomeda-c1-devnet" | "swimmer-testnet" | "solana-mainnet" | "skale-europa" | "meter-mainnet" | "meter-testnet" | "skale-exorde" | "boba-goerli" | "neon-testnet" | "skale-staging-uum" | "skale-staging-lcc" | "arbitrum-nova-mainnet" | "canto-mainnet" | "bittorrent-mainnet" | "bittorrent-testnet" | "flarenetworks-flare-mainnet" | "flarenetworks-flare-testnet" | "flarenetworks-canary-mainnet" | "flarenetworks-canary-testnet" | "kcc-mainnet" | "kcc-testnet" | "polygon-zkevm-testnet" | "linea-testnet" | "base-testnet" | "mantle-testnet" | "scroll-alpha-testnet" | "oasys-mainnet" | "oasys-testnet" | "findora-mainnet" | "findora-forge-testnet" | "sx-mainnet" | "oasis-sapphire-mainnet" | "oasis-sapphire-testnet" | "optimism-goerli" | "polygon-zkevm-mainnet" | "horizen-yuma-testnet" | "clv-parachain" | "energi-mainnet" | "energi-testnet" | "horizen-gobi-testnet" | "eth-sepolia" | "skale-nebula" | "skale-battleground" | "avalanche-meld-testnet" | "gunzilla-testnet" | "ultron-mainnet" | "ultron-testnet" | "zora-mainnet" | "zora-testnet" | "neon-mainnet" | "avalanche-shrapnel-mainnet" | "base-mainnet" | "mantle-mainnet" | "avalanche-loco-legends-mainnet" | "linea-mainnet" | "horizen-eon-mainnet" | "avalanche-numbers" | "avalanche-dos" | "avalanche-step-network" | "avalanche-xplus" | "avalanche-xanachain" | "avalanche-meld-mainnet" | "opside-public-zkevm" | "opside-law-chain" | "avalanche-shrapnel-testnet" | "avalanche-loco-legends-testnet" | "opside-cb-zkevm" | "opside-pre-alpha-testnet" | "opside-era7" | "opside-xthrill" | "zksync-mainnet" | "metis-testnet" | "zksync-testnet" | "avalanche-blitz-testnet" | "avalanche-d-chain-testnet" | "avalanche-green-dot-testnet" | "avalanche-mintara-testnet" | "avalanche-beam-testnet" | "bnb-meta-apes-mainnet" | "bnb-antimatter-mainnet" | "bnb-antimatter-testnet" | "bnb-opbnb-testnet" | "opside-debox" | "opside-jackbot" | "opside-odx-zkevm-testnet" | "opside-readon-content-testnet" | "opside-relation" | "opside-soquest-zkevm" | "opside-vip3" | "opside-zkmeta" | "avalanche-pulsar-testnet" | "avalanche-uptn" | "bnb-fncy-mainnet" | "zetachain-testnet" | "kinto-testnet" | "mode-testnet" | "loot-mainnet" | "bnb-fncy-testnet" | "manta-testnet" | "pgn-mainnet" | "pgn-testnet" | "gnosis-mainnet" | "gnosis-testnet" | "rollux-mainnet" | "rollux-testnet" | "taiko-jolnir-testnet" | "optimism-sepolia" | "bnb-opbnb-mainnet" | "telos-mainnet" | "telos-testnet";
-/**
- * @deprecated
- * Please use {@link Quote} going forward! This type will be removed after Oct 31, 2023.
- * @see #Quote
- * CovalentClient Class
- */
-export type Quotes = "USD" | "CAD" | "EUR" | "SGD" | "INR" | "JPY" | "VND" | "CNY" | "KRW" | "RUB" | "TRY" | "NGN" | "ARS" | "AUD" | "CHF" | "GBP";
-export declare const userAgent = "com.covalenthq.sdk.typescript/0.6.6";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.7.0";
 export declare class Response<T> {
     data: T;
     error: boolean;
@@ -45,6 +31,7 @@ export declare class CovalentClient {
     PricingService: PricingService;
     TransactionService: TransactionService;
     XykService: XykService;
+    private _is_key_valid;
     constructor(apiKey: string, settings?: CovalentClientSettings);
 }
 /**
@@ -61,5 +48,6 @@ export declare class Client {
     PricingService: PricingService;
     TransactionService: TransactionService;
     XykService: XykService;
+    private _is_key_valid;
     constructor(apiKey: string, settings?: CovalentClientSettings);
 }

package/dist/es/services/NftService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Quote, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class ChainCollectionResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -482,8 +483,9 @@ export declare class NftService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
@@ -495,7 +497,7 @@ export declare class NftService {
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
      */
-    getChainCollections(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<ChainCollectionItem>;
+    getChainCollections(chainName: Chain | Chains, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<ChainCollectionItem>;
     /**
      *
      * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
@@ -507,7 +509,7 @@ export declare class NftService {
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
      */
-    getChainCollectionsByPage(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): Promise<Response<ChainCollectionResponse>>;
+    getChainCollectionsByPage(chainName: Chain | Chains, queryParamOpts?: GetChainCollectionsQueryParamOpts): Promise<Response<ChainCollectionResponse>>;
     /**
      *
      * Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.
@@ -520,7 +522,7 @@ export declare class NftService {
      *   - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
      *
      */
-    getNftsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetNftsForAddressQueryParamOpts): Promise<Response<NftAddressBalanceNftResponse>>;
+    getNftsForAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetNftsForAddressQueryParamOpts): Promise<Response<NftAddressBalanceNftResponse>>;
     /**
      *
      * Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
@@ -536,7 +538,7 @@ export declare class NftService {
      *   - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
      *
      */
-    getTokenIdsForContractWithMetadata(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<NftTokenContract>;
+    getTokenIdsForContractWithMetadata(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<NftTokenContract>;
     /**
      *
      * Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
@@ -552,7 +554,7 @@ export declare class NftService {
      *   - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
      *
      */
-    getTokenIdsForContractWithMetadataByPage(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): Promise<Response<NftMetadataResponse>>;
+    getTokenIdsForContractWithMetadataByPage(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): Promise<Response<NftMetadataResponse>>;
     /**
      *
      * Commonly used to get a single NFT metadata by token ID from a collection. Useful for building NFT card displays.
@@ -565,7 +567,7 @@ export declare class NftService {
      *   - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
      *
      */
-    getNftMetadataForGivenTokenIdForContract(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftMetadataForGivenTokenIdForContractQueryParamOpts): Promise<Response<NftMetadataResponse>>;
+    getNftMetadataForGivenTokenIdForContract(chainName: Chain | Chains, contractAddress: string, tokenId: string, queryParamOpts?: GetNftMetadataForGivenTokenIdForContractQueryParamOpts): Promise<Response<NftMetadataResponse>>;
     /**
      *
      * Commonly used to get all transactions of an NFT token. Useful for building a transaction history table or price chart.
@@ -577,7 +579,7 @@ export declare class NftService {
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
      */
-    getNftTransactionsForContractTokenId(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftTransactionsForContractTokenIdQueryParamOpts): Promise<Response<NftTransactionsResponse>>;
+    getNftTransactionsForContractTokenId(chainName: Chain | Chains, contractAddress: string, tokenId: string, queryParamOpts?: GetNftTransactionsForContractTokenIdQueryParamOpts): Promise<Response<NftTransactionsResponse>>;
     /**
      *
      * Commonly used to fetch and render the traits of a collection as seen in rarity calculators.
@@ -586,7 +588,7 @@ export declare class NftService {
      * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getTraitsForCollection(chainName: Chain, collectionContract: string): Promise<Response<NftCollectionTraitsResponse>>;
+    getTraitsForCollection(chainName: Chain | Chains, collectionContract: string): Promise<Response<NftCollectionTraitsResponse>>;
     /**
      *
      * Commonly used to get the count of unique values for traits within an NFT collection.
@@ -596,7 +598,7 @@ export declare class NftService {
      * @param {string} trait - The requested trait.
      *
      */
-    getAttributesForTraitInCollection(chainName: Chain, collectionContract: string, trait: string): Promise<Response<NftCollectionAttributesForTraitResponse>>;
+    getAttributesForTraitInCollection(chainName: Chain | Chains, collectionContract: string, trait: string): Promise<Response<NftCollectionAttributesForTraitResponse>>;
     /**
      *
      * Commonly used to calculate rarity scores for a collection based on its traits.
@@ -605,7 +607,7 @@ export declare class NftService {
      * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getCollectionTraitsSummary(chainName: Chain, collectionContract: string): Promise<Response<NftCollectionTraitSummaryResponse>>;
+    getCollectionTraitsSummary(chainName: Chain | Chains, collectionContract: string): Promise<Response<NftCollectionTraitSummaryResponse>>;
     /**
      *
      * Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.
@@ -615,7 +617,7 @@ export declare class NftService {
      * @param {string} collectionContract - The requested collection address.
      *
      */
-    checkOwnershipInNft(chainName: Chain, walletAddress: string, collectionContract: string): Promise<Response<NftOwnershipForCollectionResponse>>;
+    checkOwnershipInNft(chainName: Chain | Chains, walletAddress: string, collectionContract: string): Promise<Response<NftOwnershipForCollectionResponse>>;
     /**
      *
      * Commonly used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.
@@ -626,7 +628,7 @@ export declare class NftService {
      * @param {string} tokenId - The requested token ID.
      *
      */
-    checkOwnershipInNftForSpecificTokenId(chainName: Chain, walletAddress: string, collectionContract: string, tokenId: string): Promise<Response<NftOwnershipForCollectionResponse>>;
+    checkOwnershipInNftForSpecificTokenId(chainName: Chain | Chains, walletAddress: string, collectionContract: string, tokenId: string): Promise<Response<NftOwnershipForCollectionResponse>>;
     /**
      *
      * Commonly used to build a time-series chart of the sales count of an NFT collection.
@@ -638,7 +640,7 @@ export declare class NftService {
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *
      */
-    getNftMarketSaleCount(chainName: Chain, contractAddress: string, queryParamOpts?: GetNftMarketSaleCountQueryParamOpts): Promise<Response<NftMarketSaleCountResponse>>;
+    getNftMarketSaleCount(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetNftMarketSaleCountQueryParamOpts): Promise<Response<NftMarketSaleCountResponse>>;
     /**
      *
      * Commonly used to build a time-series chart of the transaction volume of an NFT collection.
@@ -650,7 +652,7 @@ export declare class NftService {
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *
      */
-    getNftMarketVolume(chainName: Chain, contractAddress: string, queryParamOpts?: GetNftMarketVolumeQueryParamOpts): Promise<Response<NftMarketVolumeResponse>>;
+    getNftMarketVolume(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetNftMarketVolumeQueryParamOpts): Promise<Response<NftMarketVolumeResponse>>;
     /**
      *
      * Commonly used to render a price floor chart for an NFT collection.
@@ -662,6 +664,6 @@ export declare class NftService {
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *
      */
-    getNftMarketFloorPrice(chainName: Chain, contractAddress: string, queryParamOpts?: GetNftMarketFloorPriceQueryParamOpts): Promise<Response<NftMarketFloorPriceResponse>>;
+    getNftMarketFloorPrice(chainName: Chain | Chains, contractAddress: string, queryParamOpts?: GetNftMarketFloorPriceQueryParamOpts): Promise<Response<NftMarketFloorPriceResponse>>;
 }
 export {};

package/dist/es/services/PricingService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Quote } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class TokenPricesResponse {
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     contract_decimals: number;
@@ -68,8 +69,9 @@ export declare class PricingService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to get historic prices of a token between date ranges. Supports native tokens.
@@ -83,6 +85,6 @@ export declare class PricingService {
      *   - `pricesAtAsc`: Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order.
      *
      */
-    getTokenPrices(chainName: Chain, quoteCurrency: Quote, contractAddress: string, queryParamOpts?: GetTokenPricesQueryParamOpts): Promise<Response<TokenPricesResponse>>;
+    getTokenPrices(chainName: Chain | Chains, quoteCurrency: Quote, contractAddress: string, queryParamOpts?: GetTokenPricesQueryParamOpts): Promise<Response<TokenPricesResponse>>;
 }
 export {};

package/dist/es/services/SecurityService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class ApprovalsResponse {
     /** * The requested address. */
     address: string;
@@ -135,8 +136,9 @@ export declare class SecurityService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.
@@ -145,7 +147,7 @@ export declare class SecurityService {
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getApprovals(chainName: Chain, walletAddress: string): Promise<Response<ApprovalsResponse>>;
+    getApprovals(chainName: Chain | Chains, walletAddress: string): Promise<Response<ApprovalsResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -153,6 +155,6 @@ export declare class SecurityService {
      
      *
      */
-    getNftApprovals(chainName: Chain, walletAddress: string): Promise<Response<NftApprovalsResponse>>;
+    getNftApprovals(chainName: Chain | Chains, walletAddress: string): Promise<Response<NftApprovalsResponse>>;
 }
 export {};

package/dist/es/services/TransactionService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Quote, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class TransactionResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -57,11 +58,11 @@ declare class Transaction {
     /** * The explorer links for this transaction. */
     explorers: Explorer[];
     /** * The details for the dex transaction. */
-    dex_details: DexReport;
+    dex_details: DexReport[];
     /** * The details for the NFT sale transaction. */
-    nft_sale_details: NftSalesReport;
+    nft_sale_details: NftSalesReport[];
     /** * The details for the lending protocol transaction. */
-    lending_details: LendingReport;
+    lending_details: LendingReport[];
     /** * The log events. */
     log_events: LogEvent[];
     /** * The details related to the safe transaction. */
@@ -476,8 +477,9 @@ export declare class TransactionService {
     private apiKey;
     private debug;
     private threadCount;
+    private is_key_valid;
     private LIMIT;
-    constructor(apiKey: string, debug?: boolean, threadCount?: number);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
     /**
      *
      * Commonly used to fetch and render a single transaction including its decoded log events. Additionally return semantically decoded information for DEX trades, lending and NFT sales.
@@ -493,7 +495,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransaction(chainName: Chain, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<Response<TransactionResponse>>;
+    getTransaction(chainName: Chain | Chains, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<Response<TransactionResponse>>;
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -507,7 +509,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getAllTransactionsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<Transaction>;
+    getAllTransactionsForAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<Transaction>;
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -521,7 +523,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getAllTransactionsForAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<Response<RecentTransactionsResponse>>;
+    getAllTransactionsForAddressByPage(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<Response<RecentTransactionsResponse>>;
     /**
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
@@ -534,7 +536,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransactionsForBlock(chainName: Chain, blockHeight: number, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<Response<TransactionsBlockResponse>>;
+    getTransactionsForBlock(chainName: Chain | Chains, blockHeight: number, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<Response<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.
@@ -543,7 +545,7 @@ export declare class TransactionService {
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getTransactionSummary(chainName: Chain, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
+    getTransactionSummary(chainName: Chain | Chains, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -556,6 +558,6 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransactionsForAddressV3(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<Response<TransactionsResponse>>;
+    getTransactionsForAddressV3(chainName: Chain | Chains, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<Response<TransactionsResponse>>;
 }
 export {};