Add streaming Blind Signing Review Use Case

Author: nroggeman-ledger

lib_nbgl/src/nbgl_use_case.c

@@ -107,6 +107,7 @@ typedef struct KeypadContext_s {
 #endif
 
 typedef struct BlindSigningContext_s {
+    bool                              isStreaming;
     nbgl_operationType_t              operationType;
     const nbgl_contentTagValueList_t *tagValueList;
     const nbgl_icon_details_t        *icon;
@@ -281,6 +282,12 @@ static void useCaseReview(nbgl_operationType_t              operationType,
                           nbgl_choiceCallback_t             choiceCallback,
                           bool                              isLight,
                           bool                              playNotifSound);
+static void useCaseReviewStreamingStart(nbgl_operationType_t       operationType,
+                                        const nbgl_icon_details_t *icon,
+                                        const char                *reviewTitle,
+                                        const char                *reviewSubTitle,
+                                        nbgl_choiceCallback_t      choiceCallback,
+                                        bool                       playNotifSound);
 
 static void reset_callbacks(void)
 {
@@ -584,16 +591,26 @@ static void pageCallback(int token, uint8_t index)
             blindSigningContext.choiceCallback(false);
         }
         else {  // bottom button to continue to review
-            useCaseReview(blindSigningContext.operationType,
-                          blindSigningContext.tagValueList,
-                          blindSigningContext.icon,
-                          blindSigningContext.reviewTitle,
-                          blindSigningContext.reviewSubTitle,
-                          blindSigningContext.finishTitle,
-                          blindSigningContext.tipBox,
-                          blindSigningContext.choiceCallback,
-                          false,
-                          true);
+            if (blindSigningContext.isStreaming) {
+                useCaseReviewStreamingStart(blindSigningContext.operationType,
+                                            blindSigningContext.icon,
+                                            blindSigningContext.reviewTitle,
+                                            blindSigningContext.reviewSubTitle,
+                                            blindSigningContext.choiceCallback,
+                                            false);
+            }
+            else {
+                useCaseReview(blindSigningContext.operationType,
+                              blindSigningContext.tagValueList,
+                              blindSigningContext.icon,
+                              blindSigningContext.reviewTitle,
+                              blindSigningContext.reviewSubTitle,
+                              blindSigningContext.finishTitle,
+                              blindSigningContext.tipBox,
+                              blindSigningContext.choiceCallback,
+                              false,
+                              false);
+            }
         }
     }
     else if (token == TIP_BOX_TOKEN) {
@@ -1811,6 +1828,52 @@ static void useCaseReview(nbgl_operationType_t              operationType,
     displayGenericContextPage(0, true);
 }
 
+// function to factorize code for all streaming reviews
+static void useCaseReviewStreamingStart(nbgl_operationType_t       operationType,
+                                        const nbgl_icon_details_t *icon,
+                                        const char                *reviewTitle,
+                                        const char                *reviewSubTitle,
+                                        nbgl_choiceCallback_t      choiceCallback,
+                                        bool                       playNotifSound)
+{
+    reset_callbacks();
+    memset(&genericContext, 0, sizeof(genericContext));
+
+    bundleNavContext.reviewStreaming.operationType  = operationType;
+    bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
+    bundleNavContext.reviewStreaming.icon           = icon;
+
+    // memorize context
+    onChoice  = bundleNavReviewStreamingChoice;
+    navType   = STREAMING_NAV;
+    pageTitle = NULL;
+
+    genericContext.genericContents.contentsList = localContentsList;
+    genericContext.genericContents.nbContents   = 1;
+    memset(localContentsList, 0, 1 * sizeof(nbgl_content_t));
+
+    // First a centered info
+    STARTING_CONTENT.type = EXTENDED_CENTER;
+    prepareReviewFirstPage(
+        &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
+
+    // compute number of pages & fill navigation structure
+    bundleNavContext.reviewStreaming.stepPageNb
+        = nbgl_useCaseGetNbPagesForGenericContents(&genericContext.genericContents, 0);
+    prepareNavInfo(true, NBGL_NO_PROGRESS_INDICATOR, getRejectReviewText(operationType));
+    // no back button on first page
+    navInfo.navWithButtons.backButton = false;
+
+    // Play notification sound if required
+    if (playNotifSound) {
+#ifdef HAVE_PIEZO_SOUND
+        io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
+#endif  // HAVE_PIEZO_SOUND
+    }
+
+    displayGenericContextPage(0, true);
+}
+
 /**********************
  *   GLOBAL FUNCTIONS
  **********************/
@@ -3000,6 +3063,7 @@ void nbgl_useCaseReviewBlindSigning(nbgl_operationType_t              operationT
 {
     memset(&blindSigningContext, 0, sizeof(blindSigningContext));
 
+    blindSigningContext.isStreaming    = false;
     blindSigningContext.operationType  = operationType | BLIND_OPERATION;
     blindSigningContext.tagValueList   = tagValueList;
     blindSigningContext.icon           = icon;
@@ -3106,40 +3170,44 @@ void nbgl_useCaseReviewStreamingStart(nbgl_operationType_t       operationType,
                                       const char                *reviewSubTitle,
                                       nbgl_choiceCallback_t      choiceCallback)
 {
-    reset_callbacks();
-    memset(&genericContext, 0, sizeof(genericContext));
-
-    bundleNavContext.reviewStreaming.operationType  = operationType;
-    bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
-    bundleNavContext.reviewStreaming.icon           = icon;
-
-    // memorize context
-    onChoice  = bundleNavReviewStreamingChoice;
-    navType   = STREAMING_NAV;
-    pageTitle = NULL;
-
-    genericContext.genericContents.contentsList = localContentsList;
-    genericContext.genericContents.nbContents   = 1;
-    memset(localContentsList, 0, 1 * sizeof(nbgl_content_t));
+    useCaseReviewStreamingStart(
+        operationType, icon, reviewTitle, reviewSubTitle, choiceCallback, true);
+}
 
-    // First a centered info
-    STARTING_CONTENT.type = EXTENDED_CENTER;
-    prepareReviewFirstPage(
-        &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
+/**
+ * @brief Start drawing the flow of pages of a blind-signing review. The review is preceded by a
+ * warning page
+ * @note  This should be followed by calls to nbgl_useCaseReviewStreamingContinue and finally to
+ *        nbgl_useCaseReviewStreamingFinish.
+ *
+ * @param operationType type of operation (Operation, Transaction, Message)
+ * @param icon icon used on first and last review page
+ * @param reviewTitle string used in the first review page
+ * @param reviewSubTitle string to set under reviewTitle (can be NULL)
+ * @param choiceCallback callback called when more operation data are needed (param is true) or
+ * operation is rejected (param is false)
+ */
+void nbgl_useCaseReviewStreamingBlindSigningStart(nbgl_operationType_t       operationType,
+                                                  const nbgl_icon_details_t *icon,
+                                                  const char                *reviewTitle,
+                                                  const char                *reviewSubTitle,
+                                                  nbgl_choiceCallback_t      choiceCallback)
+{
+    memset(&blindSigningContext, 0, sizeof(blindSigningContext));
 
-    // compute number of pages & fill navigation structure
-    bundleNavContext.reviewStreaming.stepPageNb
-        = nbgl_useCaseGetNbPagesForGenericContents(&genericContext.genericContents, 0);
-    prepareNavInfo(true, NBGL_NO_PROGRESS_INDICATOR, getRejectReviewText(operationType));
-    // no back button on first page
-    navInfo.navWithButtons.backButton = false;
+    blindSigningContext.isStreaming    = true;
+    blindSigningContext.operationType  = operationType | BLIND_OPERATION;
+    blindSigningContext.icon           = icon;
+    blindSigningContext.reviewTitle    = reviewTitle;
+    blindSigningContext.reviewSubTitle = reviewSubTitle;
+    blindSigningContext.choiceCallback = choiceCallback;
 
 #ifdef HAVE_PIEZO_SOUND
     // Play notification sound
     io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
 #endif  // HAVE_PIEZO_SOUND
 
-    displayGenericContextPage(0, true);
+    blindSigningWarning();
 }
 
 /**