improve: comment feedback

Signed-off-by: james-a-morris <[email protected]>

Author: james-a-morris

src/arch/svm/SpokeUtils.ts

@@ -30,11 +30,11 @@ export function getTimeAt(_spokePool: unknown, _blockNumber: number): Promise<nu
 }
 
 /**
- * Retrieves the chain time at a particular block.
+ * Retrieves the chain time at a particular slot.
  * @note This should be the same as getTimeAt() but can differ in test. These two functions should be consolidated.
- * @returns The chain time at the specified block tag.
+ * @returns The chain time at the specified slot.
  */
-export async function getTimestampForBlock(provider: Provider, slotNumber: number): Promise<number> {
+export async function getTimestampForSlot(provider: Provider, slotNumber: number): Promise<number> {
   const block = await provider.getBlock(BigInt(slotNumber)).send();
   let timestamp: number;
   if (!block?.blockTime) {
@@ -67,50 +67,6 @@ export function getDepositIdAtBlock(_contract: unknown, _blockTag: number): Prom
   throw new Error("getDepositIdAtBlock: not implemented");
 }
 
-/**
- * xxx todo
- */
-export async function getSlotForBlock(
-  provider: Provider,
-  blockNumber: bigint,
-  lowSlot: bigint,
-  _highSlot?: bigint
-): Promise<bigint | undefined> {
-  // @todo: Factor getBlock out to SlotFinder ??
-  const getBlockNumber = async (slot: bigint): Promise<bigint> => {
-    const block = await provider
-      .getBlock(slot, { transactionDetails: "none", maxSupportedTransactionVersion: 0 })
-      .send();
-    return block?.blockHeight ?? BigInt(0); // @xxx Handle undefined here!
-  };
-
-  let highSlot = _highSlot ?? (await provider.getSlot().send());
-  const [blockLow = 0, blockHigh = 1_000_000_000] = await Promise.all([
-    getBlockNumber(lowSlot),
-    getBlockNumber(highSlot),
-  ]);
-
-  if (blockLow > blockNumber || blockHigh < blockNumber) {
-    return undefined; // blockNumber did not occur within the specified block range.
-  }
-
-  // Find the lowest slot number where blockHeight is greater than the requested blockNumber.
-  do {
-    const midSlot = (highSlot + lowSlot) / BigInt(2);
-    const midBlock = await getBlockNumber(midSlot);
-
-    if (midBlock < blockNumber) {
-      lowSlot = midSlot + BigInt(1);
-    } else if (midBlock > blockNumber) {
-      highSlot = midSlot + BigInt(1); // blockNumber occurred at or earlier than midBlock.
-    } else {
-      return midSlot;
-    }
-  } while (lowSlot <= highSlot);
-
-  return undefined;
-}
-
 export function findDepositBlock(
   _spokePool: unknown,
   depositId: BigNumber,

src/clients/SpokePoolClient/SVMSpokePoolClient.ts

@@ -5,9 +5,8 @@ import {
   SvmSpokeEventsClient,
   unwrapEventData,
   getFillDeadline,
-  getTimestampForBlock,
+  getTimestampForSlot,
   getStatePda,
-  getSlotForBlock,
 } from "../../arch/svm";
 import { FillStatus, RelayData, SortableEvent } from "../../interfaces";
 import {
@@ -132,7 +131,7 @@ export class SvmSpokePoolClient extends SpokePoolClient {
         );
         return events.map(
           (event): SortableEvent => ({
-            transactionHash: event.signature.toLowerCase(),
+            transactionHash: event.signature,
             blockNumber: Number(event.slot),
             transactionIndex: 0,
             logIndex: 0,
@@ -169,13 +168,8 @@ export class SvmSpokePoolClient extends SpokePoolClient {
   /**
    * Retrieves the timestamp for a given SVM slot number.
    */
-  public override async getTimestampForBlock(blockNumber: number): Promise<number> {
-    const slot = await getSlotForBlock(this.rpc, BigInt(blockNumber), BigInt(this.deploymentBlock));
-    if (!slot) {
-      this.log("error", `SvmSpokePoolClient::getTimestampForBlock: could not get slot for block ${blockNumber}`);
-      throw new Error(`SvmSpokePoolClient::getTimestampForBlock: could not get slot for block ${blockNumber}`);
-    }
-    return getTimestampForBlock(this.rpc, Number(slot));
+  public override getTimestampForBlock(slot: number): Promise<number> {
+    return getTimestampForSlot(this.rpc, slot);
   }
 
   /**