v2.0.0: Optimism L2 & View/Pure Method Gas

What's New

• Configuration for chains with Etherscan support has been simplified to a single key. Just set the L1 option to one of the supported networks and the reporter will take care of the rest. (You'll still need a coinmarketcap api key)

  gasReporter: {
    L1: "gnosis",
    coinmarketcap: "abc...",
  }

• Gas reporting for L2 networks is coming online, starting with Optimism.

  gasReporter: {
    L2: "optimism",
    coinmarketcap: "abc...",
  }

• Gas metrics for view and pure methods are now available as an option. You can also exclude intrinsic gas costs for state-changing methods. (⚠️ There are performance hits when the view and pure options are enabled)

  gasReporter: {
    // Debits intrinsic gas for state-changing method calls in order to model contracts
    // that will never be called by an EOA
    includeIntrinsicGas: false,
  
    // This option executes an additional `eth_estimateGas` for every `eth_call`
    // detected by the reporter. If you have 1000's of tests setting it to true has a
    // noticeable performance impact
    reportPureAndViewMethods: true,
  
    // This option can add SIGNIFICANT LAG to test startup time if you have
    // 100's of contracts in your project. (It parses all the sources in your dependency tree
    // to identify state variable declarations)
    excludeAutoGeneratedGetters: true,
  }

• There are multiple report formats, including markdown.

• The reporter now supports sub-gwei gas prices. Sub-penny cost display is possible by configuring the currencyDisplayPrecision option

• Dedicated support for the OpenZeppelin Upgrades plugin has been added. (Their proxy pattern often resulted in missing gas data because the reporter didn't know what contract was being called - that's all handled under the hood now.)

• Dedicated support for the hardhat-viem plugin has been added (this was broken and should be fixed by this release)

• There are many new output, display and low-level options - check out the Config Examples section of the docs

• There's additional support for custom proxy contract resolution. If you're routing your calls through contract middleware you can configure the reporter to understand how that works and get the data you expect.

• Additionally:

  • eth-gas-reporter's logic has been ported here and translated to Typescript
  • The plugin has been decoupled from Mocha so it can be seamlessly integrated with lots of other tasks or test frameworks
  • There have been big architectural changes and testing improvements and additional features are in the pipeline

Breaking

• Codechecks support was removed because it hasn't been accepting users for a while. I loved codechecks. (Building a github action for the reporter is on the V2 roadmap though).
• The JSON object emitted by the reporter has changed to reflect the plugin's internal types. If you've been post-processing that data you'll need to look at the JSON Output docs and update your logic.
• The gas-reporter:merge task has been renamed hhgas:merge
• The onlyCalledMethods option has been renamed showUncalledMethods and must be set to true (if you want that).

Funding

Work on V2 was funded in part by OpenZeppelin via DRIPS, a public goods protocol that helps direct funding to packages in your dependency tree. If you're using DRIPS and want to add hardhat-gas-reporter to the packages you support its page is here.

Full Changelog: v1.10.0...v2.0.0