Skip to content

Fix: Document enableReturnData for debug trace methods #2015

@alexandratran

Description

@alexandratran

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions