Package | Description |
---|---|
com.keepkey.protobuf | |
org.multibit.hd.hardware.keepkey.utils |
Class and Description |
---|
KeepKeyMessage.Address
Response: Contains address derived from device private seed
@prev GetAddress
|
KeepKeyMessage.Address.Builder
Response: Contains address derived from device private seed
@prev GetAddress
|
KeepKeyMessage.AddressOrBuilder |
KeepKeyMessage.ApplySettings
Request: change language and/or label of the device
@next Success
@next Failure
@next ButtonRequest
@next PinMatrixRequest
|
KeepKeyMessage.ApplySettings.Builder
Request: change language and/or label of the device
@next Success
@next Failure
@next ButtonRequest
@next PinMatrixRequest
|
KeepKeyMessage.ApplySettingsOrBuilder |
KeepKeyMessage.ButtonAck
Request: Computer agrees to wait for HW button press
@prev ButtonRequest
|
KeepKeyMessage.ButtonAck.Builder
Request: Computer agrees to wait for HW button press
@prev ButtonRequest
|
KeepKeyMessage.ButtonAckOrBuilder |
KeepKeyMessage.ButtonRequest
Response: Device is waiting for HW button press.
|
KeepKeyMessage.ButtonRequest.Builder
Response: Device is waiting for HW button press.
|
KeepKeyMessage.ButtonRequestOrBuilder |
KeepKeyMessage.Cancel
Request: Abort last operation that required user interaction
@prev ButtonRequest
@prev PinMatrixRequest
@prev PassphraseRequest
|
KeepKeyMessage.Cancel.Builder
Request: Abort last operation that required user interaction
@prev ButtonRequest
@prev PinMatrixRequest
@prev PassphraseRequest
|
KeepKeyMessage.CancelOrBuilder |
KeepKeyMessage.ChangePin
Request: Starts workflow for setting/changing/removing the PIN
@next ButtonRequest
@next PinMatrixRequest
|
KeepKeyMessage.ChangePin.Builder
Request: Starts workflow for setting/changing/removing the PIN
@next ButtonRequest
@next PinMatrixRequest
|
KeepKeyMessage.ChangePinOrBuilder |
KeepKeyMessage.CipheredKeyValue
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
KeepKeyMessage.CipheredKeyValue.Builder
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
KeepKeyMessage.CipheredKeyValueOrBuilder |
KeepKeyMessage.CipherKeyValue
Request: Ask device to encrypt or decrypt value of given key
@next CipheredKeyValue
@next Failure
|
KeepKeyMessage.CipherKeyValue.Builder
Request: Ask device to encrypt or decrypt value of given key
@next CipheredKeyValue
@next Failure
|
KeepKeyMessage.CipherKeyValueOrBuilder |
KeepKeyMessage.ClearSession
Request: clear session (removes cached PIN, passphrase, etc).
|
KeepKeyMessage.ClearSession.Builder
Request: clear session (removes cached PIN, passphrase, etc).
|
KeepKeyMessage.ClearSessionOrBuilder |
KeepKeyMessage.DebugLinkDecision
Request: "Press" the button on the device
@next Success
|
KeepKeyMessage.DebugLinkDecision.Builder
Request: "Press" the button on the device
@next Success
|
KeepKeyMessage.DebugLinkDecisionOrBuilder |
KeepKeyMessage.DebugLinkGetState
Request: Computer asks for device state
@next DebugLinkState
|
KeepKeyMessage.DebugLinkGetState.Builder
Request: Computer asks for device state
@next DebugLinkState
|
KeepKeyMessage.DebugLinkGetStateOrBuilder |
KeepKeyMessage.DebugLinkLog
Response: Device wants host to log event
|
KeepKeyMessage.DebugLinkLog.Builder
Response: Device wants host to log event
|
KeepKeyMessage.DebugLinkLogOrBuilder |
KeepKeyMessage.DebugLinkState
Response: Device current state
@prev DebugLinkGetState
|
KeepKeyMessage.DebugLinkState.Builder
Response: Device current state
@prev DebugLinkGetState
|
KeepKeyMessage.DebugLinkStateOrBuilder |
KeepKeyMessage.DebugLinkStop
Request: Ask device to restart
|
KeepKeyMessage.DebugLinkStop.Builder
Request: Ask device to restart
|
KeepKeyMessage.DebugLinkStopOrBuilder |
KeepKeyMessage.DecryptedMessage
Response: Decrypted message
@prev DecryptedMessage
|
KeepKeyMessage.DecryptedMessage.Builder
Response: Decrypted message
@prev DecryptedMessage
|
KeepKeyMessage.DecryptedMessageOrBuilder |
KeepKeyMessage.DecryptMessage
Request: Ask device to decrypt message
@next Success
@next Failure
|
KeepKeyMessage.DecryptMessage.Builder
Request: Ask device to decrypt message
@next Success
@next Failure
|
KeepKeyMessage.DecryptMessageOrBuilder |
KeepKeyMessage.EncryptedMessage
Response: Encrypted message
@prev EncryptMessage
|
KeepKeyMessage.EncryptedMessage.Builder
Response: Encrypted message
@prev EncryptMessage
|
KeepKeyMessage.EncryptedMessageOrBuilder |
KeepKeyMessage.EncryptMessage
Request: Ask device to encrypt message
@next EncryptedMessage
@next Failure
|
KeepKeyMessage.EncryptMessage.Builder
Request: Ask device to encrypt message
@next EncryptedMessage
@next Failure
|
KeepKeyMessage.EncryptMessageOrBuilder |
KeepKeyMessage.Entropy
Response: Reply with random data generated by internal RNG
@prev GetEntropy
|
KeepKeyMessage.Entropy.Builder
Response: Reply with random data generated by internal RNG
@prev GetEntropy
|
KeepKeyMessage.EntropyAck
Request: Provide additional entropy for seed generation function
@prev EntropyRequest
@next ButtonRequest
|
KeepKeyMessage.EntropyAck.Builder
Request: Provide additional entropy for seed generation function
@prev EntropyRequest
@next ButtonRequest
|
KeepKeyMessage.EntropyAckOrBuilder |
KeepKeyMessage.EntropyOrBuilder |
KeepKeyMessage.EntropyRequest
Response: Ask for additional entropy from host computer
@prev ResetDevice
@next EntropyAck
|
KeepKeyMessage.EntropyRequest.Builder
Response: Ask for additional entropy from host computer
@prev ResetDevice
@next EntropyAck
|
KeepKeyMessage.EntropyRequestOrBuilder |
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
|
KeepKeyMessage.EstimateTxSize.Builder
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
|
KeepKeyMessage.EstimateTxSizeOrBuilder |
KeepKeyMessage.Failure
Response: Failure of the previous request
|
KeepKeyMessage.Failure.Builder
Response: Failure of the previous request
|
KeepKeyMessage.FailureOrBuilder |
KeepKeyMessage.Features
Response: Reports various information about the device
@prev Initialize
@prev GetFeatures
|
KeepKeyMessage.Features.Builder
Response: Reports various information about the device
@prev Initialize
@prev GetFeatures
|
KeepKeyMessage.FeaturesOrBuilder |
KeepKeyMessage.FirmwareErase
Request: Ask device to erase its firmware
@next Success
@next Failure
|
KeepKeyMessage.FirmwareErase.Builder
Request: Ask device to erase its firmware
@next Success
@next Failure
|
KeepKeyMessage.FirmwareEraseOrBuilder |
KeepKeyMessage.FirmwareUpload
Request: Send firmware in binary form to the device
@next Success
@next Failure
|
KeepKeyMessage.FirmwareUpload.Builder
Request: Send firmware in binary form to the device
@next Success
@next Failure
|
KeepKeyMessage.FirmwareUploadOrBuilder |
KeepKeyMessage.GetAddress
Request: Ask device for address corresponding to address_n path
@next PassphraseRequest
@next Address
@next Failure
|
KeepKeyMessage.GetAddress.Builder
Request: Ask device for address corresponding to address_n path
@next PassphraseRequest
@next Address
@next Failure
|
KeepKeyMessage.GetAddressOrBuilder |
KeepKeyMessage.GetEntropy
Request: Request a sample of random data generated by hardware RNG.
|
KeepKeyMessage.GetEntropy.Builder
Request: Request a sample of random data generated by hardware RNG.
|
KeepKeyMessage.GetEntropyOrBuilder |
KeepKeyMessage.GetFeatures
Request: Ask for device details (no device reset)
@next Features
|
KeepKeyMessage.GetFeatures.Builder
Request: Ask for device details (no device reset)
@next Features
|
KeepKeyMessage.GetFeaturesOrBuilder |
KeepKeyMessage.GetPublicKey
Request: Ask device for public key corresponding to address_n path
@next PassphraseRequest
@next PublicKey
@next Failure
|
KeepKeyMessage.GetPublicKey.Builder
Request: Ask device for public key corresponding to address_n path
@next PassphraseRequest
@next PublicKey
@next Failure
|
KeepKeyMessage.GetPublicKeyOrBuilder |
KeepKeyMessage.Initialize
Request: Reset device to default state and ask for device details
@next Features
|
KeepKeyMessage.Initialize.Builder
Request: Reset device to default state and ask for device details
@next Features
|
KeepKeyMessage.InitializeOrBuilder |
KeepKeyMessage.LoadDevice
Request: Load seed and related internal settings from the computer
@next ButtonRequest
@next Success
@next Failure
|
KeepKeyMessage.LoadDevice.Builder
Request: Load seed and related internal settings from the computer
@next ButtonRequest
@next Success
@next Failure
|
KeepKeyMessage.LoadDeviceOrBuilder |
KeepKeyMessage.MessageSignature
Response: Signed message
@prev SignMessage
|
KeepKeyMessage.MessageSignature.Builder
Response: Signed message
@prev SignMessage
|
KeepKeyMessage.MessageSignatureOrBuilder |
KeepKeyMessage.MessageType
Mapping between KeepKey wire identifier (uint) and a protobuf message
|
KeepKeyMessage.PassphraseAck
Request: Send passphrase back
@prev PassphraseRequest
|
KeepKeyMessage.PassphraseAck.Builder
Request: Send passphrase back
@prev PassphraseRequest
|
KeepKeyMessage.PassphraseAckOrBuilder |
KeepKeyMessage.PassphraseRequest
Response: Device awaits encryption passphrase
@next PassphraseAck
@next Cancel
|
KeepKeyMessage.PassphraseRequest.Builder
Response: Device awaits encryption passphrase
@next PassphraseAck
@next Cancel
|
KeepKeyMessage.PassphraseRequestOrBuilder |
KeepKeyMessage.Ping
Request: Test if the device is alive, device sends back the message in Success response
@next Success
|
KeepKeyMessage.Ping.Builder
Request: Test if the device is alive, device sends back the message in Success response
@next Success
|
KeepKeyMessage.PingOrBuilder |
KeepKeyMessage.PinMatrixAck
Request: Computer responds with encoded PIN
@prev PinMatrixRequest
|
KeepKeyMessage.PinMatrixAck.Builder
Request: Computer responds with encoded PIN
@prev PinMatrixRequest
|
KeepKeyMessage.PinMatrixAckOrBuilder |
KeepKeyMessage.PinMatrixRequest
Response: Device is asking computer to show PIN matrix and awaits PIN encoded using this matrix scheme
@next PinMatrixAck
@next Cancel
|
KeepKeyMessage.PinMatrixRequest.Builder
Response: Device is asking computer to show PIN matrix and awaits PIN encoded using this matrix scheme
@next PinMatrixAck
@next Cancel
|
KeepKeyMessage.PinMatrixRequestOrBuilder |
KeepKeyMessage.PublicKey
Response: Contains public key derived from device private seed
@prev GetPublicKey
|
KeepKeyMessage.PublicKey.Builder
Response: Contains public key derived from device private seed
@prev GetPublicKey
|
KeepKeyMessage.PublicKeyOrBuilder |
KeepKeyMessage.RecoveryDevice
Request: Start recovery workflow asking user for specific words of mnemonic
Used to recovery device safely even on untrusted computer.
|
KeepKeyMessage.RecoveryDevice.Builder
Request: Start recovery workflow asking user for specific words of mnemonic
Used to recovery device safely even on untrusted computer.
|
KeepKeyMessage.RecoveryDeviceOrBuilder |
KeepKeyMessage.ResetDevice
Request: Ask device to do initialization involving user interaction
@next EntropyRequest
@next Failure
|
KeepKeyMessage.ResetDevice.Builder
Request: Ask device to do initialization involving user interaction
@next EntropyRequest
@next Failure
|
KeepKeyMessage.ResetDeviceOrBuilder |
KeepKeyMessage.SignedIdentity
Response: Device provides signed identity
@prev SignIdentity
|
KeepKeyMessage.SignedIdentity.Builder
Response: Device provides signed identity
@prev SignIdentity
|
KeepKeyMessage.SignedIdentityOrBuilder |
KeepKeyMessage.SignIdentity
Request: Ask device to sign identity
@next SignedIdentity
@next Failure
|
KeepKeyMessage.SignIdentity.Builder
Request: Ask device to sign identity
@next SignedIdentity
@next Failure
|
KeepKeyMessage.SignIdentityOrBuilder |
KeepKeyMessage.SignMessage
Request: Ask device to sign message
@next MessageSignature
@next Failure
|
KeepKeyMessage.SignMessage.Builder
Request: Ask device to sign message
@next MessageSignature
@next Failure
|
KeepKeyMessage.SignMessageOrBuilder |
KeepKeyMessage.SignTx
Request: Ask device to sign transaction
@next PassphraseRequest
@next PinMatrixRequest
@next TxRequest
@next Failure
|
KeepKeyMessage.SignTx.Builder
Request: Ask device to sign transaction
@next PassphraseRequest
@next PinMatrixRequest
@next TxRequest
@next Failure
|
KeepKeyMessage.SignTxOrBuilder |
KeepKeyMessage.SimpleSignTx
Request: Simplified transaction signing
This method doesn't support streaming, so there are hardware limits in number of inputs and outputs.
|
KeepKeyMessage.SimpleSignTx.Builder
Request: Simplified transaction signing
This method doesn't support streaming, so there are hardware limits in number of inputs and outputs.
|
KeepKeyMessage.SimpleSignTxOrBuilder |
KeepKeyMessage.Success
Response: Success of the previous request
|
KeepKeyMessage.Success.Builder
Response: Success of the previous request
|
KeepKeyMessage.SuccessOrBuilder |
KeepKeyMessage.TxAck
Request: Reported transaction data
@prev TxRequest
@next TxRequest
|
KeepKeyMessage.TxAck.Builder
Request: Reported transaction data
@prev TxRequest
@next TxRequest
|
KeepKeyMessage.TxAckOrBuilder |
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
|
KeepKeyMessage.TxRequest.Builder
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
|
KeepKeyMessage.TxRequestOrBuilder |
KeepKeyMessage.TxSize
Response: Estimated size of the transaction
@prev EstimateTxSize
|
KeepKeyMessage.TxSize.Builder
Response: Estimated size of the transaction
@prev EstimateTxSize
|
KeepKeyMessage.TxSizeOrBuilder |
KeepKeyMessage.VerifyMessage
Request: Ask device to verify message
@next Success
@next Failure
|
KeepKeyMessage.VerifyMessage.Builder
Request: Ask device to verify message
@next Success
@next Failure
|
KeepKeyMessage.VerifyMessageOrBuilder |
KeepKeyMessage.WipeDevice
Request: Request device to wipe all sensitive data and settings
@next ButtonRequest
|
KeepKeyMessage.WipeDevice.Builder
Request: Request device to wipe all sensitive data and settings
@next ButtonRequest
|
KeepKeyMessage.WipeDeviceOrBuilder |
KeepKeyMessage.WordAck
Request: Computer replies with word from the mnemonic
@prev WordRequest
@next WordRequest
@next Success
@next Failure
|
KeepKeyMessage.WordAck.Builder
Request: Computer replies with word from the mnemonic
@prev WordRequest
@next WordRequest
@next Success
@next Failure
|
KeepKeyMessage.WordAckOrBuilder |
KeepKeyMessage.WordRequest
Response: Device is waiting for user to enter word of the mnemonic
Its position is shown only on device's internal display.
|
KeepKeyMessage.WordRequest.Builder
Response: Device is waiting for user to enter word of the mnemonic
Its position is shown only on device's internal display.
|
KeepKeyMessage.WordRequestOrBuilder |
KeepKeyStorage.Storage
Internal persistent storage of device
|
KeepKeyStorage.Storage.Builder
Internal persistent storage of device
|
KeepKeyStorage.StorageOrBuilder |
KeepKeyType.ButtonRequestType
Type of button request
@used_in ButtonRequest
|
KeepKeyType.CoinType
Structure representing Coin
@used_in Features
|
KeepKeyType.CoinType.Builder
Structure representing Coin
@used_in Features
|
KeepKeyType.CoinTypeOrBuilder |
KeepKeyType.FailureType
Type of failures returned by Failure message
@used_in Failure
|
KeepKeyType.HDNodePathType
Protobuf type
HDNodePathType |
KeepKeyType.HDNodePathType.Builder
Protobuf type
HDNodePathType |
KeepKeyType.HDNodePathTypeOrBuilder |
KeepKeyType.HDNodeType
Structure representing BIP32 (hierarchical deterministic) node
Used for imports of private key into the device and exporting public key out of device
@used_in PublicKey
@used_in LoadDevice
@used_in DebugLinkState
@used_in Storage
|
KeepKeyType.HDNodeType.Builder
Structure representing BIP32 (hierarchical deterministic) node
Used for imports of private key into the device and exporting public key out of device
@used_in PublicKey
@used_in LoadDevice
@used_in DebugLinkState
@used_in Storage
|
KeepKeyType.HDNodeTypeOrBuilder |
KeepKeyType.IdentityType
Structure representing identity data
@used_in IdentityType
|
KeepKeyType.IdentityType.Builder
Structure representing identity data
@used_in IdentityType
|
KeepKeyType.IdentityTypeOrBuilder |
KeepKeyType.InputScriptType
Type of script which will be used for transaction output
@used_in TxInputType
|
KeepKeyType.MultisigRedeemScriptType
Type of redeem script used in input
@used_in TxInputType
|
KeepKeyType.MultisigRedeemScriptType.Builder
Type of redeem script used in input
@used_in TxInputType
|
KeepKeyType.MultisigRedeemScriptTypeOrBuilder |
KeepKeyType.OutputScriptType
Type of script which will be used for transaction output
@used_in TxOutputType
|
KeepKeyType.PinMatrixRequestType
Type of PIN request
@used_in PinMatrixRequest
|
KeepKeyType.RequestType
Type of information required by transaction signing process
@used_in TxRequest
|
KeepKeyType.TransactionType
Structure representing transaction
@used_in SimpleSignTx
|
KeepKeyType.TransactionType.Builder
Structure representing transaction
@used_in SimpleSignTx
|
KeepKeyType.TransactionTypeOrBuilder |
KeepKeyType.TxInputType
Structure representing transaction input
@used_in SimpleSignTx
@used_in TransactionType
|
KeepKeyType.TxInputType.Builder
Structure representing transaction input
@used_in SimpleSignTx
@used_in TransactionType
|
KeepKeyType.TxInputTypeOrBuilder |
KeepKeyType.TxOutputBinType
Structure representing compiled transaction output
@used_in TransactionType
|
KeepKeyType.TxOutputBinType.Builder
Structure representing compiled transaction output
@used_in TransactionType
|
KeepKeyType.TxOutputBinTypeOrBuilder |
KeepKeyType.TxOutputType
Structure representing transaction output
@used_in SimpleSignTx
@used_in TransactionType
|
KeepKeyType.TxOutputType.Builder
Structure representing transaction output
@used_in SimpleSignTx
@used_in TransactionType
|
KeepKeyType.TxOutputTypeOrBuilder |
KeepKeyType.TxRequestDetailsType
Structure representing request details
@used_in TxRequest
|
KeepKeyType.TxRequestDetailsType.Builder
Structure representing request details
@used_in TxRequest
|
KeepKeyType.TxRequestDetailsTypeOrBuilder |
KeepKeyType.TxRequestSerializedType
Structure representing serialized data
@used_in TxRequest
|
KeepKeyType.TxRequestSerializedType.Builder
Structure representing serialized data
@used_in TxRequest
|
KeepKeyType.TxRequestSerializedTypeOrBuilder |
Class and Description |
---|
KeepKeyMessage.Address
Response: Contains address derived from device private seed
@prev GetAddress
|
KeepKeyMessage.ButtonRequest
Response: Device is waiting for HW button press.
|
KeepKeyMessage.CipheredKeyValue
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
KeepKeyMessage.Failure
Response: Failure of the previous request
|
KeepKeyMessage.Features
Response: Reports various information about the device
@prev Initialize
@prev GetFeatures
|
KeepKeyMessage.MessageSignature
Response: Signed message
@prev SignMessage
|
KeepKeyMessage.MessageType
Mapping between KeepKey wire identifier (uint) and a protobuf message
|
KeepKeyMessage.PinMatrixRequest
Response: Device is asking computer to show PIN matrix and awaits PIN encoded using this matrix scheme
@next PinMatrixAck
@next Cancel
|
KeepKeyMessage.PublicKey
Response: Contains public key derived from device private seed
@prev GetPublicKey
|
KeepKeyMessage.Success
Response: Success of the previous request
|
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
|
KeepKeyType.ButtonRequestType
Type of button request
@used_in ButtonRequest
|
KeepKeyType.FailureType
Type of failures returned by Failure message
@used_in Failure
|
KeepKeyType.HDNodeType
Structure representing BIP32 (hierarchical deterministic) node
Used for imports of private key into the device and exporting public key out of device
@used_in PublicKey
@used_in LoadDevice
@used_in DebugLinkState
@used_in Storage
|
KeepKeyType.PinMatrixRequestType
Type of PIN request
@used_in PinMatrixRequest
|
KeepKeyType.TransactionType
Structure representing transaction
@used_in SimpleSignTx
|
Copyright © 2013–2017 Bitcoin Solutions Ltd. All rights reserved.