status-im/nimbus-eth1
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth1.git synced 2025-02-10 03:03:44 +00:00
Code Issues Projects Releases Wiki Activity

update readme.md

Browse Source
This commit is contained in:
andri lim 2019-01-05 20:09:39 +07:00 committed by zah
parent e9f9c13c02
commit 4da247f9a9
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
premix/assets/images/premix_screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 189 KiB

45
premix/readme.md
View File

@ -14,3 +14,48 @@ inspected by developer to pinpoint where the faulty instruction located.
Premix will also produce a test case for the specific problematic transaction Premix will also produce a test case for the specific problematic transaction
complete with snapshot database to execute transaction validation in isolation. complete with snapshot database to execute transaction validation in isolation.
This test case then can be integrated with nimbus project test suite. This test case then can be integrated with nimbus project test suite.
![screenshot](assets/images/premix_screenshot.png)
## Requirements
Before you start to use premix debugging tool there are several things you need to prepare. The first one is you need to install `geth` from [source](https://github.com/ethereum/go-ethereum/releases) or [binary](https://ethereum.github.io/go-ethereum/downloads/). Then you can run it with this command:
```bash
geth --rpc --rpcapi eth,debug --syncmode full --gcmode=archive
```
You need to run it until it synced past the problematic block you want to debug. After that you can stop it by pressing `CTRL-C` and rerun it with addition flags `--maxpeers 0` if you want it to stop syncing or let it run as is if you want keep syncing.
The next requirement is you should build nimbus and premix with latest dependencies:
```bash
nim c nimbus/nimbus
nim c premix/premix
```
After you successfully build nimbus and premix, you can run nimbus with this command.
```bash
nimbus --prune:archive
```
Nimbus will try to sync up to problematic block then it will stop and execute premix. You can see the premix report page by opening `premix/index.html` if premix failed to open your default browser.
In the browser, you can try to navigate tracing result and find where the problem/bug is.
## Helper tools
* Persist Tool
Because nimbus p2p layer still contains bugs, you may become impatient when try to syncing blocks. In `/premix` directory, you can find a `persist.nim` tool. It will help you to sync relative quicker because it will bypass p2p layer and download blocks from `geth` via `rpc-api`.
```bash
nim c -r premix/persist --dataDir:your_database_directory
```
* Debug Tool
Premix debugging tool also produce a set of debugging meta data that you can use to quickly find the bug without the need to run p2p layer or any other unnecessary code.
Also in `/premix` directory you'll find `debug.nim` tool that you can use to execute this debug meta data and you'll only need to work with one block and one transaction at a time instead of multiple confusing multiple blocks or transactions.
```bash
nim c -r premix/debug (TODO: more options will come)
```