App cleanup

Cargo.toml

@@ -13,16 +13,17 @@ version = "0.1.0"
 [workspace.dependencies]
 bech32 = { version = "0.11", default-features = false }
 chrono = { version = "0.4", default-features = false }
-derive_more = { version = "2.1.1", default-features = false }
-hex = { version = "0.4.3", default-features = false }
-image = "0.25.8"
-ledger_device_sdk = "1.35.1"
-ledger_secure_sdk_sys = "1.16.1"
-num_enum = { version = "0.7.5", default-features = false }
+derive_more = { version = "2.1", default-features = false }
+hex = { version = "0.4", default-features = false }
+image = "0.25"
+ledger_device_sdk = "1.35"
+ledger_secure_sdk_sys = "1.16"
+num_enum = { version = "0.7", default-features = false }
+num-traits = { version = "0.2", default-features = false }
 # Note: the testmacro crate is published by Ledger and its source code comes from the `testmacro`
 # dir inside the sdk repo, i.e. https://github.com/LedgerHQ/ledger-device-rust-sdk/tree/cad196841dbd72c037cfa01bec81a4a3ae57a04e/testmacro
 # (though the published version is a bit older).
-testmacro = "0.1.0"
+testmacro = "0.1"
 
 mintlayer-app-core = { path = "crates/app-core" }
 mintlayer-messages = { path = "crates/messages" }
@@ -68,16 +69,16 @@ path = ["44'/19788'", "44'/1'"]
 name = "Mintlayer"
 
 [package.metadata.ledger.nanox]
-icon = "icons/mintlayer_14x14.gif"
+icon = "media/icons/mintlayer_14x14.gif"
 
 [package.metadata.ledger.nanosplus]
-icon = "icons/mintlayer_14x14.gif"
+icon = "media/icons/mintlayer_14x14.gif"
 
 [package.metadata.ledger.stax]
-icon = "icons/mintlayer_32x32.gif"
+icon = "media/icons/mintlayer_32x32.gif"
 
 [package.metadata.ledger.flex]
-icon = "icons/mintlayer_40x40.gif"
+icon = "media/icons/mintlayer_40x40.gif"
 
 [package.metadata.ledger.apex_p]
-icon = "icons/mintlayer_32x32.png"
+icon = "media/icons/mintlayer_32x32.png"

README.md

@@ -2,15 +2,17 @@
 
 ![Rule enforcer](https://github.com/mintlayer/mintlayer-ledger-app/actions/workflows/guidelines_enforcer.yml/badge.svg) ![Build and tests](https://github.com/mintlayer/mintlayer-ledger-app/actions/workflows/build_and_functional_tests.yml/badge.svg)
 
-This is the Mintlayer Ledger application for the Ledger Nano X, S+, Stax, Flex and Nano Gen 5 devices.
+This is the Mintlayer Ledger application for the Ledger Nano X, Nano S+, Stax, Flex and Nano Gen 5 devices.
 
-:warning: Nano S is not supported
+ℹ️ Nano Gen 5 is usually referred to by its codename, Apex P.
+
+⚠️ Nano S is not supported.
 
 ## Quick start guide
 
 ### With VS Code
 
-You can quickly setup a development environment on any platform (macOS, Linux or Windows) to build and test your application with [Ledger's VS Code extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools).
+You can quickly set up a development environment on any platform (macOS, Linux or Windows) to build and test your application with [Ledger's VS Code extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools).
 
 By using Ledger's own developer tools [Docker image](https://github.com/LedgerHQ/ledger-app-builder/pkgs/container/ledger-app-builder%2Fledger-app-dev-tools), the extension allows you to **build** your apps with the latest SDK, **test** them on **Speculos** and **load** them on any supported device.
 
@@ -19,45 +21,45 @@ By using Ledger's own developer tools [Docker image](https://github.com/LedgerHQ
   - On Ubuntu Linux, it should be running by default.
   - On macOS, install and launch [XQuartz](https://www.xquartz.org/) (make sure to go to XQuartz > Preferences > Security and check "Allow client connections").
   - On Windows, install and launch [VcXsrv](https://sourceforge.net/projects/vcxsrv/) (make sure to configure it to disable access control).
-- Install [VScode](https://code.visualstudio.com/download) and add [Ledger's extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools).
-- Open a terminal and clone `app-boilerplate-rust` with `git clone git@github.com:LedgerHQ/app-boilerplate-rust.git`.
-- Open the `app-boilerplate-rust` folder with VSCode.
+- Install [VS Code](https://code.visualstudio.com/download) and add [Ledger's extension](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools).
+- Open a terminal and clone `mintlayer-ledger-app` with `git clone git@github.com:mintlayer/mintlayer-ledger-app.git`.
+- Open the `mintlayer-ledger-app` folder with VS Code.
 - Use Ledger extension's sidebar menu or open the tasks menu with `ctrl + shift + b` (`command + shift + b` on a Mac) to conveniently execute actions :
   - **Build** the app for the device model of your choice with `Build`.
   - **Test** your binary on the [Speculos emulator](https://github.com/LedgerHQ/speculos) with `Run with emulator`.
   - You can also **run functional tests**, load the app on a physical device, and more.
 
-ℹ️ The terminal tab of VSCode will show you what commands the extension runs behind the scene.
+ℹ️ The terminal tab of VS Code will show you what commands the extension runs behind the scene.
 
 ## With a terminal
 
 ### Prerequisites
 
-If you do not wish to use the [VS Code extension](#with-vs-code), you can follow the following steps to setup a development environment on Linux, Windows or MacOS.
+If you do not wish to use the [VS Code extension](#with-vs-code), you can follow the following steps to set up a development environment on Linux, Windows or macOS.
 
 - The [ledger-app-dev-tools](https://github.com/LedgerHQ/ledger-app-builder/pkgs/container/ledger-app-builder%2Fledger-app-dev-tools) Docker image contains all the required tools and libraries to build, test and load an application on a device. You can download it from the ghcr.io docker repository:
 
-```shell
-sudo docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
-```
+  ```bash
+  docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+  ```
 
 - Make sure you have an X11 server running :
   - On Ubuntu Linux, it should be running by default.
   - On macOS, install and launch [XQuartz](https://www.xquartz.org/) (make sure to go to XQuartz > Preferences > Security and check "Allow client connections").
   - On Windows, install and launch [VcXsrv](https://sourceforge.net/projects/vcxsrv/) (make sure to configure it to disable access control).
 - You can then enter into this development environment by executing the following command from the directory of the application (`git` repository):
   - Linux (Ubuntu):
-  ```shell
-  sudo docker run --rm -ti --privileged -v "/dev/bus/usb:/dev/bus/usb" -v "$(realpath .):/app" --publish 5001:5001 --publish 9999:9999 -e DISPLAY=$DISPLAY -v '/tmp/.X11-unix:/tmp/.X11-unix' ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
-  ```
+    ```bash
+    docker run --user "$(id -u)":"$(id -g)" --rm -ti --privileged -v "/dev/bus/usb:/dev/bus/usb" -v "$(realpath .):/app" --publish 5000:5000 --publish 9999:9999 -e DISPLAY=$DISPLAY -v '/tmp/.X11-unix:/tmp/.X11-unix' ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+    ```
   - macOS:
-  ```shell
-  sudo docker run  --rm -ti --privileged -v "$(pwd -P):/app" --publish 5001:5001 --publish 9999:9999 -e DISPLAY='host.docker.internal:0' -v '/tmp/.X11-unix:/tmp/.X11-unix' ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
-  ```
+    ```bash
+    docker run --user "$(id -u)":"$(id -g)" --rm -ti --privileged -v "$(pwd -P):/app" --publish 5000:5000 --publish 9999:9999 -e DISPLAY='host.docker.internal:0' -v '/tmp/.X11-unix:/tmp/.X11-unix' ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+    ```
   - Windows (with PowerShell):
-  ```shell
-  docker run --rm -ti --privileged -v "$(Get-Location):/app" -e DISPLAY='host.docker.internal:0' --publish 5001:5001 --publish 9999:9999 ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
-  ```
+    ```bash
+    docker run --rm -ti --privileged -v "$(Get-Location):/app" -e DISPLAY='host.docker.internal:0' --publish 5000:5000 --publish 9999:9999 ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
+    ```
 
 The application's code will be available from inside the docker container, you can proceed to the following compilation steps to build your app.
 
@@ -69,7 +71,7 @@ You can build the Mintlayer app with the following command executed in the root
 cargo ledger build nanox
 ```
 
-This command will build the app for the Nano X, but you can use any supported device (`nanox`, `nanosplus`, `stax`, `flex`)
+This command will build the app for the Nano X, but you can use any supported device (`nanox`, `nanosplus`, `stax`, `flex`, `apex_p`).
 
 ### Testing
 
@@ -79,15 +81,17 @@ This Mintlayer app comes with functional tests implemented with Ledger's [Ragger
 
 - Install the tests requirements
 
-```bash
-pip install -r tests/requirements.txt
-```
+  ```bash
+  pip install -r tests/requirements.txt
+  ```
 
 - Run the functional tests :
 
-```shell
-pytest tests/ --tb=short -v --device {nanosp | nanox | stax | flex}
-```
+  ```bash
+  pytest tests/ --tb=short -v --device {nanosp | nanox | stax | flex | apex_p}
+  ```
+
+ℹ️ Speculos uses `nanosp` for Nano S+ (whereas `ledger_app.toml` lists it as `nanos+`).
 
 #### Emulator
 
@@ -99,51 +103,81 @@ You can also run the app directly on the [Speculos emulator](https://github.com/
 speculos --apdu-port 9999 --api-port 5000 --display headless --model nanosp target/nanosplus/release/mintlayer-app
 ```
 
-:warning: UI is displayed on `localhost:5000`
+⚠️ UI is displayed on `localhost:5000`.
 
-#### Stax or Flex
+#### Stax, Flex or Nano Gen 5
 
 ```bash
 speculos --apdu-port 9999 --api-port 5000 --model stax target/stax/release/mintlayer-app
 ```
 
-You can also specify the seed phrase with -s "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
-
-:warning: UI is displayed by your X server
+⚠️ UI is displayed by your X server.
 
 You can then send APDU using `ledgercomm` (`pip install ledgercomm`):
 
 ```
 ledgercomm-send file test.apdu
 ```
 
+ℹ️ You can also specify the seed phrase via `-s`, e.g.: `-s "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"`.
+
 ### Loading on device
 
-:warning: Loading the built application on a device shall be performed out of the Docker container, by using [ledgerctl](https://github.com/LedgerHQ/ledgerctl):
+On Linux, loading the application on a device can be done inside the docker container via:
 
-```shell
-pip3 install ledgerwallet
+```bash
+cargo ledger build nanox --load
 ```
+(the `--privileged -v "/dev/bus/usb:/dev/bus/usb"` part of the Docker run command line allows this).
+
+It can also be done outside the docker container on all platforms via [ledgerblue](https://pypi.org/project/ledgerblue/):
+
+* Install `ledgerblue`:
+  ```bash
+  pip install ledgerblue
+  ```
+
+* Build the app inside the docker container as usual.
+
+* Load the app on device, e.g. for Flex:
+  ```bash
+  python -m ledgerblue.runScript --targetId <id> --fileName target/flex/release/mintlayer-app.apdu --apdu --scp
+  ```
 
 ℹ️ Your device must be connected, unlocked and the screen showing the dashboard (not inside an application).
 
-For instance, for Flex:
+#### About the device target ID
 
+ledgerblue needs the device's `targetId`.
+
+If you call ledgerblue manually, note that its `--targetId` defaults to `0x31100002` (Nano S) — wrong for every other device,
+and it is **not** auto-detected from the connected device.
+The cleanest option is to let ledgerblue read the id straight from the ELF with `--elfFile`, which overrides `--targetId`:
+
+```bash
+python -m ledgerblue.runScript --elfFile target/flex/release/mintlayer-app --fileName target/flex/release/mintlayer-app.apdu --apdu --scp
+```
+
+If you instead need the raw target ID value (e.g. for a CI script), the [`tools/get_target_id.py`](tools/get_target_id.py)
+helper extracts it from the `ledger.target_id` ELF section:
 ```bash
-ledgerctl install -f target/flex/release/app_flex.json
+python tools/get_target_id.py target/flex/release/mintlayer-app   # -> 0x33300004
 ```
 
 ## Continuous Integration
 
 The following workflows are executed in [GitHub Actions](https://github.com/features/actions) :
 
-- Ledger guidelines enforcer which verifies that an app is compliant with Ledger guidelines. The successful completion of this reusable workflow is a mandatory step for an app to be available on the Ledger application store. More information on the guidelines can be found in the repository [ledger-app-workflow](https://github.com/LedgerHQ/ledger-app-workflows)
-- Compilation of the application for all supported devices in the [ledger-app-builder](https://github.com/LedgerHQ/ledger-app-builder) docker image
-- End-to-end tests with the [Speculos](https://github.com/LedgerHQ/speculos) emulator and [ragger](https://github.com/LedgerHQ/ragger) (see [tests/](tests/))
+- Ledger guidelines enforcer which verifies that an app is compliant with Ledger guidelines. The successful completion of this reusable workflow is a mandatory step for an app to be available on the Ledger application store. More information on the guidelines can be found in the repository [ledger-app-workflow](https://github.com/LedgerHQ/ledger-app-workflows).
+- Compilation of the application for all supported devices in the [ledger-app-builder](https://github.com/LedgerHQ/ledger-app-builder) docker image.
+- End-to-end tests with the [Speculos](https://github.com/LedgerHQ/speculos) emulator and [ragger](https://github.com/LedgerHQ/ragger) (see [tests/](tests/)).
 - Various lint checks :
-  - Source code lint checks with `cargo fmt`
-  - Python functional test code lint checks with `pylint` and `mypy`
+  - Source code lint checks with `cargo fmt`.
+  - Python functional test code lint checks with `pylint` and `mypy`.
 
 ## Additional documentation
 
-For development guidelines related to the app's memory usage see [docs/memory_usage.md](docs/memory_usage.md).
+For the additional documentation, see the [docs](docs/) folder.
+
+- [docs/memory_usage.md](docs/memory_usage.md) - guidelines related to the app's memory usage.
+- [docs/technical_specification.md](docs/technical_specification.md) - app's technical specification.

build.rs

@@ -2,18 +2,22 @@ use std::process::Command;
 
 use image::{ImageFormat, ImageReader, Pixel};
 
+// FIXME: all image files currently contain the Rust logo; need to replace them with Mintlayer logo.
+
 fn main() {
     println!("cargo:rerun-if-changed=script.ld");
-    println!("cargo:rerun-if-changed=icons/mintlayer_14x14.gif");
-    println!("cargo:rerun-if-changed=icons/mask_14x14.gif");
+    println!("cargo:rerun-if-changed=media/icons/mintlayer_14x14.gif");
+    println!("cargo:rerun-if-changed=media/icons/mask_14x14.gif");
 
-    let path = std::path::PathBuf::from("icons");
-    let reader = ImageReader::open(path.join("mintlayer_14x14.gif")).unwrap();
-    let img = reader.decode().unwrap();
-    let mut gray = img.into_luma8();
+    let icons_path = std::path::PathBuf::from("media/icons");
+    let mut gray = ImageReader::open(icons_path.join("mintlayer_14x14.gif"))
+        .unwrap()
+        .decode()
+        .unwrap()
+        .into_luma8();
 
     // Apply mask
-    let mask = ImageReader::open(path.join("mask_14x14.gif"))
+    let mask = ImageReader::open(icons_path.join("mask_14x14.gif"))
         .unwrap()
         .decode()
         .unwrap()
@@ -30,7 +34,7 @@ fn main() {
         gray.put_pixel(x, y, gray_pixel);
     }
 
-    let glyph_path = std::path::PathBuf::from("glyphs");
+    let glyph_path = std::path::PathBuf::from("media/glyphs");
     gray.save_with_format(glyph_path.join("home_nano_nbgl.png"), ImageFormat::Png)
         .unwrap();
 
@@ -42,6 +46,8 @@ fn main() {
     let git_hash = String::from_utf8(output.stdout).expect("Failed to convert git output to UTF-8");
 
     // Expose the Git hash as an environment variable
+    // FIXME: this is unused. Either implement a custom command that would return this info
+    // (e.g. in the form of a full semantic version), or remove this.
     println!("cargo:rustc-env=GIT_HASH={}", git_hash.trim());
 
     // Rerun the build script if .git/HEAD changes

crates/app-core/src/app_ui/address.rs

@@ -1,7 +1,7 @@
 /*****************************************************************************
  *   Mintlayer Ledger App.
  *   (c) 2023 Ledger SAS.
- *   (c) 2025 RBB S.r.l.
+ *   (c) 2025-2026 RBB S.r.l.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -16,20 +16,21 @@
  *  limitations under the License.
  *****************************************************************************/
 
-use crate::{
-    app_ui::utils::{compress_public_key, load_glyph, to_address},
-    StatusWord,
-};
-use mintlayer_messages::mlcp::{CoinType, Destination, PublicKey};
-
 use ledger_device_sdk::{
     ecc::ECPublicKey,
     nbgl::{NbglAddressReview, NbglGlyph},
 };
 
+use mintlayer_messages::{Destination, PublicKey};
+
+use crate::{
+    app_ui::utils::{compress_public_key, load_glyph, to_address},
+    mlcp, StatusWord,
+};
+
 pub fn ui_display_pk<const T: char>(
     public_key: &ECPublicKey<65, T>,
-    coin_type: CoinType,
+    coin_type: mlcp::CoinType,
 ) -> Result<bool, StatusWord> {
     let pk = compress_public_key(public_key)?;
 

crates/app-core/src/app_ui/menu.rs

@@ -1,7 +1,7 @@
 /*****************************************************************************
  *   Mintlayer Ledger App.
  *   (c) 2023 Ledger SAS.
- *   (c) 2025 RBB S.r.l.
+ *   (c) 2025-2026 RBB S.r.l.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.