18#include "os_helpers.h"
25#define PAGE_NB_ELEMENTS_BITS 3
26#define GET_PAGE_NB_ELEMENTS(pageData) ((pageData) &0x07)
27#define SET_PAGE_NB_ELEMENTS(nbElements) ((nbElements) &0x07)
29#define PAGE_FLAG_BITS 1
30#define GET_PAGE_FLAG(pageData) (((pageData) &0x08) >> 3)
31#define SET_PAGE_FLAG(flag) (((flag) &0x01) << 3)
33#define PAGE_DATA_BITS (PAGE_NB_ELEMENTS_BITS + PAGE_FLAG_BITS)
34#define PAGES_PER_UINT8 (8 / PAGE_DATA_BITS)
35#define SET_PAGE_DATA(pageIdx, pageData) \
36 (pagesData[pageIdx / PAGES_PER_UINT8] = pageData \
37 << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS))
39#define MAX_PAGE_NB 256
42#define STARTING_CONTENT localContentsList[0]
43#define FINISHING_CONTENT localContentsList[1]
46#define QRCODE_NB_MAX_LINES 3
48#define QRCODE_REDUCED_ADDR_LEN 128
51#define keypadContext sharedContext.keypad
52#define reviewWithWarnCtx sharedContext.reviewWithWarning
55#define W3C_DESCRIPTION_MAX_LEN 128
62#define RISKY_OPERATION (1 << 6)
69#define NO_THREAT_OPERATION (1 << 7)
81 ADDRESS_QRCODE_BUTTON_TOKEN,
93 QUIT_TIPBOX_MODAL_TOKEN,
96 DISMISS_WARNING_TOKEN,
108typedef struct DetailsContext_s {
114 const char *nextPageStart;
117typedef struct AddressConfirmationContext_s {
120} AddressConfirmationContext_t;
123typedef struct KeypadContext_s {
133typedef struct ReviewWithWarningContext_s {
138 const char *reviewTitle;
139 const char *reviewSubTitle;
140 const char *finishTitle;
147} ReviewWithWarningContext_t;
153 KeypadContext_t keypad;
155 ReviewWithWarningContext_t reviewWithWarning;
159 USE_CASE_GENERIC = 0,
161} GenericContextType_t;
164 GenericContextType_t type;
168 uint8_t currentContentElementNb;
170 bool hasStartingContent;
171 bool hasFinishingContent;
172 const char *detailsItem;
173 const char *detailsvalue;
174 bool detailsWrapping;
175 bool validWarningCtx;
193} nbgl_homeAndSettingsContext_t;
198} nbgl_reviewContext_t;
206} nbgl_reviewStreamingContext_t;
209 nbgl_homeAndSettingsContext_t homeAndSettings;
210 nbgl_reviewContext_t review;
211 nbgl_reviewStreamingContext_t reviewStreaming;
212} nbgl_BundleNavContext_t;
218} SecurityReportItem_t;
225static char tmpString[W3C_DESCRIPTION_MAX_LEN];
245static const char *pageTitle;
252static bool forwardNavOnly;
253static NavType_t navType;
255static DetailsContext_t detailsContext;
258static SharedContext_t sharedContext;
261static AddressConfirmationContext_t addressConfirmationContext;
264static GenericContext_t genericContext;
266 localContentsList[3];
267static uint8_t genericContextPagesInfo[MAX_PAGE_NB / PAGES_PER_UINT8];
270static nbgl_BundleNavContext_t bundleNavContext;
273static const uint8_t nbMaxElementsPerContentType[] = {
290 .icon = &WARNING_ICON,
291 .text =
"Blind signing required",
292 .subText =
"This transaction's details are not fully verifiable. If "
293 "you sign, you could lose all your assets."
296 .icon = &WARNING_ICON,
297 .text =
"Transaction Check unavailable",
301 .icon = &WARNING_ICON,
302 .text =
"Risk detected",
303 .subText =
"This transaction was scanned as risky by Web3 Checks."
306 .icon = &WARNING_ICON,
307 .text =
"Critical threat",
308 .subText =
"This transaction was scanned as malicious by Web3 Checks."
312 .text =
"No threat detected",
313 .subText =
"Transaction Check didn't find any threat, but always "
314 "review transaction details carefully."
324static char reducedAddress[QRCODE_REDUCED_ADDR_LEN];
330static void displayReviewPage(
uint8_t page,
bool forceFullRefresh);
331static void displayDetailsPage(
uint8_t page,
bool forceFullRefresh);
332static void displayFullValuePage(
const char *backText,
333 const char *aliasText,
335static void displayInfosListModal(
const char *modalTitle,
338static void displaySettingsPage(
uint8_t page,
bool forceFullRefresh);
339static void displayGenericContextPage(
uint8_t pageIdx,
bool forceFullRefresh);
340static void pageCallback(
int token,
uint8_t index);
342static void displayAddressQRCode(
void);
344static void modalLayoutTouchCallback(
int token,
uint8_t index);
345static void displaySkipWarning(
void);
347static void bundleNavStartHome(
void);
348static void bundleNavStartSettingsAtPage(
uint8_t initSettingPage);
349static void bundleNavStartSettings(
void);
351static void bundleNavReviewStreamingChoice(
bool confirm);
352static void displaySecurityReport(uint32_t set);
354static void displayInitialWarning(
void);
358 const char *reviewTitle,
359 const char *reviewSubTitle,
360 const char *finishTitle,
364 bool playNotifSound);
367 const char *reviewTitle,
368 const char *reviewSubTitle,
370 bool playNotifSound);
371static void useCaseHomeExt(
const char *appName,
378static void displayDetails(
const char *tag,
const char *value,
bool wrapping);
380static void reset_callbacks(
void)
387 onContentAction = NULL;
389 onModalConfirm = NULL;
391 onValidatePin = NULL;
396static void genericContextSetPageInfo(
uint8_t pageIdx,
uint8_t nbElements,
bool flag)
398 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements) + SET_PAGE_FLAG(flag);
400 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
401 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
402 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
403 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
407static void genericContextGetPageInfo(
uint8_t pageIdx,
uint8_t *nbElements,
bool *flag)
409 uint8_t pageData = genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
410 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
411 if (nbElements != NULL) {
412 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
415 *flag = GET_PAGE_FLAG(pageData);
422 switch (content->
type) {
444 if (contentIdx < 0 || contentIdx >= genericContents->
nbContents) {
461static void prepareNavInfo(
bool isReview,
uint8_t nbPages,
const char *rejectText)
463 memset(&navInfo, 0,
sizeof(navInfo));
466 navInfo.
tuneId = TUNE_TAP_CASUAL;
470 if (isReview ==
false) {
479 = ((navType == STREAMING_NAV) && (nbPages < 2)) ?
false : true;
486 const char *reviewTitle,
487 const char *reviewSubTitle)
489 contentCenter->
icon = icon;
490 contentCenter->
title = reviewTitle;
492 contentCenter->
subText =
"Swipe to review";
495 contentCenter->
padding =
false;
501 if (finishTitle != NULL) {
506 return "Sign transaction";
508 return "Sign message";
510 return "Sign operation";
517 const char *finishTitle)
519 infoLongPress->
text = getFinishTitle(operationType, finishTitle);
520 infoLongPress->
icon = icon;
528 const char *finishTitle)
530 infoButton->
text = getFinishTitle(operationType, finishTitle);
531 infoButton->
icon = icon;
538 UNUSED(operationType);
544static void pageModalCallback(
int token,
uint8_t index)
548 if (token == INFOS_TIP_BOX_TOKEN) {
555 else if (token == INFO_ALIAS_TOKEN) {
557 displayFullValuePage(genericContext.currentInfos->infoTypes[index],
558 genericContext.currentInfos->infoContents[index],
559 &genericContext.currentInfos->infoExtensions[index]);
563 modalPageContext = NULL;
564 if (token == NAV_TOKEN) {
571 displayDetailsPage(index,
false);
574 else if (token == QUIT_TOKEN) {
579 else if (token == QUIT_TIPBOX_MODAL_TOKEN) {
581 if (reviewWithWarnCtx.securityReportLevel == 2) {
582 reviewWithWarnCtx.securityReportLevel = 1;
583 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
591 else if (token == SKIP_TOKEN) {
602 else if (token == CHOICE_TOKEN) {
604 if (onModalConfirm != NULL) {
617static void pageCallback(
int token,
uint8_t index)
620 if (token == QUIT_TOKEN) {
621 if (onQuit != NULL) {
625 else if (token == CONTINUE_TOKEN) {
626 if (onContinue != NULL) {
630 else if (token == CHOICE_TOKEN) {
631 if (onChoice != NULL) {
632 onChoice((index == 0) ?
true : false);
635 else if (token == ACTION_BUTTON_TOKEN) {
636 if ((index == 0) && (onAction != NULL)) {
639 else if ((index == 1) && (onQuit != NULL)) {
644 else if (token == ADDRESS_QRCODE_BUTTON_TOKEN) {
645 displayAddressQRCode();
648 else if (token == CONFIRM_TOKEN) {
649 if (onChoice != NULL) {
653 else if (token == REJECT_TOKEN) {
654 if (onChoice != NULL) {
658 else if (token == DETAILS_BUTTON_TOKEN) {
659 displayDetails(genericContext.detailsItem,
660 genericContext.detailsvalue,
661 genericContext.detailsWrapping);
663 else if (token == NAV_TOKEN) {
665 if (onQuit != NULL) {
670 if (navType == GENERIC_NAV || navType == STREAMING_NAV) {
671 displayGenericContextPage(index,
false);
673 else if (navType == REVIEW_NAV) {
674 displayReviewPage(index,
false);
677 displaySettingsPage(index,
false);
681 else if (token == NEXT_TOKEN) {
683 displayReviewPage(navInfo.
activePage + 1,
false);
686 displayGenericContextPage(navInfo.
activePage + 1,
false);
689 else if (token == BACK_TOKEN) {
691 displayReviewPage(navInfo.
activePage - 1,
true);
694 displayGenericContextPage(navInfo.
activePage - 1,
false);
697 else if (token == SKIP_TOKEN) {
699 displaySkipWarning();
701 else if (token == VALUE_ALIAS_TOKEN) {
704 if (genericContext.currentPairs != NULL) {
705 pair = &genericContext.currentPairs[genericContext.currentElementIdx + index];
708 pair = genericContext.currentCallback(genericContext.currentElementIdx + index);
712 else if (token == BLIND_WARNING_TOKEN) {
713 reviewWithWarnCtx.isIntro =
false;
714 reviewWithWarnCtx.warning = NULL;
717 else if (token == WARNING_BUTTON_TOKEN) {
719 reviewWithWarnCtx.securityReportLevel = 1;
721 if (reviewWithWarnCtx.warning->predefinedSet) {
722 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
726 if (reviewWithWarnCtx.isIntro) {
727 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->introDetails);
730 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->reviewDetails);
734 else if (token == TIP_BOX_TOKEN) {
736 if (genericContext.validWarningCtx && (reviewWithWarnCtx.warning->predefinedSet != 0)) {
737 reviewWithWarnCtx.securityReportLevel = 1;
738 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
741 displayInfosListModal(activeTipBox.
modalTitle, &activeTipBox.
infos,
false);
745 if (onContentAction != NULL) {
746 onContentAction(token, index, navInfo.
activePage);
748 if (onControls != NULL) {
749 onControls(token, index);
755static void tickerCallback(
void)
758 if (onQuit != NULL) {
764static void displaySettingsPage(
uint8_t page,
bool forceFullRefresh)
768 if ((onNav == NULL) || (onNav(page, &content) ==
false)) {
773 content.
title = pageTitle;
776 content.
tuneId = TUNE_TAP_CASUAL;
781 if (forceFullRefresh) {
790static void displayReviewPage(
uint8_t page,
bool forceFullRefresh)
799 if ((onNav == NULL) || (onNav(navInfo.
activePage, &content) ==
false)) {
804 content.
title = NULL;
806 content.
tuneId = TUNE_TAP_CASUAL;
813 if (forwardNavOnly) {
837 if (forceFullRefresh) {
849 uint8_t *p_nbElementsInNextPage,
852 int8_t nextContentIdx = genericContext.currentContentIdx;
853 int16_t nextElementIdx = genericContext.currentElementIdx;
857 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
858 *p_nbElementsInNextPage = nbElementsInNextPage;
863 uint8_t nbElementsInCurrentPage;
865 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
866 nextElementIdx += nbElementsInCurrentPage;
871 if ((nextElementIdx >= genericContext.currentContentElementNb)
872 && (genericContext.currentContentElementNb > 0)) {
882 nextElementIdx -= nbElementsInNextPage;
888 if (nextElementIdx < 0) {
890 nextElementIdx = -nbElementsInNextPage;
896 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
897 p_content = &STARTING_CONTENT;
899 else if ((nextContentIdx == genericContext.genericContents.nbContents)
900 && (genericContext.hasFinishingContent)) {
901 p_content = &FINISHING_CONTENT;
904 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
906 if (p_content == NULL) {
921 if ((nextContentIdx != genericContext.currentContentIdx)
922 || (genericContext.currentContentElementNb == 0)) {
923 genericContext.currentContentIdx = nextContentIdx;
924 genericContext.currentContentElementNb = getContentNbElement(p_content);
926 if (nextElementIdx < 0) {
927 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
932 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
934 "Invalid element index %d / %d\n",
936 genericContext.currentContentElementNb);
941 genericContext.currentElementIdx = nextElementIdx;
949static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
954 uint8_t nextElementIdx = genericContext.currentElementIdx;
956 pageContent->
title = pageTitle;
959 pageContent->
tuneId = TUNE_TAP_CASUAL;
961 pageContent->
type = p_content->
type;
962 switch (pageContent->
type) {
1014 p_tagValueList = NULL;
1026 genericContext.detailsItem = pair->
item;
1027 genericContext.detailsvalue = pair->
value;
1032 if (p_tagValueList != NULL) {
1033 p_tagValueList->
nbPairs = nbElementsInPage;
1036 p_tagValueList->
pairs
1039 for (
uint8_t i = 0; i < nbElementsInPage; i++) {
1041 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1047 p_tagValueList->
pairs = NULL;
1051 for (
uint8_t i = 0; i < nbElementsInPage; i++) {
1055 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1093 < nextElementIdx + nbElementsInPage)) {
1113 bool isFirstOrLastPage
1117 = (navType == STREAMING_NAV)
1118 ? bundleNavContext.reviewStreaming.operationType
1119 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1122 if (isFirstOrLastPage
1123 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1125 if ((operationType & NO_THREAT_OPERATION)
1134 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1141static void displayGenericContextPage(
uint8_t pageIdx,
bool forceFullRefresh)
1149 if (navType == STREAMING_NAV) {
1151 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1152 bundleNavContext.reviewStreaming.skipCallback();
1156 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1157 bundleNavReviewStreamingChoice(
true);
1164 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1169 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1170 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1180 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1183 if (p_content == NULL) {
1189 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1195 if (forceFullRefresh) {
1204static const char *getDetailsPageAt(
uint8_t detailsPage)
1207 const char *currentChar = detailsContext.value;
1208 while (page < detailsPage) {
1218 detailsContext.wrapping);
1220 currentChar = currentChar + len;
1228static void displayDetailsPage(
uint8_t detailsPage,
bool forceFullRefresh)
1232 .nbPages = detailsContext.nbPages,
1234 .quitToken = QUIT_TOKEN,
1235 .navWithButtons.navToken = NAV_TOKEN,
1236 .navWithButtons.quitButton =
true,
1237 .navWithButtons.backButton =
true,
1238 .navWithButtons.quitText = NULL,
1239 .progressIndicator =
false,
1240 .tuneId = TUNE_TAP_CASUAL};
1242 .topRightIcon = NULL,
1243 .tagValueList.nbPairs = 1,
1244 .tagValueList.pairs = ¤tPair,
1245 .tagValueList.smallCaseForValue =
true,
1246 .tagValueList.wrapping = detailsContext.wrapping};
1248 if (modalPageContext != NULL) {
1251 currentPair.
item = detailsContext.tag;
1253 if (detailsPage <= detailsContext.currentPage) {
1255 currentPair.
value = getDetailsPageAt(detailsPage);
1256 forceFullRefresh =
true;
1260 currentPair.
value = detailsContext.nextPageStart;
1262 detailsContext.currentPage = detailsPage;
1273 detailsContext.wrapping);
1276 detailsContext.nextPageStart = currentPair.
value + len;
1282 detailsContext.nextPageStart = NULL;
1291 if (forceFullRefresh) {
1300static void displayFullValuePage(
const char *backText,
1301 const char *aliasText,
1304 const char *modalTitle
1305 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1307 genericContext.currentInfos = extension->
infolist;
1308 displayInfosListModal(modalTitle, extension->
infolist,
true);
1312 .withLeftBorder =
true,
1313 .onActionCallback = &modalLayoutTouchCallback,
1314 .tapActionText = NULL};
1316 .separationLine =
false,
1317 .backAndText.token = 0,
1318 .backAndText.tuneId = TUNE_TAP_CASUAL,
1319 .backAndText.text = modalTitle};
1328 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1329 .text2 = extension->explanation,
1340 info =
"ENS names are resolved by Ledger backend.";
1343 info =
"This account label comes from your Address Book in Ledger Live.";
1349 genericContext.modalLayout, aliasText, extension->
fullValue, info);
1358static void displayInfosListModal(
const char *modalTitle,
1365 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1366 .navWithButtons.navToken = NAV_TOKEN,
1367 .navWithButtons.quitButton =
false,
1368 .navWithButtons.backButton =
true,
1369 .navWithButtons.quitText = NULL,
1370 .progressIndicator =
false,
1371 .tuneId = TUNE_TAP_CASUAL};
1374 .topRightIcon = NULL,
1375 .infosList.nbInfos = infos->
nbInfos,
1377 .infosList.infoTypes = infos->
infoTypes,
1380 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1381 .
title = modalTitle,
1382 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1383 .tuneId = TUNE_TAP_CASUAL};
1385 if (modalPageContext != NULL) {
1394static void displayAddressQRCode(
void)
1398 .withLeftBorder =
true,
1399 .onActionCallback = &modalLayoutTouchCallback,
1400 .tapActionText = NULL};
1402 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1408 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1413 SMALL_REGULAR_FONT, addressConfirmationContext.tagValuePair.value,
AVAILABLE_WIDTH,
false);
1415 if (nbLines <= QRCODE_NB_MAX_LINES) {
1416 qrCode.
text2 = addressConfirmationContext.tagValuePair.value;
1421 addressConfirmationContext.tagValuePair.value,
1423 QRCODE_NB_MAX_LINES,
1425 QRCODE_REDUCED_ADDR_LEN);
1426 qrCode.
text2 = reducedAddress;
1432 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1440static void modalLayoutTouchCallback(
int token,
uint8_t index)
1443 if (token == DISMISS_QR_TOKEN) {
1446 addressConfirmationContext.modalLayout = NULL;
1449 else if (token == DISMISS_WARNING_TOKEN) {
1453 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1454 reviewWithWarnCtx.modalLayout = NULL;
1459 reviewWithWarnCtx.securityReportLevel = 1;
1461 if (reviewWithWarnCtx.warning->predefinedSet) {
1462 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1467 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1468 : reviewWithWarnCtx.warning->reviewDetails;
1469 displayCustomizedSecurityReport(details);
1474 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1477 reviewWithWarnCtx.securityReportLevel = 2;
1479 if (reviewWithWarnCtx.warning->predefinedSet) {
1480 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1485 ? reviewWithWarnCtx.warning->introDetails
1486 : reviewWithWarnCtx.warning->reviewDetails;
1488 displayCustomizedSecurityReport(
1497 genericContext.modalLayout = NULL;
1504static void layoutTouchCallback(
int token,
uint8_t index)
1507 if (token == WARNING_CHOICE_TOKEN) {
1509 reviewWithWarnCtx.choiceCallback(
false);
1512 reviewWithWarnCtx.isIntro =
false;
1513 if (reviewWithWarnCtx.isStreaming) {
1514 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1515 reviewWithWarnCtx.icon,
1516 reviewWithWarnCtx.reviewTitle,
1517 reviewWithWarnCtx.reviewSubTitle,
1518 reviewWithWarnCtx.choiceCallback,
1522 useCaseReview(reviewWithWarnCtx.operationType,
1523 reviewWithWarnCtx.tagValueList,
1524 reviewWithWarnCtx.icon,
1525 reviewWithWarnCtx.reviewTitle,
1526 reviewWithWarnCtx.reviewSubTitle,
1527 reviewWithWarnCtx.finishTitle,
1529 reviewWithWarnCtx.choiceCallback,
1536 else if (token == WARNING_BUTTON_TOKEN) {
1538 reviewWithWarnCtx.securityReportLevel = 1;
1540 if (reviewWithWarnCtx.warning->predefinedSet) {
1541 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1546 ? reviewWithWarnCtx.warning->introDetails
1547 : reviewWithWarnCtx.warning->reviewDetails;
1548 displayCustomizedSecurityReport(details);
1554static void displaySkipWarning(
void)
1557 .cancelText =
"Go back to review",
1558 .centeredInfo.text1 =
"Skip review?",
1560 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1561 .centeredInfo.text3 = NULL,
1563 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1564 .centeredInfo.offsetY = 0,
1565 .confirmationText =
"Yes, skip",
1566 .confirmationToken = SKIP_TOKEN,
1567 .
tuneId = TUNE_TAP_CASUAL,
1569 if (modalPageContext != NULL) {
1581static void updateKeyPad(
bool add)
1583 bool enableValidate, enableBackspace, enableDigits;
1584 bool redrawKeypad =
false;
1587 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1588 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1589 enableBackspace = (keypadContext.pinLen > 0);
1591 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1593 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1595 (keypadContext.pinLen == 1)) {
1596 redrawKeypad =
true;
1600 if ((keypadContext.pinLen == 0) ||
1601 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1603 (keypadContext.pinLen
1604 == (keypadContext.pinMaxDigits - 1))) {
1605 redrawKeypad =
true;
1608 if (keypadContext.hidden ==
true) {
1613 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1617 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1620 if ((!add) && (keypadContext.pinLen == 0)) {
1628static void keypadCallback(
char touchedKey)
1630 switch (touchedKey) {
1632 if (keypadContext.pinLen > 0) {
1633 keypadContext.pinLen--;
1634 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1636 updateKeyPad(
false);
1645 onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1649 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1650 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1651 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1652 keypadContext.pinLen++;
1661static void keypadGenericUseCase(
const char *title,
1667 tune_index_e tuneId,
1673 .separationLine =
true,
1674 .backAndText.token = backToken,
1675 .backAndText.tuneId = tuneId,
1676 .backAndText.text = NULL};
1685 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
1689 layoutDescription.
modal =
false;
1692 keypadContext.hidden = hidden;
1704 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
1711 onValidatePin = validatePinCallback;
1713 keypadContext.pinMinDigits = minDigits;
1714 keypadContext.pinMaxDigits = maxDigits;
1732 nbElements = getContentNbElement(content);
1734 while (nbElements > 0) {
1737 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
1759 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
1762 elemIdx += nbElementsInPage;
1763 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
1764 nbElements -= nbElementsInPage;
1779 for (
int i = 0; i < genericContents->
nbContents; i++) {
1780 p_content = getContentAtIdx(genericContents, i, &content);
1781 if (p_content == NULL) {
1784 nbPages += nbgl_useCaseGetNbPagesForContent(p_content,
1785 pageIdxStart + nbPages,
1793static void prepareAddressConfirmationPages(
const char *address,
1800 addressConfirmationContext.tagValuePair.item =
"Address";
1801 addressConfirmationContext.tagValuePair.value = address;
1810 if (tagValueList != NULL) {
1821 tagValueConfirm->tuneId = TUNE_TAP_CASUAL;
1829 if (tagValueList != NULL) {
1839 if (tagValueList != NULL) {
1847 tagValueConfirm->tuneId = TUNE_TAP_CASUAL;
1852static void bundleNavStartHome(
void)
1854 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
1856 useCaseHomeExt(context->appName,
1859 context->settingContents != NULL ?
true : false,
1860 &context->homeAction,
1861 bundleNavStartSettings,
1862 context->quitCallback);
1865static void bundleNavStartSettingsAtPage(
uint8_t initSettingPage)
1867 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
1871 context->settingContents,
1873 bundleNavStartHome);
1876static void bundleNavStartSettings(
void)
1878 bundleNavStartSettingsAtPage(0);
1881static void bundleNavReviewConfirmRejection(
void)
1883 bundleNavContext.review.choiceCallback(
false);
1890 const char *confirmText;
1895 title =
"Reject transaction?";
1896 confirmText =
"Go back to transaction";
1899 title =
"Reject message?";
1900 confirmText =
"Go back to message";
1903 title =
"Reject operation?";
1904 confirmText =
"Go back to operation";
1911static void bundleNavReviewChoice(
bool confirm)
1914 bundleNavContext.review.choiceCallback(
true);
1917 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
1918 bundleNavReviewConfirmRejection);
1922static void bundleNavReviewStreamingConfirmRejection(
void)
1924 bundleNavContext.reviewStreaming.choiceCallback(
false);
1927static void bundleNavReviewStreamingChoice(
bool confirm)
1934 bundleNavContext.reviewStreaming.choiceCallback(
true);
1937 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
1938 bundleNavReviewStreamingConfirmRejection);
1945static void displaySecurityReport(uint32_t set)
1948 .withLeftBorder =
true,
1949 .onActionCallback = modalLayoutTouchCallback,
1950 .tapActionText = NULL};
1952 .separationLine =
true,
1953 .backAndText.icon = NULL,
1954 .backAndText.tuneId = TUNE_TAP_CASUAL,
1955 .backAndText.token = DISMISS_WARNING_TOKEN};
1960 const char *provider;
1962 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
1975 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
1977 if (reviewWithWarnCtx.warning->predefinedSet & (1 << i)) {
1980 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
1981 bar.
subText = securityReportItems[i].subText;
1984 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
1986 bar.
text = securityReportItems[i].text;
1989 bar.
token = FIRST_WARN_BAR_TOKEN + i;
1990 bar.tuneId = TUNE_TAP_CASUAL;
1995 bar.
iconLeft = securityReportItems[i].icon;
2006 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2007 provider = reviewWithWarnCtx.warning->reportProvider;
2010 provider =
"[unknown]";
2016 + W3C_DESCRIPTION_MAX_LEN / 2;
2020 .text1 = reviewWithWarnCtx.warning->reportUrl,
2021 .text2 =
"Scan to view full report",
2026 W3C_DESCRIPTION_MAX_LEN / 2,
2028 reviewWithWarnCtx.warning->reportUrl);
2029 urlLen = strlen(destStr) + 1;
2034 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2040 info.
icon = &LARGE_WARNING_ICON;
2041 info.
title =
"This transaction cannot be Clear Signed";
2043 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2044 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2053 info.
icon = &LARGE_WARNING_ICON;
2054 info.
title =
"Transaction Check unavailable";
2056 =
"If you're not using the\nLedger Live app, Transaction Check might not work. If your "
2057 "are using Ledger Live, reject the transaction and try again.\n\nGet help at "
2077 .withLeftBorder =
true,
2078 .onActionCallback = modalLayoutTouchCallback,
2079 .tapActionText = NULL};
2081 .separationLine =
true,
2082 .backAndText.icon = NULL,
2083 .backAndText.tuneId = TUNE_TAP_CASUAL,
2084 .backAndText.token = DISMISS_WARNING_TOKEN};
2087 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2098 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2099 bar.tuneId = TUNE_TAP_CASUAL;
2123static void displayInitialWarning(
void)
2126#ifdef HAVE_PIEZO_SOUND
2127 tune_index_e tune = TUNE_RESERVED;
2131 .token = WARNING_CHOICE_TOKEN,
2132 .topText =
"Back to safety",
2134 .tuneId = TUNE_TAP_CASUAL};
2136 .separationLine =
false,
2137 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2138 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2141 reviewWithWarnCtx.isIntro =
true;
2143 layoutDescription.
modal =
false;
2149 layoutDescription.
ticker.tickerCallback = NULL;
2150 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2153 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2155 reviewWithWarnCtx.layoutCtx,
2157 WARNING_BUTTON_TOKEN,
2160 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2162 reviewWithWarnCtx.warning->introTopRightIcon,
2163 WARNING_BUTTON_TOKEN,
2168 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2171 const char *provider;
2174 info.
icon = &LARGE_WARNING_ICON;
2178 if (reviewWithWarnCtx.warning->reportProvider) {
2179 provider = reviewWithWarnCtx.warning->reportProvider;
2182 provider =
"[unknown]";
2185 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2189 info.
title =
"Blind signing ahead";
2191 =
"This transaction's details are not fully verifiable. If you sign, you could "
2192 "lose all your assets.";
2194#ifdef HAVE_PIEZO_SOUND
2195 tune = TUNE_NEUTRAL;
2199 info.
title =
"Potential risk";
2200 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2204 info.
description = reviewWithWarnCtx.warning->providerMessage;
2206 buttonsInfo.
bottomText =
"Accept risk and continue";
2207#ifdef HAVE_PIEZO_SOUND
2208 tune = TUNE_NEUTRAL;
2212 info.
title =
"Critical threat";
2213 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2217 info.
description = reviewWithWarnCtx.warning->providerMessage;
2219 buttonsInfo.
bottomText =
"Accept threat and continue";
2220#ifdef HAVE_PIEZO_SOUND
2226 else if (reviewWithWarnCtx.warning->info != NULL) {
2229#ifdef HAVE_PIEZO_SOUND
2230 tune = TUNE_LOOK_AT_ME;
2236#ifdef HAVE_PIEZO_SOUND
2237 if (tune != TUNE_RESERVED) {
2238 io_seproxyhal_play_tune(tune);
2248 const char *predefinedTipBoxText = NULL;
2251 if (reviewWithWarnCtx.warning) {
2252 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2254 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2257 predefinedTipBoxText =
"Transaction Check unavailable";
2262 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2265 predefinedTipBoxText =
"Critical threat detected.";
2270 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2273 predefinedTipBoxText =
"Potential risk detected.";
2278 predefinedTipBoxText
2279 =
"No threat detected by Transaction Check but blind signing required.";
2282 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2286 predefinedTipBoxText =
"Blind signing required.";
2290 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2292 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2293 if (predefinedTipBoxText != NULL) {
2294 genericContext.validWarningCtx =
true;
2295 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2296 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2299 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2300 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2302 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2303 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2311 const char *reviewTitle,
2312 const char *reviewSubTitle,
2313 const char *finishTitle,
2317 bool playNotifSound)
2320 memset(&genericContext, 0,
sizeof(genericContext));
2322 bundleNavContext.review.operationType = operationType;
2323 bundleNavContext.review.choiceCallback = choiceCallback;
2326 onChoice = bundleNavReviewChoice;
2327 navType = GENERIC_NAV;
2330 genericContext.genericContents.contentsList = localContentsList;
2331 genericContext.genericContents.nbContents = 3;
2336 prepareReviewFirstPage(
2337 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2340 initWarningTipBox(tipBox);
2344 memcpy(&localContentsList[1].content.tagValueList,
2352 prepareReviewLightLastPage(
2353 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2357 prepareReviewLastPage(
2358 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2362 uint8_t nbPages = getNbPagesForGenericContents(
2364 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2367 if (playNotifSound) {
2368#ifdef HAVE_PIEZO_SOUND
2369 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
2373 displayGenericContextPage(0,
true);
2379 const char *reviewTitle,
2380 const char *reviewSubTitle,
2382 bool playNotifSound)
2385 memset(&genericContext, 0,
sizeof(genericContext));
2387 bundleNavContext.reviewStreaming.operationType = operationType;
2388 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2389 bundleNavContext.reviewStreaming.icon = icon;
2392 onChoice = bundleNavReviewStreamingChoice;
2393 navType = STREAMING_NAV;
2396 genericContext.genericContents.contentsList = localContentsList;
2397 genericContext.genericContents.nbContents = 1;
2402 prepareReviewFirstPage(
2403 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2406 initWarningTipBox(NULL);
2409 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2416 if (playNotifSound) {
2417#ifdef HAVE_PIEZO_SOUND
2418 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
2422 displayGenericContextPage(0,
true);
2441static void useCaseHomeExt(
const char *appName,
2443 const char *tagline,
2452 .centeredInfo.text1 = appName,
2453 .centeredInfo.text3 = NULL,
2455 .centeredInfo.offsetY = 0,
2458 .tapActionText = NULL,
2460 .topRightToken = CONTINUE_TOKEN,
2461 .tuneId = TUNE_TAP_CASUAL};
2462 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
2477 if (tagline == NULL) {
2481 "This app enables signing\ntransactions on its network.");
2508 onContinue = topRightCallback;
2509 onQuit = quitCallback;
2523static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
2525 memset(&detailsContext, 0,
sizeof(detailsContext));
2531 detailsContext.tag = tag;
2532 detailsContext.value = value;
2534 detailsContext.currentPage = 0;
2535 detailsContext.wrapping = wrapping;
2537 if (detailsContext.nbPages > 1) {
2538 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
2547 detailsContext.nbPages++;
2551 displayDetailsPage(0,
true);
2573 bool *requireSpecificDisplay)
2576 nbPairs, tagValueList, startIndex,
false, requireSpecificDisplay);
2596 bool *requireSpecificDisplay)
2599 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2605 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
2608 *requireSpecificDisplay =
false;
2609 while (nbPairsInPage < nbPairs) {
2616 if (nbPairsInPage > 0) {
2617 currentHeight += INTER_TAG_VALUE_MARGIN;
2620 if (tagValueList->
pairs != NULL) {
2621 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2624 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2633 if (nbPairsInPage > 0) {
2640 *requireSpecificDisplay =
true;
2652 value_font = SMALL_REGULAR_FONT;
2655 value_font = LARGE_MEDIUM_FONT;
2664 if (nbPairsInPage == 0) {
2668 *requireSpecificDisplay =
true;
2674 return nbPairsInPage;
2694 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
2695 const char *
const *infoTypes = PIC(infosList->
infoTypes);
2696 const char *
const *infoContents = PIC(infosList->
infoContents);
2698 while (nbInfosInPage < nbInfos) {
2700 currentHeight += PRE_TEXT_MARGIN;
2704 SMALL_BOLD_FONT, PIC(infoTypes[startIndex + nbInfosInPage]),
AVAILABLE_WIDTH,
true);
2706 currentHeight += TEXT_SUBTEXT_MARGIN;
2710 PIC(infoContents[startIndex + nbInfosInPage]),
2713 currentHeight += POST_SUBTEXT_MARGIN;
2718 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
2723 previousHeight = currentHeight;
2726 return nbInfosInPage;
2746 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
2749 while (nbSwitchesInPage < nbSwitches) {
2751 currentHeight += PRE_TEXT_MARGIN;
2755 switchArray[startIndex + nbSwitchesInPage].text,
2759 currentHeight += TEXT_SUBTEXT_MARGIN;
2764 switchArray[startIndex + nbSwitchesInPage].subText,
2767 currentHeight += POST_SUBTEXT_MARGIN;
2772 previousHeight = currentHeight;
2777 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
2780 return nbSwitchesInPage;
2800 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
2805 while (nbBarsInPage < nbBars) {
2806 currentHeight += TOUCHABLE_BAR_HEIGHT;
2811 previousHeight = currentHeight;
2816 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
2819 return nbBarsInPage;
2839 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
2841 UNUSED(choicesList);
2844 while (nbChoicesInPage < nbChoices) {
2845 currentHeight += TOUCHABLE_BAR_HEIGHT;
2850 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
2855 previousHeight = currentHeight;
2858 return nbChoicesInPage;
2875 while (i < tagValueList->nbPairs) {
2879 nbPairs -= nbPairsInPage;
2891 const char *tagline,
2898 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
2907 const char *tagline,
2909 const char *actionButtonText,
2917 .text = actionButtonText};
2920 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
2946 onQuit = quitCallback;
2947 onNav = navCallback;
2948 onControls = controlsCallback;
2950 navType = SETTINGS_NAV;
2953 prepareNavInfo(
false, nbPages, NULL);
2955 displaySettingsPage(initPage,
true);
2973 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
2995 memset(&genericContext, 0,
sizeof(genericContext));
2998 onQuit = quitCallback;
2999 pageTitle = appName;
3000 navType = GENERIC_NAV;
3002 if (settingContents != NULL) {
3005 if (infosList != NULL) {
3006 genericContext.hasFinishingContent =
true;
3009 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3013 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3014 if (infosList != NULL) {
3015 nbPages += nbgl_useCaseGetNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3018 prepareNavInfo(
false, nbPages, NULL);
3020 displayGenericContextPage(initPage,
true);
3059 const char *appName,
3061 const char *tagline,
3069 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3071 context->appName = appName;
3072 context->appIcon = appIcon;
3073 context->tagline = tagline;
3074 context->settingContents = settingContents;
3075 context->infosList = infosList;
3076 if (action != NULL) {
3082 context->quitCallback = quitCallback;
3085 bundleNavStartSettingsAtPage(initSettingPage);
3088 bundleNavStartHome();
3104 .tickerIntervale = 0,
3107 onQuit = quitCallback;
3109#ifdef HAVE_PIEZO_SOUND
3110 io_seproxyhal_play_tune(TUNE_LEDGER_MOMENT);
3118 .centeredInfo.icon = &DENIED_CIRCLE_ICON,
3119 .centeredInfo.offsetY = SMALL_FOOTER_HEIGHT / 2,
3120 .centeredInfo.onTop =
false,
3122 .centeredInfo.text1 = message,
3123 .centeredInfo.text2 = NULL,
3124 .centeredInfo.text3 = NULL,
3125 .tapActionText =
"",
3126 .isSwipeable =
false,
3127 .tapActionToken = QUIT_TOKEN,
3129 .actionButtonText = NULL,
3130 .tuneId = TUNE_TAP_CASUAL};
3147 switch (reviewStatusType) {
3149 msg =
"Operation signed";
3153 msg =
"Operation rejected";
3157 msg =
"Transaction signed";
3161 msg =
"Transaction rejected";
3165 msg =
"Message signed";
3169 msg =
"Message rejected";
3173 msg =
"Address verified";
3177 msg =
"Address verification\ncancelled";
3199 const char *message,
3200 const char *subMessage,
3201 const char *confirmText,
3202 const char *cancelText,
3209 .centeredInfo.text2 = subMessage,
3210 .centeredInfo.text3 = NULL,
3212 .centeredInfo.icon = icon,
3213 .centeredInfo.offsetY = 0,
3214 .confirmationText = confirmText,
3215 .confirmationToken = CHOICE_TOKEN,
3216 .tuneId = TUNE_TAP_CASUAL,
3219 if ((confirmText == NULL) || (cancelText == NULL)) {
3222 onChoice = callback;
3241 const char *subMessage,
3242 const char *confirmText,
3243 const char *cancelText,
3249 .centeredInfo.text1 = message,
3250 .centeredInfo.text2 = subMessage,
3251 .centeredInfo.text3 = NULL,
3253 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3254 .centeredInfo.offsetY = 0,
3255 .confirmationText = confirmText,
3256 .confirmationToken = CHOICE_TOKEN,
3257 .tuneId = TUNE_TAP_CASUAL,
3259 onModalConfirm = callback;
3260 if (modalPageContext != NULL) {
3278 const char *message,
3279 const char *actionText,
3285 onAction = callback;
3287 content.
tuneId = TUNE_TAP_CASUAL;
3310 const char *reviewTitle,
3311 const char *reviewSubTitle,
3312 const char *rejectText,
3319 .footerToken = QUIT_TOKEN,
3320 .tapActionText = NULL,
3321 .isSwipeable =
true,
3322 .tapActionToken = CONTINUE_TOKEN,
3324 .actionButtonText = NULL,
3325 .
tuneId = TUNE_TAP_CASUAL};
3332 onQuit = rejectCallback;
3333 onContinue = continueCallback;
3335#ifdef HAVE_PIEZO_SOUND
3337 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
3350 const char *rejectText,
3358 onChoice = choiceCallback;
3359 onNav = navCallback;
3360 onControls = buttonCallback;
3361 forwardNavOnly =
false;
3362 navType = REVIEW_NAV;
3366 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3368 displayReviewPage(initPage,
true);
3385 const char *rejectText,
3391 memset(&genericContext, 0,
sizeof(genericContext));
3394 onChoice = callback;
3395 navType = GENERIC_NAV;
3399 genericContext.genericContents.contentsList = localContentsList;
3402 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3404 memcpy(&localContentsList[offset].content.tagValueList,
3411 memcpy(&localContentsList[offset].content.infoLongPress,
3417 genericContext.genericContents.nbContents = offset;
3420 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3422 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3424 displayGenericContextPage(0,
true);
3442 const char *rejectText,
3448 memset(&genericContext, 0,
sizeof(genericContext));
3451 onChoice = callback;
3452 navType = GENERIC_NAV;
3455 genericContext.genericContents.contentsList = localContentsList;
3458 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3460 memcpy(&localContentsList[offset].content.tagValueList,
3474 genericContext.genericContents.nbContents = offset;
3477 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3479 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3481 displayGenericContextPage(0,
true);
3503 const char *reviewTitle,
3504 const char *reviewSubTitle,
3505 const char *finishTitle,
3508 useCaseReview(operationType,
3542 const char *reviewTitle,
3543 const char *reviewSubTitle,
3544 const char *finishTitle,
3555 &blindSigningWarning,
3584 const char *reviewTitle,
3585 const char *reviewSubTitle,
3586 const char *finishTitle,
3591 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
3593 if (tipBox != NULL) {
3594 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
3597 memset(&activeTipBox, 0,
sizeof(activeTipBox));
3600 if ((warning == NULL)
3603 useCaseReview(operationType,
3616 operationType |= NO_THREAT_OPERATION;
3619 operationType |= RISKY_OPERATION;
3622 reviewWithWarnCtx.isStreaming =
false;
3623 reviewWithWarnCtx.operationType = operationType;
3624 reviewWithWarnCtx.tagValueList = tagValueList;
3625 reviewWithWarnCtx.icon = icon;
3626 reviewWithWarnCtx.reviewTitle = reviewTitle;
3627 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
3628 reviewWithWarnCtx.finishTitle = finishTitle;
3629 reviewWithWarnCtx.warning = warning;
3630 reviewWithWarnCtx.choiceCallback = choiceCallback;
3636 useCaseReview(operationType,
3649 displayInitialWarning();
3671 const char *reviewTitle,
3672 const char *reviewSubTitle,
3673 const char *finishTitle,
3676 useCaseReview(operationType,
3697 const char *rejectText,
3701 memset(&genericContext, 0,
sizeof(genericContext));
3704 onQuit = rejectCallback;
3705 navType = GENERIC_NAV;
3712 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3713 prepareNavInfo(
true, nbPages, rejectText);
3716#ifdef HAVE_PIEZO_SOUND
3718 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
3721 displayGenericContextPage(0,
true);
3738 const char *reviewTitle,
3739 const char *reviewSubTitle,
3742 useCaseReviewStreamingStart(
3743 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
3761 const char *reviewTitle,
3762 const char *reviewSubTitle,
3766 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
3786 const char *reviewTitle,
3787 const char *reviewSubTitle,
3791 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
3793 if ((warning == NULL)
3796 useCaseReviewStreamingStart(
3797 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
3801 operationType |= NO_THREAT_OPERATION;
3804 operationType |= RISKY_OPERATION;
3807 reviewWithWarnCtx.isStreaming =
true;
3808 reviewWithWarnCtx.operationType = operationType;
3809 reviewWithWarnCtx.icon = icon;
3810 reviewWithWarnCtx.reviewTitle = reviewTitle;
3811 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
3812 reviewWithWarnCtx.choiceCallback = choiceCallback;
3813 reviewWithWarnCtx.warning = warning;
3819 useCaseReviewStreamingStart(
3820 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
3823 displayInitialWarning();
3844 memset(&genericContext, 0,
sizeof(genericContext));
3846 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
3847 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
3850 onChoice = bundleNavReviewStreamingChoice;
3851 navType = STREAMING_NAV;
3854 genericContext.genericContents.contentsList = localContentsList;
3855 genericContext.genericContents.nbContents = 1;
3864 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
3865 &genericContext.genericContents,
3868 prepareNavInfo(
true,
3870 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
3878 displayGenericContextPage(0,
true);
3909 memset(&genericContext, 0,
sizeof(genericContext));
3911 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
3914 onChoice = bundleNavReviewStreamingChoice;
3915 navType = STREAMING_NAV;
3918 genericContext.genericContents.contentsList = localContentsList;
3919 genericContext.genericContents.nbContents = 1;
3924 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
3925 &STARTING_CONTENT.content.infoLongPress,
3926 bundleNavContext.reviewStreaming.icon,
3930 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
3931 &genericContext.genericContents,
3934 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
3936 displayGenericContextPage(0,
true);
3948 memset(&genericContext, 0,
sizeof(genericContext));
3949 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
3952 onChoice = callback;
3953 navType = GENERIC_NAV;
3956 genericContext.genericContents.contentsList = localContentsList;
3957 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
3959 prepareAddressConfirmationPages(
3960 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
3963 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3965 prepareNavInfo(
true, nbPages,
"Cancel");
3967#ifdef HAVE_PIEZO_SOUND
3969 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
3972 displayGenericContextPage(0,
true);
3994 const char *reviewTitle,
3995 const char *reviewSubTitle,
3999 memset(&genericContext, 0,
sizeof(genericContext));
4001 if (addressConfirmationContext.modalLayout) {
4004 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4007 onChoice = choiceCallback;
4008 navType = GENERIC_NAV;
4012 genericContext.genericContents.contentsList = localContentsList;
4013 genericContext.genericContents.nbContents = (additionalTagValueList == NULL) ? 2 : 3;
4018 prepareReviewFirstPage(
4019 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4020 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4023 prepareAddressConfirmationPages(
4024 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4027 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4029 prepareNavInfo(
true, nbPages,
"Cancel");
4031#ifdef HAVE_PIEZO_SOUND
4033 io_seproxyhal_play_tune(TUNE_LOOK_AT_ME);
4036 displayGenericContextPage(0,
true);
4050 if (genericContext.type != USE_CASE_SPINNER) {
4051 memset(&genericContext, 0,
sizeof(genericContext));
4052 genericContext.type = USE_CASE_SPINNER;
4057 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4060 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4067 genericContext.spinnerPosition++;
4070 genericContext.spinnerPosition = 0;
4073 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4077 else if (ret == 2) {
4108 tune_index_e tuneId,
4112 keypadGenericUseCase(title,
4119 validatePinCallback,
4146 tune_index_e tuneId,
4150 keypadGenericUseCase(title,
4157 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_pageDrawLedgerInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const char *text, int tapActionToken)
draw a page with a centered text in large case, with a round check icon
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
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_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,...
@ CENTERED_INFO_WARNING
Centered info.
@ BAR_LIST_WARNING
list of touchable bars, to display sub-pages
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)
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
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),...
This structure contains [item,value] pair(s) and info about a potential "details" button,...
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.
nbgl_contentActionCallback_t actionCallback
called when a valueIcon is touched on a given pair
const nbgl_contentTagValue_t * pairs
array of [tag,value] pairs (nbPairs items). If NULL, callback is used instead
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_contentTagValueCallback_t callback
function to call to retrieve a given pair
uint8_t nbMaxLinesForValue
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 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
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
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)
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
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
uint8_t bottomButtonsToken
const nbgl_icon_details_t * actionButtonIcon
potential icon of "action" button
nbgl_pageButtonStyle_t bottomButtonStyle
style to apply to the Bottom 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 * modalTitle
title given to modal window displayed when tip-box is touched
nbgl_contentInfoList_t infos
infos pairs displayed in modal, if type is INFOS_LIST.
const char * text
text of the tip-box
const nbgl_icon_details_t * icon
icon of the tip-box
const char *const * texts
array of texts for each bar (nbBars items, in black/bold)
const struct nbgl_warningDetails_s * details
array of nbBars structures giving what to display when each bar is touched.
const char *const * subTexts
array of texts for each bar (nbBars items, in black)
uint8_t nbBars
number of touchable bars
const nbgl_icon_details_t ** icons
array of icons for each bar (nbBars items)
The necessary parameters to build the page(s) displayed when the top-right button is touched in intro...
nbgl_warningDetailsType_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
const char * title
text of the page (used to go back)
nbgl_layoutQRCode_t qrCode
QR code, if type == QRCODE_WARNING.
nbgl_warningBarList_t barList
touchable bars list, if type == BAR_LIST_WARNING
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