org.multibit.hd.hardware.keepkey.clients

Class AbstractKeepKeyHardwareWalletClient

java.lang.Object

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

All Implemented Interfaces:

HardwareWalletClient, Connectable

Direct Known Subclasses:

KeepKeyHardwareWalletClient, KeepKeyRelayClient

public abstract class AbstractKeepKeyHardwareWalletClient
extends Object
implements HardwareWalletClient

Hardware wallet client to provide the following to KeepKey clients:

• Access to common methods

Since:

0.0.1

Constructor Summary

Constructors

Constructor and Description
AbstractKeepKeyHardwareWalletClient()

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<MessageEvent>	applySettings(String language, String label) Send the APPLY_SETTINGS message to the device.
com.google.common.base.Optional<MessageEvent>	buttonAck() Send the BUTTON_ACK message to the device in response to a BUTTON_REQUEST.
com.google.common.base.Optional<MessageEvent>	cancel() Send the CANCEL message to the device in response to a BUTTON_REQUEST, PIN_MATRIX_REQUEST or PASSPHRASE_REQUEST.
com.google.common.base.Optional<MessageEvent>	changePIN(boolean remove) Send the CHANGE_PIN message to the device.
com.google.common.base.Optional<MessageEvent>	cipherKeyValue(int account, org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose, int index, byte[] key, byte[] keyValue, boolean isEncrypting, boolean askOnDecrypt, boolean askOnEncrypt) Send the CIPHER_KEY_VALUE_MESSAGE message to the device containing a key.
com.google.common.base.Optional<MessageEvent>	clearSession() Send the CLEAR_SESSION message to the device.
com.google.common.base.Optional<MessageEvent>	decryptMessage(int account, org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose, int index, byte[] message) Send the DECRYPT_MESSAGE message to the device containing a message to decrypt.
com.google.common.base.Optional<MessageEvent>	encryptMessage(byte[] pubKey, byte[] message, boolean displayOnly) Send the ENCRYPT_MESSAGE message to the device containing a message to encrypt.
com.google.common.base.Optional<MessageEvent>	entropyAck(byte[] entropy) Send the ENTROPY_ACK message to the device in response to an ENTROPY_REQUEST.
com.google.common.base.Optional<MessageEvent>	estimateTxSize(org.bitcoinj.core.Transaction tx) Send the ESTIMATE_TX_SIZE message to the device to estimate the size of the transaction.
com.google.common.base.Optional<MessageEvent>	firmwareErase() Send the FIRMWARE_ERASE message to the device.
com.google.common.base.Optional<MessageEvent>	firmwareUpload() Send the FIRMWARE_UPLOAD message to the device.
com.google.common.base.Optional<MessageEvent>	getAddress(int account, org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose, int index, boolean showDisplay) Send the GET_ADDRESS message to the device.
com.google.common.base.Optional<MessageEvent>	getDeterministicHierarchy(List<org.bitcoinj.crypto.ChildNumber> childNumbers) Send the GET_PUBLIC_KEY message to the device based on the given list of child numbers.
com.google.common.base.Optional<MessageEvent>	getEntropy() Send the ENTROPY message to the device.
com.google.common.base.Optional<MessageEvent>	getPublicKey(int account, org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose, int index) Send the GET_PUBLIC_KEY message to the device.
com.google.common.base.Optional<MessageEvent>	initialise() Reset device to default state and ask for device details
com.google.common.base.Optional<MessageEvent>	loadDevice(String language, String label, String seedPhrase, String pin) Send the LOAD_DEVICE message to the device.
com.google.common.base.Optional<MessageEvent>	passphraseAck(String passphrase) Send the PASSPHRASE_ACK message to the device in response to a PASSPHRASE_REQUEST.
com.google.common.base.Optional<MessageEvent>	ping() Send the PING message to the device
com.google.common.base.Optional<MessageEvent>	pinMatrixAck(String pin) Send the PIN_MATRIX_ACK message to the device in response to a PIN_MATRIX_REQUEST.
com.google.common.base.Optional<MessageEvent>	recoverDevice(String language, String label, int wordCount, boolean passphraseProtection, boolean pinProtection) Send the RECOVER_DEVICE message to the device to start the workflow of asking user for specific words from their seed.
com.google.common.base.Optional<MessageEvent>	resetDevice(String language, String label, boolean displayRandom, boolean pinProtection, int strength) Send the RESET_DEVICE message to the device.
protected abstract com.google.common.base.Optional<MessageEvent>	sendMessage(com.google.protobuf.Message message) Send a message to the device that should have a near-immediate (under 5 second) response.
protected abstract 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.
com.google.common.base.Optional<MessageEvent>	signMessage(int account, org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose, int index, byte[] message) Send the SIGN_MESSAGE message to the device containing a message to sign.
com.google.common.base.Optional<MessageEvent>	signTx(org.bitcoinj.core.Transaction tx) Send the SIGN_TX message to the device.
com.google.common.base.Optional<MessageEvent>	simpleSignTx(org.bitcoinj.core.Transaction tx) Send the SIMPLE_SIGN_TX message to the device.
com.google.common.base.Optional<MessageEvent>	txAck(TxRequest txRequest, org.bitcoinj.core.Transaction tx, Map<Integer,com.google.common.collect.ImmutableList<org.bitcoinj.crypto.ChildNumber>> receivingAddressPathMap, Map<org.bitcoinj.core.Address,com.google.common.collect.ImmutableList<org.bitcoinj.crypto.ChildNumber>> changeAddressPathMap) Send the TX_ACK message to the device.
com.google.common.base.Optional<MessageEvent>	verifyMessage(org.bitcoinj.core.Address address, byte[] signature, byte[] message) Send the VERIFY_MESSAGE message to the device containing a signed message to verify.
com.google.common.base.Optional<MessageEvent>	wipeDevice() Send the WIPE_DEVICE message to the device.
com.google.common.base.Optional<MessageEvent>	wordAck(String word) Send the WORD_ACK message to the device containing a word from the seed phrase.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.multibit.hd.hardware.core.HardwareWalletClient

name, verifyFeatures

Methods inherited from interface org.multibit.hd.hardware.core.wallets.Connectable

attach, connect, disconnect, hardDetach, softDetach

Constructor Detail

AbstractKeepKeyHardwareWalletClient

public AbstractKeepKeyHardwareWalletClient()

Method Detail

initialise

public com.google.common.base.Optional<MessageEvent> initialise()

Description copied from interface: HardwareWalletClient

Reset device to default state and ask for device details

Send the INITIALISE message to the device.

Expected response events are:

• PIN_MATRIX_REQUEST if the PIN is needed
• FEATURES containing the available feature set

Specified by:

initialise in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

ping

public com.google.common.base.Optional<MessageEvent> ping()

Description copied from interface: HardwareWalletClient

Send the PING message to the device

Expected response events are:

• SUCCESS if the device is present

Specified by:

ping in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

clearSession

public com.google.common.base.Optional<MessageEvent> clearSession()

Description copied from interface: HardwareWalletClient

Send the CLEAR_SESSION message to the device.

Clear session (removes cached PIN, passphrase, etc).

Expected response events are:

• SUCCESS if the PIN is needed

Specified by:

clearSession in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

changePIN

public com.google.common.base.Optional<MessageEvent> changePIN(boolean remove)

Description copied from interface: HardwareWalletClient

Send the CHANGE_PIN message to the device. The device will respond by showing a secure PIN selection screen and asking the user to verify accordingly.

Expected response events are:

• BUTTON_REQUEST if a button press is needed
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the password was rejected

Specified by:

changePIN in interface HardwareWalletClient

Parameters:

remove - True if the PIN should be removed

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

wipeDevice

public com.google.common.base.Optional<MessageEvent> wipeDevice()

Description copied from interface: HardwareWalletClient

