arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2025-07-19 04:58:11 +00:00
Code Issues Releases Wiki Activity

feat: Make payment request protobuf fields optional.

Browse Source
This commit is contained in:
Andrew Kozlik 2025-04-15 14:56:14 +02:00 committed by Ioan Bizău
parent 361a10eff3
commit 4a4cc34d65
4 changed files with 84 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
common/protob/messages-common.proto
View File

@ -182,11 +182,11 @@ message HDNodeType {
message PaymentRequest { message PaymentRequest {
option (experimental_message) = true; option (experimental_message) = true;
optional bytes nonce = 1; // the nonce used in the signature computation optional bytes nonce = 1; // the nonce used in the signature computation
required string recipient_name = 2; // merchant's name optional string recipient_name = 2 [default=""]; // merchant's name
repeated PaymentRequestMemo memos = 3; // any memos that were signed as part of the request repeated PaymentRequestMemo memos = 3; // any memos that were signed as part of the request
optional uint64 amount = 4; // the sum of the external output amounts requested, required for non-CoinJoin optional uint64 amount = 4 [default=0]; // the sum of the external output amounts requested, required for non-CoinJoin
required bytes signature = 5; // the trusted party's signature of the paymentRequestDigest optional bytes signature = 5 [default=""]; // the trusted party's signature of the paymentRequestDigest
message PaymentRequestMemo { message PaymentRequestMemo {
optional TextMemo text_memo = 1; optional TextMemo text_memo = 1;
@ -196,7 +196,7 @@ message PaymentRequest {
} }
message TextMemo { message TextMemo {
required string text = 1; // plain-text note explaining the purpose of the payment request optional string text = 1 [default=""]; // plain-text note explaining the purpose of the payment request
} }
message TextDetailsMemo { message TextDetailsMemo {
@ -205,16 +205,16 @@ message PaymentRequest {
} }
message RefundMemo { message RefundMemo {
required string address = 1; // the address where the payment should be refunded if necessary optional string address = 1 [default=""]; // the address where the payment should be refunded if necessary
repeated uint32 address_n = 2; // BIP-32 path to derive the key from the master node repeated uint32 address_n = 2; // BIP-32 path to derive the key from the master node
required bytes mac = 3; // the MAC returned by GetAddress optional bytes mac = 3 [default=""]; // the MAC returned by GetAddress
} }
message CoinPurchaseMemo { message CoinPurchaseMemo {
required uint32 coin_type = 1; // the SLIP-0044 coin type of the address optional uint32 coin_type = 1 [default=0]; // the SLIP-0044 coin type of the address
required string amount = 2; // the amount the address will receive as a human-readable string including units, e.g. "0.025 BTC" optional string amount = 2 [default=""]; // the amount the address will receive as a human-readable string including units, e.g. "0.025 BTC"
required string address = 3; // the address where the coin purchase will be delivered optional string address = 3 [default=""]; // the address where the coin purchase will be delivered
repeated uint32 address_n = 4; // BIP-32 path to derive the key from the master node repeated uint32 address_n = 4; // BIP-32 path to derive the key from the master node
required bytes mac = 5; // the MAC returned by GetAddress optional bytes mac = 5 [default=""]; // the MAC returned by GetAddress
} }
} }

20
core/src/trezor/messages.py generated
View File

@ -251,17 +251,17 @@ if TYPE_CHECKING:
nonce: "bytes | None" nonce: "bytes | None"
recipient_name: "str" recipient_name: "str"
memos: "list[PaymentRequestMemo]" memos: "list[PaymentRequestMemo]"
amount: "int | None" amount: "int"
signature: "bytes" signature: "bytes"
def __init__( def __init__(
self, self,
*, *,
recipient_name: "str",
signature: "bytes",
memos: "list[PaymentRequestMemo] | None" = None, memos: "list[PaymentRequestMemo] | None" = None,
nonce: "bytes | None" = None, nonce: "bytes | None" = None,
recipient_name: "str | None" = None,
amount: "int | None" = None, amount: "int | None" = None,
signature: "bytes | None" = None,
) -> None: ) -> None:
pass pass
@ -295,7 +295,7 @@ if TYPE_CHECKING:
def __init__( def __init__(
self, self,
*, *,
text: "str", text: "str | None" = None,
) -> None: ) -> None:
pass pass
@ -327,9 +327,9 @@ if TYPE_CHECKING:
def __init__( def __init__(
self, self,
*, *,
address: "str",
mac: "bytes",
address_n: "list[int] | None" = None, address_n: "list[int] | None" = None,
address: "str | None" = None,
mac: "bytes | None" = None,
) -> None: ) -> None:
pass pass
@ -347,11 +347,11 @@ if TYPE_CHECKING:
def __init__( def __init__(
self, self,
*, *,
coin_type: "int",
amount: "str",
address: "str",
mac: "bytes",
address_n: "list[int] | None" = None, address_n: "list[int] | None" = None,
coin_type: "int | None" = None,
amount: "str | None" = None,
address: "str | None" = None,
mac: "bytes | None" = None,
) -> None: ) -> None:
pass pass

44
python/src/trezorlib/messages.py generated
View File

@ -885,26 +885,26 @@ class PaymentRequest(protobuf.MessageType):
MESSAGE_WIRE_TYPE = 37 MESSAGE_WIRE_TYPE = 37
FIELDS = { FIELDS = {
1: protobuf.Field("nonce", "bytes", repeated=False, required=False, default=None), 1: protobuf.Field("nonce", "bytes", repeated=False, required=False, default=None),
2: protobuf.Field("recipient_name", "string", repeated=False, required=True), 2: protobuf.Field("recipient_name", "string", repeated=False, required=False, default=''),
3: protobuf.Field("memos", "PaymentRequestMemo", repeated=True, required=False, default=None), 3: protobuf.Field("memos", "PaymentRequestMemo", repeated=True, required=False, default=None),
4: protobuf.Field("amount", "uint64", repeated=False, required=False, default=None), 4: protobuf.Field("amount", "uint64", repeated=False, required=False, default=0),
5: protobuf.Field("signature", "bytes", repeated=False, required=True), 5: protobuf.Field("signature", "bytes", repeated=False, required=False, default=b''),
} }
def __init__( def __init__(
self, self,
*, *,
recipient_name: "str",
signature: "bytes",
memos: Optional[Sequence["PaymentRequestMemo"]] = None, memos: Optional[Sequence["PaymentRequestMemo"]] = None,
nonce: Optional["bytes"] = None, nonce: Optional["bytes"] = None,
amount: Optional["int"] = None, recipient_name: Optional["str"] = '',
amount: Optional["int"] = 0,
signature: Optional["bytes"] = b'',
) -> None: ) -> None:
self.memos: Sequence["PaymentRequestMemo"] = memos if memos is not None else [] self.memos: Sequence["PaymentRequestMemo"] = memos if memos is not None else []
self.recipient_name = recipient_name
self.signature = signature
self.nonce = nonce self.nonce = nonce
self.recipient_name = recipient_name
self.amount = amount self.amount = amount
self.signature = signature
class PaymentRequestMemo(protobuf.MessageType): class PaymentRequestMemo(protobuf.MessageType):
@ -933,13 +933,13 @@ class PaymentRequestMemo(protobuf.MessageType):
class TextMemo(protobuf.MessageType): class TextMemo(protobuf.MessageType):
MESSAGE_WIRE_TYPE = None MESSAGE_WIRE_TYPE = None
FIELDS = { FIELDS = {
1: protobuf.Field("text", "string", repeated=False, required=True), 1: protobuf.Field("text", "string", repeated=False, required=False, default=''),
} }
def __init__( def __init__(
self, self,
*, *,
text: "str", text: Optional["str"] = '',
) -> None: ) -> None:
self.text = text self.text = text
@ -964,17 +964,17 @@ class TextDetailsMemo(protobuf.MessageType):
class RefundMemo(protobuf.MessageType): class RefundMemo(protobuf.MessageType):
MESSAGE_WIRE_TYPE = None MESSAGE_WIRE_TYPE = None
FIELDS = { FIELDS = {
1: protobuf.Field("address", "string", repeated=False, required=True), 1: protobuf.Field("address", "string", repeated=False, required=False, default=''),
2: protobuf.Field("address_n", "uint32", repeated=True, required=False, default=None), 2: protobuf.Field("address_n", "uint32", repeated=True, required=False, default=None),
3: protobuf.Field("mac", "bytes", repeated=False, required=True), 3: protobuf.Field("mac", "bytes", repeated=False, required=False, default=b''),
} }
def __init__( def __init__(
self, self,
*, *,
address: "str",
mac: "bytes",
address_n: Optional[Sequence["int"]] = None, address_n: Optional[Sequence["int"]] = None,
address: Optional["str"] = '',
mac: Optional["bytes"] = b'',
) -> None: ) -> None:
self.address_n: Sequence["int"] = address_n if address_n is not None else [] self.address_n: Sequence["int"] = address_n if address_n is not None else []
self.address = address self.address = address
@ -984,21 +984,21 @@ class RefundMemo(protobuf.MessageType):
class CoinPurchaseMemo(protobuf.MessageType): class CoinPurchaseMemo(protobuf.MessageType):
MESSAGE_WIRE_TYPE = None MESSAGE_WIRE_TYPE = None
FIELDS = { FIELDS = {
1: protobuf.Field("coin_type", "uint32", repeated=False, required=True), 1: protobuf.Field("coin_type", "uint32", repeated=False, required=False, default=0),
2: protobuf.Field("amount", "string", repeated=False, required=True), 2: protobuf.Field("amount", "string", repeated=False, required=False, default=''),
3: protobuf.Field("address", "string", repeated=False, required=True), 3: protobuf.Field("address", "string", repeated=False, required=False, default=''),
4: protobuf.Field("address_n", "uint32", repeated=True, required=False, default=None), 4: protobuf.Field("address_n", "uint32", repeated=True, required=False, default=None),
5: protobuf.Field("mac", "bytes", repeated=False, required=True), 5: protobuf.Field("mac", "bytes", repeated=False, required=False, default=b''),
} }
def __init__( def __init__(
self, self,
*, *,
coin_type: "int",
amount: "str",
address: "str",
mac: "bytes",
address_n: Optional[Sequence["int"]] = None, address_n: Optional[Sequence["int"]] = None,
coin_type: Optional["int"] = 0,
amount: Optional["str"] = '',
address: Optional["str"] = '',
mac: Optional["bytes"] = b'',
) -> None: ) -> None:
self.address_n: Sequence["int"] = address_n if address_n is not None else [] self.address_n: Sequence["int"] = address_n if address_n is not None else []
self.coin_type = coin_type self.coin_type = coin_type

128
rust/trezor-client/src/protos/generated/messages_common.rs generated
View File

@ -2567,7 +2567,7 @@ impl PaymentRequest {
self.nonce.take().unwrap_or_else(|| ::std::vec::Vec::new()) self.nonce.take().unwrap_or_else(|| ::std::vec::Vec::new())
} }
// required string recipient_name = 2; // optional string recipient_name = 2;
pub fn recipient_name(&self) -> &str { pub fn recipient_name(&self) -> &str {
match self.recipient_name.as_ref() { match self.recipient_name.as_ref() {
@ -2606,7 +2606,7 @@ impl PaymentRequest {
// optional uint64 amount = 4; // optional uint64 amount = 4;
pub fn amount(&self) -> u64 { pub fn amount(&self) -> u64 {
self.amount.unwrap_or(0) self.amount.unwrap_or(0u64)
} }
pub fn clear_amount(&mut self) { pub fn clear_amount(&mut self) {
@ -2622,12 +2622,12 @@ impl PaymentRequest {
self.amount = ::std::option::Option::Some(v); self.amount = ::std::option::Option::Some(v);
} }
// required bytes signature = 5; // optional bytes signature = 5;
pub fn signature(&self) -> &[u8] { pub fn signature(&self) -> &[u8] {
match self.signature.as_ref() { match self.signature.as_ref() {
Some(v) => v, Some(v) => v,
None => &[], None => b"",
} }
} }
@ -2698,17 +2698,6 @@ impl ::protobuf::Message for PaymentRequest {
const NAME: &'static str = "PaymentRequest"; const NAME: &'static str = "PaymentRequest";
fn is_initialized(&self) -> bool { fn is_initialized(&self) -> bool {
if self.recipient_name.is_none() {
return false;
}
if self.signature.is_none() {
return false;
}
for v in &self.memos {
if !v.is_initialized() {
return false;
}
};
true true
} }
@ -2899,26 +2888,6 @@ pub mod payment_request {
const NAME: &'static str = "PaymentRequestMemo"; const NAME: &'static str = "PaymentRequestMemo";
fn is_initialized(&self) -> bool { fn is_initialized(&self) -> bool {
for v in &self.text_memo {
if !v.is_initialized() {
return false;
}
};
for v in &self.refund_memo {
if !v.is_initialized() {
return false;
}
};
for v in &self.coin_purchase_memo {
if !v.is_initialized() {
return false;
}
};
for v in &self.text_details_memo {
if !v.is_initialized() {
return false;
}
};
true true
} }
@ -3058,7 +3027,7 @@ pub mod payment_request {
::std::default::Default::default() ::std::default::Default::default()
} }
// required string text = 1; // optional string text = 1;
pub fn text(&self) -> &str { pub fn text(&self) -> &str {
match self.text.as_ref() { match self.text.as_ref() {
@ -3114,9 +3083,6 @@ pub mod payment_request {
const NAME: &'static str = "TextMemo"; const NAME: &'static str = "TextMemo";
fn is_initialized(&self) -> bool { fn is_initialized(&self) -> bool {
if self.text.is_none() {
return false;
}
true true
} }
@ -3435,7 +3401,7 @@ pub mod payment_request {
::std::default::Default::default() ::std::default::Default::default()
} }
// required string address = 1; // optional string address = 1;
pub fn address(&self) -> &str { pub fn address(&self) -> &str {
match self.address.as_ref() { match self.address.as_ref() {
@ -3471,12 +3437,12 @@ pub mod payment_request {
self.address.take().unwrap_or_else(|| ::std::string::String::new()) self.address.take().unwrap_or_else(|| ::std::string::String::new())
} }
// required bytes mac = 3; // optional bytes mac = 3;
pub fn mac(&self) -> &[u8] { pub fn mac(&self) -> &[u8] {
match self.mac.as_ref() { match self.mac.as_ref() {
Some(v) => v, Some(v) => v,
None => &[], None => b"",
} }
} }
@ -3537,12 +3503,6 @@ pub mod payment_request {
const NAME: &'static str = "RefundMemo"; const NAME: &'static str = "RefundMemo";
fn is_initialized(&self) -> bool { fn is_initialized(&self) -> bool {
if self.address.is_none() {
return false;
}
if self.mac.is_none() {
return false;
}
true true
} }
@ -3678,10 +3638,10 @@ pub mod payment_request {
::std::default::Default::default() ::std::default::Default::default()
} }
// required uint32 coin_type = 1; // optional uint32 coin_type = 1;
pub fn coin_type(&self) -> u32 { pub fn coin_type(&self) -> u32 {
self.coin_type.unwrap_or(0) self.coin_type.unwrap_or(0u32)
} }
pub fn clear_coin_type(&mut self) { pub fn clear_coin_type(&mut self) {
@ -3697,7 +3657,7 @@ pub mod payment_request {
self.coin_type = ::std::option::Option::Some(v); self.coin_type = ::std::option::Option::Some(v);
} }
// required string amount = 2; // optional string amount = 2;
pub fn amount(&self) -> &str { pub fn amount(&self) -> &str {
match self.amount.as_ref() { match self.amount.as_ref() {
@ -3733,7 +3693,7 @@ pub mod payment_request {
self.amount.take().unwrap_or_else(|| ::std::string::String::new()) self.amount.take().unwrap_or_else(|| ::std::string::String::new())
} }
// required string address = 3; // optional string address = 3;
pub fn address(&self) -> &str { pub fn address(&self) -> &str {
match self.address.as_ref() { match self.address.as_ref() {
@ -3769,12 +3729,12 @@ pub mod payment_request {
self.address.take().unwrap_or_else(|| ::std::string::String::new()) self.address.take().unwrap_or_else(|| ::std::string::String::new())
} }
// required bytes mac = 5; // optional bytes mac = 5;
pub fn mac(&self) -> &[u8] { pub fn mac(&self) -> &[u8] {
match self.mac.as_ref() { match self.mac.as_ref() {
Some(v) => v, Some(v) => v,
None => &[], None => b"",
} }
} }
@ -3845,18 +3805,6 @@ pub mod payment_request {
const NAME: &'static str = "CoinPurchaseMemo"; const NAME: &'static str = "CoinPurchaseMemo";
fn is_initialized(&self) -> bool { fn is_initialized(&self) -> bool {
if self.coin_type.is_none() {
return false;
}
if self.amount.is_none() {
return false;
}
if self.address.is_none() {
return false;
}
if self.mac.is_none() {
return false;
}
true true
} }
@ -4037,30 +3985,30 @@ static file_descriptor_proto_data: &'static [u8] = b"\
gerprint\x18\x02\x20\x02(\rR\x0bfingerprint\x12\x1b\n\tchild_num\x18\x03\ gerprint\x18\x02\x20\x02(\rR\x0bfingerprint\x12\x1b\n\tchild_num\x18\x03\
\x20\x02(\rR\x08childNum\x12\x1d\n\nchain_code\x18\x04\x20\x02(\x0cR\tch\ \x20\x02(\rR\x08childNum\x12\x1d\n\nchain_code\x18\x04\x20\x02(\x0cR\tch\
ainCode\x12\x1f\n\x0bprivate_key\x18\x05\x20\x01(\x0cR\nprivateKey\x12\ ainCode\x12\x1f\n\x0bprivate_key\x18\x05\x20\x01(\x0cR\nprivateKey\x12\
\x1d\n\npublic_key\x18\x06\x20\x02(\x0cR\tpublicKey\"\xb8\x07\n\x0ePayme\ \x1d\n\npublic_key\x18\x06\x20\x02(\x0cR\tpublicKey\"\xce\x07\n\x0ePayme\
ntRequest\x12\x14\n\x05nonce\x18\x01\x20\x01(\x0cR\x05nonce\x12%\n\x0ere\ ntRequest\x12\x14\n\x05nonce\x18\x01\x20\x01(\x0cR\x05nonce\x12'\n\x0ere\
cipient_name\x18\x02\x20\x02(\tR\rrecipientName\x12R\n\x05memos\x18\x03\ cipient_name\x18\x02\x20\x01(\t:\0R\rrecipientName\x12R\n\x05memos\x18\
\x20\x03(\x0b2<.hw.trezor.messages.common.PaymentRequest.PaymentRequestM\ \x03\x20\x03(\x0b2<.hw.trezor.messages.common.PaymentRequest.PaymentRequ\
emoR\x05memos\x12\x16\n\x06amount\x18\x04\x20\x01(\x04R\x06amount\x12\ estMemoR\x05memos\x12\x19\n\x06amount\x18\x04\x20\x01(\x04:\x010R\x06amo\
\x1c\n\tsignature\x18\x05\x20\x02(\x0cR\tsignature\x1a\x8d\x03\n\x12Paym\ unt\x12\x1e\n\tsignature\x18\x05\x20\x01(\x0c:\0R\tsignature\x1a\x8d\x03\
entRequestMemo\x12O\n\ttext_memo\x18\x01\x20\x01(\x0b22.hw.trezor.messag\ \n\x12PaymentRequestMemo\x12O\n\ttext_memo\x18\x01\x20\x01(\x0b22.hw.tre\
es.common.PaymentRequest.TextMemoR\x08textMemo\x12U\n\x0brefund_memo\x18\ zor.messages.common.PaymentRequest.TextMemoR\x08textMemo\x12U\n\x0brefun\
\x02\x20\x01(\x0b24.hw.trezor.messages.common.PaymentRequest.RefundMemoR\ d_memo\x18\x02\x20\x01(\x0b24.hw.trezor.messages.common.PaymentRequest.R\
\nrefundMemo\x12h\n\x12coin_purchase_memo\x18\x03\x20\x01(\x0b2:.hw.trez\ efundMemoR\nrefundMemo\x12h\n\x12coin_purchase_memo\x18\x03\x20\x01(\x0b\
or.messages.common.PaymentRequest.CoinPurchaseMemoR\x10coinPurchaseMemo\ 2:.hw.trezor.messages.common.PaymentRequest.CoinPurchaseMemoR\x10coinPur\
\x12e\n\x11text_details_memo\x18\x04\x20\x01(\x0b29.hw.trezor.messages.c\ chaseMemo\x12e\n\x11text_details_memo\x18\x04\x20\x01(\x0b29.hw.trezor.m\
ommon.PaymentRequest.TextDetailsMemoR\x0ftextDetailsMemo\x1a\x1e\n\x08Te\ essages.common.PaymentRequest.TextDetailsMemoR\x0ftextDetailsMemo\x1a\
xtMemo\x12\x12\n\x04text\x18\x01\x20\x02(\tR\x04text\x1a?\n\x0fTextDetai\ \x20\n\x08TextMemo\x12\x14\n\x04text\x18\x01\x20\x01(\t:\0R\x04text\x1a?\
lsMemo\x12\x16\n\x05title\x18\x01\x20\x01(\t:\0R\x05title\x12\x14\n\x04t\ \n\x0fTextDetailsMemo\x12\x16\n\x05title\x18\x01\x20\x01(\t:\0R\x05title\
ext\x18\x02\x20\x01(\t:\0R\x04text\x1aU\n\nRefundMemo\x12\x18\n\x07addre\ \x12\x14\n\x04text\x18\x02\x20\x01(\t:\0R\x04text\x1aY\n\nRefundMemo\x12\
ss\x18\x01\x20\x02(\tR\x07address\x12\x1b\n\taddress_n\x18\x02\x20\x03(\ \x1a\n\x07address\x18\x01\x20\x01(\t:\0R\x07address\x12\x1b\n\taddress_n\
\rR\x08addressN\x12\x10\n\x03mac\x18\x03\x20\x02(\x0cR\x03mac\x1a\x90\ \x18\x02\x20\x03(\rR\x08addressN\x12\x12\n\x03mac\x18\x03\x20\x01(\x0c:\
\x01\n\x10CoinPurchaseMemo\x12\x1b\n\tcoin_type\x18\x01\x20\x02(\rR\x08c\ \0R\x03mac\x1a\x99\x01\n\x10CoinPurchaseMemo\x12\x1e\n\tcoin_type\x18\
oinType\x12\x16\n\x06amount\x18\x02\x20\x02(\tR\x06amount\x12\x18\n\x07a\ \x01\x20\x01(\r:\x010R\x08coinType\x12\x18\n\x06amount\x18\x02\x20\x01(\
ddress\x18\x03\x20\x02(\tR\x07address\x12\x1b\n\taddress_n\x18\x04\x20\ \t:\0R\x06amount\x12\x1a\n\x07address\x18\x03\x20\x01(\t:\0R\x07address\
\x03(\rR\x08addressN\x12\x10\n\x03mac\x18\x05\x20\x02(\x0cR\x03mac:\x04\ \x12\x1b\n\taddress_n\x18\x04\x20\x03(\rR\x08addressN\x12\x12\n\x03mac\
\x88\xb2\x19\x01B>\n#com.satoshilabs.trezor.lib.protobufB\x13TrezorMessa\ \x18\x05\x20\x01(\x0c:\0R\x03mac:\x04\x88\xb2\x19\x01B>\n#com.satoshilab\
geCommon\x80\xa6\x1d\x01\ s.trezor.lib.protobufB\x13TrezorMessageCommon\x80\xa6\x1d\x01\
"; ";
/// `FileDescriptorProto` object which was a source for this generated file /// `FileDescriptorProto` object which was a source for this generated file