Skip to content

feat!: use NetworkKind#250

Merged
ValuedMammal merged 6 commits intobitcoindevkit:masterfrom
luisschwab:feat/networkkind
Oct 27, 2025
Merged

feat!: use NetworkKind#250
ValuedMammal merged 6 commits intobitcoindevkit:masterfrom
luisschwab:feat/networkkind

Conversation

@luisschwab
Copy link
Copy Markdown
Member

@luisschwab luisschwab commented Jun 1, 2025 •
edited
Loading

Description

Closes #22.
Closes #94.

This PR replaces bitcoin::Network for bitcoin::NetworkKind where it applies.

I also took the liberty of fixing up and adding comments on the files I touched.

Changelog

  • wallet_name_from_descriptor() takes NetworkKind instead of Network.
  • DescriptorToExtract takes NetworkKind instead of Network.
  • impl IntoWalletDescriptor for <T> takes Network instead NetworkKind.
  • DescriptorTemplate::build() takes NetworkKind instead of Network.
  • ExtendedKey::into_xprv() takes NetworkKind instead of Network.
  • ExtendedKey::into_xpub() takes NetworkKind instead of Network.
  • DerivableKey::into_extended_key() examples updated to use NetworkKind instead of Network.
  • any_network() renamed to any_network_kind().
  • mainnet_network() renamed to mainnet_network_kind().
  • test_networks() renamed to test_network_kind().
  • merge_networks() renamed to intersect_network_kinds().
  • ValidNetworks type alias renamed to ValidNetworkKinds.
  • GeneratedKey::new() takes ValidNetworkKinds instead of ValidNetworks.
  • DescriptorKey::from_public() takes ValidNetworkKinds instead of ValidNetworks.
  • DescriptorKey::from_secret() takes ValidNetworkKinds instead of ValidNetworks.
  • KeyError::InvalidNetwork renamed to KeyError::InvalidNetworkKind.
  • DescriptorKey::override_valid_networks() renamed to override_valid_network_kinds().
  • Network validation logic updated to use NetworkKind instead of Network.
  • Test network validation now uses NetworkKind::Test instead of Network::{Regtest, Signet, Testnet, Testnet4}.
  • Examples and comments updated to use NetworkKind instead of Network.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo +nightly 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

@coveralls
Copy link
Copy Markdown

coveralls commented Jun 1, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 18730536494

Details

  • 372 of 403 (92.31%) changed or added relevant lines in 9 files are covered.
  • 4 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.2%) to 84.995%
Changes Missing Coverage Covered Lines Changed/Added Lines %
src/keys/bip39.rs 13 14 92.86%
src/descriptor/dsl.rs 38 40 95.0%
src/wallet/mod.rs 10 13 76.92%
src/descriptor/template.rs 119 123 96.75%
src/descriptor/policy.rs 15 21 71.43%
src/descriptor/mod.rs 48 55 87.27%
src/keys/mod.rs 127 135 94.07%
Files with Coverage Reduction New Missed Lines %
src/descriptor/template.rs 4 97.46%
Totals Coverage Status
Change from base Build 18318022693: 0.2%
Covered Lines: 7001
Relevant Lines: 8237
💛 - Coveralls

@luisschwab luisschwab force-pushed the feat/networkkind branch 2 times, most recently from 22d27a6 to e6e6266 Compare June 1, 2025 17:41
@luisschwab luisschwab self-assigned this Jun 1, 2025
@luisschwab luisschwab added the api A breaking API change label Jun 1, 2025
@luisschwab luisschwab moved this to Needs Review in BDK Wallet Jun 1, 2025
@luisschwab luisschwab modified the milestones: Wallet 3.1.0, Wallet 3.0.0 Jun 1, 2025
@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Sep 20, 2025 •
edited
Loading

Concept ACK. To consider this work complete I think we should also strive for a fix to #22. Edit: This is a proposed solution 277ae25. Also I think GeneratedKey should hold the NetworkKind internally (instead of ValidNetworkKinds).

@luisschwab luisschwab added the bug Something isn't working label Sep 24, 2025
ValuedMammal
ValuedMammal reviewed Sep 24, 2025
View reviewed changes
@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Sep 24, 2025

You certainly did take some liberties with the code, definitely an improvement overall. In the future it would be nice to make a separate patch for things like documentation and code comments.

@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Sep 25, 2025

ACK 3ee3ae2

@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Sep 29, 2025

Will need a rebase. Sorry for the inconvenience.

oleonardolima
oleonardolima reviewed Sep 30, 2025
View reviewed changes
@thunderbiscuit
Copy link
Copy Markdown
Member

thunderbiscuit commented Sep 30, 2025

I have just a quick feedback that might help you in further PRs @luisschwab. Last week I saw your message on Discord looking for review on this, and I decided to take a look. In the end the diffs are really big because it's so much docs changes all mixed up with code changes, and I didn't have enough time before my day was over.

My advice for further work would be to separate docs and code changes in different commits (I don't actually mind that they are in the same PR, and I know that sometimes we're in a given part of the codebase and it makes sense to fix docs while we're there and thinking about it). I actually like these little ongoing fixes/polish of the docs. But when the diff is big, I review one commit at a time, and that makes it much easier if the two ideas are separate.

@luisschwab
Copy link
Copy Markdown
Member Author

luisschwab commented Sep 30, 2025

Yeah, Mammal mentioned that as well. This PR is pretty old, but I'll keep that in mind for the future.

@luisschwab luisschwab force-pushed the feat/networkkind branch 2 times, most recently from 24da1b6 to 554bb75 Compare October 8, 2025 00:23
@luisschwab luisschwab mentioned this pull request Oct 8, 2025
Closed
3 tasks
luisschwab and others added 6 commits October 22, 2025 16:32
@luisschwab
feat!(descriptor): use NetworkKind
ade83b4
@luisschwab
feat!(keys): use NetworkKind
c22aa13
@luisschwab
feat!(wallet): use NetworkKind
944274a
@luisschwab
feat!(examples,test): use NetworkKind
b1d384f
@ValuedMammal @luisschwab
fix: GeneratableKey options for PrivateKey, Xpriv
fdb9d13 
..to require the NetworkKind when generating the key. This fixes
an issue where keys generated for mainnet were incorrectly marked
valid for any network.

test(keys): Add `test_xpriv_generate_options`

fixes bitcoindevkit#22
@luisschwab @cooparo
chore: rename merge_network_kinds to intersect_network_kinds
881df71 
Co-authored-by: cooparo <github.ambitious226@slmails.com>
oleonardolima
oleonardolima approved these changes Oct 22, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 881df71

@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Oct 27, 2025

ACK 881df71

@ValuedMammal ValuedMammal merged commit e7d9d44 into bitcoindevkit:master Oct 27, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Wallet Oct 27, 2025
@luisschwab luisschwab deleted the feat/networkkind branch October 27, 2025 18:28
@ValuedMammal ValuedMammal mentioned this pull request Mar 4, 2026
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oleonardolima oleonardolima oleonardolima approved these changes

@ValuedMammal ValuedMammal Awaiting requested review from ValuedMammal ValuedMammal is a code owner

Assignees

@luisschwab luisschwab

Labels

api A breaking API change bug Something isn't working

Projects

BDK Wallet
Archived in project

Milestone

Wallet 3.0.0

Development

Successfully merging this pull request may close these issues.

feat: use new NetworkKind throughout the BDK codebase A bug for generating testnet descriptor?

5 participants

@luisschwab @coveralls @ValuedMammal @thunderbiscuit @oleonardolima