Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(wallet): Add docs to explain the lookahead #1596

Merged
merged 1 commit into from
Sep 16, 2024
Merged

doc(wallet): Add docs to explain the lookahead #1596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions crates/wallet/src/wallet/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ impl Wallet {
/// 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 can lead to confusing results.
/// equivalent of [`External`] but this behavior must not be relied on.
///
/// # Example
///
Expand Down Expand Up @@ -1070,8 +1070,6 @@ impl Wallet {
/// **WARNING**: You must persist the changes resulting from one or more calls to this method
/// if you need the inserted checkpoint data to be reloaded after closing the wallet.
/// See [`Wallet::reveal_next_address`].
///
/// [`commit`]: Self::commit
pub fn insert_checkpoint(
&mut self,
block_id: BlockId,
Expand Down Expand Up @@ -2294,9 +2292,7 @@ impl Wallet {
/// transactions related to your wallet into it.
///
/// After applying updates you should persist the staged wallet changes. For an example of how
/// to persist staged wallet changes see [`Wallet::reveal_next_address`]. `
///
/// [`commit`]: Self::commit
/// to persist staged wallet changes see [`Wallet::reveal_next_address`].
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn apply_update(&mut self, update: impl Into<Update>) -> Result<(), CannotConnectError> {
Expand Down
14 changes: 12 additions & 2 deletions crates/wallet/src/wallet/params.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,12 @@ impl CreateParams {
self
}

/// Use custom lookahead value.
/// Use a custom `lookahead` value.
///
/// The `lookahead` defines a number of script pubkeys to derive over and above the last
/// revealed index. Without a lookahead the indexer will miss outputs you own when processing
/// transactions whose output script pubkeys lie beyond the last revealed index. In most cases
/// the default value [`DEFAULT_LOOKAHEAD`] is sufficient.
ValuedMammal marked this conversation as resolved.
Show resolved Hide resolved
pub fn lookahead(mut self, lookahead: u32) -> Self {
self.lookahead = lookahead;
self
Expand Down Expand Up @@ -211,7 +216,12 @@ impl LoadParams {
self
}

/// Use custom lookahead value.
/// Use a custom `lookahead` value.
///
/// The `lookahead` defines a number of script pubkeys to derive over and above the last
/// revealed index. Without a lookahead the indexer will miss outputs you own when processing
/// transactions whose output script pubkeys lie beyond the last revealed index. In most cases
/// the default value [`DEFAULT_LOOKAHEAD`] is sufficient.
pub fn lookahead(mut self, lookahead: u32) -> Self {
self.lookahead = lookahead;
self
Expand Down
2 changes: 1 addition & 1 deletion crates/wallet/src/wallet/signer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,7 +751,7 @@ pub struct SignOptions {
/// Whether the signer should trust the `witness_utxo`, if the `non_witness_utxo` hasn't been
/// provided
///
/// Defaults to `false` to mitigate the "SegWit bug" which should trick the wallet into
/// Defaults to `false` to mitigate the "SegWit bug" which could trick the wallet into
/// paying a fee larger than expected.
///
/// Some wallets, especially if relatively old, might not provide the `non_witness_utxo` for
Expand Down
Loading