Merge branch 'v-next' into keystore-error-message

Author: ChristopherDedominici

.changeset/olive-lobsters-carry.md

@@ -0,0 +1,6 @@
+---
+"@nomicfoundation/ignition-ui": patch
+"@nomicfoundation/hardhat-ignition": patch
+---
+
+update mermaid version and re-enable visualize task (v3)

pnpm-lock.yaml

@@ -39,7 +39,7 @@
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-react-hooks": "^5.1.0",
     "eslint-plugin-react-refresh": "^0.4.18",
-    "mermaid": "10.8.0",
+    "mermaid": "10.9.3",
     "mocha": "^10.0.0",
     "prettier": "3.2.5",
     "react": "^18.2.0",

v-next/hardhat-ignition-ui/package.json

@@ -99,10 +99,7 @@ const hardhatIgnitionPlugin: HardhatPlugin = {
       })
       .setAction(import.meta.resolve("./internal/tasks/wipe.js"))
       .build(),
-    task(
-      ["ignition", "visualize"],
-      "Not implemented yet - to be available soon",
-    )
+    task(["ignition", "visualize"], "Visualize a module as an HTML report")
       .addPositionalArgument({
         name: "modulePath",
         type: ArgumentType.FILE,

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

@@ -1,77 +1,68 @@
 import type { HardhatRuntimeEnvironment } from "hardhat/types/hre";
 import type { NewTaskActionFunction } from "hardhat/types/tasks";
 
-// import path from "node:path";
+import path from "node:path";
 
-// import { HardhatError } from "@nomicfoundation/hardhat-errors";
-// import {
-//   batches,
-//   IgnitionError,
-//   IgnitionModuleSerializer,
-// } from "@nomicfoundation/ignition-core";
+import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import {
+  batches,
+  IgnitionError,
+  IgnitionModuleSerializer,
+} from "@nomicfoundation/ignition-core";
 
-// import { loadModule } from "../utils/load-module.js";
-// import { open } from "../utils/open.js";
-// import { shouldBeHardhatPluginError } from "../utils/shouldBeHardhatPluginError.js";
-// import { writeVisualization } from "../visualization/write-visualization.js";
-import chalk from "chalk";
+import { loadModule } from "../utils/load-module.js";
+import { open } from "../utils/open.js";
+import { shouldBeHardhatPluginError } from "../utils/shouldBeHardhatPluginError.js";
+import { writeVisualization } from "../visualization/write-visualization.js";
 
 interface TaskVisualizeArguments {
   modulePath: string;
   noOpen: boolean;
 }
 
 const visualizeTask: NewTaskActionFunction<TaskVisualizeArguments> = async (
-  _args: { noOpen: boolean; modulePath: string },
-  _hre: HardhatRuntimeEnvironment,
+  { noOpen, modulePath }: { noOpen: boolean; modulePath: string },
+  hre: HardhatRuntimeEnvironment,
 ) => {
-  console.log(
-    chalk.yellow(
-      "This task will be implemented soon. Check back soon for more updates.",
-    ),
-  );
+  await hre.tasks.getTask("compile").run({ quiet: true });
 
-  return;
+  const userModule = await loadModule(hre.config.paths.ignition, modulePath);
 
-  // await hre.tasks.getTask("compile").run({ quiet: true });
+  if (userModule === undefined) {
+    throw new HardhatError(HardhatError.ERRORS.IGNITION.NO_MODULES_FOUND);
+  }
 
-  // const userModule = await loadModule(hre.config.paths.ignition, modulePath);
+  try {
+    const serializedIgnitionModule =
+      IgnitionModuleSerializer.serialize(userModule);
 
-  // if (userModule === undefined) {
-  //   throw new HardhatError(HardhatError.ERRORS.IGNITION.NO_MODULES_FOUND);
-  // } else {
-  //   try {
-  //     const serializedIgnitionModule =
-  //       IgnitionModuleSerializer.serialize(userModule);
+    const batchInfo = batches(userModule);
 
-  //     const batchInfo = batches(userModule);
+    await writeVisualization(
+      { module: serializedIgnitionModule, batches: batchInfo },
+      {
+        cacheDir: hre.config.paths.cache,
+      },
+    );
+  } catch (e) {
+    if (e instanceof IgnitionError && shouldBeHardhatPluginError(e)) {
+      throw new HardhatError(HardhatError.ERRORS.IGNITION.INTERNAL_ERROR, e);
+    }
 
-  //     await writeVisualization(
-  //       { module: serializedIgnitionModule, batches: batchInfo },
-  //       {
-  //         cacheDir: hre.config.paths.cache,
-  //       },
-  //     );
-  //   } catch (e) {
-  //     if (e instanceof IgnitionError && shouldBeHardhatPluginError(e)) {
-  //       throw new HardhatError(HardhatError.ERRORS.IGNITION.INTERNAL_ERROR, e);
-  //     }
+    throw e;
+  }
 
-  //     throw e;
-  //   }
-  // }
+  if (!noOpen) {
+    const indexFile = path.join(
+      hre.config.paths.cache,
+      "visualization",
+      "index.html",
+    );
 
-  // if (!noOpen) {
-  //   const indexFile = path.join(
-  //     hre.config.paths.cache,
-  //     "visualization",
-  //     "index.html",
-  //   );
+    console.log(`Deployment visualization written to ${indexFile}`);
 
-  //   console.log(`Deployment visualization written to ${indexFile}`);
-
-  //   open(indexFile);
-  // }
+    open(indexFile);
+  }
 };
 
 export default visualizeTask;