@covalenthq/client-sdk 2.2.4 → 2.2.6

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

@@ -50,7 +50,7 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getErc20TransfersForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<GoldRushResponse<Erc20TransfersResponse>>;
+    getErc20TransfersForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<GoldRushResponse<Erc20TransfersResponse>>;
     /**
      *
      * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
@@ -66,7 +66,7 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getErc20TransfersForWalletAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): Promise<GoldRushResponse<Erc20TransfersResponse>>;
+    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.

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

@@ -1,6 +1,6 @@
 import { type Execution } from "../utils/functions/execution";
-import { type Chain, type GoldRushResponse, type Quote } from "../utils/types/Generic.types";
-import { type GetTokenPricesQueryParamOpts, type TokenPricesResponse } from "../utils/types/PricingService.types";
+import type { Chain, GoldRushResponse, Quote } from "../utils/types/Generic.types";
+import type { GetTokenPricesQueryParamOpts, PoolSpotPriceQueryParamsOpts, PoolSpotPricesResponse, TokenPricesResponse } from "../utils/types/PricingService.types";
 /**
  * Pricing API
  *
@@ -22,4 +22,15 @@ export declare class PricingService {
      *
      */
     getTokenPrices(chainName: Chain, quoteCurrency: Quote, contractAddress: string, queryParamOpts?: GetTokenPricesQueryParamOpts): Promise<GoldRushResponse<TokenPricesResponse[]>>;
+    /**
+     *
+     * Get the spot token pair prices for a specified pool contract address. Supports pools on Uniswap V2, V3 and their forks.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} contractAddress - The pool contract address.
+     * @param {GetTokenPricesQueryParamOpts} queryParamOpts
+     *    - `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`.
+     *
+     */
+    getPoolSpotPrices(chainName: Chain, contractAddress: string, queryParamOpts?: PoolSpotPriceQueryParamsOpts): Promise<GoldRushResponse<PoolSpotPricesResponse[]>>;
 }

