Add new debug RPCs to display the block trace. (#606)

* Rename whitelist to allowlist. Signed-off-by: Byron Gravenorst <[email protected]> * Additional updates. Signed-off-by: Byron Gravenorst <[email protected]> * Whitelist renaming. Signed-off-by: Byron Gravenorst <[email protected]> * Address reviewer feedback. Signed-off-by: Byron Gravenorst <[email protected]> * Fix typos. Signed-off-by: Byron Gravenorst <[email protected]> * Add new debug RPCs to display the block trace. Signed-off-by: Byron Gravenorst <[email protected]> * Fix markdown issues. Signed-off-by: Byron Gravenorst <[email protected]>
hyperledger · Feb 10, 2021 · c03272a · c03272a
1 parent e45b88d
commit c03272a
Showing 1 changed file with 94 additions and 0 deletions.
diff --git a/docs/Reference/API-Methods.md b/docs/Reference/API-Methods.md
@@ -4046,6 +4046,100 @@ Returns the accounts for a specified block.
         }
         ```
 
+### `debug_standardTraceBlockToFile`
+
+Generates files containing the block trace. A separate file is generated for each
+transaction in the block.
+
+You can also specify a trace file for a specific transaction in a block.
+
+Use [`debug_standardTraceBadBlockToFile`](#debug_standardtracebadblocktofile) to view the trace for
+an invalid block.
+
+#### Parameters
+
+`blockHash` : `data` - Block hash.
+
+`txHash` : `data` - The transaction hash. Optional. If omitted, then a trace file is generated for each
+transaction in the block.
+
+`disableMemory` : `boolean` - Specify whether to capture EVM memory during the trace.
+Defaults to `true`.
+
+#### Returns
+
+`result` : `data` - Location of the generated trace files.
+
+!!! example
+
+    === "curl HTTP request"
+
+        ```bash
+        curl -X POST --data '{"jsonrpc":"2.0","method":"debug_standardTraceBlockToFile","params":["0x2dc0b6c43144e314a86777b4bd4f987c0790a6a0b21560671d221ed81a23f2dc", {
+        "txHash": "0x4ff04c4aec9517721179c8dd435f47fbbfc2ed26cd4926845ab687420d5580a6", "disableMemory": false}], "id":1}' http://127.0.0.1:8545
+        ```
+
+    === "wscat WS request"
+
+        ```bash
+        {"jsonrpc":"2.0","method":"debug_standardTraceBlockToFile","params":["0x2dc0b6c43144e314a86777b4bd4f987c0790a6a0b21560671d221ed81a23f2dc", {
+        "txHash": "0x4ff04c4aec9517721179c8dd435f47fbbfc2ed26cd4926845ab687420d5580a6", "disableMemory": false}], "id":1}
+        ```
+
+    === "JSON result"
+
+        ```json
+        {
+          "jsonrpc": "2.0",
+          "id": 1,
+           "result": [
+             "/Users/me/mynode/goerli/data/traces/block_0x2dc0b6c4-4-0x4ff04c4a-1612820117332"
+           ]
+        }
+        ```
+
+### `debug_standardTraceBadBlockToFile`
+
+Generates files containing the block trace of invalid blocks. A separate file is generated for each
+transaction in the block.
+
+Use [`debug_standardTraceBlockToFile`](#debug_standardtraceblocktofile) to view the trace for a
+valid block.
+
+#### Parameters
+
+`blockHash` : `data` - Block hash.
+
+#### Returns
+
+`result` : `data` - Location of the generated trace files.
+
+!!! example
+
+    === "curl HTTP request"
+
+        ```bash
+        curl -X POST --data '{"jsonrpc":"2.0","method":"debug_standardTraceBadBlockToFile","params":["0x53741e9e94791466d117c5f9e41a2ed1de3f73d39920c621dfc2f294e7779baa"], "id":1}' http://127.0.0.1:8545
+        ```
+
+    === "wscat WS request"
+
+        ```bash
+        {"jsonrpc":"2.0","method":"debug_standardTraceBadBlockToFile","params":["0x53741e9e94791466d117c5f9e41a2ed1de3f73d39920c621dfc2f294e7779baa"], "id":1}
+        ```
+
+    === "JSON result"
+
+        ```json
+        {
+          "jsonrpc": "2.0",
+          "id": 1,
+           "result": [
+             "/Users/me/mynode/goerli/data/traces/block_0x53741e9e-0-0x407ec43d-1600951088172"
+           ]
+        }
+        ```
+
 ### `debug_storageRangeAt`
 
 [Remix](https://remix.ethereum.org/) uses `debug_storageRangeAt` to implement debugging. Use the