@covalenthq/client-sdk 0.6.7 → 0.7.0

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

@@ -483,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.

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

@@ -1,4 +1,4 @@
-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. */
@@ -266,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;
@@ -312,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
  *
@@ -320,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.
@@ -463,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,7 +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";
-export declare const userAgent = "com.covalenthq.sdk.typescript/0.6.7";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.7.0";
 export declare class Response<T> {
     data: T;
     error: boolean;
@@ -31,6 +31,7 @@ export declare class CovalentClient {
     PricingService: PricingService;
     TransactionService: TransactionService;
     XykService: XykService;
+    private _is_key_valid;
     constructor(apiKey: string, settings?: CovalentClientSettings);
 }
 /**
@@ -47,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

@@ -483,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.

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

@@ -69,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.

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

@@ -136,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.

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

@@ -58,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. */
@@ -477,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.

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

@@ -544,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).

package/dist/es/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/es/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/es/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. */