npm - @covalenthq/client-sdk - Versions diffs - 2.3.6 → 2.3.8 - Mend

@covalenthq/client-sdk 2.3.6 → 2.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/LICENSE +21 -201
package/README.md +595 -596
package/dist/index.js +605 -375
package/dist/index.js.map +1 -1
package/dist/src/services/AllChainsService.d.ts +6 -0
package/dist/src/services/BalanceService.d.ts +22 -4
package/dist/src/services/BaseService.d.ts +30 -1
package/dist/src/services/BitcoinService.d.ts +7 -1
package/dist/src/services/NftService.d.ts +18 -0
package/dist/src/services/PricingService.d.ts +5 -1
package/dist/src/services/SecurityService.d.ts +2 -0
package/dist/src/services/StreamingService.d.ts +76 -27
package/dist/src/services/TransactionService.d.ts +14 -2
package/dist/src/utils/types/Generic.types.d.ts +16 -104
package/dist/src/utils/types/StreamingService.types.d.ts +134 -39
package/package.json +6 -3

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

@@ -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.
@@ -50,6 +52,10 @@ export declare class AllChainsService {
      */
     getMultiChainAndMultiAddressTransactions(queryParamOpts?: GetMultiChainMultiAddressTransactionsParamOtps): Promise<GoldRushResponse<MultiChainMultiAddressTransactionsResponse>>;
     /**
+     *
+     * Fetch paginated spot & historical native and token balances for a single address on up to 10 EVM chains with one API call.
+     *
+     * **Credit Cost**: 2.5 per call
      *
      * @param {string} walletAddress - The requested wallet Address.
      * @param {GetMultiChainBalanceQueryParamOpts} queryParamOpts

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

@@ -10,7 +10,9 @@ 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.
@@ -27,6 +29,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 +43,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 +61,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,7 +77,9 @@ 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.
@@ -83,7 +93,9 @@ 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.
@@ -97,7 +109,9 @@ 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.
@@ -113,6 +127,10 @@ export declare class BalanceService {
      */
     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 CHANGED Viewed

@@ -13,6 +13,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 +22,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 +35,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 +50,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 +65,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 +82,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 +98,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 +114,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 +131,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 +148,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,10 +156,16 @@ export declare class BaseService {
      *
      * Commonly used to build internal status dashboards of all supported chains.
      *
+     * **Credit Cost**: 1 per call
      *
      */
     getAllChainStatus(): Promise<GoldRushResponse<AllChainsStatusResponse>>;
     /**
+     *
+     * Commonly used to locate chains which an address is active on with a single API call.
+     *
+     * **Credit Cost**: 0.5 per call
+     *
      * @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.
@@ -152,6 +177,10 @@ export declare class BaseService {
      */
     getAddressActivity(walletAddress: string, queryParamOpts?: GetAddressActivityQueryParamOpts): Promise<GoldRushResponse<ChainActivityResponse>>;
     /**
+     *
+     * Get real-time gas estimates for different transaction speeds on a specific network, enabling users to optimize transaction costs and confirmation times.
+     *
+     * **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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -18,6 +18,7 @@ export declare class NftService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getChainCollections(chainName: Chain, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<GoldRushResponse<ChainCollectionResponse>>;
     /**
@@ -30,12 +31,15 @@ export declare class NftService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     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
@@ -59,6 +63,7 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getTokenIdsForContractWithMetadata(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<GoldRushResponse<NftMetadataResponse>>;
     /**
@@ -75,6 +80,7 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getTokenIdsForContractWithMetadataByPage(chainName: Chain, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): Promise<GoldRushResponse<NftMetadataResponse>>;
     /**
@@ -88,6 +94,7 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getNftMetadataForGivenTokenIdForContract(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftMetadataForGivenTokenIdForContractQueryParamOpts): Promise<GoldRushResponse<NftMetadataResponse>>;
     /**
@@ -100,6 +107,7 @@ export declare class NftService {
      * @param {GetNftTransactionsForContractTokenIdQueryParamOpts} queryParamOpts
      *   - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getNftTransactionsForContractTokenId(chainName: Chain, contractAddress: string, tokenId: string, queryParamOpts?: GetNftTransactionsForContractTokenIdQueryParamOpts): Promise<GoldRushResponse<NftTransactionsResponse>>;
     /**
@@ -109,6 +117,7 @@ export declare class NftService {
      * @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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getTraitsForCollection(chainName: Chain, collectionContract: string): Promise<GoldRushResponse<NftCollectionTraitsResponse>>;
     /**
@@ -119,6 +128,7 @@ export declare class NftService {
      * @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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getAttributesForTraitInCollection(chainName: Chain, collectionContract: string, trait: string): Promise<GoldRushResponse<NftCollectionAttributesForTraitResponse>>;
     /**
@@ -128,6 +138,7 @@ export declare class NftService {
      * @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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getCollectionTraitsSummary(chainName: Chain, collectionContract: string): Promise<GoldRushResponse<NftCollectionTraitsSummaryResponse>>;
     /**
@@ -140,6 +151,7 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getHistoricalFloorPricesForCollection(chainName: Chain, collectionAddress: string, queryParamOpts?: GetCollectionMarketDataQueryParamOpts): Promise<GoldRushResponse<NftCollectionFloorPriceResponse>>;
     /**
@@ -152,6 +164,7 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     getHistoricalVolumeForCollection(chainName: Chain, collectionAddress: string, queryParamOpts?: GetCollectionMarketDataQueryParamOpts): Promise<GoldRushResponse<NftCollectionVolumeResponse>>;
     /**
@@ -164,12 +177,15 @@ export declare class NftService {
      *   - `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.
      *
+     * @deprecated This endpoint is no longer supported by the GoldRush API.
      */
     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 +199,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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -12,6 +12,8 @@ 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.
      *

package/dist/src/services/StreamingService.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { type NewPairsStreamParams, type NewPairsStreamResponse, type OHLCVPairsStreamParams, type OHLCVPairsStreamResponse, type OHLCVTokensStreamParams, type OHLCVTokensStreamResponse, type StreamingServiceConfig, type StreamSubscriptionOptions, type TokenBalancesStreamParams, type TokenBalancesStreamResponse, type UnsubscribeFunction, type UpdatePairsStreamParams, type UpdatePairsStreamResponse, type WalletActivityStreamParams, type WalletActivityStreamResponse } from "../utils/types/StreamingService.types";
+import { type NewPairsStreamParams, type NewPairsStreamResponse, type OHLCVPairsStreamParams, type OHLCVPairsStreamResponse, type OHLCVTokensStreamParams, type OHLCVTokensStreamResponse, type StreamingServiceConfig, type StreamSubscriptionOptions, type TokenSearchParams, type TokenSearchResponse, type UnsubscribeFunction, type UpdatePairsStreamParams, type UpdatePairsStreamResponse, type UPnLForTokenParams, type UPnLForTokenResponse, type UPnLForWalletParams, type UPnLForWalletResponse, type WalletActivityStreamParams, type WalletActivityStreamResponse } from "../utils/types/StreamingService.types";
 import { type Client } from "graphql-ws";
 /**
  * Streaming API Service
@@ -30,7 +30,12 @@ export declare class StreamingService {
      */
     rawQuery<T = Array<object>>(query: string, variables: Record<string, unknown>, callbacks: StreamSubscriptionOptions<T>): UnsubscribeFunction;
     /**
-     * Subscribe to OHLCV data for specific pairs
+     *
+     * The OHLCV Pairs stream provides real-time updates on the Open, High, Low, Close prices and Volume of one or many token pairs at configurable intervals.
+     *
+     * **Credit Cost**: 0 per call
+     *
+     * **Beta**: This endpoint is in beta.
      *
      * @param params - Parameters for the OHLCV pairs stream
      * @param callbacks - Subscription callbacks
@@ -55,7 +60,12 @@ export declare class StreamingService {
      */
     subscribeToOHLCVPairs(params: OHLCVPairsStreamParams, callbacks: StreamSubscriptionOptions<OHLCVPairsStreamResponse[]>): UnsubscribeFunction;
     /**
-     * Subscribe to OHLCV data for specific tokens
+     *
+     * The OHLCV Tokens stream provides real-time updates on the Open, High, Low, Close prices and Volume of one or many tokens at configurable intervals.
+     *
+     * **Credit Cost**: 0 per call
+     *
+     * **Beta**: This endpoint is in beta.
      *
      * @param params - Parameters for the OHLCV tokens stream
      * @param callbacks - Subscription callbacks
@@ -80,7 +90,12 @@ export declare class StreamingService {
      */
     subscribeToOHLCVTokens(params: OHLCVTokensStreamParams, callbacks: StreamSubscriptionOptions<OHLCVTokensStreamResponse[]>): UnsubscribeFunction;
     /**
-     * Subscribe to new DEX pairs created on supported decentralized exchanges
+     *
+     * The New DEX Pairs stream provides real-time updates when new liquidity pairs are created on decentralized exchanges (DEXes). This documentation follows our standard streaming API structure.
+     *
+     * **Credit Cost**: 0 per call
+     *
+     * **Beta**: This endpoint is in beta.
      *
      * @param params - Parameters for the new pairs stream
      * @param callbacks - Subscription callbacks
@@ -103,7 +118,12 @@ export declare class StreamingService {
      */
     subscribeToNewPairs(params: NewPairsStreamParams, callbacks: StreamSubscriptionOptions<NewPairsStreamResponse[]>): UnsubscribeFunction;
     /**
-     * Subscribe to real-time updates for specific trading pairs including price, volume, and liquidity data
+     *
+     * The Update DEX Pairs stream provides real-time event updates on the prices, volumes, market cap and liquidity of one or many token pairs.
+     *
+     * **Credit Cost**: 0 per call
+     *
+     * **Beta**: This endpoint is in beta.
      *
      * @param params - Parameters for the update pairs stream
      * @param callbacks - Subscription callbacks
@@ -128,30 +148,12 @@ export declare class StreamingService {
      */
     subscribeToUpdatePairs(params: UpdatePairsStreamParams, callbacks: StreamSubscriptionOptions<UpdatePairsStreamResponse>): UnsubscribeFunction;
     /**
-     * Subscribe to real-time token balance updates for a specific wallet address
      *
-     * @param params - Parameters for the token balances stream
-     * @param callbacks - Subscription callbacks
-     * @returns Unsubscribe function
+     * The Wallet Activity stream provides real-time updates on wallet transactions, token transfers, and interactions with smart contracts . This documentation follows our standard Streaming API structure.
      *
-     * @example
-     * ```typescript
-     * const unsubscribe = streamingService.subscribeToTokenBalances(
-     *   {
-     *     chain_name: StreamingChain.BASE_MAINNET,
-     *     wallet_address: "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
-     *   },
-     *   {
-     *     next: (data) => console.log("Token Balances:", data),
-     *     error: (err) => console.error("Error:", err),
-     *     complete: () => console.log("Stream completed")
-     *   }
-     * );
-     * ```
-     */
-    subscribeToTokenBalances(params: TokenBalancesStreamParams, callbacks: StreamSubscriptionOptions<TokenBalancesStreamResponse>): UnsubscribeFunction;
-    /**
-     * Subscribe to real-time wallet activity including transactions, token transfers, and smart contract interactions
+     * **Credit Cost**: 0 per call
+     *
+     * **Beta**: This endpoint is in beta.
      *
      * @param params - Parameters for the wallet activity stream
      * @param callbacks - Subscription callbacks
@@ -173,4 +175,51 @@ export declare class StreamingService {
      * ```
      */
     subscribeToWalletActivity(params: WalletActivityStreamParams, callbacks: StreamSubscriptionOptions<WalletActivityStreamResponse[]>): UnsubscribeFunction;
+    /**
+     * Search for tokens by keyword, ticker, or contract address
+     *
+     * @param params - Parameters for the token search query
+     * @returns Promise resolving to an array of matching tokens
+     *
+     * @example
+     * ```typescript
+     * const results = await streamingService.searchToken({
+     *   query: "PEPE"
+     * });
+     * console.log("Search Results:", results);
+     * ```
+     */
+    searchToken(params: TokenSearchParams): Promise<TokenSearchResponse[]>;
+    /**
+     * Get top trader wallets and their PnL for a specific token
+     *
+     * @param params - Parameters for the UPnL token query
+     * @returns Promise resolving to an array of top trader wallet data
+     *
+     * @example
+     * ```typescript
+     * const traders = await streamingService.getUPnLForToken({
+     *   chain_name: StreamingChain.ETH_MAINNET,
+     *   token_address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
+     * });
+     * console.log("Top Traders:", traders);
+     * ```
+     */
+    getUPnLForToken(params: UPnLForTokenParams): Promise<UPnLForTokenResponse[]>;
+    /**
+     * Get unrealized and realized PnL for all tokens held by a wallet
+     *
+     * @param params - Parameters for the UPnL wallet query
+     * @returns Promise resolving to an array of token PnL data for the wallet
+     *
+     * @example
+     * ```typescript
+     * const pnl = await streamingService.getUPnLForWallet({
+     *   chain_name: StreamingChain.ETH_MAINNET,
+     *   wallet_address: "0xfe97b0C517a84F98fc6eDe3CD26B43012d31992a"
+     * });
+     * console.log("Wallet PnL:", pnl);
+     * ```
+     */
+    getUPnLForWallet(params: UPnLForWalletParams): Promise<UPnLForWalletResponse[]>;
 }

package/dist/src/services/TransactionService.d.ts CHANGED Viewed

@@ -10,7 +10,9 @@ export declare class TransactionService {
     constructor(execution: Execution);
     /**
      *
-     * Commonly used to fetch and render a single transaction including its decoded log events.
+     * Used to fetch and render a single transaction including its decoded event logs. For foundational chains, can also retrieve internal transactions, state changes and method ID where available.
+     *
+     * **Credit Cost**: 0.1 per call
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} txHash - The transaction hash.
@@ -25,7 +27,9 @@ export declare class TransactionService {
     getTransaction(chainName: Chain, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<GoldRushResponse<TransactionResponse>>;
     /**
      *
-     * Commonly used to fetch the earliest and latest transactions, and the transaction count for a wallet. Calculate the age of the wallet and the time it has been idle and quickly gain insights into their engagement with web3.
+     * Used to fetch the earliest and latest transactions, and the transaction count for a wallet. Also enriched with gas expenditure details and total ERC20 token transfers count.
+     *
+     * **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.
@@ -51,6 +55,8 @@ export declare class TransactionService {
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
      *
+     * **Credit Cost**: 0.1 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 {GetAllTransactionsForAddressQueryParamOpts} queryParamOpts
@@ -67,6 +73,8 @@ export declare class TransactionService {
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
      *
+     * **Credit Cost**: 0.1 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 {GetAllTransactionsForAddressQueryParamOpts} queryParamOpts
@@ -106,6 +114,8 @@ export declare class TransactionService {
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
      *
+     * **Credit Cost**: 0.1 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {number} blockHeight - The requested block height.
      * @param {number} page - The requested page, 0-indexed.
@@ -119,6 +129,8 @@ export declare class TransactionService {
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
      *
+     * **Credit Cost**: 0.1 per item
+     *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
      * @param {string} blockHash - The requested block hash.
      * @param {getTransactionsForBlockByPageQueryParamOpts} queryParamOpts