frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(wallet): improve docs for unbounded spk iterator methods

Browse Source
This commit is contained in:
志宇 2024-01-17 13:29:16 +08:00
parent b74c2e2622
commit 9294e30943
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/bdk/src/wallet/mod.rs
View File

@ -811,8 +811,7 @@ impl<D> Wallet<D> {
self.chain.tip()
}
/// Returns a iterators of all the script pubkeys for the `Internal` and `External` variants in
/// `KeychainKind`.
/// Get unbounded script pubkey iterators for both `Internal` and `External` keychains.
///
/// This is intended to be used when doing a full scan of your addresses (e.g. after restoring
/// from seed words). You pass the `BTreeMap` of iterators to a blockchain data source (e.g.
@ -826,7 +825,7 @@ impl<D> Wallet<D> {
self.indexed_graph.index.all_unbounded_spk_iters()
}
/// Gets an iterator over all the script pubkeys in a single keychain.
/// Get an unbounded script pubkey iterator for the given `keychain`.
///
/// See [`all_unbounded_spk_iters`] for more documentation
///