adjusted 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/protocol/baselayer/network-utils/LightnetUtils.ts

@@ -105,11 +105,7 @@ export class LightnetUtils implements MinaNetworkUtils {
 
     tx.sign([faucetDonor]);
 
-    await this.transactionSender.signProveAndSendTransaction(
-      tx,
-      [faucetDonorPublicKey],
-      "included"
-    );
+    await this.transactionSender.proveAndSendTransaction(tx, "included");
 
     log.provable.info(
       `Funded account ${receiver.toBase58()} with ${fundingAmount / 1e9} MINA`

packages/sequencer/src/protocol/baselayer/network-utils/LocalBlockchainUtils.ts

@@ -87,11 +87,7 @@ export class LocalBlockchainUtils implements MinaNetworkUtils {
 
     tx.sign([faucetDonor]);
 
-    await this.transactionSender.signProveAndSendTransaction(
-      tx,
-      [faucetDonorPublicKey],
-      "included"
-    );
+    await this.transactionSender.proveAndSendTransaction(tx, "included");
 
     log.provable.info(
       `Funded account ${receiver.toBase58()} with ${fundingAmount / 1e9} MINA`

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 {
@@ -79,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") {
@@ -90,24 +94,21 @@ export class TxStatusWaiter {
 
     const emitter = this.getEmitter(txId);
     const eventPromise = new Promise<void>((resolve, reject) => {
-      emitter.on(desiredStatus, () => resolve());
+      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(() => {

packages/sequencer/test/settlement/MinaTransactionSender.test.ts

@@ -38,6 +38,11 @@ type SenderFixture = {
   retryStrategy: any;
 };
 
+type BaseLayerStub = {
+  isLocalBlockChain: () => boolean;
+  config: { network: { type: "local" | "remote" | "lightnet" } };
+};
+
 function makeSender(
   pendingStorage: PendingL1TransactionStorage,
   dispatcherConfig: {
@@ -47,6 +52,10 @@ function makeSender(
   } = {
     pollIntervalMs: 5,
     statusCheckIntervalMs: 5,
+  },
+  baseLayerStub: BaseLayerStub = {
+    isLocalBlockChain: () => true,
+    config: { network: { type: "local" } },
   }
 ): SenderFixture {
   const flowCreator = {
@@ -73,8 +82,6 @@ function makeSender(
     applyTransaction: jest.fn(async () => undefined),
   } as any;
 
-  const baseLayer = { config: { network: { type: "local" } } } as any;
-
   const retryStrategy = {
     shouldRetry: jest.fn(async () => true),
     prepareRetryTransaction: jest.fn(async (record: any) => record.transaction),
@@ -89,13 +96,14 @@ function makeSender(
     retryStrategy as any,
     signer as any,
     waiter,
-    dispatcherConfig
+    dispatcherConfig,
+    baseLayerStub as any
   );
   const sender = new MinaTransactionSender(
     flowCreator,
     provingTask,
     simulator,
-    baseLayer,
+    baseLayerStub as any,
     pendingStorage as any,
     signer,
     feeStrategy,
@@ -134,7 +142,6 @@ describe("MinaTransactionSender (unit)", () => {
     const pendingStorage: PendingL1TransactionStorage =
       new InMemoryPendingL1TransactionStorage();
     const { sender } = makeSender(pendingStorage);
-    checkZkappTransactionStatus.mockResolvedValue({ success: false });
 
     const { tx } = makeTx({ senderBase58: "S", nonce: 0, hash: "H1" });
 
@@ -159,7 +166,6 @@ describe("MinaTransactionSender (unit)", () => {
     const pendingStorage: PendingL1TransactionStorage =
       new InMemoryPendingL1TransactionStorage();
     const { sender } = makeSender(pendingStorage);
-    checkZkappTransactionStatus.mockResolvedValueOnce({ success: true });
 
     const { tx } = makeTx({ senderBase58: "S", nonce: 0, hash: "H2" });
     try {
@@ -178,7 +184,6 @@ describe("MinaTransactionSender (unit)", () => {
     const pendingStorage: PendingL1TransactionStorage =
       new InMemoryPendingL1TransactionStorage();
     const { sender } = makeSender(pendingStorage);
-    checkZkappTransactionStatus.mockResolvedValue({ success: false });
 
     const tx0 = makeTx({ senderBase58: "S", nonce: 0, hash: "H0" });
     const tx1 = makeTx({ senderBase58: "S", nonce: 1, hash: "H1" });
@@ -202,11 +207,18 @@ describe("MinaTransactionSender (unit)", () => {
   it("should retry a transaction if first attempt fails", async () => {
     const pendingStorage: PendingL1TransactionStorage =
       new InMemoryPendingL1TransactionStorage();
-    const { sender } = makeSender(pendingStorage, {
-      pollIntervalMs: 5,
-      statusCheckIntervalMs: 0,
-      inclusionTimeoutMs: 0,
-    });
+    const { sender } = makeSender(
+      pendingStorage,
+      {
+        pollIntervalMs: 5,
+        statusCheckIntervalMs: 0,
+        inclusionTimeoutMs: 0,
+      },
+      {
+        isLocalBlockChain: () => false,
+        config: { network: { type: "remote" } },
+      }
+    );
 
     const { tx } = makeTx({ senderBase58: "S", nonce: 0, hash: "H-R1" });
 
@@ -238,11 +250,18 @@ describe("MinaTransactionSender (unit)", () => {
   it("should stop retrying when shouldRetry returns false", async () => {
     const pendingStorage: PendingL1TransactionStorage =
       new InMemoryPendingL1TransactionStorage();
-    const { sender, retryStrategy } = makeSender(pendingStorage, {
-      pollIntervalMs: 5,
-      statusCheckIntervalMs: 0,
-      inclusionTimeoutMs: 0,
-    });
+    const { sender, retryStrategy } = makeSender(
+      pendingStorage,
+      {
+        pollIntervalMs: 5,
+        statusCheckIntervalMs: 0,
+        inclusionTimeoutMs: 0,
+      },
+      {
+        isLocalBlockChain: () => false,
+        config: { network: { type: "remote" } },
+      }
+    );
 
     // Force "no retry"
     retryStrategy.shouldRetry = jest.fn(async () => false);