org.multibit.hd.hardware.keepkey.clients

Class KeepKeyRelayClient

java.lang.Object

org.multibit.hd.hardware.keepkey.clients.AbstractKeepKeyHardwareWalletClient

org.multibit.hd.hardware.keepkey.clients.KeepKeyRelayClient

All Implemented Interfaces:

HardwareWalletClient, Connectable

public class KeepKeyRelayClient
extends AbstractKeepKeyHardwareWalletClient

Client to provide the following to applications:

• A client that enables communication of KeepKey wire messages with a remote KeepKey. Locally you generate and consume KeepKey messages. These are 'teleported' to a remote machine where a physical KeepKey is.
• The RelayClient talks to a RelayServer on a remote machine via a ServerSocket

Since:

0.0.1

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	serverMonitorService

Constructor Summary

Constructors

Constructor and Description
KeepKeyRelayClient(String relayServerLocation, int relayServerPort)

Method Summary

Modifier and Type	Method and Description
boolean	attach() Handle device attachment.
boolean	connect() Attempt a connection to the underlying hardware to establish communication only (no higher level messages)
void	disconnect() Break the connection to the device
void	hardDetach() Handle device detachment and imminent shutdown.
String	name() Assist downstream API consumers with identifying the source of events
com.google.common.base.Optional<MessageEvent>	sendMessage(com.google.protobuf.Message message) Send a message to an output stream
com.google.common.base.Optional<MessageEvent>	sendMessage(com.google.protobuf.Message message, int duration, TimeUnit timeUnit) Send a message to the device with an arbitrary response duration.
void	softDetach() Handle device detachment.
boolean	verifyFeatures(Features features) Verify the contents of the Features message in accordance with client-specific rules (e.g.

Methods inherited from class org.multibit.hd.hardware.keepkey.clients.AbstractKeepKeyHardwareWalletClient

applySettings, buttonAck, cancel, changePIN, cipherKeyValue, clearSession, decryptMessage, encryptMessage, entropyAck, estimateTxSize, firmwareErase, firmwareUpload, getAddress, getDeterministicHierarchy, getEntropy, getPublicKey, initialise, loadDevice, passphraseAck, ping, pinMatrixAck, recoverDevice, resetDevice, signMessage, signTx, simpleSignTx, txAck, verifyMessage, wipeDevice, wordAck

Methods inherited from class java.lang.Object

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

Field Detail

serverMonitorService

protected final ExecutorService serverMonitorService

Constructor Detail

KeepKeyRelayClient

public KeepKeyRelayClient(String relayServerLocation,
                          int relayServerPort)

Parameters:

relayServerLocation - The location of the RelayServer

relayServerPort - The port number of the server

Method Detail

name

public String name()

Description copied from interface: HardwareWalletClient

Assist downstream API consumers with identifying the source of events

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

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)

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)

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)

Returns:

True if the connection was successful

disconnect

public void disconnect()

Description copied from interface: Connectable

Break the connection to the device

Implementers must ensure the following behaviour:

• All non-persistent state associated with the device is reset
• A connect is required to restart communications

sendMessage

public com.google.common.base.Optional<MessageEvent> sendMessage(com.google.protobuf.Message message)

Send a message to an output stream

Specified by:

sendMessage in class AbstractKeepKeyHardwareWalletClient

Parameters:

message - the message to serialise and send to the OutputStream

Returns:

An optional low level message event, present only in blocking implementations

sendMessage

public com.google.common.base.Optional<MessageEvent> sendMessage(com.google.protobuf.Message message,
                                                                 int duration,
                                                                 TimeUnit timeUnit)

Description copied from class: AbstractKeepKeyHardwareWalletClient

Send a message to the device with an arbitrary response duration.

If the response times out a FAILURE message should be generated.

Specified by:

sendMessage in class AbstractKeepKeyHardwareWalletClient

Parameters:

message - The message to send to the hardware wallet

duration - The duration to wait before returning

timeUnit - The time unit

Returns:

An optional low level message event, present only in blocking implementations

verifyFeatures

public boolean verifyFeatures(Features features)

Description copied from interface: HardwareWalletClient

Verify the contents of the Features message in accordance with client-specific rules (e.g. firmware)

Parameters:

features - The Features from the device

Returns:

True if the Features are compatible with this version of MultiBit Hardware