Merge pull request #114 from LedgerHQ/y333/nanos_nbgl_migration

Build Nano* version with NBGL

Author: yogh333

Cargo.lock

@@ -1,11 +1,11 @@
 [package]
 name = "app-boilerplate-rust"
-version = "1.6.3"
-authors = ["yhql", "agrojean-ledger"]
+version = "1.7.0"
+authors = ["Ledger"]
 edition = "2021"
 
 [dependencies]
-ledger_device_sdk = "1.20.3"
+ledger_device_sdk = "1.21.0"
 include_gif = "1.2.0"
 serde = { version="1.0.192", default-features = false, features = ["derive"] }
 serde-json-core = { git = "https://github.com/rust-embedded-community/serde-json-core" }
@@ -17,8 +17,8 @@ opt-level = 'z'
 lto = true
 
 [features]
-default = ["pending_review_screen"]
-pending_review_screen = []
+default = ["ledger_device_sdk/nbgl"]
+debug = ["ledger_device_sdk/debug"]
 
 [package.metadata.ledger]
 curve = ["secp256k1"]
@@ -39,4 +39,4 @@ icon = "crab_32x32.gif"
 icon = "crab_40x40.gif"
 
 [lints.rust]
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("stax", "flex", "nanos", "nanox", "nanosplus"))'] }
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("stax", "flex", "nanos", "nanox", "nanosplus"))'] }

Cargo.toml

@@ -18,17 +18,8 @@
 use crate::AppSW;
 use alloc::format;
 
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::ui::{
-    bitmaps::{CROSSMARK, EYE, VALIDATE_14},
-    gadgets::{Field, MultiFieldReview},
-};
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
-use ledger_device_sdk::nbgl::{NbglAddressReview, NbglGlyph};
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use include_gif::include_gif;
+use ledger_device_sdk::nbgl::{NbglAddressReview, NbglGlyph};
 
 // Display only the last 20 bytes of the address
 const DISPLAY_ADDR_BYTES_LEN: usize = 20;
@@ -39,34 +30,15 @@ pub fn ui_display_pk(addr: &[u8]) -> Result<bool, AppSW> {
         hex::encode(&addr[addr.len() - DISPLAY_ADDR_BYTES_LEN..]).to_uppercase()
     );
 
-    #[cfg(not(any(target_os = "stax", target_os = "flex")))]
-    {
-        let my_field = [Field {
-            name: "Address",
-            value: addr_hex.as_str(),
-        }];
-
-        let my_review = MultiFieldReview::new(
-            &my_field,
-            &["Confirm Address"],
-            Some(&EYE),
-            "Approve",
-            Some(&VALIDATE_14),
-            "Reject",
-            Some(&CROSSMARK),
-        );
-
-        Ok(my_review.show())
-    }
-
+    // Load glyph from 64x64 4bpp gif file with include_gif macro. Creates an NBGL compatible glyph.
     #[cfg(any(target_os = "stax", target_os = "flex"))]
-    {
-        // Load glyph from 64x64 4bpp gif file with include_gif macro. Creates an NBGL compatible glyph.
-        const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_64x64.gif", NBGL));
-        // Display the address confirmation screen.
-        Ok(NbglAddressReview::new()
-            .glyph(&FERRIS)
-            .verify_str("Verify CRAB address")
-            .show(&addr_hex))
-    }
+    const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_64x64.gif", NBGL));
+    #[cfg(any(target_os = "nanosplus", target_os = "nanox"))]
+    const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_16x16.gif", NBGL));
+
+    // Display the address confirmation screen.
+    Ok(NbglAddressReview::new()
+        .glyph(&FERRIS)
+        .verify_str("Verify CRAB address")
+        .show(&addr_hex))
 }

crab.gif renamed to crab_16x16.gif

@@ -18,64 +18,15 @@
 use include_gif::include_gif;
 use ledger_device_sdk::io::Comm;
 
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::ui::{
-    bitmaps::{Glyph, BACK, CERTIFICATE, DASHBOARD_X},
-    gadgets::{EventOrPageIndex, MultiPageMenu, Page},
-};
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use crate::settings::Settings;
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use ledger_device_sdk::nbgl::{NbglGlyph, NbglHomeAndSettings};
 
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use crate::Instruction;
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::io::Event;
-
-// use ledger_device_sdk::nvm::*;
-
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-fn ui_about_menu(comm: &mut Comm) -> Event<Instruction> {
-    let pages = [
-        &Page::from((["Rust Boilerplate", "(c) 2023 Ledger"], true)),
-        &Page::from(("Back", &BACK)),
-    ];
-    loop {
-        match MultiPageMenu::new(comm, &pages).show() {
-            EventOrPageIndex::Event(e) => return e,
-            EventOrPageIndex::Index(1) => return ui_menu_main(comm),
-            EventOrPageIndex::Index(_) => (),
-        }
-    }
-}
-
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-pub fn ui_menu_main(comm: &mut Comm) -> Event<Instruction> {
-    const APP_ICON: Glyph = Glyph::from_include(include_gif!("crab.gif"));
-    let pages = [
-        // The from trait allows to create different styles of pages
-        // without having to use the new() function.
-        &Page::from((["Boilerplate", "is ready"], &APP_ICON)),
-        &Page::from((["Version", env!("CARGO_PKG_VERSION")], true)),
-        &Page::from(("About", &CERTIFICATE)),
-        &Page::from(("Quit", &DASHBOARD_X)),
-    ];
-    loop {
-        match MultiPageMenu::new(comm, &pages).show() {
-            EventOrPageIndex::Event(e) => return e,
-            EventOrPageIndex::Index(2) => return ui_about_menu(comm),
-            EventOrPageIndex::Index(3) => ledger_device_sdk::exit_app(0),
-            EventOrPageIndex::Index(_) => (),
-        }
-    }
-}
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 pub fn ui_menu_main(_: &mut Comm) -> NbglHomeAndSettings {
     // Load glyph from 64x64 4bpp gif file with include_gif macro. Creates an NBGL compatible glyph.
+    #[cfg(any(target_os = "stax", target_os = "flex"))]
     const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_64x64.gif", NBGL));
+    #[cfg(any(target_os = "nanosplus", target_os = "nanox"))]
+    const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_16x16.gif", NBGL));
 
     let settings_strings = [["Display Memo", "Allow display of transaction memo."]];
     let mut settings: Settings = Default::default();

src/app_ui/address.rs

@@ -17,17 +17,8 @@
 use crate::handlers::sign_tx::Tx;
 use crate::AppSW;
 
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::ui::{
-    bitmaps::{CROSSMARK, EYE, VALIDATE_14},
-    gadgets::{Field, MultiFieldReview},
-};
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use crate::settings::Settings;
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use include_gif::include_gif;
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use ledger_device_sdk::nbgl::{Field, NbglGlyph, NbglReview};
 
 use alloc::format;
@@ -60,41 +51,28 @@ pub fn ui_display_tx(tx: &Tx) -> Result<bool, AppSW> {
     ];
 
     // Create transaction review
-    #[cfg(not(any(target_os = "stax", target_os = "flex")))]
-    {
-        let my_review = MultiFieldReview::new(
-            &my_fields,
-            &["Review ", "Transaction"],
-            Some(&EYE),
-            "Approve",
-            Some(&VALIDATE_14),
-            "Reject",
-            Some(&CROSSMARK),
-        );
-
-        Ok(my_review.show())
-    }
 
+    // Load glyph from 64x64 4bpp gif file with include_gif macro. Creates an NBGL compatible glyph.
     #[cfg(any(target_os = "stax", target_os = "flex"))]
-    {
-        // Load glyph from 64x64 4bpp gif file with include_gif macro. Creates an NBGL compatible glyph.
-        const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_64x64.gif", NBGL));
-        // Create NBGL review. Maximum number of fields and string buffer length can be customised
-        // with constant generic parameters of NbglReview. Default values are 32 and 1024 respectively.
-        let review: NbglReview = NbglReview::new()
-            .titles(
-                "Review transaction\nto send CRAB",
-                "",
-                "Sign transaction\nto send CRAB",
-            )
-            .glyph(&FERRIS);
+    const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_64x64.gif", NBGL));
+    #[cfg(any(target_os = "nanosplus", target_os = "nanox"))]
+    const FERRIS: NbglGlyph = NbglGlyph::from_include(include_gif!("crab_16x16.gif", NBGL));
+
+    // Create NBGL review. Maximum number of fields and string buffer length can be customised
+    // with constant generic parameters of NbglReview. Default values are 32 and 1024 respectively.
+    let review: NbglReview = NbglReview::new()
+        .titles(
+            "Review transaction\nto send CRAB",
+            "",
+            "Sign transaction\nto send CRAB",
+        )
+        .glyph(&FERRIS);
 
-        // If first setting switch is disabled do not display the transaction memo
-        let settings: Settings = Default::default();
-        if settings.get_element(0) == 0 {
-            Ok(review.show(&my_fields[0..2]))
-        } else {
-            Ok(review.show(&my_fields))
-        }
+    // If first setting switch is disabled do not display the transaction memo
+    let settings: Settings = Default::default();
+    if settings.get_element(0) == 0 {
+        Ok(review.show(&my_fields[0..2]))
+    } else {
+        Ok(review.show(&my_fields))
     }
 }

src/app_ui/menu.rs

@@ -21,8 +21,6 @@ use alloc::vec::Vec;
 use ledger_device_sdk::ecc::{Secp256k1, SeedDerive};
 use ledger_device_sdk::hash::{sha3::Keccak256, HashInit};
 use ledger_device_sdk::io::Comm;
-
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use ledger_device_sdk::nbgl::NbglHomeAndSettings;
 
 use serde::Deserialize;
@@ -45,7 +43,6 @@ pub struct TxContext {
     raw_tx: Vec<u8>,
     path: Bip32Path,
     review_finished: bool,
-    #[cfg(any(target_os = "stax", target_os = "flex"))]
     pub home: NbglHomeAndSettings,
 }
 
@@ -57,7 +54,6 @@ impl TxContext {
             raw_tx: Vec::new(),
             path: Default::default(),
             review_finished: false,
-            #[cfg(any(target_os = "stax", target_os = "flex"))]
             home: Default::default(),
         }
     }

