Add support for ledger nanos

Lbqds · Lbqds · commit 21ccfdbeabb4 · 2024-10-16T18:15:42.000+08:00
diff --git a/.github/workflows/build_and_function_tests.yml b/.github/workflows/build_and_function_tests.yml
@@ -31,6 +31,7 @@ jobs:
           node-version: 16
       - run: make release
       - run: make set-github-action
+      - run: make run-github-ci device=nanos path=nanos
       - run: make run-github-ci device=nanosp path=nanosplus
       - run: make run-github-ci device=nanox path=nanox
       - run: make run-github-ci device=stax path=stax
diff --git a/Makefile b/Makefile
@@ -3,6 +3,7 @@ ledger_app_builder = ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:$(ve
 ledger_app_dev_tools = ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:$(version)
 
 release:
+	@make _release device=nanos
 	@make _release device=nanox
 	@make _release device=nanosplus
 	@make _release device=stax
@@ -26,7 +27,7 @@ check:
 			echo 'Cargo fmt' && \
 			cargo fmt --all -- --check && \
 			echo 'Cargo clippy' && \
-			cargo +nightly-2023-11-10 clippy --target=nanox && \
+			cargo +nightly-2023-11-10 clippy --target=nanos && \
 			cargo +nightly-2023-11-10 clippy --target=stax && \
 			cargo install cargo-audit && cargo audit && \
 			cargo install --locked cargo-deny && cargo +nightly-2023-11-10 deny check \
@@ -38,7 +39,10 @@ _run-speculos:
 		speculos -m $(device) /app/app/target/$(path)/release/alephium
 
 run-speculos:
-	@make run-speculos-nanosplus
+	@make run-speculos-nanos
+
+run-speculos-nanos:
+	@make _run-speculos device=nanos path=nanos
 
 run-speculos-nanosplus:
 	@make _run-speculos device=nanosp path=nanosplus
@@ -69,5 +73,8 @@ run-github-ci:
 
 .PHONY: release clean
 
+install_nanos:
+	ledgerctl install -f nanos.json
+
 install_nanosplus:
 	ledgerctl install -f nanosplus.json
diff --git a/app/Cargo.toml b/app/Cargo.toml
@@ -29,6 +29,9 @@ curve = ["secp256k1"]
 flags = "0"
 path = ["44'/1234'"]
 
+[package.metadata.ledger.nanos]
+icon = "alph_16x16.gif"
+
 [package.metadata.ledger.nanox]
 icon = "alph_14x14.gif"
 
diff --git a/app/alph_16x16.gif b/app/alph_16x16.gif
diff --git a/app/src/nvm/mod.rs b/app/src/nvm/mod.rs
@@ -1,8 +1,13 @@
+#[cfg(target_os = "nanos")]
+use crate::nvm::nvm_data::NVMData;
+#[cfg(not(target_os = "nanos"))]
 use ledger_device_sdk::NVMData;
 use ledger_secure_sdk_sys::nvm_write;
 
 use crate::error_code::ErrorCode;
 
+#[cfg(target_os = "nanos")]
+pub mod nvm_data;
 pub mod swapping_buffer;
 
 pub const NVM_DATA_SIZE: usize = 2048;
diff --git a/app/src/nvm/nvm_data.rs b/app/src/nvm/nvm_data.rs
@@ -0,0 +1,17 @@
+pub struct NVMData<T> {
+    data: T,
+}
+
+impl<T> NVMData<T> {
+    pub const fn new(data: T) -> NVMData<T> {
+        NVMData { data }
+    }
+
+    pub fn get_mut(&mut self) -> &mut T {
+        ledger_secure_sdk_sys::pic_rs_mut(&mut self.data)
+    }
+
+    pub fn get_ref(&self) -> &T {
+        ledger_secure_sdk_sys::pic_rs(&self.data)
+    }
+}
diff --git a/app/src/nvm/swapping_buffer.rs b/app/src/nvm/swapping_buffer.rs
@@ -1,10 +1,13 @@
 // This code is inspired by code from zondax: https://github.com/Zondax/ledger-rust/blob/main/bolos/src/swapping_buffer.rs
 use utils::buffer::Writable;
 
+#[cfg(target_os = "nanos")]
+use crate::nvm::nvm_data::NVMData;
 use crate::{
     error_code::ErrorCode,
     nvm::{write_from, NVM},
 };
+#[cfg(not(target_os = "nanos"))]
 use ledger_device_sdk::NVMData;
 
 pub const RAM_SIZE: usize = 512;
diff --git a/app/src/sign_tx_context.rs b/app/src/sign_tx_context.rs
@@ -1,4 +1,7 @@
+#[cfg(target_os = "nanos")]
+use crate::nvm::nvm_data::NVMData;
 use ledger_device_sdk::io::ApduHeader;
+#[cfg(not(target_os = "nanos"))]
 use ledger_device_sdk::NVMData;
 use utils::{
     buffer::Buffer, decode::StreamingDecoder, deserialize_path, types::UnsignedTx, PATH_LENGTH,
diff --git a/app/src/ui/bagl/home.rs b/app/src/ui/bagl/home.rs
@@ -15,7 +15,7 @@ const UI_PAGE_NUM: u8 = 4;
 
 fn show_ui_welcome() {
     const APP_ICON: Glyph = Glyph::from_include(include_gif!("alph_14x14.gif"));
-    gadgets::Page::from((["Alephium", "is ready"], &APP_ICON)).place();
+    gadgets::Page::from((["Alephium ", "is ready"], &APP_ICON)).place();
 }
 
 fn show_ui_blind_signing() {
diff --git a/app/src/ui/bagl/mod.rs b/app/src/ui/bagl/mod.rs
@@ -10,7 +10,7 @@ pub fn sign_hash_ui(path: &[u32], message: &[u8]) -> Result<([u8; 72], u32, u32)
     let hex: [u8; 64] = utils::to_hex(message).ok_or(ErrorCode::BadLen)?;
     let hex_str = from_utf8(&hex).map_err(|_| ErrorCode::InternalError)?;
 
-    let review_messages = ["Review", "Hash"];
+    let review_messages = ["Review ", "Hash "];
     let fields = [Field {
         name: "Hash",
         value: hex_str,
@@ -32,7 +32,7 @@ pub fn sign_hash_ui(path: &[u32], message: &[u8]) -> Result<([u8; 72], u32, u32)
 }
 
 pub fn review_address(address: &str) -> Result<(), ErrorCode> {
-    let review_messages = ["Review", "Address"];
+    let review_messages = ["Review ", "Address "];
     let fields = [Field {
         name: "Address",
         value: address,
diff --git a/app/src/ui/bagl/tx_reviewer_inner.rs b/app/src/ui/bagl/tx_reviewer_inner.rs
@@ -9,7 +9,7 @@ use ledger_device_sdk::{
 
 // Different Ledger devices use different UI libraries, so we've introduced the
 // `TxReviewInner` to facilitate the display of tx details across different devices.
-// The `TxReviewInner` here is for Ledger Nanosp/Nanox.
+// The `TxReviewInner` here is for Ledger Nanos/Nanosp/Nanox.
 pub struct TxReviewerInner {
     is_tx_execute_script: bool,
 }
@@ -32,7 +32,7 @@ impl TxReviewerInner {
         fields: &'a [Field<'a>],
         review_message: &str,
     ) -> Result<(), ErrorCode> {
-        let review_messages = ["Review", review_message];
+        let review_messages = ["Review ", review_message];
         let review = MultiFieldReview::new(
             fields,
             &review_messages,
@@ -55,13 +55,13 @@ impl TxReviewerInner {
         if self.is_tx_execute_script {
             self.finish_review_inner(fields, &["Blind Signing"], Some(&WARNING))
         } else {
-            self.finish_review_inner(fields, &["Confirm", "Self-transfer"], Some(&EYE))
+            self.finish_review_inner(fields, &["Confirm ", "Self-transfer"], Some(&EYE))
         }
     }
 
     // Review the warning for external inputs, i.e. inputs that are not from the device address
     pub fn warning_external_inputs(&self) -> Result<(), ErrorCode> {
-        let review_messages = ["There are", "external inputs"];
+        let review_messages = ["There are ", "external inputs"];
         let review = MultiFieldReview::new(
             &[],
             &review_messages,
@@ -88,6 +88,10 @@ impl TxReviewerInner {
         review_message: &'a [&'a str],
         review_glyph: Option<&'a Glyph<'a>>,
     ) -> Result<(), ErrorCode> {
+        #[cfg(target_os = "nanos")]
+        let validation_messages = ["Accept and sign", ""];
+
+        #[cfg(not(target_os = "nanos"))]
         let validation_messages = if !self.is_tx_execute_script {
             ["Accept", "and sign"]
         } else {
diff --git a/app/src/ui/tx_reviewer.rs b/app/src/ui/tx_reviewer.rs
@@ -1,4 +1,6 @@
 use super::TxReviewerInner;
+#[cfg(target_os = "nanos")]
+use crate::nvm::nvm_data::NVMData;
 use crate::{
     blake2b_hasher::Blake2bHasher,
     error_code::ErrorCode,
@@ -13,6 +15,7 @@ use crate::{
 use ledger_device_sdk::nbgl::Field;
 #[cfg(not(any(target_os = "stax", target_os = "flex")))]
 use ledger_device_sdk::ui::gadgets::Field;
+#[cfg(not(target_os = "nanos"))]
 use ledger_device_sdk::NVMData;
 use utils::{
     base58::ALPHABET,
diff --git a/js/test/utils.ts b/js/test/utils.ts
@@ -21,17 +21,29 @@ async function clickAndApprove(times: number) {
 
 function getModel(): string {
   const model = process.env.MODEL
-  return model ? model as string : 'nanosp'
+  return model ? model as string : 'nanos'
 }
 
 export enum OutputType {
   Base,
   Multisig,
+  Nanos10,
+  Nanos11,
   Token,
   BaseAndToken,
   MultisigAndToken
 }
 
+const NanosClickTable = new Map([
+  [OutputType.Base, 5],
+  [OutputType.Multisig, 10],
+  [OutputType.Nanos10, 10],
+  [OutputType.Nanos11, 11],
+  [OutputType.Token, 11],
+  [OutputType.BaseAndToken, 12],
+  [OutputType.MultisigAndToken, 16],
+])
+
 const NanospClickTable = new Map([
   [OutputType.Base, 3],
   [OutputType.Multisig, 5],
@@ -59,6 +71,7 @@ const FlexClickTable = new Map([
 function getOutputClickSize(outputType: OutputType) {
   const model = getModel()
   switch (model) {
+    case 'nanos': return NanosClickTable.get(outputType)!
     case 'nanosp':
     case 'nanox': return NanospClickTable.get(outputType)!
     case 'stax': return StaxClickTable.get(outputType)!
@@ -178,7 +191,11 @@ export async function approveHash() {
   if (isStaxOrFlex()) {
     return await _touch(2, true)
   }
-  await clickAndApprove(3)
+  if (getModel() === 'nanos') {
+    await clickAndApprove(5)
+  } else {
+    await clickAndApprove(3)
+  }
 }
 
 export async function approveAddress() {
@@ -188,13 +205,21 @@ export async function approveAddress() {
     await staxFlexApproveOnce()
     return
   }
-  await clickAndApprove(2)
+  if (getModel() === 'nanos') {
+    await clickAndApprove(4)
+  } else {
+    await clickAndApprove(2)
+  }
 }
 
 export function isStaxOrFlex(): boolean {
   return !getModel().startsWith('nano')
 }
 
+export function isNanos(): boolean {
+  return getModel() === 'nanos'
+}
+
 export async function skipBlindSigningWarning() {
   if (!needToAutoApprove()) return
   if (isStaxOrFlex()) {
diff --git a/js/test/wallet.test.ts b/js/test/wallet.test.ts
@@ -3,7 +3,7 @@ import { ALPH_TOKEN_ID, Address, DUST_AMOUNT, NodeProvider, ONE_ALPH, binToHex,
 import { getSigner, mintToken, transfer } from '@alephium/web3-test'
 import { PrivateKeyWallet } from '@alephium/web3-wallet'
 import blake from 'blakejs'
-import { approveAddress, approveHash, approveTx, createTransport, enableBlindSigning, getRandomInt, isStaxOrFlex, needToAutoApprove, OutputType, skipBlindSigningWarning, staxFlexAcceptRisk, staxFlexApproveOnce } from './utils'
+import { approveAddress, approveHash, approveTx, createTransport, enableBlindSigning, getRandomInt, isNanos, isStaxOrFlex, needToAutoApprove, OutputType, skipBlindSigningWarning, staxFlexAcceptRisk, staxFlexApproveOnce } from './utils'
 import { TokenMetadata } from '../src/types'
 import { randomBytes } from 'crypto'
 import { merkleTokens, tokenMerkleProofs } from '../src/merkle'
@@ -309,7 +309,11 @@ describe('ledger wallet', () => {
     }
     const encodedUnsignedTx = codec.unsignedTxCodec.encodeApiUnsignedTx(unsignedTx)
 
-    approveTx(Array(5).fill(OutputType.BaseAndToken))
+    if (isNanos()) {
+      approveTx([OutputType.Nanos11, OutputType.Nanos10, OutputType.Nanos10, OutputType.Nanos10, OutputType.Nanos11])
+    } else {
+      approveTx(Array(5).fill(OutputType.BaseAndToken))
+    }
     const signature = await app.signUnsignedTx(path, Buffer.from(encodedUnsignedTx))
     const txId = blake.blake2b(encodedUnsignedTx, undefined, 32)
     expect(transactionVerifySignature(binToHex(txId), testAccount.publicKey, signature)).toBe(true)
diff --git a/ledger_app.toml b/ledger_app.toml
@@ -1,4 +1,4 @@
 [app]
 build_directory = "./app"
 sdk = "Rust"
-devices = ["nanox", "nanos+", "stax", "flex"]
+devices = ["nanos", "nanox", "nanos+", "stax", "flex"]

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ const UI_PAGE_NUM: u8 = 4;`
`15`	`15`
`16`	`16`	`fn show_ui_welcome() {`
`17`	`17`	`const APP_ICON: Glyph = Glyph::from_include(include_gif!("alph_14x14.gif"));`
`18`		`- gadgets::Page::from((["Alephium", "is ready"], &APP_ICON)).place();`
	`18`	`+ gadgets::Page::from((["Alephium ", "is ready"], &APP_ICON)).place();`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`fn show_ui_blind_signing() {`