feat(forge): backtraces

[yash-atreya]

Motivation

Closes #2328

Forge lacks backtraces, which are useful for pinpointing the line where the revert/error originated in the call stack. This is especially useful when there are multiple nested calls between different contracts, making traces hard to follow. Backtraces help you easily "goto" the line throwing the error.

Solution

• Introduce backtrace support in forge test
• Backtraces are enabled when verbosity >= 3 and printed if there is a revert
• When verbosity >= 3, we collect the source maps, deployed bytecode, and source content.
• In case a test fails, extract the backtraces using extract_backtraces; thebytecode.pc (program counter) is mapped to the instruction pointer and then source maps are used to pinpoint the source locations in the call stack.
• Each call is stored as a BacktraceFrame containing the source location of the call along with the contract and function names.

Implementation can be tested using:

• foundryup --pr 11547
• Clone: https://github.com/yash-atreya/test-backtraces
• Run forge t -vvv

wip

TODOs

• Should work across fresh and cached artifacts, i.e, when there are compiler source ID conflicts - 028b1aa + 5c93b5c
• Fork test backtraces with and without ETHERSCAN_API_KEY c9ce5bc
• resolve internal libs and deployed (external/linked) libraries 328c915 + 966fee6
• Internal calls
• Handle breaking tests
• Cleanup and remove debug logs
• Handling assertions feat: extend (error) traces to include source code line number and filename #2328 (comment)

PR Checklist

• Added Tests
• Added Documentation
• Breaking changes