v2.0

[cgewecke]

TODO

Tests

• [x] Re-org existing test suite
  • (#169)
• [x] Lint and add lint check in CI
  • (#172)
• [x] Add validations for integration tests reporter output

  • 176

• [x] Add viem test

  • 177

• [x] Test options
• [x] Add unit tests for migrated eth-gas-reporter utils

  • 184

• [x] Add tests for hardhat run command
• [x] Migrate to github actions

E2E

• [x] Test against hh-toolbox (no issues with extendConfig)
• [x] Test against hh-toolbox-viem
• [x] Test vs EDR (fast!)
• [x] Test vs 1inch/solidity-utils
• [x] Test vs solidstate-network/solidstate-solidity
• [x] Test vs PaintSwap/samwitch-orderbook
• [x] 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

• [x] Re-org src (tasks, utils, index.ts)
  • (#171)
• [x] Port eth-gas-reporter logic here
  • Decouple from mocha
  • (#173)
• [x] Use extendProvider
  • (#173)
• [x] Use extendConfig
  • (#173)
• [x] Add jsonOutput option

  • 178

• [x] Fix JSON serialization on object output

  • 176

• [x] Support viem

  • 177

  • 156

• [x] Restore ethPrice support

  • 178

  • (#173)
  • ISSUES

  • 116

• [x] Support Optimism estimates

  • 180

  • ISSUES

  • 78

  • 88

  • 152

  • 148

  • eth-gas-reporter 273
• [x] Add additional table formats

  • 179

  • 91

  • [x] legacy
  • [x] compressed (contract names & methods in same column, w/ indentation)
  • [x] markdown
  • [x] separated by compiler settings
  • [x] darkMode (replace grey w/ cyan)
• [x] Support Arbitrum estimates
  • Deferred: see #181
• [x] Use ethers v6 (?)
  • maybe replace with viem since that was added alongside optimism
• [x] Make sure contracts that use immutable are matched
• [x] Add option to output to both terminal and file

  • 185

  • 130

• [x] Support OZ upgradeable automatically

  • 188

  • 189

  • 121

  • 141

  • 154

  • what about diamonds?
• [x] Emit warnings at end of run when price or block data fetches fail.
• [x] Support pure / view with estimates for eth_call

  • 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)

  • 92

• [x] Add option to deduct intrinsic gas costs
• [x] Autoconfigure urls for network / chain

  • 200

  • add etherscan api key option (important for task run)
• [x] Add totals table for TASK_RUN
  • Deferred via #195
  • track account balances?
  • track token balances for accounts?
• [x] Support EIP-1559
  • Deferred via #194
• [x] Support --parallel flag
  • Deferred via #198

    Tasks

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

Docs

• [ ] Migrate to vocs docs
  • github actions for github pages

CI

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

Misc

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