Skip to content

Commit

Permalink
doc(wallet): clarify docs for Wallet::load
Browse files Browse the repository at this point in the history
  • Loading branch information
ValuedMammal committed Aug 14, 2024
1 parent 3951110 commit 13e7008
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions crates/wallet/src/wallet/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit 13e7008

Please sign in to comment.