fix: update JSDoc comments for scrapeEvents to match actual behavior

src/libexec/RelayerSpokePoolListenerSVM.ts

@@ -71,10 +71,10 @@ function logFromEvent(event: Pick<EventWithData, "slot" | "program" | "signature
 }
 
 /**
- * Aggregate utils/scrapeEvents for a series of event names.
- * @param spokePool Ethers Contract instance.
+ * Aggregate utils/scrapeEvents for a series of event names and submit them to the parent process.
+ * @param eventsClient SVM CPI events client instance.
  * @param eventNames The array of events to be queried.
- * @param opts Options to configure event scraping behaviour.
+ * @param opts Options to configure event scraping behaviour, including the target block number.
  * @returns void
  */
 async function scrapeEvents(

src/libexec/util/evm/util.ts

@@ -4,13 +4,13 @@ import { getNetworkName, paginatedEventQuery, Profiler, Provider, winston } from
 import { Log, ScraperOpts } from "../../types";
 
 /**
- * Given a SpokePool contract instance and an event name, scrape all corresponding events and submit them to the
- * parent process (if defined).
+ * Scrape events from a contract for a given event signature within a specified block range.
  * @param provider Ethers RPC provider instance.
  * @param address Contract address to filter on.
  * @param event The event descriptor to filter for.
- * @param opts Options to configure event scraping behaviour.
- * @returns void
+ * @param opts Options to configure event scraping behaviour, including the target block number.
+ * @param logger Optional Winston logger instance.
+ * @returns Promise resolving to an array of log entries.
  */
 export async function scrapeEvents(
   provider: Provider,

src/libexec/util/svm/util.ts

@@ -4,12 +4,13 @@ import { Profiler, winston } from "../../../utils";
 import { ScraperOpts } from "../../types";
 
 /**
- * Given a SpokePool contract instance and an event name, scrape all corresponding events and submit them to the
- * parent process (if defined).
- * @param spokePool Ethers Contract instance.
+ * Scrape events from a SVM CPI events client for a given event name within a specified block range.
+ * @param chain Chain name identifier.
+ * @param eventsClient SVM CPI events client instance.
  * @param eventName The name of the event to be filtered.
- * @param opts Options to configure event scraping behaviour.
- * @returns void
+ * @param opts Options to configure event scraping behaviour, including the target block number.
+ * @param logger Winston logger instance.
+ * @returns Promise resolving to an array of events with data.
  */
 export async function scrapeEvents(
   chain: string,