refactor(wallet): use Amount everywhere#1595
Merged
notmandatory merged 1 commit intobitcoindevkit:masterfrom Sep 9, 2024
Merged
refactor(wallet): use Amount everywhere#1595notmandatory merged 1 commit intobitcoindevkit:masterfrom
Amount everywhere#1595notmandatory merged 1 commit intobitcoindevkit:masterfrom
Conversation
Comment on lines
35
to
39
| impl IsDust for u64 { | ||
| fn is_dust(&self, script: &Script) -> bool { | ||
| *self < script.minimal_non_dust().to_sat() | ||
| Amount::from_sat(*self).is_dust(script) | ||
| } | ||
| } |
Collaborator
There was a problem hiding this comment.
nit: I guess this could be moved to coin_selection, it's the only place still using is_dust with a u64, right ?
notmandatory
reviewed
Sep 9, 2024
| let mut tx_builder = wallet.build_tx(); | ||
| tx_builder | ||
| .add_recipient(faucet_address.script_pubkey(), SEND_AMOUNT) | ||
| .add_recipient(address.script_pubkey(), SEND_AMOUNT) |
Member
There was a problem hiding this comment.
👍 thanks for cleaning this up!
This was referenced Sep 13, 2024
Closed
Closed
6 tasks
notmandatory
added a commit
that referenced
this pull request
Dec 11, 2024
…se Amount type 2a9eeed ci: pin msrv dep version for rustls (Steve Myers) 20789ec refactor(chain)!: use Amount for DescriptorExt::dust_value() (Steve Myers) 58a8435 refactor(coin_selection)!: use Amount and SignedAmount for API and internally (Steve Myers) Pull request description: ### Description refactor(coin_selection)!: use Amount and SignedAmount for API and internally refactor(chain)!: use Amount for DescriptorExt::dust_value() Using named types make the API and internal code easier to read and reason about since it makes it clear that the values are bitcoin amounts. Also to create these types the units (ie .from_sat()) must be specified. ### Notes to the reviewers For coin_selection using Amount and SignedAmount makes internal code safer against overflow errors. In particular because these types will panic if an amount overflow occurs. Using u64/i64 on the other hand can silently rollover. See: https://doc.rust-lang.org/book/ch03-02-data-types.html#integer-overflow This is a continuation of the work done in #1595. Since this is an API breaking change I would like to include it in the 1.0.0-beta milestone if possible. ### Changelog notice - Change coin_selection to use Amount instead of u64 for all bitcoin amounts. - Change DescriptorExt::dust_value() to return an Amount instead of u64. ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing #### Bugfixes: * [x] 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 ACKs for top commit: ValuedMammal: ACK 2a9eeed Tree-SHA512: 9dd1b31d0f8d3d8c383c7aae7ec0fffb55bfcfe49c804e273faa740d30efde7efb7c9504e87cceb56798ea14a3e34fc8a7b65a8ad5e52ea38b8523150c9b6bc2
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a followup to #1426 that refactors wallet internals to use
bitcoin::Amount(nearly) everywhere. I chose not to change any public types incoin_selection.rsthat still useu64as that might require more discussion.partially addresses #1432
fixes #1434
Checklists
All Submissions:
cargo fmtandcargo clippybefore committing