Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including buidler-gas-reporter with all npm packages installed. Try it out:

require("@nomiclabs/buidler/package.json"); // @nomiclabs/buidler is a peer dependency. var buidlerGasReporter = require("buidler-gas-reporter")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

buidler-gas-reporter v0.1.4

Buidler plugin for eth-gas-reporter, a mocha reporter for Ethereum test suites

npm version Build Status

buidler-gas-reporter

eth-gas-reporter plugin for buidler. :fuelpump:

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");

Configuration

Configuration is optional.

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

:bulb: 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

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free