Coldcard Interface Library

coldcard is a library for interfacing with the Coldcard hardware wallet.

Usage

```rust use coldcard::protocol;

// create an API instance let mut api = coldcard::Api::new()?;

// detect all connected Coldcards let serials = api.detect()?;

// get the first serial and open it let first = serials.intoiter().next().unwrap(); let (mut cc, masterxpub) = api.open(first, None).unwrap();

// set a passphrase coldcard.set_passphrase(protocol::Passphrase::new("secret")?)?;

// after the user confirms let xpub = coldcard.getpassphrasedone()?;

if let Some(xpub) = xpub { println!("The new XPUB is: {}", xpub); }

// secure logout coldcard.logout()?; ```

In order to be able to detect a Coldcard device on a Linux system, 51-coinkite.rules must be placed in /etc/udev/rules.d/.

Two mutually exclusive HID backends are supported and can be turned on using the following features:

The log feature enables logging using the log crate. Disabled by default. Use judiciously as logging can leak details into the environment.

This project also offers a CLI tool. See the project's own crate for more information.

Install it with:

bash $ cargo install coldcard-cli

Contributions are welcome. Before making large changes, please open an issue first.

This is not an official project and comes with no warranty whatsoever.