Skip to content

Add enableMemory parameter to debug_traceTransaction and debug_traceBlockByNumber#10169

Merged
fab-10 merged 2 commits intobesu-eth:mainfrom
vivek-0509:10115-add-enableMemory-param
Apr 13, 2026
Merged

Add enableMemory parameter to debug_traceTransaction and debug_traceBlockByNumber#10169
fab-10 merged 2 commits intobesu-eth:mainfrom
vivek-0509:10115-add-enableMemory-param

Conversation

@vivek-0509
Copy link
Copy Markdown
Contributor

@vivek-0509 vivek-0509 commented Apr 2, 2026

PR description

Adds the enableMemory param (default false) to TransactionTraceParams. When both enableMemory and disableMemory are provided, enableMemory takes precedence.

Changes

  • Added enableMemory JSON property to TransactionTraceParams following the same nullable Boolean pattern as the existing disableMemory param
  • Updated traceOptions() precedence: enableMemory -> disableMemory -> non-opcode tracer fallback
  • Added 4 unit tests covering enableMemory true/false and precedence over disableMemory

Fixed Issue(s)

Partial fix for #10115 (item 8)

Thanks for sending a pull request! Have you done the following?

  • Checked out our contribution guidelines?
  • Considered documentation and added the doc-change-required label to this PR if updates are required.
  • Considered the changelog and included an update if required.
  • For database changes (e.g. KeyValueSegmentIdentifier) considered compatibility and performed forwards and backwards compatibility tests

Locally, you can run these tests to catch failures early:

  • spotless: ./gradlew spotlessApply
  • unit tests: ./gradlew build
  • acceptance tests: ./gradlew acceptanceTest
  • integration tests: ./gradlew integrationTest
  • reference tests: ./gradlew ethereum:referenceTests:referenceTests
  • hive tests: Engine or other RPCs modified?

@vivek-0509 vivek-0509 changed the title Add enableMemory parameter to debug_traceTransaction Add enableMemory parameter to debug_traceTransaction and debug_traceBlockByNumber Apr 2, 2026
@vivek-0509
Copy link
Copy Markdown
Contributor Author

@macfarla do take a look, build passes locally

Adds the enableMemory param (default false) to TransactionTraceParams.
When both enableMemory and disableMemory are provided, enableMemory
takes precedence.

Ref: besu-eth#10115

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>
Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>
@vivek-0509 vivek-0509 force-pushed the 10115-add-enableMemory-param branch from 90ec112 to d695198 Compare April 13, 2026 14:09
@vivek-0509
Copy link
Copy Markdown
Contributor Author

@fab-10 @macfarla Please take a look when you get a chance

@fab-10 fab-10 requested a review from Copilot April 13, 2026 14:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a new enableMemory boolean parameter to transaction/block debug tracing params, with defined precedence over the existing disableMemory flag.

Changes:

  • Introduces enableMemory (nullable Boolean) to TransactionTraceParams and updates traceOptions() precedence (enableMemorydisableMemory → non-opcode tracer fallback).
  • Adds unit tests for enableMemory true/false, precedence over disableMemory, and behavior with non-opcode tracers.
  • Updates CHANGELOG.md to announce the new parameter and its defaults.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TransactionTraceParams.java Adds enableMemory param and updates memory-tracing precedence logic.
ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TransactionTraceParamsTest.java Adds unit tests for enableMemory behavior and precedence.
CHANGELOG.md Documents the new enableMemory parameter for debug trace RPCs.

Comment thread CHANGELOG.md

