Merge pull request #232 from sanket1729/expose_inner

Expose sh/wsh Inners

Author: heap-coder

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "miniscript"
-version = "5.0.2"
+version = "5.1.0"
 authors = ["Andrew Poelstra <[email protected]>, Sanket Kanjalkar <[email protected]>"]
 repository = "https://github.com/apoelstra/miniscript"
 description = "Miniscript: a subset of Bitcoin Script designed for analysis"

examples/parse.rs

@@ -17,7 +17,7 @@
 extern crate bitcoin;
 extern crate miniscript;
 
-use miniscript::DescriptorTrait;
+use miniscript::{descriptor::DescriptorType, DescriptorTrait};
 use std::str::FromStr;
 
 fn main() {
@@ -45,4 +45,11 @@ fn main() {
         format!("{:x}", my_descriptor.explicit_script()),
         "21020202020202020202020202020202020202020202020202020202020202020202ac"
     );
+
+    let desc = miniscript::Descriptor::<bitcoin::PublicKey>::from_str(
+        "sh(wsh(c:pk_k(020202020202020202020202020202020202020202020202020202020202020202)))",
+    )
+    .unwrap();
+
+    assert!(desc.desc_type() == DescriptorType::ShWsh);
 }

src/descriptor/mod.rs

@@ -47,8 +47,8 @@ mod sh;
 mod sortedmulti;
 // Descriptor Exports
 pub use self::bare::{Bare, Pkh};
-pub use self::segwitv0::{Wpkh, Wsh};
-pub use self::sh::Sh;
+pub use self::segwitv0::{Wpkh, Wsh, WshInner};
+pub use self::sh::{Sh, ShInner};
 pub use self::sortedmulti::SortedMultiVec;
 
 mod checksum;
@@ -168,6 +168,31 @@ pub enum Descriptor<Pk: MiniscriptKey> {
     Wsh(Wsh<Pk>),
 }
 
+/// Descriptor Type of the descriptor
+#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+pub enum DescriptorType {
+    /// Bare descriptor(Contains the native P2pk)
+    Bare,
+    /// Pure Sh Descriptor. Does not contain nested Wsh/Wpkh
+    Sh,
+    /// Pkh Descriptor
+    Pkh,
+    /// Wpkh Descriptor
+    Wpkh,
+    /// Wsh
+    Wsh,
+    /// Sh Wrapped Wsh
+    ShWsh,
+    /// Sh wrapped Wpkh
+    ShWpkh,
+    /// Sh Sorted Multi
+    ShSortedMulti,
+    /// Wsh Sorted Multi
+    WshSortedMulti,
+    /// Sh Wsh Sorted Multi
+    ShWshSortedMulti,
+}
+
 impl<Pk: MiniscriptKey> Descriptor<Pk> {
     // Keys
 
@@ -251,6 +276,28 @@ impl<Pk: MiniscriptKey> Descriptor<Pk> {
     pub fn new_wsh_sortedmulti(k: usize, pks: Vec<Pk>) -> Result<Self, Error> {
         Ok(Descriptor::Wsh(Wsh::new_sortedmulti(k, pks)?))
     }
+
+    /// Get the [DescriptorType] of [Descriptor]
+    pub fn desc_type(&self) -> DescriptorType {
+        match *self {
+            Descriptor::Bare(ref _bare) => DescriptorType::Bare,
+            Descriptor::Pkh(ref _pkh) => DescriptorType::Pkh,
+            Descriptor::Wpkh(ref _wpkh) => DescriptorType::Wpkh,
+            Descriptor::Sh(ref sh) => match sh.as_inner() {
+                ShInner::Wsh(ref wsh) => match wsh.as_inner() {
+                    WshInner::SortedMulti(ref _smv) => DescriptorType::ShWshSortedMulti,
+                    WshInner::Ms(ref _ms) => DescriptorType::ShWsh,
+                },
+                ShInner::Wpkh(ref _wpkh) => DescriptorType::ShWpkh,
+                ShInner::SortedMulti(ref _smv) => DescriptorType::ShSortedMulti,
+                ShInner::Ms(ref _ms) => DescriptorType::Sh,
+            },
+            Descriptor::Wsh(ref wsh) => match wsh.as_inner() {
+                WshInner::SortedMulti(ref _smv) => DescriptorType::WshSortedMulti,
+                WshInner::Ms(ref _ms) => DescriptorType::Wsh,
+            },
+        }
+    }
 }
 
 impl<P: MiniscriptKey, Q: MiniscriptKey> TranslatePk<P, Q> for Descriptor<P> {