Send the WIPE_DEVICE message to the device. The device will respond by cancelling its pending action and clearing the screen. It will also wipe all sensitive data and settings back to factory defaults.

Expected response events are:

• SUCCESS if the message was acknowledged
• BUTTON_REQUEST if a button press is needed

Specified by:

wipeDevice in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

firmwareErase

public com.google.common.base.Optional<MessageEvent> firmwareErase()

Description copied from interface: HardwareWalletClient

Send the FIRMWARE_ERASE message to the device.

Expected response events are:

• SUCCESS if the message was acknowledged

Specified by:

firmwareErase in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

firmwareUpload

public com.google.common.base.Optional<MessageEvent> firmwareUpload()

Description copied from interface: HardwareWalletClient

Send the FIRMWARE_UPLOAD message to the device.

Expected response events are:

• SUCCESS if the message was acknowledged
• PIN_MATRIX_REQUEST if the PIN is needed

Specified by:

firmwareUpload in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

getEntropy

public com.google.common.base.Optional<MessageEvent> getEntropy()

Description copied from interface: HardwareWalletClient

Send the ENTROPY message to the device. The device will respond by providing some random data from its internal hardware random number generator.

Expected response events are:

• ENTROPY (with data) if the operation succeeded
• BUTTON_REQUEST if a button press is needed
• FAILURE if the operation was unsuccessful

Specified by:

getEntropy in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

loadDevice

public com.google.common.base.Optional<MessageEvent> loadDevice(String language,
                                                                String label,
                                                                String seedPhrase,
                                                                String pin)

Description copied from interface: HardwareWalletClient

Send the LOAD_DEVICE message to the device. The device will overwrite any existing private keys and replace them based on the seed phrase provided.

Expected response events are:

• SUCCESS if the operation succeeded (may take up to 10 seconds)
• BUTTON_REQUEST if a button press is needed
• FAILURE if the operation was unsuccessful

Specified by:

loadDevice in interface HardwareWalletClient

Parameters:

language - The language code

label - The label to display below the logo (e.g "Fred")

seedPhrase - The seed phrase provided by the user in the clear

pin - The personal identification number (PIN) in the clear

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

resetDevice

public com.google.common.base.Optional<MessageEvent> resetDevice(String language,
                                                                 String label,
                                                                 boolean displayRandom,
                                                                 boolean pinProtection,
                                                                 int strength)

Description copied from interface: HardwareWalletClient

Send the RESET_DEVICE message to the device. The device will perform a full reset, generating a new seed and asking the user for new settings (PIN etc). This is typically needed when a device is first un-boxed.

Expected response events are:

• ENTROPY_REQUEST if the user should supply additional entropy (recommended)
• FAILURE if the operation was unsuccessful

Specified by:

resetDevice in interface HardwareWalletClient

Parameters:

language - The language code (e.g. "english")

label - The label to display below the logo (e.g "Fred")

displayRandom - True if the device should display the entropy generated by the device before asking for additional entropy

pinProtection - True if the device should use PIN protection

strength - The strength of the seed in bits (default is 128)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

recoverDevice

public com.google.common.base.Optional<MessageEvent> recoverDevice(String language,
                                                                   String label,
                                                                   int wordCount,
                                                                   boolean passphraseProtection,
                                                                   boolean pinProtection)

Description copied from interface: HardwareWalletClient

Send the RECOVER_DEVICE message to the device to start the workflow of asking user for specific words from their seed.

Expected response events are:

• WORD_REQUEST for each word in the user seed

Specified by:

recoverDevice in interface HardwareWalletClient

Parameters:

language - The language code

label - The label to display

wordCount - The number of words in the seed

passphraseProtection - True if the device should use passphrase protection

pinProtection - True if the device should use PIN protection

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

wordAck

public com.google.common.base.Optional<MessageEvent> wordAck(String word)

Description copied from interface: HardwareWalletClient

Send the WORD_ACK message to the device containing a word from the seed phrase.

Expected response events are:

• SUCCESS if the overall operation succeeded
• WORD_REQUEST if another word is needed
• FAILURE if the operation was unsuccessful

Specified by:

wordAck in interface HardwareWalletClient

Parameters:

word - A word from the seed phrase

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

signTx

public com.google.common.base.Optional<MessageEvent> signTx(org.bitcoinj.core.Transaction tx)

Description copied from interface: HardwareWalletClient

Send the SIGN_TX message to the device. Behind the scenes the device will response with a series of TxRequests in order to build up the overall transaction. This client takes care of all the chatter leaving a final response condition. This allows transactions of arbitrary size to be created.

Expected response events are:

• PASSPHRASE_REQUEST if the passphrase is needed
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

signTx in interface HardwareWalletClient

Parameters:

tx - The Bitcoinj transaction providing all the necessary information (will be modified)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

simpleSignTx

public com.google.common.base.Optional<MessageEvent> simpleSignTx(org.bitcoinj.core.Transaction tx)

Description copied from interface: HardwareWalletClient

Send the SIMPLE_SIGN_TX message to the device. This will use the supplied transaction object and attempt to deliver it to the device in a single request. This limits the size of the transaction but simplifies the call.

Expected response events are:

• PASSPHRASE_REQUEST if the passphrase is needed
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

simpleSignTx in interface HardwareWalletClient

Parameters:

tx - The Bitcoinj transaction providing all the necessary information (will be modified)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

txAck

public com.google.common.base.Optional<MessageEvent> txAck(TxRequest txRequest,
                                                           org.bitcoinj.core.Transaction tx,
                                                           Map<Integer,com.google.common.collect.ImmutableList<org.bitcoinj.crypto.ChildNumber>> receivingAddressPathMap,
                                                           Map<org.bitcoinj.core.Address,com.google.common.collect.ImmutableList<org.bitcoinj.crypto.ChildNumber>> changeAddressPathMap)

Description copied from interface: HardwareWalletClient

Send the TX_ACK message to the device. This contains a description of an input or output depending on the contents of an earlier TX_REQUEST message.

Expected response events are:

• TX_REQUEST if more transaction information is required or to notify completion of workflow
• FAILURE if the operation was unsuccessful

Specified by:

txAck in interface HardwareWalletClient

Parameters:

txRequest - The transaction request describing what is required

tx - The Bitcoinj transaction providing all the necessary information (will be modified)

receivingAddressPathMap - The receiving address path map (keyed on input index and providing deterministic path to receiving address)

changeAddressPathMap - The change address path map (keyed on Address and providing deterministic path to change address)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

pinMatrixAck

public com.google.common.base.Optional<MessageEvent> pinMatrixAck(String pin)

Description copied from interface: HardwareWalletClient

Send the PIN_MATRIX_ACK message to the device in response to a PIN_MATRIX_REQUEST.

Implementers are expected to show a PIN matrix on the UI.

Expected response events are:

• FAILURE if the operation was unsuccessful

Specified by:

pinMatrixAck in interface HardwareWalletClient

Parameters:

pin - The PIN as entered from the PIN matrix (obfuscated)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

passphraseAck

public com.google.common.base.Optional<MessageEvent> passphraseAck(String passphrase)

Description copied from interface: HardwareWalletClient

Send the PASSPHRASE_ACK message to the device in response to a PASSPHRASE_REQUEST.

Implementers are expected to show a passphrase dialog on the UI.

Expected response events are:

• FAILURE if the operation was unsuccessful

Specified by:

passphraseAck in interface HardwareWalletClient

Parameters:

passphrase - The passphrase as entered by the user (not obfuscated)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

buttonAck

public com.google.common.base.Optional<MessageEvent> buttonAck()

Description copied from interface: HardwareWalletClient

Send the BUTTON_ACK message to the device in response to a BUTTON_REQUEST. The calling software will then block (appropriately for its UI) until the device responds/fails.

Expected response events are:

• BUTTON_REQUEST if the operation succeeded

Specified by:

buttonAck in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

cancel

public com.google.common.base.Optional<MessageEvent> cancel()

Description copied from interface: HardwareWalletClient

Send the CANCEL message to the device in response to a BUTTON_REQUEST, PIN_MATRIX_REQUEST or PASSPHRASE_REQUEST.

Expected response events are:

• BUTTON_REQUEST if a button press is needed
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

cancel in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

getAddress

public com.google.common.base.Optional<MessageEvent> getAddress(int account,
                                                                org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose,
                                                                int index,
                                                                boolean showDisplay)

Description copied from interface: HardwareWalletClient

Send the GET_ADDRESS message to the device. The device will respond by providing an address calculated based on the BIP-44 deterministic wallet approach from the master node.

Expected response events are:

• ADDRESS (with data) if the operation succeeded
• PIN_MATRIX_REQUEST if the PIN is needed
• PASSPHRASE_REQUEST if the passphrase is needed
• FAILURE if the operation was unsuccessful

Specified by:

getAddress in interface HardwareWalletClient

Parameters:

account - The plain account number (0 gives maximum compatibility)

keyPurpose - The key purpose (RECEIVE_FUNDS,CHANGE,REFUND,AUTHENTICATION etc)

index - The plain index of the required address

showDisplay - True if the device should display the same address to allow the user to verify no tampering has occurred (recommended).

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

getPublicKey

public com.google.common.base.Optional<MessageEvent> getPublicKey(int account,
                                                                  org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose,
                                                                  int index)

Description copied from interface: HardwareWalletClient

Send the GET_PUBLIC_KEY message to the device. The device will respond by providing a public key calculated based on the BIP-44 deterministic wallet approach from the master node.

Expected response events are:

• PUBLIC_KEY if the operation succeeded (may take up to 10 seconds)
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

getPublicKey in interface HardwareWalletClient

Parameters:

account - The plain account number (0 gives maximum compatibility)

keyPurpose - The key purpose (RECEIVE_FUNDS,CHANGE,REFUND,AUTHENTICATION etc)

index - The plain index of the required address

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

getDeterministicHierarchy

public com.google.common.base.Optional<MessageEvent> getDeterministicHierarchy(List<org.bitcoinj.crypto.ChildNumber> childNumbers)

Description copied from interface: HardwareWalletClient

Send the GET_PUBLIC_KEY message to the device based on the given list of child numbers. The device will respond by providing an extended public key (xpub) calculated based on the BIP-44 deterministic wallet approach from the master node.

Expected response events are:

• PUBLIC_KEY if the operation succeeded (may take up to 10 seconds)
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

getDeterministicHierarchy in interface HardwareWalletClient

Parameters:

childNumbers - The list of child numbers to explore (some of which may be hardened)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

applySettings

public com.google.common.base.Optional<MessageEvent> applySettings(String language,
                                                                   String label)

Description copied from interface: HardwareWalletClient

Send the APPLY_SETTINGS message to the device.

Change language and/or label of the device

Expected response events are:

• SUCCESS if the operation succeeded
• BUTTON_REQUEST if a button press is needed
• PIN_MATRIX_REQUEST if the PIN is needed
• FAILURE if the operation was unsuccessful

Specified by:

applySettings in interface HardwareWalletClient

Parameters:

language - The language code

label - The label

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

entropyAck

public com.google.common.base.Optional<MessageEvent> entropyAck(byte[] entropy)

Description copied from interface: HardwareWalletClient

Send the ENTROPY_ACK message to the device in response to an ENTROPY_REQUEST. This allows the device to obtain additional entropy to offset potentially compromised hardware.

Expected response events are:

• BUTTON_REQUEST if the a button press is needed
• FAILURE if the operation was unsuccessful

Specified by:

entropyAck in interface HardwareWalletClient

Parameters:

entropy - The additional entropy

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

signMessage

public com.google.common.base.Optional<MessageEvent> signMessage(int account,
                                                                 org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose,
                                                                 int index,
                                                                 byte[] message)

Description copied from interface: HardwareWalletClient

Send the SIGN_MESSAGE message to the device containing a message to sign.

Expected response events are:

• MESSAGE_SIGNATURE if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

signMessage in interface HardwareWalletClient

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

verifyMessage

public com.google.common.base.Optional<MessageEvent> verifyMessage(org.bitcoinj.core.Address address,
                                                                   byte[] signature,
                                                                   byte[] message)

Description copied from interface: HardwareWalletClient

Send the VERIFY_MESSAGE message to the device containing a signed message to verify.

Expected response events are:

• SUCCESS if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

verifyMessage in interface HardwareWalletClient

Parameters:

address - The address to use for verification

signature - The signature

message - The message to sign

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

encryptMessage

public com.google.common.base.Optional<MessageEvent> encryptMessage(byte[] pubKey,
                                                                    byte[] message,
                                                                    boolean displayOnly)

Description copied from interface: HardwareWalletClient

Send the ENCRYPT_MESSAGE message to the device containing a message to encrypt.

Expected response events are:

• SUCCESS if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

encryptMessage in interface HardwareWalletClient

Parameters:

pubKey - The public key to use for encryption

message - The message to encrypt

displayOnly - True if the output is for display only

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

decryptMessage

public com.google.common.base.Optional<MessageEvent> decryptMessage(int account,
                                                                    org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose,
                                                                    int index,
                                                                    byte[] message)

Description copied from interface: HardwareWalletClient

Send the DECRYPT_MESSAGE message to the device containing a message to decrypt.

Expected response events are:

• SUCCESS if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

decryptMessage in interface HardwareWalletClient

Parameters:

account - The plain account number (0 gives maximum compatibility)

keyPurpose - The key purpose (RECEIVE_FUNDS,CHANGE,REFUND,AUTHENTICATION etc)

index - The plain index of the required address

message - The message to decrypt

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

cipherKeyValue

public com.google.common.base.Optional<MessageEvent> cipherKeyValue(int account,
                                                                    org.bitcoinj.wallet.KeyChain.KeyPurpose keyPurpose,
                                                                    int index,
                                                                    byte[] key,
                                                                    byte[] keyValue,
                                                                    boolean isEncrypting,
                                                                    boolean askOnDecrypt,
                                                                    boolean askOnEncrypt)

Description copied from interface: HardwareWalletClient

Send the CIPHER_KEY_VALUE_MESSAGE message to the device containing a key. The device will encrypt or decrypt the value of the given key.

Expected response events are:

• SUCCESS if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

cipherKeyValue in interface HardwareWalletClient

Parameters:

account - The plain account number (0 gives maximum compatibility)

keyPurpose - The key purpose (RECEIVE_FUNDS,CHANGE,REFUND,AUTHENTICATION etc)

index - The plain index of the required address

key - The cipher key (e.g. "Some text")

keyValue - The key value (e.g. "[16 bytes of random data]")

isEncrypting - True if encrypting

askOnDecrypt - True if device should ask on decrypting

askOnEncrypt - True if device should ask on encrypting

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

estimateTxSize

public com.google.common.base.Optional<MessageEvent> estimateTxSize(org.bitcoinj.core.Transaction tx)

Description copied from interface: HardwareWalletClient

Send the ESTIMATE_TX_SIZE message to the device to estimate the size of the transaction. This behaves exactly like the SignTx in that it uses the TxRequest mechanism to describe the transaction.

Expected response events are:

• TX_SIZE if the operation succeeded
• FAILURE if the operation was unsuccessful

Specified by:

estimateTxSize in interface HardwareWalletClient

Parameters:

tx - The Bitcoinj transaction providing all the necessary information (will not be modified)

Returns:

The response event if implementation is blocking. Absent if non-blocking or device failure.

sendMessage

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

Send a message to the device that should have a near-immediate (under 5 second) response.

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

Parameters:

message - The message to send to the hardware wallet

Returns:

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

sendMessage

protected abstract 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.

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

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