Merge rust-bitcoin/rust-miniscript#340: SigType check for cost-analysis in SegwitV1 scripts

heap-coder · heap-coder · commit b01e48f2a975 · 2022-05-19T11:20:16.000-07:00
52d66477274e9afa770fdb61f53ec8b13f68d750 Add SigType check in CompilerExtData for deciding key byte-lengths (Aman Rojjha)

Pull request description:

  Previously, the struct `CompilerExtData` provided cost analysis for a given script considering the **SegwitV0** standards. This PR aims to track the type/ (context) of the script and provide the respective cost analysis.

ACKs for top commit:
  sanket1729:
    ACK 52d66477274e9afa770fdb61f53ec8b13f68d750

Tree-SHA512: 55f9ac4fb0de151fa3613195494d9c9fd7ba7e0e1982a0494d510a8f38e939a15d7b7a210ecccfed04af0947d2208e4edea501e2b93dfa220320c0a279cf65bd
diff --git a/src/miniscript/mod.rs b/src/miniscript/mod.rs
@@ -654,38 +654,38 @@ mod tests {
         let pkk_ms: Miniscript<DummyKey, Segwitv0> = Miniscript {
             node: Terminal::Check(Arc::new(Miniscript {
                 node: Terminal::PkK(DummyKey),
-                ty: Type::from_pk_k(),
-                ext: types::extra_props::ExtData::from_pk_k(),
+                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()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_k()).unwrap(),
+            ty: Type::cast_check(Type::from_pk_k::<Segwitv0>()).unwrap(),
+            ext: ExtData::cast_check(ExtData::from_pk_k::<Segwitv0>()).unwrap(),
             phantom: PhantomData,
         };
         string_rtt(pkk_ms, "[B/onduesm]c:[K/onduesm]pk_k(DummyKey)", "pk()");
 
         let pkh_ms: Miniscript<DummyKey, Segwitv0> = Miniscript {
             node: Terminal::Check(Arc::new(Miniscript {
                 node: Terminal::PkH(DummyKeyHash),
-                ty: Type::from_pk_h(),
-                ext: types::extra_props::ExtData::from_pk_h(),
+                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()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_h()).unwrap(),
+            ty: Type::cast_check(Type::from_pk_h::<Segwitv0>()).unwrap(),
+            ext: ExtData::cast_check(ExtData::from_pk_h::<Segwitv0>()).unwrap(),
             phantom: PhantomData,
         };
         string_rtt(pkh_ms, "[B/nduesm]c:[K/nduesm]pk_h(DummyKeyHash)", "pkh()");
 
         let pkk_ms: Segwitv0Script = Miniscript {
             node: Terminal::Check(Arc::new(Miniscript {
                 node: Terminal::PkK(pk),
-                ty: Type::from_pk_k(),
-                ext: types::extra_props::ExtData::from_pk_k(),
+                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()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_k()).unwrap(),
+            ty: Type::cast_check(Type::from_pk_k::<Segwitv0>()).unwrap(),
+            ext: ExtData::cast_check(ExtData::from_pk_k::<Segwitv0>()).unwrap(),
             phantom: PhantomData,
         };
 
@@ -698,12 +698,12 @@ mod tests {
         let pkh_ms: Segwitv0Script = Miniscript {
             node: Terminal::Check(Arc::new(Miniscript {
                 node: Terminal::PkH(hash),
-                ty: Type::from_pk_h(),
-                ext: types::extra_props::ExtData::from_pk_h(),
+                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()).unwrap(),
-            ext: ExtData::cast_check(ExtData::from_pk_h()).unwrap(),
+            ty: Type::cast_check(Type::from_pk_h::<Segwitv0>()).unwrap(),
+            ext: ExtData::cast_check(ExtData::from_pk_h::<Segwitv0>()).unwrap(),
             phantom: PhantomData,
         };
 
diff --git a/src/miniscript/types/correctness.rs b/src/miniscript/types/correctness.rs
@@ -15,6 +15,7 @@
 //! Correctness/Soundness type properties
 
 use super::{ErrorKind, Property};
+use crate::ScriptContext;
 
 /// Basic type representing where the fragment can go
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
@@ -142,7 +143,7 @@ impl Property for Correctness {
         }
     }
 
-    fn from_pk_k() -> Self {
+    fn from_pk_k<Ctx: ScriptContext>() -> Self {
         Correctness {
             base: Base::K,
             input: Input::OneNonZero,
@@ -151,7 +152,7 @@ impl Property for Correctness {
         }
     }
 
-    fn from_pk_h() -> Self {
+    fn from_pk_h<Ctx: ScriptContext>() -> Self {
         Correctness {
             base: Base::K,
             input: Input::AnyNonZero,
diff --git a/src/miniscript/types/extra_props.rs b/src/miniscript/types/extra_props.rs
@@ -5,6 +5,7 @@ use std::cmp;
 use std::iter::once;
 
 use super::{Error, ErrorKind, Property, ScriptContext};
+use crate::miniscript::context::SigType;
 use crate::miniscript::limits::{
     HEIGHT_TIME_THRESHOLD, SEQUENCE_LOCKTIME_DISABLE_FLAG, SEQUENCE_LOCKTIME_TYPE_FLAG,
 };
@@ -183,30 +184,42 @@ impl Property for ExtData {
         }
     }
 
-    fn from_pk_k() -> Self {
+    fn from_pk_k<Ctx: ScriptContext>() -> Self {
         ExtData {
-            pk_cost: 34,
+            pk_cost: match Ctx::sig_type() {
+                SigType::Ecdsa => 34,
+                SigType::Schnorr => 33,
+            },
             has_free_verify: false,
             ops: OpLimits::new(0, Some(0), Some(0)),
             stack_elem_count_sat: Some(1),
             stack_elem_count_dissat: Some(1),
-            max_sat_size: Some((73, 73)),
+            max_sat_size: match Ctx::sig_type() {
+                SigType::Ecdsa => Some((73, 73)),
+                SigType::Schnorr => Some((66, 66)),
+            },
             max_dissat_size: Some((1, 1)),
             timelock_info: TimeLockInfo::default(),
             exec_stack_elem_count_sat: Some(1), // pushes the pk
             exec_stack_elem_count_dissat: Some(1),
         }
     }
 
-    fn from_pk_h() -> Self {
+    fn from_pk_h<Ctx: ScriptContext>() -> Self {
         ExtData {
             pk_cost: 24,
             has_free_verify: false,
             ops: OpLimits::new(3, Some(0), Some(0)),
             stack_elem_count_sat: Some(2),
             stack_elem_count_dissat: Some(2),
-            max_sat_size: Some((34 + 73, 34 + 73)),
-            max_dissat_size: Some((35, 35)),
+            max_sat_size: match Ctx::sig_type() {
+                SigType::Ecdsa => Some((34 + 73, 34 + 73)),
+                SigType::Schnorr => Some((66 + 33, 33 + 66)),
+            },
+            max_dissat_size: match Ctx::sig_type() {
+                SigType::Ecdsa => Some((35, 35)),
+                SigType::Schnorr => Some((34, 34)),
+            },
             timelock_info: TimeLockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // dup and hash push
             exec_stack_elem_count_dissat: Some(2),
@@ -244,7 +257,7 @@ impl Property for ExtData {
             (false, false) => 2,
         };
         ExtData {
-            pk_cost: num_cost + 33 * n /*pks*/ + (n-1) /*checksigadds*/ + 1,
+            pk_cost: num_cost + 33 * n /*pks*/ + (n - 1) /*checksigadds*/ + 1,
             has_free_verify: true,
             // These numbers are irrelevant here are there is no op limit in tapscript
             ops: OpLimits::new(n, Some(0), Some(0)),
@@ -903,8 +916,8 @@ impl Property for ExtData {
         let ret = match *fragment {
             Terminal::True => Ok(Self::from_true()),
             Terminal::False => Ok(Self::from_false()),
-            Terminal::PkK(..) => Ok(Self::from_pk_k()),
-            Terminal::PkH(..) => Ok(Self::from_pk_h()),
+            Terminal::PkK(..) => Ok(Self::from_pk_k::<Ctx>()),
+            Terminal::PkH(..) => Ok(Self::from_pk_h::<Ctx>()),
             Terminal::Multi(k, ref pks) | Terminal::MultiA(k, ref pks) => {
                 if k == 0 {
                     return Err(Error {
diff --git a/src/miniscript/types/malleability.rs b/src/miniscript/types/malleability.rs
@@ -15,6 +15,7 @@
 //! Malleability-related Type properties
 
 use super::{ErrorKind, Property};
+use crate::ScriptContext;
 
 /// Whether the fragment has a dissatisfaction, and if so, whether
 /// it is unique. Affects both correctness and malleability-freeness,
@@ -94,15 +95,15 @@ impl Property for Malleability {
         }
     }
 
-    fn from_pk_k() -> Self {
+    fn from_pk_k<Ctx: ScriptContext>() -> Self {
         Malleability {
             dissat: Dissat::Unique,
             safe: true,
             non_malleable: true,
         }
     }
 
-    fn from_pk_h() -> Self {
+    fn from_pk_h<Ctx: ScriptContext>() -> Self {
         Malleability {
             dissat: Dissat::Unique,
             safe: true,
diff --git a/src/miniscript/types/mod.rs b/src/miniscript/types/mod.rs
@@ -258,10 +258,10 @@ pub trait Property: Sized {
     fn from_false() -> Self;
 
     /// Type property of the `PkK` fragment
-    fn from_pk_k() -> Self;
+    fn from_pk_k<Ctx: ScriptContext>() -> Self;
 
     /// Type property of the `PkH` fragment
-    fn from_pk_h() -> Self;
+    fn from_pk_h<Ctx: ScriptContext>() -> Self;
 
     /// Type property of a `Multi` fragment
     fn from_multi(k: usize, n: usize) -> Self;
@@ -413,8 +413,8 @@ pub trait Property: Sized {
         let ret = match *fragment {
             Terminal::True => Ok(Self::from_true()),
             Terminal::False => Ok(Self::from_false()),
-            Terminal::PkK(..) => Ok(Self::from_pk_k()),
-            Terminal::PkH(..) => Ok(Self::from_pk_h()),
+            Terminal::PkK(..) => Ok(Self::from_pk_k::<Ctx>()),
+            Terminal::PkH(..) => Ok(Self::from_pk_h::<Ctx>()),
             Terminal::Multi(k, ref pks) | Terminal::MultiA(k, ref pks) => {
                 if k == 0 {
                     return Err(Error {
@@ -562,17 +562,17 @@ impl Property for Type {
         }
     }
 
-    fn from_pk_k() -> Self {
+    fn from_pk_k<Ctx: ScriptContext>() -> Self {
         Type {
-            corr: Property::from_pk_k(),
-            mall: Property::from_pk_k(),
+            corr: Property::from_pk_k::<Ctx>(),
+            mall: Property::from_pk_k::<Ctx>(),
         }
     }
 
-    fn from_pk_h() -> Self {
+    fn from_pk_h<Ctx: ScriptContext>() -> Self {
         Type {
-            corr: Property::from_pk_h(),
-            mall: Property::from_pk_h(),
+            corr: Property::from_pk_h::<Ctx>(),
+            mall: Property::from_pk_h::<Ctx>(),
         }
     }
 
@@ -796,8 +796,8 @@ impl Property for Type {
         let ret = match *fragment {
             Terminal::True => Ok(Self::from_true()),
             Terminal::False => Ok(Self::from_false()),
-            Terminal::PkK(..) => Ok(Self::from_pk_k()),
-            Terminal::PkH(..) => Ok(Self::from_pk_h()),
+            Terminal::PkK(..) => Ok(Self::from_pk_k::<Ctx>()),
+            Terminal::PkH(..) => Ok(Self::from_pk_h::<Ctx>()),
             Terminal::Multi(k, ref pks) | Terminal::MultiA(k, ref pks) => {
                 if k == 0 {
                     return Err(Error {
diff --git a/src/policy/compiler.rs b/src/policy/compiler.rs
@@ -24,6 +24,7 @@ use std::marker::PhantomData;
 use std::sync::Arc;
 use std::{cmp, error, f64, fmt, hash, mem};
 
+use crate::miniscript::context::SigType;
 use crate::miniscript::limits::MAX_PUBKEYS_PER_MULTISIG;
 use crate::miniscript::types::{self, ErrorKind, ExtData, Property, Type};
 use crate::miniscript::ScriptContext;
@@ -165,19 +166,30 @@ impl Property for CompilerExtData {
         }
     }
 
-    fn from_pk_k() -> Self {
+    fn from_pk_k<Ctx: ScriptContext>() -> Self {
         CompilerExtData {
             branch_prob: None,
-            sat_cost: 73.0,
+            sat_cost: match Ctx::sig_type() {
+                SigType::Ecdsa => 73.0,
+                SigType::Schnorr => 1.0 /* <var_int> */ + 64.0 /* sig */ + 1.0, /* <sighash_type> */
+            },
             dissat_cost: Some(1.0),
         }
     }
 
-    fn from_pk_h() -> Self {
+    fn from_pk_h<Ctx: ScriptContext>() -> Self {
         CompilerExtData {
             branch_prob: None,
-            sat_cost: 73.0 + 34.0,
-            dissat_cost: Some(1.0 + 34.0),
+            sat_cost: match Ctx::sig_type() {
+                SigType::Ecdsa => 73.0 + 34.0,
+                SigType::Schnorr => 66.0 + 33.0,
+            },
+            dissat_cost: Some(
+                1.0 + match Ctx::sig_type() {
+                    SigType::Ecdsa => 34.0,
+                    SigType::Schnorr => 33.0,
+                },
+            ),
         }
     }
 
@@ -189,6 +201,14 @@ impl Property for CompilerExtData {
         }
     }
 
+    fn from_multi_a(k: usize, n: usize) -> Self {
+        CompilerExtData {
+            branch_prob: None,
+            sat_cost: 66.0 * k as f64 + (n - k) as f64,
+            dissat_cost: Some(n as f64), /* <w_n> ... <w_1> := 0x00 ... 0x00 (n times) */
+        }
+    }
+
     fn from_hash() -> Self {
         CompilerExtData {
             branch_prob: None,
@@ -1258,7 +1278,7 @@ mod tests {
         let compilation: DummyTapAstElemExt =
             best_t(&mut BTreeMap::new(), &policy, 1.0, None).unwrap();
 
-        assert_eq!(compilation.cost_1d(1.0, None), 88.0 + 74.109375);
+        assert_eq!(compilation.cost_1d(1.0, None), 87.0 + 67.0390625);
         assert_eq!(
             policy.lift().unwrap().sorted(),
             compilation.ms.lift().unwrap().sorted()
@@ -1271,7 +1291,7 @@ mod tests {
         let compilation: DummyTapAstElemExt =
             best_t(&mut BTreeMap::new(), &policy, 1.0, None).unwrap();
 
-        assert_eq!(compilation.cost_1d(1.0, None), 438.0 + 299.4003295898438);
+        assert_eq!(compilation.cost_1d(1.0, None), 433.0 + 275.7909749348958);
         assert_eq!(
             policy.lift().unwrap().sorted(),
             compilation.ms.lift().unwrap().sorted()

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`//! Correctness/Soundness type properties`
`16`	`16`
`17`	`17`	`use super::{ErrorKind, Property};`
	`18`	`+use crate::ScriptContext;`
`18`	`19`
`19`	`20`	`/// Basic type representing where the fragment can go`
`20`	`21`	`#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]`
`@@ -142,7 +143,7 @@ impl Property for Correctness {`
`142`	`143`	`}`
`143`	`144`	`}`
`144`	`145`
`145`		`- fn from_pk_k() -> Self {`
	`146`	`+ fn from_pk_k<Ctx: ScriptContext>() -> Self {`
`146`	`147`	`Correctness {`
`147`	`148`	`base: Base::K,`
`148`	`149`	`input: Input::OneNonZero,`
`@@ -151,7 +152,7 @@ impl Property for Correctness {`
`151`	`152`	`}`
`152`	`153`	`}`
`153`	`154`
`154`		`- fn from_pk_h() -> Self {`
	`155`	`+ fn from_pk_h<Ctx: ScriptContext>() -> Self {`
`155`	`156`	`Correctness {`
`156`	`157`	`base: Base::K,`
`157`	`158`	`input: Input::AnyNonZero,`