temp 5: remove private keys from KeyRing

Author: thunderbiscuit

examples/example_n_keychains/src/main.rs

@@ -1,8 +1,9 @@
 use bdk_esplora::{esplora_client, EsploraExt};
 use bdk_wallet::chain::DescriptorId;
-use bdk_wallet::{KeyRing, Wallet};
+use bdk_wallet::Wallet;
 use bdk_wallet::bitcoin::Network;
 use bdk_wallet::KeychainKind;
+use bdk_wallet::keyring::KeyRing;
 
 const ESPLORA_URL: &str = "http://signet.bitcoindevkit.net";
 const STOP_GAP: usize = 5;
@@ -26,7 +27,7 @@ fn main() -> Result<(), anyhow::Error> {
     println!("{:?}", keychain_ids);
 
     // Create the wallet and peek addresses on each of the descriptors
-    let mut wallet: Wallet = Wallet::new(keyring, Network::Signet).create_wallet_no_persist()?;
+    let mut wallet: Wallet = Wallet::new(keyring).create_wallet_no_persist()?;
     let address_1 = wallet.peek_address(KeychainKind::Default, 0).unwrap();
     let address_2 = wallet.peek_address(KeychainKind::Other(keychain_ids[1]), 0).unwrap();
     let address_3 = wallet.peek_address(KeychainKind::Other(keychain_ids[2]), 0).unwrap();

wallet/examples/n_keychains.rs

@@ -1,7 +1,8 @@
 use bdk_chain::DescriptorId;
-use bdk_wallet::{KeyRing, Wallet};
+use bdk_wallet::Wallet;
 use bdk_wallet::bitcoin::Network;
 use bdk_wallet::KeychainKind;
+use bdk_wallet::keyring::KeyRing;
 
 const EXTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/0/*)";
 const OTHER_DESC_21: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/21/*)";
@@ -10,7 +11,7 @@ const OTHER_DESC_41: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7
 
 fn main() -> Result<(), anyhow::Error> {
     // Create a keyring with a single, default descriptor (aka the KeychainKind::External from the 1.2.0 API)
-    let mut keyring = KeyRing::new(EXTERNAL_DESC, Network::Testnet4);
+    let mut keyring = KeyRing::new(EXTERNAL_DESC, Network::Testnet);
 
     // Add 3 new custom descriptors
     keyring.add_other_descriptor(OTHER_DESC_21);
@@ -37,6 +38,5 @@ fn main() -> Result<(), anyhow::Error> {
 
     let full_scan_request = wallet.start_full_scan().build();
 
-
     Ok(())
 }

wallet/src/wallet/keyring.rs

@@ -13,7 +13,6 @@ use std::prelude::rust_2021::Vec;
 use bitcoin::Network;
 use chain::{DescriptorExt, DescriptorId};
 use miniscript::{Descriptor, DescriptorPublicKey};
-use miniscript::descriptor::KeyMap;
 use crate::descriptor::IntoWalletDescriptor;
 use crate::{DescriptorToExtract, KeychainKind};
 use crate::wallet::make_descriptor_to_extract;
@@ -22,7 +21,7 @@ use crate::wallet::utils::SecpCtx;
 /// A `WalletKeychain` is mostly a descriptor with metadata associated with it. It states whether the
 /// keychain is the default keychain for the wallet, and provides an identifier for it which can be
 /// used for retrieval.
-pub type WalletKeychain = (KeychainKind, (Descriptor<DescriptorPublicKey>, KeyMap));
+pub type WalletKeychain = (KeychainKind, Descriptor<DescriptorPublicKey>);
 
 #[derive(Debug, Clone)]
 pub struct KeyRing {
@@ -37,8 +36,8 @@ impl KeyRing {
     ) -> Self {
         let secp = SecpCtx::new();
         let descriptor_to_extract: DescriptorToExtract = make_descriptor_to_extract(default_descriptor);
-        let public_descriptor: (Descriptor<DescriptorPublicKey>, KeyMap) = descriptor_to_extract(&secp, network).unwrap();
-        let wallet_keychain = (KeychainKind::Default, public_descriptor);
+        let public_descriptor: (Descriptor<DescriptorPublicKey>, _) = descriptor_to_extract(&secp, network).unwrap();
+        let wallet_keychain = (KeychainKind::Default, public_descriptor.0);
 
         KeyRing {
             keychains: vec![wallet_keychain],
@@ -64,7 +63,7 @@ impl KeyRing {
         let public_descriptor = descriptor_to_extract(&secp, self.network).unwrap();
         let descriptor_id = public_descriptor.0.descriptor_id();
 
-        let wallet_keychain = ((KeychainKind::Other(descriptor_id)), public_descriptor);
+        let wallet_keychain = ((KeychainKind::Other(descriptor_id)), public_descriptor.0);
 
         self.keychains.push(wallet_keychain);
         self
@@ -79,9 +78,13 @@ impl KeyRing {
             .iter()
             .map(|keychain| match keychain.0 {
                 KeychainKind::Other(descriptor_id) => descriptor_id,
-                KeychainKind::Default => keychain.1.0.descriptor_id(),
-                KeychainKind::Change => keychain.1.0.descriptor_id(),
+                KeychainKind::Default => keychain.1.descriptor_id(),
+                KeychainKind::Change => keychain.1.descriptor_id(),
             })
             .collect()
     }
+
+    pub fn network(&self) -> Network {
+        self.network
+    }
 }

wallet/src/wallet/mod.rs

@@ -59,7 +59,7 @@ mod persisted;
 pub mod signer;
 pub mod tx_builder;
 pub(crate) mod utils;
-mod keyring;
+pub mod keyring;
 
 use crate::collections::{BTreeMap, HashMap, HashSet};
 use crate::descriptor::{
@@ -86,7 +86,7 @@ pub use persisted::*;
 pub use utils::IsDust;
 use crate::error::KeychainNotInKeyRingError;
 use crate::error::KeychainNotInKeyRingError::KeychainNotFound;
-use crate::wallet::keyring::KeyRing;
+use crate::keyring::KeyRing;
 
 /// A Bitcoin wallet
 ///
@@ -114,7 +114,7 @@ pub struct Wallet {
     stage: ChangeSet,
     network: Network,
     secp: SecpCtx,
-    keychain_set: KeyRing
+    key_ring: KeyRing
 }
 
 /// An update to [`Wallet`].
@@ -288,8 +288,9 @@ impl std::error::Error for ApplyBlockError {}
 pub type WalletTx<'a> = CanonicalTx<'a, Arc<Transaction>, ConfirmationBlockTime>;
 
 impl Wallet {
-    pub fn new(keychain_set: KeyRing, network: Network) -> CreateParams {
-        CreateParams::new_with_keychain_set(keychain_set, network)
+    pub fn new(key_ring: KeyRing) -> CreateParams {
+        let network = key_ring.network();
+        CreateParams::new_with_keyring(key_ring, network)
     }
 
     /// Build a new single descriptor [`Wallet`].
@@ -387,15 +388,16 @@ impl Wallet {
 
         // let (descriptor, mut descriptor_keymap) = (params.descriptor)(&secp, network)?;
         // let (descriptor, mut descriptor_keymap) = (params.keychain_set.get_default_keychain().1.0)(&secp, network)?;
-        let (descriptor, mut descriptor_keymap) = params.keychain_set.get_default_keychain().1;
+        let descriptor = params.key_ring.get_default_keychain().1;
         check_wallet_descriptor(&descriptor)?;
-        descriptor_keymap.extend(descriptor_keymap.clone());
+        // descriptor_keymap.extend(descriptor_keymap.clone());
 
-        let signers = Arc::new(SignersContainer::build(
-            descriptor_keymap,
-            &descriptor,
-            &secp,
-        ));
+        let signers = Arc::new(SignersContainer::new());
+        // let signers = Arc::new(SignersContainer::build(
+        //     descriptor_keymap,
+        //     &descriptor,
+        //     &secp,
+        // ));
 
         // TODO: Handle change
         let (change_descriptor, change_signers) = (None, Arc::new(SignersContainer::new()));
@@ -414,11 +416,11 @@ impl Wallet {
             // None => (None, Arc::new(SignersContainer::new())),
         // };
 
-        let index = create_indexer(params.keychain_set.clone(), params.lookahead)?;
+        let index = create_indexer(params.key_ring.clone(), params.lookahead)?;
 
         // TODO: Understand why we have the descriptors above but then request them from the indexer
         //       here. Is it just for sanity check?
-        let descriptor = index.get_descriptor(params.keychain_set.get_default_keychain().0).cloned();
+        let descriptor = index.get_descriptor(params.key_ring.get_default_keychain().0).cloned();
         // TODO: Doesn't work because get_change_keychain() returns an Option
         // let change_descriptor = index.get_descriptor(params.keychain_set.get_change_keychain().0).cloned();
         let indexed_graph = IndexedTxGraph::new(index);
@@ -441,7 +443,7 @@ impl Wallet {
             indexed_graph,
             stage,
             secp,
-            keychain_set: params.keychain_set,
+            key_ring: params.key_ring,
         })
     }
 
@@ -2563,7 +2565,7 @@ fn create_indexer(
 
     // TODO: I'm here, May 2
     keyring.list_keychains().iter().for_each(|k| {
-        indexer.insert_descriptor(k.0, k.1.0.clone()).expect("This should work");
+        indexer.insert_descriptor(k.0, k.1.clone()).expect("This should work");
         dbg!("Inserting descriptor into indexer");
     });
 

wallet/src/wallet/params.rs

@@ -3,7 +3,7 @@ use bdk_chain::keychain_txout::DEFAULT_LOOKAHEAD;
 use bitcoin::{BlockHash, Network};
 use miniscript::descriptor::KeyMap;
 
-use crate::{descriptor::{DescriptorError, ExtendedDescriptor, IntoWalletDescriptor}, utils::SecpCtx, AsyncWalletPersister, CreateWithPersistError, KeyRing, LoadWithPersistError, Wallet, WalletPersister};
+use crate::{descriptor::{DescriptorError, ExtendedDescriptor, IntoWalletDescriptor}, utils::SecpCtx, AsyncWalletPersister, CreateWithPersistError, wallet::keyring::KeyRing, LoadWithPersistError, Wallet, WalletPersister};
 
 use super::{ChangeSet, LoadError, PersistedWallet};
 
@@ -27,11 +27,7 @@ where
 /// Parameters for [`Wallet::create`] or [`PersistedWallet::create`].
 #[must_use]
 pub struct CreateParams {
-    pub(crate) keychain_set: KeyRing,
-    // pub(crate) descriptor: DescriptorToExtract,
-    // pub(crate) descriptor_keymap: KeyMap,
-    // pub(crate) change_descriptor: Option<DescriptorToExtract>,
-    // pub(crate) change_descriptor_keymap: KeyMap,
+    pub(crate) key_ring: KeyRing,
     pub(crate) network: Network,
     pub(crate) genesis_hash: Option<BlockHash>,
     pub(crate) lookahead: u32,
@@ -81,12 +77,12 @@ impl CreateParams {
     //     }
     // }
 
-    pub fn new_with_keychain_set(
-        keychain_set: KeyRing,
+    pub fn new_with_keyring(
+        key_ring: KeyRing,
         network: Network,
     ) -> Self {
         Self {
-            keychain_set,
+            key_ring,
             network,
             genesis_hash: None,
             lookahead: DEFAULT_LOOKAHEAD,