deprecate(wallet): phase out wallet-as-keystore

Author: noahjoeris

src/wallet/export.rs

@@ -249,6 +249,11 @@ impl FullyNodedExport {
     }
 
     /// Export a wallet to FullyNoded format using keys stored in the wallet.
+    #[deprecated(
+        since = "3.2.0",
+        note = "pass external and internal KeyMaps explicitly; use FullyNodedExport::export_wallet_with_keymaps instead."
+    )]
+    #[allow(deprecated)]
     pub fn export_wallet(
         wallet: &Wallet,
         label: &str,

src/wallet/mod.rs

@@ -1122,6 +1122,10 @@ impl Wallet {
     /// Add an external signer
     ///
     /// See [the `signer` module](signer) for an example.
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn add_signer(
         &mut self,
         keychain: KeychainKind,
@@ -1140,6 +1144,10 @@ impl Wallet {
     ///
     /// Note this does nothing if the given keychain has no descriptor because we won't
     /// know the context (segwit, taproot, etc) in which to create signatures.
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn set_keymap(&mut self, keychain: KeychainKind, keymap: KeyMap) {
         let wallet_signers = match keychain {
             KeychainKind::External => Arc::make_mut(&mut self.signers),
@@ -1151,6 +1159,11 @@ impl Wallet {
     }
 
     /// Set the keymap for each keychain.
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
+    #[allow(deprecated)]
     pub fn set_keymaps(&mut self, keymaps: impl IntoIterator<Item = (KeychainKind, KeyMap)>) {
         for (keychain, keymap) in keymaps {
             self.set_keymap(keychain, keymap);
@@ -1169,13 +1182,18 @@ impl Wallet {
     /// let wallet = Wallet::create(descriptor, change_descriptor)
     ///     .network(Network::Testnet)
     ///     .create_wallet_no_persist()?;
+    /// #[allow(deprecated)]
     /// for secret_key in wallet.get_signers(KeychainKind::External).signers().iter().filter_map(|s| s.descriptor_secret_key()) {
     ///     // secret_key: tprv8ZgxMBicQKsPe73PBRSmNbTfbcsZnwWhz5eVmhHpi31HW29Z7mc9B4cWGRQzopNUzZUT391DeDJxL2PefNunWyLgqCKRMDkU1s2s8bAfoSk/84'/0'/0'/0/*
     ///     println!("secret_key: {}", secret_key);
     /// }
     ///
     /// Ok::<(), Box<dyn core::error::Error>>(())
     /// ```
+    #[deprecated(
+        since = "3.2.0",
+        note = "the Wallet is being phased out as a key store; keep your own KeyMap or Xpriv instead. During the transition you can still pass the returned SignersContainer to Wallet::sign_with_signers (issue #70)."
+    )]
     pub fn get_signers(&self, keychain: KeychainKind) -> Arc<SignersContainer> {
         match keychain {
             KeychainKind::External => Arc::clone(&self.signers),
@@ -1747,10 +1765,15 @@ impl Wallet {
     ///     builder.add_recipient(to_address.script_pubkey(), Amount::from_sat(50_000));
     ///     builder.finish()?
     /// };
+    /// #[allow(deprecated)]
     /// let finalized = wallet.sign(&mut psbt, SignOptions::default())?;
     /// assert!(finalized, "we should have signed all the inputs");
     /// # Ok::<(),anyhow::Error>(())
     /// ```
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn sign(&self, psbt: &mut Psbt, sign_options: SignOptions) -> Result<bool, SignerError> {
         self.sign_with_signers(
             psbt,
@@ -3217,6 +3240,7 @@ mod test {
     }
 
     #[test]
+    #[allow(deprecated)] // get_signers is deprecated by this PR; still used here to verify get_keymap
     fn test_get_keymap() {
         use crate::test_utils::get_test_wpkh_and_change_desc;
         let (external_desc, internal_desc) = get_test_wpkh_and_change_desc();

src/wallet/params.rs

@@ -141,6 +141,10 @@ impl CreateParams {
     }
 
     /// Extend the given `keychain`'s `keymap`.
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn keymap(mut self, keychain: KeychainKind, keymap: KeyMap) -> Self {
         match keychain {
             KeychainKind::External => &mut self.descriptor_keymap,
@@ -243,6 +247,10 @@ impl LoadParams {
     }
 
     /// Extend the given `keychain`'s `keymap`.
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn keymap(mut self, keychain: KeychainKind, keymap: KeyMap) -> Self {
         match keychain {
             KeychainKind::External => &mut self.descriptor_keymap,
@@ -307,6 +315,10 @@ impl LoadParams {
 
     /// Whether to try extracting private keys from the *provided descriptors* upon loading.
     /// See also [`LoadParams::descriptor`].
+    #[deprecated(
+        since = "3.2.0",
+        note = "use your KeyMap or Xpriv and sign with Wallet::sign_psbt for software signing, or use your own signer for hardware signing. Wallet::sign_with_signers lets you keep using a SignersContainer while the signer module is phased out (issue #70)."
+    )]
     pub fn extract_keys(mut self) -> Self {
         self.extract_keys = true;
         self

tests/persisted_wallet.rs

@@ -230,6 +230,7 @@ fn wallet_is_persisted() -> anyhow::Result<()> {
 }
 
 #[test]
+#[allow(deprecated)]
 fn wallet_load_checks() -> anyhow::Result<()> {
     fn run<Db, CreateDb, OpenDb>(
         filename: &str,