Fix clippy warnings for new stable rust `1.50.0` by notmandatory · Pull Request #282 · bitcoindevkit/bdk

notmandatory · 2021-02-11T19:17:11Z

Description

Two new clippy warning are showing up with the new stable version of rust 1.50.0.

The first clippy warning unnecessary_wraps only required removing the unnecessary Result wrapper for the policy::finalize() and compact_filters peer::_recv() functions.

Slightly more changes were required for the second warning wrong_self_convention which requires renaming the ToWalletDescriptor::to_wallet_descriptor() function to into_wallet_descriptor() to satisfy the naming convention that into_ methods take self and to_ methods take &self.

Notes to the reviewers

Once this is merged to master I'll cherry pick it to the `release/0.4.0' branch.

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
I've updated CHANGELOG.md

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

tcharding

Typo in brief message of commit: 25222b4 Fix clippy warning 'unnecissary_wraps' (unnecessary misspelled).

Thanks

tcharding · 2021-02-13T04:26:43Z

src/descriptor/mod.rs

@@ -74,15 +74,15 @@ pub type HDKeyPaths = BTreeMap<PublicKey, KeySource>;
 /// Trait for types which can be converted into an [`ExtendedDescriptor`] and a [`KeyMap`] usable by a wallet in a specific [`Network`]
 pub trait ToWalletDescriptor {


Perhaps this should be changed as well to IntoWalletDescriptor.

Ah yes makes sense. Fixed.

tcharding · 2021-02-13T04:27:19Z

CHANGELOG.md

 - Removed the explicit `id` argument from `Wallet::add_signer()` since that's now part of `Signer` itself
+- Renamed `ToWalletDescriptor::to_wallet_descriptor` to `ToWalletDescriptor::into_wallet_descriptor`
+
+### Policy 


This line has trailing whitespace.

👍 fixed.

tcharding · 2021-02-13T04:33:09Z

src/descriptor/template.rs

@@ -70,12 +70,12 @@ pub trait DescriptorTemplate {
 /// Turns a [`DescriptorTemplate`] into a valid wallet descriptor by calling its
 /// [`build`](DescriptorTemplate::build) method
 impl<T: DescriptorTemplate> ToWalletDescriptor for T {


Perhaps the trait should be renamed also to IntoWalletDescriptor.

Yes good call, fixed.

tcharding · 2021-02-13T04:38:27Z

CHANGELOG.md

 ### Wallet
 #### Changed
 - Removed the explicit `id` argument from `Wallet::add_signer()` since that's now part of `Signer` itself
+- Renamed `ToWalletDescriptor::to_wallet_descriptor` to `ToWalletDescriptor::into_wallet_descriptor`


Perhaps we should mention ToDescriptorKey as well?

Yes just added and I also renamed the trait ToDescriptorKey to be IntoDescriptorKey to match the into_descriptor_key() function name.

afilini

utACK 1c6864a

I'm a bit annoyed by this thing that our CI breaks every time there's a new Rust release.. maybe we should consider hard-coding the toolchain version and only manually update it "atomically" in a PR that fixes all the new clippy warnings that come with it.

afilini · 2021-02-13T16:09:10Z

Merging those into the release branch as well since we'll need the CI to run the tests before publishing

notmandatory · 2021-02-13T18:05:30Z

utACK 1c6864a
maybe we should consider hard-coding the toolchain version and only manually update it "atomically" in a PR that fixes all the new clippy warnings that come with it.

Ya I agree. I'll create a PR 🙂

tcharding · 2021-02-15T08:07:02Z

utACK 1c6864a

I'm a bit annoyed by this thing that our CI breaks every time there's a new Rust release.. maybe we should consider hard-coding the toolchain version and only manually update it "atomically" in a PR that fixes all the new clippy warnings that come with it.

Alternatively we can just keep the code linting cleanly using nightly (assuming no breaking changes to previous stable versions) and then this issue shouldn't arise. This PR makes a start.

notmandatory · 2021-02-15T17:49:21Z

I think trying to keep our code mostly or partially in sync with nightly lint rules will be more work than it's worth.

I'd rather do what @afilini is suggesting above which is to hard code our CI to test against our MSRV 1.45 and the current stable version. We can then upgrade to any newer stable version as they come out with a single PR without CI breaking unexpectedly.

notmandatory force-pushed the fix/clippy_150 branch from d0ff5f7 to 3bf20b9 Compare February 11, 2021 19:19

notmandatory changed the title ~~Fix/clippy 150~~ Fix clippy warnings for new stable rust 1.50.0 Feb 11, 2021

notmandatory force-pushed the fix/clippy_150 branch 2 times, most recently from d2f22cd to 3ebf720 Compare February 11, 2021 23:24

notmandatory marked this pull request as ready for review February 11, 2021 23:40

notmandatory requested a review from afilini February 11, 2021 23:40

notmandatory mentioned this pull request Feb 12, 2021

Add add_foreign_utxo #279

Merged

8 tasks

LLFourn approved these changes Feb 12, 2021

View reviewed changes

tcharding reviewed Feb 13, 2021

View reviewed changes

tcharding mentioned this pull request Feb 13, 2021

126 clippy #285

Merged

9 tasks

notmandatory added 3 commits February 12, 2021 22:23

Fix clippy warning 'unnecessary_wraps'

eda2349

Fix clippy warning 'wrong_self_convention'

04348d0

Fix clippy warn on compact_filters peer::_recv()

c90a1f7

notmandatory force-pushed the fix/clippy_150 branch from 3ebf720 to 8827e32 Compare February 13, 2021 06:24

notmandatory added 3 commits February 12, 2021 23:23

Update CHANGELOG for rust 1.50.0 clippy changes

2f75137

Rename ToWalletDescriptor to IntoWalletDescriptor

d638da2

Rename ToDescriptorKey to IntoDescriptorKey

1c6864a

notmandatory force-pushed the fix/clippy_150 branch from 48adfd9 to 1c6864a Compare February 13, 2021 07:23

afilini approved these changes Feb 13, 2021

View reviewed changes

afilini merged commit 1c6864a into bitcoindevkit:master Feb 13, 2021

notmandatory mentioned this pull request Feb 15, 2021

[ci] Manually set rust stable version in CI pipeline #290

Merged

4 tasks

notmandatory deleted the fix/clippy_150 branch September 16, 2021 20:15

		@@ -74,15 +74,15 @@ pub type HDKeyPaths = BTreeMap<PublicKey, KeySource>;
		/// Trait for types which can be converted into an [`ExtendedDescriptor`] and a [`KeyMap`] usable by a wallet in a specific [`Network`]
		pub trait ToWalletDescriptor {

Conversation

notmandatory commented Feb 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Checklists

All Submissions:

New Features:

Bugfixes:

Uh oh!

tcharding left a comment

Choose a reason for hiding this comment

Uh oh!

tcharding Feb 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

tcharding Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

tcharding Feb 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

tcharding Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 13, 2021

Choose a reason for hiding this comment

Uh oh!

afilini left a comment

Choose a reason for hiding this comment

Uh oh!

afilini commented Feb 13, 2021

Uh oh!

notmandatory commented Feb 13, 2021

Uh oh!

tcharding commented Feb 15, 2021

Uh oh!

notmandatory commented Feb 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

notmandatory commented Feb 11, 2021 •

edited

Loading

tcharding Feb 13, 2021 •

edited

Loading

tcharding Feb 13, 2021 •

edited

Loading