Merge pull request #204 from Zondax/review_with_intent

Adds review with intent functionality

Author: chcmedeiros

app/ui/view.c

@@ -78,6 +78,11 @@ void view_review_show(review_type_e reviewKind) {
     view_review_show_impl((unsigned int)reviewKind, NULL, NULL);
 }
 
+void view_review_show_with_intent(review_type_e reviewKind, const char *intent) {
+    // New function that explicitly handles intent
+    view_review_show_with_intent_impl((unsigned int)reviewKind, intent);
+}
+
 void view_review_show_generic(review_type_e reviewKind, const char *title, const char *validate) {
     view_review_show_impl((unsigned int)reviewKind, title, validate);
 }

app/ui/view.h

@@ -128,6 +128,8 @@ void view_inspect_init(viewfunc_getInnerItem_t view_funcGetInnerItem, viewfunc_g
 
 void view_review_show(review_type_e reviewKind);
 
+void view_review_show_with_intent(review_type_e reviewKind, const char *intent);
+
 void view_spinner_show(const char *text);
 
 void view_review_show_generic(review_type_e reviewKind, const char *title, const char *validate);
@@ -148,4 +150,4 @@ typedef enum {
 } settings_list_e;
 
 void view_set_switch_subtext(settings_list_e switch_id, const char *subtext);
-#endif  // TARGET_STAX || TARGET_FLEX
+#endif  // TARGET_STAX || TARGET_FLEX

app/ui/view_internal.h

@@ -230,6 +230,8 @@ void h_inspect_init();
 
 void view_review_show_impl(unsigned int requireReply, const char *title, const char *validate);
 
+void view_review_show_with_intent_impl(unsigned int requireReply, const char *intent);
+
 void view_inspect_show_impl();
 
 void view_initialize_show_impl(uint8_t item_idx, const char *statusString);

app/ui/view_nbgl.c

@@ -54,6 +54,9 @@ const char *intro_submessage = NULL;
 char intro_msg_buf[MAX_CHARS_PER_VALUE1_LINE];
 char intro_submsg_buf[MAX_CHARS_SUBMSG_LINE];
 
+#define REVIEW_STANDALONE_SIZE 22
+#define REVIEW_MESSAGE_SIZE 18
+
 static nbgl_layoutTagValue_t pairs[NB_MAX_DISPLAYED_PAIRS_IN_REVIEW];
 
 static nbgl_layoutTagValue_t pair;
@@ -464,6 +467,7 @@ static void config_useCaseReview(nbgl_operationType_t type) {
     pairList.pairs = NULL;  // to indicate that callback should be used
     pairList.callback = update_item_callback;
     pairList.startIndex = 0;
+
     if (app_mode_blindsign_required()) {
         nbgl_useCaseReviewBlindSigning(type, &pairList, &C_icon_stax_64,
                                        (intro_message == NULL ? "Review transaction" : intro_message),
@@ -563,6 +567,50 @@ void view_review_show_impl(unsigned int requireReply, const char *title, const c
     }
 }
 
+void view_review_show_with_intent_impl(unsigned int requireReply, const char *intent) {
+    review_type = (review_type_e)requireReply;
+
+    intro_message = NULL;
+    intro_submessage = NULL;
+    intro_msg_buf[0] = '\0';
+    intro_submsg_buf[0] = '\0';
+    viewdata.key = viewdata.keys[0];
+    viewdata.value = viewdata.values[0];
+
+    // Format the intro message based on the intent
+    if (intent != NULL && strlen(intent) > 0) {
+        // Show everything on a single line for NBGL
+        const char *review_text = (review_type == REVIEW_MSG) ? "Review message" : "Review transaction";
+        int ret = snprintf(intro_msg_buf, sizeof(intro_msg_buf), "%s to %s", review_text, intent);
+
+        // Check if truncation occurred and add ellipsis if needed
+        if (ret >= (int)sizeof(intro_msg_buf)) {
+            const size_t buf_len = sizeof(intro_msg_buf);
+            if (buf_len >= 4) {
+                intro_msg_buf[buf_len - 4] = '.';
+                intro_msg_buf[buf_len - 3] = '.';
+                intro_msg_buf[buf_len - 2] = '.';
+                intro_msg_buf[buf_len - 1] = '\0';
+            }
+        }
+        intro_message = intro_msg_buf;
+        intro_submessage = NULL;  // No second line for NBGL
+    }
+
+    h_paging_init();
+
+    switch (review_type) {
+        case REVIEW_MSG: {
+            config_useCaseMessageReview();
+            break;
+        }
+        case REVIEW_TXN:
+        default:
+            config_useCaseReview(TYPE_TRANSACTION);
+            break;
+    }
+}
+
 void view_set_switch_subtext(settings_list_e switch_id, const char *subtext) {
     if (switch_id >= SETTINGS_SWITCHES_NB_LEN) {
         return;

app/ui/view_s.c

@@ -608,4 +608,11 @@ static unsigned int view_skip_button(unsigned int button_mask, __Z_UNUSED unsign
     return 0;
 }
 
+void view_review_show_with_intent_impl(unsigned int requireReply, const char *intent) {
+    // For Nano S, we don't have space to display the intent in the title
+    // Just use the normal review flow
+    UNUSED(intent);
+    view_review_show_impl(requireReply, NULL, NULL);
+}
+
 #endif

app/ui/view_x.c

@@ -282,7 +282,6 @@ UX_FLOW_DEF_NOCB(ux_review_flow_4_review_title, pbb,
                      REVIEW_MSG_TITLE,
                      REVIEW_MSG_VALUE,
                  });
-
 UX_STEP_INIT(ux_review_flow_2_start_step, NULL, NULL, { h_review_loop_start(); });
 #ifdef HAVE_INSPECT
 UX_STEP_CB_INIT(ux_review_flow_2_step, bnnn_paging, h_review_loop_inside(), inspect_init(),
@@ -566,6 +565,76 @@ void view_review_show_impl(unsigned int requireReply, const char *title, const c
 
 void run_root_txn_flow() { run_ux_review_flow(review_type, &ux_review_flow_2_start_step); }
 
+void view_review_show_with_intent_impl(unsigned int requireReply, const char *intent) {
+    review_type = requireReply;
+    h_paging_init();
+    h_paging_decrease();
+
+    // Format the intro message based on the intent
+    if (intent != NULL && strlen(intent) > 0) {
+        // Put "Review transaction" or "Review message" on first line
+        const char *first_line = (review_type == REVIEW_MSG) ? "Review message" : "Review transaction";
+        snprintf(intro_msg_buf, sizeof(intro_msg_buf), "%s", first_line);
+
+        // Put "to {intent}" on second line
+        const size_t max_intent_len = sizeof(intro_submsg_buf) - 4;  // Reserve 4 bytes: "to " (3) + null terminator (1)
+        int ret = snprintf(intro_submsg_buf, sizeof(intro_submsg_buf), "to %.*s", (int)max_intent_len, intent);
+
+        // Check if truncation occurred and add ellipsis if needed
+        if (ret >= (int)sizeof(intro_submsg_buf)) {
+            const size_t buf_len = sizeof(intro_submsg_buf);
+            if (buf_len >= 4) {
+                intro_submsg_buf[buf_len - 4] = '.';
+                intro_submsg_buf[buf_len - 3] = '.';
+                intro_submsg_buf[buf_len - 2] = '.';
+                intro_submsg_buf[buf_len - 1] = '\0';
+            }
+        }
+
+        // Use the dynamic review flow for transactions and messages with intent
+        if (review_type == REVIEW_TXN) {
+            flow_inside_loop = 0;
+            if (G_ux.stack_count == 0) {
+                ux_stack_push();
+            }
+            // Build flow with dynamic title for transaction
+            uint8_t index = 0;
+            ux_review_flow[index++] = &ux_review_flow_1_review_group_title;
+            ux_review_flow[index++] = &ux_review_flow_2_start_step;
+            ux_review_flow[index++] = &ux_review_flow_2_step;
+            ux_review_flow[index++] = &ux_review_flow_2_end_step;
+            ux_review_flow[index++] = &ux_review_flow_3_step;
+            ux_review_flow[index++] = FLOW_END_STEP;
+            ux_flow_init(0, ux_review_flow, NULL);
+            return;
+        } else if (review_type == REVIEW_MSG) {
+            // Create custom flow for message with intent
+            flow_inside_loop = 0;
+            if (G_ux.stack_count == 0) {
+                ux_stack_push();
+            }
+            // Build flow with dynamic title for message
+            uint8_t index = 0;
+            // Use the group title flow which displays intro_msg_buf
+            ux_review_flow[index++] = &ux_review_flow_1_review_group_title;
+            ux_review_flow[index++] = &ux_review_flow_2_start_step;
+            ux_review_flow[index++] = &ux_review_flow_2_step;
+            ux_review_flow[index++] = &ux_review_flow_2_end_step;
+            ux_review_flow[index++] = &ux_review_flow_6_step;
+            ux_review_flow[index++] = FLOW_END_STEP;
+            ux_flow_init(0, ux_review_flow, NULL);
+            return;
+        }
+    }
+
+    // Fallback to normal review flow if no intent or other review types
+    flow_inside_loop = 0;
+    if (G_ux.stack_count == 0) {
+        ux_stack_push();
+    }
+    run_ux_review_flow((review_type_e)review_type, NULL);
+}
+
 // Build review UX flow and run it
 void run_ux_review_flow(review_type_e reviewType, const ux_flow_step_t *const start_step) {
     uint8_t index = 0;

include/zxversion.h

@@ -17,4 +17,4 @@
 
 #define ZXLIB_MAJOR 36
 #define ZXLIB_MINOR 0
-#define ZXLIB_PATCH 1
+#define ZXLIB_PATCH 2