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 block index issue with wallet scan #1495

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Conversation

levoncrypto
Copy link
Contributor

No description provided.

Copy link

coderabbitai bot commented Nov 11, 2024

Walkthrough

The changes in this pull request primarily focus on enhancing the CWallet::GetBlockByDate and CWallet::ScanForWalletTransactions methods in src/wallet/wallet.cpp. The GetBlockByDate method now includes logic to return the genesis block for block heights below 200, improving robustness. The ScanForWalletTransactions method has been updated to allow rescanning based on a user-specified date, utilizing the modified GetBlockByDate for determining the scan's starting point. Additional logging and minor formatting adjustments were also made for improved clarity and traceability.

Changes

File Change Summary
src/wallet/wallet.cpp - Updated CWallet::GetBlockByDate to return genesis block for heights < 200.
- Enhanced CWallet::ScanForWalletTransactions to handle rescanning by date.
- Added logging statements for better traceability.
- Minor comments and formatting adjustments.

Possibly related PRs

  • Wallet scan optimisation #1474: Enhances the wallet recovery process by allowing users to specify a creation date, relating to the modifications in date handling for wallet transactions.

🐇 In the wallet's cozy nook,
Changes made with a thoughtful look.
Dates now guide the scan so bright,
Genesis block shines with light.
Logs to trace, a path anew,
Hopping forward, we bid adieu! 🌟


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>, please review it.
    • 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 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 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 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 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.

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: 0

🧹 Outside diff range and nitpick comments (3)
src/wallet/wallet.cpp (3)

2385-2389: Add documentation explaining the 200 block offset

The magic number 200 should be documented to explain its purpose in the date-based block scanning logic. Consider adding a constant with a descriptive name and comment.

+    // Number of blocks to offset from target date to account for timestamp variance
+    static const int DATE_BLOCK_OFFSET = 200;
+
     if (pindex->GetBlockTime() > targetTimestamp) {
-        if (pindex->nHeight >= 200) {
-            return chainActive[pindex->nHeight - 200];
+        if (pindex->nHeight >= DATE_BLOCK_OFFSET) {
+            return chainActive[pindex->nHeight - DATE_BLOCK_OFFSET];

2385-2389: Add logging for debugging purposes

Consider adding debug logging to help troubleshoot date-based scanning issues:

+    LogPrint("wallet", "GetBlockByDate: searching for block at date %s\n", dateStr);
+    LogPrint("wallet", "GetBlockByDate: found block at height %d\n", pindex->nHeight);

2385-2389: Consider adding unit tests

The new date-based block scanning functionality should be covered by unit tests to verify correct behavior with:

  • Valid dates in different formats
  • Invalid date strings
  • Edge cases around the 200 block offset
  • Chain height validation

Would you like me to help create unit tests for the new functionality?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bdfb76e and 45efa8c.

📒 Files selected for processing (1)
  • src/wallet/wallet.cpp (1 hunks)
🔇 Additional comments (3)
src/wallet/wallet.cpp (3)

2385-2389: 🛠️ Refactor suggestion

Add input validation for date string format

The date string parsing should validate the input format and handle invalid dates gracefully. Consider adding validation and error handling:

+    if (dateStr.empty() || dateStr.length() != 10) { // Expect DD-MM-YYYY
+        throw std::invalid_argument("Invalid date format, expected DD-MM-YYYY");
+    }
+
     std::time_t targetTimestamp = parseDate(dateStr);
+    if (targetTimestamp == -1) {
+        throw std::invalid_argument("Failed to parse date string");
+    }

2385-2389: ⚠️ Potential issue

Add bounds checking for chainActive access

Direct array access to chainActive should include bounds checking to prevent potential crashes:

-    return chainActive[chainActive.Tip()->nHeight];
+    const int tipHeight = chainActive.Tip()->nHeight;
+    if (tipHeight < 0) {
+        throw std::runtime_error("Invalid chain height");
+    }
+    return chainActive[tipHeight];

Likely invalid or redundant comment.


2385-2389: 🛠️ Refactor suggestion

Add validation and error handling for block height check

The block height validation logic should handle edge cases more gracefully. Consider:

-            if (pindex->nHeight >= 200) {
-                return chainActive[pindex->nHeight - 200];
-            } else {
-                return chainActive[0];
-            }
+            int targetHeight = std::max(0, pindex->nHeight - 200);
+            if (!chainActive[targetHeight]) {
+                throw std::runtime_error("Invalid block height");
+            }
+            return chainActive[targetHeight];

@justanwar justanwar merged commit a09abf0 into master Nov 14, 2024
11 checks passed
@justanwar justanwar deleted the fix_LogPrintf_segfault branch November 14, 2024 09:49
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