Add CreateTxError and use as error type for TxBuilder::finish() #1028

notmandatory · 2023-07-06T03:02:40Z

Description

To remove some places where there were .expect("TODO") I added a new CreateTxError type which is returned from TxBuilder::finish(). I also updated related tests and doc tests.

Fixes #996 (comment)

Also added fallible Wallet::try_get_address() and try_get_internal_address() to return Result with a possible D:WriteError when a PersistBackend is used. This should fix #996.

I removed catch-all bdk::Error and replaced usages with new types and updated related functions, fixes #994.

Notes to the reviewers

I didn't add all possible bdk::Error types that Wallet::create_tx() and TxBuilder::finish() functions might throw. It's probably not too much more work but will take a bit more research so I want to make sure this is the right general approach first.

I added anyhow to the dev-dependencies so I could remove some .expect() lines from the docs tests and make the examples closer to what an end user should do. I also used the anyhow!() macro to replace a few places that were using the bdk::Error::Generic in example code.

I also moved the module level error.rs file to wallet/error.rs so no one would be tempted to make any new catch all errors and to make it clear that all the errors in it are wallet module related.

Changelog notice

Changed

Updated bdk module to use new context specific error types
- wallet: MiniscriptPsbtError, CreateTxError, BuildFeeBumpError error enums
- coin_selection: module Error enum
Renamed fallible Wallet address functions to try_get_address() and try_get_internal_address()

Removed

Removed catch-all top level bdk::Error enum
Removed impl_error macro

Added

Added infallible Wallet get_address(), get_internal_address functions

Checklists

All Submissions:

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

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

evanlinjin

Thank you for taking this on!

I appreciate your attempt to be conservative in the amount of changes made. However, the current state of this PR does not result in a better API since the caller still has to handle a large list of redundant error variants.

If it was a PR to purely remove the .expect("TODO")s, I would just return a bdk::Error::Generic or introduce a new variant in bdk::Error.

However, I would prefer this PR to fix the error-handling API for tx creation completely (as it seems you already have done the majority of the work).

crates/bdk/src/wallet/mod.rs

evanlinjin · 2023-07-07T04:54:04Z

But we probably just need a quick fix for the next release.

notmandatory · 2023-07-08T02:27:19Z

I added fallible Wallet::try_get_address() and try_get_internal_address() to return Result with a possible D:WriteError when a PersistBackend is used. This should fix #996.

notmandatory · 2023-07-08T04:53:55Z

I removed the CreateTxError::Bdk variant and moved all the needed variants from the bdk::Error to the CreateTxError enum, plus created concrete variants for any errors that were using Generic. A few other things I'd like to do, but don't need to be in this PR:

add BuildFeeBumpError enum for Wallet::build_fee_bump
add SignError enum for Wallet::sign
add FinalizeError enum for Wallet::finalize
eliminate (or greatly diminish) bdk::Error
move the wallet error enums and related code to a wallet::error file
add fallible and infallible versions of any others Wallet functions it makes sense for

notmandatory · 2023-07-15T14:27:00Z

Per comment: #1025 (comment)

I'm moving this to future alpha release.

LLFourn

+1 on adding CreateTxError. left some comments.

crates/bdk/src/wallet/mod.rs

example-crates/wallet_electrum/src/main.rs

nondiremanuel · 2023-08-22T17:19:14Z

@notmandatory we didn't talk about this PR in the last calls. Is it correct to keep it into alpha.3 milestone? Shall we discuss it in the next call?

notmandatory · 2023-08-23T00:57:03Z

@notmandatory we didn't talk about this PR in the last calls. Is it correct to keep it into alpha.3 milestone? Shall we discuss it in the next call?

I don't think we need to discuss it until after alpha.2 is released. Then I'll have to rebase it and fix a few small things and will bug folks for a re-review.

notmandatory · 2023-11-07T18:07:20Z

I've removed the cfg for fmt::Display and created a new issue for that change (if we want to do it). Tests passing and ready for re-review.

ValuedMammal

I made minor comments, but nothing that should block this from moving forward

crates/bdk/examples/mnemonic_to_descriptors.rs

crates/bdk/src/wallet/mod.rs

crates/bdk/src/wallet/tx_builder.rs

crates/bdk/src/wallet/error.rs

crates/bdk/src/wallet/mod.rs

notmandatory · 2023-11-14T05:56:36Z

I pushed a couple more commits to add changes suggested by @ValuedMammal. I'll squash commits to clean up the history prior to merging.

