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

chore(chain): document insert_descriptor invariants better

Browse Source
This commit is contained in:
LLFourn 2024-06-11 14:29:26 +10:00 committed by 志宇
parent 69f2a695f7
commit 8779afdb0b
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,11 @@ pub const DEFAULT_LOOKAHEAD: u32 = 25;
///
/// There is a strict 1-to-1 relationship between descriptors and keychains. Each keychain has one
/// 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.
/// [`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.
///
/// # Revealed script pubkeys
///