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 reviewWithWarnCtx sharedContext.reviewWithWarning
59#define choiceWithDetailsCtx sharedContext.choiceWithDetails
62#define W3C_DESCRIPTION_MAX_LEN 128
69#define RISKY_OPERATION (1 << 6)
76#define NO_THREAT_OPERATION (1 << 7)
89 ADDRESS_QRCODE_BUTTON_TOKEN,
100 CHOICE_DETAILS_TOKEN,
102 QUIT_TIPBOX_MODAL_TOKEN,
103 WARNING_CHOICE_TOKEN,
105 DISMISS_WARNING_TOKEN,
106 DISMISS_DETAILS_TOKEN,
107 PRELUDE_CHOICE_TOKEN,
108 FIRST_WARN_BAR_TOKEN,
119typedef struct DetailsContext_s {
122 uint8_t currentPairIdx;
126 const char *nextPageStart;
129typedef struct AddressConfirmationContext_s {
133} AddressConfirmationContext_t;
136typedef struct KeypadContext_s {
139 uint8_t pinMinDigits;
140 uint8_t pinMaxDigits;
146typedef struct ReviewWithWarningContext_s {
151 const char *reviewTitle;
152 const char *reviewSubTitle;
153 const char *finishTitle;
158 uint8_t securityReportLevel;
160} ReviewWithWarningContext_t;
162typedef struct ChoiceWithDetailsContext_s {
167} ChoiceWithDetailsContext_t;
171 SHARE_CTX_REVIEW_WITH_WARNING,
172 SHARE_CTX_CHOICE_WITH_DETAILS,
173} SharedContextUsage_t;
180 KeypadContext_t keypad;
182 ReviewWithWarningContext_t reviewWithWarning;
183 ChoiceWithDetailsContext_t choiceWithDetails;
185 SharedContextUsage_t usage;
189 USE_CASE_GENERIC = 0,
191} GenericContextType_t;
194 GenericContextType_t type;
195 uint8_t spinnerPosition;
197 int8_t currentContentIdx;
198 uint8_t currentContentElementNb;
199 uint8_t currentElementIdx;
200 bool hasStartingContent;
201 bool hasFinishingContent;
202 const char *detailsItem;
203 const char *detailsvalue;
204 bool detailsWrapping;
205 bool validWarningCtx;
215 SharedContext_t sharedCtx;
226} nbgl_homeAndSettingsContext_t;
231} nbgl_reviewContext_t;
239} nbgl_reviewStreamingContext_t;
242 nbgl_homeAndSettingsContext_t homeAndSettings;
243 nbgl_reviewContext_t review;
244 nbgl_reviewStreamingContext_t reviewStreaming;
245} nbgl_BundleNavContext_t;
251} SecurityReportItem_t;
258static char tmpString[W3C_DESCRIPTION_MAX_LEN];
278static const char *pageTitle;
281#define activeTipBox genericContext.tipBox
285static bool forwardNavOnly;
286static NavType_t navType;
288static DetailsContext_t detailsContext;
291static AddressConfirmationContext_t addressConfirmationContext;
294static GenericContext_t genericContext;
296 localContentsList[3];
297static uint8_t genericContextPagesInfo[MAX_PAGE_NB / PAGES_PER_UINT8];
298static uint8_t modalContextPagesInfo[MAX_MODAL_PAGE_NB / PAGES_PER_UINT8];
301static nbgl_BundleNavContext_t bundleNavContext;
304static const uint8_t nbMaxElementsPerContentType[] = {
321 .icon = &WARNING_ICON,
322 .text =
"Blind signing required",
323 .subText =
"This transaction's details are not fully verifiable. If "
324 "you sign, you could lose all your assets."
327 .icon = &WARNING_ICON,
328 .text =
"Transaction Check unavailable",
332 .icon = &WARNING_ICON,
333 .text =
"Risk detected",
334 .subText =
"This transaction was scanned as risky by Web3 Checks."
337 .icon = &WARNING_ICON,
338 .text =
"Critical threat",
339 .subText =
"This transaction was scanned as malicious by Web3 Checks."
343 .text =
"No threat detected",
344 .subText =
"Transaction Check didn't find any threat, but always "
345 "review transaction details carefully."
355static char reducedAddress[QRCODE_REDUCED_ADDR_LEN];
361static void displayReviewPage(uint8_t page,
bool forceFullRefresh);
362static void displayDetailsPage(uint8_t page,
bool forceFullRefresh);
363static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh);
364static void displayFullValuePage(
const char *backText,
365 const char *aliasText,
367static void displayInfosListModal(
const char *modalTitle,
371static void displaySettingsPage(uint8_t page,
bool forceFullRefresh);
372static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh);
373static void pageCallback(
int token, uint8_t index);
375static void displayAddressQRCode(
void);
377static void modalLayoutTouchCallback(
int token, uint8_t index);
378static void displaySkipWarning(
void);
380static void bundleNavStartHome(
void);
381static void bundleNavStartSettingsAtPage(uint8_t initSettingPage);
382static void bundleNavStartSettings(
void);
384static void bundleNavReviewStreamingChoice(
bool confirm);
386static void displaySecurityReport(uint32_t set);
388static void displayInitialWarning(
void);
392 const char *reviewTitle,
393 const char *reviewSubTitle,
394 const char *finishTitle,
398 bool playNotifSound);
401 const char *reviewTitle,
402 const char *reviewSubTitle,
404 bool playNotifSound);
405static void useCaseHomeExt(
const char *appName,
412static void displayDetails(
const char *tag,
const char *value,
bool wrapping);
414static void reset_callbacks_and_context(
void)
421 onContentAction = NULL;
424 onValidatePin = NULL;
426 memset(&genericContext, 0,
sizeof(genericContext));
430static void genericContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements,
bool flag)
432 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements) + SET_PAGE_FLAG(flag);
434 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
435 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
436 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
437 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
441static void genericContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements,
bool *flag)
443 uint8_t pageData = genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
444 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
445 if (nbElements != NULL) {
446 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
449 *flag = GET_PAGE_FLAG(pageData);
454static void modalContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements)
456 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements);
458 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
459 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
460 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
461 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
465static void modalContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements)
467 uint8_t pageData = modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
468 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
469 if (nbElements != NULL) {
470 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
477 switch (content->
type) {
501 if (contentIdx < 0 || contentIdx >= genericContents->
nbContents) {
518static void prepareNavInfo(
bool isReview, uint8_t nbPages,
const char *rejectText)
520 memset(&navInfo, 0,
sizeof(navInfo));
523 navInfo.
tuneId = TUNE_TAP_CASUAL;
527 if (isReview ==
false) {
536 = ((navType == STREAMING_NAV) && (nbPages < 2)) ?
false : true;
543 const char *reviewTitle,
544 const char *reviewSubTitle)
546 contentCenter->
icon = icon;
547 contentCenter->
title = reviewTitle;
549 contentCenter->
subText =
"Swipe to review";
552 contentCenter->
padding =
false;
558 if (finishTitle != NULL) {
563 return "Sign transaction";
565 return "Sign message";
567 return "Sign operation";
574 const char *finishTitle)
576 infoLongPress->
text = getFinishTitle(operationType, finishTitle);
577 infoLongPress->
icon = icon;
585 const char *finishTitle)
587 infoButton->
text = getFinishTitle(operationType, finishTitle);
588 infoButton->
icon = icon;
595 UNUSED(operationType);
601static void pageModalCallback(
int token, uint8_t index)
605 if (token == INFOS_TIP_BOX_TOKEN) {
607 displayFullValuePage(activeTipBox.infos.infoTypes[index],
608 activeTipBox.infos.infoContents[index],
609 &activeTipBox.infos.infoExtensions[index]);
612 else if (token == INFO_ALIAS_TOKEN) {
614 displayFullValuePage(genericContext.currentInfos->infoTypes[index],
615 genericContext.currentInfos->infoContents[index],
616 &genericContext.currentInfos->infoExtensions[index]);
620 modalPageContext = NULL;
621 if (token == NAV_TOKEN) {
628 displayDetailsPage(index,
false);
631 if (token == MODAL_NAV_TOKEN) {
638 displayTagValueListModalPage(index,
false);
641 else if (token == QUIT_TOKEN) {
646 else if (token == QUIT_TIPBOX_MODAL_TOKEN) {
648 if (reviewWithWarnCtx.securityReportLevel == 2) {
649 reviewWithWarnCtx.securityReportLevel = 1;
650 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
658 else if (token == SKIP_TOKEN) {
669 else if (token == CHOICE_TOKEN) {
671 if (onModalConfirm != NULL) {
673 onModalConfirm = NULL;
685static void pageCallback(
int token, uint8_t index)
688 if (token == QUIT_TOKEN) {
689 if (onQuit != NULL) {
693 else if (token == CONTINUE_TOKEN) {
694 if (onContinue != NULL) {
698 else if (token == CHOICE_TOKEN) {
699 if (onChoice != NULL) {
700 onChoice((index == 0) ?
true : false);
703 else if (token == ACTION_BUTTON_TOKEN) {
704 if ((index == 0) && (onAction != NULL)) {
707 else if ((index == 1) && (onQuit != NULL)) {
712 else if (token == ADDRESS_QRCODE_BUTTON_TOKEN) {
713 displayAddressQRCode();
716 else if (token == CONFIRM_TOKEN) {
717 if (onChoice != NULL) {
721 else if (token == REJECT_TOKEN) {
722 if (onChoice != NULL) {
726 else if (token == DETAILS_BUTTON_TOKEN) {
727 displayDetails(genericContext.detailsItem,
728 genericContext.detailsvalue,
729 genericContext.detailsWrapping);
731 else if (token == NAV_TOKEN) {
733 if (onQuit != NULL) {
738 if (navType == GENERIC_NAV || navType == STREAMING_NAV) {
739 displayGenericContextPage(index,
false);
741 else if (navType == REVIEW_NAV) {
742 displayReviewPage(index,
false);
745 displaySettingsPage(index,
false);
749 else if (token == NEXT_TOKEN) {
751 displayReviewPage(navInfo.
activePage + 1,
false);
754 displayGenericContextPage(navInfo.
activePage + 1,
false);
757 else if (token == BACK_TOKEN) {
759 displayReviewPage(navInfo.
activePage - 1,
true);
762 displayGenericContextPage(navInfo.
activePage - 1,
false);
765 else if (token == SKIP_TOKEN) {
767 displaySkipWarning();
769 else if (token == VALUE_ALIAS_TOKEN) {
772 if (genericContext.currentPairs != NULL) {
773 pair = &genericContext.currentPairs[genericContext.currentElementIdx + index];
776 pair = genericContext.currentCallback(genericContext.currentElementIdx + index);
780 else if (token == BLIND_WARNING_TOKEN) {
781 reviewWithWarnCtx.isIntro =
false;
782 reviewWithWarnCtx.warning = NULL;
785 else if (token == WARNING_BUTTON_TOKEN) {
787 reviewWithWarnCtx.securityReportLevel = 1;
789 if (reviewWithWarnCtx.warning->predefinedSet) {
790 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
794 if (reviewWithWarnCtx.isIntro) {
795 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->introDetails);
798 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->reviewDetails);
802 else if (token == TIP_BOX_TOKEN) {
804 if (genericContext.validWarningCtx && (reviewWithWarnCtx.warning->predefinedSet != 0)) {
805 reviewWithWarnCtx.securityReportLevel = 1;
806 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
809 displayInfosListModal(activeTipBox.modalTitle, &activeTipBox.infos,
false);
813 if (onContentAction != NULL) {
814 onContentAction(token, index, navInfo.
activePage);
816 if (onControls != NULL) {
817 onControls(token, index);
823static void tickerCallback(
void)
826 if (onQuit != NULL) {
832static void displaySettingsPage(uint8_t page,
bool forceFullRefresh)
836 if ((onNav == NULL) || (onNav(page, &content) ==
false)) {
841 content.
title = pageTitle;
844 content.
tuneId = TUNE_TAP_CASUAL;
849 if (forceFullRefresh) {
858static void displayReviewPage(uint8_t page,
bool forceFullRefresh)
867 if ((onNav == NULL) || (onNav(navInfo.
activePage, &content) ==
false)) {
872 content.
title = NULL;
874 content.
tuneId = TUNE_TAP_CASUAL;
881 if (forwardNavOnly) {
906 if (forceFullRefresh) {
916static const nbgl_content_t *genericContextComputeNextPageParams(uint8_t pageIdx,
918 uint8_t *p_nbElementsInNextPage,
921 int8_t nextContentIdx = genericContext.currentContentIdx;
922 int16_t nextElementIdx = genericContext.currentElementIdx;
923 uint8_t nbElementsInNextPage;
926 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
927 *p_nbElementsInNextPage = nbElementsInNextPage;
932 uint8_t nbElementsInCurrentPage;
934 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
935 nextElementIdx += nbElementsInCurrentPage;
940 if ((nextElementIdx >= genericContext.currentContentElementNb)
941 && (genericContext.currentContentElementNb > 0)) {
951 nextElementIdx -= nbElementsInNextPage;
957 if (nextElementIdx < 0) {
959 nextElementIdx = -nbElementsInNextPage;
965 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
966 p_content = &STARTING_CONTENT;
968 else if ((nextContentIdx == genericContext.genericContents.nbContents)
969 && (genericContext.hasFinishingContent)) {
970 p_content = &FINISHING_CONTENT;
973 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
975 if (p_content == NULL) {
990 if ((nextContentIdx != genericContext.currentContentIdx)
991 || (genericContext.currentContentElementNb == 0)) {
992 genericContext.currentContentIdx = nextContentIdx;
993 genericContext.currentContentElementNb = getContentNbElement(p_content);
995 if (nextElementIdx < 0) {
996 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
1001 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
1003 "Invalid element index %d / %d\n",
1005 genericContext.currentContentElementNb);
1010 genericContext.currentElementIdx = nextElementIdx;
1018static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
1019 uint8_t nbElementsInPage,
1023 uint8_t nextElementIdx = genericContext.currentElementIdx;
1025 pageContent->
title = pageTitle;
1028 pageContent->
tuneId = TUNE_TAP_CASUAL;
1030 pageContent->
type = p_content->
type;
1031 switch (pageContent->
type) {
1083 p_tagValueList = NULL;
1095 genericContext.detailsItem = pair->
item;
1096 genericContext.detailsvalue = pair->
value;
1101 if (p_tagValueList != NULL) {
1102 p_tagValueList->
nbPairs = nbElementsInPage;
1105 p_tagValueList->
pairs
1108 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1110 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1116 p_tagValueList->
pairs = NULL;
1120 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1124 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1140 if ((nextElementIdx + nbElementsInPage)
1152 p_tagValueList->
nbPairs = nbElementsInPage;
1153 p_tagValueList->
pairs
1156 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1158 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1163 genericContext.currentPairs = p_tagValueList->
pairs;
1164 genericContext.currentCallback = p_tagValueList->
callback;
1188 < nextElementIdx + nbElementsInPage)) {
1208 bool isFirstOrLastPage
1212 = (navType == STREAMING_NAV)
1213 ? bundleNavContext.reviewStreaming.operationType
1214 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1217 if (isFirstOrLastPage
1218 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1220 if ((operationType & NO_THREAT_OPERATION)
1229 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1236static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh)
1240 uint8_t nbElementsInPage;
1244 if (navType == STREAMING_NAV) {
1246 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1247 bundleNavContext.reviewStreaming.skipCallback();
1251 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1252 bundleNavReviewStreamingChoice(
true);
1259 pageIdx = navInfo.
nbPages - 1;
1265 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1270 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1271 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1281 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1284 if (p_content == NULL) {
1288 if ((navType != STREAMING_NAV)
1291 if ((pageIdx > 0) && (pageIdx < (navInfo.
nbPages - 1))) {
1303 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1309 if (forceFullRefresh) {
1318static const char *getDetailsPageAt(uint8_t detailsPage)
1321 const char *currentChar = detailsContext.value;
1322 while (page < detailsPage) {
1332 detailsContext.wrapping);
1334 if (currentChar[len] ==
'\n') {
1337 else if (detailsContext.wrapping ==
false) {
1340 currentChar = currentChar + len;
1348static void displayDetailsPage(uint8_t detailsPage,
bool forceFullRefresh)
1352 .nbPages = detailsContext.nbPages,
1354 .quitToken = QUIT_TOKEN,
1355 .navWithButtons.navToken = NAV_TOKEN,
1356 .navWithButtons.quitButton =
true,
1357 .navWithButtons.backButton =
true,
1358 .navWithButtons.quitText = NULL,
1359 .progressIndicator =
false,
1360 .tuneId = TUNE_TAP_CASUAL};
1362 .topRightIcon = NULL,
1363 .tagValueList.nbPairs = 1,
1364 .tagValueList.pairs = ¤tPair,
1365 .tagValueList.smallCaseForValue =
true,
1366 .tagValueList.wrapping = detailsContext.wrapping};
1368 if (modalPageContext != NULL) {
1371 currentPair.
item = detailsContext.tag;
1373 if (detailsPage <= detailsContext.currentPage) {
1375 currentPair.
value = getDetailsPageAt(detailsPage);
1376 forceFullRefresh =
true;
1380 currentPair.
value = detailsContext.nextPageStart;
1382 detailsContext.currentPage = detailsPage;
1393 detailsContext.wrapping);
1396 if (currentPair.
value[len] ==
'\n') {
1399 else if (!detailsContext.wrapping) {
1404 detailsContext.nextPageStart = currentPair.
value + len;
1410 detailsContext.nextPageStart = NULL;
1419 if (forceFullRefresh) {
1428static void displayFullValuePage(
const char *backText,
1429 const char *aliasText,
1432 const char *modalTitle
1433 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1435 genericContext.currentInfos = extension->
infolist;
1436 displayInfosListModal(modalTitle, extension->
infolist,
true);
1439 genericContext.currentTagValues = extension->
tagValuelist;
1444 .withLeftBorder =
true,
1445 .onActionCallback = &modalLayoutTouchCallback,
1446 .tapActionText = NULL};
1448 .separationLine =
false,
1449 .backAndText.token = 0,
1450 .backAndText.tuneId = TUNE_TAP_CASUAL,
1451 .backAndText.text = modalTitle};
1460 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1461 .text2 = extension->explanation,
1470 content.
title = aliasText;
1472 content.
info =
"ENS names are resolved by Ledger backend.";
1494static void displayInfosListModal(
const char *modalTitle,
1501 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1502 .navWithButtons.navToken = NAV_TOKEN,
1503 .navWithButtons.quitButton =
false,
1504 .navWithButtons.backButton =
true,
1505 .navWithButtons.quitText = NULL,
1506 .progressIndicator =
false,
1507 .tuneId = TUNE_TAP_CASUAL};
1510 .topRightIcon = NULL,
1511 .infosList.nbInfos = infos->
nbInfos,
1513 .infosList.infoTypes = infos->
infoTypes,
1516 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1517 .
title = modalTitle,
1518 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1519 .tuneId = TUNE_TAP_CASUAL};
1521 if (modalPageContext != NULL) {
1530static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh)
1533 .nbPages = detailsContext.nbPages,
1535 .quitToken = QUIT_TOKEN,
1536 .navWithButtons.navToken = MODAL_NAV_TOKEN,
1537 .navWithButtons.quitButton =
true,
1538 .navWithButtons.backButton =
true,
1539 .navWithButtons.quitText = NULL,
1540 .progressIndicator =
false,
1541 .tuneId = TUNE_TAP_CASUAL};
1543 .topRightIcon = NULL,
1544 .tagValueList.smallCaseForValue =
true,
1545 .tagValueList.wrapping = detailsContext.wrapping};
1546 uint8_t nbElementsInPage;
1549 if (detailsContext.currentPage <= pageIdx) {
1550 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1554 modalContextGetPageInfo(pageIdx + 1, &nbElementsInPage);
1555 detailsContext.currentPairIdx -= nbElementsInPage;
1556 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1557 detailsContext.currentPairIdx -= nbElementsInPage;
1559 detailsContext.currentPage = pageIdx;
1562 = &genericContext.currentTagValues->pairs[detailsContext.currentPairIdx];
1564 detailsContext.currentPairIdx += nbElementsInPage;
1570 if (modalPageContext != NULL) {
1575 if (forceFullRefresh) {
1584static void displayAddressQRCode(
void)
1588 .withLeftBorder =
true,
1589 .onActionCallback = &modalLayoutTouchCallback,
1590 .tapActionText = NULL};
1592 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1598 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1603 addressConfirmationContext.tagValuePairs[0].value,
1607 if (nbLines <= QRCODE_NB_MAX_LINES) {
1608 qrCode.
text2 = addressConfirmationContext.tagValuePairs[0].value;
1613 addressConfirmationContext.tagValuePairs[0].value,
1615 QRCODE_NB_MAX_LINES,
1617 QRCODE_REDUCED_ADDR_LEN);
1618 qrCode.
text2 = reducedAddress;
1624 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1632static void modalLayoutTouchCallback(
int token, uint8_t index)
1635 if (token == DISMISS_QR_TOKEN) {
1638 addressConfirmationContext.modalLayout = NULL;
1641 else if (token == DISMISS_WARNING_TOKEN) {
1645 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1646 reviewWithWarnCtx.modalLayout = NULL;
1651 reviewWithWarnCtx.securityReportLevel = 1;
1653 if (reviewWithWarnCtx.warning->predefinedSet) {
1654 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1659 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1660 : reviewWithWarnCtx.warning->reviewDetails;
1661 displayCustomizedSecurityReport(details);
1666 else if (token == DISMISS_DETAILS_TOKEN) {
1670 if (choiceWithDetailsCtx.level <= 1) {
1671 choiceWithDetailsCtx.modalLayout = NULL;
1676 choiceWithDetailsCtx.level = 1;
1677 choiceWithDetailsCtx.modalLayout
1678 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1681 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1682 if (sharedContext.usage == SHARE_CTX_REVIEW_WITH_WARNING) {
1685 reviewWithWarnCtx.securityReportLevel = 2;
1687 if (reviewWithWarnCtx.warning->predefinedSet) {
1688 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1693 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1694 : reviewWithWarnCtx.warning->reviewDetails;
1696 displayCustomizedSecurityReport(
1701 else if (sharedContext.usage == SHARE_CTX_CHOICE_WITH_DETAILS) {
1703 = &choiceWithDetailsCtx.details->
barList.
details[token - FIRST_WARN_BAR_TOKEN];
1707 choiceWithDetailsCtx.level = 2;
1708 choiceWithDetailsCtx.modalLayout
1709 = displayModalDetails(details, DISMISS_DETAILS_TOKEN);
1717 genericContext.modalLayout = NULL;
1724static void layoutTouchCallback(
int token, uint8_t index)
1727 if (token == WARNING_CHOICE_TOKEN) {
1729 reviewWithWarnCtx.choiceCallback(
false);
1732 reviewWithWarnCtx.isIntro =
false;
1733 if (reviewWithWarnCtx.isStreaming) {
1734 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1735 reviewWithWarnCtx.icon,
1736 reviewWithWarnCtx.reviewTitle,
1737 reviewWithWarnCtx.reviewSubTitle,
1738 reviewWithWarnCtx.choiceCallback,
1742 useCaseReview(reviewWithWarnCtx.operationType,
1743 reviewWithWarnCtx.tagValueList,
1744 reviewWithWarnCtx.icon,
1745 reviewWithWarnCtx.reviewTitle,
1746 reviewWithWarnCtx.reviewSubTitle,
1747 reviewWithWarnCtx.finishTitle,
1749 reviewWithWarnCtx.choiceCallback,
1756 else if (token == WARNING_BUTTON_TOKEN) {
1758 reviewWithWarnCtx.securityReportLevel = 1;
1760 if (reviewWithWarnCtx.warning->predefinedSet) {
1761 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1766 ? reviewWithWarnCtx.warning->introDetails
1767 : reviewWithWarnCtx.warning->reviewDetails;
1768 displayCustomizedSecurityReport(details);
1772 else if (token == CHOICE_DETAILS_TOKEN) {
1773 choiceWithDetailsCtx.level = 1;
1774 choiceWithDetailsCtx.modalLayout
1775 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1778 else if (token == PRELUDE_CHOICE_TOKEN) {
1780 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->prelude->details);
1784 displayInitialWarning();
1787 reviewWithWarnCtx.isIntro =
false;
1788 if (reviewWithWarnCtx.isStreaming) {
1789 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1790 reviewWithWarnCtx.icon,
1791 reviewWithWarnCtx.reviewTitle,
1792 reviewWithWarnCtx.reviewSubTitle,
1793 reviewWithWarnCtx.choiceCallback,
1797 useCaseReview(reviewWithWarnCtx.operationType,
1798 reviewWithWarnCtx.tagValueList,
1799 reviewWithWarnCtx.icon,
1800 reviewWithWarnCtx.reviewTitle,
1801 reviewWithWarnCtx.reviewSubTitle,
1802 reviewWithWarnCtx.finishTitle,
1804 reviewWithWarnCtx.choiceCallback,
1812 else if (token == CHOICE_TOKEN) {
1813 if (onChoice != NULL) {
1814 onChoice((index == 0) ?
true : false);
1820static void displaySkipWarning(
void)
1823 .cancelText =
"Go back to review",
1824 .centeredInfo.text1 =
"Skip review?",
1826 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1827 .centeredInfo.text3 = NULL,
1829 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1830 .centeredInfo.offsetY = 0,
1831 .confirmationText =
"Yes, skip",
1832 .confirmationToken = SKIP_TOKEN,
1833 .
tuneId = TUNE_TAP_CASUAL,
1835 if (modalPageContext != NULL) {
1847static void updateKeyPad(
bool add)
1849 bool enableValidate, enableBackspace, enableDigits;
1850 bool redrawKeypad =
false;
1853 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1854 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1855 enableBackspace = (keypadContext.pinLen > 0);
1857 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1859 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1861 (keypadContext.pinLen == 1)) {
1862 redrawKeypad =
true;
1866 if ((keypadContext.pinLen == 0) ||
1867 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1869 (keypadContext.pinLen
1870 == (keypadContext.pinMaxDigits - 1))) {
1871 redrawKeypad =
true;
1874 if (keypadContext.hidden ==
true) {
1879 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1883 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1886 if ((!add) && (keypadContext.pinLen == 0)) {
1894static void keypadCallback(
char touchedKey)
1896 switch (touchedKey) {
1898 if (keypadContext.pinLen > 0) {
1899 keypadContext.pinLen--;
1900 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1902 updateKeyPad(
false);
1911 onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1915 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1916 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1917 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1918 keypadContext.pinLen++;
1926static void keypadGeneric_cb(
int token, uint8_t index)
1929 if (token != BACK_TOKEN) {
1950static uint8_t getNbTagValuesInPage(uint8_t nbPairs,
1954 bool hasConfirmationButton,
1955 bool hasDetailsButton,
1956 bool *requireSpecificDisplay)
1958 uint8_t nbPairsInPage = 0;
1959 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
1965 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
1968 *requireSpecificDisplay =
false;
1969 while (nbPairsInPage < nbPairs) {
1976 if (nbPairsInPage > 0) {
1977 currentHeight += INTER_TAG_VALUE_MARGIN;
1980 if (tagValueList->
pairs != NULL) {
1981 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
1984 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
1993 if (nbPairsInPage > 0) {
2000 *requireSpecificDisplay =
true;
2012 value_font = SMALL_REGULAR_FONT;
2015 value_font = LARGE_MEDIUM_FONT;
2029 if (nbPairsInPage == 0) {
2033 *requireSpecificDisplay =
true;
2042 if (hasConfirmationButton && (nbPairsInPage == nbPairs)) {
2043 maxUsableHeight -= UP_FOOTER_BUTTON_HEIGHT;
2044 if (currentHeight > maxUsableHeight) {
2049 else if (hasDetailsButton) {
2050 maxUsableHeight -= (SMALL_BUTTON_RADIUS * 2);
2051 if (currentHeight > maxUsableHeight) {
2055 return nbPairsInPage;
2067static uint8_t getNbTagValuesInDetailsPage(uint8_t nbPairs,
2071 uint8_t nbPairsInPage = 0;
2072 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2075 while (nbPairsInPage < nbPairs) {
2080 if (nbPairsInPage > 0) {
2081 currentHeight += INTER_TAG_VALUE_MARGIN;
2084 if (tagValueList->
pairs != NULL) {
2085 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2088 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2102 if (currentHeight >= maxUsableHeight) {
2107 return nbPairsInPage;
2110static uint8_t getNbPagesForContent(
const nbgl_content_t *content,
2111 uint8_t pageIdxStart,
2115 uint8_t nbElements = 0;
2116 uint8_t nbPages = 0;
2117 uint8_t nbElementsInPage;
2118 uint8_t elemIdx = 0;
2121 nbElements = getContentNbElement(content);
2123 while (nbElements > 0) {
2126 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
2128 nbElementsInPage = getNbTagValuesInPage(nbElements,
2137 nbElementsInPage = getNbTagValuesInPage(nbElements,
2162 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
2165 elemIdx += nbElementsInPage;
2166 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
2167 nbElements -= nbElementsInPage;
2175 uint8_t pageIdxStart,
2178 uint8_t nbPages = 0;
2182 for (
int i = 0; i < genericContents->
nbContents; i++) {
2183 p_content = getContentAtIdx(genericContents, i, &content);
2184 if (p_content == NULL) {
2187 nbPages += getNbPagesForContent(p_content,
2188 pageIdxStart + nbPages,
2196static void prepareAddressConfirmationPages(
const char *address,
2203 addressConfirmationContext.tagValuePairs[0].item =
"Address";
2204 addressConfirmationContext.tagValuePairs[0].value = address;
2205 addressConfirmationContext.nbPairs = 1;
2214 if ((tagValueList != NULL) && (tagValueList->
nbPairs < ADDR_VERIF_NB_PAIRS)) {
2218 for (uint8_t i = 0; i < tagValueList->
nbPairs; i++) {
2219 memcpy(&addressConfirmationContext.tagValuePairs[1 + i],
2220 &tagValueList->
pairs[i],
2222 addressConfirmationContext.nbPairs++;
2226 tmpList.
nbPairs = addressConfirmationContext.nbPairs;
2227 tmpList.
pairs = addressConfirmationContext.tagValuePairs;
2228 addressConfirmationContext.nbPairs = getNbTagValuesInPage(
2229 addressConfirmationContext.nbPairs, &tmpList, 0,
false,
true,
true, &flag);
2231 if (tmpList.
nbPairs > addressConfirmationContext.nbPairs) {
2232 addressConfirmationContext.nbPairs = 1;
2243 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2251 if ((tagValueList != NULL)
2252 && (tagValueList->
nbPairs > (addressConfirmationContext.nbPairs - 1))) {
2262 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2265 = tagValueList->
nbPairs - (addressConfirmationContext.nbPairs - 1);
2267 = &tagValueList->
pairs[addressConfirmationContext.nbPairs - 1];
2276static void bundleNavStartHome(
void)
2278 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2280 useCaseHomeExt(context->appName,
2283 context->settingContents != NULL ?
true : false,
2284 &context->homeAction,
2285 bundleNavStartSettings,
2286 context->quitCallback);
2289static void bundleNavStartSettingsAtPage(uint8_t initSettingPage)
2291 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2295 context->settingContents,
2297 bundleNavStartHome);
2300static void bundleNavStartSettings(
void)
2302 bundleNavStartSettingsAtPage(0);
2305static void bundleNavReviewConfirmRejection(
void)
2307 bundleNavContext.review.choiceCallback(
false);
2314 const char *confirmText;
2319 title =
"Reject transaction?";
2320 confirmText =
"Go back to transaction";
2323 title =
"Reject message?";
2324 confirmText =
"Go back to message";
2327 title =
"Reject operation?";
2328 confirmText =
"Go back to operation";
2335static void bundleNavReviewChoice(
bool confirm)
2338 bundleNavContext.review.choiceCallback(
true);
2341 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
2342 bundleNavReviewConfirmRejection);
2346static void bundleNavReviewStreamingConfirmRejection(
void)
2348 bundleNavContext.reviewStreaming.choiceCallback(
false);
2351static void bundleNavReviewStreamingChoice(
bool confirm)
2354 bundleNavContext.reviewStreaming.choiceCallback(
true);
2357 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
2358 bundleNavReviewStreamingConfirmRejection);
2368 .withLeftBorder =
true,
2369 .onActionCallback = modalLayoutTouchCallback,
2370 .tapActionText = NULL};
2372 .separationLine =
true,
2373 .backAndText.icon = NULL,
2374 .backAndText.tuneId = TUNE_TAP_CASUAL,
2375 .backAndText.token = token};
2391 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2392 bar.
tuneId = TUNE_TAP_CASUAL;
2419static void displaySecurityReport(uint32_t set)
2422 .withLeftBorder =
true,
2423 .onActionCallback = modalLayoutTouchCallback,
2424 .tapActionText = NULL};
2426 .separationLine =
true,
2427 .backAndText.icon = NULL,
2428 .backAndText.tuneId = TUNE_TAP_CASUAL,
2429 .backAndText.token = DISMISS_WARNING_TOKEN};
2433 const char *provider;
2435 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2441 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
2445 && (reviewWithWarnCtx.warning->predefinedSet & (1 << i))) {
2448 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
2449 bar.
subText = securityReportItems[i].subText;
2452 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
2454 bar.
text = securityReportItems[i].text;
2457 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2458 bar.
tuneId = TUNE_TAP_CASUAL;
2463 bar.
iconLeft = securityReportItems[i].icon;
2474 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2475 provider = reviewWithWarnCtx.warning->reportProvider;
2478 provider =
"[unknown]";
2484 + W3C_DESCRIPTION_MAX_LEN / 2;
2488 .text1 = reviewWithWarnCtx.warning->reportUrl,
2489 .text2 =
"Scan to view full report",
2494 W3C_DESCRIPTION_MAX_LEN / 2,
2496 reviewWithWarnCtx.warning->reportUrl);
2497 urlLen = strlen(destStr) + 1;
2502 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2508 info.
icon = &LARGE_WARNING_ICON;
2509 info.
title =
"This transaction cannot be Clear Signed";
2511 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2512 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2521 info.
icon = &LARGE_WARNING_ICON;
2522 info.
title =
"Transaction Check unavailable";
2524 =
"If you're not using the Ledger Wallet app, Transaction Check might not work. If "
2526 "are using Ledger Wallet, reject the transaction and try again.\n\nGet help at "
2545 reviewWithWarnCtx.modalLayout = displayModalDetails(details, DISMISS_WARNING_TOKEN);
2549static void displayInitialWarning(
void)
2552#ifdef HAVE_PIEZO_SOUND
2553 tune_index_e tune = TUNE_RESERVED;
2557 .token = WARNING_CHOICE_TOKEN,
2558 .topText =
"Back to safety",
2560 .tuneId = TUNE_TAP_CASUAL};
2562 .separationLine =
false,
2563 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2564 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2567 bool isBlindSigningOnly
2569 reviewWithWarnCtx.isIntro =
true;
2571 layoutDescription.
modal =
false;
2577 layoutDescription.
ticker.tickerCallback = NULL;
2578 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2581 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2584 isBlindSigningOnly ? &INFO_I_ICON : &QRCODE_ICON,
2585 WARNING_BUTTON_TOKEN,
2588 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2590 reviewWithWarnCtx.warning->introTopRightIcon,
2591 WARNING_BUTTON_TOKEN,
2596 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2599 const char *provider;
2602 info.
icon = &LARGE_WARNING_ICON;
2605 if (isBlindSigningOnly ==
false) {
2606 if (reviewWithWarnCtx.warning->reportProvider) {
2607 provider = reviewWithWarnCtx.warning->reportProvider;
2610 provider =
"[unknown]";
2613 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2617 if (isBlindSigningOnly) {
2618 info.
title =
"Blind signing ahead";
2621 =
"If you sign this transaction, you could loose your assets. "
2622 "Explore safer alternatives: ledger.com/integrated-apps";
2623 buttonsInfo.
bottomText =
"Accept risk and continue";
2627 =
"This transaction's details are not fully verifiable. If you sign, you could "
2628 "lose all your assets.";
2631#ifdef HAVE_PIEZO_SOUND
2632 tune = TUNE_NEUTRAL;
2636 info.
title =
"Potential risk";
2637 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2641 info.
description = reviewWithWarnCtx.warning->providerMessage;
2643 buttonsInfo.
bottomText =
"Accept risk and continue";
2644#ifdef HAVE_PIEZO_SOUND
2645 tune = TUNE_NEUTRAL;
2649 info.
title =
"Critical threat";
2650 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2654 info.
description = reviewWithWarnCtx.warning->providerMessage;
2656 buttonsInfo.
bottomText =
"Accept threat and continue";
2657#ifdef HAVE_PIEZO_SOUND
2663 else if (reviewWithWarnCtx.warning->info != NULL) {
2666#ifdef HAVE_PIEZO_SOUND
2667 tune = TUNE_LOOK_AT_ME;
2673#ifdef HAVE_PIEZO_SOUND
2674 if (tune != TUNE_RESERVED) {
2675 os_io_seph_cmd_piezo_play_tune(tune);
2683static void displayPrelude(
void)
2687 = {.
bottomText = reviewWithWarnCtx.warning->prelude->footerText,
2688 .token = PRELUDE_CHOICE_TOKEN,
2689 .topText = reviewWithWarnCtx.warning->prelude->buttonText,
2691 .tuneId = TUNE_TAP_CASUAL};
2693 .separationLine =
false,
2694 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2696 reviewWithWarnCtx.isIntro =
true;
2698 layoutDescription.
modal =
false;
2702 layoutDescription.
ticker.tickerCallback = NULL;
2703 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2710 info.
icon = reviewWithWarnCtx.warning->prelude->icon;
2712 info.
title = reviewWithWarnCtx.warning->prelude->title;
2713 info.
description = reviewWithWarnCtx.warning->prelude->description;
2719#ifdef HAVE_PIEZO_SOUND
2720 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2729 const char *predefinedTipBoxText = NULL;
2732 if (reviewWithWarnCtx.warning) {
2733 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2735 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2738 predefinedTipBoxText =
"Transaction Check unavailable";
2743 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2746 predefinedTipBoxText =
"Critical threat detected.";
2751 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2754 predefinedTipBoxText =
"Potential risk detected.";
2759 predefinedTipBoxText
2760 =
"No threat detected by Transaction Check but blind signing required.";
2763 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2767 predefinedTipBoxText =
"Blind signing required.";
2771 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2773 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2774 if (predefinedTipBoxText != NULL) {
2775 genericContext.validWarningCtx =
true;
2776 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2777 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2780 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2781 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2783 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2784 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2792 const char *reviewTitle,
2793 const char *reviewSubTitle,
2794 const char *finishTitle,
2798 bool playNotifSound)
2800 bundleNavContext.review.operationType = operationType;
2801 bundleNavContext.review.choiceCallback = choiceCallback;
2804 onChoice = bundleNavReviewChoice;
2805 navType = GENERIC_NAV;
2808 genericContext.genericContents.contentsList = localContentsList;
2809 genericContext.genericContents.nbContents = 3;
2814 prepareReviewFirstPage(
2815 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2818 initWarningTipBox(tipBox);
2822 memcpy(&localContentsList[1].content.tagValueList,
2830 prepareReviewLightLastPage(
2831 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2835 prepareReviewLastPage(
2836 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2840 uint8_t nbPages = getNbPagesForGenericContents(
2842 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2845 if (playNotifSound) {
2846#ifdef HAVE_PIEZO_SOUND
2847 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2851 displayGenericContextPage(0,
true);
2857 const char *reviewTitle,
2858 const char *reviewSubTitle,
2860 bool playNotifSound)
2862 bundleNavContext.reviewStreaming.operationType = operationType;
2863 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2864 bundleNavContext.reviewStreaming.icon = icon;
2867 onChoice = bundleNavReviewStreamingChoice;
2868 navType = STREAMING_NAV;
2871 genericContext.genericContents.contentsList = localContentsList;
2872 genericContext.genericContents.nbContents = 1;
2877 prepareReviewFirstPage(
2878 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2881 initWarningTipBox(NULL);
2884 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2891 if (playNotifSound) {
2892#ifdef HAVE_PIEZO_SOUND
2893 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2897 displayGenericContextPage(0,
true);
2916static void useCaseHomeExt(
const char *appName,
2918 const char *tagline,
2925 .centeredInfo.text1 = appName,
2926 .centeredInfo.text3 = NULL,
2928 .centeredInfo.offsetY = 0,
2931 .tapActionText = NULL,
2933 .topRightToken = CONTINUE_TOKEN,
2934 .tuneId = TUNE_TAP_CASUAL};
2935 reset_callbacks_and_context();
2937 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
2952 if (tagline == NULL) {
2956 "This app enables signing\ntransactions on its network.");
2983 onContinue = topRightCallback;
2984 onQuit = quitCallback;
2998static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
3000 memset(&detailsContext, 0,
sizeof(detailsContext));
3006 detailsContext.tag = tag;
3007 detailsContext.value = value;
3009 detailsContext.currentPage = 0;
3010 detailsContext.wrapping = wrapping;
3012 if (detailsContext.nbPages > 1) {
3013 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
3016 uint8_t nbLinesInLastPage
3022 detailsContext.nbPages++;
3026 displayDetailsPage(0,
true);
3032 uint8_t nbElements = 0;
3033 uint8_t nbElementsInPage;
3034 uint8_t elemIdx = 0;
3037 memset(&detailsContext, 0,
sizeof(detailsContext));
3038 nbElements = tagValues->
nbPairs;
3040 while (nbElements > 0) {
3041 nbElementsInPage = getNbTagValuesInDetailsPage(nbElements, tagValues, elemIdx);
3043 elemIdx += nbElementsInPage;
3044 modalContextSetPageInfo(detailsContext.nbPages, nbElementsInPage);
3045 nbElements -= nbElementsInPage;
3046 detailsContext.nbPages++;
3049 displayTagValueListModalPage(0,
true);
3071 bool *requireSpecificDisplay)
3073 return getNbTagValuesInPage(
3074 nbPairs, tagValueList, startIndex,
false,
false,
false, requireSpecificDisplay);
3094 bool *requireSpecificDisplay)
3096 return getNbTagValuesInPage(
3097 nbPairs, tagValueList, startIndex, isSkippable,
false,
false, requireSpecificDisplay);
3114 uint8_t nbInfosInPage = 0;
3115 uint16_t currentHeight = 0;
3116 uint16_t previousHeight;
3117 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3118 const char *
const *infoContents = PIC(infosList->
infoContents);
3120 while (nbInfosInPage < nbInfos) {
3123 += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING + LIST_ITEM_HEADING_SUB_TEXT;
3127 PIC(infoContents[startIndex + nbInfosInPage]),
3134 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3139 previousHeight = currentHeight;
3142 return nbInfosInPage;
3159 uint8_t nbSwitchesInPage = 0;
3160 uint16_t currentHeight = 0;
3161 uint16_t previousHeight = 0;
3162 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3165 while (nbSwitchesInPage < nbSwitches) {
3169 uint16_t textHeight =
MAX(
3170 LIST_ITEM_MIN_TEXT_HEIGHT,
3172 currentHeight += textHeight + 2 * LIST_ITEM_PRE_HEADING;
3175 currentHeight += LIST_ITEM_HEADING_SUB_TEXT;
3185 previousHeight = currentHeight;
3190 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3193 return nbSwitchesInPage;
3210 uint8_t nbBarsInPage = 0;
3211 uint16_t currentHeight = 0;
3212 uint16_t previousHeight;
3213 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3218 while (nbBarsInPage < nbBars) {
3219 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3224 previousHeight = currentHeight;
3229 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3232 return nbBarsInPage;
3249 uint8_t nbChoicesInPage = 0;
3250 uint16_t currentHeight = 0;
3251 uint16_t previousHeight;
3252 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3254 UNUSED(choicesList);
3257 while (nbChoicesInPage < nbChoices) {
3258 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3263 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3268 previousHeight = currentHeight;
3271 return nbChoicesInPage;
3282 uint8_t nbPages = 0;
3283 uint8_t nbPairs = tagValueList->
nbPairs;
3284 uint8_t nbPairsInPage;
3288 while (i < tagValueList->nbPairs) {
3292 nbPairs -= nbPairsInPage;
3304 const char *tagline,
3311 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3320 const char *tagline,
3322 const char *actionButtonText,
3330 .text = actionButtonText};
3333 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3356 reset_callbacks_and_context();
3359 onQuit = quitCallback;
3360 onNav = navCallback;
3361 onControls = controlsCallback;
3363 navType = SETTINGS_NAV;
3366 prepareNavInfo(
false, nbPages, NULL);
3368 displaySettingsPage(initPage,
true);
3386 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
3407 reset_callbacks_and_context();
3410 onQuit = quitCallback;
3411 pageTitle = appName;
3412 navType = GENERIC_NAV;
3414 if (settingContents != NULL) {
3417 if (infosList != NULL) {
3418 genericContext.hasFinishingContent =
true;
3421 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3425 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3426 if (infosList != NULL) {
3427 nbPages += getNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3430 prepareNavInfo(
false, nbPages, NULL);
3432 displayGenericContextPage(initPage,
true);
3471 const char *appName,
3473 const char *tagline,
3481 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3483 reset_callbacks_and_context();
3485 context->appName = appName;
3486 context->appIcon = appIcon;
3487 context->tagline = tagline;
3488 context->settingContents = settingContents;
3489 context->infosList = infosList;
3490 if (action != NULL) {
3496 context->quitCallback = quitCallback;
3499 bundleNavStartSettingsAtPage(initSettingPage);
3502 bundleNavStartHome();
3516 .tickerIntervale = 0,
3520 reset_callbacks_and_context();
3522 onQuit = quitCallback;
3524#ifdef HAVE_PIEZO_SOUND
3525 os_io_seph_cmd_piezo_play_tune(TUNE_LEDGER_MOMENT);
3528 info.
centeredInfo.
icon = isSuccess ? &CHECK_CIRCLE_ICON : &DENIED_CIRCLE_ICON;
3533 info.
tuneId = TUNE_TAP_CASUAL;
3549 switch (reviewStatusType) {
3551 msg =
"Operation signed";
3555 msg =
"Operation rejected";
3559 msg =
"Transaction signed";
3563 msg =
"Transaction rejected";
3567 msg =
"Message signed";
3571 msg =
"Message rejected";
3575 msg =
"Address verified";
3579 msg =
"Address verification\ncancelled";
3601 const char *message,
3602 const char *subMessage,
3603 const char *confirmText,
3604 const char *cancelText,
3609 if ((confirmText == NULL) || (cancelText == NULL)) {
3612 reset_callbacks_and_context();
3621 info.
tuneId = TUNE_TAP_CASUAL;
3623 onChoice = callback;
3643 const char *message,
3644 const char *subMessage,
3645 const char *confirmText,
3646 const char *cancelText,
3652 .token = CHOICE_TOKEN,
3653 .topText = confirmText,
3655 .tuneId = TUNE_TAP_CASUAL};
3658 .separationLine =
false,
3659 .emptySpace.height = MEDIUM_CENTERING_HEADER};
3662 if ((confirmText == NULL) || (cancelText == NULL)) {
3666 reset_callbacks_and_context();
3668 onChoice = callback;
3669 layoutDescription.
modal =
false;
3675 layoutDescription.
ticker.tickerCallback = NULL;
3676 sharedContext.usage = SHARE_CTX_CHOICE_WITH_DETAILS;
3677 choiceWithDetailsCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
3678 choiceWithDetailsCtx.details = details;
3682 centeredInfo.
icon = icon;
3683 centeredInfo.
title = message;
3687 if (details != NULL) {
3689 choiceWithDetailsCtx.layoutCtx, &SEARCH_ICON, CHOICE_DETAILS_TOKEN, TUNE_TAP_CASUAL);
3710 const char *subMessage,
3711 const char *confirmText,
3712 const char *cancelText,
3718 .centeredInfo.text1 = message,
3719 .centeredInfo.text2 = subMessage,
3720 .centeredInfo.text3 = NULL,
3722 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3723 .centeredInfo.offsetY = 0,
3724 .confirmationText = confirmText,
3725 .confirmationToken = CHOICE_TOKEN,
3726 .tuneId = TUNE_TAP_CASUAL,
3728 onModalConfirm = callback;
3729 if (modalPageContext != NULL) {
3747 const char *message,
3748 const char *actionText,
3753 reset_callbacks_and_context();
3755 onAction = callback;
3757 content.
tuneId = TUNE_TAP_CASUAL;
3780 const char *reviewTitle,
3781 const char *reviewSubTitle,
3782 const char *rejectText,
3787 .footerToken = QUIT_TOKEN,
3788 .tapActionText = NULL,
3789 .isSwipeable =
true,
3790 .tapActionToken = CONTINUE_TOKEN,
3792 .actionButtonText = NULL,
3793 .
tuneId = TUNE_TAP_CASUAL};
3795 reset_callbacks_and_context();
3803 onQuit = rejectCallback;
3804 onContinue = continueCallback;
3806#ifdef HAVE_PIEZO_SOUND
3808 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
3821 const char *rejectText,
3826 reset_callbacks_and_context();
3829 onChoice = choiceCallback;
3830 onNav = navCallback;
3831 onControls = buttonCallback;
3832 forwardNavOnly =
false;
3833 navType = REVIEW_NAV;
3837 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3839 displayReviewPage(initPage,
true);
3856 const char *rejectText,
3861 reset_callbacks_and_context();
3864 onChoice = callback;
3865 navType = GENERIC_NAV;
3869 genericContext.genericContents.contentsList = localContentsList;
3872 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3874 memcpy(&localContentsList[offset].content.tagValueList,
3881 memcpy(&localContentsList[offset].content.infoLongPress,
3887 genericContext.genericContents.nbContents = offset;
3890 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3892 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3894 displayGenericContextPage(0,
true);
3912 const char *rejectText,
3917 reset_callbacks_and_context();
3920 onChoice = callback;
3921 navType = GENERIC_NAV;
3924 genericContext.genericContents.contentsList = localContentsList;
3927 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3929 memcpy(&localContentsList[offset].content.tagValueList,
3943 genericContext.genericContents.nbContents = offset;
3946 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3948 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3950 displayGenericContextPage(0,
true);
3972 const char *reviewTitle,
3973 const char *reviewSubTitle,
3974 const char *finishTitle,
3977 reset_callbacks_and_context();
3979 useCaseReview(operationType,
4013 const char *reviewTitle,
4014 const char *reviewSubTitle,
4015 const char *finishTitle,
4026 &blindSigningWarning,
4055 const char *reviewTitle,
4056 const char *reviewSubTitle,
4057 const char *finishTitle,
4062 reset_callbacks_and_context();
4065 if (tipBox != NULL) {
4066 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
4069 if ((warning == NULL)
4072 useCaseReview(operationType,
4085 operationType |= NO_THREAT_OPERATION;
4088 operationType |= RISKY_OPERATION;
4090 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4091 reviewWithWarnCtx.isStreaming =
false;
4092 reviewWithWarnCtx.operationType = operationType;
4093 reviewWithWarnCtx.tagValueList = tagValueList;
4094 reviewWithWarnCtx.icon = icon;
4095 reviewWithWarnCtx.reviewTitle = reviewTitle;
4096 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4097 reviewWithWarnCtx.finishTitle = finishTitle;
4098 reviewWithWarnCtx.warning = warning;
4099 reviewWithWarnCtx.choiceCallback = choiceCallback;
4102 if (reviewWithWarnCtx.warning->prelude) {
4107 displayInitialWarning();
4110 useCaseReview(operationType,
4142 const char *reviewTitle,
4143 const char *reviewSubTitle,
4144 const char *finishTitle,
4147 reset_callbacks_and_context();
4149 useCaseReview(operationType,
4170 const char *rejectText,
4173 reset_callbacks_and_context();
4176 onQuit = rejectCallback;
4177 navType = GENERIC_NAV;
4184 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4185 prepareNavInfo(
true, nbPages, rejectText);
4188#ifdef HAVE_PIEZO_SOUND
4190 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4193 displayGenericContextPage(0,
true);
4210 const char *reviewTitle,
4211 const char *reviewSubTitle,
4214 reset_callbacks_and_context();
4216 useCaseReviewStreamingStart(
4217 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4235 const char *reviewTitle,
4236 const char *reviewSubTitle,
4240 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
4260 const char *reviewTitle,
4261 const char *reviewSubTitle,
4265 reset_callbacks_and_context();
4268 if ((warning == NULL)
4271 useCaseReviewStreamingStart(
4272 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4276 operationType |= NO_THREAT_OPERATION;
4279 operationType |= RISKY_OPERATION;
4282 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4283 reviewWithWarnCtx.isStreaming =
true;
4284 reviewWithWarnCtx.operationType = operationType;
4285 reviewWithWarnCtx.icon = icon;
4286 reviewWithWarnCtx.reviewTitle = reviewTitle;
4287 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4288 reviewWithWarnCtx.choiceCallback = choiceCallback;
4289 reviewWithWarnCtx.warning = warning;
4292 if (reviewWithWarnCtx.warning->prelude) {
4297 displayInitialWarning();
4300 useCaseReviewStreamingStart(
4301 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4323 memset(&genericContext, 0,
sizeof(genericContext));
4325 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4326 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
4329 onChoice = bundleNavReviewStreamingChoice;
4330 navType = STREAMING_NAV;
4333 genericContext.genericContents.contentsList = localContentsList;
4334 genericContext.genericContents.nbContents = 1;
4343 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4344 &genericContext.genericContents,
4347 prepareNavInfo(
true,
4349 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4357 displayGenericContextPage(0,
true);
4388 memset(&genericContext, 0,
sizeof(genericContext));
4390 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4393 onChoice = bundleNavReviewStreamingChoice;
4394 navType = STREAMING_NAV;
4397 genericContext.genericContents.contentsList = localContentsList;
4398 genericContext.genericContents.nbContents = 1;
4403 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
4404 &STARTING_CONTENT.content.infoLongPress,
4405 bundleNavContext.reviewStreaming.icon,
4409 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4410 &genericContext.genericContents,
4413 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4415 displayGenericContextPage(0,
true);
4426 reset_callbacks_and_context();
4427 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4430 onChoice = callback;
4431 navType = GENERIC_NAV;
4434 genericContext.genericContents.contentsList = localContentsList;
4435 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
4437 prepareAddressConfirmationPages(
4438 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
4441 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4443 prepareNavInfo(
true, nbPages,
"Cancel");
4445#ifdef HAVE_PIEZO_SOUND
4447 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4450 displayGenericContextPage(0,
true);
4472 const char *reviewTitle,
4473 const char *reviewSubTitle,
4476 reset_callbacks_and_context();
4479 if (addressConfirmationContext.modalLayout) {
4482 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4485 onChoice = choiceCallback;
4486 navType = GENERIC_NAV;
4490 genericContext.genericContents.contentsList = localContentsList;
4495 prepareReviewFirstPage(
4496 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4497 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4500 prepareAddressConfirmationPages(
4501 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4504 genericContext.genericContents.nbContents
4506 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4508 prepareNavInfo(
true, nbPages,
"Cancel");
4510#ifdef HAVE_PIEZO_SOUND
4512 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4515 displayGenericContextPage(0,
true);
4529 if (genericContext.type != USE_CASE_SPINNER) {
4530 memset(&genericContext, 0,
sizeof(genericContext));
4531 genericContext.type = USE_CASE_SPINNER;
4536 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4539 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4546 genericContext.spinnerPosition++;
4549 genericContext.spinnerPosition = 0;
4552 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4556 else if (ret == 2) {
4591 .separationLine =
true,
4592 .backAndText.token = BACK_TOKEN,
4593 .backAndText.tuneId = TUNE_TAP_CASUAL,
4594 .backAndText.text = NULL};
4601 reset_callbacks_and_context();
4603 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
4606 onQuit = backCallback;
4610 layoutDescription.
modal =
false;
4613 keypadContext.hidden = hidden;
4625 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
4632 onValidatePin = validatePinCallback;
4634 keypadContext.pinMinDigits = minDigits;
4635 keypadContext.pinMaxDigits = maxDigits;
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_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_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_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,...
#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
#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()
@ 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 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_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)
#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
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 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