fixing DI for TxStatusWaiter

Author: Raunaque97

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts

@@ -13,6 +13,7 @@ import {
   SequencerModule,
 } from "../../sequencer/builder/SequencerModule";
 import { MinaTransactionSender } from "../../settlement/transactions/MinaTransactionSender";
+import { TxStatusWaiter } from "../../settlement/transactions/TxStatusWaiter";
 import { DefaultOutgoingMessageAdapter } from "../../settlement/messages/outgoing/DefaultOutgoingMessageAdapter";
 
 import { BaseLayer } from "./BaseLayer";
@@ -93,6 +94,10 @@ export class MinaBaseLayer
         useClass: MinaTransactionSender,
       },
 
+      TxStatusWaiter: {
+        useClass: TxStatusWaiter,
+      },
+
       L1TransactionDispatcherConfig: {
         useValue: {
           ...DEFAULT_L1_TRANSACTION_DISPATCHER_CONFIG,

packages/sequencer/src/settlement/transactions/L1TransactionDispatcher.ts

@@ -35,7 +35,7 @@ export class L1TransactionDispatcher {
     @inject("L1TransactionRetryStrategy")
     private readonly retryStrategy: L1TransactionRetryStrategy,
     @inject("SettlementSigner") private readonly signer: MinaSigner,
-    private readonly waiter: TxStatusWaiter,
+    @inject("TxStatusWaiter") private readonly waiter: TxStatusWaiter,
     @inject("L1TransactionDispatcherConfig")
     private readonly config: Required<DispatcherConfig>,
     @inject("BaseLayer")

packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts

@@ -34,7 +34,7 @@ export class MinaTransactionSender implements Closeable {
     @inject("SettlementSigner") private readonly signer: MinaSigner,
     @inject("FeeStrategy") private readonly feeStrategy: FeeStrategy,
     private readonly dispatcher: L1TransactionDispatcher,
-    private readonly waiter: TxStatusWaiter
+    @inject("TxStatusWaiter") private readonly waiter: TxStatusWaiter
   ) {
     this.dispatcher.start();
   }
@@ -90,6 +90,9 @@ export class MinaTransactionSender implements Closeable {
       queuedAt: now,
       nextActionAt: now,
     });
+    log.info(
+      `MinaTransactionSender: queued transaction ${txnId} for sender ${sender} nonce ${nonceNum}`
+    );
 
     this.dispatcher.requestDispatch(sender);
 

packages/sequencer/src/settlement/transactions/TxStatusWaiter.ts

@@ -2,6 +2,7 @@ import { inject, injectable } from "tsyringe";
 import {
   EventsRecord,
   ReplayingSingleUseEventEmitter,
+  log,
 } from "@proto-kit/common";
 
 import {
@@ -50,10 +51,12 @@ export class TxStatusWaiter {
 
   public notifyIncluded(txId: string, hash: string) {
     this.getEmitter(txId).emit("included", { hash });
+    this.emitters.delete(txId);
   }
 
   public notifyFailed(txId: string, error: unknown) {
     this.getEmitter(txId).emit("failed", { error });
+    this.emitters.delete(txId);
   }
 
   private static isSatisfied(
@@ -77,6 +80,9 @@ export class TxStatusWaiter {
   ): Promise<void> {
     const initial = await this.pendingStorage.findById(txId);
     if (!initial) {
+      log.info(
+        `TxStatusWaiter: waitFor(${desiredStatus}) unknown txId=${txId}`
+      );
       throw new Error(`Unknown pending L1 transaction id ${txId}`);
     }
     if (initial.status === "failed") {
@@ -89,25 +95,20 @@ export class TxStatusWaiter {
     const emitter = this.getEmitter(txId);
     const eventPromise = new Promise<void>((resolve, reject) => {
       emitter.on(desiredStatus, () => {
+        log.info(
+          `TxStatusWaiter: waitFor(${desiredStatus}) resolved by event txId=${txId}`
+        );
         resolve();
       });
       emitter.on("failed", ({ error }) => {
+        log.info(
+          `TxStatusWaiter: waitFor(${desiredStatus}) rejected by failed event txId=${txId}`,
+          error
+        );
         reject(error instanceof Error ? error : new Error(String(error)));
       });
     });
 
-    // if the status change happened between the first DB read and listener registration
-    const afterSubscribe = await this.pendingStorage.findById(txId);
-    if (!afterSubscribe) {
-      throw new Error(`Unknown pending L1 transaction id ${txId}`);
-    }
-    if (afterSubscribe.status === "failed") {
-      throw TxStatusWaiter.toError(afterSubscribe);
-    }
-    if (TxStatusWaiter.isSatisfied(afterSubscribe, desiredStatus)) {
-      return;
-    }
-
     if (options.timeoutMs !== undefined) {
       const timeoutPromise = new Promise<void>((_, reject) => {
         const t = setTimeout(() => {
@@ -119,13 +120,9 @@ export class TxStatusWaiter {
         }, options.timeoutMs);
         t.unref?.();
       });
-      await Promise.race([eventPromise, timeoutPromise]).finally(() => {
-        this.emitters.delete(txId);
-      });
+      await Promise.race([eventPromise, timeoutPromise]);
     } else {
-      await eventPromise.finally(() => {
-        this.emitters.delete(txId);
-      });
+      await eventPromise;
     }
   }
 }