@covalenthq/client-sdk 2.2.2 → 2.2.3

package/dist/cjs/src/services/NftService.d.ts

@@ -1,6 +1,6 @@
 import { type Execution } from "../utils/functions/execution";
 import { type Chain, type GoldRushResponse } from "../utils/types/Generic.types";
-import { type ChainCollectionResponse, type CheckOwnershipInNftQueryParamOpts, type GetChainCollectionsQueryParamOpts, type GetNftMetadataForGivenTokenIdForContractQueryParamOpts, type GetNftTransactionsForContractTokenIdQueryParamOpts, type GetNftsForAddressQueryParamOpts, type GetTokenIdsForContractWithMetadataQueryParamOpts, type NftAddressBalanceNftResponse, type NftCollectionAttributesForTraitResponse, type NftCollectionTraitsResponse, type NftCollectionTraitsSummaryResponse, type NftMetadataResponse, type NftOwnershipForCollectionResponse, type NftTransactionsResponse } from "../utils/types/NftService.types";
+import { type ChainCollectionResponse, type CheckOwnershipInNftQueryParamOpts, type GetChainCollectionsQueryParamOpts, type GetCollectionMarketDataQueryParamOpts, type GetNftMetadataForGivenTokenIdForContractQueryParamOpts, type GetNftTransactionsForContractTokenIdQueryParamOpts, type GetNftsForAddressQueryParamOpts, type GetTokenIdsForContractWithMetadataQueryParamOpts, type NftAddressBalanceNftResponse, type NftCollectionAttributesForTraitResponse, type NftCollectionFloorPriceResponse, type NftCollectionSalesCountResponse, type NftCollectionTraitsResponse, type NftCollectionTraitsSummaryResponse, type NftCollectionVolumeResponse, type NftMetadataResponse, type NftOwnershipForCollectionResponse, type NftTransactionsResponse } from "../utils/types/NftService.types";
 /**
  * NFTs API
  *
@@ -130,6 +130,42 @@ export declare class NftService {
      *
      */
     getCollectionTraitsSummary(chainName: Chain, collectionContract: string): Promise<GoldRushResponse<NftCollectionTraitsSummaryResponse>>;
+    /**
+     *
+     * Commonly used to render a price floor chart for an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    getHistoricalFloorPricesForCollection(chainName: Chain, collectionAddress: string, queryParamOpts?: GetCollectionMarketDataQueryParamOpts): Promise<GoldRushResponse<NftCollectionFloorPriceResponse>>;
+    /**
+     *
+     * Commonly used to build a time-series chart of the transaction volume of an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    getHistoricalVolumeForCollection(chainName: Chain, collectionAddress: string, queryParamOpts?: GetCollectionMarketDataQueryParamOpts): Promise<GoldRushResponse<NftCollectionVolumeResponse>>;
+    /**
+     *
+     * Commonly used to build a time-series chart of the sales count of an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    getHistoricalSalesCountForCollection(chainName: Chain, collectionAddress: string, queryParamOpts?: GetCollectionMarketDataQueryParamOpts): Promise<GoldRushResponse<NftCollectionSalesCountResponse>>;
     /**
      *
      * Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.

package/dist/cjs/src/utils/types/AllChainService.types.d.ts

@@ -73,7 +73,7 @@ export type MultiChainBalanceItem = Nullable<{
     /** * 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. */
-    native_token: boolean;
+    is_native_token: boolean;
     /** * One of `cryptocurrency`, `stablecoin`, `nft` or `dust`. */
     type: string;
     /** * Denotes whether the token is suspected spam. */

package/dist/cjs/src/utils/types/NftService.types.d.ts

@@ -1,4 +1,4 @@
-import { type ChainID, type ChainName, type LogEvent, type NftData, type Nullable, type Pagination } from "./Generic.types";
+import { type ChainID, type ChainName, type LogEvent, type NftData, type Nullable, type Pagination, type Quote } from "./Generic.types";
 export type ChainCollectionResponse = Nullable<{
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -271,3 +271,85 @@ export type CheckOwnershipInNftQueryParamOpts = Nullable<{
     /** * Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding. */
     valuesFilter?: string;
 }>;
+export type GetCollectionMarketDataQueryParamOpts = Nullable<{
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency?: Quote;
+    /** The number of days to return data for. Request up 365 days. Defaults to 30 days. */
+    days?: number;
+}>;
+export type NftCollectionFloorPriceResponse = Nullable<{
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** The requested address. */
+    address: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * List of response items. */
+    items: NftCollectionFloorPriceItem[];
+}>;
+export type NftCollectionFloorPriceItem = Nullable<{
+    /** * The timestamp of the date of sale. */
+    date: Date;
+    /** * The ticker symbol for the native currency. */
+    native_ticker_symbol: string;
+    /** * The contract name of the native currency. */
+    native_name: string;
+    /** * The current floor price in native currency. */
+    floor_price_native_quote: number;
+    /** * The current floor price converted to fiat in quote-currency. */
+    floor_price_quote: number;
+    /** * A prettier version of the floor price quote for rendering purposes. */
+    pretty_floor_price_quote: string;
+}>;
+export type NftCollectionVolumeResponse = Nullable<{
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** The requested address. */
+    address: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * List of response items. */
+    items: NftCollectionVolumeItem[];
+}>;
+export type NftCollectionVolumeItem = Nullable<{
+    /** * The timestamp of the date of sale. */
+    date: Date;
+    /** * The ticker symbol for the native currency. */
+    native_ticker_symbol: string;
+    /** * The contract name of the native currency. */
+    native_name: string;
+    /** * The current volume converted to fiat in `quoteCurrency`. */
+    volume_quote: number;
+    /** * The current volume in native currency. */
+    volume_native_quote: number;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
+}>;
+export type NftCollectionSalesCountResponse = Nullable<{
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** The requested address. */
+    address: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * List of response items. */
+    items: NftCollectionSalesCountItem[];
+}>;
+export type NftCollectionSalesCountItem = Nullable<{
+    /** * The timestamp of the date of sale. */
+    date: Date;
+    /** * The total amount of sales for the current day. */
+    sales_count: string;
+}>;

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-var version = "2.2.2";
+var version = "2.2.3";
 
 const bigIntParser = (val) => {
     if (val === null || val === undefined) {
@@ -2162,6 +2162,120 @@ class NftService {
         };
         return await this.execution.execute(endpoint, parseData);
     }
+    /**
+     *
+     * Commonly used to render a price floor chart for an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    async getHistoricalFloorPricesForCollection(chainName, collectionAddress, queryParamOpts) {
+        const endpoint = endpointGenerator(`${chainName}/nft_market/${collectionAddress}/floor_price`, [
+            {
+                key: "days",
+                value: queryParamOpts?.days,
+            },
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quote_currency,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((floorPriceItem) => ({
+                        ...floorPriceItem,
+                        date: floorPriceItem.date ? new Date(floorPriceItem.date) : null,
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
+    /**
+     *
+     * Commonly used to build a time-series chart of the transaction volume of an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    async getHistoricalVolumeForCollection(chainName, collectionAddress, queryParamOpts) {
+        const endpoint = endpointGenerator(`${chainName}/nft_market/${collectionAddress}/volume`, [
+            {
+                key: "days",
+                value: queryParamOpts?.days,
+            },
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quote_currency,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((floorPriceItem) => ({
+                        ...floorPriceItem,
+                        date: floorPriceItem.date ? new Date(floorPriceItem.date) : null,
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
+    /**
+     *
+     * Commonly used to build a time-series chart of the sales count of an NFT collection.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} collectionAddress - The requested address.
+     * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
+     *
+     */
+    async getHistoricalSalesCountForCollection(chainName, collectionAddress, queryParamOpts) {
+        const endpoint = endpointGenerator(`${chainName}/nft_market/${collectionAddress}/sale_count`, [
+            {
+                key: "days",
+                value: queryParamOpts?.days,
+            },
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quote_currency,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((floorPriceItem) => ({
+                        ...floorPriceItem,
+                        date: floorPriceItem.date ? new Date(floorPriceItem.date) : null,
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
     /**
      *
      * Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.