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

docs(chain): fix docs

Browse Source
This commit is contained in:
志宇 2024-06-12 21:50:03 +08:00
parent c77e12bae7
commit 5a02f40122
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/chain/src/keychain/txout_index.rs
View File

@ -29,9 +29,9 @@ pub const DEFAULT_LOOKAHEAD: u32 = 25;
/// and only one descriptor and each descriptor has one and only one keychain. The
/// [`insert_descriptor`] method will return an error if you try and violate this invariant. This
/// rule is a proxy for a stronger rule: no two descriptors should produce the same script pubkey.
/// Having two descriptors produce the same script pubkey should cause whichever keychain derives the
/// script pubkey first to be the effective owner of it but you should not rely on this behaviour.
/// ⚠ It is up you, the developer, not to violate this invariant.
/// Having two descriptors produce the same script pubkey should cause whichever keychain derives
/// the script pubkey first to be the effective owner of it but you should not rely on this
/// behaviour. ⚠ It is up you, the developer, not to violate this invariant.
///
/// # Revealed script pubkeys
///
@ -341,7 +341,7 @@ impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K> {
}
impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K> {
/// Return the map of the keychain to descriptors.
/// Return all keychains and their corresponding descriptors.
pub fn keychains(
&self,
) -> impl DoubleEndedIterator<Item = (&K, &Descriptor<DescriptorPublicKey>)> + ExactSizeIterator + '_