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

danielabrozzoni · 2023-10-09T14:50:26Z

Fixes #872

Description

This commit moves the hardwaresigner outside of bdk and inside bdk_hwi

Notes to the reviewers

There are currently two issues with the code:

TransactionSigner dictates that sign_transaction must return a SignerError - but being SignerError defined inside of bdk, we can't modify it to include an hwi specific error! I don't know how we could fix this (other than getting rid of the trait altogether :)); for now I just added a SignerError::Generic variant, lmk if you have better ideas!
The hwi tests used the bdk utils to get a funded wallet for testing, which aren't available in bdk_hwi, which made me realize - maybe we should expose them so that we can use them across our crates, and also our users can use them to test their code?
For now, I just left the test commented.

Changelog notice

The old hardwaresigner module has been moved out of bdk and inside bdk_hwi.

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

nondiremanuel · 2023-11-07T15:20:49Z

As per today's discussion in the Lib Team Call, this PR probably needs to be rebased after the ci fix of #1182

ValuedMammal

ACK

I also agree it would be nice to move some common bdk test utils to a shared crate - similar to #1171

ValuedMammal · 2023-11-20T14:25:44Z

crates/hwi/src/signer.rs

+            self.client
+                .sign_tx(psbt)
+                .map_err(|e| {
+                    SignerError::Generic(format!("While signing with hardware wallet: {}", e))


would this work?

Suggested change

SignerError::Generic(format!("While signing with hardware wallet: {}", e))

SignerError::HWIError(e.to_string())

In order for this to work, we would need to add the HWIError variant inside of bdk, which is not really desirable since it wouldn't be used inside bdk but in an outside crate.

evanlinjin · 2023-11-21T21:11:49Z

This PR moves harwaresigner into a separate crate, but the new crate still depends on bdk. Ideally, bdk_hwi should not depend on bdk. The best way to do this is to have the Signer traits in a separate crate as well - however, this is also non-ideal since those traits will most likely be scrapped in the future.

I would really love to have hwi as a separate crate. However, I don't think it makes sense to do it with the current state of Wallet.

Introducing SignerError::Generic is also non-ideal. Now the error variant for HWI is ambiguous.

In conclusion, I think we should try this again later down the line.

danielabrozzoni · 2023-11-22T08:49:22Z

Ideally, bdk_hwi should not depend on bdk

Why? We already have rust_hwi available if someone wants to use hardware wallets without using bdk. bdk_hwi is supposed to be for people that want to use hwi and bdk together, so I don't see why it shouldn't depend on bdk.

Introducing SignerError::Generic is also non-ideal. Now the error variant for HWI is ambiguous.

True, but at the moment everyone trying to implement the Signer trait in a crate outside of bdk encounters the same problem, so I think we should find a way to fix this anyways (without having to wait for a complete refactoring on the signer/wallet, since that will take a while). We could add either good docs to SignerError::Generic, create a SignerError::External (for external crates), or maybe we could refactor the trait to return a generic Box<dyn std::error::Error> (I haven't tested this so it might not be feasible)

I agree that this code is very suboptimal given the state of the Wallet, but we won't refactor the Wallet until bdk 2.0; do we want to leave hwi inside bdk, untested, until then?

nondiremanuel · 2023-12-05T12:07:20Z

@evanlinjin do you have any feedback on Daniela's last comment?

notmandatory · 2023-12-12T03:34:49Z

Please rebase now that #1183 has been merged.

danielabrozzoni · 2023-12-13T09:14:09Z

Done, thanks!

notmandatory · 2023-12-13T19:05:21Z

crates/bdk/src/wallet/signer.rs

-        SignerError::HWIError(e)
-    }
+    /// A generic error
+    Generic(String),


I'm not a big fan of the SignerError::Generic since I just removed bdk::Error::Generic in #1028. But in this case I don't see an simple way around it. If it becomes annoying we can fix it in 2.0 release.

notmandatory

ACK f1124d4

notmandatory · 2023-12-20T17:35:50Z

Can merge this one after the new CI issues are fixed with #1247 (after it's ACKd and merged).

evanlinjin

ACK f1124d4

I don't like SignerError::Generic, however I don't see a better option without taking too much time. We will change the API greatly for 2.0 anyway (as @danielabrozzoni mentioned: #1161 (comment)).

danielabrozzoni · 2024-01-02T12:41:29Z

Do you think it would be better to rename SignerError::Generic to SignerError::ExternalTraitImplementationError or something better? This would make it clear that it's needed only for external libraries implementing the Signer trait.

notmandatory · 2024-01-06T04:14:22Z

How about SignerError::External with doc that explains this is for external trait implementation errors? Or I'd be fine with the longer version too.

Fixes bitcoindevkit#872

danielabrozzoni · 2024-01-08T12:34:52Z

Thanks, I rebased and changed Error::Generic to Error::External. LMK if the docs look ok or if they can be improved!

notmandatory

reACK 105d70e

danielabrozzoni force-pushed the issue/872 branch 2 times, most recently from 8cfee3e to 6d9920d Compare October 9, 2023 16:57

notmandatory added this to the 1.0.0-alpha.3 milestone Oct 10, 2023

notmandatory assigned danielabrozzoni Oct 13, 2023

nondiremanuel mentioned this pull request Oct 22, 2023

W43 Lib Team Call bitcoindevkit/.github#83

Closed

33 tasks

nondiremanuel mentioned this pull request Nov 5, 2023

W45 Lib Team Call bitcoindevkit/.github#84

Closed

38 tasks

danielabrozzoni force-pushed the issue/872 branch from 6d9920d to 4049c70 Compare November 9, 2023 09:30

danielabrozzoni mentioned this pull request Nov 16, 2023

chore: fix typos #1220

Merged

8 tasks

nondiremanuel mentioned this pull request Nov 19, 2023

W47 Lib Team Call bitcoindevkit/.github#86

Closed

54 tasks

ValuedMammal reviewed Nov 20, 2023

View reviewed changes

danielabrozzoni force-pushed the issue/872 branch from 4049c70 to e291408 Compare November 24, 2023 13:02

nondiremanuel mentioned this pull request Dec 2, 2023

W49 Lib Team Call bitcoindevkit/.github#87

Closed

55 tasks

danielabrozzoni force-pushed the issue/872 branch from e291408 to f1124d4 Compare December 13, 2023 09:13

notmandatory reviewed Dec 13, 2023

View reviewed changes

notmandatory approved these changes Dec 13, 2023

View reviewed changes

nondiremanuel mentioned this pull request Jan 1, 2024

W01 Lib Team Call bitcoindevkit/.github#89

Closed

24 tasks

evanlinjin approved these changes Jan 2, 2024

View reviewed changes

nondiremanuel modified the milestones: 1.0.0-alpha.3, 1.0.0 Jan 6, 2024

ref(hwi): Move hwi out of bdk

105d70e

Fixes bitcoindevkit#872

danielabrozzoni force-pushed the issue/872 branch from f1124d4 to 105d70e Compare January 8, 2024 12:34

notmandatory approved these changes Jan 8, 2024

View reviewed changes

notmandatory merged commit 6e6bad9 into bitcoindevkit:master Jan 8, 2024
12 checks passed

notmandatory added the api A breaking API change label Jan 16, 2024

notmandatory mentioned this pull request Jan 16, 2024

Release 1.0.0-alpha.4 #1281

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

danielabrozzoni commented Oct 9, 2023

nondiremanuel commented Nov 7, 2023

ValuedMammal left a comment

ValuedMammal Nov 20, 2023

danielabrozzoni Nov 21, 2023

evanlinjin commented Nov 21, 2023

danielabrozzoni commented Nov 22, 2023

nondiremanuel commented Dec 5, 2023

notmandatory commented Dec 12, 2023

danielabrozzoni commented Dec 13, 2023

notmandatory Dec 13, 2023

notmandatory left a comment

notmandatory commented Dec 20, 2023 •

edited

Loading

evanlinjin left a comment

danielabrozzoni commented Jan 2, 2024

notmandatory commented Jan 6, 2024 •

edited

Loading

danielabrozzoni commented Jan 8, 2024

notmandatory left a comment

	SignerError::Generic(format!("While signing with hardware wallet: {}", e))
	SignerError::HWIError(e.to_string())

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

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

Conversation

danielabrozzoni commented Oct 9, 2023

Description

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

New Features:

nondiremanuel commented Nov 7, 2023

ValuedMammal left a comment

Choose a reason for hiding this comment

ValuedMammal Nov 20, 2023

Choose a reason for hiding this comment

danielabrozzoni Nov 21, 2023

Choose a reason for hiding this comment

evanlinjin commented Nov 21, 2023

danielabrozzoni commented Nov 22, 2023

nondiremanuel commented Dec 5, 2023

notmandatory commented Dec 12, 2023

danielabrozzoni commented Dec 13, 2023

notmandatory Dec 13, 2023

Choose a reason for hiding this comment

notmandatory left a comment

Choose a reason for hiding this comment

notmandatory commented Dec 20, 2023 • edited Loading

evanlinjin left a comment

Choose a reason for hiding this comment

danielabrozzoni commented Jan 2, 2024

notmandatory commented Jan 6, 2024 • edited Loading

danielabrozzoni commented Jan 8, 2024

notmandatory left a comment

Choose a reason for hiding this comment

notmandatory commented Dec 20, 2023 •

edited

Loading

notmandatory commented Jan 6, 2024 •

edited

Loading