Struct hwi::interface::HWIClient

source ·

pub struct HWIClient { /* private fields */ }

Implementations§

source §

impl HWIClient

source

pub fn enumerate() -> Result<Vec<Result<HWIDevice, Error>>, Error>

Lists all HW devices currently connected.

let devices = HWIClient::enumerate()?;
for device in devices {
    match device {
        Ok(d) => println!("I can see a {} here 😄", d.model),
        Err(e) => println!("Uh oh, something went wrong when opening the device: {}", e),
    }
}

source

pub fn get_client( device: &HWIDevice, expert: bool, chain: HWIChain ) -> Result<HWIClient, Error>

Returns the HWIClient for a certain device. You can list all the available devices using enumerate.

Setting expert to true will enable additional output for some commands.

let devices = HWIClient::enumerate()?;
for device in devices {
    let device = device?;
    let client = HWIClient::get_client(&device, false, bitcoin::Network::Testnet.into())?;
    let xpub = client.get_master_xpub(HWIAddressType::Tap, 0)?;
    println!(
        "I can see a {} here, and its xpub is {}",
        device.model,
        xpub.to_string()
    );
}

source

pub fn find_device( password: Option<&str>, device_type: Option<HWIDeviceType>, fingerprint: Option<&str>, expert: bool, chain: Network ) -> Result<HWIClient, Error>

Returns the HWIClient for a certain device_type or fingerprint. You can list all the available devices using enumerate.

Setting expert to true will enable additional output for some commands.

let client = HWIClient::find_device(
    None,
    Some(HWIDeviceType::Trezor),
    None,
    false,
    bitcoin::Network::Testnet,
)?;
let xpub = client.get_master_xpub(HWIAddressType::Tap, 0)?;
println!("Trezor's xpub is {}", xpub.to_string());

source

pub fn get_master_xpub( &self, addrtype: HWIAddressType, account: u32 ) -> Result<HWIExtendedPubKey, Error>

Returns the master xpub of a device, given the address type and the account number.

source

pub fn sign_tx( &self, psbt: &Psbt ) -> Result<HWIPartiallySignedTransaction, Error>

Signs a PSBT.

source

pub fn get_xpub( &self, path: &DerivationPath, expert: bool ) -> Result<HWIExtendedPubKey, Error>

Returns the xpub of a device. If expert is set, additional output is returned.

source

pub fn sign_message( &self, message: &str, path: &DerivationPath ) -> Result<HWISignature, Error>

Signs a message.

source

pub fn get_keypool( &self, keypool: bool, internal: bool, addr_type: HWIAddressType, addr_all: bool, account: Option<u32>, path: Option<&DerivationPath>, start: u32, end: u32 ) -> Result<Vec<HWIKeyPoolElement>, Error>

Returns an array of keys that can be imported in Bitcoin core using importmulti

keypool - keypool value in result. Check bitcoin core importmulti documentation for further information
internal - Whether to use internal (change) or external keys
addr_type - Address type to use
addr_all - Whether to return a multiple descriptors for every address type
account - Optional BIP43 account to use
path - The derivation path to derive the keys.
start - Keypool start
end - Keypool end

source

pub fn get_descriptors<T>( &self, account: Option<u32> ) -> Result<HWIDescriptor<T>, Error>
where T: ToDescriptor + DeserializeOwned,

Returns device descriptors. You can optionally specify a BIP43 account to use.

source

pub fn display_address_with_desc<T>( &self, descriptor: &T ) -> Result<HWIAddress, Error>
where T: ToDescriptor + ToString,

Returns an address given a descriptor.

source

pub fn display_address_with_path( &self, path: &DerivationPath, address_type: HWIAddressType ) -> Result<HWIAddress, Error>

Returns an address given path and address type.

source

pub fn install_udev_rules( source: Option<&str>, location: Option<&str> ) -> Result<(), Error>

Install the udev rules to the local machine.

The rules will be copied from the source to the location; the default source location is ./udev, the default destination location is /lib/udev/rules.d

source