https://github.com/zemse/hardhat-storage-layout-changes
💾 Check for storage layout changes
https://github.com/zemse/hardhat-storage-layout-changes
ethereum hardhat hardhat-plugin smart-contracts storage-layout upgradable-contracts
Last synced: 6 months ago
JSON representation
💾 Check for storage layout changes
- Host: GitHub
- URL: https://github.com/zemse/hardhat-storage-layout-changes
- Owner: zemse
- License: mit
- Created: 2022-09-22T10:45:18.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T04:14:11.000Z (almost 3 years ago)
- Last Synced: 2025-03-19T03:57:36.033Z (7 months ago)
- Topics: ethereum, hardhat, hardhat-plugin, smart-contracts, storage-layout, upgradable-contracts
- Language: TypeScript
- Homepage:
- Size: 94.7 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hardhat-storage-layout-changes
_Hardhat plugin to check for storage layout changes_
## What
When working with complex and upgradable contracts, it can be difficult to manually see whether some solidity changes broke the storage layout or not. A mistake can cause undefined behavior in deployed contracts. This plugin aims to help notice any storage layout breakings while dev works on solidity changes.
## Installation
```bash
npm install hardhat-storage-layout-changes
```
Import the plugin in your `hardhat.config.js`:
```js
require("hardhat-storage-layout-changes");
```
Or if you are using TypeScript, in your `hardhat.config.ts`:
```ts
import "hardhat-storage-layout-changes";
```
## Tasks
This plugin adds the _storage-layout_ task to Hardhat:
```
Usage: hardhat [GLOBAL OPTIONS] storage-layout [--check] [--update]
OPTIONS:
--check Checks if storage layout has changed
--update Updates storage layout artifact
```
## Configuration
This plugin extends the `HardhatUserConfig`'s `ProjectPathsUserConfig` object with an optional
`storageLayouts` field and also adds a `storageLayoutConfig`.
This is an example of how to set it:
```js
module.exports = {
paths: {
storageLayouts: ".storage-layouts",
},
storageLayoutConfig: {
contracts: ["Pool"],
fullPath: false
};
};
```
## Usage
### `npx hardhat storage-layout --check`
```
Contract: Pool
"accounts": at same location
"user": at same location
"balance": at same location
"owner": changed slot from 1 to 2
"lastUpdate": found new storage entry at slot 1 offset 0
"owner": found new storage entry at slot 2 offset 0
Error: Storage Layout Changed. If this was intentional, please update the storage layout files using "npx hardhat storage-layout --update".
```
### `npx hardhat storage-layout --update`
```
Contract: Pool
updating Pool.json
```