@covalenthq/client-sdk 0.6.6 → 0.7.0

package/dist/esm/services/XykService.d.ts

@@ -1,4 +1,5 @@
 import { Chain, Quote, Response } from "./CovalentClient";
+import { Chains } from "../util/Chains";
 declare class PoolResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -543,8 +544,9 @@ export declare class XykService {
     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 all the pools of a particular DEX. Supports most common DEXs (Uniswap, SushiSwap, etc), and returns detailed trading data (volume, liquidity, swap counts, fees, LP token prices).
@@ -553,7 +555,7 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getPools(chainName: Chain, dexName: string): Promise<Response<PoolResponse>>;
+    getPools(chainName: Chain | Chains, dexName: string): Promise<Response<PoolResponse>>;
     /**
      *
      * Commonly used to get the corresponding supported DEX given a pool address, along with the swap fees, DEX's logo url, and factory addresses. Useful to identifying the specific DEX to which a pair address is associated.
@@ -562,7 +564,7 @@ export declare class XykService {
      * @param {string} poolAddress - The requested pool address.
      *
      */
-    getDexForPoolAddress(chainName: Chain, poolAddress: string): Promise<Response<PoolToDexResponse>>;
+    getDexForPoolAddress(chainName: Chain | Chains, poolAddress: string): Promise<Response<PoolToDexResponse>>;
     /**
      *
      * Commonly used to get the 7 day and 30 day time-series data (volume, liquidity, price) of a particular liquidity pool in a DEX. Useful for building time-series charts on DEX trading activity.
@@ -572,7 +574,7 @@ export declare class XykService {
      * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getPoolByAddress(chainName: Chain, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    getPoolByAddress(chainName: Chain | Chains, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
     /**
      *
      * Commonly used to get all pools and the supported DEX for a token. Useful for building a table of top pairs across all supported DEXes that the token is trading on.
@@ -584,7 +586,7 @@ export declare class XykService {
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *
      */
-    getPoolsForTokenAddress(chainName: Chain, tokenAddress: string, page: number, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    getPoolsForTokenAddress(chainName: Chain | Chains, tokenAddress: string, page: number, queryParamOpts?: GetPoolsForTokenAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
     /**
      *
      * Commonly used to return balance of a wallet/contract address on a specific DEX.
@@ -594,7 +596,7 @@ export declare class XykService {
      * @param {string} accountAddress - The account address.
      *
      */
-    getAddressExchangeBalances(chainName: Chain, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
+    getAddressExchangeBalances(chainName: Chain | Chains, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
     /**
      *
      * Commonly used to get all pools and supported DEX for a wallet. Useful for building a personal DEX UI showcasing pairs and supported DEXes associated to the wallet.
@@ -607,7 +609,7 @@ export declare class XykService {
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *
      */
-    getPoolsForWalletAddress(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: GetPoolsForWalletAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
+    getPoolsForWalletAddress(chainName: Chain | Chains, walletAddress: string, page: number, queryParamOpts?: GetPoolsForWalletAddressQueryParamOpts): Promise<Response<PoolsDexDataResponse>>;
     /**
      *
      * Commonly used to retrieve all network exchange tokens for a specific DEX. Useful for building a top tokens table by total liquidity within a particular DEX.
@@ -616,7 +618,7 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getNetworkExchangeTokens(chainName: Chain, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
+    getNetworkExchangeTokens(chainName: Chain | Chains, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
     /**
      *
      * Commonly used to get all the supported DEXs available for the xy=k endpoints, along with the swap fees and factory addresses.
@@ -633,7 +635,7 @@ export declare class XykService {
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getSingleNetworkExchangeToken(chainName: Chain, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
+    getSingleNetworkExchangeToken(chainName: Chain | Chains, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
     /**
      *
      * Commonly used to get all the DEX transactions of a wallet. Useful for building tables of DEX activity segmented by wallet.
@@ -643,7 +645,7 @@ export declare class XykService {
      * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
      *
      */
-    getTransactionsForAccountAddress(chainName: Chain, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
+    getTransactionsForAccountAddress(chainName: Chain | Chains, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
     /**
      *
      * Commonly used to get all the transactions of a token within a particular DEX. Useful for getting a per-token view of DEX activity.
@@ -653,7 +655,7 @@ export declare class XykService {
      * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getTransactionsForTokenAddress(chainName: Chain, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
+    getTransactionsForTokenAddress(chainName: Chain | Chains, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
     /**
      *
      * Commonly used for getting all the transactions of a particular DEX liquidity pool. Useful for building a transactions history table for an individual pool.
@@ -663,7 +665,7 @@ export declare class XykService {
      * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getTransactionsForExchange(chainName: Chain, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
+    getTransactionsForExchange(chainName: Chain | Chains, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
     /**
      *
      * Commonly used to get a 7d and 30d time-series chart of DEX activity. Includes volume and swap count.
@@ -672,7 +674,7 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getEcosystemChartData(chainName: Chain, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
+    getEcosystemChartData(chainName: Chain | Chains, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
     /**
      *
      * Commonly used to ping the health of xy=k endpoints to get the synced block height per chain.
@@ -681,6 +683,6 @@ export declare class XykService {
      * @param {string} dexName - The DEX name eg: `uniswap_v2`.
      *
      */
-    getHealthData(chainName: Chain, dexName: string): Promise<Response<HealthDataResponse>>;
+    getHealthData(chainName: Chain | Chains, dexName: string): Promise<Response<HealthDataResponse>>;
 }
 export {};

package/dist/esm/util/ApiKeyValidator.d.ts

@@ -0,0 +1,8 @@
+export declare class ApiKeyValidator {
+    readonly _apiKey: string;
+    private static readonly _apiKeyV1Pattern;
+    private static readonly _apiKeyV2Pattern;
+    static readonly INVALID_API_KEY_MESSAGE = "Invalid or missing API key (sign up at covalenthq.com/platform)";
+    constructor(apiKey: string);
+    isValidApiKey(): boolean;
+}

package/dist/esm/util/Chains.d.ts

@@ -0,0 +1,180 @@
+export declare enum Chains {
+    BTC_MAINNET = "btc-mainnet",
+    ETH_MAINNET = "eth-mainnet",
+    MATIC_MAINNET = "matic-mainnet",
+    BSC_MAINNET = "bsc-mainnet",
+    AVALANCHE_MAINNET = "avalanche-mainnet",
+    OPTIMISM_MAINNET = "optimism-mainnet",
+    FANTOM_MAINNET = "fantom-mainnet",
+    MOONBEAM_MAINNET = "moonbeam-mainnet",
+    MOONBEAM_MOONRIVER = "moonbeam-moonriver",
+    RSK_MAINNET = "rsk-mainnet",
+    ARBITRUM_MAINNET = "arbitrum-mainnet",
+    PALM_MAINNET = "palm-mainnet",
+    KLAYTN_MAINNET = "klaytn-mainnet",
+    HECO_MAINNET = "heco-mainnet",
+    NERVOS_GODWOKEN_MAINNET = "nervos-godwoken-mainnet",
+    AXIE_MAINNET = "axie-mainnet",
+    EVMOS_MAINNET = "evmos-mainnet",
+    ASTAR_MAINNET = "astar-mainnet",
+    IOTEX_MAINNET = "iotex-mainnet",
+    HARMONY_MAINNET = "harmony-mainnet",
+    CRONOS_MAINNET = "cronos-mainnet",
+    AURORA_MAINNET = "aurora-mainnet",
+    EMERALD_PARATIME_MAINNET = "emerald-paratime-mainnet",
+    BOBA_MAINNET = "boba-mainnet",
+    ETH_GOERLI = "eth-goerli",
+    MATIC_MUMBAI = "matic-mumbai",
+    AVALANCHE_TESTNET = "avalanche-testnet",
+    BSC_TESTNET = "bsc-testnet",
+    MOONBEAM_MOONBASE_ALPHA = "moonbeam-moonbase-alpha",
+    RSK_TESTNET = "rsk-testnet",
+    ARBITRUM_GOERLI = "arbitrum-goerli",
+    FANTOM_TESTNET = "fantom-testnet",
+    PALM_TESTNET = "palm-testnet",
+    HECO_TESTNET = "heco-testnet",
+    NERVOS_GODWOKEN_TESTNET = "nervos-godwoken-testnet",
+    EVMOS_TESTNET = "evmos-testnet",
+    ASTAR_SHIDEN = "astar-shiden",
+    IOTEX_TESTNET = "iotex-testnet",
+    HARMONY_TESTNET = "harmony-testnet",
+    AURORA_TESTNET = "aurora-testnet",
+    SCROLL_SEPOLIA_TESTNET = "scroll-sepolia-testnet",
+    COVALENT_INTERNAL_NETWORK_V1 = "covalent-internal-network-v1",
+    DEFI_KINGDOMS_MAINNET = "defi-kingdoms-mainnet",
+    SWIMMER_MAINNET = "swimmer-mainnet",
+    BOBA_AVALANCHE_MAINNET = "boba-avalanche-mainnet",
+    BOBA_BOBABEAM_MAINNET = "boba-bobabeam-mainnet",
+    BOBA_BNB_MAINNET = "boba-bnb-mainnet",
+    BOBA_RINKEBY_TESTNET = "boba-rinkeby-testnet",
+    BOBA_BOBABASE_TESTNET = "boba-bobabase-testnet",
+    BOBA_BNB_TESTNET = "boba-bnb-testnet",
+    BOBA_AVALANCHE_TESTNET = "boba-avalanche-testnet",
+    KLAYTN_TESTNET = "klaytn-testnet",
+    GATHER_MAINNET = "gather-mainnet",
+    GATHER_TESTNET = "gather-testnet",
+    SKALE_CALYPSO = "skale-calypso",
+    SKALE_MAINNET = "skale-mainnet",
+    SKALE_RAZOR = "skale-razor",
+    AVALANCHE_DEXALOT_MAINNET = "avalanche-dexalot-mainnet",
+    SKALE_OMNUS = "skale-omnus",
+    AVALANCHE_DEXALOT_TESTNET = "avalanche-dexalot-testnet",
+    ASTAR_SHIBUYA = "astar-shibuya",
+    CRONOS_TESTNET = "cronos-testnet",
+    DEFI_KINGDOMS_TESTNET = "defi-kingdoms-testnet",
+    METIS_MAINNET = "metis-mainnet",
+    METIS_STARDUST = "metis-stardust",
+    MILKOMEDA_A1_MAINNET = "milkomeda-a1-mainnet",
+    MILKOMEDA_A1_DEVNET = "milkomeda-a1-devnet",
+    MILKOMEDA_C1_MAINNET = "milkomeda-c1-mainnet",
+    MILKOMEDA_C1_DEVNET = "milkomeda-c1-devnet",
+    SWIMMER_TESTNET = "swimmer-testnet",
+    SOLANA_MAINNET = "solana-mainnet",
+    SKALE_EUROPA = "skale-europa",
+    METER_MAINNET = "meter-mainnet",
+    METER_TESTNET = "meter-testnet",
+    SKALE_EXORDE = "skale-exorde",
+    BOBA_GOERLI = "boba-goerli",
+    NEON_TESTNET = "neon-testnet",
+    SKALE_STAGING_UUM = "skale-staging-uum",
+    SKALE_STAGING_LCC = "skale-staging-lcc",
+    ARBITRUM_NOVA_MAINNET = "arbitrum-nova-mainnet",
+    CANTO_MAINNET = "canto-mainnet",
+    BITTORRENT_MAINNET = "bittorrent-mainnet",
+    BITTORRENT_TESTNET = "bittorrent-testnet",
+    FLARENETWORKS_FLARE_MAINNET = "flarenetworks-flare-mainnet",
+    FLARENETWORKS_FLARE_TESTNET = "flarenetworks-flare-testnet",
+    FLARENETWORKS_CANARY_MAINNET = "flarenetworks-canary-mainnet",
+    FLARENETWORKS_CANARY_TESTNET = "flarenetworks-canary-testnet",
+    KCC_MAINNET = "kcc-mainnet",
+    KCC_TESTNET = "kcc-testnet",
+    POLYGON_ZKEVM_TESTNET = "polygon-zkevm-testnet",
+    LINEA_TESTNET = "linea-testnet",
+    BASE_TESTNET = "base-testnet",
+    MANTLE_TESTNET = "mantle-testnet",
+    SCROLL_ALPHA_TESTNET = "scroll-alpha-testnet",
+    OASYS_MAINNET = "oasys-mainnet",
+    OASYS_TESTNET = "oasys-testnet",
+    FINDORA_MAINNET = "findora-mainnet",
+    FINDORA_FORGE_TESTNET = "findora-forge-testnet",
+    SX_MAINNET = "sx-mainnet",
+    OASIS_SAPPHIRE_MAINNET = "oasis-sapphire-mainnet",
+    OASIS_SAPPHIRE_TESTNET = "oasis-sapphire-testnet",
+    OPTIMISM_GOERLI = "optimism-goerli",
+    POLYGON_ZKEVM_MAINNET = "polygon-zkevm-mainnet",
+    HORIZEN_YUMA_TESTNET = "horizen-yuma-testnet",
+    CLV_PARACHAIN = "clv-parachain",
+    ENERGI_MAINNET = "energi-mainnet",
+    ENERGI_TESTNET = "energi-testnet",
+    HORIZEN_GOBI_TESTNET = "horizen-gobi-testnet",
+    ETH_SEPOLIA = "eth-sepolia",
+    SKALE_NEBULA = "skale-nebula",
+    SKALE_BATTLEGROUNDS = "skale-battleground",
+    AVALANCHE_MELD_TESTNET = "avalanche-meld-testnet",
+    GUNZILLA_TESTNET = "gunzilla-testnet",
+    ULTRON_MAINNET = "ultron-mainnet",
+    ULTRON_TESTNET = "ultron-testnet",
+    ZORA_MAINNET = "zora-mainnet",
+    ZORA_TESTNET = "zora-testnet",
+    NEON_MAINNET = "neon-mainnet",
+    AVALANCHE_SHRAPNEL_MAINNET = "avalanche-shrapnel-mainnet",
+    BASE_MAINNET = "base-mainnet",
+    MANTLE_MAINNET = "mantle-mainnet",
+    AVALANCHE_LOCO_LEGENDS_MAINNET = "avalanche-loco-legends-mainnet",
+    LINEA_MAINNET = "linea-mainnet",
+    HORIZEN_EON_MAINNET = "horizen-eon-mainnet",
+    AVALANCHE_NUMBERS = "avalanche-numbers",
+    AVALANCHE_DOS = "avalanche-dos",
+    AVALANCHE_STEP_NETWORK = "avalanche-step-network",
+    AVALANCHE_XPLUS = "avalanche-xplus",
+    AVALANCHE_XANACHAIN = "avalanche-xanachain",
+    AVALANCHE_MELD_MAINNET = "avalanche-meld-mainnet",
+    OPSIDE_PUBLIC_ZKEVM = "opside-public-zkevm",
+    OPSIDE_LAW_CHAIN = "opside-law-chain",
+    AVALANCHE_SHRAPNEL_TESTNET = "avalanche-shrapnel-testnet",
+    AVALANCHE_LOCO_LEGENDS_TESTNET = "avalanche-loco-legends-testnet",
+    OPSIDE_CB_ZKEVM = "opside-cb-zkevm",
+    OPSIDE_PRE_ALPHA_TESTNET = "opside-pre-alpha-testnet",
+    OPSIDE_ERA7 = "opside-era7",
+    OPSIDE_XTHRILL = "opside-xthrill",
+    ZKSYNC_MAINNET = "zksync-mainnet",
+    METIS_TESTNET = "metis-testnet",
+    ZKSYNC_TESTNET = "zksync-testnet",
+    AVALANCHE_BLITZ_TESTNET = "avalanche-blitz-testnet",
+    AVALANCHE_D_CHAIN_TESTNET = "avalanche-d-chain-testnet",
+    AVALANCHE_GREEN_DOT_TESTNET = "avalanche-green-dot-testnet",
+    AVALANCHE_MINTARA_TESTNET = "avalanche-mintara-testnet",
+    AVALANCHE_BEAM_TESTNET = "avalanche-beam-testnet",
+    BNB_META_APES_MAINNET = "bnb-meta-apes-mainnet",
+    BNB_ANTIMATTER_MAINNET = "bnb-antimatter-mainnet",
+    BNB_ANTIMATTER_TESTNET = "bnb-antimatter-testnet",
+    BNB_OPBNB_TESTNET = "bnb-opbnb-testnet",
+    OPSIDE_DEBOX = "opside-debox",
+    OPSIDE_JACKBOT = "opside-jackbot",
+    OPSIDE_ODX_ZKEVM_TESTNET = "opside-odx-zkevm-testnet",
+    OPSIDE_READON_CONTENT_TESTNET = "opside-readon-content-testnet",
+    OPSIDE_RELATION = "opside-relation",
+    OPSIDE_SOQUEST_ZKEVM = "opside-soquest-zkevm",
+    OPSIDE_VIP3 = "opside-vip3",
+    OPSIDE_ZKMETA = "opside-zkmeta",
+    AVALANCHE_PULSAR_TESTNET = "avalanche-pulsar-testnet",
+    AVALANCHE_UPTN = "avalanche-uptn",
+    BNB_FNCY_MAINNET = "bnb-fncy-mainnet",
+    ZETACHAIN_TESTNET = "zetachain-testnet",
+    KINTO_TESTNET = "kinto-testnet",
+    MODE_TESTNET = "mode-testnet",
+    LOOT_MAINNET = "loot-mainnet",
+    BNB_FNCY_TESTNET = "bnb-fncy-testnet",
+    MANTA_TESTNET = "manta-testnet",
+    PGN_MAINNET = "pgn-mainnet",
+    PGN_TESTNET = "pgn-testnet",
+    GNOSIS_MAINNET = "gnosis-mainnet",
+    GNOSIS_TESTNET = "gnosis-testnet",
+    ROLLUX_MAINNET = "rollux-mainnet",
+    ROLLUX_TESTNET = "rollux-testnet",
+    TAIKO_JOLNIR_TESTNET = "taiko-jolnir-testnet",
+    OPTIMISM_SEPOLIA = "optimism-sepolia",
+    BNB_OPBNB_MAINNET = "bnb-opbnb-mainnet",
+    TELOS_MAINNET = "telos-mainnet",
+    TELOS_TESTNET = "telos-testnet"
+}

package/dist/esm/util/types/BaseServiceTypes.d.ts

@@ -194,3 +194,39 @@ export interface ChainActivityEvent extends ChainItem {
     /** * The timestamp when the address was last seen on the chain. */
     last_seen_at: Date;
 }
+export interface 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[];
+}
+export interface 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;
+}
+export interface OtherFees {
+    /** * The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval. */
+    l1_gas_quote: number;
+}

package/dist/esm/util/types/TransactionServiceTypes.d.ts

@@ -56,11 +56,11 @@ export interface 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. */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { CovalentClient, Client, Chain, Quote, Chains, Quotes, CovalentClientSettings } from "./services/CovalentClient";
+export { CovalentClient, Client, Chain, Quote, CovalentClientSettings } from "./services/CovalentClient";
 export * from "./util/types/BalanceServiceTypes";
 export * from "./util/types/BaseServiceTypes";
 export * from "./util/types/NftServiceTypes";
@@ -9,3 +9,4 @@ export * from "./util/types/GenericTypes";
 export * from "./util/types/TransactionServiceTypes";
 export { calculatePrettyBalance } from "./util/CalculatePrettyBalance";
 export { prettifyCurrency } from "./util/prettifyCurrency";
+export { Chains } from "./util/Chains";

package/dist/index.js

@@ -9,4 +9,5 @@ export * from "./util/types/GenericTypes";
 export * from "./util/types/TransactionServiceTypes";
 export { calculatePrettyBalance } from "./util/CalculatePrettyBalance";
 export { prettifyCurrency } from "./util/prettifyCurrency";
+export { Chains } from "./util/Chains";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAwD,MAAM,2BAA2B,CAAC;AACzH,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAwC,MAAM,2BAA2B,CAAC;AACzG,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC"}

package/dist/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/services/BalanceService.js

@@ -3,6 +3,7 @@ import { checkAndModifyResponse, debugOutput, paginateEndpoint } from "../util/A
 import { parseISO } from "date-fns";
 import { ExponentialBackoff } from "../util/backoff";
 import pLimit from "p-limit";
+import { ApiKeyValidator } from "../util/ApiKeyValidator";
 class BalancesResponse {
     constructor(data) {
         this.address = data.address;
@@ -284,10 +285,11 @@ class NativeBalanceItem {
  *
  */
 export class BalanceService {
-    constructor(apiKey, debug = false, threadCount = 3) {
+    constructor(apiKey, debug = false, threadCount = 3, is_key_valid) {
         this.apiKey = apiKey;
         this.debug = debug;
         this.threadCount = threadCount;
+        this.is_key_valid = is_key_valid;
         this.LIMIT = pLimit(this.threadCount);
     }
     /**
@@ -312,6 +314,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }
@@ -395,6 +405,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }
@@ -471,6 +489,9 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    throw new Error(`An error occurred 401: ${ApiKeyValidator.INVALID_API_KEY_MESSAGE}`);
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }
@@ -523,6 +544,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }
@@ -609,6 +638,9 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    throw new Error(`An error occurred 401: ${ApiKeyValidator.INVALID_API_KEY_MESSAGE}`);
+                }
                 if (queryParamOpts?.blockHeight !== undefined) {
                     urlParams.append("block-height", queryParamOpts?.blockHeight.toString());
                 }
@@ -653,6 +685,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.blockHeight !== undefined) {
                     urlParams.append("block-height", queryParamOpts?.blockHeight.toString());
                 }
@@ -738,6 +778,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }
@@ -825,6 +873,14 @@ export class BalanceService {
         while (!success) {
             try {
                 const urlParams = new URLSearchParams();
+                if (!this.is_key_valid) {
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 401,
+                        error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
+                    };
+                }
                 if (queryParamOpts?.quoteCurrency !== undefined) {
                     urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
                 }