What should be changed?
Update the debug trace docs for the behavior merged in besu-eth/besu#10172.
The PR adds an optional enableReturnData boolean to TransactionTraceParams. The default is false. When set to true, Besu captures EVM return data per opcode and includes returnData in each applicable StructLog entry as a 0x-prefixed hex string. The field is omitted when return data isn't enabled, isn't captured, or is empty.
Suggested docs updates:
- Add
enableReturnData to the options object for debug trace methods in docs/public-networks/reference/api/index.md.
- At minimum, update the methods called out by the PR and changelog:
debug_traceTransaction and debug_traceBlockByNumber.
- Verify the shared
TransactionTraceParams usage before updating related sections, including debug_traceCall, debug_traceBlock, debug_traceBlockByHash, and the standard trace-to-file debug methods.
- Update
docs/public-networks/reference/api/objects.md to add returnData to the structured log object, with the omission behavior above.
- Consider adding or adjusting an example request that uses
"enableReturnData": true and a response snippet that includes returnData.
Docs page
Issue type
- Outdated content
- Missing content
Source links
What should be changed?
Update the debug trace docs for the behavior merged in besu-eth/besu#10172.
The PR adds an optional
enableReturnDataboolean toTransactionTraceParams. The default isfalse. When set totrue, Besu captures EVM return data per opcode and includesreturnDatain each applicableStructLogentry as a0x-prefixed hex string. The field is omitted when return data isn't enabled, isn't captured, or is empty.Suggested docs updates:
enableReturnDatato theoptionsobject for debug trace methods indocs/public-networks/reference/api/index.md.debug_traceTransactionanddebug_traceBlockByNumber.TransactionTraceParamsusage before updating related sections, includingdebug_traceCall,debug_traceBlock,debug_traceBlockByHash, and the standard trace-to-file debug methods.docs/public-networks/reference/api/objects.mdto addreturnDatato the structured log object, with the omission behavior above."enableReturnData": trueand a response snippet that includesreturnData.Docs page
Issue type
Source links