Skip to content

Commit

Permalink
docs(chain): fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
evanlinjin committed Jun 13, 2024
1 parent c77e12b commit 5a02f40
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions crates/chain/src/keychain/txout_index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down Expand Up @@ -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 + '_
Expand Down

0 comments on commit 5a02f40

Please sign in to comment.