Merge #250: feat!: use NetworkKind

881df71 chore: rename `merge_network_kinds` to `intersect_network_kinds` (Luis Schwab)
fdb9d13 fix: GeneratableKey options for PrivateKey, Xpriv (valued mammal)
b1d384f feat!(examples,test): use `NetworkKind` (Luis Schwab)
944274a feat!(wallet): use `NetworkKind` (Luis Schwab)
c22aa13 feat!(keys): use `NetworkKind` (Luis Schwab)
ade83b4 feat!(descriptor): use `NetworkKind` (Luis Schwab)

Pull request description:

  ### 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:

  * [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 +nightly fmt` and `cargo clippy` before committing

  #### New Features:

  * [ ] I've added tests for the new feature
  * [X] I've added docs for the new feature

  #### Bugfixes:

  * [X] This pull request breaks the existing API
  * [ ] I've added tests to reproduce the issue which are now passing
  * [X] I'm linking the issue being fixed by this PR

ACKs for top commit:
  ValuedMammal:
    ACK 881df71
  oleonardolima:
    ACK 881df71

Tree-SHA512: 9da33233db1409764d75fd688c8343f01c624b359df389acbafbab818114b2ffb1d0f1a977ff60ff5f850b8d8de4b74827360a4740954c0d751ce5a60d1cc5af

Author: ValuedMammal

examples/mnemonic_to_descriptors.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2021 Bitcoin Dev Kit Developers
+// Copyright (c) 2020-2025 Bitcoin Dev Kit Developers
 //
 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
@@ -9,7 +9,7 @@
 use anyhow::anyhow;
 use bdk_wallet::bitcoin::bip32::DerivationPath;
 use bdk_wallet::bitcoin::secp256k1::Secp256k1;
-use bdk_wallet::bitcoin::Network;
+use bdk_wallet::bitcoin::NetworkKind;
 use bdk_wallet::descriptor;
 use bdk_wallet::descriptor::IntoWalletDescriptor;
 use bdk_wallet::keys::bip39::{Language, Mnemonic, WordCount};
@@ -18,32 +18,32 @@ use bdk_wallet::miniscript::Tap;
 use std::str::FromStr;
 
 /// This example demonstrates how to generate a mnemonic phrase
-/// using BDK and use that to generate a descriptor string.
+/// using BDK and use that mnemonic phrase to generate a descriptor string.
 #[allow(clippy::print_stdout)]
 fn main() -> Result<(), anyhow::Error> {
     let secp = Secp256k1::new();
 
-    // In this example we are generating a 12 words mnemonic phrase
+    // In this example we are generating a 12 word mnemonic phrase
     // but it is also possible generate 15, 18, 21 and 24 words
-    // using their respective `WordCount` variant.
+    // using the respective `WordCount` variant.
     let mnemonic: GeneratedKey<_, Tap> =
         Mnemonic::generate((WordCount::Words12, Language::English))
             .map_err(|_| anyhow!("Mnemonic generation error"))?;
 
     println!("Mnemonic phrase: {}", *mnemonic);
     let mnemonic_with_passphrase = (mnemonic, None);
 
-    // define external and internal derivation key path
+    // Define the external and internal derivation key path.
     let external_path = DerivationPath::from_str("m/86h/1h/0h/0").unwrap();
     let internal_path = DerivationPath::from_str("m/86h/1h/0h/1").unwrap();
 
-    // generate external and internal descriptor from mnemonic
+    // Generate external and internal descriptors from the mnemonic phrase.
     let (external_descriptor, ext_keymap) =
         descriptor!(tr((mnemonic_with_passphrase.clone(), external_path)))?
-            .into_wallet_descriptor(&secp, Network::Testnet)?;
+            .into_wallet_descriptor(&secp, NetworkKind::Test)?;
     let (internal_descriptor, int_keymap) =
         descriptor!(tr((mnemonic_with_passphrase, internal_path)))?
-            .into_wallet_descriptor(&secp, Network::Testnet)?;
+            .into_wallet_descriptor(&secp, NetworkKind::Test)?;
 
     println!("tpub external descriptor: {external_descriptor}");
     println!("tpub internal descriptor: {internal_descriptor}");

examples/policy.rs

@@ -1,7 +1,7 @@
 // Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
-// Copyright (c) 2020-2021 Bitcoin Dev Kit Developers
+// Copyright (c) 2020-2025 Bitcoin Dev Kit Developers
 //
 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
@@ -10,11 +10,12 @@
 // licenses.
 
 extern crate bdk_wallet;
+
 use std::error::Error;
 
-use bdk_wallet::bitcoin::Network;
 use bdk_wallet::descriptor::{policy::BuildSatisfaction, ExtractPolicy, IntoWalletDescriptor};
 use bdk_wallet::signer::SignersContainer;
+use bitcoin::NetworkKind;
 
 /// This example describes the use of the BDK's [`bdk_wallet::descriptor::policy`] module.
 ///
@@ -29,18 +30,17 @@ use bdk_wallet::signer::SignersContainer;
 fn main() -> Result<(), Box<dyn Error>> {
     let secp = bitcoin::secp256k1::Secp256k1::new();
 
-    // The descriptor used in the example
-    // The form is "wsh(multi(2, <privkey>, <pubkey>))"
+    // The descriptor used in the example. The form is "wsh(multi(2, <privkey>, <pubkey>))".
     let desc = "wsh(multi(2,tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcLNfjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/*,tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/1/*))";
 
     // Use the descriptor string to derive the full descriptor and a keymap.
     // The wallet descriptor can be used to create a new bdk_wallet::wallet.
     // While the `keymap` can be used to create a `SignerContainer`.
     //
     // The `SignerContainer` can sign for `PSBT`s.
-    // a `bdk_wallet::Wallet` internally uses these to handle transaction signing.
-    // But they can be used as independent tools also.
-    let (wallet_desc, keymap) = desc.into_wallet_descriptor(&secp, Network::Testnet)?;
+    // A `bdk_wallet::Wallet` internally uses these to handle transaction signing, but they can be
+    // used as independent tools as well.
+    let (wallet_desc, keymap) = desc.into_wallet_descriptor(&secp, NetworkKind::Test)?;
 
     println!("Example Descriptor for policy analysis : {wallet_desc}");