subaccount formatting (#267)

* Add token information registry and helper functions

* Add formatting function to be use for registry look-up

* Add commands to retrieve token registry

* Add support to JS package to retrieve token registry from ledger devices

* Add zemu test to retrieve device's token registry

* Proper check to decide if using tokenInfo from table or default to Tokens marker for amount and fee

* Apply the rigth format to Fees

* Fix fee formatting for known and unknown tokens

* Use token formatting according to token table for sns transactions

* Update neuron tests

* Update tests

* Fix warnings

* Bump version and update snapshots

* Add token decimal tests

* Fix token display title and update test vector(fixed)

* Add support for neuron voting power updates

* Fix parser and complete UI for voting power transaction

* feat(manageneuron): Add neuron refresh voting power test in zemu

* Add support to handle the configuration operation to set neuron visibility

* Add zemu test to check neuron visibility transaction

* Reduce title length to Max fee + token name

* Fix fee title and update tests

* Update snapshots to reproduce a change from Maximun fee to Max fee

* Remove commented code which is not used

* Update snapshots

* Fix(candid): created time field in transaction must be optional

Fix(fmt): Fix subaccounts formatting

fix(tests): Remove token_decimals tests and move them into icrc transfers tests as provided by icp team

* Bump app version

* Add boundary checks

* Fix field name with the shorter version

---------

Co-authored-by: Andrés Benso <[email protected]>

Author: neithanmo

app/Makefile.version

@@ -3,4 +3,4 @@ APPVERSION_M=3
 # This is the minor version of this release
 APPVERSION_N=2
 # This is the patch version of this release
-APPVERSION_P=5
+APPVERSION_P=6

app/src/candid/candid_parser.c

@@ -421,10 +421,9 @@ parser_error_t readCandidICRCTransfer(parser_tx_t *tx, const uint8_t *input, uin
 
     // Read has_created_at_time
     CHECK_PARSER_ERR(readCandidByte(&ctx, &icrc->has_created_at_time))
-    if (!icrc->has_created_at_time) {
-        return parser_required_method;
+    if (icrc->has_created_at_time) {
+        CHECK_PARSER_ERR(readCandidNat64(&ctx, &icrc->created_at_time))
     }
-    CHECK_PARSER_ERR(readCandidNat64(&ctx, &icrc->created_at_time)) // assume has_created_at_time
 
     // Read amount
     CHECK_PARSER_ERR(readCandidLEB128(&ctx, &icrc->amount))

app/src/coin.h

@@ -49,6 +49,10 @@ extern "C" {
 #define DFINITY_SUBACCOUNT_LEN 32u
 #define DFINITY_PRINCIPAL_LEN 29u
 #define DFINITY_TEXTUAL_SIZE 100u
+// From an account we just display the first 16 bytes:
+// including the '.' prefix
+// 2 | From account [3/3] : .d7e8516 52cd032b a5ed76b1 7f626aa4"
+#define DFINITY_SUBACCOUNT_MAX_BYTES_TO_TEXTUAL 16u
 
 #define MAX_CHARS_PER_VALUE_LINE 18u
 

app/src/parser_print_candid.c

@@ -134,24 +134,41 @@ __Z_INLINE parser_error_t print_follow_topic(int32_t topic, char *outVal,
   return parser_ok;
 }
 
+// Stick to the spec for printing accounts
+// https://internetcomputer.org/docs/current/references/icrc1-standard#textual-encoding-of-accounts
 __Z_INLINE parser_error_t print_accountBytes(
     sender_t sender, const candid_transfer_t *sendrequest, char *outVal,
     uint16_t outValLen, uint8_t pageIdx, uint8_t *pageCount) {
-  uint8_t address[32] = {0};
+
+  // First check if we have a subaccount and if it's non-zero
+  bool has_subaccount = sendrequest->has_from_subaccount;
+  bool is_default_subaccount = true;
+
+  if (has_subaccount) {
+    // Check if subaccount is all zeros
+    for (uint16_t i = 0; i < sendrequest->from_subaccount.len; i++) {
+      if (sendrequest->from_subaccount.p[i] != 0) {
+        is_default_subaccount = false;
+        break;
+      }
+    }
+  }
+
+  // If no subaccount or all zeros, just print the principal
+  if (!has_subaccount || is_default_subaccount) {
+    return print_principal(sender.data, (uint16_t)sender.len, outVal, outValLen,
+                           pageIdx, pageCount);
+  }
+
+  // For non-default subaccount, we need to handle the full format
   uint8_t subaccount[32] = {0};
-  if (sendrequest->has_from_subaccount) {
+  if (has_subaccount) {
     MEMCPY(subaccount, sendrequest->from_subaccount.p,
            (size_t)sendrequest->from_subaccount.len);
   }
 
-  zxerr_t err = crypto_principalToSubaccount(sender.data, (uint16_t)sender.len,
-                                             subaccount, sizeof(subaccount),
-                                             address, sizeof(address));
-  if (err != zxerr_ok) {
-    return parser_unexpected_error;
-  }
-
-  return page_hexstring_with_delimiters(address, sizeof(address), outVal,
+  return page_principal_with_subaccount(sender.data, (uint16_t)sender.len,
+                                        subaccount, sizeof(subaccount), outVal,
                                         outValLen, pageIdx, pageCount);
 }
 
@@ -1602,7 +1619,7 @@ parser_error_t parser_getItemCandid(const parser_context_t *ctx,
   }
 
   default:
-    ZEMU_LOGF(50, "Candid type not supported\n")
+    zemu_log("Candid type not supported\n");
     break;
   }
 

app/src/parser_print_helper.c

@@ -221,14 +221,18 @@ parser_error_t page_principal_with_subaccount(
   // print principal
   uint16_t principalLen = sizeof(text);
   zxerr_t err = zxerr_unknown;
+
   err = crypto_principalToTextual(sender, senderLen, text_ptr, &principalLen);
+
   // maximum length without separators is 53
   if (err != zxerr_ok || principalLen > 53) {
     return parser_unexpected_error;
   }
+
   // every 5 chars there's a separator, and last block has no separator after it
   const uint8_t principalTextLen =
       (uint8_t)(principalLen + principalLen / 5 - (principalLen % 5 ? 0 : 1));
+
   for (uint8_t i = 5; i < principalTextLen; i += 6) {
     // two blocks separated with dash, 3rd with SEPARATOR
     if ((i + 1) % 18 == 0)
@@ -240,11 +244,13 @@ parser_error_t page_principal_with_subaccount(
       return parser_unexpected_error;
     }
   }
+
   // we are sure it's going to be up to 63 (53 + 10)
   principalLen = (uint16_t)strnlen(text, sizeof(text));
   if (principalLen > 63) {
     return parser_unexpected_value;
   }
+
   *(text_ptr + principalLen) = '-';
   text_ptr += principalLen + 1;
 
@@ -253,14 +259,17 @@ parser_error_t page_principal_with_subaccount(
   char crc_text[10] = {0};
   uint8_t tmpArray[DFINITY_PRINCIPAL_LEN + DFINITY_SUBACCOUNT_LEN + 1] = {0};
   MEMCPY(tmpArray, sender, senderLen);
+
   // crc is computed with full subaccount with all zeros at the beginning
   MEMCPY(tmpArray + senderLen, fromSubaccount, fromSubaccountLen);
   uint32_t crc = 0;
+
   crc32_small(tmpArray, senderLen + fromSubaccountLen, &crc);
   crc_array[0] = (uint8_t)((crc & 0xFF000000) >> 24);
   crc_array[1] = (uint8_t)((crc & 0x00FF0000) >> 16);
   crc_array[2] = (uint8_t)((crc & 0x0000FF00) >> 8);
   crc_array[3] = (uint8_t)((crc & 0x000000FF) >> 0);
+
   uint8_t crcLen =
       (uint8_t)base32_encode(crc_array, 4, crc_text, sizeof(crc_text));
   if (crcLen == 0) {
@@ -271,6 +280,7 @@ parser_error_t page_principal_with_subaccount(
   MEMCPY(text_ptr, crc_text, crcLen);
   *(text_ptr + crcLen) = SEPARATOR;
   text_ptr += crcLen + 1;
+
 #if !defined(TARGET_STAX) &&                                                   \
     !defined(TARGET_FLEX) // needed if crc32 length is < 7
   for (uint8_t i = crcLen; i < 7; i++) {
@@ -280,28 +290,41 @@ parser_error_t page_principal_with_subaccount(
 #endif
   crcLen = 8; // also counting separator
 
-  // print subaccount
+  *text_ptr = '.';
+  text_ptr++;
+
+  uint16_t bytesToShow = subaccTrimLen;
+  if (subaccTrimLen > DFINITY_SUBACCOUNT_MAX_BYTES_TO_TEXTUAL) {
+    bytesToShow = DFINITY_SUBACCOUNT_MAX_BYTES_TO_TEXTUAL;
+  }
+
   array_to_hexstr(text_ptr, (uint16_t)sizeof(text) - principalLen - crcLen,
-                  subaccTrim, subaccTrimLen);
+                  subaccTrim, bytesToShow);
+
   const uint8_t subaccountTextLen =
-      2 * subaccTrimLen       // 1 hex byte ==> 2 chars
-      + subaccTrimLen / 4 - 1 // separator for every block except last one
-      + (subaccTrimLen % 4 ? 1 : 0);
-  // text_ptr is right at the start of subaccount
-  for (uint8_t i = 8; i < subaccountTextLen; i += 9) {
-    if ((i + 1) % 18 == 0)
-      err = inplace_insert_char(text_ptr, sizeof(text), i,
-                                SEPARATOR); // line break
-    else
-      err = inplace_insert_char(text_ptr, sizeof(text), i, ' ');
+      2 * bytesToShow + bytesToShow / 4 - 1 + (bytesToShow % 4 ? 1 : 0);
+
+  const uint8_t FIRST_BLOCK = 7;
+  const uint8_t OTHER_BLOCKS = 8;
+  // Add boundary check before inserting spaces
+  if (subaccountTextLen < FIRST_BLOCK) {
+    return parser_unexpected_error;
+  }
+
+  for (uint8_t i = 0, pos = FIRST_BLOCK; i < 3 && pos < subaccountTextLen;
+       i++) {
+    err = inplace_insert_char(text_ptr, sizeof(text), pos, ' ');
     if (err != zxerr_ok) {
       return parser_unexpected_error;
     }
+    // +1 for the space we just inserted
+    pos += OTHER_BLOCKS + 1;
   }
 
   uint8_t finalStrLen = (uint8_t)strnlen(text, sizeof(text));
-  // [principal (<=64 chars) | crc32 (8 chars) | subaccount (<=71 chars)]
-  if (finalStrLen > 143) {
+  // [principal (<=64 chars) | crc32 (8 chars) | subaccount (<=71 chars) + 1
+  // ('.')]
+  if (finalStrLen > 144) {
     return parser_unexpected_error;
   }
 
@@ -311,11 +334,13 @@ parser_error_t page_principal_with_subaccount(
   *pageCount =
       finalStrLen / CHARS_PER_PAGE + (finalStrLen % CHARS_PER_PAGE ? 1 : 0);
   const char *textToPrint = text + pageIdx * CHARS_PER_PAGE;
+
   // we don't want to print last separator for each page
   if (CHARS_PER_PAGE > outValLen) {
     return parser_unexpected_error;
   }
   snprintf(outVal, CHARS_PER_PAGE, "%.*s", CHARS_PER_PAGE - 1, textToPrint);
+
   return parser_ok;
 }
 

tests/candid_send.json

@@ -5,8 +5,8 @@
     "blob": "d9d9f7a167636f6e74656e74a663617267587a4449444c066d7b6c01e0a9b302786e006c01d6f68e8001786e036c06fbca0100c6fcb60201ba89e5c20478a2de94eb060282f3f3910c04d8a38ca80d01010520d3e13d4777e22367532053190b6c6ccf57444a61337e996242b1abfb52cf92c810270000000000000000000000000000000000ca9a3b000000006b63616e69737465725f69644a000000000000000201016e696e67726573735f6578706972791b176077308e9795c06b6d6574686f645f6e616d65687472616e736665726c726571756573745f747970656463616c6c6673656e646572581d19aa3d42c048dd7d14f0cfa0df69a1c1381780f6e9a137abaa6a82e302",
     "output": [
       "0 | Transaction type : Send ICP",
-      "1 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "1 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "1 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "1 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | To account [1/2] : d3e13d47 77e22367 53205319 0b6c6ccf",
       "2 | To account [2/2] : 57444a61 337e9962 42b1abfb 52cf92c8",
       "3 | Amount (Tokens) : 1000000000",
@@ -18,8 +18,8 @@
       "1 | Sender [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
       "1 | Sender [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | Subaccount  : Not set",
-      "3 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "3 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "3 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "3 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "4 | To account [1/2] : d3e13d47 77e22367 53205319 0b6c6ccf",
       "4 | To account [2/2] : 57444a61 337e9962 42b1abfb 52cf92c8",
       "5 | Amount (Tokens) : 1000000000",
@@ -33,8 +33,9 @@
     "blob": "d9d9f7a167636f6e74656e74a663617267589b4449444c066d7b6c01e0a9b302786e006c01d6f68e8001786e036c06fbca0100c6fcb60201ba89e5c20478a2de94eb060282f3f3910c04d8a38ca80d01010520df4ad42194201b15ecbbe66ff68559a126854d8141fd935c5bd53433c2fb28d41027000000000000000000000000000001200a000000000030004b01010000000000000000000000000000000000000000000000c258884d0000006b63616e69737465725f69644a000000000000000201016e696e67726573735f6578706972791b17620a22c9b169c06b6d6574686f645f6e616d65687472616e736665726c726571756573745f747970656463616c6c6673656e646572581d19aa3d42c048dd7d14f0cfa0df69a1c1381780f6e9a137abaa6a82e302",
     "output": [
       "0 | Transaction type : Send ICP",
-      "1 | From account [1/2] : e934e0e3 7eb96d71 41f7489e b87c3541",
-      "1 | From account [2/2] : f98b2c36 4b304229 8b684a36 44722b3d",
+      "1 | From account [1/3] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "1 | From account [2/3] : obhal-yb5xj-ue32x ktkql-rqe-gipanwi",
+      "1 | From account [3/3] : .0a00000 00000300 04b01010 00000000",
       "2 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "2 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "3 | Amount (Tokens) : 333000000000",
@@ -47,8 +48,9 @@
       "1 | Sender [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | Subaccount [1/2] : 0a000000 00003000 4b010100 00000000",
       "2 | Subaccount [2/2] : 00000000 00000000 00000000 00000000",
-      "3 | From account [1/2] : e934e0e3 7eb96d71 41f7489e b87c3541",
-      "3 | From account [2/2] : f98b2c36 4b304229 8b684a36 44722b3d",
+      "3 | From account [1/3] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "3 | From account [2/3] : obhal-yb5xj-ue32x ktkql-rqe-gipanwi",
+      "3 | From account [3/3] : .0a00000 00000300 04b01010 00000000",
       "4 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "4 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "5 | Amount (Tokens) : 333000000000",
@@ -62,8 +64,8 @@
     "blob": "d9d9f7a167636f6e74656e74a66361726758824449444c066d7b6c01e0a9b302786e006c01d6f68e8001786e036c06fbca0100c6fcb60201ba89e5c20478a2de94eb060282f3f3910c04d8a38ca80d01010520df4ad42194201b15ecbbe66ff68559a126854d8141fd935c5bd53433c2fb28d41027000000000000000000000000000000010038a7d84e9acd0930f95d55000000006b63616e69737465725f69644a000000000000000201016e696e67726573735f6578706972791b17620a22c9b169c06b6d6574686f645f6e616d65687472616e736665726c726571756573745f747970656463616c6c6673656e646572581d19aa3d42c048dd7d14f0cfa0df69a1c1381780f6e9a137abaa6a82e302",
     "output": [
       "0 | Transaction type : Send ICP",
-      "1 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "1 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "1 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "1 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "2 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "3 | Amount (Tokens) : 1432222000",
@@ -75,8 +77,8 @@
       "1 | Sender [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
       "1 | Sender [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | Subaccount  : Not set",
-      "3 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "3 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "3 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "3 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "4 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "4 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "5 | Amount (Tokens) : 1432222000",
@@ -90,8 +92,8 @@
     "blob": "d9d9f7a167636f6e74656e74a66361726758824449444c066d7b6c01e0a9b302786e006c01d6f68e8001786e036c06fbca0100c6fcb60201ba89e5c20478a2de94eb060282f3f3910c04d8a38ca80d01010520d3e13d4777e22367532053190b6c6ccf57444a61337e996242b1abfb52cf92c8102700000000000021caa60700000000000100d82c3c3807221200943577000000006b63616e69737465725f69644a000000000000000201016e696e67726573735f6578706972791b17620a22c9c0ac006b6d6574686f645f6e616d65687472616e736665726c726571756573745f747970656463616c6c6673656e646572581d19aa3d42c048dd7d14f0cfa0df69a1c1381780f6e9a137abaa6a82e302",
     "output": [
       "0 | Transaction type : Send ICP",
-      "1 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "1 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "1 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "1 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | To account [1/2] : d3e13d47 77e22367 53205319 0b6c6ccf",
       "2 | To account [2/2] : 57444a61 337e9962 42b1abfb 52cf92c8",
       "3 | Amount (Tokens) : 2000000000",
@@ -103,8 +105,8 @@
       "1 | Sender [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
       "1 | Sender [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | Subaccount  : Not set",
-      "3 | From account [1/2] : 4f3d4b40 cdb85273 2601fccf 8bd24dff",
-      "3 | From account [2/2] : e44957a6 47cb8679 13e982d9 8cf85676",
+      "3 | From account [1/2] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "3 | From account [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "4 | To account [1/2] : d3e13d47 77e22367 53205319 0b6c6ccf",
       "4 | To account [2/2] : 57444a61 337e9962 42b1abfb 52cf92c8",
       "5 | Amount (Tokens) : 2000000000",
@@ -118,8 +120,9 @@
     "blob": "d9d9f7a167636f6e74656e74a663617267589b4449444c066d7b6c01e0a9b302786e006c01d6f68e8001786e036c06fbca0100c6fcb60201ba89e5c20478a2de94eb060282f3f3910c04d8a38ca80d01010520df4ad42194201b15ecbbe66ff68559a126854d8141fd935c5bd53433c2fb28d4102700000000000013726eab1e01000001201d02dc69531d6e8375cf08e80e6ecdd73b93b0ff60cc297b8a3fea531c0200000000e87648170000006b63616e69737465725f69644a000000000000000201016e696e67726573735f6578706972791b17620a22c9cfee406b6d6574686f645f6e616d65687472616e736665726c726571756573745f747970656463616c6c6673656e646572581d19aa3d42c048dd7d14f0cfa0df69a1c1381780f6e9a137abaa6a82e302",
     "output": [
       "0 | Transaction type : Send ICP",
-      "1 | From account [1/2] : eb94123b 55a5cf10 9982da44 a3cb35db",
-      "1 | From account [2/2] : 38a41b86 979acf20 ce44a97a c13ba2a2",
+      "1 | From account [1/3] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "1 | From account [2/3] : obhal-yb5xj-ue32x ktkql-rqe-vxtx5wq",
+      "1 | From account [3/3] : .1d02dc6 9531d6e8 375cf08e 80e6ecdd",
       "2 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "2 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "3 | Amount (Tokens) : 100000000000",
@@ -132,8 +135,9 @@
       "1 | Sender [2/2] : obhal-yb5xj-ue32x ktkql-rqe",
       "2 | Subaccount [1/2] : 1d02dc69 531d6e83 75cf08e8 0e6ecdd7",
       "2 | Subaccount [2/2] : 3b93b0ff 60cc297b 8a3fea53 1c020000",
-      "3 | From account [1/2] : eb94123b 55a5cf10 9982da44 a3cb35db",
-      "3 | From account [2/2] : 38a41b86 979acf20 ce44a97a c13ba2a2",
+      "3 | From account [1/3] : 5upke-tazvi-6ufqc i3v6r-j4gpu-dpwti",
+      "3 | From account [2/3] : obhal-yb5xj-ue32x ktkql-rqe-vxtx5wq",
+      "3 | From account [3/3] : .1d02dc6 9531d6e8 375cf08e 80e6ecdd",
       "4 | To account [1/2] : df4ad421 94201b15 ecbbe66f f68559a1",
       "4 | To account [2/2] : 26854d81 41fd935c 5bd53433 c2fb28d4",
       "5 | Amount (Tokens) : 100000000000",