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.

Sign up for GitHub

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

Jump to bottom

Add from to CannotConnectError #525

Merged
merged 1 commit into from
May 2, 2024
Merged

Add from to CannotConnectError #525

merged 1 commit into from
May 2, 2024

Conversation

reez
Copy link
Collaborator

@reez reez commented May 2, 2024 •
edited by coderabbitai bot
Loading

Description

Merge #524 first.

This adds a From for CannotConnectError, which is in line with how we want to format.

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

Summary by CodeRabbit

  • New Features

    • Improved error handling for wallet connectivity issues.

  • Refactor

    • Simplified error management in wallet operations.

@reez reez self-assigned this May 2, 2024
@reez reez changed the title Add from to cannotconnecterror Add from to CannotConnectError May 2, 2024
@reez reez marked this pull request as ready for review May 2, 2024 16:15
@reez reez requested a review from thunderbiscuit May 2, 2024 16:15
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 2, 2024 •
edited
Loading

Walkthrough

The recent updates primarily focus on enhancing error handling in the BDK-FFI library. A new error conversion has been implemented in the error.rs file, and the wallet.rs file has been modified to utilize this conversion more effectively. This simplifies the error management process within the wallet's apply_update method, making the code cleaner and more maintainable.

Changes

File Change Summary
.../error.rs - Added use bdk::chain;.
- Implemented conversion from chain::local_chain::CannotConnectError to CannotConnectError.
.../wallet.rs - Simplified error handling in the apply_update method by using CannotConnectError::from.
Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 75d155c and 9b5b967.
Files selected for processing (2)
  • bdk-ffi/src/error.rs (2 hunks)
  • bdk-ffi/src/wallet.rs (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • bdk-ffi/src/error.rs
  • bdk-ffi/src/wallet.rs

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

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.
  • 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.

coderabbitai[bot]
coderabbitai bot reviewed May 2, 2024
View reviewed changes
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: 1

bdk-ffi/src/error.rs Outdated
Comment on lines 831 to 837
impl From<chain::local_chain::CannotConnectError> for CannotConnectError {
fn from(error: chain::local_chain::CannotConnectError) -> Self {
CannotConnectError::Include {
height: error.try_include_height,
}
}
}
Copy link

Choose a reason for hiding this comment

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

The implementation of From for CannotConnectError is straightforward and correctly uses the try_include_height field. However, consider renaming try_include_height to something more descriptive if it does not involve a try-catch mechanism or isn't a boolean. This would enhance code readability and maintainability.

thunderbiscuit
thunderbiscuit approved these changes May 2, 2024
View reviewed changes
Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

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

ACK 620af06.

@reez
Copy link
Collaborator Author

reez commented May 2, 2024

Just rebasing off of what was just merged into master right now is all

@reez reez merged commit 9b5b967 into bitcoindevkit:master May 2, 2024
25 checks passed
@reez reez deleted the cannot branch May 2, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@thunderbiscuit thunderbiscuit thunderbiscuit approved these changes

Assignees

@reez reez

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@reez @thunderbiscuit