mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-12-23 23:08:14 +00:00
494 lines
15 KiB
Protocol Buffer
494 lines
15 KiB
Protocol Buffer
syntax = "proto2";
|
|
package hw.trezor.messages.monero;
|
|
|
|
// Sugar for easier handling in Java
|
|
option java_package = "com.satoshilabs.trezor.lib.protobuf";
|
|
option java_outer_classname = "TrezorMessageMonero";
|
|
|
|
/**
|
|
* Structure representing Monero transaction source entry, UTXO
|
|
* @embed
|
|
*/
|
|
message MoneroTransactionSourceEntry {
|
|
repeated MoneroOutputEntry outputs = 1;
|
|
optional uint64 real_output = 2;
|
|
optional bytes real_out_tx_key = 3;
|
|
repeated bytes real_out_additional_tx_keys = 4;
|
|
optional uint64 real_output_in_tx_index = 5;
|
|
optional uint64 amount = 6;
|
|
optional bool rct = 7;
|
|
optional bytes mask = 8;
|
|
optional MoneroMultisigKLRki multisig_kLRki = 9;
|
|
message MoneroOutputEntry {
|
|
optional uint64 idx = 1;
|
|
optional MoneroRctKey key = 2;
|
|
message MoneroRctKey {
|
|
optional bytes dest = 1;
|
|
optional bytes mask = 2;
|
|
}
|
|
}
|
|
message MoneroMultisigKLRki {
|
|
optional bytes K = 1;
|
|
optional bytes L = 2;
|
|
optional bytes R = 3;
|
|
optional bytes ki = 4;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Structure representing Monero transaction destination entry
|
|
* @embed
|
|
*/
|
|
message MoneroTransactionDestinationEntry {
|
|
optional uint64 amount = 1;
|
|
optional MoneroAccountPublicAddress addr = 2;
|
|
optional bool is_subaddress = 3;
|
|
/**
|
|
* Structure representing Monero public address
|
|
*/
|
|
message MoneroAccountPublicAddress {
|
|
optional bytes spend_public_key = 1;
|
|
optional bytes view_public_key = 2;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Range sig parameters / data.
|
|
*/
|
|
message MoneroTransactionRsigData {
|
|
optional uint32 version = 1;
|
|
optional uint32 rsig_type = 2;
|
|
optional uint32 offload_type = 3;
|
|
repeated uint64 grouping = 4; // aggregation scheme for BP
|
|
|
|
optional uint32 step = 5;
|
|
optional uint64 operation = 6;
|
|
optional bytes seed = 7; // determ. mask seed
|
|
optional bytes mask = 8; // mask vector
|
|
optional bytes amount = 9; // amount vector
|
|
optional bytes rsig = 10; // range sig, full or partial
|
|
repeated MoneroTransactionDestinationEntry outputs = 11;
|
|
}
|
|
|
|
/**
|
|
* Request: Ask device for public address derived from seed and address_n
|
|
* @start
|
|
* @next MoneroAddress
|
|
* @next Failure
|
|
*/
|
|
message MoneroGetAddress {
|
|
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
|
|
optional bool show_display = 2; // Optionally show on display before sending the result
|
|
optional uint32 network_type = 3; // Main-net / testnet / stagenet
|
|
optional uint32 account = 4; // Major subaddr index
|
|
optional uint32 minor = 5; // Minor subaddr index
|
|
}
|
|
|
|
/**
|
|
* Response: Contains Monero watch-only credentials derived from device private seed
|
|
* @end
|
|
*/
|
|
message MoneroAddress {
|
|
optional bytes address = 1;
|
|
}
|
|
|
|
/**
|
|
* Request: Ask device for watch only credentials
|
|
* @start
|
|
* @next MoneroWatchKey
|
|
* @next Failure
|
|
*/
|
|
message MoneroGetWatchKey {
|
|
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
|
|
optional uint32 network_type = 2; // Main-net / testnet / stagenet
|
|
}
|
|
|
|
/**
|
|
* Response: Contains Monero watch-only credentials derived from device private seed
|
|
* @end
|
|
*/
|
|
message MoneroWatchKey {
|
|
optional bytes watch_key = 1;
|
|
optional bytes address = 2;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Initializes transaction signing.
|
|
* @start
|
|
* @next MoneroTransactionInitAck
|
|
*/
|
|
message MoneroTransactionInitRequest {
|
|
optional uint32 version = 1;
|
|
repeated uint32 address_n = 2;
|
|
optional uint32 network_type = 3; // Main-net / testnet / stagenet
|
|
optional MoneroTransactionData tsx_data = 4;
|
|
/**
|
|
* Structure representing Monero initial transaction information
|
|
*/
|
|
message MoneroTransactionData {
|
|
optional uint32 version = 1;
|
|
optional bytes payment_id = 2;
|
|
optional uint64 unlock_time = 3;
|
|
repeated MoneroTransactionDestinationEntry outputs = 4;
|
|
optional MoneroTransactionDestinationEntry change_dts = 5;
|
|
optional uint32 num_inputs = 6;
|
|
optional uint32 mixin = 7;
|
|
optional uint64 fee = 8;
|
|
optional uint32 account = 9;
|
|
repeated uint32 minor_indices = 10;
|
|
optional bool is_multisig = 11;
|
|
optional bytes exp_tx_prefix_hash = 12;
|
|
repeated bytes use_tx_keys = 13;
|
|
optional MoneroTransactionRsigData rsig_data = 14;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Response: Response to transaction signing initialization.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionInitAck {
|
|
optional uint32 version = 1;
|
|
optional uint32 status = 2;
|
|
optional bool in_memory = 3;
|
|
repeated bytes hmacs = 4;
|
|
optional bool many_inputs = 5;
|
|
optional bool many_outputs = 6;
|
|
optional MoneroTransactionRsigData rsig_data = 7;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sends one UTXO to device
|
|
* @next MoneroTransactionSetInputAck
|
|
*/
|
|
message MoneroTransactionSetInputRequest {
|
|
optional uint32 version = 1;
|
|
optional MoneroTransactionSourceEntry src_entr = 2;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to setting UTXO for signature. Contains sealed values needed for further protocol steps.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionSetInputAck {
|
|
optional bytes vini = 1; // xmrtypes.TxinToKey
|
|
optional bytes vini_hmac = 2;
|
|
optional bytes pseudo_out = 3;
|
|
optional bytes pseudo_out_hmac = 4;
|
|
optional bytes alpha_enc = 5;
|
|
optional bytes spend_enc = 6;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Permutation on key images.
|
|
* @next MoneroTransactionInputsPermutationAck
|
|
*/
|
|
message MoneroTransactionInputsPermutationRequest {
|
|
repeated uint32 perm = 1;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to setting permutation on key images
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionInputsPermutationAck {
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sends one UTXO to device together with sealed values.
|
|
* @next MoneroTransactionInputViniAck
|
|
*/
|
|
message MoneroTransactionInputViniRequest {
|
|
optional MoneroTransactionSourceEntry src_entr = 1;
|
|
optional bytes vini = 2; // xmrtypes.TxinToKey
|
|
optional bytes vini_hmac = 3;
|
|
optional bytes pseudo_out = 4;
|
|
optional bytes pseudo_out_hmac = 5;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to setting UTXO to the device
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionInputViniAck {
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sent after all inputs have been sent. Useful for rangeisg offloading.
|
|
* @next MoneroTransactionAllInputsSetAck
|
|
*/
|
|
message MoneroTransactionAllInputsSetRequest {
|
|
optional MoneroTransactionRsigData rsig_data = 1;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to after all inputs have been set.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionAllInputsSetAck {
|
|
optional MoneroTransactionRsigData rsig_data = 1;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sends one transaction destination to device (HMACed)
|
|
* @next MoneroTransactionSetOutputAck
|
|
*/
|
|
message MoneroTransactionSetOutputRequest {
|
|
optional MoneroTransactionDestinationEntry dst_entr = 1;
|
|
optional bytes dst_entr_hmac = 2;
|
|
optional MoneroTransactionRsigData rsig_data = 3;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to setting transaction destination. Contains sealed values needed for further protocol steps.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionSetOutputAck {
|
|
optional bytes tx_out = 1; // xmrtypes.TxOut
|
|
optional bytes vouti_hmac = 2;
|
|
optional MoneroTransactionRsigData rsig_data = 3;
|
|
optional bytes out_pk = 4;
|
|
optional bytes ecdh_info = 5;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Rangesig offloading roundtrips.
|
|
* @next MoneroTransactionAllInputsSetAck
|
|
*/
|
|
message MoneroTransactionRangeSigRequest {
|
|
optional MoneroTransactionRsigData rsig_data = 1;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to rangesig offloading request
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionRangeSigAck {
|
|
optional MoneroTransactionRsigData rsig_data = 1;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sent after all outputs are sent.
|
|
* @next MoneroTransactionAllOutSetAck
|
|
*/
|
|
message MoneroTransactionAllOutSetRequest {
|
|
optional MoneroTransactionRsigData rsig_data = 1;
|
|
}
|
|
|
|
/**
|
|
* Response: After all outputs are sent the initial RCT signature fields are sent.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionAllOutSetAck {
|
|
optional bytes extra = 1;
|
|
optional bytes tx_prefix_hash = 2;
|
|
optional MoneroTransactionRsigData rsig_data = 3;
|
|
optional MoneroRingCtSig rv = 4; // xmrtypes.RctSig
|
|
/*
|
|
* Structure represents initial fields of the Monero RCT signature
|
|
*/
|
|
message MoneroRingCtSig {
|
|
optional uint64 txn_fee = 1;
|
|
optional bytes message = 2;
|
|
optional uint32 rv_type = 3;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign.
|
|
* @next MoneroTransactionMlsagDoneAck
|
|
*/
|
|
message MoneroTransactionMlsagDoneRequest {
|
|
}
|
|
|
|
/**
|
|
* Response: Contains full message hash needed for the signature
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionMlsagDoneAck {
|
|
optional bytes full_message_hash = 1;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Sends UTXO for the signing.
|
|
* @next MoneroTransactionSignInputAck
|
|
*/
|
|
message MoneroTransactionSignInputRequest {
|
|
optional MoneroTransactionSourceEntry src_entr = 1;
|
|
optional bytes vini = 2; // xmrtypes.TxinToKey
|
|
optional bytes vini_hmac = 3;
|
|
optional bytes pseudo_out = 4;
|
|
optional bytes pseudo_out_hmac = 5;
|
|
optional bytes alpha_enc = 6;
|
|
optional bytes spend_enc = 7;
|
|
}
|
|
|
|
/**
|
|
* Response: Contains full MG signature of the UTXO + multisig data if applicable.
|
|
* @next MoneroTransactionSignRequest
|
|
*/
|
|
message MoneroTransactionSignInputAck {
|
|
optional bytes signature = 1;
|
|
optional bytes cout = 2;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroTransactionSign. Final message of the procol after all UTXOs are signed
|
|
* @next MoneroTransactionFinalAck
|
|
*/
|
|
message MoneroTransactionFinalRequest {
|
|
}
|
|
|
|
/**
|
|
* Response: Contains transaction metadata and encryption keys needed for further transaction operations (e.g. multisig, send proof).
|
|
* @end
|
|
*/
|
|
message MoneroTransactionFinalAck {
|
|
optional bytes cout_key = 1;
|
|
optional bytes salt = 2;
|
|
optional bytes rand_mult = 3;
|
|
optional bytes tx_enc_keys = 4;
|
|
}
|
|
|
|
/**
|
|
* Request: Wrapping request for transaction signature protocol.
|
|
* @wrap MoneroTransactionInitRequest
|
|
* @wrap MoneroTransactionSetInputRequest
|
|
* @wrap MoneroTransactionInputsPermutationRequest
|
|
* @wrap MoneroTransactionInputViniRequest
|
|
* @wrap MoneroTransactionAllInputsSetRequest
|
|
* @wrap MoneroTransactionSetOutputRequest
|
|
* @wrap MoneroTransactionRangeSigRequest
|
|
* @wrap MoneroTransactionAllOutSetRequest
|
|
* @wrap MoneroTransactionMlsagDoneRequest
|
|
* @wrap MoneroTransactionSignInputRequest
|
|
* @wrap MoneroTransactionFinalRequest
|
|
*/
|
|
message MoneroTransactionSignRequest {
|
|
optional MoneroTransactionInitRequest init = 1;
|
|
optional MoneroTransactionSetInputRequest set_input = 2;
|
|
optional MoneroTransactionInputsPermutationRequest input_permutation = 3;
|
|
optional MoneroTransactionInputViniRequest input_vini = 4;
|
|
optional MoneroTransactionAllInputsSetRequest all_in_set = 5;
|
|
optional MoneroTransactionSetOutputRequest set_output = 6;
|
|
optional MoneroTransactionRangeSigRequest rsig = 7;
|
|
optional MoneroTransactionAllOutSetRequest all_out_set = 8;
|
|
optional MoneroTransactionMlsagDoneRequest mlsag_done = 9;
|
|
optional MoneroTransactionSignInputRequest sign_input = 10;
|
|
optional MoneroTransactionFinalRequest final_msg = 11;
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroKeyImageSync. Initializing key image sync.
|
|
* @start
|
|
* @next MoneroKeyImageExportInitAck
|
|
*/
|
|
message MoneroKeyImageExportInitRequest {
|
|
optional uint64 num = 1;
|
|
optional bytes hash = 2;
|
|
repeated uint32 address_n = 3; // BIP-32 path to derive the key from master node
|
|
optional uint32 network_type = 4; // Main-net / testnet / stagenet
|
|
repeated MoneroSubAddressIndicesList subs = 5;
|
|
/**
|
|
* Structure representing Monero list of sub-addresses
|
|
*/
|
|
message MoneroSubAddressIndicesList {
|
|
optional uint32 account = 1;
|
|
repeated uint32 minor_indices = 2;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Response: Response to key image sync initialization.
|
|
* @next MoneroKeyImageSyncRequest
|
|
*/
|
|
message MoneroKeyImageExportInitAck {
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroKeyImageSync. Contains batch of the UTXO to export key image for.
|
|
* @next MoneroKeyImageSyncStepAck
|
|
*/
|
|
message MoneroKeyImageSyncStepRequest {
|
|
repeated MoneroTransferDetails tdis = 1;
|
|
/**
|
|
* Structure representing Monero UTXO for key image sync
|
|
*/
|
|
message MoneroTransferDetails {
|
|
optional bytes out_key = 1;
|
|
optional bytes tx_pub_key = 2;
|
|
repeated bytes additional_tx_pub_keys = 3;
|
|
optional uint64 internal_output_index = 4;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Response: Response to key image sync step. Contains encrypted exported key image.
|
|
* @next MoneroKeyImageSyncRequest
|
|
*/
|
|
message MoneroKeyImageSyncStepAck {
|
|
repeated MoneroExportedKeyImage kis = 1;
|
|
/**
|
|
* Structure representing Monero encrypted exported key image
|
|
*/
|
|
message MoneroExportedKeyImage {
|
|
optional bytes iv = 1;
|
|
optional bytes tag = 2;
|
|
optional bytes blob = 3;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Request: Sub request of MoneroKeyImageSync. Final message of the sync protocol.
|
|
* @next MoneroKeyImageSyncFinalAck
|
|
*/
|
|
message MoneroKeyImageSyncFinalRequest {
|
|
}
|
|
|
|
/**
|
|
* Response: Response to key image sync step. Contains encryption keys for exported key images.
|
|
* @end
|
|
*/
|
|
message MoneroKeyImageSyncFinalAck {
|
|
optional bytes enc_key = 1;
|
|
}
|
|
|
|
/**
|
|
* Request: Wrapping request for key image sync protocol.
|
|
* @wrap MoneroKeyImageExportInitRequest
|
|
* @wrap MoneroKeyImageSyncStepRequest
|
|
* @wrap MoneroKeyImageSyncFinalRequest
|
|
*/
|
|
message MoneroKeyImageSyncRequest {
|
|
optional MoneroKeyImageExportInitRequest init = 1;
|
|
optional MoneroKeyImageSyncStepRequest step = 2;
|
|
optional MoneroKeyImageSyncFinalRequest final_msg = 3;
|
|
}
|
|
|
|
/**
|
|
* Request: Universal Monero protocol implementation diagnosis request.
|
|
* @start
|
|
* @next DebugMoneroDiagAck
|
|
*/
|
|
message DebugMoneroDiagRequest {
|
|
optional uint64 ins = 1;
|
|
optional uint64 p1 = 2;
|
|
optional uint64 p2 = 3;
|
|
repeated uint64 pd = 4;
|
|
optional bytes data1 = 5;
|
|
optional bytes data2 = 6;
|
|
}
|
|
|
|
/**
|
|
* Response: Response to Monero diagnosis protocol.
|
|
* @end
|
|
*/
|
|
message DebugMoneroDiagAck {
|
|
optional uint64 ins = 1;
|
|
optional uint64 p1 = 2;
|
|
optional uint64 p2 = 3;
|
|
repeated uint64 pd = 4;
|
|
optional bytes data1 = 5;
|
|
optional bytes data2 = 6;
|
|
}
|