From 007f71b0b685c21fe42f1e43cabab201af1b4c3f Mon Sep 17 00:00:00 2001 From: aagbotemi Date: Sat, 26 Apr 2025 13:07:37 +0100 Subject: [PATCH] bip322: update proof handling for new bdk-bip322 API --- .github/workflows/audit.yml | 8 ++++++- Cargo.lock | 10 +++++++++ Cargo.toml | 2 ++ src/commands.rs | 31 +++++++++++++++++++++++++ src/error.rs | 7 ++++++ src/handlers.rs | 45 +++++++++++++++++++++++++++++++++++++ src/utils.rs | 18 +++++++++++++++ 7 files changed, 120 insertions(+), 1 deletion(-) diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml index 4faea52c..90c861d0 100644 --- a/.github/workflows/audit.yml +++ b/.github/workflows/audit.yml @@ -3,10 +3,17 @@ name: Audit on: push: paths: + # Run if workflow changes + - '.github/workflows/audit.yml' + # Run on changed dependencies - '**/Cargo.toml' - '**/Cargo.lock' + # Run if the configuration file changes + - '**/audit.toml' schedule: - cron: '0 0 * * 0' # Once per week + # Run manually + workflow_dispatch: jobs: @@ -14,6 +21,5 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: actions-rust-lang/audit@v1 with: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/Cargo.lock b/Cargo.lock index 98036e68..a45a1c4a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -192,10 +192,20 @@ version = "0.22.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" +[[package]] +name = "bdk-bip322" +version = "0.1.0" +source = "git+https://github.com/aagbotemi/bdk-bip322.git?branch=master#aabe67ee68c14992b0d529192641d25ce376b6b1" +dependencies = [ + "bdk_wallet", + "bitcoin", +] + [[package]] name = "bdk-cli" version = "2.0.0" dependencies = [ + "bdk-bip322", "bdk_bitcoind_rpc", "bdk_electrum", "bdk_esplora", diff --git a/Cargo.toml b/Cargo.toml index b7d610a6..bb7829e2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -36,6 +36,7 @@ shlex = { version = "1.3.0", optional = true } payjoin = { version = "1.0.0-rc.1", features = ["v1", "v2", "io", "_test-utils"], optional = true} reqwest = { version = "0.12.23", default-features = false, optional = true } url = { version = "2.5.4", optional = true } +bdk-bip322 = { git = "https://github.com/aagbotemi/bdk-bip322.git", branch = "master", optional = true } [features] default = ["repl", "sqlite"] @@ -55,6 +56,7 @@ rpc = ["bdk_bitcoind_rpc", "_payjoin-dependencies"] # Internal features _payjoin-dependencies = ["payjoin", "reqwest", "url"] +bip322 = ["bdk-bip322"] # Use this to consensus verify transactions at sync time verify = [] diff --git a/src/commands.rs b/src/commands.rs index 14ad9eae..c98ab185 100644 --- a/src/commands.rs +++ b/src/commands.rs @@ -405,6 +405,37 @@ pub enum OfflineWalletSubCommand { #[arg(env = "BASE64_PSBT", required = true)] psbt: Vec, }, + /// Sign a message using BIP322 + #[cfg(feature = "bip322")] + SignBip322 { + /// The message to sign + #[arg(long)] + message: String, + /// The signature format (e.g., Legacy, Simple, Full) + #[arg(long, default_value = "simple")] + signature_type: String, + /// Address to sign + #[arg(long)] + address: String, + // Optional list of specific UTXOs for proof-of-funds (only for `FullWithProofOfFunds`) #[arg(long)] + utxos: Option>, + }, + /// Verify a BIP322 signature + #[cfg(feature = "bip322")] + VerifyBip322 { + /// The signature proof to verify + #[arg(long)] + proof: String, + /// The message that was signed + #[arg(long)] + message: String, + /// The signature format (e.g., Legacy, Simple, Full) + #[arg(long, default_value = "simple")] + signature_type: String, + /// The address associated with the signature + #[arg(long)] + address: String, + }, } /// Wallet subcommands that needs a blockchain backend. diff --git a/src/error.rs b/src/error.rs index 064a928d..3f3282eb 100644 --- a/src/error.rs +++ b/src/error.rs @@ -119,3 +119,10 @@ impl From for BDKCliError { BDKCliError::PsbtExtractTxError(Box::new(value)) } } + +#[cfg(feature = "bip322")] +impl From for BDKCliError { + fn from(e: bdk_bip322::error::Error) -> Self { + BDKCliError::Generic(e.to_string()) + } +} diff --git a/src/handlers.rs b/src/handlers.rs index 1f867b41..e7262a57 100644 --- a/src/handlers.rs +++ b/src/handlers.rs @@ -69,6 +69,11 @@ use std::str::FromStr; ))] use std::sync::Arc; +#[cfg(feature = "bip322")] +use crate::error::BDKCliError; +#[cfg(feature = "bip322")] +use bdk_bip322::{BIP322, Bip322Proof, Bip322VerificationResult}; + #[cfg(any( feature = "electrum", feature = "esplora", @@ -591,6 +596,46 @@ pub fn handle_offline_wallet_subcommand( &json!({ "psbt": BASE64_STANDARD.encode(final_psbt.serialize()) }), )?) } + #[cfg(feature = "bip322")] + SignBip322 { + message, + signature_type, + address, + utxos, + } => { + let address: Address = parse_address(&address)?; + let signature_format = parse_signature_format(&signature_type)?; + + let proof: Bip322Proof = wallet + .sign_bip322(message.as_str(), signature_format, &address, utxos) + .map_err(|e| { + BDKCliError::Generic(format!("Failed to sign BIP-322 message: {e}")) + })?; + + Ok(json!({"proof": proof.to_base64()}).to_string()) + } + #[cfg(feature = "bip322")] + VerifyBip322 { + proof, + message, + signature_type, + address, + } => { + let address: Address = parse_address(&address)?; + let signature_format = parse_signature_format(&signature_type)?; + + let parsed_proof: Bip322Proof = Bip322Proof::from_base64(&proof) + .map_err(|e| BDKCliError::Generic(format!("Invalid proof: {e}")))?; + + let is_valid: Bip322VerificationResult = + wallet.verify_bip322(&parsed_proof, &message, signature_format, &address)?; + + Ok(json!({ + "valid": is_valid.valid, + "proven_amount": is_valid.proven_amount.map(|a| a.to_sat()) // optional field + }) + .to_string()) + } } } diff --git a/src/utils.rs b/src/utils.rs index 73d34531..4dd28be8 100644 --- a/src/utils.rs +++ b/src/utils.rs @@ -56,6 +56,9 @@ use bdk_wallet::descriptor::Segwitv0; use bdk_wallet::keys::{GeneratableKey, GeneratedKey, bip39::WordCount}; use serde_json::{Value, json}; +#[cfg(feature = "bip322")] +use bdk_bip322::SignatureFormat; + /// Parse the recipient (Address,Amount) argument from cli input. pub(crate) fn parse_recipient(s: &str) -> Result<(ScriptBuf, u64), String> { let parts: Vec<_> = s.split(':').collect(); @@ -95,6 +98,21 @@ pub(crate) fn parse_address(address_str: &str) -> Result { Ok(unchecked_address.assume_checked()) } +/// Function to parse the signature format from a string +#[cfg(feature = "bip322")] +pub(crate) fn parse_signature_format(format_str: &str) -> Result { + 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(), + )), + } +} + /// Prepare bdk-cli home directory /// /// This function is called to check if [`crate::CliOpts`] datadir is set.