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

Bump rust bdk to alpha 11 #533

Merged
merged 1 commit into from
May 14, 2024
Merged

Conversation

reez
Copy link
Collaborator

@reez reez commented May 11, 2024

Description

Bump rust bdk to alpha 11 with things like:

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 self-assigned this May 11, 2024
@reez reez force-pushed the alpha-11 branch 7 times, most recently from d60bf77 to 553755c Compare May 11, 2024 20:25
@reez reez marked this pull request as ready for review May 11, 2024 20:31
Copy link

coderabbitai bot commented May 11, 2024

Walkthrough

The updates across various modules primarily involve a transition from using total balance directly to accessing it through the .sat property, reflecting a shift to more explicitly handle balances in satoshis. Additionally, the introduction of the Amount struct and modifications to error handling and type definitions align with enhancing clarity and precision in balance and transaction management.

Changes

File Path Change Summary
.../LiveTxBuilderTest.kt, .../LiveWalletTest.kt, .../OfflineWalletTest.kt Updated print and assert statements to use .sat for balance checks.
bdk-ffi/src/... Added Amount struct, updated balance and transaction value types to Amount, and introduced new error handling.
.../test_live_tx_builder.py, .../test_live_wallet.py, .../test_offline_wallet.py Modified assertions to check balance using .sat attribute.
.../LiveTxBuilderTests.swift, .../LiveWalletTests.swift, .../OfflineWalletTests.swift Updated assertions to use .sat property for balance checks in Swift tests.

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.

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

Out of diff range and nitpick comments (1)
bdk-python/tests/test_offline_wallet.py (1)

Line range hint 16-16: Undefined name 'Wallet' used. This might be due to a missing import or a typo.

+ from bdk import Wallet

@reez reez requested a review from thunderbiscuit May 13, 2024 13:08
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.

Looks good! My one thought that might need more discussion is around the Amount type being a dictionary instead of an interface. I think if we eventually want to expand it to more (and the from_sat and from_btc method might be the first ones we go after) in order to use the type for what it's pretty good at, we'll need methods on it, and therefore will not be able to have fields.

Another option is to have an actual struct that would hold both as fields, but then no other cool methods could be called on it. Something like

struct Amount {
    pub sat: u64,
    pub btc: f64,
}

But then you'd still need constructors from_sat and from_btc to create it from the bindigns side (for example when providing it to your txbuilder)? I haven't tried that before but I think that might not be possible.

@thunderbiscuit
Copy link
Member

Oh and the Amount type belongs in the bitcoin module rather than the types module.

@reez
Copy link
Collaborator Author

reez commented May 13, 2024

Oh and the Amount type belongs in the bitcoin module rather than the types module.

my b, fixed!

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

Out of diff range and nitpick comments (1)
bdk-python/tests/test_offline_wallet.py (1)

Line range hint 16-16: Undefined name Wallet used in the test setup.

- wallet: Wallet = bdk.Wallet(
+ wallet: bdk.Wallet = bdk.Wallet(

@reez reez force-pushed the alpha-11 branch 4 times, most recently from 465a0a5 to e554088 Compare May 14, 2024 18:39
@reez
Copy link
Collaborator Author

reez commented May 14, 2024

@thunderbiscuit ready for review/merge, rebased on the signet PR, test passing

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 e554088. Good work! A lot of files changes, but nothing too insane in the end.

Would you mind adding text for the changelog? That way we can just copy/paste it when we make the release.

@reez
Copy link
Collaborator Author

reez commented May 14, 2024

ACK e554088. Good work! A lot of files changes, but nothing too insane in the end.

Would you mind adding text for the changelog? That way we can just copy/paste it when we make the release.

Sure, added, hopefully its what you were looking for-

@thunderbiscuit
Copy link
Member

Oh well that's not quite what I meant but it works!

@thunderbiscuit thunderbiscuit merged commit 97d9bb6 into bitcoindevkit:master May 14, 2024
25 checks passed
@reez reez deleted the alpha-11 branch May 14, 2024 19:59
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