docs(flashblocks): document simulate_v1 block-envelope fields + error…#2
Merged
Merged
Conversation
… object shape
Expand the simulate_v1 trait doc to describe two response-schema details
that are observable to callers but currently undocumented:
* The hydrated block envelope on each SimulatedBlock entry (number, hash,
gasUsed, baseFeePerGas at the block level). The flashblock executor
populates these so callers can size cumulative gas budgets and
dereference state by hash without an extra RPC round-trip.
* The error object shape returned inside calls[*].error when a simulated
call reverts. Two required fields:
- message: String — human-readable revert reason
- code: i64 — numeric revert classification
Plus a note that calls[*].logs includes ETH transfer logs when the
caller passes traceTransfers: true, matching the standard eth_simulateV1
contract.
This is a doc-comment-only change. No signatures or behavior touched.
Purpose: blind test of the sync-from-base agent vs base/docs#1405
(which surfaced the same fields in the corresponding docs page on the
upstream side). Comparing the resulting docs PR against PR base#1405
page-by-page is how we grade the agent's output against a human
reference. See scripts/sync-from-base/NOTES.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
… object shape
Expand the simulate_v1 trait doc to describe two response-schema details that are observable to callers but currently undocumented:
The hydrated block envelope on each SimulatedBlock entry (number, hash, gasUsed, baseFeePerGas at the block level). The flashblock executor populates these so callers can size cumulative gas budgets and dereference state by hash without an extra RPC round-trip.
The error object shape returned inside calls[*].error when a simulated call reverts. Two required fields:
Plus a note that calls[*].logs includes ETH transfer logs when the caller passes traceTransfers: true, matching the standard eth_simulateV1 contract.
This is a doc-comment-only change. No signatures or behavior touched. Purpose: blind test of the sync-from-base agent vs base/docs#1405 (which surfaced the same fields in the corresponding docs page on the upstream side). Comparing the resulting docs PR against PR base#1405 page-by-page is how we grade the agent's output against a human reference. See scripts/sync-from-base/NOTES.md.