@covalenthq/client-sdk 2.2.4 → 2.2.5

package/README.md

@@ -248,8 +248,8 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
     2. <strong>Security Service</strong>: Access to the token approvals API endpoints
   </summary>
 
-- `getApprovals()`: Get a list of approvals across all ERC20 token contracts categorized by spenders for a wallet’s assets.
-- `getNftApprovals()`: Get a list of approvals across all NFT contracts categorized by spenders for a wallet’s assets.
+- `getApprovals()`: Get a list of approvals across all ERC20 token contracts categorized by spenders for a wallet's assets.
+- `getNftApprovals()`: Get a list of approvals across all NFT contracts categorized by spenders for a wallet's assets.
 </details>
 
 <details>
@@ -333,13 +333,13 @@ The Covalent SDK provides comprehensive support for all Class A, Class B, and Pr
 
 - `getAllTransactionsForAddress()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Paginated)
 - `getAllTransactionsForAddressByPage()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications. (Nonpaginated)
-- `getTransactionsForAddressV3()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+- `getPaginatedTransactionsForAddress()`: Fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
 - `getTransaction()`: Fetch and render a single transaction including its decoded log events. Additionally return semantically decoded information for DEX trades, lending and NFT sales.
-- `getTransactionsForBlock()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+- `getTransactionsForBlockByPage()`: Fetch all transactions including their decoded log events in a block by page number and further flag interesting wallets or transactions.
+- `getTransactionsForBlock()`: Fetch all transactions including their decoded log events in a block by block hash and further flag interesting wallets or transactions.
 - `getTransactionSummary()`: 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.
 - `getTimeBucketTransactionsForAddress()`: Fetch all transactions including their decoded log events in a 15-minute time bucket interval.
