Merge pull request #8 from solidstate-network/hh3

Update for Hardhat 3

Author: ItsNickBarry

.gitignore

@@ -1,3 +1,4 @@
+.tsbuildinfo
 artifacts/
 cache/
 dist/

.husky/pre-commit

@@ -1,2 +1,2 @@
 #!/bin/sh
-yarn run lint-staged
+pnpm lint-staged --hide-unstaged --hide-untracked

.lintstagedrc.json

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

.prettierrc.json

@@ -1,4 +1,4 @@
-# Hardhat Storage Layout Diff
+# Hardhat Storage Layout Inspector
 
 Inspect and compare Solidity smart contract storage layouts.
 
@@ -7,17 +7,26 @@ Inspect and compare Solidity smart contract storage layouts.
 ## Installation
 
 ```bash
-npm install --save-dev @solidstate/hardhat-storage-layout-diff
+npm install --save-dev @solidstate/hardhat-storage-layout-inspector
 # or
-yarn add --dev @solidstate/hardhat-storage-layout-diff
+pnpm add -D @solidstate/hardhat-storage-layout-inspector
 ```
 
 ## Usage
 
 Load plugin in Hardhat config:
 
 ```javascript
-require('@solidstate/hardhat-storage-layout-diff');
+import HardhatStorageLayoutInspector from '@solidstate/hardhat-storage-layout-inspector';
+
+const config: HardhatUserConfig = {
+  plugins: [
+    HardhatStorageLayoutInspector,
+  ],
+  storageLayoutDiff: {
+    ... // see table for configuration options
+  },
+};
 ```
 
 Add configuration under the `storageLayoutDiff` key:
@@ -31,42 +40,46 @@ 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
 npx hardhat export-storage-layout
 # or
-yarn run hardhat export-storage-layout
+pnpm 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]
+pnpm 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]
+pnpm 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 rev options to look up a contract identifier at a particular git revision.
+
 ## Development
 
-Install dependencies via Yarn:
+Install dependencies via pnpm:
 
 ```bash
-yarn install
+pnpm install
 ```
 
 Setup Husky to format code on commit:
 
 ```bash
-yarn prepare
+pnpm prepare
 ```

README.md

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+pragma solidity *;
+
+contract SlotsZero {}
+
+contract SlotsOne {
+    uint256 one;
+}
+
+contract SlotsOneOffsetOne is SlotsOne layout at 1  {}
+
+contract SlotsTwo is SlotsOne {
+    uint256 two;
+}
+
+contract SlotsTwoOffsetOne is SlotsTwo layout at 1  {}
+
+contract SlotsTwoOffsetTwo is SlotsTwo layout at 2  {}

contracts/Offset.sol

@@ -1,38 +1,18 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
 pragma solidity *;
 
-contract Test {
-    enum E {
-        ONE,
-        TWO
-    }
-
-    struct Struct {
-        address a;
-        E e;
-        address b;
-        E f;
-    }
+import { E, S } from './Types.sol';
 
-    Struct str;
+contract Test {
+    // slots 0-1
+    S str;
+    // slot 2
     mapping(address => bool) map;
-    uint128[5] five;
+    // slots 3-5
+    uint128[5] array;
+    // slot 6
     bool b0;
     bool b1;
-    bool[4][2] bools;
-}
-
-contract Test2 {
-    bytes29 _b;
-    uint128 a;
-    uint64 b;
-    uint128 u;
-}
-
-contract Test3 {
-    bytes30 _b;
-    uint64 a;
-    uint128 b;
-    uint128 u;
-    uint64 uu;
+    // slots 7-8
+    bool[4][2] nestedArray;
 }

contracts/Test.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity *;
+
+enum E {
+    ONE,
+    TWO
+}
+
+struct S {
+    address a;
+    E e;
+    bytes16 b;
+}

contracts/Types.sol

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

hardhat.config.ts

@@ -0,0 +1,4 @@
+export default {
+  '*.{js,ts,sol,json,md}': ['prettier --write'],
+  '*': () => ['knip', 'knip --production'],
+};