Skip to content
New issue

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

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

Already on GitHub? # to your account

Refactor Errors with alias types from external crates #528

Merged
merged 1 commit into from
May 6, 2024

Conversation

reez
Copy link
Collaborator

@reez reez commented May 6, 2024

Description

Streamline error handling by introducing aliases for types from external crate. Utilized 'use' statements to create shorter, more readable names.

Notes to the reviewers

One of my last refactors I referenced potentially making in #495.

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

@reez reez marked this pull request as ready for review May 6, 2024 18:56
Copy link

coderabbitai bot commented May 6, 2024

Walkthrough

The recent modifications in the bdk-ffi project involve enhancing error handling by integrating errors from the bdk and chain libraries. New error types from the bdk library related to Bitcoin address, encoding, and PSBT extraction have been added, along with a connection error from the chain library. These errors are now mapped to the project's custom error types through several new impl From conversions, improving modularity and error management.

Changes

File Path Change Summary
bdk-ffi/src/error.rs Added use statements for BdkAddressError, BdkEncodeError, BdkExtractTxError, BdkCannotConnectError; Implemented conversions from these errors to corresponding custom errors.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 330dc96 and b7fe91b.
Files selected for processing (1)
  • bdk-ffi/src/error.rs (6 hunks)
Additional comments not posted (10)
bdk-ffi/src/error.rs (10)

28-31: Alias declarations for error types enhance readability and maintainability.


28-28: Correct alias declaration for BdkAddressError.


29-29: Correct alias declaration for BdkEncodeError.


30-30: Correct alias declaration for BdkExtractTxError.


31-31: Correct alias declaration for BdkCannotConnectError.


448-460: Proper implementation of From<BdkAddressError> for AddressError with comprehensive error handling.


555-556: Correct implementation of From<BdkCannotConnectError> for CannotConnectError.


754-764: Effective implementation of From<BdkExtractTxError> for ExtractTxError, including conversion of fee rates.


819-834: Comprehensive handling of BdkEncodeError in the From<BdkEncodeError> for TransactionError implementation.


708-709: Proper conversion of BdkBip32Error to DescriptorKeyError with appropriate error messaging.


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.

@reez reez self-assigned this May 6, 2024
@reez reez requested a review from thunderbiscuit May 6, 2024 18:56
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 b7fe91b.

@reez reez merged commit b7fe91b into bitcoindevkit:master May 6, 2024
25 checks passed
@reez reez deleted the from branch May 6, 2024 19:44
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants