fix(eth/core): fix typos

[dbadoy]

Small typos

Summary by CodeRabbit

• Refactor
  • Improved naming conventions for block and transaction retrieval functions to enhance clarity.
  • Updated documentation to better describe the functionality of retrieving the current final block.

[coderabbitai]

Walkthrough

The codebase has undergone a renaming of functions to align with their actual functionality. This includes updates to block and transaction retrieval methods, with a focus on clarity regarding the finality of blocks and the retrieval of receipts and transactions by their identifiers. Additionally, a function related to block insertion has been renamed to better describe its role in handling historical data.

Changes

File Path	Change Summary
.../chain_reader.go	Functions renamed for clarity in block and transaction retrieval; comments updated for accuracy.
.../chain_writer.go	InsertBlock function renamed to writeHistoricalData without altering its functionality.

Poem

In the code where blocks entwine,
A rabbit hopped to redefine.
🌟 Clearer names now take the stage,
With history penned on a cleaner page. 📜

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c3cf22b and 9d4ddfc.

Files selected for processing (2)

• eth/core/chain_reader.go (4 hunks)
• eth/core/chain_writer.go (1 hunks)

Files skipped from review due to trivial changes (1)

• eth/core/chain_writer.go

Additional comments: 4

eth/core/chain_reader.go (4)

• 87-88: The function GetHeadersFrom has been renamed to CurrentFinalBlock. The comment has been updated to reflect this change and to describe the functionality more accurately.
• 141-141: The function GetBlock has been renamed to GetBlockByNumber. Ensure that all references to the old function name have been updated to the new name across the codebase.
• 178-178: The function GetReceipts has been renamed to GetReceiptsByHash. Verify that all calls to the old function name have been updated to the new name throughout the codebase.
• 216-216: The function GetTransaction has been renamed to GetTransactionLookup. Verify that all calls to the old function name have been updated to the new name throughout the codebase.

Verification successful

---

It seems that the renaming of the GetTransaction function to GetTransactionLookup has been successfully verified. The search for the old function name usage returned no results, indicating that the old function name is no longer present in the codebase. Additionally, the search for the new function name usage returned multiple locations where the new name is used, confirming that the new function name has been applied throughout the codebase.

The verification process has provided definitive evidence that the renaming is consistent and that all calls to the old function name have been updated to the new name throughout the codebase.

Conclusion

The renaming of the GetTransaction function to GetTransactionLookup has been successfully verified, and all calls to the old function name have been updated to the new name throughout the codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for old function name usage. Expecting no results.
rg --type go 'GetTransaction\('
# Search for new function name usage. Expecting list of locations where the new name is used.
rg --type go 'GetTransactionLookup\('

Length of output: 458