matthiasdebernardini · 2023-11-15T17:22:22Z

Hey! This needs fixing too, "not enough"

bdk/crates/bdk/src/descriptor/policy.rs

Line 524 in d6a0cf0

    
           Self::NotEnoughItemsSelected(err) => write!(f, "Not enought items selected: {}", err),

vladimirfomene

Just nits. LGTM. ACK 35a108b

crates/bdk/src/wallet/coin_selection.rs

crates/bdk/src/wallet/mod.rs

evanlinjin · 2023-11-16T00:41:12Z

I don't think this should be addressed in this PR, but I think we should use idiomatic naming for methods: https://rust-lang.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter

I.e. Wallet::get_address should be Wallet::address.

evanlinjin

ACK 35a108b

Thank you for this work. Now the errors are more domain-specific and detailed.

danielabrozzoni

Fantastic work, than you.

I think Lloyd's comment should be fixed, as it should be fairly trivial. I left a comment on that.

crates/bdk/src/wallet/mod.rs

notmandatory · 2023-11-16T14:27:35Z

I think Lloyd's comment should be fixed, as it should be fairly trivial. I left a comment on that.

Ohhhh! 🤦‍♂️ thanks for the help here, now I get it. I'm going to push your fix, rebase, clean up the history a little, and then it should be ready to merge.

…ror mod refactor(bdk)!: remove impl_error macro refactor(wallet)!: add MiniscriptPsbtError, CreateTxError, BuildFeeBumpError error enums refactor(coin_selection)!: add module Error enum test(bdk): use anyhow dev-dependency for all tests

…ss functions refactor!(wallet)!: rename fallible Wallet try_get_address(), try_get_internal_address functions

I made the requested fix (with some help from Daniela)

notmandatory self-assigned this Jul 6, 2023

notmandatory added the module-wallet label Jul 6, 2023

notmandatory added this to the 1.0.0-alpha.1 milestone Jul 6, 2023

notmandatory force-pushed the tmp_fix_write_error branch from f19ce86 to 0bbb998 Compare July 6, 2023 03:05

notmandatory marked this pull request as draft July 6, 2023 03:10

notmandatory changed the title ~~Add CreateTxError as error type for TxBuilder::finish()~~ Add CreateTxError and use as error type for TxBuilder::finish() Jul 6, 2023

notmandatory force-pushed the tmp_fix_write_error branch 5 times, most recently from 17b3987 to d99e4a5 Compare July 6, 2023 03:53

notmandatory marked this pull request as ready for review July 6, 2023 04:00

evanlinjin requested changes Jul 7, 2023

View reviewed changes

crates/bdk/src/wallet/mod.rs Outdated Show resolved Hide resolved

notmandatory marked this pull request as draft July 8, 2023 01:11

notmandatory force-pushed the tmp_fix_write_error branch 2 times, most recently from be04de6 to cc4ba36 Compare July 8, 2023 02:20

notmandatory marked this pull request as ready for review July 8, 2023 04:56

notmandatory mentioned this pull request Jul 13, 2023

Release 1.0.0-alpha.1 #1025

Closed

24 tasks

notmandatory removed this from the 1.0.0-alpha.1 milestone Jul 15, 2023

notmandatory mentioned this pull request Jul 15, 2023

W29 Lib Team Call bitcoindevkit/.github#68

Closed

19 tasks

notmandatory added this to the 1.0.0-alpha.4 milestone Jul 18, 2023

LLFourn previously requested changes Jul 20, 2023

View reviewed changes

crates/bdk/src/wallet/mod.rs Show resolved Hide resolved

example-crates/wallet_electrum/src/main.rs Outdated Show resolved Hide resolved

notmandatory mentioned this pull request Aug 1, 2023

Remove TransactionDetails from Wallet API #1048

Merged

5 tasks

nondiremanuel mentioned this pull request Aug 22, 2023

W35 Lib Team Call bitcoindevkit/.github#74

Closed

30 tasks

notmandatory mentioned this pull request Nov 7, 2023

Reduce size of no_std binaries #1198

Open

notmandatory force-pushed the tmp_fix_write_error branch 2 times, most recently from 26ce0fa to 55e2c9f Compare November 7, 2023 17:22

notmandatory force-pushed the tmp_fix_write_error branch from 55e2c9f to 1014b87 Compare November 13, 2023 20:34

ValuedMammal reviewed Nov 13, 2023

View reviewed changes

notmandatory force-pushed the tmp_fix_write_error branch from 39476fb to 626bdf0 Compare November 14, 2023 05:32

