Merge branch 'fixproto'

Author: benma

messages/eth.proto

@@ -18,9 +18,12 @@ package shiftcrypto.bitbox02;
 import "common.proto";
 import "antiklepto.proto";
 
+// Kept for backwards compatibility. Use chain_id instead, introduced in v9.10.0.
 enum ETHCoin {
   ETH = 0;
+  // Removed in v9.14.0 - deprecated
   RopstenETH = 1;
+  // Removed in v9.14.0 - deprecated
   RinkebyETH = 2;
 }
 

py/bitbox02/bitbox02/communication/generated/btc_pb2.pyi

@@ -243,7 +243,7 @@ class BTCSignInitRequest(google.protobuf.message.Message):
     class _FormatUnitEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[BTCSignInitRequest._FormatUnit.ValueType], builtins.type):
         DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
         DEFAULT: BTCSignInitRequest._FormatUnit.ValueType  # 0
-        """According to BTCCoin (BTC, LTC, etc.)."""
+        """According to `coin` (BTC, LTC, etc.)."""
 
         SAT: BTCSignInitRequest._FormatUnit.ValueType  # 1
         """Only valid for BTC/TBTC, formats as "sat"/"tsat"."""
@@ -252,7 +252,7 @@ class BTCSignInitRequest(google.protobuf.message.Message):
         pass
 
     DEFAULT: BTCSignInitRequest.FormatUnit.ValueType  # 0
-    """According to BTCCoin (BTC, LTC, etc.)."""
+    """According to `coin` (BTC, LTC, etc.)."""
 
     SAT: BTCSignInitRequest.FormatUnit.ValueType  # 1
     """Only valid for BTC/TBTC, formats as "sat"/"tsat"."""

py/bitbox02/bitbox02/communication/generated/eth_pb2.pyi

@@ -21,13 +21,22 @@ class _ETHCoinEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTy
     DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
     ETH: _ETHCoin.ValueType  # 0
     RopstenETH: _ETHCoin.ValueType  # 1
+    """Removed in v9.14.0 - deprecated"""
+
     RinkebyETH: _ETHCoin.ValueType  # 2
+    """Removed in v9.14.0 - deprecated"""
+
 class ETHCoin(_ETHCoin, metaclass=_ETHCoinEnumTypeWrapper):
+    """Kept for backwards compatibility. Use chain_id instead, introduced in v9.10.0."""
     pass
 
 ETH: ETHCoin.ValueType  # 0
 RopstenETH: ETHCoin.ValueType  # 1
+"""Removed in v9.14.0 - deprecated"""
+
 RinkebyETH: ETHCoin.ValueType  # 2
+"""Removed in v9.14.0 - deprecated"""
+
 global___ETHCoin = ETHCoin
 
 

src/rust/bitbox02-rust/src/hww/api/ethereum/params.rs

@@ -43,7 +43,7 @@ const PARAMS: &[Params] = &[
         unit: "ETH",
     },
     Params {
-        coin: Some(EthCoin::GoerliEth),
+        coin: None,
         bip44_coin: 1 + HARDENED,
         chain_id: 5,
         name: "Goerli",
@@ -144,7 +144,6 @@ mod tests {
     pub fn test_get() {
         assert_eq!(get(EthCoin::Eth, 0).unwrap().name, "Ethereum");
         assert_eq!(get(EthCoin::Eth, 1).unwrap().name, "Ethereum");
-        assert_eq!(get(EthCoin::GoerliEth, 0).unwrap().name, "Goerli");
         assert_eq!(get(EthCoin::Eth, 5).unwrap().name, "Goerli");
         assert_eq!(get(EthCoin::Eth, 56).unwrap().name, "Binance Smart Chain");
 

src/rust/bitbox02-rust/src/hww/api/ethereum/pubrequest.rs

@@ -231,10 +231,10 @@ mod tests {
             block_on(process(&pb::EthPubRequest {
                 output_type: OutputType::Address as _,
                 keypath: [44 + HARDENED, 60 + HARDENED, 0 + HARDENED, 0, 0].to_vec(),
-                coin: pb::EthCoin::GoerliEth as _,
+                coin: pb::EthCoin::Eth as _,
                 display: true,
                 contract_address: b"".to_vec(),
-                chain_id: 0,
+                chain_id: 5,
             })),
             Ok(Response::Pub(pb::PubResponse {
                 r#pub: ADDRESS.into()

src/rust/bitbox02-rust/src/hww/api/ethereum/sign.rs

@@ -472,7 +472,7 @@ mod tests {
         mock_unlocked();
 
         block_on(process(&pb::EthSignRequest {
-            coin: pb::EthCoin::GoerliEth as _,
+            coin: pb::EthCoin::Eth as _,
             keypath: KEYPATH.to_vec(),
             nonce: b"\x1f\xdc".to_vec(),
             gas_price: b"\x01\x65\xa0\xbc\x00".to_vec(),
@@ -483,7 +483,7 @@ mod tests {
             value: b"\x07\x5c\xf1\x25\x9e\x9c\x40\x00".to_vec(),
             data: b"".to_vec(),
             host_nonce_commitment: None,
-            chain_id: 0,
+            chain_id: 5,
         }))
         .unwrap();
         assert_eq!(unsafe { CONFIRM_COUNTER }, 1);
@@ -567,7 +567,7 @@ mod tests {
         mock_unlocked();
         assert_eq!(
             block_on(process(&pb::EthSignRequest {
-                coin: pb::EthCoin::GoerliEth as _, // ignored because chain_id > 0
+                coin: pb::EthCoin::RopstenEth as _, // ignored because chain_id > 0
                 keypath: KEYPATH.to_vec(),
                 nonce: b"\x23\x67".to_vec(),
                 gas_price: b"\x02\x7a\xca\x1a\x80".to_vec(),

src/rust/bitbox02-rust/src/hww/api/ethereum/signmsg.rs

@@ -178,11 +178,11 @@ mod tests {
         });
         mock_unlocked();
         block_on(process(&pb::EthSignMessageRequest {
-            coin: pb::EthCoin::GoerliEth as _,
+            coin: pb::EthCoin::Eth as _,
             keypath: KEYPATH.to_vec(),
             msg: MESSAGE.to_vec(),
             host_nonce_commitment: None,
-            chain_id: 0,
+            chain_id: 5,
         }))
         .unwrap();
         assert_eq!(unsafe { CONFIRM_COUNTER }, 3);

src/rust/bitbox02-rust/src/shiftcrypto.bitbox02.backups.rs

@@ -1,33 +1,36 @@
+#[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct BackupMetaData {
-    #[prost(uint32, tag="1")]
+    #[prost(uint32, tag = "1")]
     pub timestamp: u32,
-    #[prost(string, tag="2")]
+    #[prost(string, tag = "2")]
     pub name: ::prost::alloc::string::String,
-    #[prost(enumeration="BackupMode", tag="3")]
+    #[prost(enumeration = "BackupMode", tag = "3")]
     pub mode: i32,
 }
-///*
+/// *
 /// BackupData is encoded in the data field of the BackupContent
 /// and depends on the BackupMode.
 /// Defining it as a protobuf message allows language/architecture independent
 /// encoding/decoding.
+#[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct BackupData {
-    #[prost(uint32, tag="1")]
+    #[prost(uint32, tag = "1")]
     pub seed_length: u32,
-    #[prost(bytes="vec", tag="2")]
+    #[prost(bytes = "vec", tag = "2")]
     pub seed: ::prost::alloc::vec::Vec<u8>,
-    #[prost(uint32, tag="3")]
+    #[prost(uint32, tag = "3")]
     pub birthdate: u32,
-    #[prost(string, tag="4")]
+    #[prost(string, tag = "4")]
     pub generator: ::prost::alloc::string::String,
 }
+#[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct BackupContent {
-    #[prost(bytes="vec", tag="1")]
+    #[prost(bytes = "vec", tag = "1")]
     pub checksum: ::prost::alloc::vec::Vec<u8>,
-    #[prost(message, optional, tag="2")]
+    #[prost(message, optional, tag = "2")]
     pub metadata: ::core::option::Option<BackupMetaData>,
     /// This field is obsolete and from v9.13.0, it is set to 0.
     ///
@@ -39,35 +42,30 @@ pub struct BackupContent {
     /// Since this field is part of the checksum computation, we keep it so that existing backups can
     /// be loaded and the checksum verified. Other than that, it serves no purpose, as it is not
     /// needed to deserialize or interpret the data.
-    #[prost(uint32, tag="3")]
+    #[prost(uint32, tag = "3")]
     pub length: u32,
-    #[prost(bytes="vec", tag="4")]
+    #[prost(bytes = "vec", tag = "4")]
     pub data: ::prost::alloc::vec::Vec<u8>,
 }
-// NOTE! Once the firmware is released to the general public and there are actual backups it is
-// strictly forbidden to modify BackupV1 and any types contained within BackupV1 because the
-// checksum covers all fields. 
-
+#[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct BackupV1 {
-    #[prost(message, optional, tag="1")]
+    #[prost(message, optional, tag = "1")]
     pub content: ::core::option::Option<BackupContent>,
 }
-//message Backup_V2 {
-//RSBackupContent rs_content = 1;
-//}
-
+#[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Backup {
-    #[prost(oneof="backup::BackupVersion", tags="1")]
+    #[prost(oneof = "backup::BackupVersion", tags = "1")]
     pub backup_version: ::core::option::Option<backup::BackupVersion>,
 }
 /// Nested message and enum types in `Backup`.
 pub mod backup {
+    #[allow(clippy::derive_partial_eq_without_eq)]
     #[derive(Clone, PartialEq, ::prost::Oneof)]
     pub enum BackupVersion {
-        ///        Backup_V2 backup_V2 = 2;
-        #[prost(message, tag="1")]
+        ///         Backup_V2 backup_V2 = 2;
+        #[prost(message, tag = "1")]
         BackupV1(super::BackupV1),
     }
 }
@@ -76,3 +74,21 @@ pub mod backup {
 pub enum BackupMode {
     Plaintext = 0,
 }
+impl BackupMode {
+    /// String value of the enum field names used in the ProtoBuf definition.
+    ///
+    /// The values are not transformed in any way and thus are considered stable
+    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
+    pub fn as_str_name(&self) -> &'static str {
+        match self {
+            BackupMode::Plaintext => "PLAINTEXT",
+        }
+    }
+    /// Creates an enum from field names used in the ProtoBuf definition.
+    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
+        match value {
+            "PLAINTEXT" => Some(Self::Plaintext),
+            _ => None,
+        }
+    }
+}