Merge pull request #14 from mintlayer/firmware_versioning

Mintlayer firmware versioning

Author: ImplOfAnImpl

.github/actions/ui-report/action.yml

@@ -13,8 +13,13 @@ inputs:
     default: "failure"
 runs:
   using: composite
-  # Disabled for Mintlayer repository
-  # steps:
+  steps:
+    # Disabled for Mintlayer repository
+    # Note: GitHub doesn't like it when the "steps" element is missing or empty, so we add
+    # a placeholder step.
+    - run: echo "This action is disabled for Mintlayer repository"
+      shell: sh
+
   #   - name: Set AWS credentials
   #     uses: aws-actions/configure-aws-credentials@v4
   #     with:

README.md

@@ -1,3 +1,15 @@
+# This is Mintlayer's fork of the Trezor firmware repository
+
+Note: the fork maintains a parallel versioning scheme. The mapping between our version and the original version is as follows:
+
+| Mintlayer firmware version | Original firmware version | Upstream repository revision or tag  |
+| ---                        | ---                       | ---                                  |
+| 1.0.0                      | 2.9.0                     | core/v2.9.0                          |
+
+The current Mintlayer firmware version can be obtained via `trezorctl mintlayer get-firmware-info`.
+
+The original README goes below:
+
 # Trezor Firmware
 
 ![img](https://repository-images.githubusercontent.com/180590388/968e6880-6538-11e9-9da6-4aef78157e94)

common/protob/messages-mintlayer.proto

@@ -15,6 +15,26 @@ enum MintlayerChainType {
     Signet = 4;
 }
 
+/**
+ * Request: Ask the device for the info about the current firmware
+ * @start
+ * @next MintlayerFirmwareInfo
+ * @next Failure
+ */
+message MintlayerGetFirmwareInfo {}
+
+/**
+ * Response: The info about the current firmware
+ * @end
+ */
+message MintlayerFirmwareInfo {
+    required uint32 major_version = 1;          // major version of the firmware, e.g. 1
+    required uint32 minor_version = 2;          // minor version of the firmware, e.g. 0
+    required uint32 patch_version = 3;          // patch version of the firmware, e.g. 0
+    required string prerelease_id = 4;          // semver pre-release identifier, e.g. "alpha"; can be empty
+    required string build_metadata = 5;         // semver build metadata; can be empty
+}
+
 /**
  * Request: Ask the device for a Mintlayer address.
  * @start

common/protob/messages.proto

@@ -355,12 +355,14 @@ enum MessageType {
     MessageType_BenchmarkResult = 9103 [(bitcoin_only) = true];
 
     // Mintlayer
-    MessageType_MintlayerGetAddress = 10000 [(wire_in) = true];
-    MessageType_MintlayerAddress = 10001 [(wire_out) = true];
-    MessageType_MintlayerGetPublicKey = 10002 [(wire_in) = true];
-    MessageType_MintlayerPublicKey = 10003 [(wire_out) = true];
-    MessageType_MintlayerSignMessage = 10004 [(wire_in) = true];
-    MessageType_MintlayerSignTx = 10005 [(wire_in) = true];
-    MessageType_MintlayerTxRequest = 10006 [(wire_out) = true];
-    MessageType_MintlayerTxAck = 10007 [(wire_in) = true];
+    MessageType_MintlayerGetFirmwareInfo = 10000 [(wire_in) = true];
+    MessageType_MintlayerFirmwareInfo = 10001 [(wire_out) = true];
+    MessageType_MintlayerGetAddress = 10002 [(wire_in) = true];
+    MessageType_MintlayerAddress = 10003 [(wire_out) = true];
+    MessageType_MintlayerGetPublicKey = 10004 [(wire_in) = true];
+    MessageType_MintlayerPublicKey = 10005 [(wire_out) = true];
+    MessageType_MintlayerSignMessage = 10006 [(wire_in) = true];
+    MessageType_MintlayerSignTx = 10007 [(wire_in) = true];
+    MessageType_MintlayerTxRequest = 10008 [(wire_out) = true];
+    MessageType_MintlayerTxAck = 10009 [(wire_in) = true];
 }

core/embed/upymod/qstrdefsport.h

@@ -154,6 +154,7 @@ Q(apps.management.show_tutorial)
 Q(apps.management.wipe_device)
 Q(apps.mintlayer)
 Q(apps.mintlayer.get_address)
+Q(apps.mintlayer.get_firmware_info)
 Q(apps.mintlayer.get_public_key)
 Q(apps.mintlayer.sign_message)
 Q(apps.mintlayer.sign_tx)
@@ -228,6 +229,7 @@ Q(get_address)
 Q(get_ecdh_session_key)
 Q(get_entropy)
 Q(get_firmware_hash)
+Q(get_firmware_info)
 Q(get_next_u2f_counter)
 Q(get_nonce)
 Q(get_ownership_id)

core/src/apps/mintlayer/get_firmware_info.py

@@ -0,0 +1,29 @@
+from typing import TYPE_CHECKING
+from ubinascii import hexlify
+
+from trezor import utils
+
+if TYPE_CHECKING:
+    from trezor.messages import MintlayerFirmwareInfo, MintlayerGetFirmwareInfo
+
+
+MINTLAYER_FIRMWARE_VERSION_MAJOR = 1
+MINTLAYER_FIRMWARE_VERSION_MINOR = 0
+MINTLAYER_FIRMWARE_VERSION_PATCH = 0
+MINTLAYER_FIRMWARE_PRERELEASE_ID = ""
+# Note: 12-character hash should be more than enough for any forseable future
+# (at the time of writing this, 9-character hashes seem to be sufficient, but it won't
+# hurt to have some leeway).
+MINTLAYER_FIRMWARE_BUILD_METADATA = hexlify(utils.SCM_REVISION).decode()[0:12]
+
+
+async def get_firmware_info(_msg: MintlayerGetFirmwareInfo) -> MintlayerFirmwareInfo:
+    from trezor.messages import MintlayerFirmwareInfo
+
+    return MintlayerFirmwareInfo(
+        major_version=MINTLAYER_FIRMWARE_VERSION_MAJOR,
+        minor_version=MINTLAYER_FIRMWARE_VERSION_MINOR,
+        patch_version=MINTLAYER_FIRMWARE_VERSION_PATCH,
+        prerelease_id=MINTLAYER_FIRMWARE_PRERELEASE_ID,
+        build_metadata=MINTLAYER_FIRMWARE_BUILD_METADATA,
+    )

core/src/apps/workflow_handlers.py

@@ -217,6 +217,8 @@ def _find_message_handler_module(msg_type: int) -> str:
             return "apps.solana.sign_tx"
 
         # mintlayer
+        if msg_type == MessageType.MintlayerGetFirmwareInfo:
+            return "apps.mintlayer.get_firmware_info"
         if msg_type == MessageType.MintlayerGetAddress:
             return "apps.mintlayer.get_address"
         if msg_type == MessageType.MintlayerGetPublicKey: