workflows: add menu and trinary_choice to the Workflows trait

benma · benma · commit 5b75afd6c0c1 · 2025-04-21T12:33:33.000+02:00
diff --git a/src/rust/bitbox02-rust/src/hww/api/bip85.rs b/src/rust/bitbox02-rust/src/hww/api/bip85.rs
@@ -46,8 +46,8 @@ pub async fn process<W: Workflows>(
 /// Derives and displays a BIP-39 seed according to BIP-85:
 /// https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki#bip39.
 async fn process_bip39<W: Workflows>(workflows: &mut W) -> Result<(), Error> {
-    use crate::workflow::trinary_choice::{choose, TrinaryChoice};
-    use crate::workflow::{menu, mnemonic, trinary_input_string};
+    use crate::workflow::trinary_choice::TrinaryChoice;
+    use crate::workflow::{mnemonic, trinary_input_string};
 
     workflows
         .confirm(&confirm::Params {
@@ -68,7 +68,10 @@ async fn process_bip39<W: Workflows>(workflows: &mut W) -> Result<(), Error> {
         })
         .await?;
 
-    let num_words: u32 = match choose("How many words?", "12", "18", "24").await {
+    let num_words: u32 = match workflows
+        .trinary_choice("How many words?", "12", "18", "24")
+        .await
+    {
         TrinaryChoice::TRINARY_CHOICE_LEFT => 12,
         TrinaryChoice::TRINARY_CHOICE_MIDDLE => 18,
         TrinaryChoice::TRINARY_CHOICE_RIGHT => 24,
@@ -79,32 +82,34 @@ async fn process_bip39<W: Workflows>(workflows: &mut W) -> Result<(), Error> {
         .await;
 
     // Pick index. The first few are quick-access. "More" leads to a full number input keyboard.
-    let index: u32 =
-        match menu::pick(&["0", "1", "2", "3", "4", "More"], Some("Select index")).await? {
-            i @ 0..=4 => i.into(),
-            5 => {
-                let number_string = workflows
-                    .enter_string(
-                        &trinary_input_string::Params {
-                            title: "Enter index",
-                            number_input: true,
-                            longtouch: true,
-                            ..Default::default()
-                        },
-                        trinary_input_string::CanCancel::Yes,
-                        "",
-                    )
-                    .await?;
-                match number_string.as_str().parse::<u32>() {
-                    Ok(i) if i < util::bip32::HARDENED => i,
-                    _ => {
-                        workflows.status("Invalid index", false).await;
-                        return Err(Error::InvalidInput);
-                    }
+    let index: u32 = match workflows
+        .menu(&["0", "1", "2", "3", "4", "More"], Some("Select index"))
+        .await?
+    {
+        i @ 0..=4 => i.into(),
+        5 => {
+            let number_string = workflows
+                .enter_string(
+                    &trinary_input_string::Params {
+                        title: "Enter index",
+                        number_input: true,
+                        longtouch: true,
+                        ..Default::default()
+                    },
+                    trinary_input_string::CanCancel::Yes,
+                    "",
+                )
+                .await?;
+            match number_string.as_str().parse::<u32>() {
+                Ok(i) if i < util::bip32::HARDENED => i,
+                _ => {
+                    workflows.status("Invalid index", false).await;
+                    return Err(Error::InvalidInput);
                 }
             }
-            6.. => panic!("bip85 error"),
-        };
+        }
+        6.. => panic!("bip85 error"),
+    };
 
     workflows.status(&format!("Index: {}", index), true).await;
 
diff --git a/src/rust/bitbox02-rust/src/workflow.rs b/src/rust/bitbox02-rust/src/workflow.rs
@@ -58,6 +58,16 @@ pub trait Workflows {
     ) -> Result<zeroize::Zeroizing<String>, trinary_input_string::Error>;
 
     async fn insert_sdcard(&mut self) -> Result<(), sdcard::UserAbort>;
+
+    async fn menu(&mut self, words: &[&str], title: Option<&str>) -> Result<u8, menu::CancelError>;
+
+    async fn trinary_choice(
+        &mut self,
+        message: &str,
+        label_left: &str,
+        label_middle: &str,
+        label_right: &str,
+    ) -> trinary_choice::TrinaryChoice;
 }
 
 pub struct RealWorkflows;
@@ -106,4 +116,20 @@ impl Workflows for RealWorkflows {
     async fn insert_sdcard(&mut self) -> Result<(), sdcard::UserAbort> {
         sdcard::sdcard().await
     }
+
+    #[inline(always)]
+    async fn menu(&mut self, words: &[&str], title: Option<&str>) -> Result<u8, menu::CancelError> {
+        menu::pick(words, title).await
+    }
+
+    #[inline(always)]
+    async fn trinary_choice(
+        &mut self,
+        message: &str,
+        label_left: &str,
+        label_middle: &str,
+        label_right: &str,
+    ) -> trinary_choice::TrinaryChoice {
+        trinary_choice::choose(message, label_left, label_middle, label_right).await
+    }
 }
diff --git a/src/rust/bitbox02-rust/src/workflow/mnemonic.rs b/src/rust/bitbox02-rust/src/workflow/mnemonic.rs
@@ -16,7 +16,7 @@ pub use super::cancel::Error as CancelError;
 use super::cancel::{cancel, set_result, with_cancel};
 use super::confirm;
 use super::menu;
-use super::trinary_choice::{choose, TrinaryChoice};
+use super::trinary_choice::TrinaryChoice;
 use super::trinary_input_string;
 use super::Workflows;
 
@@ -224,8 +224,8 @@ async fn get_24th_word<W: Workflows>(
         choices.len() - 1
     };
     loop {
-        match super::menu::pick(&as_str_vec(&choices), Some(title)).await {
-            Err(super::menu::CancelError::Cancelled) => return Err(CancelError::Cancelled),
+        match workflows.menu(&as_str_vec(&choices), Some(title)).await {
+            Err(menu::CancelError::Cancelled) => return Err(CancelError::Cancelled),
             Ok(choice_idx) if choice_idx as usize == none_of_them_idx => {
                 let params = confirm::Params {
                     title: "",
@@ -301,7 +301,10 @@ async fn get_12th_18th_word<W: Workflows>(
 pub async fn get<W: Workflows>(
     workflows: &mut W,
 ) -> Result<zeroize::Zeroizing<String>, CancelError> {
-    let num_words: usize = match choose("How many words?", "12", "18", "24").await {
+    let num_words: usize = match workflows
+        .trinary_choice("How many words?", "12", "18", "24")
+        .await
+    {
         TrinaryChoice::TRINARY_CHOICE_LEFT => 12,
         TrinaryChoice::TRINARY_CHOICE_MIDDLE => 18,
         TrinaryChoice::TRINARY_CHOICE_RIGHT => 24,
@@ -378,7 +381,8 @@ pub async fn get<W: Workflows>(
                 } else {
                     // In all other words, we give the choice between editing the previous word and
                     // cancelling.
-                    match menu::pick(&["Edit previous word", "Cancel restore"], Some("Choose"))
+                    match workflows
+                        .menu(&["Edit previous word", "Cancel restore"], Some("Choose"))
                         .await
                     {
                         Err(menu::CancelError::Cancelled) => {
diff --git a/src/rust/bitbox02-rust/src/workflow/testing.rs b/src/rust/bitbox02-rust/src/workflow/testing.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use super::{confirm, sdcard, transaction, trinary_input_string, Workflows};
+use super::{confirm, menu, sdcard, transaction, trinary_choice, trinary_input_string, Workflows};
 
 use alloc::boxed::Box;
 use alloc::string::String;
@@ -137,6 +137,24 @@ impl Workflows for TestingWorkflows<'_> {
     async fn insert_sdcard(&mut self) -> Result<(), sdcard::UserAbort> {
         Ok(())
     }
+
+    async fn menu(
+        &mut self,
+        _words: &[&str],
+        _title: Option<&str>,
+    ) -> Result<u8, menu::CancelError> {
+        todo!("not used in unit tests yet");
+    }
+
+    async fn trinary_choice(
+        &mut self,
+        _message: &str,
+        _label_left: &str,
+        _label_middle: &str,
+        _label_right: &str,
+    ) -> trinary_choice::TrinaryChoice {
+        todo!("not used in unit tests yet");
+    }
 }
 
 impl<'a> TestingWorkflows<'a> {
