eth-gas-reporter

eth-gas-reporter

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 codechecks^beta
• Simple installation for Truffle and Buidler

Example output

Installation and Config

Truffle

npm install --save-dev eth-gas-reporter

/* truffle-config.js */
module.exports = {
  networks: { ... },
  mocha: {
    reporter: 'eth-gas-reporter',
    reporterOptions : { ... } // See options below
  }
};

Buidler

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

/* buidler.config.js */
usePlugin('buidler-gas-reporter');

module.exports = {
  networks: { ... },
  gasReporter: { ... } // See options below
};

Other

This reporter should work with any build platform that uses Mocha and connects to an Ethereum client running as a separate process. There's more on advanced use cases here.

Continuous Integration (in CircleCI)

If you use CircleCI, this reporter can be combined with codechecks to track changes in gas consumption between PRs. Codechecks is free for open source and maintained by MakerDao engineer @krzkaczor.

Complete set-up guide here (it's easy).

Options

Option	Type	Default	Description
currency	String	'EUR'	National currency to represent gas costs in. Exchange rates loaded at runtime from the coinmarketcap api. Available currency codes can be found here.
gasPrice	Number	(varies)	Denominated in gwei. Default is loaded at runtime from the eth gas station api
outputFile	String	stdout	File path to write report output to
noColors	Boolean	false	Suppress report color. Useful if you are printing to file b/c terminal colorization corrupts the text.
onlyCalledMethods	Boolean	true	Omit methods that are never called from report.
rst	Boolean	false	Output with a reStructured text code-block directive. Useful if you want to include report in RTD
rstTitle	String	""	Title for reStructured text header (See Travis for example output)
showTimeSpent	Boolean	false	Show the amount of time spent as well as the gas consumed
excludeContracts	String[]	[]	Contract names to exclude from report. Ex: ['Migrations']
src	String	"contracts"	Folder in root directory to begin search for .sol files. This can also be a path to a subfolder relative to the root, e.g. "planets/annares/contracts"
url	String	web3.currentProvider.host	RPC client url (ex: "http://localhost:8545")
proxyResolver	Function	none	Custom method to resolve identity of methods managed by a proxy contract.
artifactType	Function or String	"truffle-v5"	Compilation artifact format to consume. (See advanced use.)

Advanced Use

An advanced use guide is available here. Topics include:

• Getting accurate gas data when using proxy contracts like EtherRouter or ZeppelinOS.
• Configuring the reporter to work with non-truffle, non-buidler projects.

Example Reports

• gnosis/gnosis-contracts
• windingtree/LifToken

Usage Notes

• Requires Node >= 8.
• You cannot use ganache-core as an in-process provider for your test suite. The reporter makes sync RPC calls while collecting data and your tests will hang unless the client is launched as a separate process.
• Method calls that throw are filtered from the stats.
• Contracts that are only ever created by other contracts within Solidity are not shown in the deployments table.

Contributions

Feel free to open PRs or issues. There is an integration test and one of the mock test cases is expected to fail. If you're adding an option, you can vaildate it in CI by adding it to the mock options config located here.

Credits

All the ideas in this utility have been borrowed from elsewhere. Many thanks to:

• @maurelian - Mocha reporting gas instead of time is his idea.
• @cag - The table borrows from / is based his gas statistics work for the Gnosis contracts.
• Neufund - Block limit size ratios for contract deployments and euro pricing are borrowed from their ico-contracts test suite.

Contributors

• @cgewecke
• @rmuslimov
• @area
• @ldub
• @ben-kaufman
• @wighawag
• @ItsNickBarry
• @krzkaczor