Add debug_standardTraceBlockToFile JSON RPC method #1392

matkt · 2020-09-23T16:24:35Z

Signed-off-by: Karim TAAM karim.t2am@gmail.com

PR description

Add debug_standardTraceBlockToFile JSON RPC API. This API accepts a block hash and will replay the block. It returns a list of files containing the result of the trace (one file per transaction). The files are stored in the machine that serves this API.

Request

If you want a specific transaction in a block

{
    "jsonrpc": "2.0",
    "method": "debug_standardTraceBlockToFile",
    "params": ["0x346bf832874407208006572fd779be5a6a6e0022be76f21a27a2c88b65b0c323", {
        "txHash": "0xaa190c4ed5375ce3577e6212357671ab0aca47dd8c517c177844bf84b4b5c261",
        "disableMemory": false
    }],
    "id": 1
}

If you want all transactions of a block

{
    "jsonrpc": "2.0",
    "method": "debug_standardTraceBlockToFile",
    "params": ["0x346bf832874407208006572fd779be5a6a6e0022be76f21a27a2c88b65b0c323"],
    "id": 1
}

If you want disableMemory == false (default is true)

{
    "jsonrpc": "2.0",
    "method": "debug_standardTraceBlockToFile",
    "params": ["0x346bf832874407208006572fd779be5a6a6e0022be76f21a27a2c88b65b0c323", {
        "txHash": "0xaa190c4ed5375ce3577e6212357671ab0aca47dd8c517c177844bf84b4b5c261",
        "disableMemory": false
    }],
    "id": 1
}

Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        "/Users/johndoe/private-network/Clique-Network/Node-1/data/traces/block_0x346bf832-0-0x407ec43d-1600951088172"
    ]
}

Changelog

I thought about the changelog and included a changelog update if required.

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

shemnon · 2020-09-23T16:39:07Z

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/vm/EVMToolTracer.java

@@ -34,30 +32,42 @@
 import org.apache.tuweni.bytes.Bytes;
 import org.apache.tuweni.units.bigints.UInt256;

-class EVMToolTracer implements OperationTracer {
+public class EVMToolTracer implements OperationTracer {


Since it's been moved out of EVM tool perhaps a different name, StandardJsonTracer?

shemnon · 2020-09-23T16:45:07Z

...va/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TransactionTraceParams.java

+
+  @JsonProperty("txHash")
+  @Nullable
+  String transactionHash();


Use standard getter/setters

shemnon · 2020-09-23T16:45:38Z

...va/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TransactionTraceParams.java

  }

-  public TraceOptions traceOptions() {
-    return new TraceOptions(!disableStorage, !disableMemory, !disableStack);
+  default Optional<Hash> getTransactionHash() {


This will need to be renamed, or dropped.

shemnon · 2020-09-23T16:48:56Z

...ain/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/processor/TransactionTracer.java

+        final Transaction transaction = transactions.get(i);
+        if (selectedHash.isEmpty()
+            || selectedHash.filter(isEqual(transaction.getHash())).isPresent()) {
+          final File tmpFile =


Do we want these going to tmp? perhaps our data root under traces?

I don't have a strong opinion on it. I did this to be consistent with the other clients. But I just changed to put it in the data/traces now

shemnon · 2020-09-23T16:52:08Z

Not your bug (it's mine) but in the EvmToolTracer we need to show 32 bytes per memory word. I'd do a suggestion but it's too far down.

about line 99

messageFrame.readMemory(UInt256.ZERO, messageFrame.memoryWordSize()).toHexString())

becomes

messageFrame.readMemory(UInt256.ZERO, messageFrame.memoryWordSize().multiply(32)).toHexString())

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt · 2020-09-24T12:48:05Z

Not your bug (it's mine) but in the EvmToolTracer we need to show 32 bytes per memory word. I'd do a suggestion but it's too far down.

about line 99
messageFrame.readMemory(UInt256.ZERO, messageFrame.memoryWordSize()).toHexString())
becomes
messageFrame.readMemory(UInt256.ZERO, messageFrame.memoryWordSize().multiply(32)).toHexString())

I just updated the code to fix this issue

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

shemnon · 2020-09-28T14:50:16Z

CHANGELOG.md

@@ -4,6 +4,7 @@

 ### Additions and Improvements
 * The new version of the [web3js-eea library (v0.10)](https://github.com/PegaSysEng/web3js-eea) supports the onchain privacy group management changes made in Besu v1.5.3.     
+* Added `debug_standardTraceBlockToFile` JSON-RPC API. This API accepts a block hash and will replay the block. It returns a list of files containing the result of the trace (one file per transaction). [\#1392](https://github.com/hyperledger/besu/pull/1392)


This should be moved to the 1.6.0-RC1 section once merged.

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

…to-file Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt added 2 commits September 23, 2020 18:18

add debug_standardTraceBlockToFile JSON RPC method

bcbb84e

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

update CHANGELOG.md

d332694

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt marked this pull request as ready for review September 23, 2020 16:37

Merge branch 'master' into feature/add-standard-trace-block-to-file

bdba868

shemnon reviewed Sep 23, 2020

View reviewed changes

matkt added 2 commits September 24, 2020 14:46

fix review issues

50255af

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

fix review issues

38046da

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt added 2 commits September 24, 2020 14:51

Merge branch 'master' into feature/add-standard-trace-block-to-file

c45752e

fix pipeline

9742da8

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt requested a review from shemnon September 25, 2020 07:55

Merge branch 'master' into feature/add-standard-trace-block-to-file

76cbd63

MadelineMurray mentioned this pull request Sep 28, 2020

Doc debug_standardTraceBlockToFile hyperledger/besu-docs#523

Closed

Merge branch 'master' into feature/add-standard-trace-block-to-file

2309566

shemnon approved these changes Sep 28, 2020

View reviewed changes

matkt added 2 commits September 28, 2020 18:43

update CHANGELOG.md

b4cffef

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

Merge branch 'upstream/master' into feature/add-standard-trace-block-…

799674f

…to-file Signed-off-by: Karim TAAM <karim.t2am@gmail.com>

matkt merged commit 6034b89 into hyperledger:master Sep 28, 2020

matkt linked an issue Oct 7, 2020 that may be closed by this pull request

Support Standard Bad Blocks JSON-RPC APIs #1357

Closed

matkt deleted the feature/add-standard-trace-block-to-file branch October 13, 2020 08:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug_standardTraceBlockToFile JSON RPC method #1392

Add debug_standardTraceBlockToFile JSON RPC method #1392

matkt commented Sep 23, 2020 •

edited

Loading

shemnon Sep 23, 2020

matkt Sep 24, 2020

shemnon Sep 23, 2020

matkt Sep 24, 2020

shemnon Sep 23, 2020

matkt Sep 24, 2020

shemnon Sep 23, 2020

matkt Sep 24, 2020

shemnon commented Sep 23, 2020

matkt commented Sep 24, 2020

shemnon Sep 28, 2020

Add debug_standardTraceBlockToFile JSON RPC method #1392

Add debug_standardTraceBlockToFile JSON RPC method #1392

Conversation

matkt commented Sep 23, 2020 • edited Loading

PR description

Request

Response

Changelog

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shemnon commented Sep 23, 2020

matkt commented Sep 24, 2020

Choose a reason for hiding this comment

matkt commented Sep 23, 2020 •

edited

Loading