chore(example): add example using async-hwi

Author: sdmg15

Cargo.toml

@@ -5,7 +5,8 @@ members = [
     "examples/example_wallet_electrum",
     "examples/example_wallet_esplora_blocking",
     "examples/example_wallet_esplora_async",
-    "examples/example_wallet_rpc",
+    "examples/example_wallet_rpc", 
+    "examples/example_wallet_hwi_signer",
 ]
 
 [workspace.package]

examples/example_wallet_hwi_signer/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "example_wallet_hwi_signer"
+version = "0.1.0"
+edition = "2021"
+authors.workspace = true
+
+[features]
+simulator = []
+
+[dependencies]
+bdk_wallet = { path = "../../wallet", features = ["file_store", "test-utils"] }
+tokio = { version = "1", features = ["rt", "rt-multi-thread", "macros"] }
+# Once the next release happens on crates.io we can update here
+async-hwi = { git = "https://github.com/wizardsardine/async-hwi", branch = "master"}
+anyhow = "1"

examples/example_wallet_hwi_signer/README.md

@@ -0,0 +1,27 @@
+# Example signing with HWI Interface
+
+
+## Requirements
+
+sudo apt install libudev-dev
+
+## Build and run
+
+`$ cargo run --bin example_wallet_hwi_signer`
+
+## Running with simulator
+
+Download a simulator at `https://github.com/BitBoxSwiss/bitbox02-firmware/releases/`.
+
+Run the simulator and then run the example with `--features=simulator` enabled.
+
+```sh
+
+curl https://github.com/BitBoxSwiss/bitbox02-firmware/releases/download/firmware%2Fv9.19.0/bitbox02-multi-v9.19.0-simulator1.0.0-linux-amd64
+
+./bitbox02-multi-v9.19.0-simulator1.0.0-linux-amd64
+
+cargo run --bin example_wallet_hwi_signer --features simulator
+```
+
+

examples/example_wallet_hwi_signer/src/main.rs

@@ -0,0 +1,68 @@
+use async_hwi::bitbox::api::runtime::TokioRuntime;
+use async_hwi::bitbox::api::BitBox;
+use async_hwi::bitbox::NoiseConfigNoCache;
+use bdk_wallet::bitcoin::absolute::LockTime;
+use bdk_wallet::bitcoin::{Amount, FeeRate, Network};
+
+use bdk_wallet::test_utils::get_funded_wallet;
+use async_hwi::{bitbox::BitBox02, HWI};
+use bdk_wallet::KeychainKind;
+
+const SEND_AMOUNT: Amount = Amount::from_sat(5000);
+const NETWORK: Network = Network::Regtest;
+const EXTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdfCLpvozodGytD3gRUa1M5WQz4kNuDZVf1inhcsSHXRpyLWN3k3Qy3nucrzz5hw2iZiEs6spehpee2WxqfSi31ByRJEu4rZ/84h/1h/0h/0/*)";
+const INTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdfCLpvozodGytD3gRUa1M5WQz4kNuDZVf1inhcsSHXRpyLWN3k3Qy3nucrzz5hw2iZiEs6spehpee2WxqfSi31ByRJEu4rZ/84h/1h/0h/1/*)";
+
+#[tokio::main]
+async fn main() -> Result<(), anyhow::Error> {
+
+    let (mut wallet, _) = get_funded_wallet(EXTERNAL_DESC, INTERNAL_DESC);
+
+    // Pairing with Bitbox connected Bitbox device
+    let noise_config = Box::new(NoiseConfigNoCache {});
+
+    let bitbox = {
+        #[cfg(feature = "simulator")]
+        {
+            BitBox::<TokioRuntime>::from_simulator(None, noise_config).await?
+        }
+
+        #[cfg(not(feature = "simulator"))]
+        {
+            use async_hwi::bitbox::api::usb;
+            BitBox::<TokioRuntime>::from_hid_device(usb::get_any_bitbox02().unwrap(), noise_config)
+                .await?
+        }
+    };
+
+    let pairing_device = bitbox.unlock_and_pair().await?;
+    let paired_device = pairing_device.wait_confirm().await?;
+
+    if let Ok(_) = paired_device.restore_from_mnemonic().await {
+        println!("Initializing device with mnemonic...");
+    } else {
+        println!("Device already initialized proceeding...");
+    }
+
+    let bb = BitBox02::from(paired_device);
+    let bb = bb.with_network(NETWORK);
+
+    let receiving_address = wallet.next_unused_address(KeychainKind::External);
+
+    println!("Wallet balance {}", wallet.balance());
+
+    let mut tx_builder = wallet.build_tx();
+
+    tx_builder
+        .add_recipient(receiving_address.script_pubkey(), SEND_AMOUNT)
+        .fee_rate(FeeRate::from_sat_per_vb(2).unwrap())
+        .nlocktime(LockTime::from_height(0).unwrap());
+
+    let mut psbt = tx_builder.finish()?;
+
+    // Sign with the connected bitbox or any hardware device
+    bb.sign_tx(&mut psbt).await?;
+    
+    println!("Signing with bitbox done. Balance After signing {}", wallet.balance());
+    Ok(())
+}