@covalenthq/client-sdk 2.3.7 → 3.0.0

package/dist/src/services/AllChainsService.d.ts

@@ -12,6 +12,8 @@ export declare class AllChainsService {
      *
      * Commonly used to locate chains which an address is active on with a single API call.
      *
+     * **Credit Cost**: 0.5 per call
+     *
      * @param {string} walletAddress - The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetAddressActivityQueryParamOpts} queryParamOpts
      *   - `testnets`: Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity.
@@ -34,22 +36,10 @@ export declare class AllChainsService {
      */
     getMultiChainMultiAddressTransactions(queryParamOpts?: GetMultiChainMultiAddressTransactionsParamOtps): Promise<GoldRushResponse<MultiChainMultiAddressTransactionsResponse>>;
     /**
-     * @deprecated This method is deprecated and will be removed in the upcoming versions. Please use `AllChainsService.getMultiChainMultiAddressTransactions` instead.
      *
-     * Commonly used to get transactions cross chains and addresses.
+     * Fetch paginated spot & historical native and token balances for a single address on up to 10 EVM chains with one API call.
      *
-     * @param {Chain[]} chains - An array of the chain names or IDs to retrieve transactions from. Defaults to all foundational chains.
-     * @param {string[]} addresses - An array of addresses for which transactions are fetched. Does not support name resolution.
-     * @param {number} limit - Number of transactions to return per page, up to the default max of 100 items.
-     * @param {string} before - Pagination cursor pointing to fetch transactions before a certain point.
-     * @param {string} after - Pagination cursor pointing to fetch transactions after a certain point.
-     * @param {boolean} withLogs - Whether to include raw logs in the response.
-     * @param {boolean} withDecodedLogs - Whether to include decoded logs in the response.
-     * @param {Quote | CryptocurrencyQuote} quoteCurrency - The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`.
-     *
-     */
-    getMultiChainAndMultiAddressTransactions(queryParamOpts?: GetMultiChainMultiAddressTransactionsParamOtps): Promise<GoldRushResponse<MultiChainMultiAddressTransactionsResponse>>;
-    /**
+     * **Credit Cost**: 2.5 per call
      *
      * @param {string} walletAddress - The requested wallet Address.
      * @param {GetMultiChainBalanceQueryParamOpts} queryParamOpts

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

@@ -10,16 +10,15 @@ export declare class BalanceService {
     constructor(execution: Execution);
     /**
      *
-     * Commonly used to fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.
+     * Commonly used to fetch the native and fungible (ERC20) tokens held by an address. Response includes spot prices and other metadata.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetTokenBalancesForWalletAddressQueryParamOpts} queryParamOpts
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
-     *   - `nft`: If `true`, NFTs will be included in the response.
-     *   - `noNftFetch`: If `true`, only NFTs that have been cached will be included in the response. Helpful for faster response times.
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
-     *   - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
      *
      */
     getTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetTokenBalancesForWalletAddressQueryParamOpts): Promise<GoldRushResponse<BalancesResponse>>;
