16#include "os_io_seph_ux.h"
19#include "os_helpers.h"
26#define PAGE_NB_ELEMENTS_BITS 3
27#define GET_PAGE_NB_ELEMENTS(pageData) ((pageData) &0x07)
28#define SET_PAGE_NB_ELEMENTS(nbElements) ((nbElements) &0x07)
30#define PAGE_FLAG_BITS 1
31#define GET_PAGE_FLAG(pageData) (((pageData) &0x08) >> 3)
32#define SET_PAGE_FLAG(flag) (((flag) &0x01) << 3)
34#define PAGE_DATA_BITS (PAGE_NB_ELEMENTS_BITS + PAGE_FLAG_BITS)
35#define PAGES_PER_UINT8 (8 / PAGE_DATA_BITS)
36#define SET_PAGE_DATA(pageIdx, pageData) \
37 (pagesData[pageIdx / PAGES_PER_UINT8] = pageData \
38 << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS))
40#define MAX_PAGE_NB 256
41#define MAX_MODAL_PAGE_NB 32
44#define STARTING_CONTENT localContentsList[0]
45#define FINISHING_CONTENT localContentsList[1]
48#define QRCODE_NB_MAX_LINES 3
50#define QRCODE_REDUCED_ADDR_LEN 128
53#define ADDR_VERIF_NB_PAIRS 3
56#define sharedContext genericContext.sharedCtx
57#define keypadContext sharedContext.keypad
58#define keyboardContext sharedContext.keyboard
59#define reviewWithWarnCtx sharedContext.reviewWithWarning
60#define choiceWithDetailsCtx sharedContext.choiceWithDetails
63#define W3C_DESCRIPTION_MAX_LEN 128
70#define RISKY_OPERATION (1 << 6)
77#define NO_THREAT_OPERATION (1 << 7)
90 ADDRESS_QRCODE_BUTTON_TOKEN,
100 WARNING_BUTTON_TOKEN,
101 CHOICE_DETAILS_TOKEN,
103 QUIT_TIPBOX_MODAL_TOKEN,
104 WARNING_CHOICE_TOKEN,
106 DISMISS_WARNING_TOKEN,
107 DISMISS_DETAILS_TOKEN,
108 PRELUDE_CHOICE_TOKEN,
109 KEYBOARD_BUTTON_TOKEN,
110 KEYBOARD_CROSS_TOKEN,
111 FIRST_WARN_BAR_TOKEN,
123typedef struct DetailsContext_s {
126 uint8_t currentPairIdx;
130 const char *nextPageStart;
133typedef struct AddressConfirmationContext_s {
137} AddressConfirmationContext_t;
140typedef struct KeypadContext_s {
143 uint8_t pinMinDigits;
144 uint8_t pinMaxDigits;
152typedef struct KeyboardContext_s {
163typedef struct ReviewWithWarningContext_s {
168 const char *reviewTitle;
169 const char *reviewSubTitle;
170 const char *finishTitle;
175 uint8_t securityReportLevel;
177} ReviewWithWarningContext_t;
179typedef struct ChoiceWithDetailsContext_s {
184} ChoiceWithDetailsContext_t;
188 SHARE_CTX_REVIEW_WITH_WARNING,
189 SHARE_CTX_CHOICE_WITH_DETAILS,
190} SharedContextUsage_t;
197 KeypadContext_t keypad;
200 KeyboardContext_t keyboard;
202 ReviewWithWarningContext_t reviewWithWarning;
203 ChoiceWithDetailsContext_t choiceWithDetails;
205 SharedContextUsage_t usage;
209 USE_CASE_GENERIC = 0,
211} GenericContextType_t;
214 GenericContextType_t type;
215 uint8_t spinnerPosition;
217 int8_t currentContentIdx;
218 uint8_t currentContentElementNb;
219 uint8_t currentElementIdx;
220 bool hasStartingContent;
221 bool hasFinishingContent;
222 const char *detailsItem;
223 const char *detailsvalue;
224 bool detailsWrapping;
225 bool validWarningCtx;
235 SharedContext_t sharedCtx;
246} nbgl_homeAndSettingsContext_t;
251} nbgl_reviewContext_t;
259} nbgl_reviewStreamingContext_t;
262 nbgl_homeAndSettingsContext_t homeAndSettings;
263 nbgl_reviewContext_t review;
264 nbgl_reviewStreamingContext_t reviewStreaming;
265} nbgl_BundleNavContext_t;
271} SecurityReportItem_t;
278static char tmpString[W3C_DESCRIPTION_MAX_LEN];
295static const char *pageTitle;
298#define activeTipBox genericContext.tipBox
302static bool forwardNavOnly;
303static NavType_t navType;
305static DetailsContext_t detailsContext;
308static AddressConfirmationContext_t addressConfirmationContext;
311static GenericContext_t genericContext;
313 localContentsList[3];
314static uint8_t genericContextPagesInfo[MAX_PAGE_NB / PAGES_PER_UINT8];
315static uint8_t modalContextPagesInfo[MAX_MODAL_PAGE_NB / PAGES_PER_UINT8];
318static nbgl_BundleNavContext_t bundleNavContext;
321static const uint8_t nbMaxElementsPerContentType[] = {
338 .icon = &WARNING_ICON,
339 .text =
"Blind signing required",
340 .subText =
"This transaction's details are not fully verifiable. If "
341 "you sign, you could lose all your assets."
344 .icon = &WARNING_ICON,
345 .text =
"Transaction Check unavailable",
349 .icon = &WARNING_ICON,
350 .text =
"Risk detected",
351 .subText =
"This transaction was scanned as risky by Web3 Checks."
354 .icon = &WARNING_ICON,
355 .text =
"Critical threat",
356 .subText =
"This transaction was scanned as malicious by Web3 Checks."
360 .text =
"No threat detected",
361 .subText =
"Transaction Check didn't find any threat, but always "
362 "review transaction details carefully."
372static char reducedAddress[QRCODE_REDUCED_ADDR_LEN];
378static void displayReviewPage(uint8_t page,
bool forceFullRefresh);
379static void displayDetailsPage(uint8_t page,
bool forceFullRefresh);
380static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh);
381static void displayFullValuePage(
const char *backText,
382 const char *aliasText,
384static void displayInfosListModal(
const char *modalTitle,
388static void displaySettingsPage(uint8_t page,
bool forceFullRefresh);
389static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh);
390static void pageCallback(
int token, uint8_t index);
392static void displayAddressQRCode(
void);
394static void modalLayoutTouchCallback(
int token, uint8_t index);
395static void displaySkipWarning(
void);
397static void bundleNavStartHome(
void);
398static void bundleNavStartSettingsAtPage(uint8_t initSettingPage);
399static void bundleNavStartSettings(
void);
401static void bundleNavReviewStreamingChoice(
bool confirm);
403static void displaySecurityReport(uint32_t set);
405static void displayInitialWarning(
void);
409 const char *reviewTitle,
410 const char *reviewSubTitle,
411 const char *finishTitle,
415 bool playNotifSound);
418 const char *reviewTitle,
419 const char *reviewSubTitle,
421 bool playNotifSound);
422static void useCaseHomeExt(
const char *appName,
429static void displayDetails(
const char *tag,
const char *value,
bool wrapping);
431static void reset_callbacks_and_context(
void)
438 onContentAction = NULL;
440 memset(&genericContext, 0,
sizeof(genericContext));
444static void genericContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements,
bool flag)
446 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements) + SET_PAGE_FLAG(flag);
448 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
449 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
450 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
451 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
455static void genericContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements,
bool *flag)
457 uint8_t pageData = genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
458 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
459 if (nbElements != NULL) {
460 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
463 *flag = GET_PAGE_FLAG(pageData);
468static void modalContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements)
470 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements);
472 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
473 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
474 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
475 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
479static void modalContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements)
481 uint8_t pageData = modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
482 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
483 if (nbElements != NULL) {
484 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
491 switch (content->
type) {
515 if (contentIdx < 0 || contentIdx >= genericContents->
nbContents) {
532static void prepareNavInfo(
bool isReview, uint8_t nbPages,
const char *rejectText)
534 memset(&navInfo, 0,
sizeof(navInfo));
537 navInfo.
tuneId = TUNE_TAP_CASUAL;
541 if (isReview ==
false) {
550 = ((navType == STREAMING_NAV) && (nbPages < 2)) ?
false : true;
557 const char *reviewTitle,
558 const char *reviewSubTitle)
560 contentCenter->
icon = icon;
561 contentCenter->
title = reviewTitle;
563 contentCenter->
subText =
"Swipe to review";
566 contentCenter->
padding =
false;
572 if (finishTitle != NULL) {
577 return "Sign transaction";
579 return "Sign message";
581 return "Sign operation";
588 const char *finishTitle)
590 infoLongPress->
text = getFinishTitle(operationType, finishTitle);
591 infoLongPress->
icon = icon;
599 const char *finishTitle)
601 infoButton->
text = getFinishTitle(operationType, finishTitle);
602 infoButton->
icon = icon;
609 UNUSED(operationType);
615static void pageModalCallback(
int token, uint8_t index)
619 if (token == INFOS_TIP_BOX_TOKEN) {
621 displayFullValuePage(activeTipBox.infos.infoTypes[index],
622 activeTipBox.infos.infoContents[index],
623 &activeTipBox.infos.infoExtensions[index]);
626 else if (token == INFO_ALIAS_TOKEN) {
628 displayFullValuePage(genericContext.currentInfos->infoTypes[index],
629 genericContext.currentInfos->infoContents[index],
630 &genericContext.currentInfos->infoExtensions[index]);
634 modalPageContext = NULL;
635 if (token == NAV_TOKEN) {
642 displayDetailsPage(index,
false);
645 if (token == MODAL_NAV_TOKEN) {
652 displayTagValueListModalPage(index,
false);
655 else if (token == QUIT_TOKEN) {
660 else if (token == QUIT_TIPBOX_MODAL_TOKEN) {
662 if (reviewWithWarnCtx.securityReportLevel == 2) {
663 reviewWithWarnCtx.securityReportLevel = 1;
664 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
672 else if (token == SKIP_TOKEN) {
683 else if (token == CHOICE_TOKEN) {
685 if (onModalConfirm != NULL) {
687 onModalConfirm = NULL;
699static void pageCallback(
int token, uint8_t index)
702 if (token == QUIT_TOKEN) {
703 if (onQuit != NULL) {
707 else if (token == CONTINUE_TOKEN) {
708 if (onContinue != NULL) {
712 else if (token == CHOICE_TOKEN) {
713 if (onChoice != NULL) {
714 onChoice((index == 0) ?
true : false);
717 else if (token == ACTION_BUTTON_TOKEN) {
718 if ((index == 0) && (onAction != NULL)) {
721 else if ((index == 1) && (onQuit != NULL)) {
726 else if (token == ADDRESS_QRCODE_BUTTON_TOKEN) {
727 displayAddressQRCode();
730 else if (token == CONFIRM_TOKEN) {
731 if (onChoice != NULL) {
735 else if (token == REJECT_TOKEN) {
736 if (onChoice != NULL) {
740 else if (token == DETAILS_BUTTON_TOKEN) {
741 displayDetails(genericContext.detailsItem,
742 genericContext.detailsvalue,
743 genericContext.detailsWrapping);
745 else if (token == NAV_TOKEN) {
747 if (onQuit != NULL) {
752 if (navType == GENERIC_NAV || navType == STREAMING_NAV) {
753 displayGenericContextPage(index,
false);
755 else if (navType == REVIEW_NAV) {
756 displayReviewPage(index,
false);
759 displaySettingsPage(index,
false);
763 else if (token == NEXT_TOKEN) {
765 displayReviewPage(navInfo.
activePage + 1,
false);
768 displayGenericContextPage(navInfo.
activePage + 1,
false);
771 else if (token == BACK_TOKEN) {
773 displayReviewPage(navInfo.
activePage - 1,
true);
776 displayGenericContextPage(navInfo.
activePage - 1,
false);
779 else if (token == SKIP_TOKEN) {
781 displaySkipWarning();
783 else if (token == VALUE_ALIAS_TOKEN) {
786 if (genericContext.currentPairs != NULL) {
787 pair = &genericContext.currentPairs[genericContext.currentElementIdx + index];
790 pair = genericContext.currentCallback(genericContext.currentElementIdx + index);
794 else if (token == BLIND_WARNING_TOKEN) {
795 reviewWithWarnCtx.isIntro =
false;
796 reviewWithWarnCtx.warning = NULL;
799 else if (token == WARNING_BUTTON_TOKEN) {
801 reviewWithWarnCtx.securityReportLevel = 1;
803 if (reviewWithWarnCtx.warning->predefinedSet) {
804 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
808 if (reviewWithWarnCtx.isIntro) {
809 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->introDetails);
812 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->reviewDetails);
816 else if (token == TIP_BOX_TOKEN) {
818 if (genericContext.validWarningCtx && (reviewWithWarnCtx.warning->predefinedSet != 0)) {
819 reviewWithWarnCtx.securityReportLevel = 1;
820 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
823 displayInfosListModal(activeTipBox.modalTitle, &activeTipBox.infos,
false);
827 if (onContentAction != NULL) {
828 onContentAction(token, index, navInfo.
activePage);
830 if (onControls != NULL) {
831 onControls(token, index);
837static void tickerCallback(
void)
840 if (onQuit != NULL) {
846static void displaySettingsPage(uint8_t page,
bool forceFullRefresh)
850 if ((onNav == NULL) || (onNav(page, &content) ==
false)) {
855 content.
title = pageTitle;
858 content.
tuneId = TUNE_TAP_CASUAL;
863 if (forceFullRefresh) {
872static void displayReviewPage(uint8_t page,
bool forceFullRefresh)
881 if ((onNav == NULL) || (onNav(navInfo.
activePage, &content) ==
false)) {
886 content.
title = NULL;
888 content.
tuneId = TUNE_TAP_CASUAL;
895 if (forwardNavOnly) {
920 if (forceFullRefresh) {
930static const nbgl_content_t *genericContextComputeNextPageParams(uint8_t pageIdx,
932 uint8_t *p_nbElementsInNextPage,
935 int8_t nextContentIdx = genericContext.currentContentIdx;
936 int16_t nextElementIdx = genericContext.currentElementIdx;
937 uint8_t nbElementsInNextPage;
940 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
941 *p_nbElementsInNextPage = nbElementsInNextPage;
946 uint8_t nbElementsInCurrentPage;
948 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
949 nextElementIdx += nbElementsInCurrentPage;
954 if ((nextElementIdx >= genericContext.currentContentElementNb)
955 && (genericContext.currentContentElementNb > 0)) {
965 nextElementIdx -= nbElementsInNextPage;
971 if (nextElementIdx < 0) {
973 nextElementIdx = -nbElementsInNextPage;
979 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
980 p_content = &STARTING_CONTENT;
982 else if ((nextContentIdx == genericContext.genericContents.nbContents)
983 && (genericContext.hasFinishingContent)) {
984 p_content = &FINISHING_CONTENT;
987 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
989 if (p_content == NULL) {
1004 if ((nextContentIdx != genericContext.currentContentIdx)
1005 || (genericContext.currentContentElementNb == 0)) {
1006 genericContext.currentContentIdx = nextContentIdx;
1007 genericContext.currentContentElementNb = getContentNbElement(p_content);
1009 if (nextElementIdx < 0) {
1010 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
1015 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
1017 "Invalid element index %d / %d\n",
1019 genericContext.currentContentElementNb);
1024 genericContext.currentElementIdx = nextElementIdx;
1032static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
1033 uint8_t nbElementsInPage,
1037 uint8_t nextElementIdx = genericContext.currentElementIdx;
1039 pageContent->
title = pageTitle;
1042 pageContent->
tuneId = TUNE_TAP_CASUAL;
1044 pageContent->
type = p_content->
type;
1045 switch (pageContent->
type) {
1097 p_tagValueList = NULL;
1109 genericContext.detailsItem = pair->
item;
1110 genericContext.detailsvalue = pair->
value;
1115 if (p_tagValueList != NULL) {
1116 p_tagValueList->
nbPairs = nbElementsInPage;
1119 p_tagValueList->
pairs
1122 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1124 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1130 p_tagValueList->
pairs = NULL;
1134 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1138 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1154 if ((nextElementIdx + nbElementsInPage)
1166 p_tagValueList->
nbPairs = nbElementsInPage;
1167 p_tagValueList->
pairs
1170 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1172 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1177 genericContext.currentPairs = p_tagValueList->
pairs;
1178 genericContext.currentCallback = p_tagValueList->
callback;
1202 < nextElementIdx + nbElementsInPage)) {
1222 bool isFirstOrLastPage
1226 = (navType == STREAMING_NAV)
1227 ? bundleNavContext.reviewStreaming.operationType
1228 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1231 if (isFirstOrLastPage
1232 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1234 if ((operationType & NO_THREAT_OPERATION)
1243 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1250static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh)
1254 uint8_t nbElementsInPage;
1258 if (navType == STREAMING_NAV) {
1260 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1261 bundleNavContext.reviewStreaming.skipCallback();
1265 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1266 bundleNavReviewStreamingChoice(
true);
1273 pageIdx = navInfo.
nbPages - 1;
1279 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1284 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1285 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1295 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1298 if (p_content == NULL) {
1302 if ((navType != STREAMING_NAV)
1305 if ((pageIdx > 0) && (pageIdx < (navInfo.
nbPages - 1))) {
1317 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1323 if (forceFullRefresh) {
1332static const char *getDetailsPageAt(uint8_t detailsPage)
1335 const char *currentChar = detailsContext.value;
1336 while (page < detailsPage) {
1346 detailsContext.wrapping);
1348 if (currentChar[len] ==
'\n') {
1351 else if (detailsContext.wrapping ==
false) {
1354 currentChar = currentChar + len;
1362static void displayDetailsPage(uint8_t detailsPage,
bool forceFullRefresh)
1366 .nbPages = detailsContext.nbPages,
1368 .quitToken = QUIT_TOKEN,
1369 .navWithButtons.navToken = NAV_TOKEN,
1370 .navWithButtons.quitButton =
true,
1371 .navWithButtons.backButton =
true,
1372 .navWithButtons.quitText = NULL,
1373 .progressIndicator =
false,
1374 .tuneId = TUNE_TAP_CASUAL};
1376 .topRightIcon = NULL,
1377 .tagValueList.nbPairs = 1,
1378 .tagValueList.pairs = ¤tPair,
1379 .tagValueList.smallCaseForValue =
true,
1380 .tagValueList.wrapping = detailsContext.wrapping};
1382 if (modalPageContext != NULL) {
1385 currentPair.
item = detailsContext.tag;
1387 if (detailsPage <= detailsContext.currentPage) {
1389 currentPair.
value = getDetailsPageAt(detailsPage);
1390 forceFullRefresh =
true;
1394 currentPair.
value = detailsContext.nextPageStart;
1396 detailsContext.currentPage = detailsPage;
1407 detailsContext.wrapping);
1410 if (currentPair.
value[len] ==
'\n') {
1413 else if (!detailsContext.wrapping) {
1418 detailsContext.nextPageStart = currentPair.
value + len;
1424 detailsContext.nextPageStart = NULL;
1433 if (forceFullRefresh) {
1442static void displayFullValuePage(
const char *backText,
1443 const char *aliasText,
1446 const char *modalTitle
1447 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1449 genericContext.currentInfos = extension->
infolist;
1450 displayInfosListModal(modalTitle, extension->
infolist,
true);
1453 genericContext.currentTagValues = extension->
tagValuelist;
1458 .withLeftBorder =
true,
1459 .onActionCallback = &modalLayoutTouchCallback,
1460 .tapActionText = NULL};
1462 .separationLine =
false,
1463 .backAndText.token = 0,
1464 .backAndText.tuneId = TUNE_TAP_CASUAL,
1465 .backAndText.text = modalTitle};
1474 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1475 .text2 = extension->explanation,
1484 content.
title = aliasText;
1486 content.
info =
"ENS names are resolved by Ledger backend.";
1508static void displayInfosListModal(
const char *modalTitle,
1515 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1516 .navWithButtons.navToken = NAV_TOKEN,
1517 .navWithButtons.quitButton =
false,
1518 .navWithButtons.backButton =
true,
1519 .navWithButtons.quitText = NULL,
1520 .progressIndicator =
false,
1521 .tuneId = TUNE_TAP_CASUAL};
1524 .topRightIcon = NULL,
1525 .infosList.nbInfos = infos->
nbInfos,
1527 .infosList.infoTypes = infos->
infoTypes,
1530 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1531 .
title = modalTitle,
1532 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1533 .tuneId = TUNE_TAP_CASUAL};
1535 if (modalPageContext != NULL) {
1544static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh)
1547 .nbPages = detailsContext.nbPages,
1549 .quitToken = QUIT_TOKEN,
1550 .navWithButtons.navToken = MODAL_NAV_TOKEN,
1551 .navWithButtons.quitButton =
true,
1552 .navWithButtons.backButton =
true,
1553 .navWithButtons.quitText = NULL,
1554 .progressIndicator =
false,
1555 .tuneId = TUNE_TAP_CASUAL};
1557 .topRightIcon = NULL,
1558 .tagValueList.smallCaseForValue =
true,
1559 .tagValueList.wrapping = detailsContext.wrapping};
1560 uint8_t nbElementsInPage;
1563 if (detailsContext.currentPage <= pageIdx) {
1564 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1568 modalContextGetPageInfo(pageIdx + 1, &nbElementsInPage);
1569 detailsContext.currentPairIdx -= nbElementsInPage;
1570 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1571 detailsContext.currentPairIdx -= nbElementsInPage;
1573 detailsContext.currentPage = pageIdx;
1576 = &genericContext.currentTagValues->pairs[detailsContext.currentPairIdx];
1578 detailsContext.currentPairIdx += nbElementsInPage;
1584 if (modalPageContext != NULL) {
1589 if (forceFullRefresh) {
1598static void displayAddressQRCode(
void)
1602 .withLeftBorder =
true,
1603 .onActionCallback = &modalLayoutTouchCallback,
1604 .tapActionText = NULL};
1606 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1612 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1617 addressConfirmationContext.tagValuePairs[0].value,
1621 if (nbLines <= QRCODE_NB_MAX_LINES) {
1622 qrCode.
text2 = addressConfirmationContext.tagValuePairs[0].value;
1627 addressConfirmationContext.tagValuePairs[0].value,
1629 QRCODE_NB_MAX_LINES,
1631 QRCODE_REDUCED_ADDR_LEN);
1632 qrCode.
text2 = reducedAddress;
1638 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1646static void modalLayoutTouchCallback(
int token, uint8_t index)
1649 if (token == DISMISS_QR_TOKEN) {
1652 addressConfirmationContext.modalLayout = NULL;
1655 else if (token == DISMISS_WARNING_TOKEN) {
1659 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1660 reviewWithWarnCtx.modalLayout = NULL;
1665 reviewWithWarnCtx.securityReportLevel = 1;
1667 if (reviewWithWarnCtx.warning->predefinedSet) {
1668 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1673 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1674 : reviewWithWarnCtx.warning->reviewDetails;
1675 displayCustomizedSecurityReport(details);
1680 else if (token == DISMISS_DETAILS_TOKEN) {
1684 if (choiceWithDetailsCtx.level <= 1) {
1685 choiceWithDetailsCtx.modalLayout = NULL;
1690 choiceWithDetailsCtx.level = 1;
1691 choiceWithDetailsCtx.modalLayout
1692 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1695 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1696 if (sharedContext.usage == SHARE_CTX_REVIEW_WITH_WARNING) {
1699 reviewWithWarnCtx.securityReportLevel = 2;
1701 if (reviewWithWarnCtx.warning->predefinedSet) {
1702 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1707 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1708 : reviewWithWarnCtx.warning->reviewDetails;
1710 displayCustomizedSecurityReport(
1715 else if (sharedContext.usage == SHARE_CTX_CHOICE_WITH_DETAILS) {
1717 = &choiceWithDetailsCtx.details->
barList.
details[token - FIRST_WARN_BAR_TOKEN];
1721 choiceWithDetailsCtx.level = 2;
1722 choiceWithDetailsCtx.modalLayout
1723 = displayModalDetails(details, DISMISS_DETAILS_TOKEN);
1731 genericContext.modalLayout = NULL;
1738static void layoutTouchCallback(
int token, uint8_t index)
1741 if (token == WARNING_CHOICE_TOKEN) {
1743 reviewWithWarnCtx.choiceCallback(
false);
1746 reviewWithWarnCtx.isIntro =
false;
1747 if (reviewWithWarnCtx.isStreaming) {
1748 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1749 reviewWithWarnCtx.icon,
1750 reviewWithWarnCtx.reviewTitle,
1751 reviewWithWarnCtx.reviewSubTitle,
1752 reviewWithWarnCtx.choiceCallback,
1756 useCaseReview(reviewWithWarnCtx.operationType,
1757 reviewWithWarnCtx.tagValueList,
1758 reviewWithWarnCtx.icon,
1759 reviewWithWarnCtx.reviewTitle,
1760 reviewWithWarnCtx.reviewSubTitle,
1761 reviewWithWarnCtx.finishTitle,
1763 reviewWithWarnCtx.choiceCallback,
1770 else if (token == WARNING_BUTTON_TOKEN) {
1772 reviewWithWarnCtx.securityReportLevel = 1;
1774 if (reviewWithWarnCtx.warning->predefinedSet) {
1775 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1780 ? reviewWithWarnCtx.warning->introDetails
1781 : reviewWithWarnCtx.warning->reviewDetails;
1782 displayCustomizedSecurityReport(details);
1786 else if (token == CHOICE_DETAILS_TOKEN) {
1787 choiceWithDetailsCtx.level = 1;
1788 choiceWithDetailsCtx.modalLayout
1789 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1792 else if (token == PRELUDE_CHOICE_TOKEN) {
1794 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->prelude->details);
1798 displayInitialWarning();
1801 reviewWithWarnCtx.isIntro =
false;
1802 if (reviewWithWarnCtx.isStreaming) {
1803 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1804 reviewWithWarnCtx.icon,
1805 reviewWithWarnCtx.reviewTitle,
1806 reviewWithWarnCtx.reviewSubTitle,
1807 reviewWithWarnCtx.choiceCallback,
1811 useCaseReview(reviewWithWarnCtx.operationType,
1812 reviewWithWarnCtx.tagValueList,
1813 reviewWithWarnCtx.icon,
1814 reviewWithWarnCtx.reviewTitle,
1815 reviewWithWarnCtx.reviewSubTitle,
1816 reviewWithWarnCtx.finishTitle,
1818 reviewWithWarnCtx.choiceCallback,
1826 else if (token == CHOICE_TOKEN) {
1827 if (onChoice != NULL) {
1828 onChoice((index == 0) ?
true : false);
1834static void displaySkipWarning(
void)
1837 .cancelText =
"Go back to review",
1838 .centeredInfo.text1 =
"Skip review?",
1840 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1841 .centeredInfo.text3 = NULL,
1843 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1844 .centeredInfo.offsetY = 0,
1845 .confirmationText =
"Yes, skip",
1846 .confirmationToken = SKIP_TOKEN,
1847 .
tuneId = TUNE_TAP_CASUAL,
1849 if (modalPageContext != NULL) {
1861static void updateKeyPad(
bool add)
1863 bool enableValidate, enableBackspace, enableDigits;
1864 bool redrawKeypad =
false;
1867 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1868 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1869 enableBackspace = (keypadContext.pinLen > 0);
1871 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1873 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1875 (keypadContext.pinLen == 1)) {
1876 redrawKeypad =
true;
1880 if ((keypadContext.pinLen == 0) ||
1881 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1883 (keypadContext.pinLen
1884 == (keypadContext.pinMaxDigits - 1))) {
1885 redrawKeypad =
true;
1888 if (keypadContext.hidden ==
true) {
1893 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1897 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1900 if ((!add) && (keypadContext.pinLen == 0)) {
1908static void keypadCallback(
char touchedKey)
1910 switch (touchedKey) {
1912 if (keypadContext.pinLen > 0) {
1913 keypadContext.pinLen--;
1914 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1916 updateKeyPad(
false);
1925 keypadContext.onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1929 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1930 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1931 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1932 keypadContext.pinLen++;
1940static void keypadGeneric_cb(
int token, uint8_t index)
1943 if (token != BACK_TOKEN) {
1952static void keyboardCallback(
char touchedKey)
1955 size_t textLen = strlen(keyboardContext.entryBuffer);
1961 keyboardContext.entryBuffer[--textLen] =
'\0';
1964 keyboardContext.entryBuffer[textLen] = touchedKey;
1965 keyboardContext.entryBuffer[++textLen] =
'\0';
1969 keyboardContext.getSuggestionButtons(&keyboardContext.keyboardContent, &mask);
1971 else if (textLen >= keyboardContext.entryMaxLen) {
1977 keyboardContext.keyboardIndex,
1980 keyboardContext.casing);
1984static void keyboardGeneric_cb(
int token, uint8_t index)
1991 case KEYBOARD_CROSS_TOKEN:
1993 keyboardContext.entryBuffer[0] =
'a';
1994 keyboardContext.entryBuffer[1] =
'\0';
1997 case KEYBOARD_BUTTON_TOKEN:
2004 && (token >= keyboardContext.keyboardContent.suggestionButtons.firstButtonToken)) {
2005 onControls(token, index);
2026static uint8_t getNbTagValuesInPage(uint8_t nbPairs,
2030 bool hasConfirmationButton,
2031 bool hasDetailsButton,
2032 bool *requireSpecificDisplay)
2034 uint8_t nbPairsInPage = 0;
2035 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2041 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
2044 *requireSpecificDisplay =
false;
2045 while (nbPairsInPage < nbPairs) {
2052 if (nbPairsInPage > 0) {
2053 currentHeight += INTER_TAG_VALUE_MARGIN;
2056 if (tagValueList->
pairs != NULL) {
2057 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2060 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2069 if (nbPairsInPage > 0) {
2076 *requireSpecificDisplay =
true;
2088 value_font = SMALL_REGULAR_FONT;
2091 value_font = LARGE_MEDIUM_FONT;
2105 if (nbPairsInPage == 0) {
2109 *requireSpecificDisplay =
true;
2118 if (hasConfirmationButton && (nbPairsInPage == nbPairs)) {
2119 maxUsableHeight -= UP_FOOTER_BUTTON_HEIGHT;
2120 if (currentHeight > maxUsableHeight) {
2125 else if (hasDetailsButton) {
2126 maxUsableHeight -= (SMALL_BUTTON_RADIUS * 2);
2127 if (currentHeight > maxUsableHeight) {
2131 return nbPairsInPage;
2143static uint8_t getNbTagValuesInDetailsPage(uint8_t nbPairs,
2147 uint8_t nbPairsInPage = 0;
2148 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2151 while (nbPairsInPage < nbPairs) {
2156 if (nbPairsInPage > 0) {
2157 currentHeight += INTER_TAG_VALUE_MARGIN;
2160 if (tagValueList->
pairs != NULL) {
2161 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2164 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2178 if (currentHeight >= maxUsableHeight) {
2183 return nbPairsInPage;
2186static uint8_t getNbPagesForContent(
const nbgl_content_t *content,
2187 uint8_t pageIdxStart,
2191 uint8_t nbElements = 0;
2192 uint8_t nbPages = 0;
2193 uint8_t nbElementsInPage;
2194 uint8_t elemIdx = 0;
2197 nbElements = getContentNbElement(content);
2199 while (nbElements > 0) {
2202 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
2204 nbElementsInPage = getNbTagValuesInPage(nbElements,
2213 nbElementsInPage = getNbTagValuesInPage(nbElements,
2238 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
2241 elemIdx += nbElementsInPage;
2242 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
2243 nbElements -= nbElementsInPage;
2251 uint8_t pageIdxStart,
2254 uint8_t nbPages = 0;
2258 for (
int i = 0; i < genericContents->
nbContents; i++) {
2259 p_content = getContentAtIdx(genericContents, i, &content);
2260 if (p_content == NULL) {
2263 nbPages += getNbPagesForContent(p_content,
2264 pageIdxStart + nbPages,
2272static void prepareAddressConfirmationPages(
const char *address,
2279 addressConfirmationContext.tagValuePairs[0].item =
"Address";
2280 addressConfirmationContext.tagValuePairs[0].value = address;
2281 addressConfirmationContext.nbPairs = 1;
2290 if ((tagValueList != NULL) && (tagValueList->
nbPairs < ADDR_VERIF_NB_PAIRS)) {
2294 for (uint8_t i = 0; i < tagValueList->
nbPairs; i++) {
2295 memcpy(&addressConfirmationContext.tagValuePairs[1 + i],
2296 &tagValueList->
pairs[i],
2298 addressConfirmationContext.nbPairs++;
2302 tmpList.
nbPairs = addressConfirmationContext.nbPairs;
2303 tmpList.
pairs = addressConfirmationContext.tagValuePairs;
2304 addressConfirmationContext.nbPairs = getNbTagValuesInPage(
2305 addressConfirmationContext.nbPairs, &tmpList, 0,
false,
true,
true, &flag);
2307 if (tmpList.
nbPairs > addressConfirmationContext.nbPairs) {
2308 addressConfirmationContext.nbPairs = 1;
2319 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2327 if ((tagValueList != NULL)
2328 && (tagValueList->
nbPairs > (addressConfirmationContext.nbPairs - 1))) {
2338 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2341 = tagValueList->
nbPairs - (addressConfirmationContext.nbPairs - 1);
2343 = &tagValueList->
pairs[addressConfirmationContext.nbPairs - 1];
2352static void bundleNavStartHome(
void)
2354 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2356 useCaseHomeExt(context->appName,
2359 context->settingContents != NULL ?
true : false,
2360 &context->homeAction,
2361 bundleNavStartSettings,
2362 context->quitCallback);
2365static void bundleNavStartSettingsAtPage(uint8_t initSettingPage)
2367 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2371 context->settingContents,
2373 bundleNavStartHome);
2376static void bundleNavStartSettings(
void)
2378 bundleNavStartSettingsAtPage(0);
2381static void bundleNavReviewConfirmRejection(
void)
2383 bundleNavContext.review.choiceCallback(
false);
2390 const char *confirmText;
2395 title =
"Reject transaction?";
2396 confirmText =
"Go back to transaction";
2399 title =
"Reject message?";
2400 confirmText =
"Go back to message";
2403 title =
"Reject operation?";
2404 confirmText =
"Go back to operation";
2411static void bundleNavReviewChoice(
bool confirm)
2414 bundleNavContext.review.choiceCallback(
true);
2417 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
2418 bundleNavReviewConfirmRejection);
2422static void bundleNavReviewStreamingConfirmRejection(
void)
2424 bundleNavContext.reviewStreaming.choiceCallback(
false);
2427static void bundleNavReviewStreamingChoice(
bool confirm)
2430 bundleNavContext.reviewStreaming.choiceCallback(
true);
2433 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
2434 bundleNavReviewStreamingConfirmRejection);
2444 .withLeftBorder =
true,
2445 .onActionCallback = modalLayoutTouchCallback,
2446 .tapActionText = NULL};
2448 .separationLine =
true,
2449 .backAndText.icon = NULL,
2450 .backAndText.tuneId = TUNE_TAP_CASUAL,
2451 .backAndText.token = token};
2467 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2468 bar.
tuneId = TUNE_TAP_CASUAL;
2495static void displaySecurityReport(uint32_t set)
2498 .withLeftBorder =
true,
2499 .onActionCallback = modalLayoutTouchCallback,
2500 .tapActionText = NULL};
2502 .separationLine =
true,
2503 .backAndText.icon = NULL,
2504 .backAndText.tuneId = TUNE_TAP_CASUAL,
2505 .backAndText.token = DISMISS_WARNING_TOKEN};
2509 const char *provider;
2511 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2517 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
2521 && (reviewWithWarnCtx.warning->predefinedSet & (1 << i))) {
2524 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
2525 bar.
subText = securityReportItems[i].subText;
2528 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
2530 bar.
text = securityReportItems[i].text;
2533 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2534 bar.
tuneId = TUNE_TAP_CASUAL;
2539 bar.
iconLeft = securityReportItems[i].icon;
2550 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2551 provider = reviewWithWarnCtx.warning->reportProvider;
2554 provider =
"[unknown]";
2560 + W3C_DESCRIPTION_MAX_LEN / 2;
2564 .text1 = reviewWithWarnCtx.warning->reportUrl,
2565 .text2 =
"Scan to view full report",
2570 W3C_DESCRIPTION_MAX_LEN / 2,
2572 reviewWithWarnCtx.warning->reportUrl);
2573 urlLen = strlen(destStr) + 1;
2578 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2584 info.
icon = &LARGE_WARNING_ICON;
2585 info.
title =
"This transaction cannot be Clear Signed";
2587 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2588 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2597 info.
icon = &LARGE_WARNING_ICON;
2598 info.
title =
"Transaction Check unavailable";
2600 =
"If you're not using the Ledger Wallet app, Transaction Check might not work. If "
2602 "are using Ledger Wallet, reject the transaction and try again.\n\nGet help at "
2621 reviewWithWarnCtx.modalLayout = displayModalDetails(details, DISMISS_WARNING_TOKEN);
2625static void displayInitialWarning(
void)
2628#ifdef HAVE_PIEZO_SOUND
2629 tune_index_e tune = TUNE_RESERVED;
2633 .token = WARNING_CHOICE_TOKEN,
2634 .topText =
"Back to safety",
2636 .tuneId = TUNE_TAP_CASUAL};
2638 .separationLine =
false,
2639 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2640 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2643 bool isBlindSigningOnly
2645 reviewWithWarnCtx.isIntro =
true;
2647 layoutDescription.
modal =
false;
2653 layoutDescription.
ticker.tickerCallback = NULL;
2654 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2657 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2660 isBlindSigningOnly ? &INFO_I_ICON : &QRCODE_ICON,
2661 WARNING_BUTTON_TOKEN,
2664 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2666 reviewWithWarnCtx.warning->introTopRightIcon,
2667 WARNING_BUTTON_TOKEN,
2672 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2675 const char *provider;
2678 info.
icon = &LARGE_WARNING_ICON;
2681 if (isBlindSigningOnly ==
false) {
2682 if (reviewWithWarnCtx.warning->reportProvider) {
2683 provider = reviewWithWarnCtx.warning->reportProvider;
2686 provider =
"[unknown]";
2689 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2693 if (isBlindSigningOnly) {
2694 info.
title =
"Blind signing ahead";
2697 =
"If you sign this transaction, you could loose your assets. "
2698 "Explore safer alternatives: ledger.com/integrated-apps";
2699 buttonsInfo.
bottomText =
"Accept risk and continue";
2703 =
"This transaction's details are not fully verifiable. If you sign, you could "
2704 "lose all your assets.";
2707#ifdef HAVE_PIEZO_SOUND
2708 tune = TUNE_NEUTRAL;
2712 info.
title =
"Potential risk";
2713 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2717 info.
description = reviewWithWarnCtx.warning->providerMessage;
2719 buttonsInfo.
bottomText =
"Accept risk and continue";
2720#ifdef HAVE_PIEZO_SOUND
2721 tune = TUNE_NEUTRAL;
2725 info.
title =
"Critical threat";
2726 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2730 info.
description = reviewWithWarnCtx.warning->providerMessage;
2732 buttonsInfo.
bottomText =
"Accept threat and continue";
2733#ifdef HAVE_PIEZO_SOUND
2739 else if (reviewWithWarnCtx.warning->info != NULL) {
2742#ifdef HAVE_PIEZO_SOUND
2743 tune = TUNE_LOOK_AT_ME;
2749#ifdef HAVE_PIEZO_SOUND
2750 if (tune != TUNE_RESERVED) {
2751 os_io_seph_cmd_piezo_play_tune(tune);
2759static void displayPrelude(
void)
2763 = {.
bottomText = reviewWithWarnCtx.warning->prelude->footerText,
2764 .token = PRELUDE_CHOICE_TOKEN,
2765 .topText = reviewWithWarnCtx.warning->prelude->buttonText,
2767 .tuneId = TUNE_TAP_CASUAL};
2769 .separationLine =
false,
2770 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2772 reviewWithWarnCtx.isIntro =
true;
2774 layoutDescription.
modal =
false;
2778 layoutDescription.
ticker.tickerCallback = NULL;
2779 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2786 info.
icon = reviewWithWarnCtx.warning->prelude->icon;
2788 info.
title = reviewWithWarnCtx.warning->prelude->title;
2789 info.
description = reviewWithWarnCtx.warning->prelude->description;
2795#ifdef HAVE_PIEZO_SOUND
2796 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2805 const char *predefinedTipBoxText = NULL;
2808 if (reviewWithWarnCtx.warning) {
2809 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2811 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2814 predefinedTipBoxText =
"Transaction Check unavailable";
2819 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2822 predefinedTipBoxText =
"Critical threat detected.";
2827 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2830 predefinedTipBoxText =
"Potential risk detected.";
2835 predefinedTipBoxText
2836 =
"No threat detected by Transaction Check but blind signing required.";
2839 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2843 predefinedTipBoxText =
"Blind signing required.";
2847 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2849 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2850 if (predefinedTipBoxText != NULL) {
2851 genericContext.validWarningCtx =
true;
2852 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2853 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2856 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2857 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2859 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2860 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2868 const char *reviewTitle,
2869 const char *reviewSubTitle,
2870 const char *finishTitle,
2874 bool playNotifSound)
2876 bundleNavContext.review.operationType = operationType;
2877 bundleNavContext.review.choiceCallback = choiceCallback;
2880 onChoice = bundleNavReviewChoice;
2881 navType = GENERIC_NAV;
2884 genericContext.genericContents.contentsList = localContentsList;
2885 genericContext.genericContents.nbContents = 3;
2890 prepareReviewFirstPage(
2891 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2894 initWarningTipBox(tipBox);
2898 memcpy(&localContentsList[1].content.tagValueList,
2906 prepareReviewLightLastPage(
2907 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2911 prepareReviewLastPage(
2912 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2916 uint8_t nbPages = getNbPagesForGenericContents(
2918 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2921 if (playNotifSound) {
2922#ifdef HAVE_PIEZO_SOUND
2923 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2927 displayGenericContextPage(0,
true);
2933 const char *reviewTitle,
2934 const char *reviewSubTitle,
2936 bool playNotifSound)
2938 bundleNavContext.reviewStreaming.operationType = operationType;
2939 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2940 bundleNavContext.reviewStreaming.icon = icon;
2943 onChoice = bundleNavReviewStreamingChoice;
2944 navType = STREAMING_NAV;
2947 genericContext.genericContents.contentsList = localContentsList;
2948 genericContext.genericContents.nbContents = 1;
2953 prepareReviewFirstPage(
2954 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2957 initWarningTipBox(NULL);
2960 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2967 if (playNotifSound) {
2968#ifdef HAVE_PIEZO_SOUND
2969 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2973 displayGenericContextPage(0,
true);
2992static void useCaseHomeExt(
const char *appName,
2994 const char *tagline,
3001 .centeredInfo.text1 = appName,
3002 .centeredInfo.text3 = NULL,
3004 .centeredInfo.offsetY = 0,
3007 .tapActionText = NULL,
3009 .topRightToken = CONTINUE_TOKEN,
3010 .tuneId = TUNE_TAP_CASUAL};
3011 reset_callbacks_and_context();
3013 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
3028 if (tagline == NULL) {
3032 "This app enables signing\ntransactions on its network.");
3059 onContinue = topRightCallback;
3060 onQuit = quitCallback;
3074static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
3076 memset(&detailsContext, 0,
sizeof(detailsContext));
3082 detailsContext.tag = tag;
3083 detailsContext.value = value;
3085 detailsContext.currentPage = 0;
3086 detailsContext.wrapping = wrapping;
3088 if (detailsContext.nbPages > 1) {
3089 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
3092 uint8_t nbLinesInLastPage
3098 detailsContext.nbPages++;
3102 displayDetailsPage(0,
true);
3108 uint8_t nbElements = 0;
3109 uint8_t nbElementsInPage;
3110 uint8_t elemIdx = 0;
3113 memset(&detailsContext, 0,
sizeof(detailsContext));
3114 nbElements = tagValues->
nbPairs;
3116 while (nbElements > 0) {
3117 nbElementsInPage = getNbTagValuesInDetailsPage(nbElements, tagValues, elemIdx);
3119 elemIdx += nbElementsInPage;
3120 modalContextSetPageInfo(detailsContext.nbPages, nbElementsInPage);
3121 nbElements -= nbElementsInPage;
3122 detailsContext.nbPages++;
3125 displayTagValueListModalPage(0,
true);
3147 bool *requireSpecificDisplay)
3149 return getNbTagValuesInPage(
3150 nbPairs, tagValueList, startIndex,
false,
false,
false, requireSpecificDisplay);
3170 bool *requireSpecificDisplay)
3172 return getNbTagValuesInPage(
3173 nbPairs, tagValueList, startIndex, isSkippable,
false,
false, requireSpecificDisplay);
3190 uint8_t nbInfosInPage = 0;
3191 uint16_t currentHeight = 0;
3192 uint16_t previousHeight;
3193 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3194 const char *
const *infoContents = PIC(infosList->
infoContents);
3196 while (nbInfosInPage < nbInfos) {
3199 += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING + LIST_ITEM_HEADING_SUB_TEXT;
3203 PIC(infoContents[startIndex + nbInfosInPage]),
3210 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3215 previousHeight = currentHeight;
3218 return nbInfosInPage;
3235 uint8_t nbSwitchesInPage = 0;
3236 uint16_t currentHeight = 0;
3237 uint16_t previousHeight = 0;
3238 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3241 while (nbSwitchesInPage < nbSwitches) {
3245 uint16_t textHeight =
MAX(
3246 LIST_ITEM_MIN_TEXT_HEIGHT,
3248 currentHeight += textHeight + 2 * LIST_ITEM_PRE_HEADING;
3251 currentHeight += LIST_ITEM_HEADING_SUB_TEXT;
3261 previousHeight = currentHeight;
3266 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3269 return nbSwitchesInPage;
3286 uint8_t nbBarsInPage = 0;
3287 uint16_t currentHeight = 0;
3288 uint16_t previousHeight;
3289 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3294 while (nbBarsInPage < nbBars) {
3295 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3300 previousHeight = currentHeight;
3305 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3308 return nbBarsInPage;
3325 uint8_t nbChoicesInPage = 0;
3326 uint16_t currentHeight = 0;
3327 uint16_t previousHeight;
3328 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3330 UNUSED(choicesList);
3333 while (nbChoicesInPage < nbChoices) {
3334 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3339 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3344 previousHeight = currentHeight;
3347 return nbChoicesInPage;
3358 uint8_t nbPages = 0;
3359 uint8_t nbPairs = tagValueList->
nbPairs;
3360 uint8_t nbPairsInPage;
3364 while (i < tagValueList->nbPairs) {
3368 nbPairs -= nbPairsInPage;
3380 const char *tagline,
3387 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3396 const char *tagline,
3398 const char *actionButtonText,
3406 .text = actionButtonText};
3409 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3432 reset_callbacks_and_context();
3435 onQuit = quitCallback;
3436 onNav = navCallback;
3437 onControls = controlsCallback;
3439 navType = SETTINGS_NAV;
3442 prepareNavInfo(
false, nbPages, NULL);
3444 displaySettingsPage(initPage,
true);
3462 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
3483 reset_callbacks_and_context();
3486 onQuit = quitCallback;
3487 pageTitle = appName;
3488 navType = GENERIC_NAV;
3490 if (settingContents != NULL) {
3493 if (infosList != NULL) {
3494 genericContext.hasFinishingContent =
true;
3497 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3501 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3502 if (infosList != NULL) {
3503 nbPages += getNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3506 prepareNavInfo(
false, nbPages, NULL);
3508 displayGenericContextPage(initPage,
true);
3547 const char *appName,
3549 const char *tagline,
3557 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3559 reset_callbacks_and_context();
3561 context->appName = appName;
3562 context->appIcon = appIcon;
3563 context->tagline = tagline;
3564 context->settingContents = settingContents;
3565 context->infosList = infosList;
3566 if (action != NULL) {
3572 context->quitCallback = quitCallback;
3575 bundleNavStartSettingsAtPage(initSettingPage);
3578 bundleNavStartHome();
3592 .tickerIntervale = 0,
3596 reset_callbacks_and_context();
3598 onQuit = quitCallback;
3600#ifdef HAVE_PIEZO_SOUND
3601 os_io_seph_cmd_piezo_play_tune(TUNE_LEDGER_MOMENT);
3604 info.
centeredInfo.
icon = isSuccess ? &CHECK_CIRCLE_ICON : &DENIED_CIRCLE_ICON;
3609 info.
tuneId = TUNE_TAP_CASUAL;
3625 switch (reviewStatusType) {
3627 msg =
"Operation signed";
3631 msg =
"Operation rejected";
3635 msg =
"Transaction signed";
3639 msg =
"Transaction rejected";
3643 msg =
"Message signed";
3647 msg =
"Message rejected";
3651 msg =
"Address verified";
3655 msg =
"Address verification\ncancelled";
3677 const char *message,
3678 const char *subMessage,
3679 const char *confirmText,
3680 const char *cancelText,
3685 if ((confirmText == NULL) || (cancelText == NULL)) {
3688 reset_callbacks_and_context();
3697 info.
tuneId = TUNE_TAP_CASUAL;
3699 onChoice = callback;
3719 const char *message,
3720 const char *subMessage,
3721 const char *confirmText,
3722 const char *cancelText,
3728 .token = CHOICE_TOKEN,
3729 .topText = confirmText,
3731 .tuneId = TUNE_TAP_CASUAL};
3734 .separationLine =
false,
3735 .emptySpace.height = MEDIUM_CENTERING_HEADER};
3738 if ((confirmText == NULL) || (cancelText == NULL)) {
3742 reset_callbacks_and_context();
3744 onChoice = callback;
3745 layoutDescription.
modal =
false;
3751 layoutDescription.
ticker.tickerCallback = NULL;
3752 sharedContext.usage = SHARE_CTX_CHOICE_WITH_DETAILS;
3753 choiceWithDetailsCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
3754 choiceWithDetailsCtx.details = details;
3758 centeredInfo.
icon = icon;
3759 centeredInfo.
title = message;
3763 if (details != NULL) {
3765 choiceWithDetailsCtx.layoutCtx, &SEARCH_ICON, CHOICE_DETAILS_TOKEN, TUNE_TAP_CASUAL);
3786 const char *subMessage,
3787 const char *confirmText,
3788 const char *cancelText,
3794 .centeredInfo.text1 = message,
3795 .centeredInfo.text2 = subMessage,
3796 .centeredInfo.text3 = NULL,
3798 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3799 .centeredInfo.offsetY = 0,
3800 .confirmationText = confirmText,
3801 .confirmationToken = CHOICE_TOKEN,
3802 .tuneId = TUNE_TAP_CASUAL,
3804 onModalConfirm = callback;
3805 if (modalPageContext != NULL) {
3823 const char *message,
3824 const char *actionText,
3829 reset_callbacks_and_context();
3831 onAction = callback;
3833 content.
tuneId = TUNE_TAP_CASUAL;
3856 const char *reviewTitle,
3857 const char *reviewSubTitle,
3858 const char *rejectText,
3863 .footerToken = QUIT_TOKEN,
3864 .tapActionText = NULL,
3865 .isSwipeable =
true,
3866 .tapActionToken = CONTINUE_TOKEN,
3868 .actionButtonText = NULL,
3869 .
tuneId = TUNE_TAP_CASUAL};
3871 reset_callbacks_and_context();
3879 onQuit = rejectCallback;
3880 onContinue = continueCallback;
3882#ifdef HAVE_PIEZO_SOUND
3884 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
3897 const char *rejectText,
3902 reset_callbacks_and_context();
3905 onChoice = choiceCallback;
3906 onNav = navCallback;
3907 onControls = buttonCallback;
3908 forwardNavOnly =
false;
3909 navType = REVIEW_NAV;
3913 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3915 displayReviewPage(initPage,
true);
3932 const char *rejectText,
3937 reset_callbacks_and_context();
3940 onChoice = callback;
3941 navType = GENERIC_NAV;
3945 genericContext.genericContents.contentsList = localContentsList;
3948 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3950 memcpy(&localContentsList[offset].content.tagValueList,
3957 memcpy(&localContentsList[offset].content.infoLongPress,
3963 genericContext.genericContents.nbContents = offset;
3966 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3968 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3970 displayGenericContextPage(0,
true);
3988 const char *rejectText,
3993 reset_callbacks_and_context();
3996 onChoice = callback;
3997 navType = GENERIC_NAV;
4000 genericContext.genericContents.contentsList = localContentsList;
4003 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
4005 memcpy(&localContentsList[offset].content.tagValueList,
4019 genericContext.genericContents.nbContents = offset;
4022 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4024 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
4026 displayGenericContextPage(0,
true);
4048 const char *reviewTitle,
4049 const char *reviewSubTitle,
4050 const char *finishTitle,
4053 reset_callbacks_and_context();
4055 useCaseReview(operationType,
4089 const char *reviewTitle,
4090 const char *reviewSubTitle,
4091 const char *finishTitle,
4102 &blindSigningWarning,
4131 const char *reviewTitle,
4132 const char *reviewSubTitle,
4133 const char *finishTitle,
4138 reset_callbacks_and_context();
4141 if (tipBox != NULL) {
4142 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
4145 if ((warning == NULL)
4148 useCaseReview(operationType,
4161 operationType |= NO_THREAT_OPERATION;
4164 operationType |= RISKY_OPERATION;
4166 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4167 reviewWithWarnCtx.isStreaming =
false;
4168 reviewWithWarnCtx.operationType = operationType;
4169 reviewWithWarnCtx.tagValueList = tagValueList;
4170 reviewWithWarnCtx.icon = icon;
4171 reviewWithWarnCtx.reviewTitle = reviewTitle;
4172 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4173 reviewWithWarnCtx.finishTitle = finishTitle;
4174 reviewWithWarnCtx.warning = warning;
4175 reviewWithWarnCtx.choiceCallback = choiceCallback;
4178 if (reviewWithWarnCtx.warning->prelude) {
4183 displayInitialWarning();
4186 useCaseReview(operationType,
4218 const char *reviewTitle,
4219 const char *reviewSubTitle,
4220 const char *finishTitle,
4223 reset_callbacks_and_context();
4225 useCaseReview(operationType,
4246 const char *rejectText,
4249 reset_callbacks_and_context();
4252 onQuit = rejectCallback;
4253 navType = GENERIC_NAV;
4260 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4261 prepareNavInfo(
true, nbPages, rejectText);
4264#ifdef HAVE_PIEZO_SOUND
4266 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4269 displayGenericContextPage(0,
true);
4286 const char *reviewTitle,
4287 const char *reviewSubTitle,
4290 reset_callbacks_and_context();
4292 useCaseReviewStreamingStart(
4293 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4311 const char *reviewTitle,
4312 const char *reviewSubTitle,
4316 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
4336 const char *reviewTitle,
4337 const char *reviewSubTitle,
4341 reset_callbacks_and_context();
4344 if ((warning == NULL)
4347 useCaseReviewStreamingStart(
4348 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4352 operationType |= NO_THREAT_OPERATION;
4355 operationType |= RISKY_OPERATION;
4358 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4359 reviewWithWarnCtx.isStreaming =
true;
4360 reviewWithWarnCtx.operationType = operationType;
4361 reviewWithWarnCtx.icon = icon;
4362 reviewWithWarnCtx.reviewTitle = reviewTitle;
4363 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4364 reviewWithWarnCtx.choiceCallback = choiceCallback;
4365 reviewWithWarnCtx.warning = warning;
4368 if (reviewWithWarnCtx.warning->prelude) {
4373 displayInitialWarning();
4376 useCaseReviewStreamingStart(
4377 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4399 memset(&genericContext, 0,
sizeof(genericContext));
4401 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4402 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
4405 onChoice = bundleNavReviewStreamingChoice;
4406 navType = STREAMING_NAV;
4409 genericContext.genericContents.contentsList = localContentsList;
4410 genericContext.genericContents.nbContents = 1;
4419 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4420 &genericContext.genericContents,
4423 prepareNavInfo(
true,
4425 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4433 displayGenericContextPage(0,
true);
4464 memset(&genericContext, 0,
sizeof(genericContext));
4466 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4469 onChoice = bundleNavReviewStreamingChoice;
4470 navType = STREAMING_NAV;
4473 genericContext.genericContents.contentsList = localContentsList;
4474 genericContext.genericContents.nbContents = 1;
4479 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
4480 &STARTING_CONTENT.content.infoLongPress,
4481 bundleNavContext.reviewStreaming.icon,
4485 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4486 &genericContext.genericContents,
4489 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4491 displayGenericContextPage(0,
true);
4502 reset_callbacks_and_context();
4503 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4506 onChoice = callback;
4507 navType = GENERIC_NAV;
4510 genericContext.genericContents.contentsList = localContentsList;
4511 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
4513 prepareAddressConfirmationPages(
4514 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
4517 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4519 prepareNavInfo(
true, nbPages,
"Cancel");
4521#ifdef HAVE_PIEZO_SOUND
4523 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4526 displayGenericContextPage(0,
true);
4548 const char *reviewTitle,
4549 const char *reviewSubTitle,
4552 reset_callbacks_and_context();
4555 if (addressConfirmationContext.modalLayout) {
4558 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4561 onChoice = choiceCallback;
4562 navType = GENERIC_NAV;
4566 genericContext.genericContents.contentsList = localContentsList;
4571 prepareReviewFirstPage(
4572 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4573 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4576 prepareAddressConfirmationPages(
4577 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4580 genericContext.genericContents.nbContents
4582 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4584 prepareNavInfo(
true, nbPages,
"Cancel");
4586#ifdef HAVE_PIEZO_SOUND
4588 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4591 displayGenericContextPage(0,
true);
4605 if (genericContext.type != USE_CASE_SPINNER) {
4606 memset(&genericContext, 0,
sizeof(genericContext));
4607 genericContext.type = USE_CASE_SPINNER;
4612 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4615 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4622 genericContext.spinnerPosition++;
4625 genericContext.spinnerPosition = 0;
4628 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4632 else if (ret == 2) {
4667 .separationLine =
true,
4668 .backAndText.token = BACK_TOKEN,
4669 .backAndText.tuneId = TUNE_TAP_CASUAL};
4676 reset_callbacks_and_context();
4678 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
4681 onQuit = backCallback;
4685 layoutDescription.
modal =
false;
4688 keypadContext.hidden = hidden;
4700 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
4706 keypadContext.onValidatePin = validatePinCallback;
4708 keypadContext.pinMinDigits = minDigits;
4709 keypadContext.pinMaxDigits = maxDigits;
4748 .backAndText.token = BACK_TOKEN,
4749 .backAndText.tuneId = TUNE_TAP_CASUAL};
4752 .mode = params->
mode,
4753 .casing = params->
casing};
4757 reset_callbacks_and_context();
4759 memset(&keyboardContext, 0,
sizeof(KeyboardContext_t));
4762 onQuit = backCallback;
4775 keyboardContext.keyboardIndex = status;
4776 keyboardContext.casing = params->
casing;
4777 keyboardContext.entryBuffer = PIC(params->
entryBuffer);
4778 keyboardContext.entryMaxLen = params->
entryMaxLen;
4779 keyboardContext.entryBuffer[0] =
'\0';
4782 .type = params->
type,
4783 .title = PIC(params->
title),
4785 .number = params->
number,
4786 .text = keyboardContext.entryBuffer,
4787 .textToken = KEYBOARD_CROSS_TOKEN,
4788 .tuneId = TUNE_TAP_CASUAL,
4790 switch (params->
type) {
4795 .token = KEYBOARD_BUTTON_TOKEN,
4801 keyboardContext.getSuggestionButtons
4812 &keyboardContext.keyboardContent);
nbgl_contentTagValue_t *(* nbgl_contentTagValueCallback_t)(uint8_t pairIndex)
prototype of tag/value pair retrieval callback
@ ICON_ILLUSTRATION
simple icon
@ LARGE_CASE_INFO
text in BLACK and large case (INTER 32px), subText in black in Inter24px
@ INFO_LONG_PRESS
a centered info and a long press button
@ EXTENDED_CENTER
a centered content and a possible tip-box
@ CHOICES_LIST
list of choices through radio buttons
@ CENTERED_INFO
a centered info
@ SWITCHES_LIST
list of switches with descriptions
@ TAG_VALUE_DETAILS
a tag/value pair and a small button to get details.
@ INFOS_LIST
list of infos with titles
@ TAG_VALUE_CONFIRM
tag/value pairs and a black button/footer to confirm/cancel.
@ TAG_VALUE_LIST
list of tag/value pairs
@ BARS_LIST
list of touchable bars (with > on the right to go to sub-pages)
@ INFO_BUTTON
a centered info and a simple black button
@ INFO_LIST_ALIAS
alias is list of infos
@ ENS_ALIAS
alias comes from ENS
@ ADDRESS_BOOK_ALIAS
alias comes from Address Book
@ QR_CODE_ALIAS
alias is an address to be displayed as a QR Code
void(* nbgl_contentActionCallback_t)(int token, uint8_t index, int page)
prototype of function to be called when an action on a content object occurs
#define LOG_DEBUG(__logger,...)
bool nbgl_getTextMaxLenInNbLines(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, uint16_t maxNbLines, uint16_t *len, bool wrapping)
void nbgl_textReduceOnNbLines(nbgl_font_id_e fontId, const char *origText, uint16_t maxWidth, uint8_t nbLines, char *reducedText, uint16_t reducedTextLen)
uint16_t nbgl_getTextHeightInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
uint16_t nbgl_getTextNbLinesInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
uint8_t nbgl_getFontLineHeight(nbgl_font_id_e fontId)
void(* nbgl_layoutTouchCallback_t)(int token, uint8_t index)
prototype of function to be called when an object is touched
int nbgl_layoutAddContentCenter(nbgl_layout_t *layout, const nbgl_contentCenter_t *info)
Creates an area on the center of the main panel, with a possible icon, and possible texts under it.
int nbgl_layoutUpdateKeyboard(nbgl_layout_t *layout, uint8_t index, uint32_t keyMask, bool updateCasing, keyboardCase_t casing)
Updates an existing keyboard on bottom of the screen, with the given configuration.
int nbgl_layoutAddKeyboard(nbgl_layout_t *layout, const nbgl_layoutKbd_t *kbdInfo)
Creates a keyboard on bottom of the screen, with the given configuration.
int nbgl_layoutUpdateKeypad(nbgl_layout_t *layout, uint8_t index, bool enableValidate, bool enableBackspace, bool enableDigits)
Updates an existing keypad on bottom of the screen, with the given configuration.
int nbgl_layoutAddKeyboardContent(nbgl_layout_t *layout, nbgl_layoutKeyboardContent_t *content)
Adds an area containing a potential title, a text entry and either confirmation or suggestion buttons...
int nbgl_layoutAddSeparationLine(nbgl_layout_t *layout)
adds a separation line on bottom of the last added item
int nbgl_layoutAddQRCode(nbgl_layout_t *layout, const nbgl_layoutQRCode_t *info)
Creates an area on the center of the main panel, with a QRCode, a possible text in black (bold) under...
int nbgl_layoutDraw(nbgl_layout_t *layout)
Applies given layout. The screen will be redrawn.
int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout)
Creates a touchable bar in main panel.
@ WHITE_BACKGROUND
rounded bordered button, with text/icon in black, on white background
@ BLACK_BACKGROUND
rounded bordered button, with text/icon in white, on black background
int nbgl_layoutAddTopRightButton(nbgl_layout_t *layout, const nbgl_icon_details_t *icon, uint8_t token, tune_index_e tuneId)
Creates a Top-right button in the top right corner of the top panel.
int nbgl_layoutAddTextContent(nbgl_layout_t *layout, nbgl_layoutTextContent_t *content)
Creates in the main container three text areas:
void * nbgl_layout_t
type shared externally
@ HEADER_EMPTY
empty space, to have a better vertical centering of centered info
@ HEADER_BACK_AND_TEXT
back key and optional text
int nbgl_layoutUpdateKeyboardContent(nbgl_layout_t *layout, nbgl_layoutKeyboardContent_t *content)
Updates an area containing a potential title, a text entry and either confirmation or suggestion butt...
int nbgl_layoutAddKeypadContent(nbgl_layout_t *layout, const char *title, bool hidden, uint8_t nbDigits, const char *text)
Adds an area with a title and a placeholder for hidden digits on top of a keypad, to represent the en...
#define NBGL_INVALID_TOKEN
int nbgl_layoutUpdateKeypadContent(nbgl_layout_t *layout, bool hidden, uint8_t nbActiveDigits, const char *text)
Updates an existing set of hidden digits, with the given configuration.
nbgl_layout_t * nbgl_layoutGet(const nbgl_layoutDescription_t *description)
returns a layout of the given type. The layout is reset
int nbgl_layoutAddExtendedFooter(nbgl_layout_t *layout, const nbgl_layoutFooter_t *footerDesc)
Creates a touchable area at the footer of the screen, containing various controls,...
@ ROUNDED_AND_FOOTER_STYLE
A black background button on top of a footer.
int nbgl_layoutAddChoiceButtons(nbgl_layout_t *layout, const nbgl_layoutChoiceButtons_t *info)
Creates two buttons to make a choice. Both buttons are mandatory. Both buttons are full width,...
int nbgl_layoutAddSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t initPosition)
Creates a centered (vertically & horizontally) spinner with a text under it.
int nbgl_layoutUpdateSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t position)
Update an existing spinner (must be the only object of the layout)
#define NBGL_NO_PROGRESS_INDICATOR
To be used when a control token shall not be used.
int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc)
Creates a touchable (or not) area at the header of the screen, containing various controls,...
@ KEYBOARD_WITH_BUTTON
text entry area + confirmation button
@ KEYBOARD_WITH_SUGGESTIONS
text entry area + suggestion buttons
#define TAG_VALUE_INTERVALE
@ FOOTER_EMPTY
empty space, to have a better vertical centering of centered info
int nbgl_layoutRelease(nbgl_layout_t *layout)
Release the layout obtained with nbgl_layoutGet()
int nbgl_layoutAddFooter(nbgl_layout_t *layout, const char *text, uint8_t token, tune_index_e tuneId)
Creates a touchable text at the footer of the screen, separated with a thin line from the rest of the...
int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled)
Adds a keypad on bottom of the screen, with the associated callback.
#define NB_SPINNER_POSITIONS
keyboardCase_t
Letters casing in which to open/set the keyboard.
#define KEYPAD_MAX_DIGITS
void nbgl_refreshSpecial(nbgl_refresh_mode_t mode)
void nbgl_refreshSpecialWithPostRefresh(nbgl_refresh_mode_t mode, nbgl_post_refresh_t post_refresh)
nbgl_page_t * nbgl_pageDrawGenericContent(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content)
draw a generic content page, with the given content, and if nav parameter is not NULL,...
nbgl_page_t * nbgl_pageDrawInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const nbgl_pageInfoDescription_t *info)
draw a page with a centered info (icon and/or texts) with a touchable footer, in a potential "tapable...
void * nbgl_page_t
type shared externally
@ NAV_WITH_BUTTONS
move forward and backward with buttons in bottom nav bar
nbgl_page_t * nbgl_pageDrawConfirmation(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageConfirmationDescription_t *info)
draw a confirmation page, with a centered info (icon and/or text), a button to confirm and a footer t...
int nbgl_pageRelease(nbgl_page_t *)
Release the page obtained with any of the nbgl_pageDrawXXX() functions.
nbgl_page_t * nbgl_pageDrawGenericContentExt(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content, bool modal)
draw a generic content page, with the given content, and if nav parameter is not NULL,...
@ QUIT_APP_TEXT
A full width button with "Quit app" text (only for bottom button)
@ INFO_ICON
info (i) icon in the button.
@ NO_BUTTON_STYLE
no button.
@ SETTINGS_ICON
settings (wheel) icon in the button.
struct PACKED__ nbgl_screenTickerConfiguration_s nbgl_screenTickerConfiguration_t
struct to configure a screen layer
void nbgl_screenRedraw(void)
@ POST_REFRESH_FORCE_POWER_ON
Force screen power on after refresh.
struct PACKED__ nbgl_icon_details_s nbgl_icon_details_t
Represents all information about an icon.
nbgl_refresh_mode_t
different modes of refresh for nbgl_refreshSpecial()
@ BLACK_AND_WHITE_REFRESH
to be used for pure B&W area, when contrast is important
@ FULL_COLOR_CLEAN_REFRESH
to be used for lock screen display (cleaner but longer refresh)
@ BLACK_AND_WHITE_FAST_REFRESH
to be used for pure B&W area, when contrast is not priority
@ FULL_COLOR_PARTIAL_REFRESH
to be used for small partial refresh (radio buttons, switches)
@ FULL_COLOR_REFRESH
to be used for normal refresh
API of the Advanced BOLOS Graphical Library, for typical application use-cases.
DEPRECATED void nbgl_useCaseHome(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
#define NB_MAX_LINES_IN_REVIEW
maximum number of lines for value field in review pages
@ NO_TYPE_WARNING
Invalid type (to use for bars leading to nothing)
@ CENTERED_INFO_WARNING
Centered info.
@ BAR_LIST_WARNING
list of touchable bars, to display sub-pages
DEPRECATED void nbgl_useCaseSettings(const char *settingsTitle, uint8_t initPage, uint8_t nbPages, bool touchableTitle, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
uint8_t nbgl_useCaseGetNbTagValuesInPageExt(uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool isSkippable, bool *requireSpecificDisplay)
void(* nbgl_callback_t)(void)
prototype of generic callback function
#define SKIPPABLE_OPERATION
This is to use in nbgl_operationType_t when the operation is skippable. This is used.
void nbgl_useCaseGenericSettings(const char *appName, uint8_t initPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, nbgl_callback_t quitCallback)
uint32_t nbgl_operationType_t
This mask is used to describe the type of operation to review with additional options It is a mask of...
void nbgl_useCaseReview(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseAction(const nbgl_icon_details_t *icon, const char *message, const char *actionText, nbgl_callback_t callback)
uint8_t nbgl_useCaseGetNbTagValuesInPage(uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool *requireSpecificDisplay)
uint8_t nbgl_useCaseGetNbPagesForTagValueList(const nbgl_contentTagValueList_t *tagValueList)
DEPRECATED void nbgl_useCaseRegularReview(uint8_t initPage, uint8_t nbPages, const char *rejectText, nbgl_layoutTouchCallback_t buttonCallback, nbgl_navCallback_t navCallback, nbgl_choiceCallback_t choiceCallback)
void(* nbgl_pinValidCallback_t)(const uint8_t *pin, uint8_t pinLen)
prototype of pin validation callback function
void nbgl_useCaseReviewStreamingStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseHomeAndSettings(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, const uint8_t initSettingPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, const nbgl_homeAction_t *action, nbgl_callback_t quitCallback)
void nbgl_useCaseStaticReviewLight(const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
uint8_t nbgl_useCaseGetNbInfosInPage(uint8_t nbInfos, const nbgl_contentInfoList_t *infosList, uint8_t startIndex, bool withNav)
void(* nbgl_choiceCallback_t)(bool confirm)
prototype of choice callback function
uint8_t nbgl_useCaseGetNbBarsInPage(uint8_t nbBars, const nbgl_contentBarsList_t *barsList, uint8_t startIndex, bool withNav)
void nbgl_useCaseNavigableContent(const char *title, uint8_t initPage, uint8_t nbPages, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
#define INFOS_AREA_HEIGHT
height available for infos pairs display
@ STRONG_HOME_ACTION
Black button, implicating the main action of the App.
void nbgl_useCaseReviewStreamingFinish(const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseChoiceWithDetails(const nbgl_icon_details_t *icon, const char *message, const char *subMessage, const char *confirmText, const char *cancelText, nbgl_warningDetails_t *details, nbgl_choiceCallback_t callback)
void nbgl_useCaseSpinner(const char *text)
void nbgl_useCaseConfirm(const char *message, const char *subMessage, const char *confirmText, const char *rejectText, nbgl_callback_t callback)
#define NB_MAX_LINES_IN_DETAILS
maximum number of lines for value field in details pages
void nbgl_useCaseReviewStart(const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *rejectText, nbgl_callback_t continueCallback, nbgl_callback_t rejectCallback)
DEPRECATED void nbgl_useCaseHomeExt(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, const char *actionButtonText, nbgl_callback_t actionCallback, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
#define APP_DESCRIPTION_MAX_LEN
Length of buffer used for the default Home tagline.
void nbgl_useCaseStatus(const char *message, bool isSuccess, nbgl_callback_t quitCallback)
@ W3C_THREAT_DETECTED_WARN
Web3 Checks: Threat detected (see reportRisk field)
@ W3C_ISSUE_WARN
Web3 Checks issue (not available)
@ BLIND_SIGNING_WARN
Blind signing.
@ GATED_SIGNING_WARN
Gated signing.
@ W3C_NO_THREAT_WARN
Web3 Checks: No Threat detected.
@ W3C_RISK_DETECTED_WARN
Web3 Checks: Risk detected (see reportRisk field)
DEPRECATED void nbgl_useCaseAddressConfirmationExt(const char *address, nbgl_choiceCallback_t callback, const nbgl_contentTagValueList_t *tagValueList)
void nbgl_useCaseGenericConfiguration(const char *title, uint8_t initPage, const nbgl_genericContents_t *contents, nbgl_callback_t quitCallback)
#define INIT_HOME_PAGE
Value to pass to nbgl_useCaseHomeAndSettings() initSettingPage parameter to initialize the use case o...
void nbgl_useCaseKeypad(const char *title, uint8_t minDigits, uint8_t maxDigits, bool shuffled, bool hidden, nbgl_pinValidCallback_t validatePinCallback, nbgl_callback_t backCallback)
void nbgl_useCaseReviewStreamingContinueExt(const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback, nbgl_callback_t skipCallback)
void nbgl_useCaseReviewBlindSigning(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseChoice(const nbgl_icon_details_t *icon, const char *message, const char *subMessage, const char *confirmText, const char *rejectString, nbgl_choiceCallback_t callback)
#define FIRST_USER_TOKEN
when using controls in page content (nbgl_pageContent_t), this is the first token value usable for th...
#define TAG_VALUE_AREA_HEIGHT
height available for tag/value pairs display
#define BLIND_OPERATION
This is to use in nbgl_operationType_t when the operation is "blind" This is used to indicate a warni...
#define TAGLINE_PART1
Default strings used in the Home tagline.
void nbgl_useCaseGenericReview(const nbgl_genericContents_t *contents, const char *rejectText, nbgl_callback_t rejectCallback)
#define STATUS_SCREEN_DURATION
void nbgl_useCaseKeyboard(const nbgl_keyboardParams_t *params, nbgl_callback_t backCallback)
void nbgl_useCaseStaticReview(const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
void nbgl_useCaseReviewStreamingBlindSigningStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseReviewStreamingContinue(const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseReviewLight(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
uint8_t nbgl_useCaseGetNbChoicesInPage(uint8_t nbChoices, const nbgl_contentRadioChoice_t *choicesList, uint8_t startIndex, bool withNav)
void(* nbgl_keyboardButtonsCallback_t)(nbgl_layoutKeyboardContent_t *content, uint32_t *mask)
prototype of keyboard buttons callback function
#define REAL_TYPE_MASK
This is the mask to apply on nbgl_operationType_t to get the real type provided by app.
void nbgl_useCaseReviewStatus(nbgl_reviewStatusType_t reviewStatusType, nbgl_callback_t quitCallback)
#define LAST_PAGE_FOR_REVIEW
value of page parameter used with navigation callback when "skip" button is touched,...
nbgl_reviewStatusType_t
The different types of review status.
@ STATUS_TYPE_TRANSACTION_REJECTED
@ STATUS_TYPE_ADDRESS_REJECTED
@ STATUS_TYPE_TRANSACTION_SIGNED
@ STATUS_TYPE_OPERATION_REJECTED
@ STATUS_TYPE_OPERATION_SIGNED
@ STATUS_TYPE_ADDRESS_VERIFIED
@ STATUS_TYPE_MESSAGE_SIGNED
@ STATUS_TYPE_MESSAGE_REJECTED
bool(* nbgl_navCallback_t)(uint8_t page, nbgl_pageContent_t *content)
prototype of navigation callback function
#define MAX_APP_NAME_FOR_SDK_TAGLINE
Max supported length of appName used for the default Home tagline.
#define HAS_INITIAL_WARNING(_warning)
void nbgl_useCaseAddressReview(const char *address, const nbgl_contentTagValueList_t *additionalTagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
@ TYPE_TRANSACTION
For operations transferring a coin or taken from an account to another.
@ TYPE_OPERATION
For other types of operation (generic type)
void nbgl_useCaseAdvancedReviewStreamingStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseAdvancedReview(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
uint8_t nbgl_useCaseGetNbSwitchesInPage(uint8_t nbSwitches, const nbgl_contentSwitchesList_t *switchesList, uint8_t startIndex, bool withNav)
This structure contains data to build a BARS_LIST content.
const uint8_t * tokens
array of tokens, one for each bar (nbBars items)
const char *const * barTexts
array of texts for each bar (nbBars items, in black/bold)
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when a bar is touched
uint8_t nbBars
number of elements in barTexts and tokens array
This structure contains info to build a centered (vertically and horizontally) area,...
uint16_t iconHug
vertical margin to apply on top and bottom of the icon
const nbgl_icon_details_t * icon
the icon (can be null)
const char * title
title in black large (can be null)
const char * description
description in black small regular case (can be null)
const char * subText
sub-text in dark gray regular small case
bool padding
if true, apply a padding of 40px at the bottom
const char * smallTitle
sub-title in black small bold case (can be null)
nbgl_contentIllustrationType_t illustrType
const char * text2
second text (can be null)
const char * text1
first text (can be null)
nbgl_contentCenteredInfoStyle_t style
style to apply to this info
int16_t offsetY
vertical shift to apply to this info (if >0, shift to bottom)
const char * text3
third text (can be null)
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
nbgl_contentCenter_t contentCenter
centered content (icon + text(s))
This structure contains data to build a centered info + simple black button content.
const char * buttonText
text of the long press button
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
const char * text
centered text in large case
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is touched
This structure contains data to build a INFOS_LIST content.
const char *const * infoContents
array of contents of infos (in black)
const char *const * infoTypes
array of types of infos (in black/bold)
const nbgl_contentValueExt_t * infoExtensions
uint8_t nbInfos
number of elements in infoTypes and infoContents array
This structure contains data to build a centered info + long press button content.
const char * longPressText
text of the long press button
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
const char * text
centered text in large case
This structure contains a list of names to build a list of radio buttons (on the right part of screen...
uint8_t initChoice
index of the current choice
const char *const * names
array of strings giving the choices (nbChoices)
uint8_t nbChoices
number of choices
This structure contains info to build a switch (on the right) with a description (on the left),...
const char * text
main text for the switch
const char * subText
description under main text (NULL terminated, single line, may be null)
This structure contains [item,value] pair(s) and info about a potential "details" button,...
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when details button is touched
const char * confirmationText
text of the confirmation button, if NULL "It matches" is used
uint8_t detailsButtonToken
uint8_t confirmationToken
the token used as argument of the onActionCallback
nbgl_contentTagValueList_t tagValueList
list of tag/value pairs
const char * detailsButtonText
this text is used for "details" button (if NULL, no button)
const nbgl_icon_details_t * detailsButtonIcon
icon to use in details button
const nbgl_icon_details_t * detailsButtonIcon
icon to use in details button
uint8_t detailsButtonToken
const char * detailsButtonText
this text is used for "details" button
nbgl_contentTagValueList_t tagValueList
list of tag/value pairs
This structure contains a list of [tag,value] pairs.
const nbgl_contentTagValue_t * pairs
array of [tag,value] pairs (nbPairs items). If NULL, callback is used instead
nbgl_contentTagValueCallback_t callback
function to call to retrieve a given pair
uint8_t nbMaxLinesForValue
if > 0, set the max number of lines for value field.
bool hideEndOfLastLine
if set to true, replace 3 last chars of last line by "..."
bool wrapping
if set to true, value text will be wrapped on ' ' to avoid cutting words
uint8_t startIndex
index of the first pair to get with callback
nbgl_contentActionCallback_t actionCallback
called when a valueIcon is touched on a given pair
This structure contains a [tag,value] pair and possible extensions.
const nbgl_contentValueExt_t * extension
if not NULL, gives additional info on value field
const nbgl_icon_details_t * valueIcon
int8_t centeredInfo
if set to 1, the tag will be displayed as a centered info
const char * value
string giving the value name
const char * item
string giving the tag name
This structure contains additions to a tag/value pair, to be able to build a screen to display these ...
const char * fullValue
full string of the value when used as an alias
nbgl_contentValueAliasType_t aliasType
type of alias
const struct nbgl_contentTagValueList_s * tagValuelist
if aliasType is TAG_VALUE_LIST_ALIAS
const char * backText
used as title of the popping page, if not NULL, otherwise "item" is used
const char * aliasSubName
string displayed under alias and in details view
const struct nbgl_contentInfoList_s * infolist
if aliasType is INFO_LIST_ALIAS
This structure contains data to build a content.
nbgl_contentActionCallback_t contentActionCallback
callback to be called when an action on an object occurs
nbgl_contentType_t type
type of page content in the content union
const struct nbgl_genericDetails_s * details
array of nbBars structures giving what to display when each bar is touched.
uint8_t nbBars
number of touchable bars
const nbgl_icon_details_t ** icons
array of icons for each bar (nbBars items)
const char *const * subTexts
array of texts for each bar (nbBars items, in black)
const char *const * texts
array of texts for each bar (nbBars items, in black/bold)
uint8_t nbContents
number of contents
const nbgl_content_t * contentsList
array of nbgl_content_t (nbContents items).
nbgl_contentCallback_t contentGetterCallback
function to call to retrieve a given content
The necessary parameters to build the page(s) displayed when the top-right button is touched in intro...
const char * title
text of the page (used to go back)
nbgl_genericBarList_t barList
touchable bars list, if type == BAR_LIST_WARNING
nbgl_layoutQRCode_t qrCode
QR code, if type == QRCODE_WARNING.
nbgl_genericDetailsType_t type
type of content in the page, determining what to use in the following union
nbgl_contentCenter_t centeredInfo
centered info, if type == CENTERED_INFO_WARNING
Structure describing the action button in Home Screen.
const nbgl_icon_details_t * icon
icon to use in action button in Home page
nbgl_callback_t callback
function to call when action button is touched in Home page
const char * text
text to use in action button in Home page
nbgl_homeActionStyle_t style
style of action button
nbgl_keyboardButtonsCallback_t updateButtonsCallback
callback to call when a key is pressed to update suggestions
nbgl_layoutTouchCallback_t onButtonCallback
callback to call when one of the buttons is pressed
const char ** buttons
array of strings for buttons (last ones can be NULL)
int firstButtonToken
first token used for buttons, provided in onButtonCallback
Structure containing all parameters for keyboard use case.
keyboardMode_t mode
keyboard mode to start with
nbgl_kbdSuggestParams_t suggestionParams
nbgl_kbdButtonParams_t confirmationParams
used if type is KEYBOARD_WITH_SUGGESTIONS
bool lettersOnly
if true, only display letter keys and Backspace
uint8_t entryMaxLen
maximum length of text that can be entered
nbgl_layoutKeyboardContentType_t type
type of content
bool numbered
if set to true, the text is preceded on the left by 'number.'
keyboardCase_t casing
keyboard casing mode (lower, upper once or upper locked)
const char * title
centered title explaining the screen
char * entryBuffer
already entered text
uint8_t number
if numbered is true, number used to build 'number.' text
This structure contains info to build a clickable "bar" with a text and an icon.
bool inactive
if set to true, the bar is grayed-out and cannot be touched
const char * text
text (can be NULL)
uint8_t token
the token that will be used as argument of the callback
bool large
set to true only for the main level of OS settings
const char * subText
sub text (can be NULL)
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const nbgl_icon_details_t * iconLeft
a buffer containing the 1BPP icon for icon on left (can be NULL)
const nbgl_icon_details_t * iconRight
Structure containing all information when creating a layout. This structure must be passed as argumen...
nbgl_screenTickerConfiguration_t ticker
const char * tapActionText
Light gray text used when main container is "tapable".
nbgl_layoutTouchCallback_t onActionCallback
the callback to be called on any action on the layout
This structure contains info to build a keyboard with nbgl_layoutAddKeyboard()
keyboardCallback_t callback
function called when an active key is pressed
This structure contains info to build a keyboard content (controls that are linked to keyboard)
This structure contains info to build a centered (vertically and horizontally) area,...
const char * text2
second text (can be null)
const char * url
URL for QR code.
This structure contains info for Text content, to be set with nbgl_layoutAddTextContent.
const char * descriptions[NB_MAX_DESCRIPTIONS]
uint8_t nbDescriptions
number of used descriptions in above array
const char * info
description at bottom (in small gray)
const char * title
main text (in large bold font)
Structure containing all specific information when creating a confirmation page.
const char * cancelText
the text used for cancel action, if NULL a simple X button is used
uint8_t confirmationToken
the token used as argument of the onActionCallback
const char * confirmationText
text of the confirmation button
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is pressed
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent)
nbgl_contentTagValueDetails_t tagValueDetails
TAG_VALUE_DETAILS type
const char * title
text for the title of the page (if NULL, no title)
uint8_t topRightToken
token used when top-right button (if not NULL) is touched
nbgl_contentInfoLongPress_t infoLongPress
INFO_LONG_PRESS type
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when title is touched
nbgl_contentBarsList_t barsList
BARS_LIST type
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
nbgl_contentInfoList_t infosList
INFOS_LIST type
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
const nbgl_icon_details_t * topRightIcon
nbgl_contentType_t type
type of page content in the following union
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
nbgl_contentTagValueConfirm_t tagValueConfirm
TAG_VALUE_CONFIRM type
bool isTouchableTitle
if set to true, the title is preceded by <- arrow to go back
nbgl_contentExtendedCenter_t extendedCenter
EXTENDED_CENTER type
Structure containing all specific information when creating an information page.
nbgl_layoutButtonStyle_t actionButtonStyle
style of "action" button
const char * actionButtonText
if not NULL an "action" button is set under the centered info
const char * tapActionText
uint8_t bottomButtonsToken
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button/footer is pressed
const nbgl_icon_details_t * actionButtonIcon
potential icon of "action" button
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
Structure containing all specific information when creating a multi-screens page.
uint8_t nbPages
the number of pages to display (if <2, no navigation bar)
uint8_t quitToken
the token used as argument of the actionCallback when the footer is touched
uint8_t skipToken
if skipText is NULL the token used when right part of footer is touched
nbgl_pageNavigationType_t navType
uint8_t activePage
the index of the page to display at start-up
bool progressIndicator
if set to true, display a progress indicator on top of the page
nbgl_pageNavWithButtons_t navWithButtons
structure used when navigation with buttons
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when next or back is pressed
bool visiblePageIndicator
if set to true, the page indicator will be visible in navigation
const char * quitText
the text displayed in footer (on the left), used to quit (only on Flex)
bool backButton
if set to true, a back button (<-) is displayed in the nav bar
This structure contains data to build a SWITCHES_LIST content.
uint8_t nbSwitches
number of elements in switches and tokens array
const nbgl_contentSwitch_t * switches
array of switches (nbSwitches items)
The necessary parameters to build a tip-box in first review page and the modal if this tip box is tou...
const char * text
text of the tip-box
const nbgl_icon_details_t * icon
icon of the tip-box
The necessary parameters to build a warning page preceding a review. One can either use predefinedSet...
const nbgl_preludeDetails_t * prelude
if not null, means that the review can start by a prelude
const nbgl_warningDetails_t * introDetails
const nbgl_warningDetails_t * reviewDetails
Union of the different type of contents.
nbgl_contentInfoList_t infosList
INFOS_LIST type
nbgl_contentInfoLongPress_t infoLongPress
INFO_LONG_PRESS type
nbgl_contentTagValueConfirm_t tagValueConfirm
TAG_VALUE_CONFIRM type
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
nbgl_contentBarsList_t barsList
BARS_LIST type
nbgl_contentExtendedCenter_t extendedCenter
EXTENDED_CENTER type
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type