arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-28 18:38:39 +00:00
Code Issues Releases Wiki Activity

feat(common): send BIP-380 descriptor in GetPublicKey response

Browse Source 
[no changelog]
This commit is contained in:
Martin Milata 2024-02-23 01:03:54 +01:00
parent a2b53e3c46
commit 3f10a291b5
5 changed files with 98 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
common/protob/messages-bitcoin.proto
View File

@ -92,9 +92,10 @@ message GetPublicKey {
* @end * @end
*/ */
message PublicKey { message PublicKey {
required common.HDNodeType node = 1; // BIP32 public node required common.HDNodeType node = 1; // BIP-32 public node
required string xpub = 2; // serialized form of public node required string xpub = 2; // serialized form of public node
optional uint32 root_fingerprint = 3; // master root node fingerprint optional uint32 root_fingerprint = 3; // master root node fingerprint
optional string descriptor = 4; // BIP-380 descriptor
} }
/** /**

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

@ -447,6 +447,7 @@ if TYPE_CHECKING:
node: "HDNodeType" node: "HDNodeType"
xpub: "str" xpub: "str"
root_fingerprint: "int | None" root_fingerprint: "int | None"
descriptor: "str | None"
def __init__( def __init__(
self, self,
@ -454,6 +455,7 @@ if TYPE_CHECKING:
node: "HDNodeType", node: "HDNodeType",
xpub: "str", xpub: "str",
root_fingerprint: "int | None" = None, root_fingerprint: "int | None" = None,
descriptor: "str | None" = None,
) -> None: ) -> None:
pass pass

1
legacy/firmware/protob/messages-bitcoin.options
View File

@ -3,6 +3,7 @@ GetPublicKey.ecdsa_curve_name max_size:32
GetPublicKey.coin_name max_size:21 GetPublicKey.coin_name max_size:21
PublicKey.xpub max_size:113 PublicKey.xpub max_size:113
PublicKey.descriptor type:FT_IGNORE
GetAddress.address_n max_count:8 GetAddress.address_n max_count:8
GetAddress.coin_name max_size:21 GetAddress.coin_name max_size:21

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

@ -1046,6 +1046,7 @@ class PublicKey(protobuf.MessageType):
1: protobuf.Field("node", "HDNodeType", repeated=False, required=True), 1: protobuf.Field("node", "HDNodeType", repeated=False, required=True),
2: protobuf.Field("xpub", "string", repeated=False, required=True), 2: protobuf.Field("xpub", "string", repeated=False, required=True),
3: protobuf.Field("root_fingerprint", "uint32", repeated=False, required=False, default=None), 3: protobuf.Field("root_fingerprint", "uint32", repeated=False, required=False, default=None),
4: protobuf.Field("descriptor", "string", repeated=False, required=False, default=None),
} }
def __init__( def __init__(
@ -1054,10 +1055,12 @@ class PublicKey(protobuf.MessageType):
node: "HDNodeType", node: "HDNodeType",
xpub: "str", xpub: "str",
root_fingerprint: Optional["int"] = None, root_fingerprint: Optional["int"] = None,
descriptor: Optional["str"] = None,
) -> None: ) -> None:
self.node = node self.node = node
self.xpub = xpub self.xpub = xpub
self.root_fingerprint = root_fingerprint self.root_fingerprint = root_fingerprint
self.descriptor = descriptor
class GetAddress(protobuf.MessageType): class GetAddress(protobuf.MessageType):

125
rust/trezor-client/src/protos/generated/messages_bitcoin.rs generated
View File

@ -768,6 +768,8 @@ pub struct PublicKey {
pub xpub: ::std::option::Option<::std::string::String>, pub xpub: ::std::option::Option<::std::string::String>,
// @@protoc_insertion_point(field:hw.trezor.messages.bitcoin.PublicKey.root_fingerprint) // @@protoc_insertion_point(field:hw.trezor.messages.bitcoin.PublicKey.root_fingerprint)
pub root_fingerprint: ::std::option::Option<u32>, pub root_fingerprint: ::std::option::Option<u32>,
// @@protoc_insertion_point(field:hw.trezor.messages.bitcoin.PublicKey.descriptor)
pub descriptor: ::std::option::Option<::std::string::String>,
// special fields // special fields
// @@protoc_insertion_point(special_field:hw.trezor.messages.bitcoin.PublicKey.special_fields) // @@protoc_insertion_point(special_field:hw.trezor.messages.bitcoin.PublicKey.special_fields)
pub special_fields: ::protobuf::SpecialFields, pub special_fields: ::protobuf::SpecialFields,
@ -839,8 +841,44 @@ impl PublicKey {
self.root_fingerprint = ::std::option::Option::Some(v); self.root_fingerprint = ::std::option::Option::Some(v);
} }
// optional string descriptor = 4;
pub fn descriptor(&self) -> &str {
match self.descriptor.as_ref() {
Some(v) => v,
None => "",
}
}
pub fn clear_descriptor(&mut self) {
self.descriptor = ::std::option::Option::None;
}
pub fn has_descriptor(&self) -> bool {
self.descriptor.is_some()
}
// Param is passed by value, moved
pub fn set_descriptor(&mut self, v: ::std::string::String) {
self.descriptor = ::std::option::Option::Some(v);
}
// Mutable pointer to the field.
// If field is not initialized, it is initialized with default value first.
pub fn mut_descriptor(&mut self) -> &mut ::std::string::String {
if self.descriptor.is_none() {
self.descriptor = ::std::option::Option::Some(::std::string::String::new());
}
self.descriptor.as_mut().unwrap()
}
// Take field
pub fn take_descriptor(&mut self) -> ::std::string::String {
self.descriptor.take().unwrap_or_else(|| ::std::string::String::new())
}
fn generated_message_descriptor_data() -> ::protobuf::reflect::GeneratedMessageDescriptorData { fn generated_message_descriptor_data() -> ::protobuf::reflect::GeneratedMessageDescriptorData {
let mut fields = ::std::vec::Vec::with_capacity(3); let mut fields = ::std::vec::Vec::with_capacity(4);
let mut oneofs = ::std::vec::Vec::with_capacity(0); let mut oneofs = ::std::vec::Vec::with_capacity(0);
fields.push(::protobuf::reflect::rt::v2::make_message_field_accessor::<_, super::messages_common::HDNodeType>( fields.push(::protobuf::reflect::rt::v2::make_message_field_accessor::<_, super::messages_common::HDNodeType>(
"node", "node",
@ -857,6 +895,11 @@ impl PublicKey {
|m: &PublicKey| { &m.root_fingerprint }, |m: &PublicKey| { &m.root_fingerprint },
|m: &mut PublicKey| { &mut m.root_fingerprint }, |m: &mut PublicKey| { &mut m.root_fingerprint },
)); ));
fields.push(::protobuf::reflect::rt::v2::make_option_accessor::<_, _>(
"descriptor",
|m: &PublicKey| { &m.descriptor },
|m: &mut PublicKey| { &mut m.descriptor },
));
::protobuf::reflect::GeneratedMessageDescriptorData::new_2::<PublicKey>( ::protobuf::reflect::GeneratedMessageDescriptorData::new_2::<PublicKey>(
"PublicKey", "PublicKey",
fields, fields,
@ -895,6 +938,9 @@ impl ::protobuf::Message for PublicKey {
24 => { 24 => {
self.root_fingerprint = ::std::option::Option::Some(is.read_uint32()?); self.root_fingerprint = ::std::option::Option::Some(is.read_uint32()?);
}, },
34 => {
self.descriptor = ::std::option::Option::Some(is.read_string()?);
},
tag => { tag => {
::protobuf::rt::read_unknown_or_skip_group(tag, is, self.special_fields.mut_unknown_fields())?; ::protobuf::rt::read_unknown_or_skip_group(tag, is, self.special_fields.mut_unknown_fields())?;
}, },
@ -917,6 +963,9 @@ impl ::protobuf::Message for PublicKey {
if let Some(v) = self.root_fingerprint { if let Some(v) = self.root_fingerprint {
my_size += ::protobuf::rt::uint32_size(3, v); my_size += ::protobuf::rt::uint32_size(3, v);
} }
if let Some(v) = self.descriptor.as_ref() {
my_size += ::protobuf::rt::string_size(4, &v);
}
my_size += ::protobuf::rt::unknown_fields_size(self.special_fields.unknown_fields()); my_size += ::protobuf::rt::unknown_fields_size(self.special_fields.unknown_fields());
self.special_fields.cached_size().set(my_size as u32); self.special_fields.cached_size().set(my_size as u32);
my_size my_size
@ -932,6 +981,9 @@ impl ::protobuf::Message for PublicKey {
if let Some(v) = self.root_fingerprint { if let Some(v) = self.root_fingerprint {
os.write_uint32(3, v)?; os.write_uint32(3, v)?;
} }
if let Some(v) = self.descriptor.as_ref() {
os.write_string(4, v)?;
}
os.write_unknown_fields(self.special_fields.unknown_fields())?; os.write_unknown_fields(self.special_fields.unknown_fields())?;
::std::result::Result::Ok(()) ::std::result::Result::Ok(())
} }
@ -952,6 +1004,7 @@ impl ::protobuf::Message for PublicKey {
self.node.clear(); self.node.clear();
self.xpub = ::std::option::Option::None; self.xpub = ::std::option::Option::None;
self.root_fingerprint = ::std::option::Option::None; self.root_fingerprint = ::std::option::Option::None;
self.descriptor = ::std::option::Option::None;
self.special_fields.clear(); self.special_fields.clear();
} }
@ -960,6 +1013,7 @@ impl ::protobuf::Message for PublicKey {
node: ::protobuf::MessageField::none(), node: ::protobuf::MessageField::none(),
xpub: ::std::option::Option::None, xpub: ::std::option::Option::None,
root_fingerprint: ::std::option::Option::None, root_fingerprint: ::std::option::Option::None,
descriptor: ::std::option::Option::None,
special_fields: ::protobuf::SpecialFields::new(), special_fields: ::protobuf::SpecialFields::new(),
}; };
&instance &instance
@ -13312,42 +13366,43 @@ static file_descriptor_proto_data: &'static [u8] = b"\
\x0bshowDisplay\x12$\n\tcoin_name\x18\x04\x20\x01(\t:\x07BitcoinR\x08coi\ \x0bshowDisplay\x12$\n\tcoin_name\x18\x04\x20\x01(\t:\x07BitcoinR\x08coi\
nName\x12Z\n\x0bscript_type\x18\x05\x20\x01(\x0e2+.hw.trezor.messages.bi\ nName\x12Z\n\x0bscript_type\x18\x05\x20\x01(\x0e2+.hw.trezor.messages.bi\
tcoin.InputScriptType:\x0cSPENDADDRESSR\nscriptType\x12*\n\x11ignore_xpu\ tcoin.InputScriptType:\x0cSPENDADDRESSR\nscriptType\x12*\n\x11ignore_xpu\
b_magic\x18\x06\x20\x01(\x08R\x0fignoreXpubMagic\"\x85\x01\n\tPublicKey\ b_magic\x18\x06\x20\x01(\x08R\x0fignoreXpubMagic\"\xa5\x01\n\tPublicKey\
\x129\n\x04node\x18\x01\x20\x02(\x0b2%.hw.trezor.messages.common.HDNodeT\ \x129\n\x04node\x18\x01\x20\x02(\x0b2%.hw.trezor.messages.common.HDNodeT\
ypeR\x04node\x12\x12\n\x04xpub\x18\x02\x20\x02(\tR\x04xpub\x12)\n\x10roo\ ypeR\x04node\x12\x12\n\x04xpub\x18\x02\x20\x02(\tR\x04xpub\x12)\n\x10roo\
t_fingerprint\x18\x03\x20\x01(\rR\x0frootFingerprint\"\xe8\x02\n\nGetAdd\ t_fingerprint\x18\x03\x20\x01(\rR\x0frootFingerprint\x12\x1e\n\ndescript\
ress\x12\x1b\n\taddress_n\x18\x01\x20\x03(\rR\x08addressN\x12$\n\tcoin_n\ or\x18\x04\x20\x01(\tR\ndescriptor\"\xe8\x02\n\nGetAddress\x12\x1b\n\tad\
ame\x18\x02\x20\x01(\t:\x07BitcoinR\x08coinName\x12!\n\x0cshow_display\ dress_n\x18\x01\x20\x03(\rR\x08addressN\x12$\n\tcoin_name\x18\x02\x20\
\x18\x03\x20\x01(\x08R\x0bshowDisplay\x12P\n\x08multisig\x18\x04\x20\x01\ \x01(\t:\x07BitcoinR\x08coinName\x12!\n\x0cshow_display\x18\x03\x20\x01(\
(\x0b24.hw.trezor.messages.bitcoin.MultisigRedeemScriptTypeR\x08multisig\ \x08R\x0bshowDisplay\x12P\n\x08multisig\x18\x04\x20\x01(\x0b24.hw.trezor\
\x12Z\n\x0bscript_type\x18\x05\x20\x01(\x0e2+.hw.trezor.messages.bitcoin\ .messages.bitcoin.MultisigRedeemScriptTypeR\x08multisig\x12Z\n\x0bscript\
.InputScriptType:\x0cSPENDADDRESSR\nscriptType\x12*\n\x11ignore_xpub_mag\ _type\x18\x05\x20\x01(\x0e2+.hw.trezor.messages.bitcoin.InputScriptType:\
ic\x18\x06\x20\x01(\x08R\x0fignoreXpubMagic\x12\x1a\n\x08chunkify\x18\ \x0cSPENDADDRESSR\nscriptType\x12*\n\x11ignore_xpub_magic\x18\x06\x20\
\x07\x20\x01(\x08R\x08chunkify\"5\n\x07Address\x12\x18\n\x07address\x18\ \x01(\x08R\x0fignoreXpubMagic\x12\x1a\n\x08chunkify\x18\x07\x20\x01(\x08\
\x01\x20\x02(\tR\x07address\x12\x10\n\x03mac\x18\x02\x20\x01(\x0cR\x03ma\ R\x08chunkify\"5\n\x07Address\x12\x18\n\x07address\x18\x01\x20\x02(\tR\
c\"\x81\x02\n\x0eGetOwnershipId\x12\x1b\n\taddress_n\x18\x01\x20\x03(\rR\ \x07address\x12\x10\n\x03mac\x18\x02\x20\x01(\x0cR\x03mac\"\x81\x02\n\
\x08addressN\x12$\n\tcoin_name\x18\x02\x20\x01(\t:\x07BitcoinR\x08coinNa\ \x0eGetOwnershipId\x12\x1b\n\taddress_n\x18\x01\x20\x03(\rR\x08addressN\
me\x12P\n\x08multisig\x18\x03\x20\x01(\x0b24.hw.trezor.messages.bitcoin.\ \x12$\n\tcoin_name\x18\x02\x20\x01(\t:\x07BitcoinR\x08coinName\x12P\n\
MultisigRedeemScriptTypeR\x08multisig\x12Z\n\x0bscript_type\x18\x04\x20\ \x08multisig\x18\x03\x20\x01(\x0b24.hw.trezor.messages.bitcoin.MultisigR\
\x01(\x0e2+.hw.trezor.messages.bitcoin.InputScriptType:\x0cSPENDADDRESSR\ edeemScriptTypeR\x08multisig\x12Z\n\x0bscript_type\x18\x04\x20\x01(\x0e2\
\nscriptType\"0\n\x0bOwnershipId\x12!\n\x0cownership_id\x18\x01\x20\x02(\ +.hw.trezor.messages.bitcoin.InputScriptType:\x0cSPENDADDRESSR\nscriptTy\
\x0cR\x0bownershipId\"\x88\x02\n\x0bSignMessage\x12\x1b\n\taddress_n\x18\ pe\"0\n\x0bOwnershipId\x12!\n\x0cownership_id\x18\x01\x20\x02(\x0cR\x0bo\
\x01\x20\x03(\rR\x08addressN\x12\x18\n\x07message\x18\x02\x20\x02(\x0cR\ wnershipId\"\x88\x02\n\x0bSignMessage\x12\x1b\n\taddress_n\x18\x01\x20\
\x07message\x12$\n\tcoin_name\x18\x03\x20\x01(\t:\x07BitcoinR\x08coinNam\ \x03(\rR\x08addressN\x12\x18\n\x07message\x18\x02\x20\x02(\x0cR\x07messa\
e\x12Z\n\x0bscript_type\x18\x04\x20\x01(\x0e2+.hw.trezor.messages.bitcoi\ ge\x12$\n\tcoin_name\x18\x03\x20\x01(\t:\x07BitcoinR\x08coinName\x12Z\n\
n.InputScriptType:\x0cSPENDADDRESSR\nscriptType\x12$\n\x0eno_script_type\ \x0bscript_type\x18\x04\x20\x01(\x0e2+.hw.trezor.messages.bitcoin.InputS\
\x18\x05\x20\x01(\x08R\x0cnoScriptType\x12\x1a\n\x08chunkify\x18\x06\x20\ criptType:\x0cSPENDADDRESSR\nscriptType\x12$\n\x0eno_script_type\x18\x05\
\x01(\x08R\x08chunkify\"J\n\x10MessageSignature\x12\x18\n\x07address\x18\ \x20\x01(\x08R\x0cnoScriptType\x12\x1a\n\x08chunkify\x18\x06\x20\x01(\
\x01\x20\x02(\tR\x07address\x12\x1c\n\tsignature\x18\x02\x20\x02(\x0cR\t\ \x08R\x08chunkify\"J\n\x10MessageSignature\x12\x18\n\x07address\x18\x01\
signature\"\xa3\x01\n\rVerifyMessage\x12\x18\n\x07address\x18\x01\x20\ \x20\x02(\tR\x07address\x12\x1c\n\tsignature\x18\x02\x20\x02(\x0cR\tsign\
\x02(\tR\x07address\x12\x1c\n\tsignature\x18\x02\x20\x02(\x0cR\tsignatur\ ature\"\xa3\x01\n\rVerifyMessage\x12\x18\n\x07address\x18\x01\x20\x02(\t\
e\x12\x18\n\x07message\x18\x03\x20\x02(\x0cR\x07message\x12$\n\tcoin_nam\ R\x07address\x12\x1c\n\tsignature\x18\x02\x20\x02(\x0cR\tsignature\x12\
e\x18\x04\x20\x01(\t:\x07BitcoinR\x08coinName\x12\x1a\n\x08chunkify\x18\ \x18\n\x07message\x18\x03\x20\x02(\x0cR\x07message\x12$\n\tcoin_name\x18\
\x05\x20\x01(\x08R\x08chunkify\"\xd9\x06\n\x06SignTx\x12#\n\routputs_cou\ \x04\x20\x01(\t:\x07BitcoinR\x08coinName\x12\x1a\n\x08chunkify\x18\x05\
nt\x18\x01\x20\x02(\rR\x0coutputsCount\x12!\n\x0cinputs_count\x18\x02\ \x20\x01(\x08R\x08chunkify\"\xd9\x06\n\x06SignTx\x12#\n\routputs_count\
\x20\x02(\rR\x0binputsCount\x12$\n\tcoin_name\x18\x03\x20\x01(\t:\x07Bit\ \x18\x01\x20\x02(\rR\x0coutputsCount\x12!\n\x0cinputs_count\x18\x02\x20\
coinR\x08coinName\x12\x1b\n\x07version\x18\x04\x20\x01(\r:\x011R\x07vers\ \x02(\rR\x0binputsCount\x12$\n\tcoin_name\x18\x03\x20\x01(\t:\x07Bitcoin\
ion\x12\x1e\n\tlock_time\x18\x05\x20\x01(\r:\x010R\x08lockTime\x12\x16\n\ R\x08coinName\x12\x1b\n\x07version\x18\x04\x20\x01(\r:\x011R\x07version\
\x12\x1e\n\tlock_time\x18\x05\x20\x01(\r:\x010R\x08lockTime\x12\x16\n\
\x06expiry\x18\x06\x20\x01(\rR\x06expiry\x12&\n\x0coverwintered\x18\x07\ \x06expiry\x18\x06\x20\x01(\rR\x06expiry\x12&\n\x0coverwintered\x18\x07\
\x20\x01(\x08R\x0coverwinteredB\x02\x18\x01\x12(\n\x10version_group_id\ \x20\x01(\x08R\x0coverwinteredB\x02\x18\x01\x12(\n\x10version_group_id\
\x18\x08\x20\x01(\rR\x0eversionGroupId\x12\x1c\n\ttimestamp\x18\t\x20\ \x18\x08\x20\x01(\rR\x0eversionGroupId\x12\x1c\n\ttimestamp\x18\t\x20\