feat: add api to create keyring with multiple desc

Author: 110CodingP

examples/multi_keychain_wallet.rs

@@ -1,3 +1,5 @@
+use std::collections::BTreeMap;
+
 use bdk_wallet::keyring::KeyRing;
 use bdk_wallet::Wallet;
 use bitcoin::Network;
@@ -58,12 +60,16 @@ fn main() {
         time_of_week_keychain: DayType::AnyDay,
     };
 
-    let mut keyring: KeyRing<KeychainId> =
-        KeyRing::new(Network::Signet, keychain_1, DESC_1).unwrap();
-    keyring.add_descriptor(keychain_2, DESC_2, false).unwrap();
-    keyring.add_descriptor(keychain_3, DESC_3, false).unwrap();
-    keyring.add_descriptor(keychain_4, DESC_4, false).unwrap();
-    keyring.add_descriptor(keychain_5, DESC_5, false).unwrap();
+    let descriptors: BTreeMap<KeychainId, &str> = [
+        (keychain_1, DESC_1),
+        (keychain_2, DESC_2),
+        (keychain_3, DESC_3),
+        (keychain_4, DESC_4),
+        (keychain_5, DESC_5),
+    ]
+    .into();
+
+    let keyring = KeyRing::new_with_descriptors(Network::Signet, descriptors, None).unwrap();
 
     // DESC_1 is the default keychain (the first one added to the keyring is automatically the
     // default keychain), but this can also be changed later on with the

src/keyring/mod.rs

@@ -66,6 +66,44 @@ where
         })
     }
 
+    /// Construct a new [`KeyRing`] with the provided `network` and a <Keychain, Descriptor> map and
+    /// the `default_keychain`.
+    ///
+    /// Specifying `default_keychain` as `None` will assign the first keychain according to the
+    /// `Ord` implementation as the default.
+    ///
+    /// Uses [`KeyRing::new`] and [`KeyRing::add_descriptor`] underneath.
+    pub fn new_with_descriptors<D: IntoWalletDescriptor>(
+        network: Network,
+        descriptors: BTreeMap<K, D>,
+        default_keychain: Option<K>,
+    ) -> Result<Self, DescriptorError> {
+        // ToDo: maybe we can use something more generic than a map?
+        // ToDo: handle error
+        if descriptors.is_empty() {
+            panic!()
+        };
+
+        let mut desc_iter = descriptors.into_iter();
+        let (keychain, desc) = desc_iter.next().expect("descriptors is non-empty");
+        let mut keyring = KeyRing::new(network, keychain.clone(), desc)?;
+
+        let curr_default = match default_keychain {
+            Some(curr_default) => curr_default,
+            None => keychain,
+        };
+
+        for (keychain, desc) in desc_iter {
+            let mut default = false;
+            if curr_default == keychain {
+                default = true;
+            }
+            keyring.add_descriptor(keychain, desc, default)?;
+        }
+
+        Ok(keyring)
+    }
+
     /// Get the [`Network`] corresponding to the [`KeyRing`]
     pub fn network(&self) -> &Network {
         &self.network

tests/keyring.rs

@@ -1,3 +1,5 @@
+use std::collections::BTreeMap;
+
 use bdk_wallet::chain::DescriptorExt;
 use bdk_wallet::descriptor::DescriptorError;
 use bdk_wallet::keyring::{self, KeyRing};
@@ -38,14 +40,19 @@ fn test_8_keychains_keyring() {
     const DESC_7: &str = "tr(tprv8ZgxMBicQKsPdWAHbugK2tjtVtRjKGixYVZUdL7xLHMgXZS6BFbFi1UDb1CHT25Z5PU1F9j7wGxwUiRhqz9E3nZRztikGUV6HoRDYcqPhM4/86'/1'/0'/6/*)";
     const DESC_8: &str = "tr(tprv8ZgxMBicQKsPdWAHbugK2tjtVtRjKGixYVZUdL7xLHMgXZS6BFbFi1UDb1CHT25Z5PU1F9j7wGxwUiRhqz9E3nZRztikGUV6HoRDYcqPhM4/86'/1'/0'/7/*)";
 
-    let mut keyring = KeyRing::new(Network::Regtest, 1, DESC_1).unwrap();
-    keyring.add_descriptor(2, DESC_2, false).unwrap();
-    keyring.add_descriptor(3, DESC_3, false).unwrap();
-    keyring.add_descriptor(4, DESC_4, false).unwrap();
-    keyring.add_descriptor(5, DESC_5, false).unwrap();
-    keyring.add_descriptor(6, DESC_6, false).unwrap();
-    keyring.add_descriptor(7, DESC_7, false).unwrap();
-    keyring.add_descriptor(8, DESC_8, false).unwrap();
+    let descriptors: BTreeMap<u8, &str> = [
+        (1, DESC_1),
+        (2, DESC_2),
+        (3, DESC_3),
+        (4, DESC_4),
+        (5, DESC_5),
+        (6, DESC_6),
+        (7, DESC_7),
+        (8, DESC_8),
+    ]
+    .into();
+
+    let keyring = KeyRing::new_with_descriptors(Network::Regtest, descriptors, Some(1)).unwrap();
 
     assert_eq!(keyring.default_keychain(), 1);
     assert_eq!(keyring.list_keychains().len(), 8);