1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-23 14:58:09 +00:00
trezor-firmware/protob/messages-tezos.proto
2018-08-27 15:39:29 +02:00

146 lines
4.6 KiB
Protocol Buffer

syntax = "proto2";
package hw.trezor.messages.tezos;
// Sugar for easier handling in Java
option java_package = "com.satoshilabs.trezor.lib.protobuf";
option java_outer_classname = "TrezorMessageTezos";
/**
* Tezos Curve Type
*/
enum TezosCurveType {
Ed25519 = 0;
Secp256k1 = 1;
P256 = 2;
}
/**
* Request: Ask device for Tezos address corresponding to address_n path
* @start
* @next TezosAddress
* @next Failure
*/
message TezosGetAddress {
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
optional TezosCurveType curve = 2 [default=Ed25519]; // Curve to use in trezor
optional bool show_display = 3; // optionally show on display before sending the result
}
/**
* Response: Contains Tezos address derived from device private seed
* @end
*/
message TezosAddress {
optional string address = 1; // Coin address in Base58 encoding
}
/**
* Request: Ask device for Tezos public key corresponding to address_n path
* @start
* @next TezosPublicKey
*/
message TezosGetPublicKey {
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
optional TezosCurveType curve = 2 [default=Ed25519]; // Curve to use in trezor
optional bool show_display = 3; // Optionally show on display before sending the result
}
/**
* Response: Contains Tezos public key derived from device private seed
* @end
*/
message TezosPublicKey {
optional string public_key = 1; // b58 encoded Tezos public key with prefix
}
/**
* Request: Ask device to sign Tezos transaction
* @start
* @next TezosSignedTx
*/
message TezosSignTx {
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
optional TezosCurveType curve = 2 [default=Ed25519]; // Curve to use in trezor
optional bytes branch = 3;
optional TezosRevealOp reveal = 4; // Tezos reveal operation (may be bundled with other op)
optional TezosTransactionOp transaction = 5; // Tezos transaction operation
optional TezosOriginationOp origination = 6; // Tezos origination operation
optional TezosDelegationOp delegation = 7; // Tezos delegation operation
/*
* Tezos contract ID
*/
message TezosContractID {
optional TezosContractType tag = 1;
optional bytes hash = 2; // Implicit = 21B, originated = 20B + 1B padding
/*
* Type of Tezos Contract type
*/
enum TezosContractType {
Implicit = 0;
Originated = 1;
}
}
/**
* Structure representing information for reveal
*/
message TezosRevealOp {
optional TezosContractID source = 1;
optional uint64 fee = 2;
optional uint64 counter = 3;
optional uint64 gas_limit = 4;
optional uint64 storage_limit = 5;
optional bytes public_key = 6;
}
/**
* Structure representing information for transaction
*/
message TezosTransactionOp {
optional TezosContractID source = 1;
optional uint64 fee = 2;
optional uint64 counter = 3;
optional uint64 gas_limit = 4;
optional uint64 storage_limit = 5;
optional uint64 amount = 6;
optional TezosContractID destination = 7;
optional bytes parameters = 8;
}
/**
* Structure representing information for origination
*/
message TezosOriginationOp {
optional TezosContractID source = 1;
optional uint64 fee = 2;
optional uint64 counter = 3;
optional uint64 gas_limit = 4;
optional uint64 storage_limit = 5;
optional bytes manager_pubkey = 6;
optional uint64 balance = 7;
optional bool spendable = 8;
optional bool delegatable = 9;
optional bytes delegate = 10;
optional bytes script = 11;
}
/**
* Structure representing information for delegation
*/
message TezosDelegationOp {
optional TezosContractID source = 1;
optional uint64 fee = 2;
optional uint64 counter = 3;
optional uint64 gas_limit = 4;
optional uint64 storage_limit = 5;
optional bytes delegate = 6;
}
}
/**
* Response: Contains Tezos transaction signature
* @end
*/
message TezosSignedTx {
optional string signature = 1; // Tezos b58 encoded transaction signature with prefix
optional bytes sig_op_contents = 2; // operation_bytes + signed operation_bytes
optional string operation_hash = 3; // b58 encoded hashed operation contents with prefix
}