Cleanup Miniscript constructors

Miniscript should only be called with two constructors. from_ast and
from_components_unchecked

Author: sanket1729

src/miniscript/mod.rs

@@ -57,7 +57,7 @@ pub struct Miniscript<Pk: MiniscriptKey, Ctx: ScriptContext> {
     ///Additional information helpful for extra analysis.
     pub ext: types::extra_props::ExtData,
     /// Context PhantomData. Only accessible inside this crate
-    pub(crate) phantom: PhantomData<Ctx>,
+    phantom: PhantomData<Ctx>,
 }
 
 /// `PartialOrd` of `Miniscript` must depend only on node and not the type information.
@@ -116,6 +116,24 @@ impl<Pk: MiniscriptKey, Ctx: ScriptContext> Miniscript<Pk, Ctx> {
             phantom: PhantomData,
         })
     }
+
+    /// Create a new `Miniscript` from a `Terminal` node and a `Type` annotation
+    /// This does not check the typing rules. The user is responsible for ensuring
+    /// that the type provided is correct.
+    ///
+    /// You should almost always use `Miniscript::from_ast` instead of this function.
+    pub fn from_components_unchecked(
+        node: Terminal<Pk, Ctx>,
+        ty: types::Type,
+        ext: types::extra_props::ExtData,
+    ) -> Miniscript<Pk, Ctx> {
+        Miniscript {
+            node,
+            ty,
+            ext,
+            phantom: PhantomData,
+        }
+    }
 }
 
 impl<Pk: MiniscriptKey, Ctx: ScriptContext> fmt::Display for Miniscript<Pk, Ctx> {
@@ -311,15 +329,7 @@ impl<Pk: MiniscriptKey, Ctx: ScriptContext> Miniscript<Pk, Ctx> {
         T: Translator<Pk, Q, FuncError>,
     {
         let inner = self.node.real_translate_pk(t)?;
-        let ms = Miniscript {
-            //directly copying the type and ext is safe because translating public
-            //key should not change any properties
-            ty: self.ty,
-            ext: self.ext,
-            node: inner,
-            phantom: PhantomData,
-        };
-        Ok(ms)
+        Ok(Miniscript::from_ast(inner).expect("This will be removed in the next commit"))
     }
 }
 
@@ -428,12 +438,7 @@ impl_from_tree!(
     /// should not be called directly; rather go through the descriptor API.
     fn from_tree(top: &expression::Tree) -> Result<Miniscript<Pk, Ctx>, Error> {
         let inner: Terminal<Pk, Ctx> = expression::FromTree::from_tree(top)?;
-        Ok(Miniscript {
-            ty: Type::type_check(&inner, |_| None)?,
-            ext: ExtData::type_check(&inner, |_| None)?,
-            node: inner,
-            phantom: PhantomData,
-        })
+        Miniscript::from_ast(inner)
     }
 );
 
@@ -663,30 +668,22 @@ mod tests {
         .unwrap();
         let hash = hash160::Hash::from_byte_array([17; 20]);
 
-        let pkk_ms: Miniscript<String, Segwitv0> = Miniscript {
-            node: Terminal::Check(Arc::new(Miniscript {
-                node: Terminal::PkK(String::from("")),
-                ty: Type::from_pk_k::<Segwitv0>(),
-                ext: types::extra_props::ExtData::from_pk_k::<Segwitv0>(),
-                phantom: PhantomData,
-            })),
-            ty: Type::cast_check(Type::from_pk_k::<Segwitv0>()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_k::<Segwitv0>()).unwrap(),
+        let pk_node = Terminal::Check(Arc::new(Miniscript {
+            node: Terminal::PkK(String::from("")),
+            ty: Type::from_pk_k::<Segwitv0>(),
+            ext: types::extra_props::ExtData::from_pk_k::<Segwitv0>(),
             phantom: PhantomData,
-        };
+        }));
+        let pkk_ms: Miniscript<String, Segwitv0> = Miniscript::from_ast(pk_node).unwrap();
         dummy_string_rtt(pkk_ms, "[B/onduesm]c:[K/onduesm]pk_k(\"\")", "pk()");
 
-        let pkh_ms: Miniscript<String, Segwitv0> = Miniscript {
-            node: Terminal::Check(Arc::new(Miniscript {
-                node: Terminal::PkH(String::from("")),
-                ty: Type::from_pk_h::<Segwitv0>(),
-                ext: types::extra_props::ExtData::from_pk_h::<Segwitv0>(),
-                phantom: PhantomData,
-            })),
-            ty: Type::cast_check(Type::from_pk_h::<Segwitv0>()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_h::<Segwitv0>()).unwrap(),
+        let pkh_node = Terminal::Check(Arc::new(Miniscript {
+            node: Terminal::PkH(String::from("")),
+            ty: Type::from_pk_h::<Segwitv0>(),
+            ext: types::extra_props::ExtData::from_pk_h::<Segwitv0>(),
             phantom: PhantomData,
-        };
+        }));
+        let pkh_ms: Miniscript<String, Segwitv0> = Miniscript::from_ast(pkh_node).unwrap();
 
         let expected_debug = "[B/nduesm]c:[K/nduesm]pk_h(\"\")";
         let expected_display = "pkh()";
@@ -701,17 +698,13 @@ mod tests {
             assert_eq!(display, expected);
         }
 
-        let pkk_ms: Segwitv0Script = Miniscript {
-            node: Terminal::Check(Arc::new(Miniscript {
-                node: Terminal::PkK(pk),
-                ty: Type::from_pk_k::<Segwitv0>(),
-                ext: types::extra_props::ExtData::from_pk_k::<Segwitv0>(),
-                phantom: PhantomData,
-            })),
-            ty: Type::cast_check(Type::from_pk_k::<Segwitv0>()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_k::<Segwitv0>()).unwrap(),
+        let pkk_node = Terminal::Check(Arc::new(Miniscript {
+            node: Terminal::PkK(pk),
+            ty: Type::from_pk_k::<Segwitv0>(),
+            ext: types::extra_props::ExtData::from_pk_k::<Segwitv0>(),
             phantom: PhantomData,
-        };
+        }));
+        let pkk_ms: Segwitv0Script = Miniscript::from_ast(pkk_node).unwrap();
 
         script_rtt(
             pkk_ms,

src/policy/compiler.rs

@@ -7,7 +7,6 @@
 //!
 
 use core::convert::From;
-use core::marker::PhantomData;
 use core::{cmp, f64, fmt, hash, mem};
 #[cfg(feature = "std")]
 use std::error;
@@ -496,12 +495,7 @@ impl<Pk: MiniscriptKey, Ctx: ScriptContext> AstElemExt<Pk, Ctx> {
         let ext = types::ExtData::type_check(&ast, |_| None)?;
         let comp_ext_data = CompilerExtData::type_check(&ast, lookup_ext)?;
         Ok(AstElemExt {
-            ms: Arc::new(Miniscript {
-                ty,
-                ext,
-                node: ast,
-                phantom: PhantomData,
-            }),
+            ms: Arc::new(Miniscript::from_components_unchecked(ast, ty, ext)),
             comp_ext_data,
         })
     }
@@ -524,12 +518,7 @@ impl<Pk: MiniscriptKey, Ctx: ScriptContext> AstElemExt<Pk, Ctx> {
         let ext = types::ExtData::type_check(&ast, |_| None)?;
         let comp_ext_data = CompilerExtData::type_check(&ast, lookup_ext)?;
         Ok(AstElemExt {
-            ms: Arc::new(Miniscript {
-                ty,
-                ext,
-                node: ast,
-                phantom: PhantomData,
-            }),
+            ms: Arc::new(Miniscript::from_components_unchecked(ast, ty, ext)),
             comp_ext_data,
         })
     }
@@ -547,12 +536,11 @@ struct Cast<Pk: MiniscriptKey, Ctx: ScriptContext> {
 impl<Pk: MiniscriptKey, Ctx: ScriptContext> Cast<Pk, Ctx> {
     fn cast(&self, ast: &AstElemExt<Pk, Ctx>) -> Result<AstElemExt<Pk, Ctx>, ErrorKind> {
         Ok(AstElemExt {
-            ms: Arc::new(Miniscript {
-                ty: (self.ast_type)(ast.ms.ty)?,
-                ext: (self.ext_data)(ast.ms.ext)?,
-                node: (self.node)(Arc::clone(&ast.ms)),
-                phantom: PhantomData,
-            }),
+            ms: Arc::new(Miniscript::from_components_unchecked(
+                (self.node)(Arc::clone(&ast.ms)),
+                (self.ast_type)(ast.ms.ty)?,
+                (self.ext_data)(ast.ms.ext)?,
+            )),
             comp_ext_data: (self.comp_ext_data)(ast.comp_ext_data)?,
         })
     }