Skip to content

Document an error case for at_derivation_index() #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Document an error case for at_derivation_index() #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/descriptor/key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,7 @@ impl DescriptorPublicKey {
/// # Errors
///
/// - If `index` is hardened.
/// - If the key contains multi-path derivations
pub fn at_derivation_index(self, index: u32) -> Result<DefiniteDescriptorKey, ConversionError> {
let definite = match self {
DescriptorPublicKey::Single(_) => self,
Expand Down
4 changes: 3 additions & 1 deletion src/descriptor/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,7 @@ impl Descriptor<DescriptorPublicKey> {
///
/// # Errors
/// - If index ≥ 2^31
/// - If the descriptor contains multi-path derivations
pub fn at_derivation_index(
&self,
index: u32,
Expand Down Expand Up @@ -650,7 +651,8 @@ impl Descriptor<DescriptorPublicKey> {
///
/// # Errors
///
/// This function will return an error if hardened derivation is attempted.
/// This function will return an error for multi-path descriptors
/// or if hardened derivation is attempted,
pub fn derived_descriptor<C: secp256k1::Verification>(
&self,
secp: &secp256k1::Secp256k1<C>,
Expand Down
Loading