public final class KeepKeyMessage extends Object
Modifier and Type | Class and Description |
---|---|
static class |
KeepKeyMessage.Address
Response: Contains address derived from device private seed
@prev GetAddress
|
static interface |
KeepKeyMessage.AddressOrBuilder |
static class |
KeepKeyMessage.ApplySettings
Request: change language and/or label of the device
@next Success
@next Failure
@next ButtonRequest
@next PinMatrixRequest
|
static interface |
KeepKeyMessage.ApplySettingsOrBuilder |
static class |
KeepKeyMessage.ButtonAck
Request: Computer agrees to wait for HW button press
@prev ButtonRequest
|
static interface |
KeepKeyMessage.ButtonAckOrBuilder |
static class |
KeepKeyMessage.ButtonRequest
Response: Device is waiting for HW button press.
|
static interface |
KeepKeyMessage.ButtonRequestOrBuilder |
static class |
KeepKeyMessage.Cancel
Request: Abort last operation that required user interaction
@prev ButtonRequest
@prev PinMatrixRequest
@prev PassphraseRequest
|
static interface |
KeepKeyMessage.CancelOrBuilder |
static class |
KeepKeyMessage.ChangePin
Request: Starts workflow for setting/changing/removing the PIN
@next ButtonRequest
@next PinMatrixRequest
|
static interface |
KeepKeyMessage.ChangePinOrBuilder |
static class |
KeepKeyMessage.CipheredKeyValue
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
static interface |
KeepKeyMessage.CipheredKeyValueOrBuilder |
static class |
KeepKeyMessage.CipherKeyValue
Request: Ask device to encrypt or decrypt value of given key
@next CipheredKeyValue
@next Failure
|
static interface |
KeepKeyMessage.CipherKeyValueOrBuilder |
static class |
KeepKeyMessage.ClearSession
Request: clear session (removes cached PIN, passphrase, etc).
|
static interface |
KeepKeyMessage.ClearSessionOrBuilder |
static class |
KeepKeyMessage.DebugLinkDecision
Request: "Press" the button on the device
@next Success
|
static interface |
KeepKeyMessage.DebugLinkDecisionOrBuilder |
static class |
KeepKeyMessage.DebugLinkGetState
Request: Computer asks for device state
@next DebugLinkState
|
static interface |
KeepKeyMessage.DebugLinkGetStateOrBuilder |
static class |
KeepKeyMessage.DebugLinkLog
Response: Device wants host to log event
|
static interface |
KeepKeyMessage.DebugLinkLogOrBuilder |
static class |
KeepKeyMessage.DebugLinkState
Response: Device current state
@prev DebugLinkGetState
|
static interface |
KeepKeyMessage.DebugLinkStateOrBuilder |
static class |
KeepKeyMessage.DebugLinkStop
Request: Ask device to restart
|
static interface |
KeepKeyMessage.DebugLinkStopOrBuilder |
static class |
KeepKeyMessage.DecryptedMessage
Response: Decrypted message
@prev DecryptedMessage
|
static interface |
KeepKeyMessage.DecryptedMessageOrBuilder |
static class |
KeepKeyMessage.DecryptMessage
Request: Ask device to decrypt message
@next Success
@next Failure
|
static interface |
KeepKeyMessage.DecryptMessageOrBuilder |
static class |
KeepKeyMessage.EncryptedMessage
Response: Encrypted message
@prev EncryptMessage
|
static interface |
KeepKeyMessage.EncryptedMessageOrBuilder |
static class |
KeepKeyMessage.EncryptMessage
Request: Ask device to encrypt message
@next EncryptedMessage
@next Failure
|
static interface |
KeepKeyMessage.EncryptMessageOrBuilder |
static class |
KeepKeyMessage.Entropy
Response: Reply with random data generated by internal RNG
@prev GetEntropy
|
static class |
KeepKeyMessage.EntropyAck
Request: Provide additional entropy for seed generation function
@prev EntropyRequest
@next ButtonRequest
|
static interface |
KeepKeyMessage.EntropyAckOrBuilder |
static interface |
KeepKeyMessage.EntropyOrBuilder |
static class |
KeepKeyMessage.EntropyRequest
Response: Ask for additional entropy from host computer
@prev ResetDevice
@next EntropyAck
|
static interface |
KeepKeyMessage.EntropyRequestOrBuilder |
static class |
KeepKeyMessage.EstimateTxSize
Request: Estimated size of the transaction
This behaves exactly like SignTx, which means that it can ask using TxRequest
This call is non-blocking (except possible PassphraseRequest to unlock the seed)
@next TxSize
@next Failure
|
static interface |
KeepKeyMessage.EstimateTxSizeOrBuilder |
static class |
KeepKeyMessage.Failure
Response: Failure of the previous request
|
static interface |
KeepKeyMessage.FailureOrBuilder |
static class |
KeepKeyMessage.Features
Response: Reports various information about the device
@prev Initialize
@prev GetFeatures
|
static interface |
KeepKeyMessage.FeaturesOrBuilder |
static class |
KeepKeyMessage.FirmwareErase
Request: Ask device to erase its firmware
@next Success
@next Failure
|
static interface |
KeepKeyMessage.FirmwareEraseOrBuilder |
static class |
KeepKeyMessage.FirmwareUpload
Request: Send firmware in binary form to the device
@next Success
@next Failure
|
static interface |
KeepKeyMessage.FirmwareUploadOrBuilder |
static class |
KeepKeyMessage.GetAddress
Request: Ask device for address corresponding to address_n path
@next PassphraseRequest
@next Address
@next Failure
|
static interface |
KeepKeyMessage.GetAddressOrBuilder |
static class |
KeepKeyMessage.GetEntropy
Request: Request a sample of random data generated by hardware RNG.
|
static interface |
KeepKeyMessage.GetEntropyOrBuilder |
static class |
KeepKeyMessage.GetFeatures
Request: Ask for device details (no device reset)
@next Features
|
static interface |
KeepKeyMessage.GetFeaturesOrBuilder |
static class |
KeepKeyMessage.GetPublicKey
Request: Ask device for public key corresponding to address_n path
@next PassphraseRequest
@next PublicKey
@next Failure
|
static interface |
KeepKeyMessage.GetPublicKeyOrBuilder |
static class |
KeepKeyMessage.Initialize
Request: Reset device to default state and ask for device details
@next Features
|
static interface |
KeepKeyMessage.InitializeOrBuilder |
static class |
KeepKeyMessage.LoadDevice
Request: Load seed and related internal settings from the computer
@next ButtonRequest
@next Success
@next Failure
|
static interface |
KeepKeyMessage.LoadDeviceOrBuilder |
static class |
KeepKeyMessage.MessageSignature
Response: Signed message
@prev SignMessage
|
static interface |
KeepKeyMessage.MessageSignatureOrBuilder |
static class |
KeepKeyMessage.MessageType
Mapping between KeepKey wire identifier (uint) and a protobuf message
|
static class |
KeepKeyMessage.PassphraseAck
Request: Send passphrase back
@prev PassphraseRequest
|
static interface |
KeepKeyMessage.PassphraseAckOrBuilder |
static class |
KeepKeyMessage.PassphraseRequest
Response: Device awaits encryption passphrase
@next PassphraseAck
@next Cancel
|
static interface |
KeepKeyMessage.PassphraseRequestOrBuilder |
static class |
KeepKeyMessage.Ping
Request: Test if the device is alive, device sends back the message in Success response
@next Success
|
static interface |
KeepKeyMessage.PingOrBuilder |
static class |
KeepKeyMessage.PinMatrixAck
Request: Computer responds with encoded PIN
@prev PinMatrixRequest
|
static interface |
KeepKeyMessage.PinMatrixAckOrBuilder |
static class |
KeepKeyMessage.PinMatrixRequest
Response: Device is asking computer to show PIN matrix and awaits PIN encoded using this matrix scheme
@next PinMatrixAck
@next Cancel
|
static interface |
KeepKeyMessage.PinMatrixRequestOrBuilder |
static class |
KeepKeyMessage.PublicKey
Response: Contains public key derived from device private seed
@prev GetPublicKey
|
static interface |
KeepKeyMessage.PublicKeyOrBuilder |
static class |
KeepKeyMessage.RecoveryDevice
Request: Start recovery workflow asking user for specific words of mnemonic
Used to recovery device safely even on untrusted computer.
|
static interface |
KeepKeyMessage.RecoveryDeviceOrBuilder |
static class |
KeepKeyMessage.ResetDevice
Request: Ask device to do initialization involving user interaction
@next EntropyRequest
@next Failure
|
static interface |
KeepKeyMessage.ResetDeviceOrBuilder |
static class |
KeepKeyMessage.SignedIdentity
Response: Device provides signed identity
@prev SignIdentity
|
static interface |
KeepKeyMessage.SignedIdentityOrBuilder |
static class |
KeepKeyMessage.SignIdentity
Request: Ask device to sign identity
@next SignedIdentity
@next Failure
|
static interface |
KeepKeyMessage.SignIdentityOrBuilder |
static class |
KeepKeyMessage.SignMessage
Request: Ask device to sign message
@next MessageSignature
@next Failure
|
static interface |
KeepKeyMessage.SignMessageOrBuilder |
static class |
KeepKeyMessage.SignTx
Request: Ask device to sign transaction
@next PassphraseRequest
@next PinMatrixRequest
@next TxRequest
@next Failure
|
static interface |
KeepKeyMessage.SignTxOrBuilder |
static class |
KeepKeyMessage.SimpleSignTx
Request: Simplified transaction signing
This method doesn't support streaming, so there are hardware limits in number of inputs and outputs.
|
static interface |
KeepKeyMessage.SimpleSignTxOrBuilder |
static class |
KeepKeyMessage.Success
Response: Success of the previous request
|
static interface |
KeepKeyMessage.SuccessOrBuilder |
static class |
KeepKeyMessage.TxAck
Request: Reported transaction data
@prev TxRequest
@next TxRequest
|
static interface |
KeepKeyMessage.TxAckOrBuilder |
static class |
KeepKeyMessage.TxRequest
Response: Device asks for information for signing transaction or returns the last result
If request_index is set, device awaits TxAck message (with fields filled in according to request_type)
If signature_index is set, 'signature' contains signed input of signature_index's input
@prev SignTx
@prev SimpleSignTx
@prev TxAck
|
static interface |
KeepKeyMessage.TxRequestOrBuilder |
static class |
KeepKeyMessage.TxSize
Response: Estimated size of the transaction
@prev EstimateTxSize
|
static interface |
KeepKeyMessage.TxSizeOrBuilder |
static class |
KeepKeyMessage.VerifyMessage
Request: Ask device to verify message
@next Success
@next Failure
|
static interface |
KeepKeyMessage.VerifyMessageOrBuilder |
static class |
KeepKeyMessage.WipeDevice
Request: Request device to wipe all sensitive data and settings
@next ButtonRequest
|
static interface |
KeepKeyMessage.WipeDeviceOrBuilder |
static class |
KeepKeyMessage.WordAck
Request: Computer replies with word from the mnemonic
@prev WordRequest
@next WordRequest
@next Success
@next Failure
|
static interface |
KeepKeyMessage.WordAckOrBuilder |
static class |
KeepKeyMessage.WordRequest
Response: Device is waiting for user to enter word of the mnemonic
Its position is shown only on device's internal display.
|
static interface |
KeepKeyMessage.WordRequestOrBuilder |
Modifier and Type | Method and Description |
---|---|
static com.google.protobuf.Descriptors.FileDescriptor |
getDescriptor() |
static void |
registerAllExtensions(com.google.protobuf.ExtensionRegistry registry) |
static void |
registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry) |
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()
Copyright © 2013–2019 Bitcoin Solutions Ltd. All rights reserved.