https://github.com/zemse/forge-flamegraph

🔥 flamegraphs for solidity
https://github.com/zemse/forge-flamegraph

flamegraph foundry solidity

Last synced: 3 days ago
JSON representation

🔥 flamegraphs for solidity

• Host: GitHub
• URL: https://github.com/zemse/forge-flamegraph
• Owner: zemse
• Archived: true
• Created: 2024-04-19T12:42:41.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T08:19:00.000Z (5 months ago)
• Last Synced: 2024-10-04T12:45:34.932Z (4 months ago)
• Topics: flamegraph, foundry, solidity
• Language: Rust
• Homepage: https://ethglobal.com/showcase/not-decided-0gr0p
• Size: 208 KB
• Stars: 35
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
> Upstreamed in https://github.com/foundry-rs/foundry/pull/8640

# forge-flamegraph

a foundry plugin that generates interactive flamegraph for a test case. currently two backends are supported: calltrace and debugtrace.

lets forge some flamegraphs!

[![flamegraph of poseidon2 hash function](./flamegraph_poseidon_debug.svg)](https://zemse.github.io/forge-flamegraph/flamegraph_poseidon_debug.svg)

above is a debugtrace flamegraph of [poseidon2 hash function](https://github.com/zemse/poseidon2).

## Installation

```bash

cargo install --git https://github.com/zemse/forge-flamegraph 

```

## Usage

### `calltrace`

suitable for complex contracts like defi protocols. generates flamegraph svg with the call trace.

```bash

forge-flamegraph -t NAME_OF_TEST_FUNCTION --open

```

### `debugtrace`

suitable for libraries. generates flamegraph svg including solidity internal functions.

```bash

forge-flamegraph -t NAME_OF_TEST_FUNCTION --debugtrace --open

```

> Note: source mappings from the solidity compiler aren't that great, this plugin still tries to guess by looking at source mappings of adjacent steps but unfortunately it only works to some extent.

## Acknowledgements

- [brockelmore](https://github.com/brockelmore) for foundry's debugger

- jonhoo for [inferno](https://github.com/jonhoo/inferno)

and ofcourse for so much oss used in this project