Merge pull request #213 from sanket1729/descriptor_overhual

Descriptor struct overhaul

Author: apoelstra

examples/htlc.rs

@@ -19,8 +19,8 @@ extern crate miniscript;
 
 use bitcoin::Network;
 use miniscript::policy::{Concrete, Liftable};
-use miniscript::Descriptor;
 use miniscript::NullCtx;
+use miniscript::{Descriptor, DescriptorTrait};
 use std::str::FromStr;
 
 fn main() {
@@ -32,7 +32,12 @@ fn main() {
                                                   expiry = "4444"
     )).unwrap();
 
-    let htlc_descriptor = Descriptor::Wsh(htlc_policy.compile().unwrap());
+    let htlc_descriptor = Descriptor::new_wsh(
+        htlc_policy
+            .compile()
+            .expect("Policy compilation only fails on resource limits or mixed timelocks"),
+    )
+    .expect("Resource limits");
 
     // Check whether the descriptor is safe
     // This checks whether all spend paths are accessible in bitcoin network.
@@ -55,14 +60,14 @@ fn main() {
     );
 
     assert_eq!(
-        format!("{:x}", htlc_descriptor.witness_script(NullCtx)),
+        format!("{:x}", htlc_descriptor.explicit_script(NullCtx)),
         "21022222222222222222222222222222222222222222222222222222222222222222ac6476a91451814f108670aced2d77c1805ddd6634bc9d473188ad025c11b26782012088a82011111111111111111111111111111111111111111111111111111111111111118768"
     );
 
     assert_eq!(
         format!(
             "{}",
-            htlc_descriptor.address(Network::Bitcoin, NullCtx).unwrap()
+            htlc_descriptor.address(NullCtx, Network::Bitcoin).unwrap()
         ),
         "bc1qmpfcw7he9z5d9ftfe8qw699azmm2sr8fen903fs4plv007yx0t3qxfmqv5"
     );

examples/parse.rs

@@ -17,7 +17,7 @@
 extern crate bitcoin;
 extern crate miniscript;
 
-use miniscript::NullCtx;
+use miniscript::{DescriptorTrait, NullCtx};
 use std::str::FromStr;
 
 fn main() {
@@ -42,7 +42,7 @@ fn main() {
     );
 
     assert_eq!(
-        format!("{:x}", my_descriptor.witness_script(NullCtx)),
+        format!("{:x}", my_descriptor.explicit_script(NullCtx)),
         "21020202020202020202020202020202020202020202020202020202020202020202ac"
     );
 }

examples/sign_multisig.rs

@@ -18,7 +18,7 @@ extern crate bitcoin;
 extern crate miniscript;
 
 use bitcoin::secp256k1; // secp256k1 re-exported from rust-bitcoin
-use miniscript::NullCtx;
+use miniscript::{DescriptorTrait, NullCtx};
 use std::collections::HashMap;
 use std::str::FromStr;
 
@@ -100,7 +100,7 @@ fn main() {
     );
 
     assert_eq!(
-        format!("{:x}", my_descriptor.witness_script(NullCtx)),
+        format!("{:x}", my_descriptor.explicit_script(NullCtx)),
         "52\
          21020202020202020202020202020202020202020202020202020202020202020202\
          21020102030405060708010203040506070801020304050607080000000000000000\

examples/xpub_descriptors.rs

@@ -17,7 +17,7 @@
 extern crate miniscript;
 
 use miniscript::bitcoin::{self, secp256k1};
-use miniscript::{Descriptor, DescriptorPublicKey, DescriptorPublicKeyCtx};
+use miniscript::{Descriptor, DescriptorPublicKey, DescriptorPublicKeyCtx, DescriptorTrait};
 
 use bitcoin::util::bip32;
 
@@ -34,13 +34,13 @@ fn main() {
             "wsh(sortedmulti(1,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH))",
         )
         .unwrap()
-        .address(bitcoin::Network::Bitcoin, desc_ctx).unwrap();
+        .address(desc_ctx, bitcoin::Network::Bitcoin).unwrap();
 
     let addr_two = Descriptor::<DescriptorPublicKey>::from_str(
             "wsh(sortedmulti(1,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB))",
         )
         .unwrap()
-        .address(bitcoin::Network::Bitcoin, desc_ctx).unwrap();
+        .address(desc_ctx, bitcoin::Network::Bitcoin).unwrap();
     let expected = bitcoin::Address::from_str(
         "bc1qpq2cfgz5lktxzr5zqv7nrzz46hsvq3492ump9pz8rzcl8wqtwqcspx5y6a",
     )
@@ -54,14 +54,14 @@ fn main() {
         )
         .unwrap()
         .derive(bitcoin::util::bip32::ChildNumber::from_normal_idx(5).unwrap())
-        .address(bitcoin::Network::Bitcoin, desc_ctx).unwrap();
+        .address(desc_ctx, bitcoin::Network::Bitcoin).unwrap();
 
     let addr_two = Descriptor::<DescriptorPublicKey>::from_str(
             "sh(wsh(sortedmulti(1,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH/0/0/*,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB/1/0/*)))",
         )
         .unwrap()
         .derive(bitcoin::util::bip32::ChildNumber::from_normal_idx(5).unwrap())
-        .address(bitcoin::Network::Bitcoin, desc_ctx).unwrap();
+        .address(desc_ctx, bitcoin::Network::Bitcoin).unwrap();
     let expected = bitcoin::Address::from_str("325zcVBN5o2eqqqtGwPjmtDd8dJRyYP82s").unwrap();
     assert_eq!(addr_one, expected);
     assert_eq!(addr_two, expected);