]> Untitled Git - bdk/commitdiff
doc(wallet): clarify docs for `Wallet::load`
authorvalued mammal <valuedmammal@protonmail.com>
Wed, 14 Aug 2024 02:14:28 +0000 (22:14 -0400)
committervalued mammal <valuedmammal@protonmail.com>
Wed, 14 Aug 2024 02:14:28 +0000 (22:14 -0400)
crates/wallet/src/wallet/mod.rs

index 11e547b29350b3e12b2233f36178bb7b574a568d..4303ad298b84bb3c9126fbeb474c11ee985adaee 100644 (file)
@@ -443,10 +443,11 @@ impl Wallet {
 
     /// Build [`Wallet`] by loading from persistence or [`ChangeSet`].
     ///
-    /// Note that the descriptor secret keys are not persisted to the db. You can either add
-    /// signers after-the-fact with [`Wallet::add_signer`] or [`Wallet::set_keymap`]. Or you can
-    /// add keys when building the wallet using [`LoadParams::keymap`] and/or
-    /// [`LoadParams::descriptor`].
+    /// Note that the descriptor secret keys are not persisted to the db. You can add
+    /// signers after-the-fact with [`Wallet::add_signer`] or [`Wallet::set_keymap`]. You
+    /// can also add keys when building the wallet by using [`LoadParams::keymap`]. Finally
+    /// you can check the wallet's descriptors are what you expect with [`LoadParams::descriptor`]
+    /// which will try to populate signers if [`LoadParams::extract_keys`] is enabled.
     ///
     /// # Synopsis
     ///