Merge pull request #67 from LedgerHQ/update-status-display-for-nbgl-devices

Implement status screens for Stax/Flex now that they are not managed …

Author: agrojean-ledger

Cargo.lock

@@ -5,7 +5,7 @@ authors = ["yhql", "agrojean-ledger"]
 edition = "2021"
 
 [dependencies]
-ledger_device_sdk = { version="1.13.1" }
+ledger_device_sdk = { version="1.14.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"}

Cargo.toml

@@ -41,20 +41,29 @@ pub struct Tx<'a> {
 pub struct TxContext {
     raw_tx: Vec<u8>,
     path: Bip32Path,
+    review_finished: bool,
 }
 
 // Implement constructor for TxInfo with default values
 impl TxContext {
+    // Constructor
     pub fn new() -> TxContext {
         TxContext {
             raw_tx: Vec::new(),
             path: Default::default(),
+            review_finished: false,
         }
     }
+    // Get review status
+    #[allow(dead_code)]
+    pub fn finished(&self) -> bool {
+        self.review_finished
+    }
     // Implement reset for TxInfo
     fn reset(&mut self) {
         self.raw_tx.clear();
         self.path = Default::default();
+        self.review_finished = false;
     }
 }
 
@@ -85,6 +94,7 @@ pub fn handler_sign_tx(
 
         // If we expect more chunks, return
         if more {
+            ctx.review_finished = false;
             Ok(())
         // Otherwise, try to parse the transaction
         } else {
@@ -94,8 +104,10 @@ pub fn handler_sign_tx(
             // the transaction, sign it. Otherwise,
             // return a "deny" status word.
             if ui_display_tx(&tx)? {
+                ctx.review_finished = true;
                 compute_signature_and_append(comm, ctx)
             } else {
+                ctx.review_finished = true;
                 Err(AppSW::Deny)
             }
         }

src/handlers/sign_tx.rs

@@ -49,7 +49,7 @@ ledger_device_sdk::set_panic!(ledger_device_sdk::exiting_panic);
 extern crate alloc;
 
 #[cfg(any(target_os = "stax", target_os = "flex"))]
-use ledger_device_sdk::nbgl::init_comm;
+use ledger_device_sdk::nbgl::{init_comm, NbglReviewStatus, StatusType};
 
 // P2 for last APDU to receive.
 const P2_SIGN_TX_LAST: u8 = 0x00;
@@ -62,6 +62,7 @@ const P1_SIGN_TX_MAX: u8 = 0x03;
 
 // Application status words.
 #[repr(u16)]
+#[derive(Clone, Copy, PartialEq)]
 pub enum AppSW {
     Deny = 0x6985,
     WrongP1P2 = 0x6A86,
@@ -76,6 +77,7 @@ pub enum AppSW {
     KeyDeriveFail = 0xB009,
     VersionParsingFail = 0xB00A,
     WrongApduLength = StatusWords::BadLen as u16,
+    Ok = 0x9000,
 }
 
 impl From<AppSW> for Reply {
@@ -126,6 +128,26 @@ impl TryFrom<ApduHeader> for Instruction {
     }
 }
 
+#[cfg(any(target_os = "stax", target_os = "flex"))]
+fn show_status_if_needed(ins: &Instruction, tx_ctx: &TxContext, status: &AppSW) {
+    let (show_status, status_type) = match (ins, status) {
+        (Instruction::GetPubkey { display: true }, AppSW::Deny | AppSW::Ok) => {
+            (true, StatusType::Address)
+        }
+        (Instruction::SignTx { .. }, AppSW::Deny | AppSW::Ok) if tx_ctx.finished() => {
+            (true, StatusType::Transaction)
+        }
+        (_, _) => (false, StatusType::Transaction),
+    };
+
+    if show_status {
+        let success = *status == AppSW::Ok;
+        NbglReviewStatus::new()
+            .status_type(status_type)
+            .show(success);
+    }
+}
+
 #[no_mangle]
 extern "C" fn sample_main() {
     // Create the communication manager, and configure it to accept only APDU from the 0xe0 class.
@@ -150,22 +172,32 @@ extern "C" fn sample_main() {
         // Wait for either a specific button push to exit the app
         // or an APDU command
         if let Event::Command(ins) = ui_menu_main(&mut comm) {
-            match handle_apdu(&mut comm, ins, &mut tx_ctx) {
-                Ok(()) => comm.reply_ok(),
-                Err(sw) => comm.reply(sw),
-            }
+            let result = handle_apdu(&mut comm, &ins, &mut tx_ctx);
+            let _status: AppSW = match result {
+                Ok(()) => {
+                    comm.reply_ok();
+                    AppSW::Ok
+                }
+                Err(sw) => {
+                    comm.reply(sw);
+                    sw
+                }
+            };
+
+            #[cfg(any(target_os = "stax", target_os = "flex"))]
+            show_status_if_needed(&ins, &tx_ctx, &_status);
         }
     }
 }
 
-fn handle_apdu(comm: &mut Comm, ins: Instruction, ctx: &mut TxContext) -> Result<(), AppSW> {
+fn handle_apdu(comm: &mut Comm, ins: &Instruction, ctx: &mut TxContext) -> Result<(), AppSW> {
     match ins {
         Instruction::GetAppName => {
             comm.append(env!("CARGO_PKG_NAME").as_bytes());
             Ok(())
         }
         Instruction::GetVersion => handler_get_version(comm),
-        Instruction::GetPubkey { display } => handler_get_public_key(comm, display),
-        Instruction::SignTx { chunk, more } => handler_sign_tx(comm, chunk, more, ctx),
+        Instruction::GetPubkey { display } => handler_get_public_key(comm, *display),
+        Instruction::SignTx { chunk, more } => handler_sign_tx(comm, *chunk, *more, ctx),
     }
 }