@@ -27,6 +26,8 @@ export declare class BalanceService {
      *
      * Commonly used to render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.
      *
+     * **Credit Cost**: 2 per 30 days
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetHistoricalPortfolioForWalletAddressQueryParamOpts} queryParamOpts
@@ -39,6 +40,8 @@ export declare class BalanceService {
      *
      * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
      *
+     * **Credit Cost**: 0.05 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetErc20TransfersForWalletAddressQueryParamOpts} queryParamOpts
@@ -55,6 +58,8 @@ export declare class BalanceService {
      *
      * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
      *
+     * **Credit Cost**: 0.05 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetErc20TransfersForWalletAddressQueryParamOpts} queryParamOpts
@@ -69,11 +74,14 @@ export declare class BalanceService {
     getErc20TransfersForWalletAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts: GetErc20TransfersForWalletAddressQueryParamOpts): Promise<GoldRushResponse<Erc20TransfersResponse>>;
     /**
      *
-     * 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.
+     * Used to get a paginated list of current or historical token holders for a specified ERC20 or ERC721 token.
+     *
+     * **Credit Cost**: 0.02 per item
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} tokenAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetTokenHoldersV2ForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `noSnapshot`: Defaults to `false`. Set to `true` to bypass last snapshot and get the latest token holders list.
      *   - `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.
@@ -83,11 +91,14 @@ export declare class BalanceService {
     getTokenHoldersV2ForTokenAddress(chainName: Chain, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): AsyncIterable<GoldRushResponse<TokenHoldersResponse>>;
     /**
      *
-     * 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.
+     * Used to get a paginated list of current or historical token holders for a specified ERC20 or ERC721 token.
+     *
+     * **Credit Cost**: 0.02 per item
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} tokenAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetTokenHoldersV2ForTokenAddressQueryParamOpts} queryParamOpts
+     *   - `noSnapshot`: Defaults to `false`. Set to `true` to bypass last snapshot and get the latest token holders list.
      *   - `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.
@@ -97,22 +108,25 @@ export declare class BalanceService {
     getTokenHoldersV2ForTokenAddressByPage(chainName: Chain, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): Promise<GoldRushResponse<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.
+     * Commonly used to fetch the historical native and fungible (ERC20) tokens held by an address at a given block height or date. Response includes daily prices and other metadata.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetHistoricalTokenBalancesForWalletAddressQueryParamOpts} queryParamOpts
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
-     *   - `nft`: If `true`, NFTs will be included in the response.
-     *   - `noNftFetch`: If `true`, only NFTs that have been cached will be included in the response. Helpful for faster response times.
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
-     *   - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
      *   - `blockHeight`: Ending block to define a block range. Omitting this parameter defaults to the latest block height.
      *   - `date`: Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.
      *
      */
     getHistoricalTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetHistoricalTokenBalancesForWalletAddressQueryParamOpts): Promise<GoldRushResponse<HistoricalBalancesResponse>>;
     /**
+     *
+     * Lightweight endpoint to just get the native token balance for an EVM address.
+     *
+     * **Credit Cost**: 0.5 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.

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

@@ -1,5 +1,4 @@
 import { type Execution } from "../utils/functions/execution";
-import { type ChainActivityResponse, type GetAddressActivityQueryParamOpts } from "../utils/types/AllChainService.types";
 import { type AllChainsResponse, type AllChainsStatusResponse, type BlockHeightsResponse, type BlockResponse, type GasPricesResponse, type GetBlockHeightsQueryParamOpts, type GetGasPricesQueryParamOpts, type GetLogEventsByAddressQueryParamOpts, type GetLogEventsByTopicHashQueryParamOpts, type GetLogsQueryParamOpts, type GetLogsResponse, type LogEventsByAddressResponse, type LogEventsByTopicHashResponse, type ResolvedAddress } from "../utils/types/BaseService.types";
 import { type Chain, type GoldRushResponse } from "../utils/types/Generic.types";
 /**
@@ -13,6 +12,8 @@ export declare class BaseService {
      *
      * Commonly used to fetch and render a single block for a block explorer.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} blockHeight - The block height or `latest` for the latest block available.
      *
@@ -20,7 +21,9 @@ export declare class BaseService {
     getBlock(chainName: Chain, blockHeight: string): Promise<GoldRushResponse<BlockResponse>>;
     /**
      *
-     * Commonly used to resolve ENS, RNS and Unstoppable Domains addresses.
+     * Commonly used to resolve ENS, RNS and Unstoppable Domains addresses. Only supports the resolution of a registered domain to an address.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
@@ -31,6 +34,8 @@ export declare class BaseService {
      *
      * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} startDate - The start date in YYYY-MM-DD format.
      * @param {string | "latest"} endDate - The end date in YYYY-MM-DD format. Also accepts "latest" for the latest block height
@@ -44,6 +49,8 @@ export declare class BaseService {
      *
      * Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} startDate - The start date in YYYY-MM-DD format.
      * @param {string | "latest"} endDate - The end date in YYYY-MM-DD format. Also accepts "latest" for the latest block height
@@ -57,6 +64,8 @@ export declare class BaseService {
      *
      * 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.
      *
+     * **Credit Cost**: 0.01 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {GetLogsQueryParamOpts} queryParamOpts
      *   - `startingBlock`: The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
@@ -72,6 +81,8 @@ export declare class BaseService {
      *
      * Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
      *
+     * **Credit Cost**: 0.01 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetLogEventsByAddressQueryParamOpts} queryParamOpts
@@ -86,6 +97,8 @@ export declare class BaseService {
      *
      * Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
      *
+     * **Credit Cost**: 0.01 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      * @param {GetLogEventsByAddressQueryParamOpts} queryParamOpts
@@ -100,6 +113,8 @@ export declare class BaseService {
      *
      * 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.
      *
+     * **Credit Cost**: 0.01 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} topicHash - The endpoint will return event logs that contain this topic hash.
      * @param {GetLogEventsByTopicHashQueryParamOpts} queryParamOpts
@@ -115,6 +130,8 @@ export declare class BaseService {
      *
      * 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.
      *
+     * **Credit Cost**: 0.01 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} topicHash - The endpoint will return event logs that contain this topic hash.
      * @param {GetLogEventsByTopicHashQueryParamOpts} queryParamOpts
@@ -130,6 +147,7 @@ export declare class BaseService {
      *
      * Commonly used to build internal dashboards for all supported chains on Covalent.
      *
+     * **Credit Cost**: 0.01 per call
      *
      */
     getAllChains(): Promise<GoldRushResponse<AllChainsResponse>>;