notmandatory mentioned this pull request Nov 14, 2023

Make sure all docs and example derivation paths correspond to the network #1209

Open

notmandatory mentioned this pull request Nov 15, 2023

Update policy.rs - small typo in error message #1217

Closed

8 tasks

notmandatory force-pushed the tmp_fix_write_error branch from 626bdf0 to 35a108b Compare November 15, 2023 17:59

vladimirfomene approved these changes Nov 15, 2023

View reviewed changes

crates/bdk/src/wallet/coin_selection.rs Outdated Show resolved Hide resolved

crates/bdk/src/wallet/mod.rs Outdated Show resolved Hide resolved

crates/bdk/src/wallet/mod.rs Show resolved Hide resolved

notmandatory force-pushed the tmp_fix_write_error branch 2 times, most recently from 92f8579 to 1ec4716 Compare November 15, 2023 21:53

evanlinjin approved these changes Nov 16, 2023

View reviewed changes

danielabrozzoni reviewed Nov 16, 2023

View reviewed changes

crates/bdk/src/wallet/mod.rs Show resolved Hide resolved

notmandatory mentioned this pull request Nov 16, 2023

refactor(bdk): use idiomatic naming for all getter methods #1221

Open

notmandatory force-pushed the tmp_fix_write_error branch from 6f570ed to d36bafe Compare November 16, 2023 15:16

notmandatory added 2 commits November 16, 2023 10:24

feat(wallet): Add infallible Wallet get_address(), get_internal_addre…

77f9977

…ss functions refactor!(wallet)!: rename fallible Wallet try_get_address(), try_get_internal_address functions

notmandatory force-pushed the tmp_fix_write_error branch from d36bafe to 77f9977 Compare November 16, 2023 17:22

ci: fix MSRV pinning for rustls 0.21.9

00ec19e

notmandatory merged commit 46d39be into bitcoindevkit:master Nov 16, 2023
12 checks passed

nondiremanuel mentioned this pull request Nov 19, 2023

W47 Lib Team Call bitcoindevkit/.github#86

Closed

54 tasks

notmandatory mentioned this pull request Dec 13, 2023

ref(hwi): Move hwi out of bdk #1161

Merged

4 tasks

notmandatory mentioned this pull request Jan 3, 2024

Release 1.0.0-alpha.3 #1254

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CreateTxError and use as error type for TxBuilder::finish() #1028

Add CreateTxError and use as error type for TxBuilder::finish() #1028

notmandatory commented Jul 6, 2023 •

edited

evanlinjin left a comment

evanlinjin commented Jul 7, 2023

notmandatory commented Jul 8, 2023

notmandatory commented Jul 8, 2023 •

edited

notmandatory commented Jul 15, 2023

LLFourn left a comment

nondiremanuel commented Aug 22, 2023

notmandatory commented Aug 23, 2023

notmandatory commented Nov 7, 2023

ValuedMammal left a comment

notmandatory commented Nov 14, 2023 •

edited

matthiasdebernardini commented Nov 15, 2023

vladimirfomene left a comment

evanlinjin commented Nov 16, 2023

evanlinjin left a comment

danielabrozzoni left a comment

notmandatory commented Nov 16, 2023

Add CreateTxError and use as error type for TxBuilder::finish() #1028

Add CreateTxError and use as error type for TxBuilder::finish() #1028

Conversation

notmandatory commented Jul 6, 2023 • edited

Description

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

Bugfixes:

evanlinjin left a comment

Choose a reason for hiding this comment

evanlinjin commented Jul 7, 2023

notmandatory commented Jul 8, 2023

notmandatory commented Jul 8, 2023 • edited

notmandatory commented Jul 15, 2023

LLFourn left a comment

Choose a reason for hiding this comment

nondiremanuel commented Aug 22, 2023

notmandatory commented Aug 23, 2023

notmandatory commented Nov 7, 2023

ValuedMammal left a comment

Choose a reason for hiding this comment

notmandatory commented Nov 14, 2023 • edited

matthiasdebernardini commented Nov 15, 2023

vladimirfomene left a comment

Choose a reason for hiding this comment

evanlinjin commented Nov 16, 2023

evanlinjin left a comment

Choose a reason for hiding this comment

danielabrozzoni left a comment

Choose a reason for hiding this comment

notmandatory commented Nov 16, 2023

notmandatory commented Jul 6, 2023 •

edited

notmandatory commented Jul 8, 2023 •

edited

notmandatory commented Nov 14, 2023 •

edited