refactor: rename plan and plan_mall to have into_ prefix

These functions consume `self`, therefore they should be prefixed with `into_`.
The old functions are now deprecated.

Author: trevarj

bitcoind-tests/tests/test_desc.rs

@@ -475,7 +475,7 @@ fn test_plan_satisfy(
 
     let plan = definite_desc
         .clone()
-        .plan(&assets)
+        .into_plan(&assets)
         .expect("plan creation failed");
 
     let mut unsigned_tx = Transaction {

src/descriptor/mod.rs

@@ -556,8 +556,20 @@ impl<Pk: MiniscriptKey + ToPublicKey> Descriptor<Pk> {
     /// Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction
     ///
     /// If the assets aren't sufficient for generating a Plan, the descriptor is returned
+    #[deprecated(since = "13.0.0", note = "use into_plan instead")]
     #[allow(clippy::result_large_err)] // our "error type" is the original descriptor
     pub fn plan<P>(self, provider: &P) -> Result<Plan<Pk>, Self>
+    where
+        P: AssetProvider<Pk>,
+    {
+        self.into_plan(provider)
+    }
+
+    /// Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction
+    ///
+    /// If the assets aren't sufficient for generating a Plan, the descriptor is returned
+    #[allow(clippy::result_large_err)] // our "error type" is the original descriptor
+    pub fn into_plan<P>(self, provider: &P) -> Result<Plan<Pk>, Self>
     where
         P: AssetProvider<Pk>,
     {
@@ -585,8 +597,20 @@ impl<Pk: MiniscriptKey + ToPublicKey> Descriptor<Pk> {
     /// Returns a plan if the provided assets are sufficient to produce a malleable satisfaction
     ///
     /// If the assets aren't sufficient for generating a Plan, the descriptor is returned
+    #[deprecated(since = "13.0.0", note = "use into_plan_mall instead")]
     #[allow(clippy::result_large_err)] // our "error type" is the original descriptor
     pub fn plan_mall<P>(self, provider: &P) -> Result<Plan<Pk>, Self>
+    where
+        P: AssetProvider<Pk>,
+    {
+        self.into_plan_mall(provider)
+    }
+
+    /// Returns a plan if the provided assets are sufficient to produce a malleable satisfaction
+    ///
+    /// If the assets aren't sufficient for generating a Plan, the descriptor is returned
+    #[allow(clippy::result_large_err)] // our "error type" is the original descriptor
+    pub fn into_plan_mall<P>(self, provider: &P) -> Result<Plan<Pk>, Self>
     where
         P: AssetProvider<Pk>,
     {

src/plan.rs

@@ -766,7 +766,7 @@ mod test {
                 assets = assets.add(hashes[hi]);
             }
 
-            let result = desc.clone().plan(&assets);
+            let result = desc.clone().into_plan(&assets);
             assert_eq!(
                 result.as_ref().ok().map(|plan| plan.satisfaction_weight()),
                 expected,
@@ -1105,7 +1105,7 @@ mod test {
         let mut psbt_input = bitcoin::psbt::Input::default();
         let assets = Assets::new().add(internal_key);
         desc.clone()
-            .plan(&assets)
+            .into_plan(&assets)
             .unwrap()
             .update_psbt_input(&mut psbt_input);
         assert!(psbt_input.tap_internal_key.is_some(), "Internal key is missing");
@@ -1116,7 +1116,7 @@ mod test {
         let mut psbt_input = bitcoin::psbt::Input::default();
         let assets = Assets::new().add(first_branch);
         desc.clone()
-            .plan(&assets)
+            .into_plan(&assets)
             .unwrap()
             .update_psbt_input(&mut psbt_input);
         assert!(psbt_input.tap_internal_key.is_none(), "Internal key is present");
@@ -1126,7 +1126,7 @@ mod test {
 
         let mut psbt_input = bitcoin::psbt::Input::default();
         let assets = Assets::new().add(second_branch);
-        desc.plan(&assets)
+        desc.into_plan(&assets)
             .unwrap()
             .update_psbt_input(&mut psbt_input);
         assert!(psbt_input.tap_internal_key.is_none(), "Internal key is present");
@@ -1149,7 +1149,7 @@ mod test {
 
         let mut psbt_input = bitcoin::psbt::Input::default();
         let assets = Assets::new().add(asset_key);
-        desc.plan(&assets)
+        desc.into_plan(&assets)
             .unwrap()
             .update_psbt_input(&mut psbt_input);
         assert!(psbt_input.witness_script.is_some(), "Witness script missing");
@@ -1202,7 +1202,7 @@ mod test {
             assets = assets.add(DescriptorPublicKey::from_str(&pk.to_string()).unwrap());
         }
 
-        let plan = desc.plan(&assets).expect("plan should succeed");
+        let plan = desc.into_plan(&assets).expect("plan should succeed");
 
         let (witness, script_sig) = plan.satisfy(&satisfier).expect("satisfy should succeed");
         assert_eq!(witness.last().unwrap(), &exp_witness_script.into_bytes());