@covalenthq/client-sdk 0.7.3 → 0.7.4

package/dist/cjs/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-l2-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" | "avalanche-hubble-exchange-testnet" | "avalanche-miho-testnet" | "avalanche-bulletin-testnet" | "avalanche-kiwi-testnet" | "avalanche-hero-testnet" | "avalanche-avacloud-testnet" | "avalanche-thirdweb-testnet" | "avalanche-mondrian-testnet" | "avalanche-conduit-testnet" | "avalanche-nmac-testnet" | "avalanche-orderly-testnet" | "avalanche-amplify-testnet" | "avalanche-mirai-testnet" | "avalanche-wagmi-testnet" | "avalanche-playa3ull-testnet" | "avalanche-beam-mainnet" | "scroll-mainnet" | "eth-holesky";
 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.7.3";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.7.4";
 export declare class Response<T> {
     data: T;
     error: boolean;

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

@@ -25,6 +25,14 @@ declare class Pool {
     total_supply: bigint | null;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the volume 24h quote for rendering purposes. */
+    pretty_volume_24h_quote: string;
+    /** * A prettier version of the fee 24h quote for rendering purposes. */
+    pretty_fee_24h_quote: string;
+    /** * A prettier version of the volume 7d quote for rendering purposes. */
+    pretty_volume_7d_quote: string;
     /** * The requested chain name eg: `eth-mainnet`. */
     chain_name: string;
     /** * The requested chain ID eg: `1`. */
@@ -88,6 +96,10 @@ declare class SupportedDex {
     chain_name: string;
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
+    /** * A display-friendly name for the dex. */
+    display_name: string;
+    /** * The dex logo URL. */
+    logo_url: string;
     factory_contract_address: string;
     router_contract_addresses: string;
     swap_fee: number;
@@ -129,6 +141,14 @@ declare class PoolWithTimeseries {
     dex_name: string;
     volume_7d_quote: string;
     annualized_fee: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the volume 24h quote for rendering purposes. */
+    pretty_volume_24h_quote: string;
+    /** * A prettier version of the fee 24h quote for rendering purposes. */
+    pretty_fee_24h_quote: string;
+    /** * A prettier version of the volume 7d quote for rendering purposes. */
+    pretty_volume_7d_quote: string;
     token_0: Token;
     token_1: Token;
     token_0_reserve_quote: string;
@@ -149,11 +169,13 @@ declare class VolumeTimeseries {
     dt: string;
     /** * The pair address. */
     exchange: string;
-    sum_amount_0_in: string;
-    sum_amount_0_out: string;
-    sum_amount_1_in: string;
-    sum_amount_1_out: string;
+    sum_amount0in: string;
+    sum_amount0out: string;
+    sum_amount1in: string;
+    sum_amount1out: string;
     volume_quote: string;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
     token_0_quote_rate: string;
     token_1_quote_rate: string;
     swap_count_24: string;
@@ -170,6 +192,8 @@ declare class LiquidityTimeseries {
     r0_c: string;
     r1_c: string;
     liquidity_quote: string;
+    /** * A prettier version of the liquidity quote for rendering purposes. */
+    pretty_liquidity_quote: string;
     token_0_quote_rate: string;
     token_1_quote_rate: string;
     constructor(data: LiquidityTimeseries);
@@ -182,14 +206,18 @@ declare class PriceTimeseries {
     dt: string;
     /** * The pair address. */
     exchange: string;
-    price_of_token_0_in_token_1: string;
-    price_of_token_0_in_token_1_description: string;
-    price_of_token_1_in_token_0: string;
-    price_of_token_1_in_token_0_description: string;
+    price_of_token0_in_token1: string;
+    /** * A prettier version of the price token0 for rendering purposes. */
+    pretty_price_of_token0_in_token1: string;
+    price_of_token0_in_token1_description: string;
+    price_of_token1_in_token0: string;
+    /** * A prettier version of the price token1 for rendering purposes. */
+    pretty_price_of_token1_in_token0: string;
+    price_of_token1_in_token0_description: string;
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
-    price_of_token_0_in_quote_currency: string;
-    price_of_token_1_in_quote_currency: string;
+    price_of_token0_in_quote_currency: string;
+    price_of_token1_in_quote_currency: string;
     constructor(data: PriceTimeseries);
 }
 declare class PoolsDexDataResponse {
@@ -345,8 +373,19 @@ declare class TokenV2Volume {
     swap_count_24h: number;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
+    /** * The 24h exchange rate for the requested quote currency. */
+    quote_rate_24h: number;
+    /** * A prettier version of the exchange rate for rendering purposes. */
+    pretty_quote_rate: string;
+    /** * A prettier version of the 24h exchange rate for rendering purposes. */
+    pretty_quote_rate_24h: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the 24h volume quote for rendering purposes. */
+    pretty_total_volume_24h_quote: string;
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: number;
+    /** * The total volume 24h converted to fiat in `quote-currency`. */
     total_volume_24h_quote: number;
     constructor(data: TokenV2Volume);
 }
@@ -402,6 +441,8 @@ declare class ExchangeTransaction {
     from_address: string;
     sender_address: string;
     total_quote: number;
+    /** * A prettier version of the total quote for rendering purposes. */
+    pretty_total_quote: string;
     token_0: PoolToken;
     token_1: PoolToken;
     token_0_quote_rate: number;

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

@@ -23,6 +23,14 @@ export interface Pool {
     total_supply: bigint | null;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the volume 24h quote for rendering purposes. */
+    pretty_volume_24h_quote: string;
+    /** * A prettier version of the fee 24h quote for rendering purposes. */
+    pretty_fee_24h_quote: string;
+    /** * A prettier version of the volume 7d quote for rendering purposes. */
+    pretty_volume_7d_quote: string;
     /** * The requested chain name eg: `eth-mainnet`. */
     chain_name: string;
     /** * The requested chain ID eg: `1`. */
@@ -76,6 +84,10 @@ export interface SupportedDex {
     chain_name: string;
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
+    /** * A display-friendly name for the dex. */
+    display_name: string;
+    /** * The dex logo URL. */
+    logo_url: string;
     factory_contract_address: string;
     router_contract_addresses: string;
     swap_fee: number;
@@ -110,6 +122,14 @@ export interface PoolWithTimeseries {
     dex_name: string;
     volume_7d_quote: string;
     annualized_fee: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the volume 24h quote for rendering purposes. */
+    pretty_volume_24h_quote: string;
+    /** * A prettier version of the fee 24h quote for rendering purposes. */
+    pretty_fee_24h_quote: string;
+    /** * A prettier version of the volume 7d quote for rendering purposes. */
+    pretty_volume_7d_quote: string;
     token_0: Token;
     token_1: Token;
     token_0_reserve_quote: string;
@@ -129,11 +149,13 @@ export interface VolumeTimeseries {
     dt: string;
     /** * The pair address. */
     exchange: string;
-    sum_amount_0_in: string;
-    sum_amount_0_out: string;
-    sum_amount_1_in: string;
-    sum_amount_1_out: string;
+    sum_amount0in: string;
+    sum_amount0out: string;
+    sum_amount1in: string;
+    sum_amount1out: string;
     volume_quote: string;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
     token_0_quote_rate: string;
     token_1_quote_rate: string;
     swap_count_24: string;
@@ -149,6 +171,8 @@ export interface LiquidityTimeseries {
     r0_c: string;
     r1_c: string;
     liquidity_quote: string;
+    /** * A prettier version of the liquidity quote for rendering purposes. */
+    pretty_liquidity_quote: string;
     token_0_quote_rate: string;
     token_1_quote_rate: string;
 }
@@ -160,14 +184,18 @@ export interface PriceTimeseries {
     dt: string;
     /** * The pair address. */
     exchange: string;
-    price_of_token_0_in_token_1: string;
-    price_of_token_0_in_token_1_description: string;
-    price_of_token_1_in_token_0: string;
-    price_of_token_1_in_token_0_description: string;
+    price_of_token0_in_token1: string;
+    /** * A prettier version of the price token0 for rendering purposes. */
+    pretty_price_of_token0_in_token1: string;
+    price_of_token0_in_token1_description: string;
+    price_of_token1_in_token0: string;
+    /** * A prettier version of the price token1 for rendering purposes. */
+    pretty_price_of_token1_in_token0: string;
+    price_of_token1_in_token0_description: string;
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
-    price_of_token_0_in_quote_currency: string;
-    price_of_token_1_in_quote_currency: string;
+    price_of_token0_in_quote_currency: string;
+    price_of_token1_in_quote_currency: string;
 }
 export interface PoolsDexDataResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -314,8 +342,19 @@ export interface TokenV2Volume {
     swap_count_24h: number;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
+    /** * The 24h exchange rate for the requested quote currency. */
+    quote_rate_24h: number;
+    /** * A prettier version of the exchange rate for rendering purposes. */
+    pretty_quote_rate: string;
+    /** * A prettier version of the 24h exchange rate for rendering purposes. */
+    pretty_quote_rate_24h: string;
+    /** * A prettier version of the total liquidity quote for rendering purposes. */
+    pretty_total_liquidity_quote: string;
+    /** * A prettier version of the 24h volume quote for rendering purposes. */
+    pretty_total_volume_24h_quote: string;
     /** * The total liquidity converted to fiat in `quote-currency`. */
     total_liquidity_quote: number;
+    /** * The total volume 24h converted to fiat in `quote-currency`. */
     total_volume_24h_quote: number;
 }
 export interface SupportedDexesResponse {
@@ -367,6 +406,8 @@ export interface ExchangeTransaction {
     from_address: string;
     sender_address: string;
     total_quote: number;
+    /** * A prettier version of the total quote for rendering purposes. */
+    pretty_total_quote: string;
     token_0: PoolToken;
     token_1: PoolToken;
     token_0_quote_rate: number;

package/dist/es/index.js

@@ -5590,6 +5590,10 @@ class Pool {
         this.fee_24h_quote = data.fee_24h_quote;
         this.total_supply = data.total_supply && data.total_supply !== null ? BigInt(data.total_supply) : null;
         this.quote_rate = data.quote_rate;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_volume_24h_quote = data.pretty_volume_24h_quote;
+        this.pretty_fee_24h_quote = data.pretty_fee_24h_quote;
+        this.pretty_volume_7d_quote = data.pretty_volume_7d_quote;
         this.chain_name = data.chain_name;
         this.chain_id = data.chain_id;
         this.dex_name = data.dex_name;
@@ -5636,6 +5640,8 @@ class SupportedDex {
         this.chain_id = data.chain_id;
         this.chain_name = data.chain_name;
         this.dex_name = data.dex_name;
+        this.display_name = data.display_name;
+        this.logo_url = data.logo_url;
         this.factory_contract_address = data.factory_contract_address;
         this.router_contract_addresses = data.router_contract_addresses;
         this.swap_fee = data.swap_fee;
@@ -5669,6 +5675,10 @@ class PoolWithTimeseries {
         this.dex_name = data.dex_name;
         this.volume_7d_quote = data.volume_7d_quote;
         this.annualized_fee = data.annualized_fee;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_volume_24h_quote = data.pretty_volume_24h_quote;
+        this.pretty_fee_24h_quote = data.pretty_fee_24h_quote;
+        this.pretty_volume_7d_quote = data.pretty_volume_7d_quote;
         this.token_0_reserve_quote = data.token_0_reserve_quote;
         this.token_1_reserve_quote = data.token_1_reserve_quote;
         this.token_0 = data.token_0 && data.token_0 !== null ? new Token(data.token_0) : null;
@@ -5687,11 +5697,12 @@ class VolumeTimeseries {
         this.chain_id = data.chain_id;
         this.dt = data.dt;
         this.exchange = data.exchange;
-        this.sum_amount_0_in = data.sum_amount_0_in;
-        this.sum_amount_0_out = data.sum_amount_0_out;
-        this.sum_amount_1_in = data.sum_amount_1_in;
-        this.sum_amount_1_out = data.sum_amount_1_out;
+        this.sum_amount0in = data.sum_amount0in;
+        this.sum_amount0out = data.sum_amount0out;
+        this.sum_amount1in = data.sum_amount1in;
+        this.sum_amount1out = data.sum_amount1out;
         this.volume_quote = data.volume_quote;
+        this.pretty_volume_quote = data.pretty_volume_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
         this.swap_count_24 = data.swap_count_24;
@@ -5706,6 +5717,7 @@ class LiquidityTimeseries {
         this.r0_c = data.r0_c;
         this.r1_c = data.r1_c;
         this.liquidity_quote = data.liquidity_quote;
+        this.pretty_liquidity_quote = data.pretty_liquidity_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
     }
@@ -5716,13 +5728,15 @@ class PriceTimeseries {
         this.chain_id = data.chain_id;
         this.dt = data.dt;
         this.exchange = data.exchange;
-        this.price_of_token_0_in_token_1 = data.price_of_token_0_in_token_1;
-        this.price_of_token_0_in_token_1_description = data.price_of_token_0_in_token_1_description;
-        this.price_of_token_1_in_token_0 = data.price_of_token_1_in_token_0;
-        this.price_of_token_1_in_token_0_description = data.price_of_token_1_in_token_0_description;
+        this.price_of_token0_in_token1 = data.price_of_token0_in_token1;
+        this.pretty_price_of_token0_in_token1 = data.pretty_price_of_token0_in_token1;
+        this.price_of_token0_in_token1_description = data.price_of_token0_in_token1_description;
+        this.price_of_token1_in_token0 = data.price_of_token1_in_token0;
+        this.pretty_price_of_token1_in_token0 = data.pretty_price_of_token1_in_token0;
+        this.price_of_token1_in_token0_description = data.price_of_token1_in_token0_description;
         this.quote_currency = data.quote_currency;
-        this.price_of_token_0_in_quote_currency = data.price_of_token_0_in_quote_currency;
-        this.price_of_token_1_in_quote_currency = data.price_of_token_1_in_quote_currency;
+        this.price_of_token0_in_quote_currency = data.price_of_token0_in_quote_currency;
+        this.price_of_token1_in_quote_currency = data.price_of_token1_in_quote_currency;
     }
 }
 class PoolsDexDataResponse {
@@ -5827,6 +5841,11 @@ class TokenV2Volume {
         this.contract_decimals = data.contract_decimals;
         this.swap_count_24h = data.swap_count_24h;
         this.quote_rate = data.quote_rate;
+        this.quote_rate_24h = data.quote_rate_24h;
+        this.pretty_quote_rate = data.pretty_quote_rate;
+        this.pretty_quote_rate_24h = data.pretty_quote_rate_24h;
+        this.pretty_total_liquidity_quote = data.pretty_total_liquidity_quote;
+        this.pretty_total_volume_24h_quote = data.pretty_total_volume_24h_quote;
         this.total_liquidity_quote = data.total_liquidity_quote;
         this.total_volume_24h_quote = data.total_volume_24h_quote;
     }
@@ -5871,6 +5890,7 @@ class ExchangeTransaction {
         this.from_address = data.from_address;
         this.sender_address = data.sender_address;
         this.total_quote = data.total_quote;
+        this.pretty_total_quote = data.pretty_total_quote;
         this.token_0_quote_rate = data.token_0_quote_rate;
         this.token_1_quote_rate = data.token_1_quote_rate;
         this.token_0 = data.token_0 && data.token_0 !== null ? new PoolToken(data.token_0) : null;
@@ -7027,7 +7047,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.7.3";
+const userAgent = "com.covalenthq.sdk.typescript/0.7.4";
 /**
  * CovalentClient Class
  */