@covalenthq/client-sdk 0.8.3 → 0.8.4

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

@@ -9,7 +9,7 @@ export type Chain = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-mainn
 export type Quote = "USD" | "CAD" | "EUR" | "SGD" | "INR" | "JPY" | "VND" | "CNY" | "KRW" | "RUB" | "TRY" | "NGN" | "ARS" | "AUD" | "CHF" | "GBP";
 export type ChainID = 20090103 | 1 | 137 | 56 | 43114 | 10 | 250 | 1284 | 1285 | 30 | 42161 | 11297108109 | 8217 | 128 | 71402 | 2020 | 9001 | 592 | 4689 | 1666600000 | 25 | 1313161554 | 42262 | 288 | 5 | 80001 | 43113 | 97 | 1287 | 31 | 421613 | 4002 | 11297108099 | 256 | 71401 | 9000 | 336 | 4690 | 1666700000 | 1313161555 | 534354 | 534351 | 1131378225 | 53935 | 73772 | 43288 | 1294 | 56288 | 28 | 1297 | 9728 | 4328 | 1001 | 192837465 | 356256156 | 1564830818 | 278611351 | 432204 | 1026062157 | 432201 | 81 | 338 | 335 | 1088 | 588 | 2002 | 200202 | 2001 | 200101 | 73773 | 1399811149 | 2046399126 | 82 | 83 | 2139927552 | 2888 | 245022926 | 344106930 | 476158412 | 42170 | 7700 | 119 | 1029 | 14 | 114 | 19 | 16 | 321 | 322 | 1422 | 59140 | 84531 | 5001 | 534353 | 248 | 9372 | 2152 | 2154 | 416 | 23294 | 23295 | 420 | 1101 | 1662 | 1024 | 39797 | 49797 | 1663 | 11155111 | 1482601649 | 644937893 | 222000222 | 49321 | 1231 | 1230 | 7777777 | 999 | 245022934 | 2044 | 8453 | 5000 | 262018 | 59144 | 7332 | 10507 | 7979 | 1234 | 1228 | 8888 | 333000333 | 12008 | 12011 | 2038 | 1995 | 12010 | 51178 | 12009 | 12012 | 324 | 599 | 280 | 1343 | 11115 | 6765897100 | 1079 | 13337 | 16350 | 1990 | 20221 | 5611 | 12018 | 12013 | 12020 | 12015 | 12016 | 12014 | 12017 | 12019 | 431234 | 6119 | 73 | 7001 | 42888 | 919 | 5151706 | 923018 | 3441005 | 424 | 58008 | 100 | 10200 | 570 | 57000 | 167007 | 11155420 | 204 | 40 | 41 | 321123 | 360163 | 78431 | 2037 | 17772 | 152703 | 894538 | 179188 | 78432 | 7777 | 986532 | 78430 | 2195 | 11111 | 3012 | 4337 | 534352 | 17000 | 88 | 89 | 20765 | 84532 | 47279324479 | 421614 | 12027 | 12028 | 12029 | 31330 | 31331 | 31332 | 31333 | 31334 | 31335 | 412346 | 8545 | 42220;
 export type Source = "Ponder" | "GoldRush";
