A mocha reporter for Truffle.
- Gas usage per unit test.
- Average gas usage per method.
- Contract deployment costs.
- Real currency costs.
npm install --save-dev eth-gas-reportermodule.exports = {
networks: {
...etc...
},
mocha: {
reporter: 'eth-gas-reporter',
reporterOptions : {
currency: 'CHF',
gasPrice: 21
}
}
};| 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 |
| 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" |
- Requires Node >= 8.
- 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.
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.
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-contractstest suite.