temp 6: clean up constructors

Author: thunderbiscuit

examples/example_n_keychains/src/main.rs

@@ -27,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).create_wallet_no_persist()?;
+    let mut wallet: Wallet = Wallet::create(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

@@ -22,7 +22,7 @@ fn main() -> Result<(), anyhow::Error> {
     println!("{:?}", keychain_ids);
 
     // Create the wallet and peek addresses on each of the descriptors
-    let wallet: Wallet = Wallet::new(keyring).create_wallet_no_persist()?;
+    let mut wallet: Wallet = Wallet::create(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/src/wallet/mod.rs

@@ -288,58 +288,6 @@ impl std::error::Error for ApplyBlockError {}
 pub type WalletTx<'a> = CanonicalTx<'a, Arc<Transaction>, ConfirmationBlockTime>;
 
 impl Wallet {
-    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`].
-    ///
-    /// If you have previously created a wallet, use [`load`](Self::load) instead.
-    ///
-    /// # Note
-    ///
-    /// Only use this method when creating a wallet designed to be used with a single
-    /// descriptor and keychain. Otherwise the recommended way to construct a new wallet is
-    /// by using [`Wallet::create`]. It's worth noting that not all features are available
-    /// with single descriptor wallets, for example setting a [`change_policy`] on [`TxBuilder`]
-    /// and related methods such as [`do_not_spend_change`]. This is because all payments are
-    /// received on the external keychain (including change), and without a change keychain
-    /// BDK lacks enough information to distinguish between change and outside payments.
-    ///
-    /// Additionally because this wallet has no internal (change) keychain, all methods that
-    /// require a [`KeychainKind`] as input, e.g. [`reveal_next_address`] should only be called
-    /// using the [`External`] variant. In most cases passing [`Internal`] is treated as the
-    /// equivalent of [`External`] but this behavior must not be relied on.
-    ///
-    /// # Example
-    ///
-    /// ```rust
-    /// # use bdk_wallet::Wallet;
-    /// # use bitcoin::Network;
-    /// # const EXTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/0/*)";
-    /// # let temp_dir = tempfile::tempdir().expect("must create tempdir");
-    /// # let file_path = temp_dir.path().join("store.db");
-    /// // Create a wallet that is persisted to SQLite database.
-    /// use bdk_wallet::rusqlite::Connection;
-    /// let mut conn = Connection::open(file_path)?;
-    /// let wallet = Wallet::create_single(EXTERNAL_DESC)
-    ///     .network(Network::Testnet)
-    ///     .create_wallet(&mut conn)?;
-    /// # Ok::<_, anyhow::Error>(())
-    /// ```
-    /// [`change_policy`]: TxBuilder::change_policy
-    /// [`do_not_spend_change`]: TxBuilder::do_not_spend_change
-    /// [`External`]: KeychainKind::External
-    /// [`Internal`]: KeychainKind::Internal
-    /// [`reveal_next_address`]: Self::reveal_next_address
-    // pub fn create_single<D>(descriptor: D) -> CreateParams
-    // where
-    //     D: IntoWalletDescriptor + Send + Clone + 'static,
-    // {
-    //     CreateParams::new_single(descriptor)
-    // }
-
     /// Build a new [`Wallet`].
     ///
     /// If you have previously created a wallet, use [`load`](Self::load) instead.
@@ -348,33 +296,30 @@ impl Wallet {
     ///
     /// ```rust
     /// # use bdk_wallet::Wallet;
+    /// # use bdk_wallet::keyring::KeyRing;
     /// # use bitcoin::Network;
     /// # fn main() -> anyhow::Result<()> {
-    /// # const EXTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/0/*)";
-    /// # const INTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/1/*)";
+    /// # const MY_DESCRIPTOR: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/0/*)";
+    /// // Create a KeyRing
+    /// let mut key_ring = KeyRing::new(MY_DESCRIPTOR, Network::Signet);
     /// // Create a non-persisted wallet.
-    /// let wallet = Wallet::create(EXTERNAL_DESC, INTERNAL_DESC)
-    ///     .network(Network::Testnet)
+    /// let wallet = Wallet::create(key_ring)
     ///     .create_wallet_no_persist()?;
     ///
     /// // Create a wallet that is persisted to SQLite database.
     /// # let temp_dir = tempfile::tempdir().expect("must create tempdir");
     /// # let file_path = temp_dir.path().join("store.db");
     /// use bdk_wallet::rusqlite::Connection;
     /// let mut conn = Connection::open(file_path)?;
-    /// let wallet = Wallet::create(EXTERNAL_DESC, INTERNAL_DESC)
-    ///     .network(Network::Testnet)
+    /// let wallet = Wallet::create(key_ring)
     ///     .create_wallet(&mut conn)?;
     /// # Ok(())
     /// # }
     /// ```
-    // pub fn create<D>(descriptor: D, change_descriptor: D) -> CreateParams
-    // where
-    //     D: IntoWalletDescriptor + Send + Clone + 'static,
-    // {
-    //     CreateParams::new(descriptor, change_descriptor)
-    // }
-    //
+    pub fn create(key_ring: KeyRing) -> CreateParams {
+        CreateParams::new(key_ring)
+    }
+
     // /// Create a new [`Wallet`] with given `params`.
     // ///
     // /// Refer to [`Wallet::create`] for more.

wallet/src/wallet/params.rs

@@ -34,53 +34,16 @@ pub struct CreateParams {
 }
 
 impl CreateParams {
-    /// Construct parameters with provided `descriptor`.
+    /// Construct parameters with provided `KeyRing`.
     ///
     /// Default values:
-    /// * `change_descriptor` = `None`
-    /// * `network` = [`Network::Bitcoin`]
+    /// * `network` = Provided by your KeyRing
     /// * `genesis_hash` = `None`
     /// * `lookahead` = [`DEFAULT_LOOKAHEAD`]
-    ///
-    /// Use this method only when building a wallet with a single descriptor. See
-    /// also [`Wallet::create_single`].
-    // pub fn new_single<D: IntoWalletDescriptor + Send + 'static>(descriptor: D) -> Self {
-    //     Self {
-    //         descriptor: make_descriptor_to_extract(descriptor),
-    //         descriptor_keymap: KeyMap::default(),
-    //         change_descriptor: None,
-    //         change_descriptor_keymap: KeyMap::default(),
-    //         network: Network::Bitcoin,
-    //         genesis_hash: None,
-    //         lookahead: DEFAULT_LOOKAHEAD,
-    //     }
-    // }
-
-    /// Construct parameters with provided `descriptor` and `change_descriptor`.
-    ///
-    /// Default values:
-    /// * `network` = [`Network::Bitcoin`]
-    /// * `genesis_hash` = `None`
-    /// * `lookahead` = [`DEFAULT_LOOKAHEAD`]
-    // pub fn new<D: IntoWalletDescriptor + Send + 'static>(
-    //     descriptor: D,
-    //     change_descriptor: D,
-    // ) -> Self {
-    //     Self {
-    //         descriptor: make_descriptor_to_extract(descriptor),
-    //         descriptor_keymap: KeyMap::default(),
-    //         change_descriptor: Some(make_descriptor_to_extract(change_descriptor)),
-    //         change_descriptor_keymap: KeyMap::default(),
-    //         network: Network::Bitcoin,
-    //         genesis_hash: None,
-    //         lookahead: DEFAULT_LOOKAHEAD,
-    //     }
-    // }
-
-    pub fn new_with_keyring(
+    pub fn new(
         key_ring: KeyRing,
-        network: Network,
     ) -> Self {
+        let network = key_ring.network();
         Self {
             key_ring,
             network,