Merge #834: 12.x: fix CI

2019e97 ci: pin nightly compiler version (Andrew Poelstra)
22ce32a clippy: non-lifetime stuff (Andrew Poelstra)
9efc345 clippy: lifetime syntax stuff (Andrew Poelstra)
01bfd22 clippy.toml: bump up large error threshold (Andrew Poelstra)
d0e59e4 doc: fix broken link and stranded doccomment (Andrew Poelstra)

Pull request description:

  Should get us green CI, and pins the nightly compiler version so that it stays green.


ACKs for top commit:
  sanket1729:
    utACK 2019e97


Tree-SHA512: 8ea194dabb839b91a3897312334f56cae15735dc131594fadb10c9d8da2759c4e9581142d10e5b67f1136d3e7e67f2f0bd556fdfdbf3b1d246811ecffded26e8

Author: apoelstra

.github/workflows/rust.yml

@@ -9,6 +9,17 @@ on:   # yamllint disable-line rule:truthy
 name: Continuous integration
 
 jobs:
+  Prepare:
+    runs-on: ubuntu-24.04
+    outputs:
+      nightly_version: ${{ steps.read_toolchain.outputs.nightly_version }}
+    steps:
+      - name: "Checkout repo"
+        uses: actions/checkout@v4
+      - name: "Read nightly version"
+        id: read_toolchain
+        run: echo "nightly_version=$(cat nightly-version)" >> $GITHUB_OUTPUT
+
   Stable:                       # 2 jobs, one per lock file.
     name: Test - stable toolchain
     runs-on: ubuntu-latest
@@ -33,6 +44,7 @@ jobs:
 
   Nightly:                      # 2 jobs, one per lock file.
     name: Test - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -47,7 +59,9 @@ jobs:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Set dependencies"
         run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
       - name: "Run test script"
@@ -79,6 +93,7 @@ jobs:
 
   Lint:
     name: Lint - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -93,7 +108,9 @@ jobs:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Install clippy"
         run: rustup component add clippy
       - name: "Set dependencies"
@@ -125,6 +142,7 @@ jobs:
 
   Docsrs:
     name: Docs - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -139,7 +157,9 @@ jobs:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Set dependencies"
         run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
       - name: "Run test script"
@@ -198,6 +218,7 @@ jobs:
         run: ./contrib/integration_test.sh
 
   Embedded:
+    needs: Prepare
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -208,7 +229,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
           override: true
           components: rust-src
           target: thumbv7m-none-eabi

clippy.toml

@@ -1,3 +1,3 @@
 msrv = "1.56.1"
 # plan API returns Self as an error type for an large-ish enum
-large-error-threshold = 256
+large-error-threshold = 512

nightly-version

@@ -0,0 +1 @@
+nightly-2025-03-21

src/descriptor/mod.rs

