npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hardhat-storage-layout

v0.1.7

Published

Hardhat plugin for exporting the contract storage layout

Downloads

8,419

Readme

hardhat-storage-layout

Generate Ethereum smart contract storage layout with Hardhat. This plugin saves time and avoids human error when a developer tries to update a specific storage slot in a remote solidity contract. For more info about the storage layout, please refer to the official solidity documentation.

Installation

yarn add --dev hardhat-storage-layout

Usage

  • Add this plugin to hardhat.config.js:
require('hardhat-storage-layout');
  • Compile your contracts (Solc version must be grather than 0.5.13)
  • Run yarn hardhat check

Or

  • Export the contracts storage layout prior deployment as follows:
const hre = require("hardhat");

async function main() {
....
  await
  hre.storageLayout.export();
}
┌─────────────────┬────────────────┬──────────────┬────────┬─────────────────────────────────────────────────────┬────────────────┐
│ contract        │ state_variable │ storage_slot │ offset │ type                                                │ numberOfBytes  │
├─────────────────┼────────────────┼──────────────┼────────┼─────────────────────────────────────────────────────┤────────────────┤
│ ERC20           │ _balances      │      0       │   0    │ t_mapping(t_address,t_uint256)                      │1               │
│ ERC20           │ _allowances    │      1       │   0    │ t_mapping(t_address,t_mapping(t_address,t_uint256)) │1               │
│ ERC20           │ _totalSupply   │      2       │   0    │ t_uint256                                           │1               │
│ ERC20           │ _name          │      3       │   0    │ t_string_storage                                    │1               │
│ ERC20           │ _symbol        │      4       │   0    │ t_string_storage                                    │1               │
│ WatermelonToken │ _balances      │      0       │   0    │ t_mapping(t_address,t_uint256)                      │1               │
│ WatermelonToken │ _allowances    │      1       │   0    │ t_mapping(t_address,t_mapping(t_address,t_uint256)) │1               │
│ WatermelonToken │ _totalSupply   │      2       │   0    │ t_uint256                                           │1               │
│ WatermelonToken │ _name          │      3       │   0    │ t_string_storage                                    │1               │
│ WatermelonToken │ _symbol        │      4       │   0    │ t_string_storage                                    │1               │
└─────────────────┴────────────────┴──────────────┴────────┴─────────────────────────────────────────────────────┘────────────────┘
  • contract: is the name of the contract including its path as prefix
  • state variable: is the name of the state variable
  • offset: is the offset in bytes within the storage slot according to the encoding
  • storage slot: is the storage slot where the state variable resides or starts. This number may be very large and therefore its JSON value is represented as a string.
  • type: is an identifier used as key to the variable’s type information (described in the following)
  • numberOfBytes: is the nummber of bytes used by the state variable.