@covalenthq/client-sdk 0.5.2 → 0.6.0

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

@@ -253,6 +253,19 @@ declare class MethodCallsForTransfers {
     method: string;
     constructor(data: MethodCallsForTransfers);
 }
+declare class TokenHoldersResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: TokenHolder[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TokenHoldersResponse);
+}
 declare class TokenHolder {
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     contract_decimals: number;
@@ -403,6 +416,8 @@ export interface GetErc20TransfersForWalletAddressQueryParamOpts {
 export interface GetTokenHoldersV2ForTokenAddressQueryParamOpts {
     /** * Ending block to define a block range. Omitting this parameter defaults to the latest block height. */
     blockHeight?: number;
+    /** * Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date. */
+    date?: string;
     /** * Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100. */
     pageSize?: number;
     /** * 0-indexed page number to begin pagination. */
@@ -422,7 +437,7 @@ export interface GetHistoricalTokenBalancesForWalletAddressQueryParamOpts {
     /** * Ending block to define a block range. Omitting this parameter defaults to the latest block height. */
     blockHeight?: number;
     /** * Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date. */
-    date?: number;
+    date?: string;
 }
 export interface GetNativeTokenBalanceQueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
@@ -509,9 +524,24 @@ export declare class BalanceService {
      *   - `blockHeight`: Ending block to define a block range. Omitting this parameter defaults to the latest block height.
      *   - `pageSize`: Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100.
      *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *   - `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>;
+    /**
+     *
+     * 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.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} tokenAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTokenHoldersV2ForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `blockHeight`: Ending block to define a block range. Omitting this parameter defaults to the latest block height.
+     *   - `pageSize`: Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *   - `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>>;
     /**
      *
      * 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.

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

@@ -34,6 +34,30 @@ declare class ResolvedAddressItem {
     name: string;
     constructor(data: ResolvedAddressItem);
 }
+declare class BlockHeightsResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: Block[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: BlockHeightsResponse);
+}
+declare class Pagination {
+    /** * True is there is another page. */
+    has_more: boolean;
+    /** * The requested page number. */
+    page_number: number;
+    /** * The requested number of items on the current page. */
+    page_size: number;
+    /** * The total number of items across all pages for this request. */
+    total_count: number;
+    constructor(data: Pagination);
+}
 declare class GetLogsResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -59,7 +83,7 @@ declare class GetLogsEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */
@@ -92,6 +116,19 @@ declare class Param {
     value: string;
     constructor(data: Param);
 }
+declare class LogEventsByAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: LogEvent[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: LogEventsByAddressResponse);
+}
 declare class LogEvent {
     /** * The block signed timestamp in UTC. */
     block_signed_at: Date;
@@ -104,7 +141,7 @@ declare class LogEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */
@@ -122,6 +159,19 @@ declare class LogEvent {
     decoded: DecodedItem;
     constructor(data: LogEvent);
 }
+declare class LogEventsByTopicHashResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: LogEvent[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: LogEventsByTopicHashResponse);
+}
 declare class AllChainsResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -302,6 +352,19 @@ export declare class BaseService {
      *
      */
     getBlockHeights(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): AsyncIterable<Block>;
+    /**
+     *
+     * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} startDate - The start date in YYYY-MM-DD format.
+     * @param {string} endDate - The end date in YYYY-MM-DD format.
+     * @param {GetBlockHeightsQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *
+     */
+    getBlockHeightsByPage(chainName: Chain, startDate: string, endDate: string, queryParamOpts?: GetBlockHeightsQueryParamOpts): Promise<Response<BlockHeightsResponse>>;
     /**
      *
      * Commonly used to get all the event logs of the latest block, or for a range of blocks. Includes sender contract metadata as well as decoded logs.
@@ -331,6 +394,20 @@ export declare class BaseService {
      *
      */
     getLogEventsByAddress(chainName: Chain, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): AsyncIterable<LogEvent>;
+    /**
+     *
+     * Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetLogEventsByAddressQueryParamOpts} queryParamOpts
+     *   - `startingBlock`: The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     *   - `endingBlock`: The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *
+     */
+    getLogEventsByAddressByPage(chainName: Chain, contractAddress: string, queryParamOpts?: GetLogEventsByAddressQueryParamOpts): Promise<Response<LogEventsByAddressResponse>>;
     /**
      *
      * Commonly used to get all event logs of the same topic hash across all contracts within a particular chain. Useful for cross-sectional analysis of event logs that are emitted on-chain.
@@ -346,6 +423,21 @@ export declare class BaseService {
      *
      */
     getLogEventsByTopicHash(chainName: Chain, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): AsyncIterable<LogEvent>;
+    /**
+     *
+     * Commonly used to get all event logs of the same topic hash across all contracts within a particular chain. Useful for cross-sectional analysis of event logs that are emitted on-chain.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} topicHash - The endpoint will return event logs that contain this topic hash.
+     * @param {GetLogEventsByTopicHashQueryParamOpts} queryParamOpts
+     *   - `startingBlock`: The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     *   - `endingBlock`: The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     *   - `secondaryTopics`: Additional topic hash(es) to filter on - padded & unpadded address fields are supported. Separate multiple topics with a comma.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *
+     */
+    getLogEventsByTopicHashByPage(chainName: Chain, topicHash: string, queryParamOpts?: GetLogEventsByTopicHashQueryParamOpts): Promise<Response<LogEventsByTopicHashResponse>>;
     /**
      *
      * Commonly used to build internal dashboards for all supported chains on Covalent.

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

@@ -21,7 +21,7 @@ export type Chains = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-main
  * CovalentClient Class
  */
 export type Quotes = "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.5.2";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.6.0";
 export declare class Response<T> {
     data: T;
     error: boolean;

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

@@ -1,4 +1,17 @@
 import { Chain, Quote, Response } from "./CovalentClient";
+declare class ChainCollectionResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ChainCollectionItem[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: ChainCollectionResponse);
+}
 declare class ChainCollectionItem {
     /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
     contract_address: string;
@@ -48,6 +61,12 @@ declare class NftTokenContractBalanceItem {
     balance: bigint | null;
     balance_24h: number;
     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;
+    /** * A prettier version of the floor price quote for rendering purposes. */
+    pretty_floor_price_quote: string;
+    /** * The current floor price in native 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_native_quote: number;
     nft_data: NftData[];
     constructor(data: NftTokenContractBalanceItem);
 }
@@ -189,7 +208,7 @@ declare class LogEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */
@@ -477,6 +496,18 @@ export declare class NftService {
      *
      */
     getChainCollections(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<ChainCollectionItem>;
+    /**
+     *
+     * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {GetChainCollectionsQueryParamOpts} queryParamOpts
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
+     *
+     */
+    getChainCollectionsByPage(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): Promise<Response<ChainCollectionResponse>>;
     /**
      *
      * Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.
@@ -506,6 +537,22 @@ export declare class NftService {
      *
      */
     getTokenIdsForContractWithMetadata(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<NftTokenContract>;
+    /**
+     *
+     * Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTokenIdsForContractWithMetadataQueryParamOpts} queryParamOpts
+     *   - `noMetadata`: Omit metadata.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *   - `traitsFilter`: Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
+     *   - `valuesFilter`: Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. If used with "traits-filter", only NFTs matching both filters will be returned. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
+     *   - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
+     *
+     */
+    getTokenIdsForContractWithMetadataByPage(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): Promise<Response<NftMetadataResponse>>;
     /**
      *
      * Commonly used to get a single NFT metadata by token ID from a collection. Useful for building NFT card displays.

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

@@ -283,7 +283,7 @@ declare class LogEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */
@@ -420,6 +420,8 @@ export interface GetTransactionsForBlockQueryParamOpts {
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
 }
 export interface GetTransactionsForAddressV3QueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
@@ -476,6 +478,7 @@ export declare class TransactionService {
      * @param {GetTransactionsForBlockQueryParamOpts} queryParamOpts
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
      *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
      *
      */
     getTransactionsForBlock(chainName: Chain, blockHeight: number, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<Response<TransactionsBlockResponse>>;

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

@@ -66,7 +66,7 @@ export interface GetLogsEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */

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

@@ -63,7 +63,7 @@ export interface LogEvent {
     /** * The requested transaction hash. */
     tx_hash: string;
     /** * The log topics in raw data. */
-    raw_log_topics: string;
+    raw_log_topics: string[];
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     sender_contract_decimals: number;
     /** * The name of the sender. */

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

@@ -47,6 +47,12 @@ export interface NftTokenContractBalanceItem {
     balance: bigint | null;
     balance_24h: number;
     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;
+    /** * A prettier version of the floor price quote for rendering purposes. */
+    pretty_floor_price_quote: string;
+    /** * The current floor price in native 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_native_quote: number;
     nft_data: NftData[];
 }
 export interface NftMetadataResponse {