src/app_ui/sign.rs

@@ -39,19 +39,12 @@ use handlers::{
     sign_tx::{handler_sign_tx, TxContext},
 };
 use ledger_device_sdk::io::{ApduHeader, Comm, Reply, StatusWords};
-#[cfg(feature = "pending_review_screen")]
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::ui::gadgets::display_pending_review;
-
-#[cfg(not(any(target_os = "stax", target_os = "flex")))]
-use ledger_device_sdk::io::Event;
 
 ledger_device_sdk::set_panic!(ledger_device_sdk::exiting_panic);
 
 // Required for using String, Vec, format!...
 extern crate alloc;
 
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 use ledger_device_sdk::nbgl::{init_comm, NbglReviewStatus, StatusType};
 
 // P2 for last APDU to receive.
@@ -131,7 +124,6 @@ impl TryFrom<ApduHeader> for Instruction {
     }
 }
 
-#[cfg(any(target_os = "stax", target_os = "flex"))]
 fn show_status_and_home_if_needed(ins: &Instruction, tx_ctx: &mut TxContext, status: &AppSW) {
     let (show_status, status_type) = match (ins, status) {
         (Instruction::GetPubkey { display: true }, AppSW::Deny | AppSW::Ok) => {
@@ -163,30 +155,15 @@ extern "C" fn sample_main() {
 
     let mut tx_ctx = TxContext::new();
 
-    #[cfg(any(target_os = "stax", target_os = "flex"))]
-    {
-        // Initialize reference to Comm instance for NBGL
-        // API calls.
-        init_comm(&mut comm);
-        tx_ctx.home = ui_menu_main(&mut comm);
-        tx_ctx.home.show_and_return();
-    }
-
-    #[cfg(not(any(target_os = "stax", target_os = "flex")))]
-    #[cfg(feature = "pending_review_screen")]
-    display_pending_review(&mut comm);
+    // Initialize reference to Comm instance for NBGL
+    // API calls.
+    init_comm(&mut comm);
+    tx_ctx.home = ui_menu_main(&mut comm);
+    tx_ctx.home.show_and_return();
 
     loop {
-        #[cfg(any(target_os = "stax", target_os = "flex"))]
         let ins: Instruction = comm.next_command();
 
-        #[cfg(not(any(target_os = "stax", target_os = "flex")))]
-        let ins = if let Event::Command(ins) = ui_menu_main(&mut comm) {
-            ins
-        } else {
-            continue;
-        };
-
         let _status = match handle_apdu(&mut comm, &ins, &mut tx_ctx) {
             Ok(()) => {
                 comm.reply_ok();
@@ -197,7 +174,6 @@ extern "C" fn sample_main() {
                 sw
             }
         };
-        #[cfg(any(target_os = "stax", target_os = "flex"))]
         show_status_and_home_if_needed(&ins, &mut tx_ctx, &_status);
     }
 }

src/handlers/sign_tx.rs

@@ -20,12 +20,12 @@
 # 2. This fixture clears the pending review screen before each test
 # 3. The scope should be the same as the one configured by BACKEND_SCOPE in 
 # ragger/conftest/configuration.py
-@pytest.fixture(scope="class", autouse=True)
-def clear_pending_review(firmware, navigator):
-    # Press a button to clear the pending review
-    if firmware.device.startswith("nano"):
-        print("Clearing pending review")
-        instructions = [
-            NavInsID.BOTH_CLICK,
-        ]
-        navigator.navigate(instructions,screen_change_before_first_instruction=False)
+# @pytest.fixture(scope="class", autouse=True)
+# def clear_pending_review(firmware, navigator):
+#     # Press a button to clear the pending review
+#     if firmware.device.startswith("nano"):
+#         print("Clearing pending review")
+#         instructions = [
+#             NavInsID.BOTH_CLICK,
+#         ]
+#         navigator.navigate(instructions,screen_change_before_first_instruction=False)