@@ -137,21 +155,15 @@ export declare class BaseService {
      *
      * Commonly used to build internal status dashboards of all supported chains.
      *
+     * **Credit Cost**: 1 per call
      *
      */
     getAllChainStatus(): Promise<GoldRushResponse<AllChainsStatusResponse>>;
     /**
-     * @deprecated This method is deprecated and will be removed in the upcoming versions. Please use `AllChainsService.getAddressActivity` instead.
      *
-     * Commonly used to locate chains which an address is active on with a single API call.
+     * Get real-time gas estimates for different transaction speeds on a specific network, enabling users to optimize transaction costs and confirmation times.
      *
-     * @param {string} walletAddress - The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
-     * @param {GetAddressActivityQueryParamOpts} queryParamOpts
-     *   - `testnets`: Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity.
-     *
-     */
-    getAddressActivity(walletAddress: string, queryParamOpts?: GetAddressActivityQueryParamOpts): Promise<GoldRushResponse<ChainActivityResponse>>;
-    /**
+     * **Credit Cost**: 1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} eventType - The desired event type to retrieve gas prices for. Supports `erc20` transfer events, `uniswapv3` swap events and `nativetokens` transfers.

package/dist/src/services/BitcoinService.d.ts

@@ -10,6 +10,10 @@ export declare class BitcoinService {
     private execution;
     constructor(execution: Execution);
     /**
+     *
+     * Commonly used to fetch the historical Bitcoin balance held by an address at a given block height or date. Response includes daily prices and other metadata.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {string} walletAddress - The requested Bitcoin HD address.
      * @param {GetBitcoinHdWalletBalancesQueryParamOpts} queryParamOpts
@@ -29,7 +33,9 @@ export declare class BitcoinService {
     getTransactionsForBtcAddress(queryParamOpts?: GetTransactionsForBitcoinAddressParamOpts): Promise<GoldRushResponse<BitcoinTransactionResponse>>;
     /**
      *
-     * Commonly used to fetch the tokens held by an address. Response includes spot prices and other metadata.
+     * Fetch Bitcoin balance for a non-HD address. Response includes spot prices and other metadata.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {string} walletAddress - The requested Bitcoin Non HD address.
      * @param {GetBitcoinNonHdWalletBalancesQueryParamOpts} queryParamOpts

package/dist/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 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";
+import { type CheckOwnershipInNftQueryParamOpts, type GetNftsForAddressQueryParamOpts, type NftAddressBalanceNftResponse, type NftOwnershipForCollectionResponse } from "../utils/types/NftService.types";
 /**
  * NFTs API
  *
@@ -8,168 +8,26 @@ import { type ChainCollectionResponse, type CheckOwnershipInNftQueryParamOpts, t
 export declare class NftService {
     private execution;
     constructor(execution: Execution);
-    /**
-     *
-     * 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`.
-     *
-     */
-    getChainCollections(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<GoldRushResponse<ChainCollectionResponse>>;
-    /**
-     *
-     * 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<GoldRushResponse<ChainCollectionResponse>>;
     /**
      *
      * Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @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 {GetNftsForAddressQueryParamOpts} queryParamOpts
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *   - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
-     *   - `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.
      *
      */
     getNftsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetNftsForAddressQueryParamOpts): Promise<GoldRushResponse<NftAddressBalanceNftResponse>>;
-    /**
-     *
-     * 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.
-     *
-     */
-    getTokenIdsForContractWithMetadata(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<GoldRushResponse<NftMetadataResponse>>;
-    /**
-     *
-     * 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<GoldRushResponse<NftMetadataResponse>>;
-    /**
-     *
-     * Commonly used to get a single NFT metadata by token ID 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 {string} tokenId - The requested token ID.
-     * @param {GetNftMetadataForGivenTokenIdForContractQueryParamOpts} queryParamOpts
-     *   - `noMetadata`: Omit metadata.
-     *   - `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.
-     *
-     */
-    getNftMetadataForGivenTokenIdForContract(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftMetadataForGivenTokenIdForContractQueryParamOpts): Promise<GoldRushResponse<NftMetadataResponse>>;
-    /**
-     *
-     * Commonly used to get all transactions of an NFT token. Useful for building a transaction history table or price chart.
-     *
-     * @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 {string} tokenId - The requested token ID.
-     * @param {GetNftTransactionsForContractTokenIdQueryParamOpts} queryParamOpts
-     *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
-     *
-     */
-    getNftTransactionsForContractTokenId(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftTransactionsForContractTokenIdQueryParamOpts): Promise<GoldRushResponse<NftTransactionsResponse>>;
-    /**
-     *
-     * Commonly used to fetch and render the traits of a collection as seen in rarity calculators.
-     *
-     * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
-     *
-     */
-    getTraitsForCollection(chainName: Chain, collectionContract: string): Promise<GoldRushResponse<NftCollectionTraitsResponse>>;
-    /**
-     *
-     * Commonly used to get the count of unique values for traits within an NFT collection.
-     *
-     * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
-     * @param {string} trait - The requested trait.
-     *
-     */
-    getAttributesForTraitInCollection(chainName: Chain, collectionContract: string, trait: string): Promise<GoldRushResponse<NftCollectionAttributesForTraitResponse>>;
-    /**
-     *
-     * Commonly used to calculate rarity scores for a collection based on its traits.
-     *
-     * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
-     *
-     */
-    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.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @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 {string} collectionContract - The requested collection address.
@@ -183,6 +41,8 @@ export declare class NftService {
      *
      * Commonly used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @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 {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.

package/dist/src/services/PricingService.d.ts

@@ -10,7 +10,9 @@ export declare class PricingService {
     constructor(execution: Execution);
     /**
      *
-     * Commonly used to get historic prices of a token between date ranges. Supports native tokens.
+     * Get the historical prices of one (or many) large cap ERC20 tokens between specified date ranges. Also supports native tokens.
+     *
+     * **Credit Cost**: 1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} quoteCurrency - The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
@@ -26,6 +28,8 @@ export declare class PricingService {
      *
      * Get the spot token pair prices for a specified pool contract address. Supports pools on Uniswap V2, V3 and their forks.
      *
+     * **Credit Cost**: 1 per call
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} contractAddress - The pool contract address.
      * @param {GetTokenPricesQueryParamOpts} queryParamOpts

package/dist/src/services/SecurityService.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 ApprovalsResponse, type NftApprovalsResponse } from "../utils/types/SecurityService.types";
+import { type ApprovalsResponse } from "../utils/types/SecurityService.types";
 /**
  * Approvals API
  *
@@ -12,17 +12,11 @@ export declare class SecurityService {
      *
      * Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.
      *
+     * **Credit Cost**: 2 per call
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
     getApprovals(chainName: Chain, walletAddress: string): Promise<GoldRushResponse<ApprovalsResponse>>;
-    /**
-       *
-       * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
-       * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
-       
-       *
-       */
-    getNftApprovals(chainName: Chain, walletAddress: string): Promise<GoldRushResponse<NftApprovalsResponse>>;
 }