package/dist/cjs/src/services/TransactionService.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 GetAllTransactionsForAddressQueryParamOpts, type GetTimeBucketTransactionsForAddressQueryParamOpts, type GetTransactionQueryParamOpts, type GetTransactionSummaryQueryParamOpts, type GetTransactionsForAddressV3QueryParamOpts, type GetTransactionsForBlockQueryParamOpts, type RecentTransactionsResponse, type TransactionResponse, type TransactionsBlockResponse, type TransactionsResponse, type TransactionsSummaryResponse, type TransactionsTimeBucketResponse } from "../utils/types/TransactionService.types";
+import type { Chain, GoldRushResponse } from "../utils/types/Generic.types";
+import type { EarliestTransactionsForAddressResponse, GetAllTransactionsForAddressQueryParamOpts, GetEarliestTransactionsForAddressQueryParamOpts, getPaginatedTransactionsForAddressQueryParamOpts, GetTimeBucketTransactionsForAddressQueryParamOpts, GetTransactionQueryParamOpts, getTransactionsForBlockByPageQueryParamOpts, GetTransactionSummaryQueryParamOpts, RecentTransactionsResponse, TransactionResponse, TransactionsBlockResponse, TransactionsForBlockResponse, TransactionsResponse, TransactionsSummaryResponse, TransactionsTimeBucketResponse } from "../utils/types/TransactionService.types";
 /**
  * Transactions API
  *
@@ -23,6 +23,30 @@ 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.
+     *
+     * @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 {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
+     *
+     */
+    getTransactionSummary(chainName: Chain, walletAddress: string, queryParamOpts?: GetTransactionSummaryQueryParamOpts): Promise<GoldRushResponse<TransactionsSummaryResponse>>;
+    /**
+     *
+     * Commonly used to fetch and render the earliest transactions involving an address. Frequently seen in wallet applications.
+     *
+     * @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 {GetEarliestTransactionsForAddressQueryParamOpts} 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.
+     *
+     */
+    getEarliestTransactionsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetEarliestTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<EarliestTransactionsForAddressResponse>>;
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -56,50 +80,55 @@ export declare class TransactionService {
      */
     getAllTransactionsForAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<RecentTransactionsResponse>>;
     /**
-     *
-     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
      *
      * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
-     * @param {number} blockHeight - The requested block height.
-     * @param {GetTransactionsForBlockQueryParamOpts} queryParamOpts
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {number} page - The requested page, 0-indexed.
+     * @param {getPaginatedTransactionsForAddressQueryParamOpts} 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.
+     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
      *
      */
-    getTransactionsForBlock(chainName: Chain, blockHeight: number | string | "latest", queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
+    getPaginatedTransactionsForAddress(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: getPaginatedTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<TransactionsResponse>>;
     /**
-     *
-     * 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.
      *
      * @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 {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     * @param {number} timeBucket - The 0-indexed 15-minute time bucket. E.g. 27 Feb 2023 05:23 GMT = 1677475383 (Unix time). 1677475383/900=1863861 timeBucket.
+     * @param {GetTimeBucketTransactionsForAddressQueryParamOpts} queryParamOpts
      *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
-     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
+     *   - `noLogs`: Omit log events.
      *
      */
-    getTransactionSummary(chainName: Chain, walletAddress: string, queryParamOpts?: GetTransactionSummaryQueryParamOpts): Promise<GoldRushResponse<TransactionsSummaryResponse>>;
+    getTimeBucketTransactionsForAddress(chainName: Chain, walletAddress: string, timeBucket: number, queryParamOpts?: GetTimeBucketTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<TransactionsTimeBucketResponse>>;
     /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
      *
      * @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 {number} blockHeight - The requested block height.
      * @param {number} page - The requested page, 0-indexed.
-     * @param {GetTransactionsForAddressV3QueryParamOpts} queryParamOpts
+     * @param {getTransactionsForBlockByPageQueryParamOpts} 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.
-     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
      *
      */
-    getTransactionsForAddressV3(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<GoldRushResponse<TransactionsResponse>>;
+    getTransactionsForBlockByPage(chainName: Chain, blockHeight: number | string | "latest", page: number, queryParamOpts?: getTransactionsForBlockByPageQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
     /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
      *
      * @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 {number} timeBucket - The 0-indexed 15-minute time bucket. E.g. 27 Feb 2023 05:23 GMT = 1677475383 (Unix time). 1677475383/900=1863861 timeBucket.
-     * @param {GetTimeBucketTransactionsForAddressQueryParamOpts} queryParamOpts
+     * @param {string} blockHash - The requested block hash.
+     * @param {getTransactionsForBlockByPageQueryParamOpts} 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.
      *
      */
-    getTimeBucketTransactionsForAddress(chainName: Chain, walletAddress: string, timeBucket: number, queryParamOpts?: GetTimeBucketTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<TransactionsTimeBucketResponse>>;
+    getTransactionsForBlock(chainName: Chain, blockHash: string, queryParamOpts?: getTransactionsForBlockByPageQueryParamOpts): Promise<GoldRushResponse<TransactionsForBlockResponse>>;
+    /**
+     * @deprecated This method has been deprecated and will be removed in future releases. Use `getPaginatedTransactionsForAddress` instead.
+     */
+    getTransactionsForAddressV3(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: getPaginatedTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<TransactionsResponse>>;
 }

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

@@ -398,7 +398,7 @@ export type GetErc20TransfersForWalletAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. */
-    contractAddress?: string;
+    contractAddress: string;
     /** * The block height to start from, defaults to `0`. */
     startingBlock?: number;
     /** * The block height to end at, defaults to current block height. */

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

@@ -38,3 +38,43 @@ export type GetTokenPricesQueryParamOpts = Nullable<{
     /** * Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order. */
     pricesAtAsc?: boolean;
 }>;
+export type PoolSpotPriceQueryParamsOpts = Nullable<{
+    /** * The currency to convert. */
+    quoteCurrency: string;
+}>;
+export type PoolSpotPricesResponse = Nullable<{
+    /** * The timestamp when the response was generated. */
+    updated_at: Date;
+    /** * The pool contract address. */
+    pool_address: string;
+    /** * The contract address of token_0 in the token pair making up the pool. */
+    token_0_address: string;
+    /** * The contract name of token_0 in the token pair making up the pool. */
+    token_0_name: string;
+    /** * The contract symbol of token_0 in the token pair making up the pool. */
+    token_0_ticker: string;
+    /** * Price of token_0 in units of token_1. */
+    token_0_price: string;
+    /** * Price of token_0 in units of token_1 as of 24 hours ago. */
+    token_0_price_24h: string;
+    /** * Price of token_0 in the selected quote currency (defaults to USD). */
+    token_0_price_quote: string;
+    /** * Price of token_0 in the selected quote currency (defaults to USD) as of 24 hours ago. */
+    token_0_price_24h_quote: string;
+    /** * The contract address of token_1 in the token pair making up the pool. */
+    token_1_address: string;
+    /** * The contract name of token_1 in the token pair making up the pool. */
+    token_1_name: string;
+    /** * The contract symbol of token_1 in the token pair making up the pool. */
+    token_1_ticker: string;
+    /** * Price of token_1 in units of token_0. */
+    token_1_price: string;
+    /** * Price of token_1 in units of token_0 as of 24 hours ago. */
+    token_1_price_24h: string;
+    /** * Price of token_1 in the selected quote currency (defaults to USD). */
+    token_1_price_quote: string;
+    /** * Price of token_1 in the selected quote currency (defaults to USD) as of 24 hours ago. */
+    token_1_price_24h_quote: string;
+    /** * The currency to convert. */
+    quote_currency: string;
+}>;

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

@@ -172,6 +172,12 @@ export type TransactionsBlockResponse = Nullable<{
     chain_name: ChainName;
     /** * List of response items. */
     items: Transaction[];
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<TransactionsBlockResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<TransactionsBlockResponse>>) | null;
 }>;
 export type TransactionsSummaryResponse = Nullable<{
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -283,13 +289,13 @@ export type GetAllTransactionsForAddressQueryParamOpts = Nullable<{
     /** * Whether to include the transaction's input data such as the Method ID. */
     withInputData?: boolean;
 }>;
-export type GetTransactionsForBlockQueryParamOpts = Nullable<{
+export type getTransactionsForBlockByPageQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
 }>;
-export type GetTransactionsForAddressV3QueryParamOpts = Nullable<{
+export type getPaginatedTransactionsForAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
@@ -345,3 +351,42 @@ export type InputData = Nullable<{
     /** * The first 4 bytes of the invoked smart contract function signature. Used to identify the function being called in the contract. */
     method_id: string;
 }>;
+export type GetEarliestTransactionsForAddressQueryParamOpts = Nullable<{
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+}>;
+export type EarliestTransactionsForAddressResponse = Nullable<{
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    complete: boolean;
+    /** * The current bucket of the response. */
+    current_bucket: number;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * List of response items. */
+    items: Transaction[];
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<EarliestTransactionsForAddressResponse>>) | null;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<EarliestTransactionsForAddressResponse>>) | null;
+}>;
+export type TransactionsForBlockResponse = Nullable<{
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * List of response items. */
+    items: Transaction[];
+}>;