Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix format block to handle fullTx false case #53

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Conversation

beer-1
Copy link
Member

@beer-1 beer-1 commented Aug 26, 2024

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Enhanced blockchain data integrity by ensuring parent block hashes are accurately set for blocks beyond the genesis block.
    • Improved transaction retrieval efficiency by streamlining how transactions are handled in the GetBlockByNumber and GetBlockByHash functions, allowing for flexible transaction detail retrieval based on user preference.

@beer-1 beer-1 marked this pull request as ready for review August 26, 2024 08:54
@beer-1 beer-1 requested a review from a team as a code owner August 26, 2024 08:54
Copy link

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes involve modifications to the ListenFinalizeBlock function in the EVMIndexerImpl struct to include parent block hash assignment for blocks beyond genesis. Additionally, the GetBlockByNumber and GetBlockByHash functions in the JSONRPCBackend class have been updated to streamline transaction retrieval and modify the formatBlock function to handle transaction details based on a new fullTx parameter.

Changes

File Change Summary
indexer/abci.go Added logic in ListenFinalizeBlock to set ParentHash for blocks with height greater than 1 by retrieving the previous block's header.
jsonrpc/backend/block.go Removed conditional logic in GetBlockByNumber and GetBlockByHash for transaction retrieval, allowing direct invocation of IterateBlockTxs. Updated formatBlock to include fullTx parameter for transaction detail handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant JSONRPCBackend
    participant BlockHeaderMap
    participant EVMIndexerImpl

    Client->>JSONRPCBackend: GetBlockByNumber(ethBlockNum, fullTx)
    JSONRPCBackend->>BlockHeaderMap: Retrieve Block Headers
    BlockHeaderMap-->>JSONRPCBackend: Return Block Headers
    JSONRPCBackend->>JSONRPCBackend: Iterate over Transactions
    JSONRPCBackend->>JSONRPCBackend: Format Block with Transactions
    JSONRPCBackend-->>Client: Return Block Data
Loading

🐇 In the code's dance, changes take flight,
A hop here, a jump, everything feels right.
Parent hashes set, transactions flow,
With each little tweak, we’re ready to go!
So let’s celebrate with a joyful cheer,
For code's sweet rhythm brings us all near! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 31 lines in your changes missing coverage. Please review.

Project coverage is 26.43%. Comparing base (4adcd17) to head (70dc3d7).
Report is 1 commits behind head on main.

Files Patch % Lines
jsonrpc/backend/block.go 0.00% 25 Missing ⚠️
indexer/abci.go 0.00% 6 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
- Coverage   26.45%   26.43%   -0.03%     
==========================================
  Files         112      112              
  Lines       11895    11905      +10     
==========================================
  Hits         3147     3147              
- Misses       8301     8311      +10     
  Partials      447      447              
Files Coverage Δ
indexer/abci.go 0.00% <0.00%> (ø)
jsonrpc/backend/block.go 0.00% <0.00%> (ø)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 7

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4adcd17 and 70dc3d7.

Files selected for processing (2)
  • indexer/abci.go (1 hunks)
  • jsonrpc/backend/block.go (2 hunks)
Additional context used
GitHub Check: codecov/patch
jsonrpc/backend/block.go

[warning] 120-125: jsonrpc/backend/block.go#L120-L125
Added lines #L120 - L125 were not covered by tests


[warning] 128-128: jsonrpc/backend/block.go#L128
Added line #L128 was not covered by tests


[warning] 146-152: jsonrpc/backend/block.go#L146-L152
Added lines #L146 - L152 were not covered by tests


[warning] 155-155: jsonrpc/backend/block.go#L155
Added line #L155 was not covered by tests


[warning] 158-158: jsonrpc/backend/block.go#L158
Added line #L158 was not covered by tests


[warning] 160-168: jsonrpc/backend/block.go#L160-L168
Added lines #L160 - L168 were not covered by tests

indexer/abci.go

[warning] 140-145: indexer/abci.go#L140-L145
Added lines #L140 - L145 were not covered by tests

jsonrpc/backend/block.go Show resolved Hide resolved
jsonrpc/backend/block.go Show resolved Hide resolved
jsonrpc/backend/block.go Show resolved Hide resolved
jsonrpc/backend/block.go Show resolved Hide resolved
jsonrpc/backend/block.go Show resolved Hide resolved
jsonrpc/backend/block.go Show resolved Hide resolved
indexer/abci.go Show resolved Hide resolved
Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

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

if blockHeight > 1 { ... } can be a problem if genesis height is higher than 0.. but still acceptable if you think it won't occur

@beer-1 beer-1 merged commit 9d70636 into main Aug 27, 2024
7 of 8 checks passed
@beer-1 beer-1 deleted the fix/format-block branch August 27, 2024 05:03
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.

2 participants