Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fergarrui/ethereum-graph-debugger
Ethereum solidity graph plain debugger. To have the whole picture when debugging.
https://github.com/fergarrui/ethereum-graph-debugger
blockchain bytecode control-flow-graph debug debugger ethereum ethereum-contract ethereum-debug ethereum-debugger ethereum-debugging ethereum-graph-debugger solidity solidity-debug solidity-debugging solidity-language trace transaction
Last synced: 6 days ago
JSON representation
Ethereum solidity graph plain debugger. To have the whole picture when debugging.
- Host: GitHub
- URL: https://github.com/fergarrui/ethereum-graph-debugger
- Owner: fergarrui
- License: gpl-3.0
- Created: 2018-06-04T20:21:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T11:36:00.000Z (almost 2 years ago)
- Last Synced: 2024-02-14T17:31:15.551Z (10 months ago)
- Topics: blockchain, bytecode, control-flow-graph, debug, debugger, ethereum, ethereum-contract, ethereum-debug, ethereum-debugger, ethereum-debugging, ethereum-graph-debugger, solidity, solidity-debug, solidity-debugging, solidity-language, trace, transaction
- Language: TypeScript
- Size: 6.76 MB
- Stars: 347
- Watchers: 11
- Forks: 33
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- DeFi-Developer-Road-Map - Ethereum graph debugger - Solidity graphical debugger (Roadmap)
README
# ethereum-graph-debugger
Graphical EVM debugger. This debugger takes a different approach to traditional debugging. Instead of stepping through the execution of the program, it shows the whole program control flow graph and the actual execution of the transaction highlighted in red. In this way, the developer can see the whole picture and jump where it is necessary in a quick and graphical way.
This project was rewritten with a frontend made by [Swolfeyes](https://github.com/Swolfeyes) and backend by [fergarrui](https://github.com/fergarrui)
[Development repository](https://github.com/fergarrui/ethereum-graph-debugger-ts) was archived, marked as read-only and moved here, to the main repo.
# Existing tools
There are already tools that allow you to debug Ethereum transactions (Solidity):
* [Remix](https://remix.ethereum.org)
* [Truffle](http://truffleframework.com)
* [Tenderly](https://tenderly.dev)
# Usage
### Download
Use release link:
* [v3.6.0](https://github.com/fergarrui/ethereum-graph-debugger/releases/tag/v3.6.0)
If you want to use master (it can be more unstable), clone and start the application
For the first time:
```
git clone https://github.com/fergarrui/ethereum-graph-debugger.git
cd ethereum-graph-debugger
npm install
npm start
```
Subsequents just:
```
npm start
```
Go to localhost:9090
### With docker
`docker-compose up`
Go to localhost:9090
Add contracts to `./contracts` (you will need to create the directory) and empty string at the 'Load contracts from URI' form.
### Use
* Go to localhost:9090
* Enter the path where the contracts are in the input text (it will load Solidity contracts recursively)
* A tab per file found will be created
* Under a file tab there are a few actions using the left menu
### How to debug bytecode (with no source code) [Experimental]
* Create a file with extension `.evm` and paste the runtime bytecode (:warning: important: with `0x` as prefix)
* For example: create a file named: `contract1.evm` with content `0x60806040`
* Scan the directory as described above
* You won't get source code mappings when clicking in operations of the CFG
# Features
* **Now interactive** :star2:: it has a sepparate frontend and API instead of building a static HTML file like in earlier versions
* **Control flow graph**: the CFG can be built without debugging a transaction.
* **Disassembler**: just disassembled opcodes can be seen, from runtime and constructor
* **Source mapping**: snippet of code related to the selected instruction is highlighted in the editor left panel
* **Debug transaction**: a transaction can be debugged using the contract's CFG and the execution trace
* **Storage viewer**: Storage layout and values can be retrieved (including dynamic arrays and mappings :exclamation: )
* Supports contracts calls. All contracts involved in the transaction can be debugged (going to the caller/called tab to see the contract-specific trace)
* EVM state in transaction: it is shown below the editor when selecting an opcode present in the execution trace of the provided transaction hash
* **Settings**: right now, there are settings to point to a different chain (by default it connects to http://127.0.0.1:8545) and basic authentication can be configured, so the RPC endpoint can be accessed if authentication is needed (to be compatible with platforms like [Kaleido](http://kaleido.io))
* When building the CFG a basic dynamic execution is made to calculate jumps and to remove most of orphan blocks (this will be improved in the future, probably with SymExec)
* To debug directly bytecode, use `.evm` extension files
* Constructor CFG is supported
* Debugging constructor transactions is supported
# Limitations/Considerations
* Only Solidity is supported at the moment
* ~~Only runtime debugging is supported for now (no constructor)~~
* You must run it against a node that supports `debug_traceTransaction`, like Geth or Ganache, therefore, Infura is not supported
* It was rewritten, so new bugs may appear