From 95829b1f3ff9d8de9d183b9c70c841abea9bb066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C8=98tefan=20Talpalaru?= Date: Fri, 25 Jan 2019 19:52:34 +0100 Subject: [PATCH] reword the HTML help and add a note about geth not switching to a full sync if it was run with a fast sync at any time in the past in that same db --- premix/index.html | 37 +++++++++++++------------------------ premix/readme.md | 7 ++++--- 2 files changed, 17 insertions(+), 27 deletions(-) diff --git a/premix/index.html b/premix/index.html index 9d49037e8..c500a9d63 100644 --- a/premix/index.html +++ b/premix/index.html @@ -122,42 +122,31 @@

Help

-

The top navigation is ordered from left to right like the picture below.

- - -

- Usually you will start from left, then move to the right to find out where the bug might located. - If you see red colored text, it means you already found the difference between nimbus and other ethereum - client tracing result. + Work your way through the top-right menu, left to right, to find out where the bug might be located. + If you see red colored text, it means you already found the difference between Nimbus and the other Ethereum + client's tracing result.

- If there is no red colored text in opcode section, it means the bug might be located in transactions section, - or in header section. + If there is no red colored text in the OPCODE section, it means the bug might be located in the TRANSACTIONS section, or in the HEADER section.

- Once you already located the bug, you can use debug.nim located in /premix - to sort things out until there is no more error or it pass block validation. + Once you locate the bug, you can use the ./build/debug tool + to sort things out until there are no more errors and the block passes validation.

- Block with multiple transactions will have triangle pointing downward in the navigation bar. - Usually only the first transaction with red colored text have the problem, but it might affect the rest - of other transactions. In opcode section, the same thing happened, perhaps only the first instruction - with red colored text have the problem, but it will affect the rest of other instructions. + Blocks with multiple transactions will have submenus in the navigation bar. + Usually, only the first transaction with red colored text is problematic, but it might affect the + other transactions. In the OPCODE section, the same thing happens. Perhaps only the first red-colored instruction + is problematic, but it will affect the other instructions.

- In Transactions section, you'll see the transaction kind. - It has three kind: Regular, ContractCreation, and ContractCall. - Each kind will help you locate the bug in Nimbus implementation, they have their own proc. + Transactions in the TRANSACTIONS section are marked as: Regular, ContractCreation, or ContractCall. + Each kind is processed separately by Nimbus, in different procedures.

@@ -167,4 +156,4 @@ - \ No newline at end of file + diff --git a/premix/readme.md b/premix/readme.md index d13acd045..7d0c3259a 100644 --- a/premix/readme.md +++ b/premix/readme.md @@ -30,9 +30,10 @@ geth --rpc --rpcapi eth,debug --syncmode full --gcmode=archive ``` You need to run it until it fully syncs past the problematic block you want to -debug (note that it will first do a fast sync of all blocks before going back -to do the full sync). After that, you can stop it by pressing `CTRL-C` and -rerun it with the additional flag `--maxpeers 0` if you want it to stop syncing +debug (you might need to do it on an empty db, because some geth versions will +keep on doing a fast sync if that's what was done before). After that, you can +stop it by pressing `CTRL-C` and rerun it with the additional flag `--maxpeers +0` if you want it to stop syncing - or just let it run as is if you want to keep syncing. The next requirement is building Nimbus and Premix: