9067195515

Committed 13 May 2024 05:25PM UTC coverage: 82.434% (-0.007%) from 82.441%

Build # 9067195515

Build Type

push

github

Committed by

notmandatory

Commit Message

Merge bitcoindevkit/bdk#1326: chore: rename bdk crate to bdk_wallet

f6781652b chore: rename bdk crate to bdk_wallet (Steve Myers)

Pull request description:

  ### Description

  Fixes #1305 .

  ### Notes to the reviewers

  Once this properly builds, even before all reviews is done, I will publish it to crates.io to reserve the name.

  ### Changelog notice

  Changed

  - Renamed `bdk` crate to `bdk_wallet`.

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

Top commit has no ACKs.

Tree-SHA512: 437c79d9dcde6b410632e5b55ce6b679256

Run Details

0 of 10 new or added lines in 2 files covered. (0.0%)

10653 of 12923 relevant lines covered (82.43%)

17070.47 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/crates/hwi/src/signer.rs

use bdk_wallet::bitcoin::bip32::Fingerprint;
use bdk_wallet::bitcoin::secp256k1::{All, Secp256k1};
use bdk_wallet::bitcoin::Psbt;

use hwi::error::Error;
use hwi::types::{HWIChain, HWIDevice};
use hwi::HWIClient;

use bdk_wallet::signer::{SignerCommon, SignerError, SignerId, TransactionSigner};

#[derive(Debug)]
/// Custom signer for Hardware Wallets
///
/// This ignores `sign_options` and leaves the decisions up to the hardware wallet.
pub struct HWISigner {
    fingerprint: Fingerprint,
    client: HWIClient,
}

impl HWISigner {
    /// Create a instance from the specified device and chain
    pub fn from_device(device: &HWIDevice, chain: HWIChain) -> Result<HWISigner, Error> {
        let client = HWIClient::get_client(device, false, chain)?;
        Ok(HWISigner {
            fingerprint: device.fingerprint,
            client,
        })
    }
}

impl SignerCommon for HWISigner {
    fn id(&self, _secp: &Secp256k1<All>) -> SignerId {
        SignerId::Fingerprint(self.fingerprint)
    }
}

impl TransactionSigner for HWISigner {
    fn sign_transaction(
        &self,
        psbt: &mut Psbt,
        _sign_options: &bdk_wallet::SignOptions,
        _secp: &Secp256k1<All>,
    ) -> Result<(), SignerError> {
        psbt.combine(
            self.client
                .sign_tx(psbt)
                .map_err(|e| {
                    SignerError::External(format!("While signing with hardware wallet: {}", e))
                })?
                .psbt,
        )
        .expect("Failed to combine HW signed psbt with passed PSBT");
        Ok(())
    }
}

// TODO: re-enable this once we have the `get_funded_wallet` test util
// #[cfg(test)]
// mod tests {
//     #[test]
//     fn test_hardware_signer() {
//         use std::sync::Arc;
//
//         use bdk_wallet::tests::get_funded_wallet;
//         use bdk_wallet::signer::SignerOrdering;
//         use bdk_wallet::bitcoin::Network;
//         use crate::HWISigner;
//         use hwi::HWIClient;
//
//         let mut devices = HWIClient::enumerate().unwrap();
//         if devices.is_empty() {
//             panic!("No devices found!");
//         }
//         let device = devices.remove(0).unwrap();
//         let client = HWIClient::get_client(&device, true, Network::Regtest.into()).unwrap();
//         let descriptors = client.get_descriptors::<String>(None).unwrap();
//         let custom_signer = HWISigner::from_device(&device, Network::Regtest.into()).unwrap();
//
//         let (mut wallet, _) = get_funded_wallet(&descriptors.internal[0]);
//         wallet.add_signer(
//             bdk_wallet::KeychainKind::External,
//             SignerOrdering(200),
//             Arc::new(custom_signer),
//         );
//
//         let addr = wallet.get_address(bdk_wallet::wallet::AddressIndex::LastUnused);
//         let mut builder = wallet.build_tx();
//         builder.drain_to(addr.script_pubkey()).drain_wallet();
//         let (mut psbt, _) = builder.finish().unwrap();
//
//         let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
//         assert!(finalized);
//     }
// }

1	use bdk_wallet::bitcoin::bip32::Fingerprint;
2	use bdk_wallet::bitcoin::secp256k1::{All, Secp256k1};
3	use bdk_wallet::bitcoin::Psbt;
4
5	use hwi::error::Error;
6	use hwi::types::{HWIChain, HWIDevice};
7	use hwi::HWIClient;
8
9	use bdk_wallet::signer::{SignerCommon, SignerError, SignerId, TransactionSigner};
10
11	#[derive(Debug)]
12	/// Custom signer for Hardware Wallets
13	///
14	/// This ignores `sign_options` and leaves the decisions up to the hardware wallet.
15	pub struct HWISigner {
16	fingerprint: Fingerprint,
17	client: HWIClient,
18	}
19
20	impl HWISigner {
21	/// Create a instance from the specified device and chain
22	pub fn from_device(device: &HWIDevice, chain: HWIChain) -> Result<HWISigner, Error> {	×
23	let client = HWIClient::get_client(device, false, chain)?;	×
24	Ok(HWISigner {	×
25	fingerprint: device.fingerprint,	×
26	client,	×
27	})	×
28	}	×
29	}
30
31	impl SignerCommon for HWISigner {
32	fn id(&self, _secp: &Secp256k1<All>) -> SignerId {	×
33	SignerId::Fingerprint(self.fingerprint)	×
34	}	×
35	}
36
37	impl TransactionSigner for HWISigner {
38	fn sign_transaction(	×
39	&self,	×
40	psbt: &mut Psbt,	×
NEW 41	_sign_options: &bdk_wallet::SignOptions,	×
42	_secp: &Secp256k1<All>,	×
43	) -> Result<(), SignerError> {	×
44	psbt.combine(	×
45	self.client	×
46	.sign_tx(psbt)	×
47	.map_err(\|e\| {	×
48	SignerError::External(format!("While signing with hardware wallet: {}", e))	×
49	})?	×
50	.psbt,
51	)
52	.expect("Failed to combine HW signed psbt with passed PSBT");	×
53	Ok(())	×
54	}	×
55	}
56
57	// TODO: re-enable this once we have the `get_funded_wallet` test util
58	// #[cfg(test)]
59	// mod tests {
60	// #[test]
61	// fn test_hardware_signer() {
62	// use std::sync::Arc;
63	//
64	// use bdk_wallet::tests::get_funded_wallet;
65	// use bdk_wallet::signer::SignerOrdering;
66	// use bdk_wallet::bitcoin::Network;
67	// use crate::HWISigner;
68	// use hwi::HWIClient;
69	//
70	// let mut devices = HWIClient::enumerate().unwrap();
71	// if devices.is_empty() {
72	// panic!("No devices found!");
73	// }
74	// let device = devices.remove(0).unwrap();
75	// let client = HWIClient::get_client(&device, true, Network::Regtest.into()).unwrap();
76	// let descriptors = client.get_descriptors::<String>(None).unwrap();
77	// let custom_signer = HWISigner::from_device(&device, Network::Regtest.into()).unwrap();
78	//
79	// let (mut wallet, _) = get_funded_wallet(&descriptors.internal[0]);
80	// wallet.add_signer(
81	// bdk_wallet::KeychainKind::External,
82	// SignerOrdering(200),
83	// Arc::new(custom_signer),
84	// );
85	//
86	// let addr = wallet.get_address(bdk_wallet::wallet::AddressIndex::LastUnused);
87	// let mut builder = wallet.build_tx();
88	// builder.drain_to(addr.script_pubkey()).drain_wallet();
89	// let (mut psbt, _) = builder.finish().unwrap();
90	//
91	// let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
92	// assert!(finalized);
93	// }
94	// }

bitcoindevkit / bdk / 9067195515

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous