arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-24 23:38:09 +00:00
Code Issues Releases Wiki Activity

feat(common): add default values to EthereumSignTx fields

Browse Source 
so that we can avoid Optional types for fields
This commit is contained in:
matejcik 2021-08-31 11:36:13 +02:00 committed by matejcik
parent 96ed53cc1c
commit 30b08d949b
5 changed files with 58 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
common/protob/messages-ethereum.proto
View File

@ -50,7 +50,8 @@ message EthereumAddress {
/** /**
* Request: Ask device to sign transaction * Request: Ask device to sign transaction
* All fields are optional from the protocol's point of view. Each field defaults to value `0` if missing. * gas_price, gas_limit and chain_id must be provided and non-zero.
* All other fields are optional and default to value `0` if missing.
* Note: the first at most 1024 bytes of data MUST be transmitted as part of this message. * Note: the first at most 1024 bytes of data MUST be transmitted as part of this message.
* @start * @start
* @next EthereumTxRequest * @next EthereumTxRequest
@ -58,13 +59,13 @@ message EthereumAddress {
*/ */
message EthereumSignTx { message EthereumSignTx {
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
optional bytes nonce = 2; // <=256 bit unsigned big endian optional bytes nonce = 2 [default='']; // <=256 bit unsigned big endian
optional bytes gas_price = 3; // <=256 bit unsigned big endian (in wei) required bytes gas_price = 3; // <=256 bit unsigned big endian (in wei)
optional bytes gas_limit = 4; // <=256 bit unsigned big endian required bytes gas_limit = 4; // <=256 bit unsigned big endian
optional string to = 11; // recipient address optional string to = 11 [default='']; // recipient address
optional bytes value = 6; // <=256 bit unsigned big endian (in wei) optional bytes value = 6 [default='']; // <=256 bit unsigned big endian (in wei)
optional bytes data_initial_chunk = 7; // The initial data chunk (<= 1024 bytes) optional bytes data_initial_chunk = 7 [default='']; // The initial data chunk (<= 1024 bytes)
optional uint32 data_length = 8; // Length of transaction payload optional uint32 data_length = 8 [default=0]; // Length of transaction payload
required uint64 chain_id = 9; // Chain Id for EIP 155 required uint64 chain_id = 9; // Chain Id for EIP 155
optional uint32 tx_type = 10; // Used for Wanchain optional uint32 tx_type = 10; // Used for Wanchain
} }
@ -114,7 +115,7 @@ message EthereumTxRequest {
* @next EthereumTxRequest * @next EthereumTxRequest
*/ */
message EthereumTxAck { message EthereumTxAck {
optional bytes data_chunk = 1; // Bytes from transaction payload (<= 1024 bytes) required bytes data_chunk = 1; // Bytes from transaction payload (<= 1024 bytes)
} }
/** /**
@ -125,7 +126,7 @@ message EthereumTxAck {
*/ */
message EthereumSignMessage { message EthereumSignMessage {
repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node repeated uint32 address_n = 1; // BIP-32 path to derive the key from master node
optional bytes message = 2; // message to be signed required bytes message = 2; // message to be signed
} }
/** /**
@ -144,7 +145,7 @@ message EthereumMessageSignature {
* @next Failure * @next Failure
*/ */
message EthereumVerifyMessage { message EthereumVerifyMessage {
optional bytes signature = 2; // signature to verify required bytes signature = 2; // signature to verify
optional bytes message = 3; // message to verify required bytes message = 3; // message to verify
optional string address = 4; // address to verify required string address = 4; // address to verify
} }

38
core/src/trezor/messages.py
View File

@ -2984,24 +2984,24 @@ if TYPE_CHECKING:
class EthereumSignTx(protobuf.MessageType): class EthereumSignTx(protobuf.MessageType):
address_n: "list[int]" address_n: "list[int]"
nonce: "bytes | None" nonce: "bytes"
gas_price: "bytes | None" gas_price: "bytes"
gas_limit: "bytes | None" gas_limit: "bytes"
to: "str | None" to: "str"
value: "bytes | None" value: "bytes"
data_initial_chunk: "bytes | None" data_initial_chunk: "bytes"
data_length: "int | None" data_length: "int"
chain_id: "int" chain_id: "int"
tx_type: "int | None" tx_type: "int | None"
def __init__( def __init__(
self, self,
*, *,
gas_price: "bytes",
gas_limit: "bytes",
chain_id: "int", chain_id: "int",
address_n: "list[int] | None" = None, address_n: "list[int] | None" = None,
nonce: "bytes | None" = None, nonce: "bytes | None" = None,
gas_price: "bytes | None" = None,
gas_limit: "bytes | None" = None,
to: "str | None" = None, to: "str | None" = None,
value: "bytes | None" = None, value: "bytes | None" = None,
data_initial_chunk: "bytes | None" = None, data_initial_chunk: "bytes | None" = None,
@ -3069,12 +3069,12 @@ if TYPE_CHECKING:
return isinstance(msg, cls) return isinstance(msg, cls)
class EthereumTxAck(protobuf.MessageType): class EthereumTxAck(protobuf.MessageType):
data_chunk: "bytes | None" data_chunk: "bytes"
def __init__( def __init__(
self, self,
*, *,
data_chunk: "bytes | None" = None, data_chunk: "bytes",
) -> None: ) -> None:
pass pass
@ -3084,13 +3084,13 @@ if TYPE_CHECKING:
class EthereumSignMessage(protobuf.MessageType): class EthereumSignMessage(protobuf.MessageType):
address_n: "list[int]" address_n: "list[int]"
message: "bytes | None" message: "bytes"
def __init__( def __init__(
self, self,
*, *,
message: "bytes",
address_n: "list[int] | None" = None, address_n: "list[int] | None" = None,
message: "bytes | None" = None,
) -> None: ) -> None:
pass pass
@ -3115,16 +3115,16 @@ if TYPE_CHECKING:
return isinstance(msg, cls) return isinstance(msg, cls)
class EthereumVerifyMessage(protobuf.MessageType): class EthereumVerifyMessage(protobuf.MessageType):
signature: "bytes | None" signature: "bytes"
message: "bytes | None" message: "bytes"
address: "str | None" address: "str"
def __init__( def __init__(
self, self,
*, *,
signature: "bytes | None" = None, signature: "bytes",
message: "bytes | None" = None, message: "bytes",
address: "str | None" = None, address: "str",
) -> None: ) -> None:
pass pass

2
python/src/trezorlib/ethereum.py
View File

@ -55,7 +55,7 @@ def sign_tx(
msg = messages.EthereumSignTx( msg = messages.EthereumSignTx(
address_n=n, address_n=n,
nonce=int_to_big_endian(nonce), nonce=int_to_big_endian(nonce),
gas_price=int_to_big_endian(gas_price) if gas_price is not None else None, gas_price=int_to_big_endian(gas_price),
gas_limit=int_to_big_endian(gas_limit), gas_limit=int_to_big_endian(gas_limit),
value=int_to_big_endian(value), value=int_to_big_endian(value),
to=to, to=to,

42
python/src/trezorlib/messages.py
View File

@ -4258,8 +4258,8 @@ class EthereumSignTx(protobuf.MessageType):
FIELDS = { FIELDS = {
1: protobuf.Field("address_n", "uint32", repeated=True, required=False), 1: protobuf.Field("address_n", "uint32", repeated=True, required=False),
2: protobuf.Field("nonce", "bytes", repeated=False, required=False), 2: protobuf.Field("nonce", "bytes", repeated=False, required=False),
3: protobuf.Field("gas_price", "bytes", repeated=False, required=False), 3: protobuf.Field("gas_price", "bytes", repeated=False, required=True),
4: protobuf.Field("gas_limit", "bytes", repeated=False, required=False), 4: protobuf.Field("gas_limit", "bytes", repeated=False, required=True),
11: protobuf.Field("to", "string", repeated=False, required=False), 11: protobuf.Field("to", "string", repeated=False, required=False),
6: protobuf.Field("value", "bytes", repeated=False, required=False), 6: protobuf.Field("value", "bytes", repeated=False, required=False),
7: protobuf.Field("data_initial_chunk", "bytes", repeated=False, required=False), 7: protobuf.Field("data_initial_chunk", "bytes", repeated=False, required=False),
@ -4271,22 +4271,22 @@ class EthereumSignTx(protobuf.MessageType):
def __init__( def __init__(
self, self,
*, *,
gas_price: "bytes",
gas_limit: "bytes",
chain_id: "int", chain_id: "int",
address_n: Optional[List["int"]] = None, address_n: Optional[List["int"]] = None,
nonce: Optional["bytes"] = None, nonce: Optional["bytes"] = b'',
gas_price: Optional["bytes"] = None, to: Optional["str"] = '',
gas_limit: Optional["bytes"] = None, value: Optional["bytes"] = b'',
to: Optional["str"] = None, data_initial_chunk: Optional["bytes"] = b'',
value: Optional["bytes"] = None, data_length: Optional["int"] = 0,
data_initial_chunk: Optional["bytes"] = None,
data_length: Optional["int"] = None,
tx_type: Optional["int"] = None, tx_type: Optional["int"] = None,
) -> None: ) -> None:
self.address_n = address_n if address_n is not None else [] self.address_n = address_n if address_n is not None else []
self.chain_id = chain_id
self.nonce = nonce
self.gas_price = gas_price self.gas_price = gas_price
self.gas_limit = gas_limit self.gas_limit = gas_limit
self.chain_id = chain_id
self.nonce = nonce
self.to = to self.to = to
self.value = value self.value = value
self.data_initial_chunk = data_initial_chunk self.data_initial_chunk = data_initial_chunk
@ -4364,13 +4364,13 @@ class EthereumTxRequest(protobuf.MessageType):
class EthereumTxAck(protobuf.MessageType): class EthereumTxAck(protobuf.MessageType):
MESSAGE_WIRE_TYPE = 60 MESSAGE_WIRE_TYPE = 60
FIELDS = { FIELDS = {
1: protobuf.Field("data_chunk", "bytes", repeated=False, required=False), 1: protobuf.Field("data_chunk", "bytes", repeated=False, required=True),
} }
def __init__( def __init__(
self, self,
*, *,
data_chunk: Optional["bytes"] = None, data_chunk: "bytes",
) -> None: ) -> None:
self.data_chunk = data_chunk self.data_chunk = data_chunk
@ -4379,14 +4379,14 @@ class EthereumSignMessage(protobuf.MessageType):
MESSAGE_WIRE_TYPE = 64 MESSAGE_WIRE_TYPE = 64
FIELDS = { FIELDS = {
1: protobuf.Field("address_n", "uint32", repeated=True, required=False), 1: protobuf.Field("address_n", "uint32", repeated=True, required=False),
2: protobuf.Field("message", "bytes", repeated=False, required=False), 2: protobuf.Field("message", "bytes", repeated=False, required=True),
} }
def __init__( def __init__(
self, self,
*, *,
message: "bytes",
address_n: Optional[List["int"]] = None, address_n: Optional[List["int"]] = None,
message: Optional["bytes"] = None,
) -> None: ) -> None:
self.address_n = address_n if address_n is not None else [] self.address_n = address_n if address_n is not None else []
self.message = message self.message = message
@ -4412,17 +4412,17 @@ class EthereumMessageSignature(protobuf.MessageType):
class EthereumVerifyMessage(protobuf.MessageType): class EthereumVerifyMessage(protobuf.MessageType):
MESSAGE_WIRE_TYPE = 65 MESSAGE_WIRE_TYPE = 65
FIELDS = { FIELDS = {
2: protobuf.Field("signature", "bytes", repeated=False, required=False), 2: protobuf.Field("signature", "bytes", repeated=False, required=True),
3: protobuf.Field("message", "bytes", repeated=False, required=False), 3: protobuf.Field("message", "bytes", repeated=False, required=True),
4: protobuf.Field("address", "string", repeated=False, required=False), 4: protobuf.Field("address", "string", repeated=False, required=True),
} }
def __init__( def __init__(
self, self,
*, *,
signature: Optional["bytes"] = None, signature: "bytes",
message: Optional["bytes"] = None, message: "bytes",
address: Optional["str"] = None, address: "str",
) -> None: ) -> None:
self.signature = signature self.signature = signature
self.message = message self.message = message

24
tests/device_tests/ethereum/test_signtx.py
View File

@ -106,30 +106,6 @@ def test_sanity_checks(client):
value=12345678901234567890, value=12345678901234567890,
) )
# no gas price
with pytest.raises(TrezorFailure):
client.call(
messages.EthereumSignTx(
address_n=parse_path("44'/60'/0'/0/0"),
nonce=b"AAA",
gas_limit=ethereum.int_to_big_endian(10000),
to=TO_ADDR,
value=ethereum.int_to_big_endian(12345678901234567890),
)
)
# no gas limit
with pytest.raises(TrezorFailure):
client.call(
messages.EthereumSignTx(
address_n=parse_path("44'/60'/0'/0/0"),
nonce=b"AAA",
gas_price=ethereum.int_to_big_endian(10000),
to=TO_ADDR,
value=ethereum.int_to_big_endian(12345678901234567890),
)
)
def test_data_streaming(client): def test_data_streaming(client):
"""Only verifying the expected responses, the signatures are """Only verifying the expected responses, the signatures are