feat: allow creating wallets with specified directory

Author: sdmg15

testenv/src/lib.rs

@@ -161,6 +161,15 @@ impl TestEnv {
         Self::new_with_conf(Config::default())
     }
 
+    /// Generate a new temporary directory
+    /// Note: The caller is responsible of calling `.close()` on the returned tmp dir
+    /// else this will result in many created and undeleted temporary folders
+    pub fn get_tmp_dir(&self) -> anyhow::Result<TempDir> {
+        let mut dir = TempDir::new()?;
+        dir.disable_cleanup(true);
+        Ok(dir)
+    }
+
     /// Create a new test environment with ZMQ enabled on bitcoind.
     ///
     /// The ZMQ socket addresses are available via

wallet/src/bmp_wallet.rs

@@ -331,6 +331,11 @@ pub trait WalletApi {
     where
         Self: Sized;
 
+    /// Allow creating the wallet at the specified path
+    fn new_with_dir(path: &str, password: &str, network: Network) -> anyhow::Result<Self>
+    where
+        Self: Sized;
+
     fn load_wallet(network: Network, password: &str) -> anyhow::Result<Self>
     where
         Self: Sized;
@@ -642,6 +647,14 @@ impl WalletApi for BMPWallet<Connection> {
         })
     }
 
+    fn new_with_dir(path: &str, password: &str, network: Network) -> anyhow::Result<Self>
+    where
+        Self: Sized,
+    {
+        std::env::set_current_dir(path).unwrap();
+        Self::new(password, network)
+    }
+
     // For already created wallets this will load stored data
     // This will also load the imported keys
     fn load_wallet(network: Network, password: &str) -> anyhow::Result<Self> {
@@ -1152,4 +1165,28 @@ mod tests {
 
         Ok(())
     }
+
+    #[test]
+    fn test_wallet_with_path_creation() -> anyhow::Result<()> {
+        let _permit = SEMAPHORE.acquire();
+        let dir_one = TempDir::with_prefix("one-")?;
+        let dir_two = TempDir::with_prefix("two-")?;
+
+        let client = MockedBDKElectrum {};
+
+        tracing::debug!("Wallet path {:?}", dir_one);
+        tracing::debug!("Wallet 2 path {:?}", dir_two);
+
+        let mut w1 =
+            BMPWallet::new_with_dir(dir_one.path().to_str().unwrap(), "", Network::Regtest)?;
+        let w2 = BMPWallet::new_with_dir(dir_two.path().to_str().unwrap(), "", Network::Regtest)?;
+
+        tracing::debug!("Wallet one balance before syncing {}", w1.balance());
+        assert_eq!(w1.balance(), Amount::from_int_btc(0));
+        let _ = w1.sync_all(&client);
+
+        assert_eq!(w1.balance(), Amount::from_int_btc(1));
+        assert_eq!(w2.balance(), Amount::ZERO);
+        Ok(())
+    }
 }

wallet/tests/wallet_integration_test.rs

@@ -401,3 +401,43 @@ async fn test_drain_wallet_no_balance() {
         .drain_imported_balance(FeeRate::from_sat_per_vb(10).unwrap())
         .unwrap();
 }
+
+#[tokio::test]
+async fn test_multi_wallet_path() -> anyhow::Result<()> {
+    let env = TestEnv::new().unwrap();
+    env.mine_block().unwrap();
+
+    let client = env.bdk_electrum_client();
+
+    let dir_one = env.get_tmp_dir()?;
+    let dir_two = env.get_tmp_dir()?;
+
+    let mut w1 = BMPWallet::new_with_dir(dir_one.path().to_str().unwrap(), "", Network::Regtest)?;
+    let mut w2 = BMPWallet::new_with_dir(
+        dir_two.path().to_str().unwrap(),
+        "password",
+        Network::Regtest,
+    )?;
+
+    let amount_to_send_w1 = Amount::from_sat(100_000);
+    let amount_to_send_w2 = Amount::from_sat(80_000);
+
+    let addr_w1 = w1.next_unused_address(KeychainKind::External);
+    let addr_w2 = w2.next_unused_address(KeychainKind::External);
+
+    env.fund_address(&addr_w1, amount_to_send_w1)?;
+    env.fund_address(&addr_w2, amount_to_send_w2)?;
+
+    env.mine_block()?;
+
+    w1.sync_all(client)?;
+    w2.sync_all(client)?;
+
+    assert_eq!(w1.balance(), amount_to_send_w1);
+    assert_eq!(w2.balance(), amount_to_send_w2);
+
+    dir_one.close()?;
+    dir_two.close()?;
+
+    Ok(())
+}