@covalenthq/client-sdk 0.9.4 → 0.9.6

package/dist/util/types/BalanceServiceTypes.d.ts

@@ -1,4 +1,4 @@
-import { NftData, Pagination, Explorer, ContractMetadata, LogoUrls } from "./GenericTypes";
+import { Pagination, Explorer, ContractMetadata, LogoUrls, NftCollectionAttribute } from "./GenericTypes";
 export interface BalancesResponse {
     /** * The requested address. */
     address: string;
@@ -25,7 +25,7 @@ export interface BalanceItem {
     /** * A display-friendly name for the contract. */
     contract_display_name: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
     /** * The contract logo URLs. */
@@ -57,12 +57,47 @@ export interface BalanceItem {
     /** * The protocol metadata. */
     protocol_metadata: ProtocolMetadata;
     /** * NFT-specific data. */
-    nft_data: NftData[];
+    nft_data: BalanceNftData[];
 }
 export interface ProtocolMetadata {
     /** * The name of the protocol. */
     protocol_name: string;
 }
+export interface BalanceNftData {
+    /** * The token's id. */
+    token_id: bigint | null;
+    /** * The count of the number of NFTs with this ID. */
+    token_balance: bigint | null;
+    /** * External URL for additional metadata. */
+    token_url: string;
+    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
+    supports_erc: string[];
+    /** * The latest price value on chain of the token ID. */
+    token_price_wei: bigint | null;
+    /** * The latest quote_rate of the token ID denominated in unscaled ETH. */
+    token_quote_rate_eth: string;
+    /** * The address of the original owner of this NFT. */
+    original_owner: string;
+    external_data: NftExternalDataV1;
+    /** * The current owner of this NFT. */
+    owner: string;
+    /** * The address of the current owner of this NFT. */
+    owner_address: string;
+    /** * When set to true, this NFT has been Burned. */
+    burned: boolean;
+}
+export interface NftExternalDataV1 {
+    name: string;
+    description: string;
+    image: string;
+    image_256: string;
+    image_512: string;
+    image_1024: string;
+    animation_url: string;
+    external_url: string;
+    attributes: NftCollectionAttribute[];
+    owner: string;
+}
 export interface PortfolioResponse {
     /** * The requested address. */
     address: string;
@@ -238,7 +273,7 @@ export interface TokenHolder {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
     /** * The requested address. */
@@ -274,13 +309,14 @@ export interface HistoricalBalanceItem {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
     /** * The height of the block. */
     block_height: number;
     /** * The block height when the token was last transferred. */
     last_transferred_block_height: number;
+    contract_display_name: string;
     /** * The timestamp when the token was transferred. */
     last_transferred_at: Date;
     /** * Indicates if a token is the chain's native gas token, eg: ETH on Ethereum. */
@@ -297,8 +333,10 @@ export interface HistoricalBalanceItem {
     quote: number;
     /** * A prettier version of the quote for rendering purposes. */
     pretty_quote: string;
+    /** * The protocol metadata. */
+    protocol_metadata: ProtocolMetadata;
     /** * NFT-specific data. */
-    nft_data: NftData[];
+    nft_data: BalanceNftData[];
 }
 export interface TokenBalanceNativeResponse {
     /** * The requested address. */
@@ -324,7 +362,7 @@ export interface NativeBalanceItem {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
     /** * The height of the block. */

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

@@ -54,10 +54,16 @@ export interface BlockHeightsResponse {
     /** * The requested chain name eg: `eth-mainnet`. */
     chain_name: string;
     /** * List of response items. */
-    items: Block[];
+    items: BlockHeights[];
     /** * Pagination metadata. */
     pagination: Pagination;
 }
+export interface BlockHeights {
+    /** * The block signed timestamp in UTC. */
+    signed_at: Date;
+    /** * The block height. */
+    height: number;
+}
 export interface GetLogsResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;

package/dist/util/types/GenericTypes.d.ts

@@ -18,6 +18,8 @@ export interface NftData {
     token_url: string;
     /** * The original minter. */
     original_owner: string;
+    /** * The current holder of this NFT. */
+    current_owner: string;
     external_data: NftExternalData;
     /** * If `true`, the asset data is available from the Covalent CDN. */
     asset_cached: boolean;

package/dist/util/types/NftServiceTypes.d.ts

@@ -39,13 +39,13 @@ export interface NftTokenContractBalanceItem {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
     is_spam: boolean;
     last_transfered_at: Date;
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
     balance: bigint | null;
-    balance_24h: number;
+    balance_24h: string;
     type: string;
     /** * The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on. */
     floor_price_quote: number;
@@ -97,7 +97,7 @@ export interface NftTransaction {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     nft_transactions: NftTransactionItem[];
     /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
     is_spam: boolean;
@@ -127,11 +127,11 @@ export interface NftTransactionItem {
     value_quote: number;
     /** * A prettier version of the quote for rendering purposes. */
     pretty_value_quote: string;
-    gas_offered: string;
+    gas_offered: number;
     /** * The gas spent for this tx. */
-    gas_spent: string;
+    gas_spent: number;
     /** * The gas price at the time of this tx. */
-    gas_price: string;
+    gas_price: number;
     /** * The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei. */
     fees_paid: bigint | null;
     /** * The gas spent in `quote-currency` denomination. */
@@ -217,11 +217,11 @@ export interface NftOwnershipForCollectionItem {
     /** * The token's id. */
     token_id: bigint | null;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     last_transfered_at: Date;
     /** * Nft balance. */
     balance: bigint | null;
-    balance_24h: number;
+    balance_24h: string;
     type: string;
     nft_data: NftData;
 }

package/dist/util/types/PricingServiceTypes.d.ts

@@ -9,7 +9,7 @@ export interface TokenPricesResponse {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string;
+    supports_erc: string[];
     /** * The contract logo URL. */
     logo_url: string;
     update_at: Date;

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

@@ -40,11 +40,11 @@ export interface Transaction {
     pretty_value_quote: string;
     /** * The requested chain native gas token metadata. */
     gas_metadata: ContractMetadata;
-    gas_offered: string;
+    gas_offered: number;
     /** * The gas spent for this tx. */
-    gas_spent: string;
+    gas_spent: number;
     /** * The gas price at the time of this tx. */
-    gas_price: string;
+    gas_price: number;
     /** * The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei. */
     fees_paid: bigint | null;
     /** * The gas spent in `quote-currency` denomination. */
@@ -73,7 +73,7 @@ export interface DexReport {
     protocol_name: string;
     /** * Stores the contract address of the protocol that facilitated the event. */
     protocol_address: string;
-    /** * Stores the URL of the logo for the protocol that facilitated the event. */
+    /** * The protocol logo URL. */
     protocol_logo_url: string;
     /** * Stores the aggregator responsible for the event. */
     aggregator_name: string;
@@ -94,7 +94,7 @@ export interface DexReport {
     lp_token_ticker: string;
     lp_token_num_decimals: number;
     lp_token_name: string;
-    lp_token_value: number;
+    lp_token_value: string;
     exchange_rate_usd: number;
     /** * Stores the address of token 0 in the specific pair. */
     token_0_address: string;
@@ -113,13 +113,13 @@ export interface DexReport {
     /** * Stores the contract name of token 1 in the specific pair. */
     token_1_name: string;
     /** * Stores the amount of token 0 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
-    token_0_amount: number;
+    token_0_amount: string;
     token_0_quote_rate: number;
     token_0_usd_quote: number;
     pretty_token_0_usd_quote: string;
     token_0_logo_url: string;
     /** * Stores the amount of token 1 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
-    token_1_amount: number;
+    token_1_amount: string;
     token_1_quote_rate: number;
     token_1_usd_quote: number;
     pretty_token_1_usd_quote: string;
@@ -138,7 +138,7 @@ export interface NftSalesReport {
     protocol_contract_address: string;
     /** * Stores the name of the protocol that facilitated the event. */
     protocol_name: string;
-    /** * Stores the URL of the logo for the protocol that facilitated the event. */
+    /** * The protocol logo URL. */
     protocol_logo_url: string;
     /** * Stores the address of the transaction recipient. */
     to: string;
@@ -149,7 +149,7 @@ export interface NftSalesReport {
     /** * Stores the address buying the NFT. */
     taker: string;
     /** * Stores the NFTs token ID. All NFTs have a token ID. Within a collection, these token IDs are unique. If the NFT is transferred to another owner, the token id remains the same, as this number is its identifier within a collection. For example, if a collection has 10K NFTs then an NFT in that collection can have a token ID from 1-10K. */
-    token_id: number;
+    token_id: string;
     /** * Stores the address of the collection. For example, [Bored Ape Yacht Club](https://etherscan.io/token/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d) */
     collection_address: string;
     /** * Stores the name of the collection. */
@@ -187,7 +187,7 @@ export interface LendingReport {
     protocol_name: string;
     /** * Stores the contract address of the lending protocol that facilitated the event. */
     protocol_address: string;
-    /** * Stores the logo URL of the lending protocol that facilitated the event. */
+    /** * The protocol logo URL. */
     protocol_logo_url: string;
     /** * Lending protocols often have multiple version (e.g. Aave V1, V2 and V3). The `version` field allows you to look at a specific version of the Lending protocol. */
     version: string;

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

@@ -14,15 +14,15 @@ export interface PoolResponse {
 export interface Pool {
     /** * The pair address. */
     exchange: string;
-    swap_count_24h: string;
+    swap_count_24h: number;
     /** * The total liquidity converted to fiat in `quote-currency`. */
-    total_liquidity_quote: string;
-    volume_24h_quote: string;
-    fee_24h_quote: string;
+    total_liquidity_quote: number;
+    volume_24h_quote: number;
+    fee_24h_quote: number;
     /** * Total supply of this pool token. */
     total_supply: bigint | null;
     /** * The exchange rate for the requested quote currency. */
-    quote_rate: string;
+    quote_rate: number;
     /** * 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. */
@@ -37,8 +37,8 @@ export interface Pool {
     chain_id: string;
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
-    volume_7d_quote: string;
-    annualized_fee: string;
+    volume_7d_quote: number;
+    annualized_fee: number;
     token_0: Token;
     token_1: Token;
 }
@@ -50,14 +50,14 @@ export interface Token {
     volume_in_24h: string;
     volume_out_24h: string;
     /** * The exchange rate for the requested quote currency. */
-    quote_rate: string;
+    quote_rate: number;
     reserve: string;
     /** * The contract logo URL. */
     logo_url: string;
     /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
     contract_ticker_symbol: string;
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
-    contract_decimals: string;
+    contract_decimals: number;
     volume_in_7d: string;
     volume_out_7d: string;
 }
@@ -89,7 +89,7 @@ export interface SupportedDex {
     /** * The dex logo URL. */
     logo_url: string;
     factory_contract_address: string;
-    router_contract_addresses: string;
+    router_contract_addresses: string[];
     swap_fee: number;
 }
 export interface PoolByAddressResponse {
@@ -109,21 +109,21 @@ export interface PoolWithTimeseries {
     exchange: string;
     /** * A list of explorers for this address. */
     explorers: Explorer[];
-    swap_count_24h: string;
+    swap_count_24h: number;
     /** * The total liquidity converted to fiat in `quote-currency`. */
-    total_liquidity_quote: string;
-    volume_24h_quote: string;
-    fee_24h_quote: string;
+    total_liquidity_quote: number;
+    volume_24h_quote: number;
+    fee_24h_quote: number;
     /** * Total supply of this pool token. */
     total_supply: bigint | null;
     /** * The exchange rate for the requested quote currency. */
-    quote_rate: string;
+    quote_rate: number;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
-    volume_7d_quote: string;
-    annualized_fee: string;
+    volume_7d_quote: number;
+    annualized_fee: number;
     /** * 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. */
@@ -134,8 +134,8 @@ export interface PoolWithTimeseries {
     pretty_volume_7d_quote: string;
     token_0: Token;
     token_1: Token;
-    token_0_reserve_quote: string;
-    token_1_reserve_quote: string;
+    token_0_reserve_quote: number;
+    token_1_reserve_quote: number;
     volume_timeseries_7d: VolumeTimeseries[];
     volume_timeseries_30d: VolumeTimeseries[];
     liquidity_timeseries_7d: LiquidityTimeseries[];
@@ -148,56 +148,56 @@ export interface VolumeTimeseries {
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    dt: string;
+    dt: Date;
     /** * The pair address. */
     exchange: string;
     sum_amount0in: string;
     sum_amount0out: string;
     sum_amount1in: string;
     sum_amount1out: string;
-    volume_quote: string;
+    volume_quote: number;
     /** * 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;
+    token_0_quote_rate: number;
+    token_1_quote_rate: number;
+    swap_count_24: number;
 }
 export interface LiquidityTimeseries {
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    dt: string;
+    dt: Date;
     /** * The pair address. */
     exchange: string;
     r0_c: string;
     r1_c: string;
-    liquidity_quote: string;
+    liquidity_quote: number;
     /** * A prettier version of the liquidity quote for rendering purposes. */
     pretty_liquidity_quote: string;
-    token_0_quote_rate: string;
-    token_1_quote_rate: string;
+    token_0_quote_rate: number;
+    token_1_quote_rate: number;
 }
 export interface PriceTimeseries {
     /** * The name of the DEX, eg: `uniswap_v2`. */
     dex_name: string;
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
-    dt: string;
+    dt: Date;
     /** * The pair address. */
     exchange: string;
-    price_of_token0_in_token1: string;
+    price_of_token0_in_token1: number;
     /** * 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;
+    price_of_token1_in_token0: number;
     /** * 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_token0_in_quote_currency: string;
-    price_of_token1_in_quote_currency: string;
+    price_of_token0_in_quote_currency: number;
+    price_of_token1_in_quote_currency: number;
 }
 export interface PoolsDexDataResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -345,8 +345,8 @@ export interface TokenV2Volume {
     contract_address: string;
     /** * The string returned by the `name()` method. */
     contract_name: string;
-    total_liquidity: number;
-    total_volume_24h: number;
+    total_liquidity: string;
+    total_volume_24h: string;
     /** * The contract logo URL. */
     logo_url: string;
     /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
@@ -394,14 +394,14 @@ 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;
+    /** * A list of explorers for this address. */
+    explorers: Explorer[];
     /** * The total liquidity unscaled value. */
-    total_liquidity: number;
+    total_liquidity: string;
     /** * The total volume 24h unscaled value. */
-    total_volume_24h: number;
+    total_volume_24h: string;
     /** * The contract logo URL. */
     logo_url: string;
     /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
@@ -441,7 +441,7 @@ export interface VolumeTokenTimeseries {
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     /** * The current date. */
-    dt: string;
+    dt: Date;
     /** * The total volume unscaled for this day. */
     total_volume: string;
     /** * The volume in `quote-currency` denomination. */
@@ -455,7 +455,7 @@ export interface LiquidityTokenTimeseries {
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     /** * The current date. */
-    dt: string;
+    dt: Date;
     /** * The total liquidity unscaled up to this day. */
     total_liquidity: string;
     /** * The liquidity in `quote-currency` denomination. */
@@ -469,7 +469,7 @@ export interface PriceTokenTimeseries {
     /** * The requested chain ID eg: `1`. */
     chain_id: string;
     /** * The current date. */
-    dt: string;
+    dt: Date;
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quote_currency: string;
     /** * The exchange rate for the requested quote currency. */
@@ -519,12 +519,12 @@ export interface ExchangeTransaction {
     address: string;
     /** * A list of explorers for this transaction. */
     explorers: Explorer[];
-    amount_0: number;
-    amount_1: number;
-    amount_0_in: number;
-    amount_0_out: number;
-    amount_1_in: number;
-    amount_1_out: number;
+    amount_0: string;
+    amount_1: string;
+    amount_0_in: string;
+    amount_0_out: string;
+    amount_1_in: string;
+    amount_1_out: string;
     to_address: string;
     from_address: string;
     sender_address: string;
@@ -540,11 +540,11 @@ export interface ExchangeTransaction {
     /** * The requested chain native gas token metadata. */
     gas_metadata: ContractMetadata;
     /** * The amount of gas supplied for this tx. */
-    gas_offered: string;
+    gas_offered: number;
     /** * The gas spent for this tx. */
-    gas_spent: string;
+    gas_spent: number;
     /** * The gas price at the time of this tx. */
-    gas_price: string;
+    gas_price: number;
     /** * The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei. */
     fees_paid: bigint | null;
     /** * The gas spent in `quote-currency` denomination. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@covalenthq/client-sdk",
-  "version": "0.9.4",
+  "version": "0.9.6",
   "types": "dist/index.d.ts",
   "files": [
     "/dist"