Skip to content

docs: align TRACE JSON-RPC responses with the Besu wire contract - #2122

Merged
alexandratran merged 3 commits into
besu-eth:mainfrom
alexandratran:docs/trace-rpc-response-shapes
Sep 1, 2026
Merged

docs: align TRACE JSON-RPC responses with the Besu wire contract#2122
alexandratran merged 3 commits into
besu-eth:mainfrom
alexandratran:docs/trace-rpc-response-shapes

Conversation

@alexandratran

@alexandratran alexandratran commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the TRACE JSON-RPC reference so the documented contract matches what Besu emits.

  • vmTrace is an object with code and an ordered ops list, not a list itself.
  • trace_call strict is a boolean, matching the Jackson-parsed call-object field.
  • Contract creation is type: "create"; action.callType is only for CALL-family traces (call, callcode, delegatecall, staticcall).
  • Failed traces omit result and include error.
  • trace_block returns a general trace stream, including self-destruct traces and block and uncle reward entries.
  • trace_replayBlockTransactions output is hex return data, not a boolean.
  • Trace type also includes suicide (euphemized as self-destruct).

Preview: https://besu-docs-git-fork-alexandratran-docs-trace-1c113d-hyperledger.vercel.app/public-networks/reference/api/trace

Related issue(s)

Fixes #2119

Document actual trace action/result shapes, vmTrace as a code+ops object,
strict as a boolean, and hex output for replay.

Signed-off-by: Alexandra Carrillo <alexandra.carrillo@consensys.net>
@alexandratran
alexandratran requested a review from a team as a code owner August 28, 2026 21:09
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
besu-docs Ready Ready Preview Aug 28, 2026 9:42pm

Request Review

Keep suicide only as the wire type value and in JSON examples.

Signed-off-by: Alexandra Carrillo <alexandra.carrillo@consensys.net>
Signed-off-by: Alexandra Carrillo <alexandra.carrillo@consensys.net>

@bgravenorst bgravenorst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alexandratran
alexandratran merged commit 9398834 into besu-eth:main Sep 1, 2026
10 checks passed
@alexandratran
alexandratran deleted the docs/trace-rpc-response-shapes branch September 3, 2026 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

call-trace endpoints emit action/result shapes and field types that diverge from the documented JSON-RPC contract

3 participants