@@ -648,7 +648,7 @@ impl Descriptor<DescriptorPublicKey> {
     /// See [`at_derivation_index`] and `[derived_descriptor`] for more documentation.
     ///
     /// [`at_derivation_index`]: Self::at_derivation_index
-    /// [`derived_descriptor`]: crate::DerivedDescriptor::derived_descriptor
+    /// [`derived_descriptor`]: crate::Descriptor::derived_descriptor
     ///
     /// # Errors
     ///

src/descriptor/tr.rs

@@ -129,7 +129,7 @@ impl<Pk: MiniscriptKey> TapTree<Pk> {
 
     /// Iterates over all miniscripts in DFS walk order compatible with the
     /// PSBT requirements (BIP 371).
-    pub fn iter(&self) -> TapTreeIter<Pk> { TapTreeIter { stack: vec![(0, self)] } }
+    pub fn iter(&self) -> TapTreeIter<'_, Pk> { TapTreeIter { stack: vec![(0, self)] } }
 
     // Helper function to translate keys
     fn translate_helper<T, Q, E>(&self, t: &mut T) -> Result<TapTree<Q>, TranslateErr<E>>
@@ -196,7 +196,7 @@ impl<Pk: MiniscriptKey> Tr<Pk> {
 
     /// Iterate over all scripts in merkle tree. If there is no script path, the iterator
     /// yields [`None`]
-    pub fn iter_scripts(&self) -> TapTreeIter<Pk> {
+    pub fn iter_scripts(&self) -> TapTreeIter<'_, Pk> {
         match self.tree {
             Some(ref t) => t.iter(),
             None => TapTreeIter { stack: vec![] },
@@ -565,7 +565,7 @@ impl<Pk: MiniscriptKey> fmt::Display for Tr<Pk> {
 }
 
 // Helper function to parse string into miniscript tree form
-fn parse_tr_tree(s: &str) -> Result<expression::Tree, Error> {
+fn parse_tr_tree(s: &str) -> Result<expression::Tree<'_>, Error> {
     expression::check_valid_chars(s)?;
 
     if s.len() > 3 && &s[..3] == "tr(" && s.as_bytes()[s.len() - 1] == b')' {

src/iter/mod.rs

@@ -17,7 +17,7 @@ pub use tree::{
 use crate::sync::Arc;
 use crate::{Miniscript, MiniscriptKey, ScriptContext, Terminal};
 
-impl<'a, Pk: MiniscriptKey, Ctx: ScriptContext> TreeLike for &'a Miniscript<Pk, Ctx> {
+impl<Pk: MiniscriptKey, Ctx: ScriptContext> TreeLike for &'_ Miniscript<Pk, Ctx> {
     fn as_node(&self) -> Tree<Self> {
         use Terminal::*;
         match self.node {

src/lib.rs

@@ -401,16 +401,6 @@ where
         T: Translator<P, Q, E>;
 }
 
-/// Either a key or keyhash, but both contain Pk
-// pub struct ForEach<'a, Pk: MiniscriptKey>(&'a Pk);
-
-// impl<'a, Pk: MiniscriptKey<Hash = Pk>> ForEach<'a, Pk> {
-//     /// Convenience method to avoid distinguishing between keys and hashes when these are the same type
-//     pub fn as_key(&self) -> &'a Pk {
-//         self.0
-//     }
-// }
-
 /// Trait describing the ability to iterate over every key
 pub trait ForEachKey<Pk: MiniscriptKey> {
     /// Run a predicate on every key in the descriptor, returning whether

src/miniscript/analyzable.rs

@@ -17,11 +17,8 @@ use crate::{Miniscript, MiniscriptKey, ScriptContext, Terminal};
 ///
 /// This allows parsing miniscripts if
 /// 1. It is unsafe(does not require a digital signature to spend it)
-/// 2. It contains a unspendable path because of either
-///     a. Resource limitations
-///     b. Timelock Mixing
-/// 3. The script is malleable and thereby some of satisfaction weight
-///    guarantees are not satisfied.
+/// 2. It contains a unspendable path because of either resource limitations or timelock mixing.
+/// 3. The script is malleable and thereby some of satisfaction weight guarantees are not satisfied.
 /// 4. It has repeated public keys
 /// 5. raw pkh fragments without the pk. This could be obtained when parsing miniscript from script
 #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Default, Hash)]
@@ -123,11 +120,8 @@ impl ExtParams {
 /// Possible reasons Miniscript guarantees can fail
 /// We currently mark Miniscript as Non-Analyzable if
 /// 1. It is unsafe(does not require a digital signature to spend it)
-/// 2. It contains a unspendable path because of either
-///     a. Resource limitations
-///     b. Timelock Mixing
-/// 3. The script is malleable and thereby some of satisfaction weight
-///    guarantees are not satisfied.
+/// 2. It contains a unspendable path because of either resource limitations or timelock mixing.
+/// 3. The script is malleable and thereby some of satisfaction weight guarantees are not satisfied.
 /// 4. It has repeated publickeys
 #[derive(Debug, PartialEq)]
 pub enum AnalysisError {

src/miniscript/iter.rs

@@ -18,12 +18,12 @@ impl<Pk: MiniscriptKey, Ctx: ScriptContext> Miniscript<Pk, Ctx> {
     /// Creates a new [Iter] iterator that will iterate over all [Miniscript] items within
     /// AST by traversing its branches. For the specific algorithm please see
     /// [Iter::next] function.
-    pub fn iter(&self) -> Iter<Pk, Ctx> { Iter::new(self) }
+    pub fn iter(&self) -> Iter<'_, Pk, Ctx> { Iter::new(self) }
 
     /// Creates a new [PkIter] iterator that will iterate over all plain public keys (and not
     /// key hash values) present in [Miniscript] items within AST by traversing all its branches.
     /// For the specific algorithm please see [PkIter::next] function.
-    pub fn iter_pk(&self) -> PkIter<Pk, Ctx> { PkIter::new(self) }
+    pub fn iter_pk(&self) -> PkIter<'_, Pk, Ctx> { PkIter::new(self) }
 
     /// Enumerates all child nodes of the current AST node (`self`) and returns a `Vec` referencing
     /// them.

src/miniscript/lex.rs

@@ -75,7 +75,7 @@ impl<'s> TokenIter<'s> {
     pub fn new(v: Vec<Token<'s>>) -> TokenIter<'s> { TokenIter(v) }
 
     /// Look at the top at Iterator
-    pub fn peek(&self) -> Option<&'s Token> { self.0.last() }
+    pub fn peek(&self) -> Option<&'s Token<'_>> { self.0.last() }
 
     /// Push a value to the iterator
     /// This will be first value consumed by popun_