fix(bip322): Re-enable bip322 feature

- update bdk_bip322 crate with replacement crate
bdk_message_signer
- re-enable bip322 feature
- update documentation for add_global_xpubs fn

Author: tvpeter

Cargo.lock

@@ -39,7 +39,7 @@ shlex = {  version = "1.3.0", optional = true }
 payjoin = { version = "0.25.0", features = ["v1", "v2", "io", "_test-utils"], optional = true}
 reqwest = { version = "0.13.2", default-features = false, features = ["rustls"], optional = true }
 url = { version = "2.5.8", optional = true }
-# bdk_bip322 = { version = "0.1.0", optional = true }
+bdk_message_signer = { version = "0.2.0", optional = true }
 bitcoin-payment-instructions = { version = "0.7.0", optional = true}
 
 [features]
@@ -61,7 +61,7 @@ dns_payment = ["bitcoin-payment-instructions"]
 
 # Internal features
 _payjoin-dependencies = ["payjoin", "reqwest", "url", "sqlite"]
-# bip322 = ["bdk_bip322"]
+bip322 = ["bdk_message_signer"]
 
 # Use this to consensus verify transactions at sync time
 verify = []

Cargo.toml

@@ -13,8 +13,8 @@
 //! All subcommands are defined in the below enums.
 
 #![allow(clippy::large_enum_variant)]
