fix(rpc): improve performance of eth_GetBlockByNumber #6189

hanabi1224 · 2025-10-24T13:48:23Z

Summary of changes

Populate message receipt cache together with state output cache to avoid unnecessarily re-computing state in some RPC methods like eth_getBlockByHash and eth_getBlockByNumber

@AlexeyKrasnoperov please re-evaluate #5633 and #6149 once this is merged.

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

Release Notes

Refactor
- Improved state and receipt caching implementation
- Added enhanced debugging support to internal components

coderabbitai · 2025-10-24T13:48:58Z

Walkthrough

Modified the populate_cache function to introduce local variables for key, state_root, and receipt_root, and added conditional logic to fetch and cache receipts from the blockstore into the receipt_event_cache_handler. Added Debug derive to the StateEvents struct.

Changes

Cohort / File(s)	Summary
Cache and Debug Updates `src/state_manager/mod.rs`	Refactored `populate_cache` to use local variables (key, state_root, receipt_root) for improved variable reuse; added conditional receipt fetching from blockstore and insertion into receipt_event_cache_handler when available; added Debug derive to StateEvents struct alongside existing derives

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

elmattic

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "fix(rpc): improve performance of eth_GetBlockByNumber" is clearly related to the pull request's main objective, which is to populate the message receipt cache together with the state output cache to improve RPC performance for methods like eth_GetBlockByNumber. The code changes in state_manager/mod.rs implement receipt caching logic that directly supports this performance improvement goal. The title is specific, mentioning both the performance aspect and the targeted RPC method, making it clear and understandable without vague terminology. The title accurately represents the intended outcome of the changeset.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch hm/improve-perf-for-eth_GetBlockByNumber

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

hanabi1224 · 2025-10-24T13:53:45Z

src/state_manager/mod.rs