-- `getTransactionsForBlockHashByPage()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
-- `getTransactionsForBlockHash()`: Fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+- `getEarliestTransactionsForAddress()`: Fetch and render the earliest transactions involving an address. Frequently seen in wallet applications.
 </details>
 
 ## Contributing

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "2.2.4";
+var version = "2.2.5";
 
 const bigIntParser = (val) => {
     if (val === null || val === undefined) {
@@ -2454,6 +2454,119 @@ class TransactionService {
         };
         return await this.execution.execute(endpoint, parseData);
     }
+    /**
+     *
+     * 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.
+     *
+     */
+    async getTransactionSummary(chainName, walletAddress, queryParamOpts) {
+        const endpoint = endpointGenerator(`${chainName}/address/${walletAddress}/transactions_summary`, [
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quoteCurrency,
+            },
+            {
+                key: "with-gas",
+                value: queryParamOpts?.withGas,
+            },
+        ]);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((txsItem) => ({
+                        ...txsItem,
+                        earliest_transaction: {
+                            ...txsItem.earliest_transaction,
+                            block_signed_at: txsItem?.earliest_transaction?.block_signed_at
+                                ? new Date(txsItem.earliest_transaction.block_signed_at)
+                                : null,
+                        },
+                        latest_transaction: {
+                            ...txsItem.latest_transaction,
+                            block_signed_at: txsItem?.latest_transaction?.block_signed_at
+                                ? new Date(txsItem?.latest_transaction?.block_signed_at)
+                                : null,
+                        },
+                        // ? API vs docs non-consistent
+                        // gas_summary: {
+                        //   ...txsItem.gas_summary,
+                        //   total_fees_paid: bigIntParser(
+                        //     txsItem.gas_summary.total_fees_paid
+                        //   ),
+                        // },
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
+    /**
+     *
+     * 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.
+     *
+     */
+    async getEarliestTransactionsForAddress(chainName, walletAddress, queryParamOpts) {
+        const searchParams = [
+            {
+                key: "quote-currency",
+                value: queryParamOpts?.quoteCurrency,
+            },
+            {
+                key: "no-logs",
+                value: queryParamOpts?.noLogs,
+            },
+        ];
+        const endpoint = endpointGenerator(`${chainName}/bulk/transactions/${walletAddress}`, searchParams);
+        const parseData = (data) => {
+            if (data.data) {
+                data.data.prev = data.data?.links?.prev
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.prev, searchParams), parseData)
+                    : null;
+                data.data.next = data.data?.links?.next
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.next, searchParams), parseData)
+                    : null;
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
+                data.data.items = data.data.items
+                    ? data.data.items.map((txItem) => ({
+                        ...txItem,
+                        value: bigIntParser(txItem.value),
+                        fees_paid: bigIntParser(txItem.fees_paid),
+                        block_signed_at: txItem.block_signed_at
+                            ? new Date(txItem.block_signed_at)
+                            : null,
+                        log_events: txItem.log_events
+                            ? txItem.log_events.map((logItem) => ({
+                                ...logItem,
+                                block_signed_at: logItem.block_signed_at
+                                    ? new Date(logItem.block_signed_at)
+                                    : null,
+                            }))
+                            : null,
+                    }))
+                    : null;
+            }
+            return data;
+        };
+        return await this.execution.execute(endpoint, parseData);
+    }
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -2604,18 +2717,18 @@ class TransactionService {
         return await this.execution.execute(endpoint, parseData);
     }
     /**
-     *
-     * 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.
      *
      */
-    async getTransactionsForBlock(chainName, blockHeight, queryParamOpts) {
-        const endpoint = endpointGenerator(`${chainName}/block/${blockHeight}/transactions_v3`, [
+    async getPaginatedTransactionsForAddress(chainName, walletAddress, page, queryParamOpts) {
+        const searchParams = [
             {
                 key: "quote-currency",
                 value: queryParamOpts?.quoteCurrency,
@@ -2624,9 +2737,20 @@ class TransactionService {
                 key: "no-logs",
                 value: queryParamOpts?.noLogs,
             },
-        ]);
+            {
+                key: "block-signed-at-asc",
+                value: queryParamOpts?.blockSignedAtAsc,
+            },
+        ];
+        const endpoint = endpointGenerator(`${chainName}/address/${walletAddress}/transactions_v3/page/${page}`, searchParams);
         const parseData = (data) => {
             if (data.data) {
+                data.data.prev = data.data?.links?.prev
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.prev, searchParams), parseData)
+                    : null;
+                data.data.next = data.data?.links?.next
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.next, searchParams), parseData)
+                    : null;
                 data.data.updated_at = data.data.updated_at
                     ? new Date(data.data.updated_at)
                     : null;
@@ -2654,54 +2778,54 @@ class TransactionService {
         return await this.execution.execute(endpoint, parseData);
     }
     /**
-     *
-     * 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.
      *
      */
-    async getTransactionSummary(chainName, walletAddress, queryParamOpts) {
-        const endpoint = endpointGenerator(`${chainName}/address/${walletAddress}/transactions_summary`, [
+    async getTimeBucketTransactionsForAddress(chainName, walletAddress, timeBucket, queryParamOpts) {
+        const searchParams = [
             {
                 key: "quote-currency",
                 value: queryParamOpts?.quoteCurrency,
             },
             {
-                key: "with-gas",
-                value: queryParamOpts?.withGas,
+                key: "no-logs",
+                value: queryParamOpts?.noLogs,
             },
-        ]);
+        ];
+        const endpoint = endpointGenerator(`${chainName}/bulk/transactions/${walletAddress}/${timeBucket}`, searchParams);
         const parseData = (data) => {
             if (data.data) {
+                data.data.prev = data.data?.links?.prev
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.prev, searchParams), parseData)
+                    : null;
+                data.data.next = data.data?.links?.next
+                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.next, searchParams), parseData)
+                    : null;
                 data.data.updated_at = data.data.updated_at
                     ? new Date(data.data.updated_at)
                     : null;
                 data.data.items = data.data.items
-                    ? data.data.items.map((txsItem) => ({
-                        ...txsItem,
-                        earliest_transaction: {
-                            ...txsItem.earliest_transaction,
-                            block_signed_at: txsItem?.earliest_transaction?.block_signed_at
-                                ? new Date(txsItem.earliest_transaction.block_signed_at)
-                                : null,
-                        },
-                        latest_transaction: {
-                            ...txsItem.latest_transaction,
-                            block_signed_at: txsItem?.latest_transaction?.block_signed_at
-                                ? new Date(txsItem?.latest_transaction?.block_signed_at)
-                                : null,
-                        },
-                        // ? API vs docs non-consistent
-                        // gas_summary: {
-                        //   ...txsItem.gas_summary,
-                        //   total_fees_paid: bigIntParser(
-                        //     txsItem.gas_summary.total_fees_paid
-                        //   ),
-                        // },
+                    ? data.data.items.map((txItem) => ({
+                        ...txItem,
+                        value: bigIntParser(txItem.value),
+                        fees_paid: bigIntParser(txItem.fees_paid),
+                        block_signed_at: txItem.block_signed_at
+                            ? new Date(txItem.block_signed_at)
+                            : null,
+                        log_events: txItem.log_events
+                            ? txItem.log_events.map((logItem) => ({
+                                ...logItem,
+                                block_signed_at: logItem.block_signed_at
+                                    ? new Date(logItem.block_signed_at)
+                                    : null,
+                            }))
+                            : null,
                     }))
                     : null;
             }
@@ -2710,17 +2834,18 @@ class TransactionService {
         return await this.execution.execute(endpoint, parseData);
     }
     /**
+     *
+     * 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.
      *
      */
-    async getTransactionsForAddressV3(chainName, walletAddress, page, queryParamOpts) {
+    async getTransactionsForBlockByPage(chainName, blockHeight, page, queryParamOpts) {
         const searchParams = [
             {
                 key: "quote-currency",
@@ -2730,23 +2855,19 @@ class TransactionService {
                 key: "no-logs",
                 value: queryParamOpts?.noLogs,
             },
-            {
-                key: "block-signed-at-asc",
-                value: queryParamOpts?.blockSignedAtAsc,
-            },
         ];
-        const endpoint = endpointGenerator(`${chainName}/address/${walletAddress}/transactions_v3/page/${page}`, searchParams);
+        const endpoint = endpointGenerator(`${chainName}/block/${blockHeight}/transactions_v3/page/${page}`, searchParams);
         const parseData = (data) => {
             if (data.data) {
+                data.data.updated_at = data.data.updated_at
+                    ? new Date(data.data.updated_at)
+                    : null;
                 data.data.prev = data.data?.links?.prev
                     ? async () => this.execution.execute(endpointGenerator(data.data?.links?.prev, searchParams), parseData)
                     : null;
                 data.data.next = data.data?.links?.next
                     ? async () => this.execution.execute(endpointGenerator(data.data?.links?.next, searchParams), parseData)
                     : null;
-                data.data.updated_at = data.data.updated_at
-                    ? new Date(data.data.updated_at)
-                    : null;
                 data.data.items = data.data.items
                     ? data.data.items.map((txItem) => ({
                         ...txItem,
@@ -2771,16 +2892,17 @@ class TransactionService {
         return await this.execution.execute(endpoint, parseData);
     }
     /**
+     *
+     * 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.
      *
      */
-    async getTimeBucketTransactionsForAddress(chainName, walletAddress, timeBucket, queryParamOpts) {
+    async getTransactionsForBlock(chainName, blockHash, queryParamOpts) {
         const searchParams = [
             {
                 key: "quote-currency",
@@ -2791,15 +2913,9 @@ class TransactionService {
                 value: queryParamOpts?.noLogs,
             },
         ];
-        const endpoint = endpointGenerator(`${chainName}/bulk/transactions/${walletAddress}/${timeBucket}`, searchParams);
+        const endpoint = endpointGenerator(`${chainName}/block_hash/${blockHash}/transactions_v3`, searchParams);
         const parseData = (data) => {
             if (data.data) {
-                data.data.prev = data.data?.links?.prev
-                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.prev, searchParams), parseData)
-                    : null;
-                data.data.next = data.data?.links?.next
-                    ? async () => this.execution.execute(endpointGenerator(data.data?.links?.next, searchParams), parseData)
-                    : null;
                 data.data.updated_at = data.data.updated_at
                     ? new Date(data.data.updated_at)
                     : null;
@@ -2826,6 +2942,12 @@ class TransactionService {
         };
         return await this.execution.execute(endpoint, parseData);
     }
+    /**
+     * @deprecated This method has been deprecated and will be removed in future releases. Use `getPaginatedTransactionsForAddress` instead.
+     */
+    async getTransactionsForAddressV3(chainName, walletAddress, page, queryParamOpts) {
+        return this.getPaginatedTransactionsForAddress(chainName, walletAddress, page, queryParamOpts);
+    }
 }
 
 async function debugOutput(settings, ...content) {