app-ethereum/src_nbgl/ui_approve_tx.c

#include <nbgl_page.h>
#include "shared_context.h"
#include "ui_callbacks.h"
#include "ui_nbgl.h"
#include "network.h"
#include "plugins.h"

// 1 more than actually displayed on screen, because of calculations in StaticReview
#define MAX_PLUGIN_ITEMS_PER_SCREEN 4
#define TAG_MAX_LEN 43
#define VALUE_MAX_LEN 79
enum {
  REJECT_TOKEN,
  START_REVIEW_TOKEN,
};

static nbgl_layoutTagValue_t tlv;
// these buffers are used as circular
static char title_buffer[MAX_PLUGIN_ITEMS_PER_SCREEN][TAG_MAX_LEN];
static char msg_buffer[MAX_PLUGIN_ITEMS_PER_SCREEN][VALUE_MAX_LEN];

static nbgl_layoutTagValueList_t useCaseTagValueList;
static nbgl_pageInfoLongPress_t infoLongPress;

struct tx_approval_context_t {
  bool fromPlugin;
  bool blindSigning;
  bool displayNetwork;
};

static struct tx_approval_context_t tx_approval_context;

static void reviewContinueCommon(void);


static void reviewReject(void) {
  io_seproxyhal_touch_tx_cancel(NULL);
  ui_idle();
}

static void confirmTransation(void) {
  io_seproxyhal_touch_tx_ok(NULL);
  ui_idle();
}

static void onConfirmAbandon(void) {
  nbgl_useCaseStatus("Transaction rejected", false, reviewReject);
}

static void rejectTransactionQuestion(void) {
  nbgl_useCaseConfirm("Reject transaction?", NULL, "Yes, reject", "Go back to transaction", onConfirmAbandon);
}

static void reviewChoice(bool confirm) {
  if (confirm) {
    nbgl_useCaseStatus("TRANSACTION\nSIGNED", true, confirmTransation);
  } else {
    rejectTransactionQuestion();
  }
}

// called by NBGL to get the tag/value pair corresponding to pairIndex
static nbgl_layoutTagValue_t* getTagValuePair(uint8_t pairIndex) {
  static int counter = 0;

  if (tx_approval_context.fromPlugin) {
    if (pairIndex < dataContext.tokenContext.pluginUiMaxItems) {
      // for the next dataContext.tokenContext.pluginUiMaxItems items, get tag/value from plugin_ui_get_item_internal()
      dataContext.tokenContext.pluginUiCurrentItem = pairIndex;
      plugin_ui_get_item_internal(
        (uint8_t *)title_buffer[counter],
        TAG_MAX_LEN,
        (uint8_t *)msg_buffer[counter],
        VALUE_MAX_LEN
      );
      tlv.item = title_buffer[counter];
      tlv.value = msg_buffer[counter];
    }
    else {
      pairIndex -= dataContext.tokenContext.pluginUiMaxItems;
      // for the last 1 (or 2), tags are fixed
      if (tx_approval_context.displayNetwork && (pairIndex == 0)) {
        tlv.item = "Network";
        tlv.value = strings.common.network_name;
      }
      else {
        tlv.item = "Max fees";
        tlv.value = strings.common.maxFee;
      }
    }
  } else {
    // if displayNonce is false, we skip index 2
    if ((pairIndex > 1) && (!N_storage.displayNonce)) {
      pairIndex++;
    }

    switch (pairIndex) {
    case 0:
      tlv.item = "Amount";
      tlv.value = strings.common.fullAmount;
      break;
    case 1:
      tlv.item = "Address";
      tlv.value = strings.common.fullAddress;
      break;
    case 2:
      tlv.item = "Nonce";
      tlv.value = strings.common.nonce;
      break;
    case 3:
      tlv.item = "Max fees";
      tlv.value = strings.common.maxFee;
      break;
    case 4:
      tlv.item = "Network";
      tlv.value = strings.common.network_name;
      break;
    }
  }
  // counter is used as index to circular buffer
  counter++;
  if (counter == MAX_PLUGIN_ITEMS_PER_SCREEN) {
    counter = 0;
  }
  return &tlv;
}

static void pageCallback(int token, uint8_t index) {
  (void)index;
  nbgl_pageRelease(pageContext);
  if (token == REJECT_TOKEN) {
    reviewReject();
  }
  else if (token == START_REVIEW_TOKEN) {
    reviewContinueCommon();
  }
}

static void reviewContinue(void) {
  if (tx_approval_context.blindSigning) {
    nbgl_pageInfoDescription_t info = {
      .centeredInfo.icon = &C_round_warning_64px,
      .centeredInfo.text1 = "Blind Signing",
      .centeredInfo.text2 = "This transaction cannot be\nsecurely interpreted by Ledger\nStax. It might put your assets\nat risk.",
      .centeredInfo.text3 = NULL,
      .centeredInfo.style = LARGE_CASE_INFO,
      .centeredInfo.offsetY = -32,
      .footerText = "Reject transaction",
      .footerToken = REJECT_TOKEN,
      .tapActionText = "Tap to continue",
      .tapActionToken = START_REVIEW_TOKEN,
      .topRightStyle = NO_BUTTON_STYLE,
      .actionButtonText = NULL,
      .tuneId = TUNE_TAP_CASUAL
    };

    if (pageContext != NULL) {
      nbgl_pageRelease(pageContext);
      pageContext = NULL;
    }
    pageContext = nbgl_pageDrawInfo(&pageCallback, NULL, &info);
  }
  else {
    reviewContinueCommon();
  }
}

static void reviewContinueCommon(void) {
  uint8_t nbPairs = 0;

  if (tx_approval_context.fromPlugin) {
    // plugin id + max items + fees
    nbPairs += dataContext.tokenContext.pluginUiMaxItems + 1;
    if (tx_approval_context.displayNetwork) {
      nbPairs ++;
    }
  } else {
    nbPairs += 3;
    if (N_storage.displayNonce) {
      nbPairs ++;
    }
    if (tx_approval_context.displayNetwork) {
      nbPairs ++;
    }
  }

  useCaseTagValueList.pairs = NULL;
  useCaseTagValueList.callback = getTagValuePair;
  useCaseTagValueList.startIndex = 0;
  useCaseTagValueList.nbPairs = nbPairs; ///< number of pairs in pairs array
  useCaseTagValueList.smallCaseForValue = false;
  useCaseTagValueList.wrapping = false;
  infoLongPress.icon = &ICONGLYPH;
  infoLongPress.text = "Review transaction";
  infoLongPress.longPressText = "Hold to sign";
  nbgl_useCaseStaticReview(&useCaseTagValueList, &infoLongPress, "Reject transaction", reviewChoice);
}


static void buildFirstPage(void) {
  if (tx_approval_context.fromPlugin) {
    plugin_ui_get_id();
    strcpy(title_buffer[0], strings.common.fullAddress);
    strcpy(msg_buffer[0], strings.common.fullAmount);
    SPRINTF(msg_buffer[1], "Review %s\ntransaction:\n%s",title_buffer[0], msg_buffer[0]);
    nbgl_useCaseReviewStart(&ICONGLYPH, msg_buffer[1], NULL, "Reject transaction", reviewContinue, rejectTransactionQuestion);
  } else {
    nbgl_useCaseReviewStart(&ICONGLYPH, "Review transaction", NULL, "Reject transaction", reviewContinue, rejectTransactionQuestion);
  }
}

void ux_approve_tx(bool fromPlugin) {
  tx_approval_context.blindSigning = !fromPlugin && tmpContent.txContent.dataPresent && !N_storage.contractDetails;
  tx_approval_context.fromPlugin = fromPlugin;
  tx_approval_context.displayNetwork = false;

  uint64_t chain_id = get_chain_id();
  if (chainConfig->chainId == ETHEREUM_MAINNET_CHAINID && chain_id != chainConfig->chainId) {
    tx_approval_context.displayNetwork = true;
  }

  buildFirstPage();
}