+            if let Ok(receipts) = Receipt::get_receipts(self.blockstore(), receipt_root)
+                && !receipts.is_empty()
+            {
+                self.receipt_event_cache_handler


Previously, without receipt_event_cache_handler cache being populated, the below function always calls compute_tipset_state to get message receipts

#[instrument(skip(self))] pub async fn tipset_message_receipts( self: &Arc<Self>, tipset: &Arc<Tipset>, ) -> anyhow::Result<Vec<Receipt>> { let key = tipset.key(); let ts = tipset.clone(); let this = Arc::clone(self); self.receipt_event_cache_handler .get_receipt_or_else( key, Box::new(move || { Box::pin(async move { let StateOutput { receipt_root, .. } = this .compute_tipset_state(ts, NO_CALLBACK, VMTrace::NotTraced) .await?; trace!("Completed tipset state calculation"); Receipt::get_receipts(this.blockstore(), receipt_root) }) }), ) .await }

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/state_manager/mod.rs (1)

218-233: Good refactor that aligns with PR objectives.

The extraction of local variables improves readability, and the receipt caching logic correctly mirrors the pattern in update_cache_with_state_output (lines 469-474). This should successfully avoid recomputation in RPC methods as intended.

One minor observation: consider adding a trace-level log when Receipt::get_receipts fails, similar to other cache operations, to aid debugging without impacting performance.

For example:

-            if let Ok(receipts) = Receipt::get_receipts(self.blockstore(), receipt_root)
-                && !receipts.is_empty()
-            {
-                self.receipt_event_cache_handler
-                    .insert_receipt(key, receipts);
-            }
+            match Receipt::get_receipts(self.blockstore(), receipt_root) {
+                Ok(receipts) if !receipts.is_empty() => {
+                    self.receipt_event_cache_handler
+                        .insert_receipt(key, receipts);
+                }
+                Err(e) => {
+                    trace!("Failed to load receipts for cache population at epoch {}: {}", parent.epoch(), e);
+                }
+                _ => {} // Empty receipts, skip caching
+            }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a86d740 and ab992bf.

📒 Files selected for processing (1)

src/state_manager/mod.rs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

src/state_manager/mod.rs (3)

src/blocks/tipset.rs (2)

key (336-339)

key (530-533)

src/shim/executor.rs (2)

key (305-310)

get_receipts (206-225)

src/state_manager/cache.rs (3)

get_receipts (154-154)

get_receipts (210-212)

get_receipts (267-269)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

GitHub Check: tests-release
GitHub Check: tests
GitHub Check: Build forest binaries on Linux AMD64
GitHub Check: All lint checks
GitHub Check: cargo-publish-dry-run
GitHub Check: Build Ubuntu

🔇 Additional comments (1)

src/state_manager/mod.rs (1)

98-98: LGTM! Helpful debugging enhancement.

Adding the Debug derive to the public StateEvents struct improves observability without breaking compatibility.

LesnyRumcajs · 2025-10-24T16:07:49Z

@hanabi1224 did you check performance gain on your side?

hanabi1224 · 2025-10-27T09:32:27Z

@hanabi1224 did you check performance gain on your side?

@LesnyRumcajs Just checked calibnet@3141000 with the curl command in #5633
Forest: Total: 0.001504s
Lotus: Total: 0.007101s

LesnyRumcajs · 2025-10-27T09:34:22Z

@hanabi1224 did you check performance gain on your side?

@LesnyRumcajs Just checked calibnet@3141000 with the curl command in #5633 Forest: Total: 0.001504s Lotus: Total: 0.007101s

I mean, the performance gain between current main and this PR.

hanabi1224 · 2025-10-27T09:45:38Z

I mean, the performance gain between current main and this PR.

@LesnyRumcajs Just checked mainnet@5441650

main: Total: 0.443274s
pr: Total: 0.006406s

LesnyRumcajs

LGTM! Might be worth a changelog entry.

hanabi1224 · 2025-10-27T09:56:33Z

LGTM! Might be worth a changelog entry.

@LesnyRumcajs changelog updated in #6192 given this has been in the merge queue.

fix(rpc): improve performance of eth_GetBlockByNumber

ab992bf

hanabi1224 marked this pull request as ready for review October 24, 2025 13:52

hanabi1224 requested a review from a team as a code owner October 24, 2025 13:52

hanabi1224 requested review from LesnyRumcajs and sudo-shashank and removed request for a team October 24, 2025 13:52

hanabi1224 commented Oct 24, 2025

View reviewed changes

coderabbitai bot reviewed Oct 24, 2025

View reviewed changes

sudo-shashank approved these changes Oct 27, 2025

View reviewed changes

LesnyRumcajs approved these changes Oct 27, 2025

View reviewed changes

LesnyRumcajs added this pull request to the merge queue Oct 27, 2025

LesnyRumcajs mentioned this pull request Oct 27, 2025

eth_GetBlockByNumber: performance issue #5633

Open

hanabi1224 added a commit that referenced this pull request Oct 27, 2025

doc: changelog for #6189

1d4fb4d

coderabbitai bot mentioned this pull request Oct 27, 2025

doc: changelog for #6189 #6192

Merged

4 tasks

Merged via the queue into main with commit 5b60a60 Oct 27, 2025
45 checks passed

LesnyRumcajs deleted the hm/improve-perf-for-eth_GetBlockByNumber branch October 27, 2025 10:12

github-merge-queue bot pushed a commit that referenced this pull request Oct 28, 2025

doc: changelog for #6189 (#6192)

5479fe0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(rpc): improve performance of eth_GetBlockByNumber #6189

fix(rpc): improve performance of eth_GetBlockByNumber #6189

Uh oh!

hanabi1224 commented Oct 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 24, 2025 •

edited

Loading

Uh oh!

hanabi1224 Oct 24, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

LesnyRumcajs commented Oct 24, 2025

Uh oh!

hanabi1224 commented Oct 27, 2025 •

edited

Loading

Uh oh!

LesnyRumcajs commented Oct 27, 2025

Uh oh!

hanabi1224 commented Oct 27, 2025

Uh oh!

LesnyRumcajs left a comment

Uh oh!

hanabi1224 commented Oct 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix(rpc): improve performance of eth_GetBlockByNumber #6189

fix(rpc): improve performance of eth_GetBlockByNumber #6189

Uh oh!

Conversation

hanabi1224 commented Oct 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

hanabi1224 Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

LesnyRumcajs commented Oct 24, 2025

Uh oh!

hanabi1224 commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LesnyRumcajs commented Oct 27, 2025

Uh oh!

hanabi1224 commented Oct 27, 2025

Uh oh!

LesnyRumcajs left a comment

Choose a reason for hiding this comment

Uh oh!

hanabi1224 commented Oct 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hanabi1224 commented Oct 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 24, 2025 •

edited

Loading

hanabi1224 Oct 24, 2025 •

edited

Loading

hanabi1224 commented Oct 27, 2025 •

edited

Loading