-// #[cfg(feature = "bip322")]
-// use crate::handlers::offline::{SignMessageCommand, VerifyMessageCommand};
+#[cfg(feature = "bip322")]
+use crate::handlers::offline::{SignMessageCommand, VerifyMessageCommand};
 use crate::handlers::{
     config::{ListWalletsCommand, SaveConfigCommand},
     descriptor::DescriptorCommand,
@@ -362,11 +362,11 @@ pub enum OfflineWalletSubCommand {
     /// Combines multiple PSBTs into one.
     CombinePsbt(CombinePsbtCommand),
     /// Sign a message using BIP322
-    // #[cfg(feature = "bip322")]
-    // SignMessage(SignMessageCommand),
+    #[cfg(feature = "bip322")]
+    SignMessage(SignMessageCommand),
     /// Verify a BIP322 signature
-    // #[cfg(feature = "bip322")]
-    // VerifyMessage(VerifyMessageCommand),
+    #[cfg(feature = "bip322")]
+    VerifyMessage(VerifyMessageCommand),
     /// Lock UTXO(s) so they're excluded from coin selection.
     LockUtxo(LockUtxoCommand),
     /// Unlock previously locked UTXO(s).

src/commands.rs

@@ -155,9 +155,9 @@ pub enum BDKCliError {
     #[cfg(feature = "payjoin")]
     #[error("Payjoin database error: {0}")]
     PayjoinDb(#[from] crate::handlers::payjoin::db::Error),
-    // #[cfg(feature = "bip322")]
-    // #[error("BIP-322 error: {0}")]
-    // Bip322Error(#[from] bdk_bip322::error::Error),
+    #[cfg(feature = "bip322")]
+    #[error("BIP-322 error: {0}")]
+    Bip322Error(#[from] bdk_message_signer::error::Error),
 }
 
 impl From<ExtractTxError> for BDKCliError {

src/error.rs

@@ -28,12 +28,12 @@ use {
     bdk_wallet::keys::{DescriptorPublicKey, DescriptorSecretKey, SinglePubKey},
     std::collections::HashMap,
 };
-// #[cfg(feature = "bip322")]
-// use {
-//     crate::utils::parse_signature_format,
-//     crate::utils::types::MessageResult,
-//     bdk_bip322::{BIP322, MessageProof},
-// };
+#[cfg(feature = "bip322")]
+use {
+    crate::utils::parse_signature_format,
+    crate::utils::types::MessageResult,
+    bdk_message_signer::{MessageProof, MessageSigner},
+};
 
 impl OfflineWalletSubCommand {
     pub fn execute(&self, ctx: &mut AppContext<OfflineOperations<'_>>) -> Result<(), Error> {
@@ -73,14 +73,14 @@ impl OfflineWalletSubCommand {
             Self::CombinePsbt(combine_psbt_command) => combine_psbt_command
                 .execute(ctx)?
                 .write_out(std::io::stdout()),
-            // #[cfg(feature = "bip322")]
-            // Self::SignMessage(sign_message_command) => sign_message_command
-            //     .execute(ctx)?
-            //     .write_out(std::io::stdout()),
-            // #[cfg(feature = "bip322")]
-            // Self::VerifyMessage(verify_message_command) => verify_message_command
-            //     .execute(ctx)?
-            //     .write_out(std::io::stdout()),
+            #[cfg(feature = "bip322")]
+            Self::SignMessage(sign_message_command) => sign_message_command
+                .execute(ctx)?
+                .write_out(std::io::stdout()),
+            #[cfg(feature = "bip322")]
+            Self::VerifyMessage(verify_message_command) => verify_message_command
+                .execute(ctx)?
+                .write_out(std::io::stdout()),
             Self::LockUtxo(lock_utxo) => lock_utxo.execute(ctx)?.write_out(std::io::stdout()),
             Self::UnlockUtxo(unlock_utxo) => unlock_utxo.execute(ctx)?.write_out(std::io::stdout()),
             Self::LockedUtxos(locked_utxos) => {
@@ -204,7 +204,7 @@ pub struct CreateTxCommand {
     #[arg(long = "enable_rbf", short = 'r', default_value_t = true)]
     pub enable_rbf: bool,
 
-    /// Make a PSBT that can be signed by offline signers and hardware wallets. Forces the addition of `non_witness_utxo` and more details to let the signer identify the change output.
+    /// Make a PSBT that can be signed by offline signers and hardware wallets. Forces the addition of `PSBT_GLOBAL_XPUB` and more details to let the signer identify the change output.
     #[arg(long = "offline_signer")]
     pub offline_signer: bool,
 
@@ -773,7 +773,6 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for CombinePsbtCommand {
     }
 }
 
-/**
 #[cfg(feature = "bip322")]
 #[derive(Debug, Parser, Clone, PartialEq)]
 pub struct SignMessageCommand {
@@ -861,12 +860,11 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for VerifyMessageCommand {
         })
     }
 }
-**/
 
 #[derive(Parser, Debug, Clone, PartialEq)]
 pub struct LockUtxoCommand {
     /// Outpoint(s) to lock, format TXID:VOUT.
-    #[arg(env = "TXID:VOUT", long = "utxo", required = true, value_parser = parse_outpoint)]
+    #[arg(env = "TXID", long = "utxo", required = true, value_parser = parse_outpoint)]
     pub utxos: Vec<OutPoint>,
 }
 
@@ -891,7 +889,7 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for LockUtxoCommand {
 #[derive(Parser, Debug, Clone, PartialEq)]
 pub struct UnlockUtxoCommand {
     /// Outpoint(s) to unlock, format TXID:VOUT.
-    #[arg(env = "TXID:VOUT", long = "utxo", required = true, value_parser = parse_outpoint)]
+    #[arg(env = "TXID", long = "utxo", required = true, value_parser = parse_outpoint)]
     pub utxos: Vec<OutPoint>,
 }
 

src/handlers/offline.rs

@@ -1,8 +1,8 @@
 use crate::{commands::WalletOpts, config::WalletConfig, error::BDKCliError as Error};
-// #[cfg(feature = "bip322")]
-// use bdk_bip322::SignatureFormat;
 #[cfg(feature = "cbf")]
 use bdk_kyoto::{Info, Receiver, UnboundedReceiver, Warning};
+#[cfg(feature = "bip322")]
+use bdk_message_signer::SignatureFormat;
 #[cfg(feature = "silent-payments")]
 use bdk_sp::encoding::SilentPaymentCode;
 use bdk_wallet::bitcoin::{Address, Network, OutPoint, ScriptBuf};
@@ -197,20 +197,20 @@ pub(crate) fn parse_sp_code_value_pairs(s: &str) -> Result<(SilentPaymentCode, u
     Ok((key, value))
 }
 
-// /// Function to parse the signature format from a string
-// #[cfg(feature = "bip322")]
-// pub(crate) fn parse_signature_format(format_str: &str) -> Result<SignatureFormat, Error> {
-//     match format_str.to_lowercase().as_str() {
-//         "legacy" => Ok(SignatureFormat::Legacy),
-//         "simple" => Ok(SignatureFormat::Simple),
-//         "full" => Ok(SignatureFormat::Full),
-//         "fullproofoffunds" => Ok(SignatureFormat::FullProofOfFunds),
-//         _ => Err(Error::Generic(
-//             "Invalid signature format. Use 'legacy', 'simple', 'full', or 'fullproofoffunds'"
-//                 .to_string(),
-//         )),
-//     }
-// }
+/// Function to parse the signature format from a string
+#[cfg(feature = "bip322")]
+pub(crate) fn parse_signature_format(format_str: &str) -> Result<SignatureFormat, Error> {
+    match format_str.to_lowercase().as_str() {
+        "legacy" => Ok(SignatureFormat::Legacy),
+        "simple" => Ok(SignatureFormat::Simple),
+        "full" => Ok(SignatureFormat::Full),
+        "fullproofoffunds" => Ok(SignatureFormat::FullProofOfFunds),
+        _ => Err(Error::Generic(
+            "Invalid signature format. Use 'legacy', 'simple', 'full', or 'fullproofoffunds'"
+                .to_string(),
+        )),
+    }
+}
 
 pub fn command_requires_db(command: &OfflineWalletSubCommand) -> bool {
     match command {
@@ -232,11 +232,11 @@ pub fn command_requires_db(command: &OfflineWalletSubCommand) -> bool {
         | OfflineWalletSubCommand::FinalizePsbt(_)
         | OfflineWalletSubCommand::CombinePsbt(_) => false,
 
-        // #[cfg(feature = "bip322")]
-        // OfflineWalletSubCommand::SignMessage(_) => true,
+        #[cfg(feature = "bip322")]
+        OfflineWalletSubCommand::SignMessage(_) => true,
 
-        // #[cfg(feature = "bip322")]
-        // OfflineWalletSubCommand::VerifyMessage(_) => true,
+        #[cfg(feature = "bip322")]
+        OfflineWalletSubCommand::VerifyMessage(_) => true,
         #[cfg(feature = "silent-payments")]
         OfflineWalletSubCommand::CreateSpTx(_) => true,
         #[cfg(feature = "dns_payment")]

src/utils/common.rs

@@ -110,18 +110,18 @@ pub struct KeychainPair<T> {
     pub internal: T,
 }
 
-// #[cfg(feature = "bip322")]
-// #[derive(Serialize, Debug, Default)]
-// pub struct MessageResult {
-//     #[serde(skip_serializing_if = "Option::is_none")]
-//     pub proof: Option<String>,
-
-//     #[serde(skip_serializing_if = "Option::is_none")]
-//     pub valid: Option<bool>,
-
-//     #[serde(skip_serializing_if = "Option::is_none")]
-//     pub proven_amount: Option<u64>,
-// }
+#[cfg(feature = "bip322")]
+#[derive(Serialize, Debug, Default)]
+pub struct MessageResult {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub proof: Option<String>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub valid: Option<bool>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub proven_amount: Option<u64>,
+}
 
 #[derive(Serialize, Debug)]
 pub struct StatusResult {