### Additions and Improvements
- Add `transactionReceipts` subscription type to `eth_subscribe` that pushes all transaction receipts when a new block is added, with optional `transactionHashes` filter to receive receipts for specific transactions only [#10190](https://github.com/besu-eth/besu/pull/10190)
- Add `enableMemory` parameter to `debug_traceTransaction` and `debug_traceBlockByNumber`. Defaults to `false`; memory is only included in trace output when explicitly enabled. The existing `disableMemory` parameter continues to work for backwards compatibility [#10169](https://github.com/besu-eth/besu/pull/10169)
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

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

The changelog states memory is 'only included ... when explicitly enabled', but TransactionTraceParams#traceOptions() still enables memory by default for non-opcode tracers (the existing fallback behavior). Consider clarifying this entry (e.g., specify the default applies to the opcode tracer path, and note non-opcode tracers may still capture memory unless explicitly disabled), or adjust the implementation if the intent is to make memory truly opt-in for all tracers.

Copilot uses AI. Check for mistakes.
.isTrue();
}

@Test
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

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

The precedence rule is only asserted for the enableMemory=true case. Add a complementary test where enableMemory=false conflicts with disableMemory=false (or disableMemory=true) to ensure enableMemory consistently wins in both directions (i.e., enableMemory=false forces memory off regardless of disableMemory).

Suggested change
@Test
@Test
public void enableMemoryFalseShouldTakePrecedenceOverDisableMemory() throws Exception {
final TransactionTraceParams params =
MAPPER.readValue(
"{\"enableMemory\": false, \"disableMemory\": false}", TransactionTraceParams.class);
final OpCodeTracerConfig config = params.traceOptions().opCodeTracerConfig();
assertThat(config.traceMemory())
.describedAs("enableMemory=false should take precedence over disableMemory=false")
.isFalse();
}
@Test

Copilot uses AI. Check for mistakes.
@fab-10 fab-10 merged commit 4bf07a5 into besu-eth:main Apr 13, 2026
34 checks passed
daniellehrner added a commit that referenced this pull request Apr 15, 2026
* Add SHL, SHR and SAR shift operations for EVM v2 (#10154)

* Add SHL, SHR and SAR implementations and benchmarks for EVM v2

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>

* Upgrade RocksDB version from 9.7.3 to 10.6.2 (#9767)

* Upgrade RocksDB version from 9.7.3 to 10.6.2
* Fix JNI SIGSEGV crashes

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>

* Add missing verification metadata (#10198)

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* Stream debug_traceBlock* responses directly to avoid OOM on large blocks (#9848)

* stream block traces on op code level

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* correctly parse default setting for memory tracing

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* fix initcode capture for failed create op codes

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* created separate streaming debug tracer, for batch request fall back to accumulation in memory, adddress pr comments

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* execute tests from genesis and verify full trace

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* addressed pr comments

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* spotless

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* optimize trace streaming and struct log handling

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>

* spotless

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>

* Fix remaining issues and add unit tests

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>

* added back pressure when writing to the socket and reduced the buffer size to work better with netty's default buffer size

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* improve error handling by deferring to send the header only when data is available, allows to send the proper error codes during setup

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* compactHex candidate comparison

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* wire in more performant hex writer

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* introduce separate timeout for streaming calls, defaults to 10 minutes

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* spotless

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Fix streamin/accumulating output parity, added missing refund field, corrected error format, reason encoding, returnValue prefix, and precompile gasCost, with equivalence tests between both

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* revert accidental removal of 0x prefix

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* pad memory bytes to 32 bytes

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

---------

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>
Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>
Co-authored-by: Ameziane H. <ameziane.hamlat@consensys.net>

* Optimize performance and reduce memory when creating Quantity from scalar (#10134)

* Optimize performance and reduce memory when creating Quantity from scalar

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* Benchmark other implementations

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

---------

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* snap sync - apply BALs before flat db heal (#10151)

Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com>

* Remove dryRunDetector workaround methods from unit tests (#10201)

* Remove dryRunDetector workaround methods from unit tests

The dryRunDetector methods were added as a workaround for a Gradle issue
that prevented @ParameterizedTest classes from being selected when running
with --dry-run. Since the issue is fixed and --dry-run is no longer used,
these methods are no longer needed.

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* Remove dryRunDetector workaround from acceptance tests too

The Gradle issue is confirmed fixed, so the workaround is no longer
needed anywhere, including acceptance tests.

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

---------

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* preserve state gas reservoir for the top level frame in case of OOG (#10205)

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Enable execution processor on PoA networks with system contract addresses (#10196)

* enable the prague execution processor for poa networks that have the systems contract addresses set in their genesis file

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Fix engine_getPayloadV1 to return -38001 instead of -32001 for unknown payloadId (#10179)

The Engine API spec requires error code -38001 (Unknown payload) when
engine_getPayloadV1 is called with an unrecognized payloadId. Besu was
incorrectly returning -32001 (Resource not found), which is a non-standard
error code that may cause interoperability issues with consensus layer clients.

Fixes #10174

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>

* Exclude IntelliJ bin/default output from Spotless shell script check (#10210)

When IntelliJ syncs a Gradle project without build delegation, it copies
processed resources (including reference test shell scripts from the
submodule) into bin/default/. Spotless then finds these copies and
incorrectly flags them for missing license headers, while CI never sees
bin/default/ since it runs bare Gradle.

Add '**/bin/default/**' to the ShellScripts targetExclude, matching the
existing pattern used for other generated/external content.

Signed-off-by: Simon Dudley <simon.dudley@consensys.net>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* Missing memory presence check (#10213)

* Call lastFrame.getMemory().isPresent() before calling lastFrame.getMemory().get().length to avoid NPE

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* feat: add transactionReceipts subscription support in eth_subscribe #… (#10190)

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>

* remove 2nd definition of forceCaptureMem

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Exclude IntelliJ generated dir from spotless solidity (#10223)

Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* ci check to make sure that all libraries have their source code verified as well (#10217)

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Implement aggregation in pipeline service (#10202)

Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com>

* Add enableMemory parameter to debug_traceTransaction and debug_traceBlockByNumber (#10169)

* Add enableMemory parameter to debug_traceTransaction

Adds the enableMemory param (default false) to TransactionTraceParams.
When both enableMemory and disableMemory are provided, enableMemory
takes precedence.

Ref: #10115

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>

* Update CHANGELOG for enableMemory parameter

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>

---------

Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>

* Exclude halt-burned gas from block regular gas (#10225)

* Exclude halt-burned gas from block regular gas

Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>

* Add contributor call agenda issue template (#10232)

* Add contributor call agenda issue template

---------

Signed-off-by: jflo <justin+github@florentine.us>
Signed-off-by: Justin Florentine <justin+github@florentine.us>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Improve block proposal cancellation to (best effort) avoid concurrency issues (#10219)

* Fix concurrency issues when block proposal is cancelled during tx selection

When block creation is cancelled or times out, the selection thread may still
be running briefly. This change adds a CountDownLatch to internal tx selection
(mirroring the existing plugin selection mechanism) and extracts a shared
waitForCancellationToBeProcessed method that correctly handles negative
remaining-time values and logs the outcome of the wait.

Exception handling in both selection phases is split by type so that
rollback() is only called for ExecutionException, where the selection thread
is guaranteed to have finished. CancellationException and InterruptedException
no longer trigger a rollback, removing a potential race on shared world state.

In MergeCoordinator, exceptions thrown after a cancellation are now logged at
INFO with guidance to report if unexpected, rather than at WARN, reducing noise
from the expected concurrency edge cases during block proposal cancellation.

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* Add unit tests for concurrency fixes and repair early-return regression

- Add test verifying CancellationException during plugin selection is
  handled gracefully (no exception propagated to caller)
- Add test verifying internal selection CountDownLatch causes
  buildTransactionListForBlock() to wait for the selection thread
- Add test verifying Throwable thrown after block creation cancellation
  is handled gracefully (logged at INFO, not propagated)
- Remove early return from timeLimitedSelection when isCancelled is
  true: the guard was causing validPendingTransactionIsNotIncludedIf
  SelectionCancelled to fail because evaluatePendingTransaction (which
  marks each tx as SELECTION_CANCELLED) was never reached; the check
  is unnecessary since evaluatePendingTransaction already handles
  isCancelled on every iteration without touching world state

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

---------

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

* Feature add block import trace to eth simulate (#10211)

* initial addition of optional block import tracing to eth_simulateV1
* move block traceEnd prior to trielog write


---------

Signed-off-by: garyschulte <garyschulte@gmail.com>
Co-authored-by: Justin Florentine <justin+github@florentine.us>

* Handle peer permission updates in PeerDiscoveryAgentV5 (#10193)

* Handle peer permission updates in PeerDiscoveryAgentV5
* Remove apparently unneeded mock calls
* Refactor to reduce code deduplication

---------

Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>

---------

Signed-off-by: Ameziane H. <ameziane.hamlat@consensys.net>
Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>
Signed-off-by: daniellehrner <daniel.lehrner@consensys.net>
Signed-off-by: Miroslav Kovar <miroslavkovar@protonmail.com>
Signed-off-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>
Signed-off-by: jflo <justin+github@florentine.us>
Signed-off-by: Justin Florentine <justin+github@florentine.us>
Signed-off-by: garyschulte <garyschulte@gmail.com>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Co-authored-by: ahamlat <ameziane.hamlat@consensys.net>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Fabio Di Fabio <fabio.difabio@consensys.net>
Co-authored-by: Miroslav Kovář <miroslavkovar@protonmail.com>
Co-authored-by: Vivek Singh Solanki <viveksolanki0509@gmail.com>
Co-authored-by: Simon Dudley <simon.dudley@consensys.net>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Justin Florentine <justin+github@florentine.us>
Co-authored-by: garyschulte <garyschulte@gmail.com>
Co-authored-by: Matilda-Clerke <matilda.clerke@consensys.net>
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.

4 participants