Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Added
- Expose miniscript `has_wildcard` and `sanity_check` methods on `Descriptor` type #945
- Expose `new_wsh_sortedmulti` and `new_pk` methods on `Descriptor` type #949

## [v2.3.0]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,32 @@ class DescriptorTest {
Descriptor("tr($MAINNET_EXTENDED_PRIVKEY/$BIP86_MAINNET_RECEIVE_PATH/0)", Network.BITCOIN)
}

// Create a multisig descriptor.
@Test
fun createMultisigDescriptor() {
val pkList = listOf(
"xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB",
"xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB",
"xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB"
)

Descriptor.newWshSortedmulti(2u, pkList);

val invalidPkList = listOf(
"invalid_xpub",
"1111111111111",
"***"
)
assertFails {
Descriptor.newWshSortedmulti(2u, invalidPkList);
}
}

@Test
fun createSingleKeyDescriptor() {
Descriptor.newPk("xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB")
}

// Cannot create addr() descriptor.
@Test
fun cannotCreateAddrDescriptor() {
Expand Down
46 changes: 46 additions & 0 deletions bdk-ffi/src/descriptor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,52 @@ impl Descriptor {
}
}

/// Create a new wsh sorted multi descriptor
/// Errors when miniscript exceeds resource limits under p2sh context
#[uniffi::constructor]
pub fn new_wsh_sortedmulti(k: u32, pks: Vec<String>) -> Result<Self, DescriptorError> {
let bdk_pks: Vec<BdkDescriptorPublicKey> = pks
.iter()
.map(|pk| {
BdkDescriptorPublicKey::from_str(pk).map_err(|e| DescriptorError::Miniscript {
error_message: e.to_string(),
})
})
.collect::<Result<Vec<BdkDescriptorPublicKey>, DescriptorError>>()?;
let miniscript_descriptor =
match bdk_wallet::miniscript::Descriptor::new_wsh_sortedmulti(k as usize, bdk_pks) {
Ok(descriptor) => descriptor,
Err(e) => {
return Err(DescriptorError::Miniscript {
error_message: e.to_string(),
})
}
};
let extended_descriptor = ExtendedDescriptor::from(miniscript_descriptor);

Ok(Self {
extended_descriptor,
key_map: KeyMap::new(),
})
}

/// Create a new pay-to-pubkey descriptor from a public key string.
#[uniffi::constructor]
pub fn new_pk(pk: String) -> Result<Self, DescriptorError> {
let key =
BdkDescriptorPublicKey::from_str(&pk).map_err(|e| DescriptorError::Miniscript {
error_message: e.to_string(),
})?;

let miniscript_descriptor = bdk_wallet::miniscript::Descriptor::new_pk(key);
let extended_descriptor = ExtendedDescriptor::from(miniscript_descriptor);

Ok(Self {
extended_descriptor,
key_map: KeyMap::new(),
})
}

/// Dangerously convert the descriptor to a string.
pub fn to_string_with_secret(&self) -> String {
let descriptor = &self.extended_descriptor;
Expand Down
Loading