External Plugin

This is a third-party plugin. Please report issues in its Github Repository

npm version Build Status

# buidler-gas-reporter

eth-gas-reporter plugin for buidler. ⛽️

# What

A Mocha reporter for Ethereum test suites:

  • Gas usage per unit test.
  • Metrics for method calls and deployments.
  • National currency costs of deploying and using your contract system.
  • CI integration with codechecksbeta

# Example report

Screen Shot 2019-06-23 at 2 10 19 PM

# Installation

npm install buidler-gas-reporter --save-dev

And add the following to your buidler.config.js:

usePlugin("buidler-gas-reporter");

# Using buidlerevm ⚠️

Are you seeing this error?

ECONNREFUSED 127.0.0.1:8545

It goes away if buidlerevm if is launched as an independent node (similar to the way ganache-cli is typically run). We're working on removing this requirement...

npx buidler node 
npx buidler test --network localhost

# Configuration

Configuration is optional.

module.exports = {
  gasReporter: {
    currency: 'CHF',
    gasPrice: 21
  }
}

💡 Pro Tip

The options include an enabled key that lets you toggle gas reporting on and off using shell environment variables. When enabled is false, mocha's (faster) default spec reporter is used. Example:

module.exports = {
  gasReporter: {
    enabled: (process.env.REPORT_GAS) ? true : false
  }
}

# Usage

This plugin overrides the built-in test task. Gas reports are generated by default with:

npx buidler test

# Options / Documentation

A list of options and other useful documentation can be found at eth-gas-reporter