Skip to content

Conversation

syan095
Copy link
Contributor

@syan095 syan095 commented Jul 28, 2025

Pull Request

Closes: PRO-2234

Checklist

Please conduct a thorough self-review before opening the PR.

  • I am confident that the code works.
  • I have written sufficient tests.
  • I have written and tested required migrations.
  • I have updated documentation where appropriate.

Summary

Changed some LP rpc call's return type to BlockUpdate - which contains block info, such as block number, hash etc.

…s block info, such as block number, hash etc.
@syan095 syan095 requested review from a team, dandanlen and nmammeri as code owners July 28, 2025 04:05
Copy link

coderabbitai bot commented Jul 28, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/lp-rpc-add-block-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@syan095 syan095 changed the title chore: add block info to some LP related rpc calls Jul 28, 2025
@syan095 syan095 requested a review from ramizhasan111 July 28, 2025 04:05
Copy link

codecov bot commented Jul 28, 2025

Codecov Report

❌ Patch coverage is 2.63158% with 37 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
state-chain/custom-rpc/src/lib.rs 0% 34 Missing ⚠️
state-chain/runtime/src/lib.rs 0% 0 Missing and 2 partials ⚠️
state-chain/custom-rpc/src/lp.rs 0% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@j4m1ef0rd j4m1ef0rd left a comment

Choose a reason for hiding this comment

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

What do we do about this breaking change? @dandanlen

.client
.number(block_hash)
.map_err(|e| call_error(e, CfErrorCode::OtherError))?
.ok_or(internal_error(format!("Could not fetch block number for block {:?}", at)))?;
Copy link
Collaborator

Choose a reason for hiding this comment

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

It would be good to understand the circumstances that can cause this to fail: what if the rpc is called on a block that is no longer in the block cache? (Like on a light rpc node).

.header(block_hash)
.map_err(|e| call_error(e, CfErrorCode::OtherError))?
.ok_or_else(|| {
internal_error(format!("Could not fetch block header for block {:?}", at))
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here - not sure we always want to error. It might be better to optimistically return as much metadata as we can rather than erroring.

at: Option<Hash>,
) -> RpcResult<BlockUpdate<Data>> {
let block_hash = self.rpc_backend.unwrap_or_best(at);
let block_number = self
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is repeating/duplicating some work:

  • when we call with_runtime_api we already have the hash
  • the header also contains the hash
  • the header might also contain the height?

I would like us to think a little harder about how to integrate the block wrapper nicely, without minimsl futher backend queries.

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.

3 participants