Update for Hardhat 3

.lintstagedrc.json

@@ -1,3 +1,3 @@
 {
-  "*.{js,ts,ejs,sol,json,md}": ["prettier --write"]
+  "*.{js,ts,sol,json,md}": ["prettier --write"]
 }

.prettierrc.json

@@ -4,7 +4,7 @@
   "trailingComma": "all",
   "bracketSpacing": true,
   "plugins": [
-    "prettier-plugin-ejs",
+    "prettier-plugin-packagejson",
     "prettier-plugin-solidity",
     "@trivago/prettier-plugin-sort-imports"
   ]

README.md

@@ -17,7 +17,16 @@ yarn add --dev @solidstate/hardhat-storage-layout-diff
 Load plugin in Hardhat config:
 
 ```javascript
-require('@solidstate/hardhat-storage-layout-diff');
+import HardhatStorageLayoutDiff from '@solidstate/hardhat-storage-layout-diff';
+
+const config: HardhatUserConfig = {
+  plugins: [
+    HardhatStorageLayoutDiff,
+  ],
+  storageLayoutDiff: {
+    ... // see table for configuration options
+  },
+};
 ```
 
 Add configuration under the `storageLayoutDiff` key:
@@ -31,6 +40,8 @@ Add configuration under the `storageLayoutDiff` key:
 | `except`  | `Array` of `String` matchers used to exclude contracts                                                     | `[]`                                                           |
 | `spacing` | number of spaces per indentation level of formatted output                                                 | `2`                                                            |
 
