Hardhat Storage Layout Inspector

Inspect and compare Solidity smart contract storage layouts.

Versions of this plugin prior to 1.0.0 were released as hardhat-storage-layout-diff, outside of the @solidstate namespace.

Installation

npm install --save-dev @solidstate/hardhat-storage-layout-inspector
# or
pnpm add -D @solidstate/hardhat-storage-layout-inspector

Usage

Load plugin in Hardhat config:

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:

| option | description | default | | --------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | path | path to HTML export directory (relative to Hardhat root) | './storage_layout' | | clear | whether to delete old output in path on output generation | false | | flat | whether to flatten output directory (may cause name collisions) | false | | only | Array of String matchers used to select included contracts, defaults to all contracts if length is 0 | ['^contracts/'] (dependent on Hardhat paths configuration) | | 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, which is included as a dependency.

Export storage layouts:

npx hardhat export-storage-layout
# or
pnpm hardhat export-storage-layout

Inspect a contract's storage layout:

npx hardhat inspect-storage-layout [CONTRACT_IDENTIFIER]
# or
pnpm hardhat inspect-storage-layout [CONTRACT_IDENTIFIER]

Compare two contracts:

npx hardhat diff-storage-layout [CONTRACT_A_IDENTIFIER] [CONTRACT_B_IDENTIFIER]
# or
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 pnpm:

pnpm install

Setup Husky to format code on commit:

pnpm prepare