refactor!: remove policy module and related code

As policy is anyway being phased out in 3.0

Author: 110CodingP

examples/policy.rs

@@ -12,9 +12,9 @@
 extern crate bdk_wallet;
 use std::error::Error;
 
-use bdk_wallet::bitcoin::Network;
-use bdk_wallet::descriptor::{policy::BuildSatisfaction, ExtractPolicy, IntoWalletDescriptor};
-use bdk_wallet::signer::SignersContainer;
+// use bdk_wallet::bitcoin::Network;
+// use bdk_wallet::descriptor::{policy::BuildSatisfaction, ExtractPolicy, IntoWalletDescriptor};
+// use bdk_wallet::signer::SignersContainer;
 
 /// This example describes the use of the BDK's [`bdk_wallet::descriptor::policy`] module.
 ///
@@ -27,34 +27,38 @@ use bdk_wallet::signer::SignersContainer;
 /// wallet holds one of the Extend Private key.
 #[allow(clippy::print_stdout)]
 fn main() -> Result<(), Box<dyn Error>> {
-    let secp = bitcoin::secp256k1::Secp256k1::new();
-
-    // The descriptor used in the example
-    // The form is "wsh(multi(2, <privkey>, <pubkey>))"
-    let desc = "wsh(multi(2,tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcLNfjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/*,tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/1/*))";
-
-    // Use the descriptor string to derive the full descriptor and a keymap.
-    // The wallet descriptor can be used to create a new bdk_wallet::wallet.
-    // While the `keymap` can be used to create a `SignerContainer`.
-    //
-    // The `SignerContainer` can sign for `PSBT`s.
-    // a `bdk_wallet::Wallet` internally uses these to handle transaction signing.
-    // But they can be used as independent tools also.
-    let (wallet_desc, keymap) = desc.into_wallet_descriptor(&secp, Network::Testnet)?;
-
-    println!("Example Descriptor for policy analysis : {wallet_desc}");
-
-    // Create the signer with the keymap and descriptor.
-    let signers_container = SignersContainer::build(keymap, &wallet_desc, &secp);
-
-    // Extract the Policy from the given descriptor and signer.
-    // Note that Policy is a wallet specific structure. It depends on the the descriptor, and
-    // what the concerned wallet with a given signer can sign for.
-    let policy = wallet_desc
-        .extract_policy(&signers_container, BuildSatisfaction::None, &secp)?
-        .expect("We expect a policy");
-
-    println!("Derived Policy for the descriptor {policy:#?}");
+    // let secp = bitcoin::secp256k1::Secp256k1::new();
+
+    // // The descriptor used in the example
+    // // The form is "wsh(multi(2, <privkey>, <pubkey>))"
+    // let desc =
+    // "wsh(multi(2,
+    // tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcLNfjdi5qUvw3VDfgYiH5mNsj5izuiu2N/
+    // 1/*,tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/
+    // 1/*))";
+
+    // // Use the descriptor string to derive the full descriptor and a keymap.
+    // // The wallet descriptor can be used to create a new bdk_wallet::wallet.
+    // // While the `keymap` can be used to create a `SignerContainer`.
+    // //
+    // // The `SignerContainer` can sign for `PSBT`s.
+    // // a `bdk_wallet::Wallet` internally uses these to handle transaction signing.
+    // // But they can be used as independent tools also.
+    // let (wallet_desc, keymap) = desc.into_wallet_descriptor(&secp, Network::Testnet)?;
+
+    // println!("Example Descriptor for policy analysis : {wallet_desc}");
+
+    // // Create the signer with the keymap and descriptor.
+    // let signers_container = SignersContainer::build(keymap, &wallet_desc, &secp);
+
+    // // Extract the Policy from the given descriptor and signer.
+    // // Note that Policy is a wallet specific structure. It depends on the the descriptor, and
+    // // what the concerned wallet with a given signer can sign for.
+    // let policy = wallet_desc
+    //     .extract_policy(&signers_container, BuildSatisfaction::None, &secp)?
+    //     .expect("We expect a policy");
+
+    // println!("Derived Policy for the descriptor {policy:#?}");
 
     Ok(())
 }

src/descriptor/error.rs

@@ -26,8 +26,8 @@ pub enum Error {
     MultiPath,
     /// Error thrown while working with [`keys`](crate::keys)
     Key(crate::keys::KeyError),
-    /// Error while extracting and manipulating policies
-    Policy(crate::descriptor::policy::PolicyError),
+    // /// Error while extracting and manipulating policies
+    // Policy(crate::descriptor::policy::PolicyError),
 
     /// Invalid byte found in the descriptor checksum
     InvalidDescriptorCharacter(u8),
@@ -72,7 +72,7 @@ impl fmt::Display for Error {
                 "The descriptor contains multipath keys with invalid number of paths (must have exactly 2 paths for receive and change)"
             ),
             Self::Key(err) => write!(f, "Key error: {err}"),
-            Self::Policy(err) => write!(f, "Policy error: {err}"),
+            // Self::Policy(err) => write!(f, "Policy error: {err}"),
             Self::InvalidDescriptorCharacter(char) => {
                 write!(f, "Invalid descriptor character: {char}")
             }
@@ -120,9 +120,3 @@ impl From<bitcoin::hex::HexToBytesError> for Error {
         Error::Hex(err)
     }
 }
-
-impl From<crate::descriptor::policy::PolicyError> for Error {
-    fn from(err: crate::descriptor::policy::PolicyError) -> Self {
-        Error::Policy(err)
-    }
-}

src/descriptor/mod.rs

@@ -33,18 +33,18 @@ pub use miniscript::{
 };
 use miniscript::{ForEachKey, MiniscriptKey, TranslatePk};
 
-use crate::descriptor::policy::BuildSatisfaction;
+// use crate::descriptor::policy::BuildSatisfaction;
 
 pub mod checksum;
 #[doc(hidden)]
 pub mod dsl;
 pub mod error;
-pub mod policy;
+// pub mod policy;
 pub mod template;
 
 pub use self::checksum::calc_checksum;
 pub use self::error::Error as DescriptorError;
-pub use self::policy::Policy;
+// pub use self::policy::Policy;
 use self::template::DescriptorTemplateOut;
 use crate::keys::{IntoDescriptorKey, KeyError};
 use crate::wallet::signer::SignersContainer;
@@ -343,16 +343,16 @@ impl<Ctx: miniscript::ScriptContext, Pk: miniscript::MiniscriptKey> CheckMiniscr
     }
 }
 
-/// Trait implemented on [`Descriptor`]s to add a method to extract the spending [`policy`]
-pub trait ExtractPolicy {
-    /// Extract the spending [`policy`]
-    fn extract_policy(
-        &self,
-        signers: &SignersContainer,
-        psbt: BuildSatisfaction,
-        secp: &SecpCtx,
-    ) -> Result<Option<Policy>, DescriptorError>;
-}
+// /// Trait implemented on [`Descriptor`]s to add a method to extract the spending [`policy`]
+// pub trait ExtractPolicy {
+//     /// Extract the spending [`policy`]
+//     fn extract_policy(
+//         &self,
+//         signers: &SignersContainer,
+//         psbt: BuildSatisfaction,
+//         secp: &SecpCtx,
+//     ) -> Result<Option<Policy>, DescriptorError>;
+// }
 
 pub(crate) trait XKeyUtils {
     fn root_fingerprint(&self, secp: &SecpCtx) -> Fingerprint;