+Additional configuration options are provided by [`@solidstate/hardhat-git`](https://www.npmjs.com/package/@solidstate/hardhat-git), which is included as a dependency.
+
 Export storage layouts:
 
 ```bash
@@ -39,24 +50,26 @@ npx hardhat export-storage-layout
 yarn run hardhat export-storage-layout
 ```
 
-Compare two contracts:
+Inspect a contract's storage layout:
 
 ```bash
-npx hardhat diff-storage-layout [CONTRACT_A_FULLY_QUALIFIED_NAME] [CONTRACT_B_FULLY_QUALIFIED_NAME]
+npx hardhat inspect-storage-layout [CONTRACT_IDENTIFIER]
 # or
-yarn run hardhat diff-storage-layout [CONTRACT_A_FULLY_QUALIFIED_NAME] [CONTRACT_B_FULLY_QUALIFIED_NAME]
+yarn run hardhat inspect-storage-layout [CONTRACT_IDENTIFIER]
 ```
 
-Include the optional `--a-ref` and/or `--b-ref` arguments to specify the git reference where contracts `a` and `b` are defined, respectively.
-
-Compare a contract to an exported JSON layout:
+Compare two contracts:
 
 ```bash
-npx hardhat storage-layout-check --source [PATH_TO_LAYOUT_JSON] --b [CONTRACT_B_FULLY_QUALIFIED_NAME]
+npx hardhat diff-storage-layout [CONTRACT_A_IDENTIFIER] [CONTRACT_B_IDENTIFIER]
 # or
-yarn run hardhat storage-layout-check --source [PATH_TO_LAYOUT_JSON] --b [CONTRACT_B_FULLY_QUALIFIED_NAME]
+yarn run hardhat diff-storage-layout [CONTRACT_A_IDENTIFIER] [CONTRACT_B_IDENTIFIER]
 ```
 
+A contract identifier may be a name, a fully qualified name, or a path to a JSON file containing a storage layout.
+
+Include the optional git ref options to look up a contract identifier at a particular git reference.
+
 ## Development
 
 Install dependencies via Yarn:

contracts/Test.sol

@@ -10,7 +10,7 @@ contract Test {
     struct Struct {
         address a;
         E e;
-        address b;
+        address b_changed;
         E f;
     }
 

hardhat.config.ts

@@ -1,8 +1,9 @@
-import './src/index';
+import HardhatStorageLayoutDiff from './src/index.js';
 import { HardhatUserConfig } from 'hardhat/config';
 
 const config: HardhatUserConfig = {
   solidity: '0.8.28',
+  plugins: [HardhatStorageLayoutDiff],
 };
 
 export default config;

package.json

@@ -1,7 +1,6 @@
 {
   "name": "@solidstate/hardhat-storage-layout-diff",
   "version": "1.0.0",
-  "license": "MIT",
   "description": "Compare storage layouts between two contracts",
   "keywords": [
     "hardhat",
@@ -15,39 +14,41 @@
     "wow"
   ],
   "repository": "github:solidstate-network/hardhat-storage-layout-diff",
+  "license": "MIT",
   "author": "Nick Barry",
+  "type": "module",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
-  "scripts": {
-    "build": "tsc --build --clean",
-    "prepare": "husky",
-    "prettier": "prettier --write ."
-  },
   "files": [
     "dist/src",
     "src"
   ],
-  "peerDependencies": {
-    "hardhat": "^2.0.0"
+  "scripts": {
+    "build": "yarn clean && tsc --build",
+    "clean": "tsc --build --clean",
+    "prepare": "husky",
+    "prettier": "prettier --write ."
+  },
+  "dependencies": {
+    "@solidstate/hardhat-git": "^1.0.0-next.2",
+    "chalk": "^5.4.1",
+    "cli-table3": "^0.6.5",
+    "simple-git": "^3.27.0"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^5.2.2",
-    "@types/ejs": "^3.1.5",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^22.14.1",
-    "hardhat": "^2.23.0",
+    "@types/node": "^22.15.17",
+    "hardhat": "^3.0.0-next.7",
     "husky": "^9.1.7",
-    "lint-staged": "^15.5.1",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.5.3",
-    "prettier-plugin-ejs": "^1.0.3",
-    "prettier-plugin-solidity": "^1.4.2",
+    "prettier-plugin-packagejson": "^2.5.12",
+    "prettier-plugin-solidity": "^2.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   },
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "cli-table3": "^0.6.5",
-    "simple-git": "^3.27.0"
+  "peerDependencies": {
+    "hardhat": "^3.0.0-next.6"
   },
   "publishConfig": {
     "access": "public"

src/actions/diff_storage_layout.ts

@@ -0,0 +1,51 @@
+import { printMergedCollatedSlots } from '../lib/print.js';
+import {
+  collateStorageLayout,
+  loadStorageLayout,
+  mergeCollatedSlots,
+} from '../lib/storage_layout_diff.js';
+import { TASK_COMPILE } from '../task_names.js';
+import { createHardhatRuntimeEnvironmentAtGitRef } from '@solidstate/hardhat-git';
+import type { NewTaskActionFunction } from 'hardhat/types/tasks';
+
+interface DiffStorageLayoutTaskActionArguments {
+  a: string;
+  b: string;
+  aRef?: string;
+  bRef?: string;
+  noCompile: boolean;
+}
+
+const action: NewTaskActionFunction<
+  DiffStorageLayoutTaskActionArguments
+> = async (args, hre) => {
+  const { aRef, bRef } = args;
+
+  const hreRefA = aRef
+    ? await createHardhatRuntimeEnvironmentAtGitRef(hre.config, aRef)
+    : hre;
+
+  const hreRefB =
+    bRef === aRef
+      ? hreRefA
+      : bRef
+        ? await createHardhatRuntimeEnvironmentAtGitRef(hre.config, bRef)
+        : hre;
+
+  if (!args.noCompile) {
+    await hreRefA.tasks.getTask(TASK_COMPILE).run();
+
+    if (aRef !== bRef) {
+      await hreRefB.tasks.getTask(TASK_COMPILE).run();
+    }
+  }
+
+  const slotsA = collateStorageLayout(await loadStorageLayout(hreRefA, args.a));
+  const slotsB = collateStorageLayout(await loadStorageLayout(hreRefB, args.b));
+
+  const mergedSlots = mergeCollatedSlots(slotsA, slotsB);
+
+  printMergedCollatedSlots(mergedSlots);
+};
+
+export default action;

src/actions/export_storage_layout.ts.ts

@@ -0,0 +1,72 @@
+import pkg from '../../package.json';
+import { loadStorageLayout } from '../lib/storage_layout_diff.js';
+import { TASK_COMPILE } from '../task_names.js';
+import { HardhatPluginError } from 'hardhat/plugins';
+import type { NewTaskActionFunction } from 'hardhat/types/tasks';
+import fs from 'node:fs';
+import path from 'node:path';
+
+interface TaskActionArguments {
+  noCompile: boolean;
+}
+
+const action: NewTaskActionFunction<TaskActionArguments> = async (
+  args,
+  hre,
+) => {
+  if (!args.noCompile) {
+    await hre.tasks.getTask(TASK_COMPILE).run();
+  }
+
+  const config = hre.config.storageLayoutDiff;
+
+  const outputDirectory = path.resolve(hre.config.paths.root, config.path);
+
+  if (!outputDirectory.startsWith(hre.config.paths.root)) {
+    throw new HardhatPluginError(
+      pkg.name,
+      'resolved path must be inside of project directory',
+    );
+  }
+
+  if (outputDirectory === hre.config.paths.root) {
+    throw new HardhatPluginError(
+      pkg.name,
+      'resolved path must not be root directory',
+    );
+  }
+
+  if (config.clear && fs.existsSync(outputDirectory)) {
+    fs.rmdirSync(outputDirectory, { recursive: true });
+  }
+
+  if (!fs.existsSync(outputDirectory)) {
+    fs.mkdirSync(outputDirectory, { recursive: true });
+  }
+
+  for (let fullName of await hre.artifacts.getAllFullyQualifiedNames()) {
+    if (config.only.length && !config.only.some((m) => fullName.match(m)))
+      continue;
+    if (config.except.length && config.except.some((m) => fullName.match(m)))
+      continue;
+
+    const storageLayout = await loadStorageLayout(hre, fullName);
+    const { storage, types } = storageLayout;
+
+    if (!storage.length) continue;
+
+    const destination =
+      path.resolve(outputDirectory, config.flat ? '' : '', fullName) + '.json';
+
+    if (!fs.existsSync(path.dirname(destination))) {
+      fs.mkdirSync(path.dirname(destination), { recursive: true });
+    }
+
+    fs.writeFileSync(
+      destination,
+      `${JSON.stringify({ storage, types }, null, config.spacing)}\n`,
+    );
+  }
+};
+
+export default action;

src/actions/inspect_storage_layout.ts

@@ -0,0 +1,35 @@
+import { printCollatedSlots } from '../lib/print.js';
+import {
+  collateStorageLayout,
+  loadStorageLayout,
+} from '../lib/storage_layout_diff.js';
+import { TASK_COMPILE } from '../task_names.js';
+import { createHardhatRuntimeEnvironmentAtGitRef } from '@solidstate/hardhat-git';
+import type { NewTaskActionFunction } from 'hardhat/types/tasks';
+
+interface InspectStorageLayoutTaskActionArguments {
+  contract: string;
+  ref?: string;
+  noCompile: boolean;
+}
+
+const action: NewTaskActionFunction<
+  InspectStorageLayoutTaskActionArguments
+> = async (args, hre) => {
+  if (args.ref) {
+    // TODO: initialize hre with plugin or user config containing storageLayout output selection
+    hre = await createHardhatRuntimeEnvironmentAtGitRef(hre.config, args.ref);
+  }
+
+  if (!args.noCompile) {
+    await hre.tasks.getTask(TASK_COMPILE).run();
+  }
+
+  const slots = collateStorageLayout(
+    await loadStorageLayout(hre, args.contract),
+  );
+
+  printCollatedSlots(slots);
+};
+
+export default action;

src/hooks/config.ts

@@ -0,0 +1,40 @@
+import type { StorageLayoutDiffConfig } from '../types.js';
+import type { ConfigHooks } from 'hardhat/types/hooks';
+
+const DEFAULT_CONFIG: StorageLayoutDiffConfig = {
+  path: './storage_layout',
+  clear: false,
+  flat: false,
+  only: [],
+  except: [],
+  spacing: 2,
+};
+
+export default async (): Promise<Partial<ConfigHooks>> => ({
+  resolveUserConfig: async (userConfig, resolveConfigurationVariable, next) => {
+    const result = {
+      ...(await next(userConfig, resolveConfigurationVariable)),
+      storageLayoutDiff: {
+        ...DEFAULT_CONFIG,
+        ...userConfig.storageLayoutDiff,
+      },
+    };
+
+    for (const key in result.solidity.profiles) {
+      const profile = result.solidity.profiles[key];
+
+      for (const compiler of profile.compilers) {
+        const settings = compiler.settings;
+        settings.outputSelection ??= {};
+        settings.outputSelection['*'] ??= {};
+        settings.outputSelection['*']['*'] ??= [];
+
+        if (!settings.outputSelection['*']['*'].includes('storageLayout')) {
+          settings.outputSelection['*']['*'].push('storageLayout');
+        }
+      }
+    }
+
+    return result;
+  },
+});