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 keypadContext sharedContext.keypad
57#define reviewWithWarnCtx sharedContext.reviewWithWarning
58#define choiceWithDetailsCtx sharedContext.choiceWithDetails
61#define W3C_DESCRIPTION_MAX_LEN 128
68#define RISKY_OPERATION (1 << 6)
75#define NO_THREAT_OPERATION (1 << 7)
88 ADDRESS_QRCODE_BUTTON_TOKEN,
101 QUIT_TIPBOX_MODAL_TOKEN,
102 WARNING_CHOICE_TOKEN,
104 DISMISS_WARNING_TOKEN,
105 DISMISS_DETAILS_TOKEN,
106 FIRST_WARN_BAR_TOKEN,
117typedef struct DetailsContext_s {
120 uint8_t currentPairIdx;
124 const char *nextPageStart;
127typedef struct AddressConfirmationContext_s {
131} AddressConfirmationContext_t;
134typedef struct KeypadContext_s {
137 uint8_t pinMinDigits;
138 uint8_t pinMaxDigits;
144typedef struct ReviewWithWarningContext_s {
149 const char *reviewTitle;
150 const char *reviewSubTitle;
151 const char *finishTitle;
156 uint8_t securityReportLevel;
158} ReviewWithWarningContext_t;
160typedef struct ChoiceWithDetailsContext_s {
165} ChoiceWithDetailsContext_t;
169 SHARE_CTX_REVIEW_WITH_WARNING,
170 SHARE_CTX_CHOICE_WITH_DETAILS,
171} SharedContextUsage_t;
178 KeypadContext_t keypad;
180 ReviewWithWarningContext_t reviewWithWarning;
181 ChoiceWithDetailsContext_t choiceWithDetails;
183 SharedContextUsage_t usage;
187 USE_CASE_GENERIC = 0,
189} GenericContextType_t;
192 GenericContextType_t type;
193 uint8_t spinnerPosition;
195 int8_t currentContentIdx;
196 uint8_t currentContentElementNb;
197 uint8_t currentElementIdx;
198 bool hasStartingContent;
199 bool hasFinishingContent;
200 const char *detailsItem;
201 const char *detailsvalue;
202 bool detailsWrapping;
203 bool validWarningCtx;
223} nbgl_homeAndSettingsContext_t;
228} nbgl_reviewContext_t;
236} nbgl_reviewStreamingContext_t;
239 nbgl_homeAndSettingsContext_t homeAndSettings;
240 nbgl_reviewContext_t review;
241 nbgl_reviewStreamingContext_t reviewStreaming;
242} nbgl_BundleNavContext_t;
248} SecurityReportItem_t;
255static char tmpString[W3C_DESCRIPTION_MAX_LEN];
275static const char *pageTitle;
278#define activeTipBox genericContext.tipBox
282static bool forwardNavOnly;
283static NavType_t navType;
285static DetailsContext_t detailsContext;
288static SharedContext_t sharedContext;
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) {
905 if (forceFullRefresh) {
915static const nbgl_content_t *genericContextComputeNextPageParams(uint8_t pageIdx,
917 uint8_t *p_nbElementsInNextPage,
920 int8_t nextContentIdx = genericContext.currentContentIdx;
921 int16_t nextElementIdx = genericContext.currentElementIdx;
922 uint8_t nbElementsInNextPage;
925 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
926 *p_nbElementsInNextPage = nbElementsInNextPage;
931 uint8_t nbElementsInCurrentPage;
933 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
934 nextElementIdx += nbElementsInCurrentPage;
939 if ((nextElementIdx >= genericContext.currentContentElementNb)
940 && (genericContext.currentContentElementNb > 0)) {
950 nextElementIdx -= nbElementsInNextPage;
956 if (nextElementIdx < 0) {
958 nextElementIdx = -nbElementsInNextPage;
964 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
965 p_content = &STARTING_CONTENT;
967 else if ((nextContentIdx == genericContext.genericContents.nbContents)
968 && (genericContext.hasFinishingContent)) {
969 p_content = &FINISHING_CONTENT;
972 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
974 if (p_content == NULL) {
989 if ((nextContentIdx != genericContext.currentContentIdx)
990 || (genericContext.currentContentElementNb == 0)) {
991 genericContext.currentContentIdx = nextContentIdx;
992 genericContext.currentContentElementNb = getContentNbElement(p_content);
994 if (nextElementIdx < 0) {
995 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
1000 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
1002 "Invalid element index %d / %d\n",
1004 genericContext.currentContentElementNb);
1009 genericContext.currentElementIdx = nextElementIdx;
1017static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
1018 uint8_t nbElementsInPage,
1022 uint8_t nextElementIdx = genericContext.currentElementIdx;
1024 pageContent->
title = pageTitle;
1027 pageContent->
tuneId = TUNE_TAP_CASUAL;
1029 pageContent->
type = p_content->
type;
1030 switch (pageContent->
type) {
1082 p_tagValueList = NULL;
1094 genericContext.detailsItem = pair->
item;
1095 genericContext.detailsvalue = pair->
value;
1100 if (p_tagValueList != NULL) {
1101 p_tagValueList->
nbPairs = nbElementsInPage;
1104 p_tagValueList->
pairs
1107 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1109 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1115 p_tagValueList->
pairs = NULL;
1119 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1123 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1138 if ((nextElementIdx + nbElementsInPage)
1150 p_tagValueList->
nbPairs = nbElementsInPage;
1151 p_tagValueList->
pairs
1154 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1156 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1161 genericContext.currentPairs = p_tagValueList->
pairs;
1162 genericContext.currentCallback = p_tagValueList->
callback;
1186 < nextElementIdx + nbElementsInPage)) {
1206 bool isFirstOrLastPage
1210 = (navType == STREAMING_NAV)
1211 ? bundleNavContext.reviewStreaming.operationType
1212 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1215 if (isFirstOrLastPage
1216 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1218 if ((operationType & NO_THREAT_OPERATION)
1227 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1234static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh)
1238 uint8_t nbElementsInPage;
1242 if (navType == STREAMING_NAV) {
1244 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1245 bundleNavContext.reviewStreaming.skipCallback();
1249 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1250 bundleNavReviewStreamingChoice(
true);
1257 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1262 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1263 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1273 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1276 if (p_content == NULL) {
1282 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1288 if (forceFullRefresh) {
1297static const char *getDetailsPageAt(uint8_t detailsPage)
1300 const char *currentChar = detailsContext.value;
1301 while (page < detailsPage) {
1311 detailsContext.wrapping);
1313 currentChar = currentChar + len;
1321static void displayDetailsPage(uint8_t detailsPage,
bool forceFullRefresh)
1325 .nbPages = detailsContext.nbPages,
1327 .quitToken = QUIT_TOKEN,
1328 .navWithButtons.navToken = NAV_TOKEN,
1329 .navWithButtons.quitButton =
true,
1330 .navWithButtons.backButton =
true,
1331 .navWithButtons.quitText = NULL,
1332 .progressIndicator =
false,
1333 .tuneId = TUNE_TAP_CASUAL};
1335 .topRightIcon = NULL,
1336 .tagValueList.nbPairs = 1,
1337 .tagValueList.pairs = ¤tPair,
1338 .tagValueList.smallCaseForValue =
true,
1339 .tagValueList.wrapping = detailsContext.wrapping};
1341 if (modalPageContext != NULL) {
1344 currentPair.
item = detailsContext.tag;
1346 if (detailsPage <= detailsContext.currentPage) {
1348 currentPair.
value = getDetailsPageAt(detailsPage);
1349 forceFullRefresh =
true;
1353 currentPair.
value = detailsContext.nextPageStart;
1355 detailsContext.currentPage = detailsPage;
1366 detailsContext.wrapping);
1369 detailsContext.nextPageStart = currentPair.
value + len;
1375 detailsContext.nextPageStart = NULL;
1384 if (forceFullRefresh) {
1393static void displayFullValuePage(
const char *backText,
1394 const char *aliasText,
1397 const char *modalTitle
1398 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1400 genericContext.currentInfos = extension->
infolist;
1401 displayInfosListModal(modalTitle, extension->
infolist,
true);
1404 genericContext.currentTagValues = extension->
tagValuelist;
1409 .withLeftBorder =
true,
1410 .onActionCallback = &modalLayoutTouchCallback,
1411 .tapActionText = NULL};
1413 .separationLine =
false,
1414 .backAndText.token = 0,
1415 .backAndText.tuneId = TUNE_TAP_CASUAL,
1416 .backAndText.text = modalTitle};
1425 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1426 .text2 = extension->explanation,
1437 info =
"ENS names are resolved by Ledger backend.";
1440 info =
"This account label comes from your Address Book in Ledger Live.";
1446 genericContext.modalLayout, aliasText, extension->
fullValue, info);
1455static void displayInfosListModal(
const char *modalTitle,
1462 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1463 .navWithButtons.navToken = NAV_TOKEN,
1464 .navWithButtons.quitButton =
false,
1465 .navWithButtons.backButton =
true,
1466 .navWithButtons.quitText = NULL,
1467 .progressIndicator =
false,
1468 .tuneId = TUNE_TAP_CASUAL};
1471 .topRightIcon = NULL,
1472 .infosList.nbInfos = infos->
nbInfos,
1474 .infosList.infoTypes = infos->
infoTypes,
1477 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1478 .
title = modalTitle,
1479 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1480 .tuneId = TUNE_TAP_CASUAL};
1482 if (modalPageContext != NULL) {
1491static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh)
1494 .nbPages = detailsContext.nbPages,
1496 .quitToken = QUIT_TOKEN,
1497 .navWithButtons.navToken = MODAL_NAV_TOKEN,
1498 .navWithButtons.quitButton =
true,
1499 .navWithButtons.backButton =
true,
1500 .navWithButtons.quitText = NULL,
1501 .progressIndicator =
false,
1502 .tuneId = TUNE_TAP_CASUAL};
1504 .topRightIcon = NULL,
1505 .tagValueList.smallCaseForValue =
true,
1506 .tagValueList.wrapping = detailsContext.wrapping};
1507 uint8_t nbElementsInPage;
1510 if (detailsContext.currentPage <= pageIdx) {
1511 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1515 modalContextGetPageInfo(pageIdx + 1, &nbElementsInPage);
1516 detailsContext.currentPairIdx -= nbElementsInPage;
1517 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1518 detailsContext.currentPairIdx -= nbElementsInPage;
1520 detailsContext.currentPage = pageIdx;
1523 = &genericContext.currentTagValues->pairs[detailsContext.currentPairIdx];
1525 detailsContext.currentPairIdx += nbElementsInPage;
1531 if (modalPageContext != NULL) {
1536 if (forceFullRefresh) {
1545static void displayAddressQRCode(
void)
1549 .withLeftBorder =
true,
1550 .onActionCallback = &modalLayoutTouchCallback,
1551 .tapActionText = NULL};
1553 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1559 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1564 addressConfirmationContext.tagValuePairs[0].value,
1568 if (nbLines <= QRCODE_NB_MAX_LINES) {
1569 qrCode.
text2 = addressConfirmationContext.tagValuePairs[0].value;
1574 addressConfirmationContext.tagValuePairs[0].value,
1576 QRCODE_NB_MAX_LINES,
1578 QRCODE_REDUCED_ADDR_LEN);
1579 qrCode.
text2 = reducedAddress;
1585 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1593static void modalLayoutTouchCallback(
int token, uint8_t index)
1596 if (token == DISMISS_QR_TOKEN) {
1599 addressConfirmationContext.modalLayout = NULL;
1602 else if (token == DISMISS_WARNING_TOKEN) {
1606 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1607 reviewWithWarnCtx.modalLayout = NULL;
1612 reviewWithWarnCtx.securityReportLevel = 1;
1614 if (reviewWithWarnCtx.warning->predefinedSet) {
1615 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1620 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1621 : reviewWithWarnCtx.warning->reviewDetails;
1622 displayCustomizedSecurityReport(details);
1627 else if (token == DISMISS_DETAILS_TOKEN) {
1631 if (choiceWithDetailsCtx.level <= 1) {
1632 choiceWithDetailsCtx.modalLayout = NULL;
1637 choiceWithDetailsCtx.level = 1;
1638 choiceWithDetailsCtx.modalLayout
1639 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1642 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1643 if (sharedContext.usage == SHARE_CTX_REVIEW_WITH_WARNING) {
1646 reviewWithWarnCtx.securityReportLevel = 2;
1648 if (reviewWithWarnCtx.warning->predefinedSet) {
1649 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1654 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1655 : reviewWithWarnCtx.warning->reviewDetails;
1657 displayCustomizedSecurityReport(
1662 else if (sharedContext.usage == SHARE_CTX_CHOICE_WITH_DETAILS) {
1664 = &choiceWithDetailsCtx.details->
barList.
details[token - FIRST_WARN_BAR_TOKEN];
1668 choiceWithDetailsCtx.level = 2;
1669 choiceWithDetailsCtx.modalLayout
1670 = displayModalDetails(details, DISMISS_DETAILS_TOKEN);
1678 genericContext.modalLayout = NULL;
1685static void layoutTouchCallback(
int token, uint8_t index)
1688 if (token == WARNING_CHOICE_TOKEN) {
1690 reviewWithWarnCtx.choiceCallback(
false);
1693 reviewWithWarnCtx.isIntro =
false;
1694 if (reviewWithWarnCtx.isStreaming) {
1695 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1696 reviewWithWarnCtx.icon,
1697 reviewWithWarnCtx.reviewTitle,
1698 reviewWithWarnCtx.reviewSubTitle,
1699 reviewWithWarnCtx.choiceCallback,
1703 useCaseReview(reviewWithWarnCtx.operationType,
1704 reviewWithWarnCtx.tagValueList,
1705 reviewWithWarnCtx.icon,
1706 reviewWithWarnCtx.reviewTitle,
1707 reviewWithWarnCtx.reviewSubTitle,
1708 reviewWithWarnCtx.finishTitle,
1710 reviewWithWarnCtx.choiceCallback,
1717 else if (token == WARNING_BUTTON_TOKEN) {
1719 reviewWithWarnCtx.securityReportLevel = 1;
1721 if (reviewWithWarnCtx.warning->predefinedSet) {
1722 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1727 ? reviewWithWarnCtx.warning->introDetails
1728 : reviewWithWarnCtx.warning->reviewDetails;
1729 displayCustomizedSecurityReport(details);
1733 else if (token == CHOICE_DETAILS_TOKEN) {
1734 choiceWithDetailsCtx.level = 1;
1735 choiceWithDetailsCtx.modalLayout
1736 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1741static void displaySkipWarning(
void)
1744 .cancelText =
"Go back to review",
1745 .centeredInfo.text1 =
"Skip review?",
1747 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1748 .centeredInfo.text3 = NULL,
1750 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1751 .centeredInfo.offsetY = 0,
1752 .confirmationText =
"Yes, skip",
1753 .confirmationToken = SKIP_TOKEN,
1754 .
tuneId = TUNE_TAP_CASUAL,
1756 if (modalPageContext != NULL) {
1768static void updateKeyPad(
bool add)
1770 bool enableValidate, enableBackspace, enableDigits;
1771 bool redrawKeypad =
false;
1774 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1775 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1776 enableBackspace = (keypadContext.pinLen > 0);
1778 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1780 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1782 (keypadContext.pinLen == 1)) {
1783 redrawKeypad =
true;
1787 if ((keypadContext.pinLen == 0) ||
1788 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1790 (keypadContext.pinLen
1791 == (keypadContext.pinMaxDigits - 1))) {
1792 redrawKeypad =
true;
1795 if (keypadContext.hidden ==
true) {
1800 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1804 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1807 if ((!add) && (keypadContext.pinLen == 0)) {
1815static void keypadCallback(
char touchedKey)
1817 switch (touchedKey) {
1819 if (keypadContext.pinLen > 0) {
1820 keypadContext.pinLen--;
1821 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1823 updateKeyPad(
false);
1832 onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1836 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1837 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1838 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1839 keypadContext.pinLen++;
1848static void keypadGenericUseCase(
const char *title,
1854 tune_index_e tuneId,
1860 .separationLine =
true,
1861 .backAndText.token = backToken,
1862 .backAndText.tuneId = tuneId,
1863 .backAndText.text = NULL};
1870 reset_callbacks_and_context();
1872 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
1876 layoutDescription.
modal =
false;
1879 keypadContext.hidden = hidden;
1891 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
1898 onValidatePin = validatePinCallback;
1900 keypadContext.pinMinDigits = minDigits;
1901 keypadContext.pinMaxDigits = maxDigits;
1922static uint8_t getNbTagValuesInPage(uint8_t nbPairs,
1926 bool hasConfirmationButton,
1927 bool hasDetailsButton,
1928 bool *requireSpecificDisplay)
1930 uint8_t nbPairsInPage = 0;
1931 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
1937 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
1940 *requireSpecificDisplay =
false;
1941 while (nbPairsInPage < nbPairs) {
1948 if (nbPairsInPage > 0) {
1949 currentHeight += INTER_TAG_VALUE_MARGIN;
1952 if (tagValueList->
pairs != NULL) {
1953 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
1956 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
1965 if (nbPairsInPage > 0) {
1972 *requireSpecificDisplay =
true;
1984 value_font = SMALL_REGULAR_FONT;
1987 value_font = LARGE_MEDIUM_FONT;
1996 if (nbPairsInPage == 0) {
2000 *requireSpecificDisplay =
true;
2009 if (hasConfirmationButton && (nbPairsInPage == nbPairs)) {
2010 maxUsableHeight -= UP_FOOTER_BUTTON_HEIGHT;
2011 if (currentHeight > maxUsableHeight) {
2016 else if (hasDetailsButton) {
2017 maxUsableHeight -= (SMALL_BUTTON_RADIUS * 2);
2018 if (currentHeight > maxUsableHeight) {
2022 return nbPairsInPage;
2034static uint8_t getNbTagValuesInDetailsPage(uint8_t nbPairs,
2038 uint8_t nbPairsInPage = 0;
2039 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2042 while (nbPairsInPage < nbPairs) {
2047 if (nbPairsInPage > 0) {
2048 currentHeight += INTER_TAG_VALUE_MARGIN;
2051 if (tagValueList->
pairs != NULL) {
2052 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2055 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2069 if (currentHeight >= maxUsableHeight) {
2074 return nbPairsInPage;
2077static uint8_t getNbPagesForContent(
const nbgl_content_t *content,
2078 uint8_t pageIdxStart,
2082 uint8_t nbElements = 0;
2083 uint8_t nbPages = 0;
2084 uint8_t nbElementsInPage;
2085 uint8_t elemIdx = 0;
2088 nbElements = getContentNbElement(content);
2090 while (nbElements > 0) {
2093 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
2095 nbElementsInPage = getNbTagValuesInPage(nbElements,
2104 nbElementsInPage = getNbTagValuesInPage(nbElements,
2129 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
2132 elemIdx += nbElementsInPage;
2133 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
2134 nbElements -= nbElementsInPage;
2142 uint8_t pageIdxStart,
2145 uint8_t nbPages = 0;
2149 for (
int i = 0; i < genericContents->
nbContents; i++) {
2150 p_content = getContentAtIdx(genericContents, i, &content);
2151 if (p_content == NULL) {
2154 nbPages += getNbPagesForContent(p_content,
2155 pageIdxStart + nbPages,
2163static void prepareAddressConfirmationPages(
const char *address,
2170 addressConfirmationContext.tagValuePairs[0].item =
"Address";
2171 addressConfirmationContext.tagValuePairs[0].value = address;
2172 addressConfirmationContext.nbPairs = 1;
2181 if ((tagValueList != NULL) && (tagValueList->
nbPairs < ADDR_VERIF_NB_PAIRS)) {
2185 for (uint8_t i = 0; i < tagValueList->
nbPairs; i++) {
2186 memcpy(&addressConfirmationContext.tagValuePairs[1 + i],
2187 &tagValueList->
pairs[i],
2189 addressConfirmationContext.nbPairs++;
2193 tmpList.
nbPairs = addressConfirmationContext.nbPairs;
2194 tmpList.
pairs = addressConfirmationContext.tagValuePairs;
2195 addressConfirmationContext.nbPairs = getNbTagValuesInPage(
2196 addressConfirmationContext.nbPairs, &tmpList, 0,
false,
true,
true, &flag);
2198 if (tmpList.
nbPairs > addressConfirmationContext.nbPairs) {
2199 addressConfirmationContext.nbPairs = 1;
2210 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2218 if ((tagValueList != NULL)
2219 && (tagValueList->
nbPairs > (addressConfirmationContext.nbPairs - 1))) {
2229 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2232 = tagValueList->
nbPairs - (addressConfirmationContext.nbPairs - 1);
2234 = &tagValueList->
pairs[addressConfirmationContext.nbPairs - 1];
2243static void bundleNavStartHome(
void)
2245 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2247 useCaseHomeExt(context->appName,
2250 context->settingContents != NULL ?
true : false,
2251 &context->homeAction,
2252 bundleNavStartSettings,
2253 context->quitCallback);
2256static void bundleNavStartSettingsAtPage(uint8_t initSettingPage)
2258 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2262 context->settingContents,
2264 bundleNavStartHome);
2267static void bundleNavStartSettings(
void)
2269 bundleNavStartSettingsAtPage(0);
2272static void bundleNavReviewConfirmRejection(
void)
2274 bundleNavContext.review.choiceCallback(
false);
2281 const char *confirmText;
2286 title =
"Reject transaction?";
2287 confirmText =
"Go back to transaction";
2290 title =
"Reject message?";
2291 confirmText =
"Go back to message";
2294 title =
"Reject operation?";
2295 confirmText =
"Go back to operation";
2302static void bundleNavReviewChoice(
bool confirm)
2305 bundleNavContext.review.choiceCallback(
true);
2308 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
2309 bundleNavReviewConfirmRejection);
2313static void bundleNavReviewStreamingConfirmRejection(
void)
2315 bundleNavContext.reviewStreaming.choiceCallback(
false);
2318static void bundleNavReviewStreamingChoice(
bool confirm)
2325 bundleNavContext.reviewStreaming.choiceCallback(
true);
2328 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
2329 bundleNavReviewStreamingConfirmRejection);
2339 .withLeftBorder =
true,
2340 .onActionCallback = modalLayoutTouchCallback,
2341 .tapActionText = NULL};
2343 .separationLine =
true,
2344 .backAndText.icon = NULL,
2345 .backAndText.tuneId = TUNE_TAP_CASUAL,
2346 .backAndText.token = token};
2362 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2363 bar.
tuneId = TUNE_TAP_CASUAL;
2390static void displaySecurityReport(uint32_t set)
2393 .withLeftBorder =
true,
2394 .onActionCallback = modalLayoutTouchCallback,
2395 .tapActionText = NULL};
2397 .separationLine =
true,
2398 .backAndText.icon = NULL,
2399 .backAndText.tuneId = TUNE_TAP_CASUAL,
2400 .backAndText.token = DISMISS_WARNING_TOKEN};
2404 uint8_t nbWarnings = 0;
2405 const char *provider;
2407 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2420 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
2422 if (reviewWithWarnCtx.warning->predefinedSet & (1 << i)) {
2425 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
2426 bar.
subText = securityReportItems[i].subText;
2429 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
2431 bar.
text = securityReportItems[i].text;
2434 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2435 bar.
tuneId = TUNE_TAP_CASUAL;
2440 bar.
iconLeft = securityReportItems[i].icon;
2451 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2452 provider = reviewWithWarnCtx.warning->reportProvider;
2455 provider =
"[unknown]";
2461 + W3C_DESCRIPTION_MAX_LEN / 2;
2465 .text1 = reviewWithWarnCtx.warning->reportUrl,
2466 .text2 =
"Scan to view full report",
2471 W3C_DESCRIPTION_MAX_LEN / 2,
2473 reviewWithWarnCtx.warning->reportUrl);
2474 urlLen = strlen(destStr) + 1;
2479 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2485 info.
icon = &LARGE_WARNING_ICON;
2486 info.
title =
"This transaction cannot be Clear Signed";
2488 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2489 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2498 info.
icon = &LARGE_WARNING_ICON;
2499 info.
title =
"Transaction Check unavailable";
2501 =
"If you're not using the\nLedger Live app, Transaction Check might not work. If your "
2502 "are using Ledger Live, reject the transaction and try again.\n\nGet help at "
2521 reviewWithWarnCtx.modalLayout = displayModalDetails(details, DISMISS_WARNING_TOKEN);
2525static void displayInitialWarning(
void)
2528#ifdef HAVE_PIEZO_SOUND
2529 tune_index_e tune = TUNE_RESERVED;
2533 .token = WARNING_CHOICE_TOKEN,
2534 .topText =
"Back to safety",
2536 .tuneId = TUNE_TAP_CASUAL};
2538 .separationLine =
false,
2539 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2540 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2543 reviewWithWarnCtx.isIntro =
true;
2545 layoutDescription.
modal =
false;
2551 layoutDescription.
ticker.tickerCallback = NULL;
2552 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2555 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2557 reviewWithWarnCtx.layoutCtx,
2559 WARNING_BUTTON_TOKEN,
2562 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2564 reviewWithWarnCtx.warning->introTopRightIcon,
2565 WARNING_BUTTON_TOKEN,
2570 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2573 const char *provider;
2576 info.
icon = &LARGE_WARNING_ICON;
2580 if (reviewWithWarnCtx.warning->reportProvider) {
2581 provider = reviewWithWarnCtx.warning->reportProvider;
2584 provider =
"[unknown]";
2587 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2591 info.
title =
"Blind signing ahead";
2593 =
"This transaction's details are not fully verifiable. If you sign, you could "
2594 "lose all your assets.";
2596#ifdef HAVE_PIEZO_SOUND
2597 tune = TUNE_NEUTRAL;
2601 info.
title =
"Potential risk";
2602 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2606 info.
description = reviewWithWarnCtx.warning->providerMessage;
2608 buttonsInfo.
bottomText =
"Accept risk and continue";
2609#ifdef HAVE_PIEZO_SOUND
2610 tune = TUNE_NEUTRAL;
2614 info.
title =
"Critical threat";
2615 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2619 info.
description = reviewWithWarnCtx.warning->providerMessage;
2621 buttonsInfo.
bottomText =
"Accept threat and continue";
2622#ifdef HAVE_PIEZO_SOUND
2628 else if (reviewWithWarnCtx.warning->info != NULL) {
2631#ifdef HAVE_PIEZO_SOUND
2632 tune = TUNE_LOOK_AT_ME;
2638#ifdef HAVE_PIEZO_SOUND
2639 if (tune != TUNE_RESERVED) {
2640 os_io_seph_cmd_piezo_play_tune(tune);
2650 const char *predefinedTipBoxText = NULL;
2653 if (reviewWithWarnCtx.warning) {
2654 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2656 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2659 predefinedTipBoxText =
"Transaction Check unavailable";
2664 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2667 predefinedTipBoxText =
"Critical threat detected.";
2672 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2675 predefinedTipBoxText =
"Potential risk detected.";
2680 predefinedTipBoxText
2681 =
"No threat detected by Transaction Check but blind signing required.";
2684 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2688 predefinedTipBoxText =
"Blind signing required.";
2692 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2694 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2695 if (predefinedTipBoxText != NULL) {
2696 genericContext.validWarningCtx =
true;
2697 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2698 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2701 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2702 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2704 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2705 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2713 const char *reviewTitle,
2714 const char *reviewSubTitle,
2715 const char *finishTitle,
2719 bool playNotifSound)
2721 reset_callbacks_and_context();
2723 bundleNavContext.review.operationType = operationType;
2724 bundleNavContext.review.choiceCallback = choiceCallback;
2727 onChoice = bundleNavReviewChoice;
2728 navType = GENERIC_NAV;
2731 genericContext.genericContents.contentsList = localContentsList;
2732 genericContext.genericContents.nbContents = 3;
2737 prepareReviewFirstPage(
2738 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2741 initWarningTipBox(tipBox);
2745 memcpy(&localContentsList[1].content.tagValueList,
2753 prepareReviewLightLastPage(
2754 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2758 prepareReviewLastPage(
2759 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2763 uint8_t nbPages = getNbPagesForGenericContents(
2765 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2768 if (playNotifSound) {
2769#ifdef HAVE_PIEZO_SOUND
2770 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2774 displayGenericContextPage(0,
true);
2780 const char *reviewTitle,
2781 const char *reviewSubTitle,
2783 bool playNotifSound)
2785 reset_callbacks_and_context();
2787 bundleNavContext.reviewStreaming.operationType = operationType;
2788 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2789 bundleNavContext.reviewStreaming.icon = icon;
2792 onChoice = bundleNavReviewStreamingChoice;
2793 navType = STREAMING_NAV;
2796 genericContext.genericContents.contentsList = localContentsList;
2797 genericContext.genericContents.nbContents = 1;
2802 prepareReviewFirstPage(
2803 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2806 initWarningTipBox(NULL);
2809 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2816 if (playNotifSound) {
2817#ifdef HAVE_PIEZO_SOUND
2818 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2822 displayGenericContextPage(0,
true);
2841static void useCaseHomeExt(
const char *appName,
2843 const char *tagline,
2850 .centeredInfo.text1 = appName,
2851 .centeredInfo.text3 = NULL,
2853 .centeredInfo.offsetY = 0,
2856 .tapActionText = NULL,
2858 .topRightToken = CONTINUE_TOKEN,
2859 .tuneId = TUNE_TAP_CASUAL};
2860 reset_callbacks_and_context();
2862 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
2877 if (tagline == NULL) {
2881 "This app enables signing\ntransactions on its network.");
2908 onContinue = topRightCallback;
2909 onQuit = quitCallback;
2923static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
2925 memset(&detailsContext, 0,
sizeof(detailsContext));
2931 detailsContext.tag = tag;
2932 detailsContext.value = value;
2934 detailsContext.currentPage = 0;
2935 detailsContext.wrapping = wrapping;
2937 if (detailsContext.nbPages > 1) {
2938 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
2941 uint8_t nbLinesInLastPage
2947 detailsContext.nbPages++;
2951 displayDetailsPage(0,
true);
2957 uint8_t nbElements = 0;
2958 uint8_t nbElementsInPage;
2959 uint8_t elemIdx = 0;
2962 memset(&detailsContext, 0,
sizeof(detailsContext));
2963 nbElements = tagValues->
nbPairs;
2965 while (nbElements > 0) {
2966 nbElementsInPage = getNbTagValuesInDetailsPage(nbElements, tagValues, elemIdx);
2968 elemIdx += nbElementsInPage;
2969 modalContextSetPageInfo(detailsContext.nbPages, nbElementsInPage);
2970 nbElements -= nbElementsInPage;
2971 detailsContext.nbPages++;
2974 displayTagValueListModalPage(0,
true);
2996 bool *requireSpecificDisplay)
2998 return getNbTagValuesInPage(
2999 nbPairs, tagValueList, startIndex,
false,
false,
false, requireSpecificDisplay);
3019 bool *requireSpecificDisplay)
3021 return getNbTagValuesInPage(
3022 nbPairs, tagValueList, startIndex, isSkippable,
false,
false, requireSpecificDisplay);
3039 uint8_t nbInfosInPage = 0;
3040 uint16_t currentHeight = 0;
3041 uint16_t previousHeight;
3042 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3043 const char *
const *infoContents = PIC(infosList->
infoContents);
3045 while (nbInfosInPage < nbInfos) {
3048 += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING + LIST_ITEM_HEADING_SUB_TEXT;
3052 PIC(infoContents[startIndex + nbInfosInPage]),
3059 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3064 previousHeight = currentHeight;
3067 return nbInfosInPage;
3084 uint8_t nbSwitchesInPage = 0;
3085 uint16_t currentHeight = 0;
3086 uint16_t previousHeight = 0;
3087 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3090 while (nbSwitchesInPage < nbSwitches) {
3094 uint16_t textHeight =
MAX(
3095 LIST_ITEM_MIN_TEXT_HEIGHT,
3097 currentHeight += textHeight + 2 * LIST_ITEM_PRE_HEADING;
3100 currentHeight += LIST_ITEM_HEADING_SUB_TEXT;
3110 previousHeight = currentHeight;
3115 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3118 return nbSwitchesInPage;
3135 uint8_t nbBarsInPage = 0;
3136 uint16_t currentHeight = 0;
3137 uint16_t previousHeight;
3138 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3143 while (nbBarsInPage < nbBars) {
3144 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3149 previousHeight = currentHeight;
3154 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3157 return nbBarsInPage;
3174 uint8_t nbChoicesInPage = 0;
3175 uint16_t currentHeight = 0;
3176 uint16_t previousHeight;
3177 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3179 UNUSED(choicesList);
3182 while (nbChoicesInPage < nbChoices) {
3183 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3188 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3193 previousHeight = currentHeight;
3196 return nbChoicesInPage;
3207 uint8_t nbPages = 0;
3208 uint8_t nbPairs = tagValueList->
nbPairs;
3209 uint8_t nbPairsInPage;
3213 while (i < tagValueList->nbPairs) {
3217 nbPairs -= nbPairsInPage;
3229 const char *tagline,
3236 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3245 const char *tagline,
3247 const char *actionButtonText,
3255 .text = actionButtonText};
3258 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3281 reset_callbacks_and_context();
3284 onQuit = quitCallback;
3285 onNav = navCallback;
3286 onControls = controlsCallback;
3288 navType = SETTINGS_NAV;
3291 prepareNavInfo(
false, nbPages, NULL);
3293 displaySettingsPage(initPage,
true);
3311 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
3332 reset_callbacks_and_context();
3335 onQuit = quitCallback;
3336 pageTitle = appName;
3337 navType = GENERIC_NAV;
3339 if (settingContents != NULL) {
3342 if (infosList != NULL) {
3343 genericContext.hasFinishingContent =
true;
3346 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3350 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3351 if (infosList != NULL) {
3352 nbPages += getNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3355 prepareNavInfo(
false, nbPages, NULL);
3357 displayGenericContextPage(initPage,
true);
3396 const char *appName,
3398 const char *tagline,
3406 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3408 reset_callbacks_and_context();
3410 context->appName = appName;
3411 context->appIcon = appIcon;
3412 context->tagline = tagline;
3413 context->settingContents = settingContents;
3414 context->infosList = infosList;
3415 if (action != NULL) {
3421 context->quitCallback = quitCallback;
3424 bundleNavStartSettingsAtPage(initSettingPage);
3427 bundleNavStartHome();
3441 .tickerIntervale = 0,
3445 reset_callbacks_and_context();
3447 onQuit = quitCallback;
3449#ifdef HAVE_PIEZO_SOUND
3450 os_io_seph_cmd_piezo_play_tune(TUNE_LEDGER_MOMENT);
3453 info.
centeredInfo.
icon = isSuccess ? &CHECK_CIRCLE_ICON : &DENIED_CIRCLE_ICON;
3458 info.
tuneId = TUNE_TAP_CASUAL;
3474 switch (reviewStatusType) {
3476 msg =
"Operation signed";
3480 msg =
"Operation rejected";
3484 msg =
"Transaction signed";
3488 msg =
"Transaction rejected";
3492 msg =
"Message signed";
3496 msg =
"Message rejected";
3500 msg =
"Address verified";
3504 msg =
"Address verification\ncancelled";
3526 const char *message,
3527 const char *subMessage,
3528 const char *confirmText,
3529 const char *cancelText,
3534 if ((confirmText == NULL) || (cancelText == NULL)) {
3537 reset_callbacks_and_context();
3546 info.
tuneId = TUNE_TAP_CASUAL;
3548 onChoice = callback;
3568 const char *message,
3569 const char *subMessage,
3570 const char *confirmText,
3571 const char *cancelText,
3577 .token = CHOICE_TOKEN,
3578 .topText = confirmText,
3580 .tuneId = TUNE_TAP_CASUAL};
3583 .separationLine =
false,
3584 .emptySpace.height = MEDIUM_CENTERING_HEADER};
3587 if ((confirmText == NULL) || (cancelText == NULL)) {
3591 reset_callbacks_and_context();
3593 onChoice = callback;
3594 layoutDescription.
modal =
false;
3600 layoutDescription.
ticker.tickerCallback = NULL;
3601 sharedContext.usage = SHARE_CTX_CHOICE_WITH_DETAILS;
3602 choiceWithDetailsCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
3603 choiceWithDetailsCtx.details = details;
3607 centeredInfo.
icon = icon;
3608 centeredInfo.
title = message;
3612 if (details != NULL) {
3614 choiceWithDetailsCtx.layoutCtx, &SEARCH_ICON, CHOICE_DETAILS_TOKEN, TUNE_TAP_CASUAL);
3635 const char *subMessage,
3636 const char *confirmText,
3637 const char *cancelText,
3643 .centeredInfo.text1 = message,
3644 .centeredInfo.text2 = subMessage,
3645 .centeredInfo.text3 = NULL,
3647 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3648 .centeredInfo.offsetY = 0,
3649 .confirmationText = confirmText,
3650 .confirmationToken = CHOICE_TOKEN,
3651 .tuneId = TUNE_TAP_CASUAL,
3653 onModalConfirm = callback;
3654 if (modalPageContext != NULL) {
3672 const char *message,
3673 const char *actionText,
3678 reset_callbacks_and_context();
3680 onAction = callback;
3682 content.
tuneId = TUNE_TAP_CASUAL;
3705 const char *reviewTitle,
3706 const char *reviewSubTitle,
3707 const char *rejectText,
3712 .footerToken = QUIT_TOKEN,
3713 .tapActionText = NULL,
3714 .isSwipeable =
true,
3715 .tapActionToken = CONTINUE_TOKEN,
3717 .actionButtonText = NULL,
3718 .
tuneId = TUNE_TAP_CASUAL};
3720 reset_callbacks_and_context();
3728 onQuit = rejectCallback;
3729 onContinue = continueCallback;
3731#ifdef HAVE_PIEZO_SOUND
3733 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
3746 const char *rejectText,
3751 reset_callbacks_and_context();
3754 onChoice = choiceCallback;
3755 onNav = navCallback;
3756 onControls = buttonCallback;
3757 forwardNavOnly =
false;
3758 navType = REVIEW_NAV;
3762 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3764 displayReviewPage(initPage,
true);
3781 const char *rejectText,
3786 reset_callbacks_and_context();
3789 onChoice = callback;
3790 navType = GENERIC_NAV;
3794 genericContext.genericContents.contentsList = localContentsList;
3797 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3799 memcpy(&localContentsList[offset].content.tagValueList,
3806 memcpy(&localContentsList[offset].content.infoLongPress,
3812 genericContext.genericContents.nbContents = offset;
3815 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3817 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3819 displayGenericContextPage(0,
true);
3837 const char *rejectText,
3842 reset_callbacks_and_context();
3845 onChoice = callback;
3846 navType = GENERIC_NAV;
3849 genericContext.genericContents.contentsList = localContentsList;
3852 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3854 memcpy(&localContentsList[offset].content.tagValueList,
3868 genericContext.genericContents.nbContents = offset;
3871 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3873 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3875 displayGenericContextPage(0,
true);
3897 const char *reviewTitle,
3898 const char *reviewSubTitle,
3899 const char *finishTitle,
3902 useCaseReview(operationType,
3936 const char *reviewTitle,
3937 const char *reviewSubTitle,
3938 const char *finishTitle,
3949 &blindSigningWarning,
3978 const char *reviewTitle,
3979 const char *reviewSubTitle,
3980 const char *finishTitle,
3985 reset_callbacks_and_context();
3986 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
3989 if (tipBox != NULL) {
3990 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
3993 if ((warning == NULL)
3996 useCaseReview(operationType,
4009 operationType |= NO_THREAT_OPERATION;
4012 operationType |= RISKY_OPERATION;
4014 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4015 reviewWithWarnCtx.isStreaming =
false;
4016 reviewWithWarnCtx.operationType = operationType;
4017 reviewWithWarnCtx.tagValueList = tagValueList;
4018 reviewWithWarnCtx.icon = icon;
4019 reviewWithWarnCtx.reviewTitle = reviewTitle;
4020 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4021 reviewWithWarnCtx.finishTitle = finishTitle;
4022 reviewWithWarnCtx.warning = warning;
4023 reviewWithWarnCtx.choiceCallback = choiceCallback;
4030 useCaseReview(operationType,
4043 displayInitialWarning();
4065 const char *reviewTitle,
4066 const char *reviewSubTitle,
4067 const char *finishTitle,
4070 useCaseReview(operationType,
4091 const char *rejectText,
4094 reset_callbacks_and_context();
4097 onQuit = rejectCallback;
4098 navType = GENERIC_NAV;
4105 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4106 prepareNavInfo(
true, nbPages, rejectText);
4109#ifdef HAVE_PIEZO_SOUND
4111 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4114 displayGenericContextPage(0,
true);
4131 const char *reviewTitle,
4132 const char *reviewSubTitle,
4135 useCaseReviewStreamingStart(
4136 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4154 const char *reviewTitle,
4155 const char *reviewSubTitle,
4159 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
4179 const char *reviewTitle,
4180 const char *reviewSubTitle,
4184 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
4186 if ((warning == NULL)
4189 useCaseReviewStreamingStart(
4190 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4194 operationType |= NO_THREAT_OPERATION;
4197 operationType |= RISKY_OPERATION;
4200 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4201 reviewWithWarnCtx.isStreaming =
true;
4202 reviewWithWarnCtx.operationType = operationType;
4203 reviewWithWarnCtx.icon = icon;
4204 reviewWithWarnCtx.reviewTitle = reviewTitle;
4205 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4206 reviewWithWarnCtx.choiceCallback = choiceCallback;
4207 reviewWithWarnCtx.warning = warning;
4213 useCaseReviewStreamingStart(
4214 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4217 displayInitialWarning();
4238 memset(&genericContext, 0,
sizeof(genericContext));
4240 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4241 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
4244 onChoice = bundleNavReviewStreamingChoice;
4245 navType = STREAMING_NAV;
4248 genericContext.genericContents.contentsList = localContentsList;
4249 genericContext.genericContents.nbContents = 1;
4258 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4259 &genericContext.genericContents,
4262 prepareNavInfo(
true,
4264 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4272 displayGenericContextPage(0,
true);
4303 memset(&genericContext, 0,
sizeof(genericContext));
4305 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4308 onChoice = bundleNavReviewStreamingChoice;
4309 navType = STREAMING_NAV;
4312 genericContext.genericContents.contentsList = localContentsList;
4313 genericContext.genericContents.nbContents = 1;
4318 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
4319 &STARTING_CONTENT.content.infoLongPress,
4320 bundleNavContext.reviewStreaming.icon,
4324 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4325 &genericContext.genericContents,
4328 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4330 displayGenericContextPage(0,
true);
4341 reset_callbacks_and_context();
4342 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4345 onChoice = callback;
4346 navType = GENERIC_NAV;
4349 genericContext.genericContents.contentsList = localContentsList;
4350 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
4352 prepareAddressConfirmationPages(
4353 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
4356 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4358 prepareNavInfo(
true, nbPages,
"Cancel");
4360#ifdef HAVE_PIEZO_SOUND
4362 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4365 displayGenericContextPage(0,
true);
4387 const char *reviewTitle,
4388 const char *reviewSubTitle,
4391 reset_callbacks_and_context();
4394 if (addressConfirmationContext.modalLayout) {
4397 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4400 onChoice = choiceCallback;
4401 navType = GENERIC_NAV;
4405 genericContext.genericContents.contentsList = localContentsList;
4410 prepareReviewFirstPage(
4411 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4412 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4415 prepareAddressConfirmationPages(
4416 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4419 genericContext.genericContents.nbContents
4421 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4423 prepareNavInfo(
true, nbPages,
"Cancel");
4425#ifdef HAVE_PIEZO_SOUND
4427 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4430 displayGenericContextPage(0,
true);
4444 if (genericContext.type != USE_CASE_SPINNER) {
4445 memset(&genericContext, 0,
sizeof(genericContext));
4446 genericContext.type = USE_CASE_SPINNER;
4451 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4454 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4461 genericContext.spinnerPosition++;
4464 genericContext.spinnerPosition = 0;
4467 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4471 else if (ret == 2) {
4502 tune_index_e tuneId,
4506 keypadGenericUseCase(title,
4513 validatePinCallback,
4540 tune_index_e tuneId,
4544 keypadGenericUseCase(title,
4551 validatePinCallback,
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)
compute the len of the given text (in bytes) fitting in the given maximum nb lines,...
void nbgl_textReduceOnNbLines(nbgl_font_id_e fontId, const char *origText, uint16_t maxWidth, uint8_t nbLines, char *reducedText, uint16_t reducedTextLen)
Create a reduced version of given ASCII text to wrap it on the given max width (in pixels),...
uint16_t nbgl_getTextHeightInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
return the height of the given multiline text, with the given font.
uint16_t nbgl_getTextNbLinesInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
compute the number of lines of the given text fitting in the given maxWidth
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_layoutAddTextContent(nbgl_layout_t *layout, const char *title, const char *description, const char *info)
Creates in the main container three text areas:
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.
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,...
@ 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
void nbgl_refresh(void)
This functions refreshes the actual screen on display with what has changed since the last refresh.
#define KEYPAD_MAX_DIGITS
void nbgl_refreshSpecial(nbgl_refresh_mode_t mode)
This functions refreshes the actual screen on display with what has changed since the last refresh,...
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)
This function redraws the whole screen on top of stack and its children.
@ 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)
void nbgl_useCaseKeypadPIN(const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)
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)
void nbgl_useCaseKeypadDigits(const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)
#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.
@ 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_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.
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
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 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.
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_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