-export declare const userAgent = "com.covalenthq.sdk.typescript/0.8.3";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.8.4";
 export declare class Response<T> {
     data: T;
     error: boolean;

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

@@ -411,6 +411,23 @@ declare class TransactionsSummaryResponse {
     items: TransactionsSummary[];
     constructor(data: TransactionsSummaryResponse);
 }
+declare class GasSummary {
+    /** * The total number of transactions sent by the address. */
+    total_sent_count: number;
+    /** * The total transaction fees paid by the address, denoted in wei. */
+    total_fees_paid: bigint | null;
+    /** * The total transaction fees paid by the address, denoted in `quote-currency`. */
+    total_gas_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_total_gas_quote: string;
+    /** * The average gas quote per transaction. */
+    average_gas_quote_per_tx: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_average_gas_quote_per_tx: string;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+    constructor(data: GasSummary);
+}
 declare class TransactionsSummary {
     /** * The total number of transactions. */
     total_count: number;
@@ -418,6 +435,8 @@ declare class TransactionsSummary {
     earliest_transaction: TransactionSummary;
     /** * The latest transaction detected. */
     latest_transaction: TransactionSummary;
+    /** * The gas summary for the transactions. */
+    gas_summary: GasSummary;
     constructor(data: TransactionsSummary);
 }
 declare class TransactionSummary {
@@ -548,6 +567,12 @@ export interface GetTransactionsForBlockHashQueryParamOpts {
     /** * Include safe details. */
     withSafe?: boolean;
 }
+export interface GetTransactionSummaryQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions. */
+    withGas?: boolean;
+}
 export declare class TransactionService {
     private apiKey;
     private debug;
@@ -620,9 +645,12 @@ export declare class TransactionService {
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
      *
      */
-    getTransactionSummary(chainName: Chain | Chains | ChainID, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
+    getTransactionSummary(chainName: Chain | Chains | ChainID, walletAddress: string, queryParamOpts?: GetTransactionSummaryQueryParamOpts): Promise<Response<TransactionsSummaryResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.

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

@@ -56,6 +56,13 @@ declare class Pagination {
     total_count: number;
     constructor(data: Pagination);
 }
+declare class Explorer {
+    /** * The name of the explorer. */
+    label: string;
+    /** * The URL of the explorer. */
+    url: string;
+    constructor(data: Explorer);
+}
 declare class Token {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
@@ -126,6 +133,8 @@ declare class PoolByAddressResponse {
 declare class PoolWithTimeseries {
     /** * The pair address. */
     exchange: string;
+    /** * A list of explorers for this address. */
+    explorers: Explorer[];
     swap_count_24h: string;
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: string;
@@ -246,6 +255,8 @@ declare class PoolsDexDataItem {
     exchange_ticker_symbol: string;
     /** * The dex logo URL for the pair address. */
     exchange_logo_url: string;
+    /** * The list of explorers for the token address. */
+    explorers: Explorer[];
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: number;
     /** * A prettier version of the total liquidity quote for rendering purposes. */
@@ -419,6 +430,8 @@ declare class TokenV2VolumeWithChartData {
     contract_address: string;
     /** * The string returned by the `name()` method. */
     contract_name: string;
+    /** * A list of explorers for this address. */
+    explorers: Explorer[];
     /** * The total liquidity unscaled value. */
     total_liquidity: number;
     /** * The total volume 24h unscaled value. */

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

@@ -331,6 +331,8 @@ export interface TransactionsSummary {
     earliest_transaction: TransactionSummary;
     /** * The latest transaction detected. */
     latest_transaction: TransactionSummary;
+    /** * The gas summary for the transactions. */
+    gas_summary: GasSummary;
 }
 export interface TransactionSummary {
     /** * The block signed timestamp in UTC. */
@@ -368,3 +370,19 @@ export interface TransactionsBlockPageResponse {
     /** * List of response items. */
     items: Transaction[];
 }
+export interface GasSummary {
+    /** * The total number of transactions sent by the address. */
+    total_sent_count: number;
+    /** * The total transaction fees paid by the address, denoted in wei. */
+    total_fees_paid: bigint | null;
+    /** * The total transaction fees paid by the address, denoted in `quote-currency`. */
+    total_gas_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_total_gas_quote: string;
+    /** * The average gas quote per transaction. */
+    average_gas_quote_per_tx: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_average_gas_quote_per_tx: string;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+}

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

@@ -1,4 +1,4 @@
-import { Pagination, ContractMetadata } from "./GenericTypes";
+import { Pagination, ContractMetadata, Explorer } from "./GenericTypes";
 export interface PoolResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -107,6 +107,8 @@ export interface PoolByAddressResponse {
 export interface PoolWithTimeseries {
     /** * The pair address. */
     exchange: string;
+    /** * A list of explorers for this address. */
+    explorers: Explorer[];
     swap_count_24h: string;
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: string;
@@ -222,6 +224,8 @@ export interface PoolsDexDataItem {
     exchange_ticker_symbol: string;
     /** * The dex logo URL for the pair address. */
     exchange_logo_url: string;
+    /** * The list of explorers for the token address. */
+    explorers: Explorer[];
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: number;
     /** * A prettier version of the total liquidity quote for rendering purposes. */
@@ -384,6 +388,8 @@ export interface TokenV2VolumeWithChartData {
     dex_name: string;
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
+    /** * The list of explorers for the token address. */
+    explorers: Explorer[];
     /** * The string returned by the `name()` method. */
     contract_name: string;
     /** * The total liquidity unscaled value. */

package/dist/services/CovalentClient.d.ts

@@ -9,7 +9,7 @@ export type Chain = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-mainn
 export type Quote = "USD" | "CAD" | "EUR" | "SGD" | "INR" | "JPY" | "VND" | "CNY" | "KRW" | "RUB" | "TRY" | "NGN" | "ARS" | "AUD" | "CHF" | "GBP";
 export type ChainID = 20090103 | 1 | 137 | 56 | 43114 | 10 | 250 | 1284 | 1285 | 30 | 42161 | 11297108109 | 8217 | 128 | 71402 | 2020 | 9001 | 592 | 4689 | 1666600000 | 25 | 1313161554 | 42262 | 288 | 5 | 80001 | 43113 | 97 | 1287 | 31 | 421613 | 4002 | 11297108099 | 256 | 71401 | 9000 | 336 | 4690 | 1666700000 | 1313161555 | 534354 | 534351 | 1131378225 | 53935 | 73772 | 43288 | 1294 | 56288 | 28 | 1297 | 9728 | 4328 | 1001 | 192837465 | 356256156 | 1564830818 | 278611351 | 432204 | 1026062157 | 432201 | 81 | 338 | 335 | 1088 | 588 | 2002 | 200202 | 2001 | 200101 | 73773 | 1399811149 | 2046399126 | 82 | 83 | 2139927552 | 2888 | 245022926 | 344106930 | 476158412 | 42170 | 7700 | 119 | 1029 | 14 | 114 | 19 | 16 | 321 | 322 | 1422 | 59140 | 84531 | 5001 | 534353 | 248 | 9372 | 2152 | 2154 | 416 | 23294 | 23295 | 420 | 1101 | 1662 | 1024 | 39797 | 49797 | 1663 | 11155111 | 1482601649 | 644937893 | 222000222 | 49321 | 1231 | 1230 | 7777777 | 999 | 245022934 | 2044 | 8453 | 5000 | 262018 | 59144 | 7332 | 10507 | 7979 | 1234 | 1228 | 8888 | 333000333 | 12008 | 12011 | 2038 | 1995 | 12010 | 51178 | 12009 | 12012 | 324 | 599 | 280 | 1343 | 11115 | 6765897100 | 1079 | 13337 | 16350 | 1990 | 20221 | 5611 | 12018 | 12013 | 12020 | 12015 | 12016 | 12014 | 12017 | 12019 | 431234 | 6119 | 73 | 7001 | 42888 | 919 | 5151706 | 923018 | 3441005 | 424 | 58008 | 100 | 10200 | 570 | 57000 | 167007 | 11155420 | 204 | 40 | 41 | 321123 | 360163 | 78431 | 2037 | 17772 | 152703 | 894538 | 179188 | 78432 | 7777 | 986532 | 78430 | 2195 | 11111 | 3012 | 4337 | 534352 | 17000 | 88 | 89 | 20765 | 84532 | 47279324479 | 421614 | 12027 | 12028 | 12029 | 31330 | 31331 | 31332 | 31333 | 31334 | 31335 | 412346 | 8545 | 42220;
 export type Source = "Ponder" | "GoldRush";
-export declare const userAgent = "com.covalenthq.sdk.typescript/0.8.3";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.8.4";
 export declare class Response<T> {
     data: T;
     error: boolean;

package/dist/services/CovalentClient.js

@@ -6,7 +6,7 @@ import { PricingService } from "./PricingService";
 import { TransactionService } from "./TransactionService";
 import { XykService } from "./XykService";
 import { ApiKeyValidator } from "../util/ApiKeyValidator";
-export const userAgent = "com.covalenthq.sdk.typescript/0.8.3";
+export const userAgent = "com.covalenthq.sdk.typescript/0.8.4";
 export class Response {
 }
 /**

package/dist/services/TransactionService.d.ts

@@ -411,6 +411,23 @@ declare class TransactionsSummaryResponse {
     items: TransactionsSummary[];
     constructor(data: TransactionsSummaryResponse);
 }
+declare class GasSummary {
+    /** * The total number of transactions sent by the address. */
+    total_sent_count: number;
+    /** * The total transaction fees paid by the address, denoted in wei. */
+    total_fees_paid: bigint | null;
+    /** * The total transaction fees paid by the address, denoted in `quote-currency`. */
+    total_gas_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_total_gas_quote: string;
+    /** * The average gas quote per transaction. */
+    average_gas_quote_per_tx: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_average_gas_quote_per_tx: string;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+    constructor(data: GasSummary);
+}
 declare class TransactionsSummary {
     /** * The total number of transactions. */
     total_count: number;
@@ -418,6 +435,8 @@ declare class TransactionsSummary {
     earliest_transaction: TransactionSummary;
     /** * The latest transaction detected. */
     latest_transaction: TransactionSummary;
+    /** * The gas summary for the transactions. */
+    gas_summary: GasSummary;
     constructor(data: TransactionsSummary);
 }
 declare class TransactionSummary {
@@ -548,6 +567,12 @@ export interface GetTransactionsForBlockHashQueryParamOpts {
     /** * Include safe details. */
     withSafe?: boolean;
 }
+export interface GetTransactionSummaryQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions. */
+    withGas?: boolean;
+}
 export declare class TransactionService {
     private apiKey;
     private debug;
@@ -620,9 +645,12 @@ export declare class TransactionService {
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
      *
      */
-    getTransactionSummary(chainName: Chain | Chains | ChainID, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
+    getTransactionSummary(chainName: Chain | Chains | ChainID, walletAddress: string, queryParamOpts?: GetTransactionSummaryQueryParamOpts): Promise<Response<TransactionsSummaryResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.

package/dist/services/TransactionService.js

@@ -541,11 +541,23 @@ class TransactionsSummaryResponse {
         this.items = data.items && data.items !== null ? data.items.map((itemData) => new TransactionsSummary(itemData)) : null;
     }
 }
+class GasSummary {
+    constructor(data) {
+        this.total_sent_count = data.total_sent_count;
+        this.total_fees_paid = data.total_fees_paid && data.total_fees_paid !== null ? BigInt(data.total_fees_paid) : null;
+        this.total_gas_quote = data.total_gas_quote;
+        this.pretty_total_gas_quote = data.pretty_total_gas_quote;
+        this.average_gas_quote_per_tx = data.average_gas_quote_per_tx;
+        this.pretty_average_gas_quote_per_tx = data.pretty_average_gas_quote_per_tx;
+        this.gas_metadata = data.gas_metadata && data.gas_metadata !== null ? new ContractMetadata(data.gas_metadata) : null;
+    }
+}
 class TransactionsSummary {
     constructor(data) {
         this.total_count = data.total_count;
         this.earliest_transaction = data.earliest_transaction && data.earliest_transaction !== null ? new TransactionSummary(data.earliest_transaction) : null;
         this.latest_transaction = data.latest_transaction && data.latest_transaction !== null ? new TransactionSummary(data.latest_transaction) : null;
+        this.gas_summary = data.gas_summary && data.gas_summary !== null ? new GasSummary(data.gas_summary) : null;
     }
 }
 class TransactionSummary {
@@ -1258,9 +1270,12 @@ export class TransactionService {
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
      *
      */
-    async getTransactionSummary(chainName, walletAddress) {
+    async getTransactionSummary(chainName, walletAddress, queryParamOpts) {
         let success = false;
         let data;
         let response;
@@ -1276,6 +1291,12 @@ export class TransactionService {
                         error_message: ApiKeyValidator.INVALID_API_KEY_MESSAGE
                     };
                 }
+                if (queryParamOpts?.quoteCurrency !== undefined) {
+                    urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
+                }
+                if (queryParamOpts?.withGas !== undefined) {
+                    urlParams.append("with-gas", queryParamOpts?.withGas.toString());
+                }
                 let startTime;
                 if (this.debug) {
                     startTime = new Date();