org.multibit.hd.hardware.trezor.wallets.v1

Class TrezorV1HidHardwareWallet

java.lang.Object

org.multibit.hd.hardware.core.wallets.AbstractHardwareWallet

org.multibit.hd.hardware.trezor.wallets.AbstractTrezorHardwareWallet

org.multibit.hd.hardware.trezor.wallets.v1.TrezorV1HidHardwareWallet

All Implemented Interfaces:

EventListener, org.hid4java.HidServicesListener, Connectable, HardwareWallet

public class TrezorV1HidHardwareWallet
extends AbstractTrezorHardwareWallet
implements org.hid4java.HidServicesListener

Trezor implementation to provide the following to applications:

• Access to a version 1 production Trezor device over USB using the HID API

This uses a hybrid approach between libusb and hidapi

Since:

0.0.1

Field Summary

Fields inherited from class org.multibit.hd.hardware.core.wallets.AbstractHardwareWallet

specification

Constructor Summary

Constructors

Constructor and Description
TrezorV1HidHardwareWallet() Default constructor for use with dynamic binding
TrezorV1HidHardwareWallet(com.google.common.base.Optional<Integer> vendorId, com.google.common.base.Optional<Integer> productId, com.google.common.base.Optional<String> serialNumber) Create a new instance of a USB-based Trezor device (standard)

Method Summary

Modifier and Type	Method and Description
void	applySpecification(HardwareWalletSpecification specification) Apply any hardware wallet specific parameters
boolean	attach() Handle device attachment.
boolean	connect() Attempt a connection to the underlying hardware to establish communication only (no higher level messages)
void	hardDetach() Handle device detachment and imminent shutdown.
void	hidDeviceAttached(org.hid4java.event.HidServicesEvent event)
void	hidDeviceDetached(org.hid4java.event.HidServicesEvent event)
void	hidFailure(org.hid4java.event.HidServicesEvent event)
String	name() Assist downstream API consumers with identifying the source of events
protected com.google.common.base.Optional<MessageEvent>	readFromDevice(int duration, TimeUnit timeUnit) Read a complete message buffer from the device and convert it into a Core message.
void	softDetach() Handle device detachment.
String	toString()
protected int	writeToDevice(byte[] buffer) Write a complete message buffer to the device.

Methods inherited from class org.multibit.hd.hardware.trezor.wallets.AbstractTrezorHardwareWallet

disconnect, getDefaultSpecification, readMessage, writeMessage

Methods inherited from class org.multibit.hd.hardware.core.wallets.AbstractHardwareWallet

getSpecification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TrezorV1HidHardwareWallet

public TrezorV1HidHardwareWallet()

Default constructor for use with dynamic binding

TrezorV1HidHardwareWallet

public TrezorV1HidHardwareWallet(com.google.common.base.Optional<Integer> vendorId,
                                 com.google.common.base.Optional<Integer> productId,
                                 com.google.common.base.Optional<String> serialNumber)

Create a new instance of a USB-based Trezor device (standard)

Parameters:

vendorId - The vendor ID (default is 0x534c)

productId - The product ID (default is 0x01)

serialNumber - The device serial number (default is to accept any)

Method Detail

applySpecification

public void applySpecification(HardwareWalletSpecification specification)

Description copied from interface: HardwareWallet

Apply any hardware wallet specific parameters

Implementers should override this, but call super.applySpecification(specification) as part of the application process

Specified by:

applySpecification in interface HardwareWallet

Overrides:

applySpecification in class AbstractHardwareWallet

Parameters:

specification - The HardwareWalletSpecification

name

public String name()

Description copied from interface: HardwareWallet

Assist downstream API consumers with identifying the source of events

Specified by:

name in interface HardwareWallet

Returns:

The client name in an enum format (e.g. "TREZOR", "KEEP_KEY" etc)

attach

public boolean attach()

Description copied from interface: Connectable

Handle device attachment. The transport to the device is new formed (device attached, socket server started etc)

Implementations should verify the supporting environment before attempting a connection. Typically this would involve initialising native libraries and verifying their communications

Specified by:

attach in interface Connectable

Returns:

True if the native libraries initialised successfully

softDetach

public void softDetach()

Description copied from interface: Connectable

Handle device detachment. The transport to the device is gone (device removed, socket server shut down etc)

Implementations may assume that recovery is possible (the hardware drivers still remain operational)

Specified by:

softDetach in interface Connectable

hardDetach

public void hardDetach()

Description copied from interface: Connectable

Handle device detachment and imminent shutdown.

Recovery is not possible (the controlling thread is about to close, hardware drivers are closing)

Specified by:

hardDetach in interface Connectable

connect

public boolean connect()

Description copied from interface: Connectable

Attempt a connection to the underlying hardware to establish communication only (no higher level messages)

Implementers must ensure the following behaviour:

• The hardware supporting the device is assumed to be physically attached and discoverable (i.e. plugged into USB or network)
• Method will return false if no matching device is found and further queries are safe to repeat (polling is permitted)
• A DEVICE_FAILED event will be generated if subsequent communication fails (i.e. USB HID fails or device is broken)

Specified by:

connect in interface Connectable

Returns:

True if the connection was successful

toString

public String toString()

Overrides:

toString in class Object

writeToDevice

protected int writeToDevice(byte[] buffer)

Description copied from class: AbstractTrezorHardwareWallet

Write a complete message buffer to the device.

Specified by:

writeToDevice in class AbstractTrezorHardwareWallet

Parameters:

buffer - The buffer that will be written to the device

Returns:

The number of bytes written

readFromDevice

protected com.google.common.base.Optional<MessageEvent> readFromDevice(int duration,
                                                                       TimeUnit timeUnit)

Description copied from class: AbstractTrezorHardwareWallet

Read a complete message buffer from the device and convert it into a Core message.

Specified by:

readFromDevice in class AbstractTrezorHardwareWallet

Parameters:

duration - The duration

timeUnit - The time unit

Returns:

The low level message event containing adapted data read from the device if present

hidDeviceAttached

public void hidDeviceAttached(org.hid4java.event.HidServicesEvent event)

Specified by:

hidDeviceAttached in interface org.hid4java.HidServicesListener

hidDeviceDetached

public void hidDeviceDetached(org.hid4java.event.HidServicesEvent event)

Specified by:

hidDeviceDetached in interface org.hid4java.HidServicesListener

hidFailure

public void hidFailure(org.hid4java.event.HidServicesEvent event)

Specified by:

hidFailure in interface org.hid4java.HidServicesListener