Class | Description |
---|---|
KeepKeyMessage | |
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.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.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.ButtonRequest |
Response: Device is waiting for HW button press.
|
KeepKeyMessage.ButtonRequest.Builder |
Response: Device is waiting for HW button press.
|
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.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.CipheredKeyValue |
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
KeepKeyMessage.CipheredKeyValue.Builder |
Response: Return ciphered/deciphered value
@prev CipherKeyValue
|
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.ClearSession |
Request: clear session (removes cached PIN, passphrase, etc).
|
KeepKeyMessage.ClearSession.Builder |
Request: clear session (removes cached PIN, passphrase, etc).
|
KeepKeyMessage.DebugLinkDecision |
Request: "Press" the button on the device
@next Success
|
KeepKeyMessage.DebugLinkDecision.Builder |
Request: "Press" the button on the device
@next Success
|
KeepKeyMessage.DebugLinkGetState |
Request: Computer asks for device state
@next DebugLinkState
|
KeepKeyMessage.DebugLinkGetState.Builder |
Request: Computer asks for device state
@next DebugLinkState
|
KeepKeyMessage.DebugLinkLog |
Response: Device wants host to log event
|
KeepKeyMessage.DebugLinkLog.Builder |
Response: Device wants host to log event
|
KeepKeyMessage.DebugLinkState |
Response: Device current state
@prev DebugLinkGetState
|
KeepKeyMessage.DebugLinkState.Builder |
Response: Device current state
@prev DebugLinkGetState
|
KeepKeyMessage.DebugLinkStop |
Request: Ask device to restart
|
KeepKeyMessage.DebugLinkStop.Builder |
Request: Ask device to restart
|
KeepKeyMessage.DecryptedMessage |
Response: Decrypted message
@prev DecryptedMessage
|
KeepKeyMessage.DecryptedMessage.Builder |
Response: Decrypted message
@prev DecryptedMessage
|
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.EncryptedMessage |
Response: Encrypted message
@prev EncryptMessage
|
KeepKeyMessage.EncryptedMessage.Builder |
Response: Encrypted message
@prev EncryptMessage
|
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.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.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.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.Failure |
Response: Failure of the previous request
|
KeepKeyMessage.Failure.Builder |
Response: Failure of the previous request
|
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.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.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.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.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.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.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.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.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.MessageSignature |
Response: Signed message
@prev SignMessage
|
KeepKeyMessage.MessageSignature.Builder |
Response: Signed message
@prev SignMessage
|
KeepKeyMessage.PassphraseAck |
Request: Send passphrase back
@prev PassphraseRequest
|
KeepKeyMessage.PassphraseAck.Builder |
Request: Send passphrase back
@prev PassphraseRequest
|
KeepKeyMessage.PassphraseRequest |
Response: Device awaits encryption passphrase
@next PassphraseAck
@next Cancel
|
KeepKeyMessage.PassphraseRequest.Builder |
Response: Device awaits encryption passphrase
@next PassphraseAck
@next Cancel
|
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.PinMatrixAck |
Request: Computer responds with encoded PIN
@prev PinMatrixRequest
|
KeepKeyMessage.PinMatrixAck.Builder |
Request: Computer responds with encoded PIN
@prev PinMatrixRequest
|
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.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.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.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.SignedIdentity |
Response: Device provides signed identity
@prev SignIdentity
|
KeepKeyMessage.SignedIdentity.Builder |
Response: Device provides signed identity
@prev SignIdentity
|
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.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.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.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.Success |
Response: Success of the previous request
|
KeepKeyMessage.Success.Builder |
Response: Success of the previous request
|
KeepKeyMessage.TxAck |
Request: Reported transaction data
@prev TxRequest
@next TxRequest
|
KeepKeyMessage.TxAck.Builder |
Request: Reported transaction data
@prev TxRequest
@next TxRequest
|
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.TxSize |
Response: Estimated size of the transaction
@prev EstimateTxSize
|
KeepKeyMessage.TxSize.Builder |
Response: Estimated size of the transaction
@prev EstimateTxSize
|
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.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.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.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.
|
KeepKeyStorage | |
KeepKeyStorage.Storage |
Internal persistent storage of device
|
KeepKeyStorage.Storage.Builder |
Internal persistent storage of device
|
KeepKeyType | |
KeepKeyType.CoinType |
Structure representing Coin
@used_in Features
|
KeepKeyType.CoinType.Builder |
Structure representing Coin
@used_in Features
|
KeepKeyType.HDNodePathType |
Protobuf type
HDNodePathType |
KeepKeyType.HDNodePathType.Builder |
Protobuf type
HDNodePathType |
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.IdentityType |
Structure representing identity data
@used_in IdentityType
|
KeepKeyType.IdentityType.Builder |
Structure representing identity data
@used_in IdentityType
|
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.TransactionType |
Structure representing transaction
@used_in SimpleSignTx
|
KeepKeyType.TransactionType.Builder |
Structure representing transaction
@used_in SimpleSignTx
|
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.TxOutputBinType |
Structure representing compiled transaction output
@used_in TransactionType
|
KeepKeyType.TxOutputBinType.Builder |
Structure representing compiled transaction output
@used_in TransactionType
|
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.TxRequestDetailsType |
Structure representing request details
@used_in TxRequest
|
KeepKeyType.TxRequestDetailsType.Builder |
Structure representing request details
@used_in TxRequest
|
KeepKeyType.TxRequestSerializedType |
Structure representing serialized data
@used_in TxRequest
|
KeepKeyType.TxRequestSerializedType.Builder |
Structure representing serialized data
@used_in TxRequest
|
Enum | Description |
---|---|
KeepKeyMessage.MessageType |
Mapping between KeepKey wire identifier (uint) and a protobuf message
|
KeepKeyType.ButtonRequestType |
Type of button request
@used_in ButtonRequest
|
KeepKeyType.FailureType |
Type of failures returned by Failure message
@used_in Failure
|
KeepKeyType.InputScriptType |
Type of script which will be used for transaction output
@used_in TxInputType
|
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
|
Copyright © 2013–2019 Bitcoin Solutions Ltd. All rights reserved.