Merge #707: 10.x backport

a4576ae Dead code fixes (Sanket Kanjalkar)
fd75028 release 10.1.0 (Andrew Poelstra)
26a9570 Add offending test case (Sanket Kanjalkar)
20b961a Track miniscript tree depth explicitly (Sanket Kanjalkar)
ab279b2 bug fix 10.x (Sanket Kanjalkar)

Pull request description:

ACKs for top commit:
  apoelstra:
    ACK a4576ae

Tree-SHA512: a2fd1d50b66c08672f98b115abd16049479878f969f0acd091f80d79e0d9ed84f4d78a6a8919d3751a2a189ad1fb355c932ee52e43fdc4a76fb101b931376772

Author: apoelstra

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 10.1.0 - July 9, 2024
+
+- Explicitly track recursion depth in fragments [#704](https://github.com/rust-bitcoin/rust-miniscript/pull/704)
+
 # 10.0.0 - May 24, 2023
 
 - Works with rust-bitcoin 0.30.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "miniscript"
-version = "10.0.0"
+version = "10.1.0"
 authors = ["Andrew Poelstra <[email protected]>, Sanket Kanjalkar <[email protected]>"]
 license = "CC0-1.0"
 homepage = "https://github.com/rust-bitcoin/rust-miniscript/"

src/lib.rs

@@ -117,7 +117,6 @@ mod macros;
 mod pub_macros;
 
 use internals::hex::exts::DisplayHex;
-pub use pub_macros::*;
 
 pub mod descriptor;
 pub mod expression;
@@ -899,6 +898,7 @@ mod tests {
     }
 }
 
+#[allow(unused_imports)] // this is an internal prelude module; not all imports are used with every feature combination
 mod prelude {
     // Mutex implementation from LDK
     // https://github.com/lightningdevkit/rust-lightning/blob/9bdce47f0e0516e37c89c09f1975dfc06b5870b1/lightning-invoice/src/sync.rs
@@ -962,10 +962,9 @@ mod prelude {
     };
     #[cfg(any(feature = "std", test))]
     pub use std::{
-        borrow::{Borrow, Cow, ToOwned},
+        borrow::{Borrow, ToOwned},
         boxed::Box,
         collections::{vec_deque::VecDeque, BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet},
-        rc, slice,
         string::{String, ToString},
         sync,
         sync::Mutex,

src/miniscript/mod.rs

@@ -139,6 +139,9 @@ pub struct ExtData {
     /// This does **not** include initial witness elements. This element only captures
     /// the additional elements that are pushed during execution.
     pub exec_stack_elem_count_dissat: Option<usize>,
+    /// The miniscript tree depth/height of this node.
+    /// Used for checking the max depth of the miniscript tree to prevent stack overflow.
+    pub tree_height: usize,
 }
 
 impl Property for ExtData {
@@ -165,6 +168,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(1),
             exec_stack_elem_count_dissat: None,
+            tree_height : 0,
         }
     }
 
@@ -180,6 +184,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: None,
             exec_stack_elem_count_dissat: Some(1),
+            tree_height : 0,
         }
     }
 
@@ -201,6 +206,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(1), // pushes the pk
             exec_stack_elem_count_dissat: Some(1),
+            tree_height: 0,
         }
     }
 
@@ -222,6 +228,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // dup and hash push
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -245,6 +252,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(n), // n pks
             exec_stack_elem_count_dissat: Some(n),
+            tree_height: 0,
         }
     }
 
@@ -267,6 +275,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // the two nums before num equal verify
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -287,6 +296,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // either size <32> or <hash256> <32 byte>
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -302,6 +312,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // either size <32> or <hash256> <32 byte>
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -317,6 +328,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // either size <32> or <hash256> <20 byte>
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -332,6 +344,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::default(),
             exec_stack_elem_count_sat: Some(2), // either size <32> or <hash256> <20 byte>
             exec_stack_elem_count_dissat: Some(2),
+            tree_height: 0,
         }
     }
 
@@ -357,6 +370,7 @@ impl Property for ExtData {
             },
             exec_stack_elem_count_sat: Some(1), // <t>
             exec_stack_elem_count_dissat: None,
+            tree_height: 0,
         }
     }
 
@@ -378,6 +392,7 @@ impl Property for ExtData {
             },
             exec_stack_elem_count_sat: Some(1), // <t>
             exec_stack_elem_count_dissat: None,
+            tree_height: 0,
         }
     }
 
@@ -393,6 +408,7 @@ impl Property for ExtData {
             timelock_info: self.timelock_info,
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: self.exec_stack_elem_count_dissat,
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -408,6 +424,7 @@ impl Property for ExtData {
             timelock_info: self.timelock_info,
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: self.exec_stack_elem_count_dissat,
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -423,6 +440,7 @@ impl Property for ExtData {
             timelock_info: self.timelock_info,
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: self.exec_stack_elem_count_dissat,
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -441,6 +459,7 @@ impl Property for ExtData {
             // Even all V types push something onto the stack and then remove them
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: Some(1),
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -457,6 +476,7 @@ impl Property for ExtData {
             timelock_info: self.timelock_info,
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: None,
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -472,6 +492,7 @@ impl Property for ExtData {
             timelock_info: self.timelock_info,
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: Some(1),
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -488,6 +509,7 @@ impl Property for ExtData {
             // Technically max(1, self.exec_stack_elem_count_sat), same rationale as cast_dupif
             exec_stack_elem_count_sat: self.exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat: self.exec_stack_elem_count_dissat,
+            tree_height : self.tree_height + 1,
         })
     }
 
@@ -528,6 +550,7 @@ impl Property for ExtData {
                 l.exec_stack_elem_count_dissat,
                 r.exec_stack_elem_count_dissat.map(|x| x + 1),
             ),
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         })
     }
 
@@ -555,6 +578,7 @@ impl Property for ExtData {
                 r.exec_stack_elem_count_sat,
             ),
             exec_stack_elem_count_dissat: None,
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         })
     }
 
@@ -603,6 +627,7 @@ impl Property for ExtData {
                 l.exec_stack_elem_count_dissat,
                 r.exec_stack_elem_count_dissat.map(|x| x + 1),
             ),
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         })
     }
 
@@ -640,6 +665,7 @@ impl Property for ExtData {
                 l.exec_stack_elem_count_dissat,
                 r.exec_stack_elem_count_dissat.map(|x| x + 1),
             ),
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         };
         Ok(res)
     }
@@ -671,6 +697,7 @@ impl Property for ExtData {
                 opt_max(r.exec_stack_elem_count_sat, l.exec_stack_elem_count_dissat),
             ),
             exec_stack_elem_count_dissat: None,
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         })
     }
 
@@ -717,6 +744,7 @@ impl Property for ExtData {
                 l.exec_stack_elem_count_dissat,
                 r.exec_stack_elem_count_dissat,
             ),
+            tree_height : cmp::max(l.tree_height, r.tree_height) + 1,
         })
     }
 
@@ -762,6 +790,7 @@ impl Property for ExtData {
                 a.exec_stack_elem_count_dissat,
                 c.exec_stack_elem_count_dissat,
             ),
+            tree_height : cmp::max(a.tree_height, cmp::max(b.tree_height, c.tree_height)) + 1,
         })
     }
 
@@ -781,6 +810,7 @@ impl Property for ExtData {
         // the max element count is same as max sat element count when satisfying one element + 1
         let mut exec_stack_elem_count_sat_vec = Vec::with_capacity(n);
         let mut exec_stack_elem_count_dissat = Some(0);
+        let mut max_child_height = 0;
 
         for i in 0..n {
             let sub = sub_ck(i)?;
@@ -814,6 +844,7 @@ impl Property for ExtData {
                 exec_stack_elem_count_dissat,
                 sub.exec_stack_elem_count_dissat,
             );
+            max_child_height = cmp::max(max_child_height, sub.tree_height) + 1;
         }
 
         stack_elem_count_sat_vec.sort_by(sat_minus_option_dissat);
@@ -885,6 +916,7 @@ impl Property for ExtData {
             timelock_info: TimelockInfo::combine_threshold(k, timelocks),
             exec_stack_elem_count_sat,
             exec_stack_elem_count_dissat,
+            tree_height : max_child_height + 1,
         })
     }
 

src/miniscript/types/extra_props.rs

@@ -1086,9 +1086,11 @@ impl PsbtFields for psbt::Input {
     ) -> &mut BTreeMap<bitcoin::key::XOnlyPublicKey, (Vec<TapLeafHash>, bip32::KeySource)> {
         &mut self.tap_key_origins
     }
+    #[allow(dead_code)]
     fn proprietary(&mut self) -> &mut BTreeMap<psbt::raw::ProprietaryKey, Vec<u8>> {
         &mut self.proprietary
     }
+    #[allow(dead_code)]
     fn unknown(&mut self) -> &mut BTreeMap<psbt::raw::Key, Vec<u8>> {
         &mut self.unknown
     }
@@ -1119,9 +1121,11 @@ impl PsbtFields for psbt::Output {
     ) -> &mut BTreeMap<bitcoin::key::XOnlyPublicKey, (Vec<TapLeafHash>, bip32::KeySource)> {
         &mut self.tap_key_origins
     }
+    #[allow(dead_code)]
     fn proprietary(&mut self) -> &mut BTreeMap<psbt::raw::ProprietaryKey, Vec<u8>> {
         &mut self.proprietary
     }
+    #[allow(dead_code)]
     fn unknown(&mut self) -> &mut BTreeMap<psbt::raw::Key, Vec<u8>> {
         &mut self.unknown
     }