port txHash bug fix to v3

Author: zoeyTM

v-next/hardhat-ignition-core/src/index.ts

@@ -19,5 +19,6 @@ export * from "./types/provider.js";
 export * from "./types/serialization.js";
 export * from "./types/status.js";
 export * from "./types/verify.js";
+export { trackTransaction } from "./track-transaction.js";
 export { getVerificationInformation } from "./verify.js";
 export { wipe } from "./wipe.js";

v-next/hardhat-ignition-core/src/internal/errors-list.ts

@@ -78,6 +78,11 @@ export const ERROR_RANGES: {
     max: 1299,
     title: "List transactions errors",
   },
+  TRACK_TRANSACTION: {
+    min: 1300,
+    max: 1399,
+    title: "Track transaction errors",
+  },
 };
 
 /**
@@ -201,6 +206,12 @@ export const ERRORS = {
       number: 410,
       message: "Gas estimation failed: %error%",
     },
+    TRANSACTION_LOST: {
+      number: 411,
+      message: `An error occured while trying to send a transaction for future %futureId%.
+Please use a block explorer to find the hash of the transaction with nonce %nonce% sent from account %sender% and use the following command to add it to your deployment:
+npx hardhat ignition track-tx <txHash> <deploymentId> --network <networkName>`,
+    },
   },
   RECONCILIATION: {
     INVALID_EXECUTION_STATUS: {
@@ -412,6 +423,36 @@ export const ERRORS = {
         "Cannot list transactions for nonexistant deployment at %deploymentDir%",
     },
   },
+  TRACK_TRANSACTION: {
+    DEPLOYMENT_DIR_NOT_FOUND: {
+      number: 1300,
+      message: "Deployment directory %deploymentDir% not found",
+    },
+    UNINITIALIZED_DEPLOYMENT: {
+      number: 1301,
+      message:
+        "Cannot track transaction for nonexistant deployment at %deploymentDir%",
+    },
+    TRANSACTION_NOT_FOUND: {
+      number: 1302,
+      message: `Transaction %txHash% not found. Please double check the transaction hash and try again.`,
+    },
+    MATCHING_NONCE_NOT_FOUND: {
+      number: 1303,
+      message: `The transaction you provided doesn't seem to belong to your deployment.
+Please double check the error you are getting when running Hardhat Ignition, and the instructions it's providing.`,
+    },
+    KNOWN_TRANSACTION: {
+      number: 1304,
+      message: `The transaction hash that you provided was already present in your deployment. 
+Please double check the error you are getting when running Hardhat Ignition, and the instructions it's providing.`,
+    },
+    INSUFFICIENT_CONFIRMATIONS: {
+      number: 1305,
+      message: `The transaction you provided doesn't have enough confirmations yet. 
+Please try again later.`,
+    },
+  },
 };
 
 /**

v-next/hardhat-ignition-core/src/internal/execution/deployment-state-helpers.ts

@@ -51,9 +51,9 @@ export async function initializeDeploymentState(
  * This function applies a new message to the deployment state, recording it to the
  * journal if needed.
  *
- * @param message The message to apply.
- * @param deploymentState The original deployment state.
- * @param deploymentLoader The deployment loader that will be used to record the message.
+ * @param message - The message to apply.
+ * @param deploymentState - The original deployment state.
+ * @param deploymentLoader - The deployment loader that will be used to record the message.
  * @returns The new deployment state.
  */
 export async function applyNewMessage(

v-next/hardhat-ignition-core/src/internal/execution/execution-engine.ts

@@ -13,9 +13,12 @@ import type { DeploymentLoader } from "../deployment-loader/types.js";
 
 import sortBy from "lodash-es/sortBy.js";
 
+import { IgnitionError } from "../../errors.js";
 import { ExecutionEventType } from "../../types/execution-events.js";
+import { ERRORS } from "../errors-list.js";
 import { assertIgnitionInvariant } from "../utils/assertions.js";
 import { getFuturesFromModule } from "../utils/get-futures-from-module.js";
+import { getNetworkExecutionStates } from "../views/execution-state/get-network-execution-states.js";
 import { getPendingNonceAndSender } from "../views/execution-state/get-pending-nonce-and-sender.js";
 import { hasExecutionSucceeded } from "../views/has-execution-succeeded.js";
 import { isBatchFinished } from "../views/is-batch-finished.js";
@@ -26,6 +29,7 @@ import { getMaxNonceUsedBySender } from "./nonce-management/get-max-nonce-used-b
 import { getNonceSyncMessages } from "./nonce-management/get-nonce-sync-messages.js";
 import { JsonRpcNonceManager } from "./nonce-management/json-rpc-nonce-manager.js";
 import { TransactionTrackingTimer } from "./transaction-tracking-timer.js";
+import { NetworkInteractionType } from "./types/network-interaction.js";
 
 /**
  * This class is used to execute a module to completion, returning the new
@@ -69,6 +73,8 @@ export class ExecutionEngine {
     deploymentParameters: DeploymentParameters,
     defaultSender: string,
   ): Promise<DeploymentState> {
+    await this._checkForMissingTransactions(deploymentState);
+
     deploymentState = await this._syncNonces(
       deploymentState,
       module,
@@ -199,6 +205,32 @@ export class ExecutionEngine {
     }
   }
 
+  /**
+   * Checks the journal for missing transactions, throws if any are found
+   * and asks the user to track the missing transaction via the `track-tx` command.
+   */
+  private async _checkForMissingTransactions(
+    deploymentState: DeploymentState,
+  ): Promise<void> {
+    const exStates = getNetworkExecutionStates(deploymentState);
+
+    for (const exState of exStates) {
+      for (const ni of exState.networkInteractions) {
+        if (
+          ni.type === NetworkInteractionType.ONCHAIN_INTERACTION &&
+          ni.nonce !== undefined &&
+          ni.transactions.length === 0
+        ) {
+          throw new IgnitionError(ERRORS.EXECUTION.TRANSACTION_LOST, {
+            futureId: exState.id,
+            nonce: ni.nonce,
+            sender: exState.from,
+          });
+        }
+      }
+    }
+  }
+
   /**
    * Syncs the nonces of the deployment state with the blockchain, returning
    * the new deployment state, and throwing if they can't be synced.

v-next/hardhat-ignition-core/src/internal/execution/future-processor/future-processor.ts

@@ -195,6 +195,7 @@ export class FutureProcessor {
           this._jsonRpcClient,
           this._nonceManager,
           this._transactionTrackingTimer,
+          this._deploymentLoader,
         );
 
       case NextAction.QUERY_STATIC_CALL:

v-next/hardhat-ignition-core/src/internal/execution/future-processor/handlers/send-transaction.ts

@@ -18,6 +18,7 @@ import type {
   TransactionSendMessage,
 } from "../../types/messages.js";
 
+import { DeploymentLoader } from "../../../deployment-loader/types.js";
 import { assertIgnitionInvariant } from "../../../utils/assertions.js";
 import { ExecutionResultType } from "../../types/execution-result.js";
 import { JournalMessageType } from "../../types/messages.js";
@@ -58,6 +59,7 @@ export async function sendTransaction(
   jsonRpcClient: JsonRpcClient,
   nonceManager: NonceManager,
   transactionTrackingTimer: TransactionTrackingTimer,
+  deploymentLoader: DeploymentLoader,
 ): Promise<
   | TransactionSendMessage
   | DeploymentExecutionStateCompleteMessage
@@ -89,6 +91,8 @@ export async function sendTransaction(
     lastNetworkInteraction,
     nonceManager,
     decodeSimulationResult(strategyGenerator, exState),
+    deploymentLoader,
+    exState.id,
   );
 
   // If the transaction failed during simulation, we need to revert the nonce allocation

v-next/hardhat-ignition-core/src/internal/execution/future-processor/helpers/network-interaction-execution.ts

@@ -22,8 +22,10 @@ import type {
 } from "../../types/network-interaction.js";
 
 import { IgnitionError } from "../../../../errors.js";
+import { DeploymentLoader } from "../../../deployment-loader/types.js";
 import { ERRORS } from "../../../errors-list.js";
 import { assertIgnitionInvariant } from "../../../utils/assertions.js";
+import { JournalMessageType } from "../../types/messages.js";
 
 /**
  * Runs a StaticCall NetworkInteraction to completion, returning its raw result.
@@ -108,12 +110,14 @@ export async function sendTransactionForOnchainInteraction(
     | StrategySimulationErrorExecutionResult
     | undefined
   >,
+  deploymentLoader: DeploymentLoader,
+  futureId: string,
 ): Promise<
   | SimulationErrorExecutionResult
   | StrategySimulationErrorExecutionResult
   | {
       type: typeof TRANSACTION_SENT_TYPE;
-      transaction: Transaction;
+      transaction: Pick<Transaction, "hash" | "fees">;
       nonce: number;
     }
 > {
@@ -201,6 +205,13 @@ export async function sendTransactionForOnchainInteraction(
     return decodedSimulationResult;
   }
 
+  await deploymentLoader.recordToJournal({
+    type: JournalMessageType.TRANSACTION_PREPARE_SEND,
+    futureId,
+    networkInteractionId: onchainInteraction.id,
+    nonce: transactionParams.nonce,
+  });
+
   const txHash = await client.sendTransaction(transactionParams);
 
   return {