-
Notifications
You must be signed in to change notification settings - Fork 82
Doc improvements #59
Copy link
Copy link
Open
Labels
auditSuggested as result of external code auditSuggested as result of external code auditdocumentationImprovements or additions to documentationImprovements or additions to documentation
Metadata
Metadata
Assignees
Labels
auditSuggested as result of external code auditSuggested as result of external code auditdocumentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Todo
bdk_chain
CheckPoint's doc comment could mention it's guaranteed to always have at least one element, since it's an invariant relied upon across the project.merge_chains's doc comment is outdated.walk_descendants's doc could mention it excludes the root tx from the iterator.SpkIterator::next(), derived_descriptor's descriptor is unwrapped because "the descriptor cannot need hardened derivation". It'd be better to have "we check it's never hardened in the constructor" as it's a stronger invariant. (Mentioning as I initially missed it was also checked inSpkIterator::new_with_range()by re-assigning to end the minimum between end andBIP32_MAX_INDEX.)bdk_esplora