v2.0

[cgewecke]

TODO

Tests

• Re-org existing test suite
  • (Reorganize tests #169)
• Lint and add lint check in CI
  • (Swap TSLint for ESLint and lint #172)
• Add validations for integration tests reporter output
  • Rebuild test suite around ethers & add behavioral tests #176
• Add viem test
  • Add viem support & tests #177
• Test options
• Add unit tests for migrated eth-gas-reporter utils
  • Additional gas logic tests & add offline option #184
• Add tests for hardhat run command
• Migrate to github actions

E2E

• Test against hh-toolbox (no issues with extendConfig)
• Test against hh-toolbox-viem
• Test vs EDR (fast!)
• Test vs 1inch/solidity-utils
• Test vs solidstate-network/solidstate-solidity
• Test vs PaintSwap/samwitch-orderbook
• Test vs Zeppelin (their CI report will be broken)
  • reportViewAndPureMethods
  • excludeAutoGeneratedGetters
  • took ~11min vs ~4min currently
  • maybe wait till parallel is supported before suggesting they upgrade to this.

Logic

• Re-org src (tasks, utils, index.ts)
  • (Move all logic out of index.ts to tasks and utils folders/files #171)
• Port eth-gas-reporter logic here
  • Decouple from mocha
  • (Port eth-gas-reporter logic to hardhat-gas-reporter #173)
• Use extendProvider
  • (Port eth-gas-reporter logic to hardhat-gas-reporter #173)
• Use extendConfig
  • (Port eth-gas-reporter logic to hardhat-gas-reporter #173)
• Add jsonOutput option
  • Add outputJSON option & Rename ethPrice to tokenPrice #178
• Fix JSON serialization on object output
  • Rebuild test suite around ethers & add behavioral tests #176
• Support viem
  • Add viem support & tests #177
  • #157 Add viem support and related tests #156
• Restore ethPrice support
  • Add outputJSON option & Rename ethPrice to tokenPrice #178
  • (Port eth-gas-reporter logic to hardhat-gas-reporter #173)
  • ISSUES
  • support ethPrice config #116
• Support Optimism estimates
  • Add support for Optimism gas costs (bedrock & ecotone) #180
  • ISSUES
  • Support Other EVM-Compatible Chains? #78
  • Add option to specify price's decimal precision #88
  • Please Allow setting gas price to less than 1. #152
  • how to estimate gas for Optimisim and Arbitrum Nova? #148
  • eth-gas-reporter 273
• Add additional table formats
  • Refactor table rendering #179
  • Output to a readable file? #91
  • legacy
  • compressed (contract names & methods in same column, w/ indentation)
  • markdown
  • separated by compiler settings
  • darkMode (replace grey w/ cyan)
• Support Arbitrum estimates
  • Deferred: see Built-in support for Arbitrum gas fees #181
• Use ethers v6 (?)
  • maybe replace with viem since that was added alongside optimism
• Make sure contracts that use immutable are matched
• Add option to output to both terminal and file
  • Add forceTerminalOutput options #185
  • Output to both stdout and file #130
• Support OZ upgradeable automatically
  • Add OZ Upgrades fixture & update tests to Ethers V6 #188
  • Add OZ Upgrades system resolver #189
  • Contracts with common function names: only one of them is shown in the results #121
  • Only child contract's name shows in report #141
  • Contracts with similar ABIs are meshed together in report #154
  • what about diamonds?
• Emit warnings at end of run when price or block data fetches fail.
• Support pure / view with estimates for eth_call
  • Add options for measuring eth_call gas usage  #191
  • Filtering public state variables getters?
  • Should be a function whitelist so you can target this (and not drag the suite for useless getter data)
  • Add option to report view & pure method gas usage #92
• Add option to deduct intrinsic gas costs
• Autoconfigure urls for network / chain
  • Add chain data auto-configuration #200
  • add etherscan api key option (important for task run)
• Add totals table for TASK_RUN
  • Deferred via Report gas usage, balances and cost outcomes for TASK_RUN #195
  • track account balances?
  • track token balances for accounts?
• Support EIP-1559
  • Deferred via EIP-1559 support #194
• Support --parallel flag
  • Deferred via Support mocha parallel #198

Tasks

• Support scripts
  • (Port eth-gas-reporter logic to hardhat-gas-reporter #173)
• Should be usable by jest, vitest etc...
• Ignition? (probably covered by test)
• Add ability to process / merge Foundry gas reports
• Use JSON validation for merge ops
• Add task to generate table from json

Docs

• Migrate to vocs docs
  • github actions for github pages

CI

• Build CI report service (Codechecks replacement)
  • Deferred via Codechecks replacement #196

Misc

• Track breaking changes
• Triage and close issues
• Deprecate eth-gas-reporter
• Move to org