Skip to content

Pegin desc wildcard #96

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 5 commits into from
Dec 7, 2024
Merged

Pegin desc wildcard #96

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a22725
Remove generic in Pegin descriptor for `fed_desc`
RCasatta Nov 26, 2024
f77617b
Refactor out the fed peg desc in a function
RCasatta Nov 26, 2024
2f1e07b
Add Pegin::derived_descriptor
RCasatta Nov 26, 2024
59362c8
remove unused lint cfg causing warning
RCasatta Dec 2, 2024
624e3f4
create an address matching the fed desc
RCasatta Dec 4, 2024
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
86 changes: 67 additions & 19 deletions src/descriptor/pegin/dynafed_pegin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use std::convert::TryFrom;
use std::fmt;

use bitcoin::blockdata::script::{self, PushBytes};
use bitcoin::{self, ScriptBuf as BtcScript, Weight};
use bitcoin::{self, PublicKey, ScriptBuf as BtcScript, Weight};
use elements::secp256k1_zkp;

use crate::descriptor::checksum::{self, verify_checksum};
Expand All @@ -33,15 +33,15 @@ use crate::extensions::{CovExtArgs, CovenantExt};
use crate::policy::{semantic, Liftable};
use crate::{
tweak_key, BtcDescriptor, BtcError, BtcFromTree, BtcLiftable, BtcPolicy, BtcSatisfier, BtcTree,
Descriptor, Error, MiniscriptKey, ToPublicKey,
Descriptor, DescriptorPublicKey, Error, MiniscriptKey, ToPublicKey,
};

/// New Pegin Descriptor with Miniscript support
/// Useful with dynamic federations
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct Pegin<Pk: MiniscriptKey> {
/// The untweaked pegin bitcoin descriptor
pub fed_desc: BtcDescriptor<Pk>,
pub fed_desc: BtcDescriptor<PublicKey>,
/// The redeem elements descriptor
///
/// TODO: Allow pegin redeem descriptor with extensions
Expand All @@ -51,7 +51,7 @@ pub struct Pegin<Pk: MiniscriptKey> {
impl<Pk: MiniscriptKey> Pegin<Pk> {
/// Create a new LegacyPegin descriptor
pub fn new(
fed_desc: BtcDescriptor<Pk>,
fed_desc: BtcDescriptor<PublicKey>,
elem_desc: Descriptor<Pk, CovenantExt<CovExtArgs>>,
) -> Self {
Self {
Expand All @@ -61,6 +61,18 @@ impl<Pk: MiniscriptKey> Pegin<Pk> {
}
}

impl Pegin<DescriptorPublicKey> {
pub fn derived_descriptor<C: secp256k1_zkp::Verification>(
&self,
arg: u32,
secp: &secp256k1_zkp::Secp256k1<C>,
) -> Result<Pegin<PublicKey>, Error> {
let elem_desc = self.elem_desc.at_derivation_index(arg)?;
let elem_desc = elem_desc.derived_descriptor(&secp)?;
Ok(Pegin::new(self.fed_desc.clone(), elem_desc))
}
}

impl<Pk: MiniscriptKey> fmt::Debug for Pegin<Pk> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "pegin({:?},{:?})", self.fed_desc, self.elem_desc)
Expand All @@ -76,15 +88,15 @@ impl<Pk: MiniscriptKey> fmt::Display for Pegin<Pk> {
}
}

impl<Pk: MiniscriptKey> Liftable<Pk> for Pegin<Pk> {
fn lift(&self) -> Result<semantic::Policy<Pk>, Error> {
impl<Pk: MiniscriptKey> Liftable<PublicKey> for Pegin<Pk> {
fn lift(&self) -> Result<semantic::Policy<PublicKey>, Error> {
let btc_pol = BtcLiftable::lift(&self.fed_desc)?;
Liftable::lift(&btc_pol)
}
}

impl<Pk: MiniscriptKey> BtcLiftable<Pk> for Pegin<Pk> {
fn lift(&self) -> Result<BtcPolicy<Pk>, BtcError> {
impl<Pk: MiniscriptKey> BtcLiftable<PublicKey> for Pegin<Pk> {
fn lift(&self) -> Result<BtcPolicy<PublicKey>, BtcError> {
self.fed_desc.lift()
}
}
Expand All @@ -101,7 +113,7 @@ impl_from_tree!(
// TODO: Confirm with Andrew about the descriptor type for dynafed
// Assuming sh(wsh) for now.

let fed_desc = BtcDescriptor::<Pk>::from_tree(&ms_expr)?;
let fed_desc = BtcDescriptor::<PublicKey>::from_tree(&ms_expr)?;
let elem_desc = Descriptor::<Pk, CovenantExt<CovExtArgs>>::from_tree(&top.args[1])?;
Ok(Pegin::new(fed_desc, elem_desc))
} else {
Expand Down Expand Up @@ -148,6 +160,7 @@ impl<Pk: MiniscriptKey> Pegin<Pk> {
{
// TODO
Ok(bitcoin::Address::p2shwsh(
// Should the address type taken from the top level user desc?
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be the right thing to do?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should come from the fed_desc field. Probably easiest to match on self.fed_desc.desc_type() (lol we should rename this) and choose the address type based on that. https://docs.rs/miniscript/latest/miniscript/descriptor/enum.Descriptor.html#method.desc_type

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than this, 59362c8 looks good.

&self
.bitcoin_witness_script(secp)
.expect("DO this cleanly after TR. Pay to taproot pegins unspecified till now"),
Expand Down Expand Up @@ -309,11 +322,23 @@ where

#[cfg(test)]
mod tests {
use bitcoin::PublicKey;
use elements::hex::FromHex;

use crate::descriptor::pegin::Pegin;
use crate::{BtcDescriptor, ConfidentialDescriptor, DescriptorPublicKey};

fn fed_peg_desc() -> BtcDescriptor<PublicKey> {
let s = bitcoin::ScriptBuf::from_hex("5b21020e0338c96a8870479f2396c373cc7696ba124e8635d41b0ea581112b678172612102675333a4e4b8fb51d9d4e22fa5a8eaced3fdac8a8cbf9be8c030f75712e6af992102896807d54bc55c24981f24a453c60ad3e8993d693732288068a23df3d9f50d4821029e51a5ef5db3137051de8323b001749932f2ff0d34c82e96a2c2461de96ae56c2102a4e1a9638d46923272c266631d94d36bdb03a64ee0e14c7518e49d2f29bc401021031c41fdbcebe17bec8d49816e00ca1b5ac34766b91c9f2ac37d39c63e5e008afb2103079e252e85abffd3c401a69b087e590a9b86f33f574f08129ccbd3521ecf516b2103111cf405b627e22135b3b3733a4a34aa5723fb0f58379a16d32861bf576b0ec2210318f331b3e5d38156da6633b31929c5b220349859cc9ca3d33fb4e68aa08401742103230dae6b4ac93480aeab26d000841298e3b8f6157028e47b0897c1e025165de121035abff4281ff00660f99ab27bb53e6b33689c2cd8dcd364bc3c90ca5aea0d71a62103bd45cddfacf2083b14310ae4a84e25de61e451637346325222747b157446614c2103cc297026b06c71cbfa52089149157b5ff23de027ac5ab781800a578192d175462103d3bde5d63bdb3a6379b461be64dad45eabff42f758543a9645afd42f6d4248282103ed1e8d5109c9ed66f7941bc53cc71137baa76d50d274bda8d5e8ffbd6e61fe9a5fae736402c00fb269522103aab896d53a8e7d6433137bbba940f9c521e085dd07e60994579b64a6d992cf79210291b7d0b1b692f8f524516ed950872e5da10fb1b808b5a526dedc6fed1cf29807210386aa9372fbab374593466bc5451dc59954e90787f08060964d95c87ef34ca5bb53ae68").unwrap();

type Segwitv0Script =
bitcoin_miniscript::Miniscript<bitcoin::PublicKey, bitcoin_miniscript::Segwitv0>;

let m = Segwitv0Script::parse(&s).unwrap();
assert_eq!(m.encode(), s);
BtcDescriptor::<_>::new_wsh(m).unwrap()
}

// test vector created with:
// ```
// $ elements-cli getnetworkinfo | jq .version
Expand All @@ -330,16 +355,7 @@ mod tests {
// ```
#[test]
fn test_pegin() {
let fedpegscript ="5b21020e0338c96a8870479f2396c373cc7696ba124e8635d41b0ea581112b678172612102675333a4e4b8fb51d9d4e22fa5a8eaced3fdac8a8cbf9be8c030f75712e6af992102896807d54bc55c24981f24a453c60ad3e8993d693732288068a23df3d9f50d4821029e51a5ef5db3137051de8323b001749932f2ff0d34c82e96a2c2461de96ae56c2102a4e1a9638d46923272c266631d94d36bdb03a64ee0e14c7518e49d2f29bc401021031c41fdbcebe17bec8d49816e00ca1b5ac34766b91c9f2ac37d39c63e5e008afb2103079e252e85abffd3c401a69b087e590a9b86f33f574f08129ccbd3521ecf516b2103111cf405b627e22135b3b3733a4a34aa5723fb0f58379a16d32861bf576b0ec2210318f331b3e5d38156da6633b31929c5b220349859cc9ca3d33fb4e68aa08401742103230dae6b4ac93480aeab26d000841298e3b8f6157028e47b0897c1e025165de121035abff4281ff00660f99ab27bb53e6b33689c2cd8dcd364bc3c90ca5aea0d71a62103bd45cddfacf2083b14310ae4a84e25de61e451637346325222747b157446614c2103cc297026b06c71cbfa52089149157b5ff23de027ac5ab781800a578192d175462103d3bde5d63bdb3a6379b461be64dad45eabff42f758543a9645afd42f6d4248282103ed1e8d5109c9ed66f7941bc53cc71137baa76d50d274bda8d5e8ffbd6e61fe9a5fae736402c00fb269522103aab896d53a8e7d6433137bbba940f9c521e085dd07e60994579b64a6d992cf79210291b7d0b1b692f8f524516ed950872e5da10fb1b808b5a526dedc6fed1cf29807210386aa9372fbab374593466bc5451dc59954e90787f08060964d95c87ef34ca5bb53ae68";
let s = bitcoin::ScriptBuf::from_hex(fedpegscript).unwrap();

type Segwitv0Script =
bitcoin_miniscript::Miniscript<bitcoin::PublicKey, bitcoin_miniscript::Segwitv0>;

let m = Segwitv0Script::parse(&s).unwrap();
assert_eq!(m.encode(), s);

let d = BtcDescriptor::<_>::new_wsh(m).unwrap();
let d = fed_peg_desc();

let fedpegdesc = "wsh(or_d(multi(11,020e0338c96a8870479f2396c373cc7696ba124e8635d41b0ea581112b67817261,02675333a4e4b8fb51d9d4e22fa5a8eaced3fdac8a8cbf9be8c030f75712e6af99,02896807d54bc55c24981f24a453c60ad3e8993d693732288068a23df3d9f50d48,029e51a5ef5db3137051de8323b001749932f2ff0d34c82e96a2c2461de96ae56c,02a4e1a9638d46923272c266631d94d36bdb03a64ee0e14c7518e49d2f29bc4010,031c41fdbcebe17bec8d49816e00ca1b5ac34766b91c9f2ac37d39c63e5e008afb,03079e252e85abffd3c401a69b087e590a9b86f33f574f08129ccbd3521ecf516b,03111cf405b627e22135b3b3733a4a34aa5723fb0f58379a16d32861bf576b0ec2,0318f331b3e5d38156da6633b31929c5b220349859cc9ca3d33fb4e68aa0840174,03230dae6b4ac93480aeab26d000841298e3b8f6157028e47b0897c1e025165de1,035abff4281ff00660f99ab27bb53e6b33689c2cd8dcd364bc3c90ca5aea0d71a6,03bd45cddfacf2083b14310ae4a84e25de61e451637346325222747b157446614c,03cc297026b06c71cbfa52089149157b5ff23de027ac5ab781800a578192d17546,03d3bde5d63bdb3a6379b461be64dad45eabff42f758543a9645afd42f6d424828,03ed1e8d5109c9ed66f7941bc53cc71137baa76d50d274bda8d5e8ffbd6e61fe9a),and_v(v:older(4032),multi(2,03aab896d53a8e7d6433137bbba940f9c521e085dd07e60994579b64a6d992cf79,0291b7d0b1b692f8f524516ed950872e5da10fb1b808b5a526dedc6fed1cf29807,0386aa9372fbab374593466bc5451dc59954e90787f08060964d95c87ef34ca5bb))))#7jwwklk4";
assert_eq!(&d.to_string(), fedpegdesc);
Expand All @@ -362,4 +378,36 @@ mod tests {

assert_eq!(pegin.to_string(), "pegin(wsh(or_d(multi(11,020e0338c96a8870479f2396c373cc7696ba124e8635d41b0ea581112b67817261,02675333a4e4b8fb51d9d4e22fa5a8eaced3fdac8a8cbf9be8c030f75712e6af99,02896807d54bc55c24981f24a453c60ad3e8993d693732288068a23df3d9f50d48,029e51a5ef5db3137051de8323b001749932f2ff0d34c82e96a2c2461de96ae56c,02a4e1a9638d46923272c266631d94d36bdb03a64ee0e14c7518e49d2f29bc4010,031c41fdbcebe17bec8d49816e00ca1b5ac34766b91c9f2ac37d39c63e5e008afb,03079e252e85abffd3c401a69b087e590a9b86f33f574f08129ccbd3521ecf516b,03111cf405b627e22135b3b3733a4a34aa5723fb0f58379a16d32861bf576b0ec2,0318f331b3e5d38156da6633b31929c5b220349859cc9ca3d33fb4e68aa0840174,03230dae6b4ac93480aeab26d000841298e3b8f6157028e47b0897c1e025165de1,035abff4281ff00660f99ab27bb53e6b33689c2cd8dcd364bc3c90ca5aea0d71a6,03bd45cddfacf2083b14310ae4a84e25de61e451637346325222747b157446614c,03cc297026b06c71cbfa52089149157b5ff23de027ac5ab781800a578192d17546,03d3bde5d63bdb3a6379b461be64dad45eabff42f758543a9645afd42f6d424828,03ed1e8d5109c9ed66f7941bc53cc71137baa76d50d274bda8d5e8ffbd6e61fe9a),and_v(v:older(4032),multi(2,03aab896d53a8e7d6433137bbba940f9c521e085dd07e60994579b64a6d992cf79,0291b7d0b1b692f8f524516ed950872e5da10fb1b808b5a526dedc6fed1cf29807,0386aa9372fbab374593466bc5451dc59954e90787f08060964d95c87ef34ca5bb)))),elwpkh(0321da398ca2ddc09be89caa26e6730ae84751b6ea3a1ca46aa365bb5e1c3d9620))#qp4fan9q");
}

#[test]
fn test_pegin_derive() {
let elem_desc = "ct(slip77(ab5824f4477b4ebb00a132adfd8eb0b7935cf24f6ac151add5d1913db374ce92),elwpkh([759db348/84'/1'/0']tpubDCRMaF33e44pcJj534LXVhFbHibPbJ5vuLhSSPFAw57kYURv4tzXFL6LSnd78bkjqdmE3USedkbpXJUPA1tdzKfuYSL7PianceqAhwL2UkA/0/*))";
let elem_desc: ConfidentialDescriptor<DescriptorPublicKey> = elem_desc.parse().unwrap();
let fed_peg_desc = fed_peg_desc();
let pegin = Pegin::new(fed_peg_desc, elem_desc.descriptor);
let secp = secp256k1::Secp256k1::new();

let witness_script_0 = pegin
.derived_descriptor(0, &secp)
.unwrap()
.bitcoin_witness_script(&secp)
.unwrap();
let address_0 = bitcoin::Address::p2wsh(&witness_script_0, bitcoin::Network::Bitcoin);
assert_eq!(
address_0.to_string(),
"bc1qqkq6czql4zqwsylgrfzttjrn5wjeqmwfq5yn80p39amxtnkng9lsn6c5qr"
);

let witness_script_1 = pegin
.derived_descriptor(1, &secp)
.unwrap()
.bitcoin_witness_script(&secp)
.unwrap();
let address_1 = bitcoin::Address::p2wsh(&witness_script_1, bitcoin::Network::Bitcoin);
assert_ne!(address_0, address_1);
assert_eq!(
address_1.to_string(),
"bc1qmevs3n40t394230lptclz55rmxkmr7dmnqhuflxf0cezdupsmvdsk25n3m"
);
}
}
12 changes: 12 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,9 @@ pub enum Error {
/// At least two BIP389 key expressions in the descriptor contain tuples of
/// derivation indexes of different lengths.
MultipathDescLenMismatch,

/// Conversion error in descriptor
Conversion(descriptor::ConversionError),
}

#[doc(hidden)]
Expand Down Expand Up @@ -449,6 +452,12 @@ impl From<bitcoin::address::ParseError> for Error {
}
}

impl From<descriptor::ConversionError> for Error {
fn from(e: descriptor::ConversionError) -> Error {
Error::Conversion(e)
}
}

fn errstr(s: &str) -> Error {
Error::Unexpected(s.to_owned())
}
Expand Down Expand Up @@ -530,6 +539,8 @@ impl fmt::Display for Error {
Error::TrNoScriptCode => write!(f, "No script code for Tr descriptors"),
Error::TrNoExplicitScript => write!(f, "No script code for Tr descriptors"),
Error::MultipathDescLenMismatch => write!(f, "At least two BIP389 key expressions in the descriptor contain tuples of derivation indexes of different lengths"),
Error::Conversion(ref e) => e.fmt(f),

}
}
}
Expand Down Expand Up @@ -584,6 +595,7 @@ impl error::Error for Error {
ContextError(e) => Some(e),
AnalysisError(e) => Some(e),
PubKeyCtxError(e, _) => Some(e),
Conversion(e) => Some(e),
}
}
}
Expand Down