Merge pull request #53 from Zondax/feature/formatting

Custom number formatting

Author: jleni

CMakeLists.txt

@@ -101,6 +101,7 @@ file(GLOB_RECURSE LIB_SRC
         ${CMAKE_CURRENT_SOURCE_DIR}/deps/ledger-zxlib/src/zxformat.c
         ####
         ${CMAKE_CURRENT_SOURCE_DIR}/app/src/parser.c
+        ${CMAKE_CURRENT_SOURCE_DIR}/app/src/formatting.c
         ${CMAKE_CURRENT_SOURCE_DIR}/app/src/parser_impl.c
         ${CMAKE_CURRENT_SOURCE_DIR}/app/src/crypto.c
         ${CMAKE_CURRENT_SOURCE_DIR}/app/src/base32.c

app/Makefile

@@ -52,7 +52,7 @@ endif
 
 APPVERSION_M=0
 APPVERSION_N=3
-APPVERSION_P=0
+APPVERSION_P=1
 
 $(info COIN  = [$(COIN)])
 ifeq ($(COIN),DFN)

app/src/coin.h

@@ -45,9 +45,11 @@ typedef enum {
     addr_secp256k1 = 0,
 } address_kind_e;
 
-#define CBOR_PARSER_MAX_RECURSIONS          4
-#define COIN_SECRET_REQUIRED_CLICKS         0
-#define COIN_AMOUNT_DECIMAL_PLACES          0                              // FIXME: Adjust this
+#define CBOR_PARSER_MAX_RECURSIONS              4
+#define COIN_SECRET_REQUIRED_CLICKS             0
+#define COIN_AMOUNT_DECIMAL_PLACES              8
+#define COIN_AMOUNT_DECIMAL_NON_TRIMMED_PLACES  2
+#define COIN_AMOUNT_THOUSAND_SEPARATOR          '\''
 
 #define VIEW_ADDRESS_OFFSET_SECP256K1       (SECP256K1_PK_LEN )
 #define VIEW_PRINCIPAL_OFFSET_TEXT          (SECP256K1_PK_LEN + DFINITY_PRINCIPAL_LEN + DFINITY_SUBACCOUNT_LEN)

app/src/crypto.c

@@ -391,11 +391,14 @@ zxerr_t crypto_principalToTextual(const uint8_t *address_in, uint8_t addressLen,
     input[1] = (uint8_t) ((crc & 0x00FF0000) >> 16);
     input[2] = (uint8_t) ((crc & 0x0000FF00) >> 8);
     input[3] = (uint8_t) ((crc & 0x000000FF) >> 0);
+
     MEMCPY(input + 4, address_in, addressLen);
-    uint32_t enc_len = base32_encode(input, 4 + addressLen, textual, 100);
+    uint32_t enc_len = base32_encode(input, 4 + addressLen, textual, *outLen);
+
     if (enc_len == 0) {
         return zxerr_unknown;
     }
+
     *outLen = enc_len;
     return zxerr_ok;
 }
@@ -433,34 +436,6 @@ zxerr_t compressLEB128(const uint64_t input, uint16_t maxSize, uint8_t *output,
     return zxerr_ok;
 }
 
-uint8_t decompressLEB128(const uint8_t *input, uint16_t inputSize, uint64_t *v) {
-    unsigned int i = 0;
-
-    *v = 0;
-    uint16_t shift = 0;
-    while (i < 10u && i < inputSize) {
-        uint64_t b = input[i] & 0x7fu;
-
-        if (shift >= 63 && b > 1) {
-            // This will overflow uint64_t
-            break;
-        }
-
-        *v |= b << shift;
-
-        if (!(input[i] & 0x80u)) {
-            return 1;
-        }
-
-        shift += 7;
-        i++;
-    }
-
-    // exit because of overflowing outputSize
-    *v = 0;
-    return 0;
-}
-
 typedef struct {
     uint8_t publicKey[SECP256K1_PK_LEN];
     uint8_t principalBytes[DFINITY_PRINCIPAL_LEN];
@@ -491,7 +466,7 @@ zxerr_t crypto_fillAddress(uint8_t *buffer, uint16_t buffer_len, uint16_t *addrL
                                              zero_subaccount, DFINITY_SUBACCOUNT_LEN, answer->subAccountBytes,
                                              sizeof_field(answer_t, subAccountBytes)));
 
-    uint16_t outLen = 0;
+    uint16_t outLen = DFINITY_TEXTUAL_SIZE;
 
     CHECK_ZXERR(crypto_principalToTextual(answer->principalBytes, DFINITY_PRINCIPAL_LEN, answer->addrText, &outLen));
 

app/src/formatting.c

@@ -0,0 +1,80 @@
+/*******************************************************************************
+*   (c) 2021 Zondax GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+********************************************************************************/
+#include "formatting.h"
+
+zxerr_t inplace_insert_char(char *s, uint16_t sMaxLen, uint16_t pos, char separator) {
+    const size_t len = strlen(s);
+    if (len >= sMaxLen) {
+        return zxerr_buffer_too_small;
+    }
+
+    if (pos > len) {
+        return zxerr_out_of_bounds;
+    }
+
+    MEMMOVE(s + pos + 1, s + pos, len - pos + 1);  // len-pos+1 because we copy zero terminator
+    s[pos] = separator;
+
+    return zxerr_ok;
+}
+
+zxerr_t number_inplace_thousands(char *s, uint16_t sMaxLen, char separator) {
+    const size_t len = strlen(s);
+    if (len > sMaxLen) {
+        return zxerr_encoding_failed;
+    }
+
+    // find decimal point
+    int32_t dec_point = -1;
+    for (int32_t i = 0; i < len && dec_point < 0; i++) {
+        if (s[i] == '.') {
+            dec_point = i;
+        }
+    }
+
+    if (dec_point < 0) {
+        dec_point = (uint16_t) len;
+    }
+
+    if (dec_point < 4) {
+        return zxerr_ok;
+    }
+
+    const uint8_t numSep = (dec_point - 1) / 3;
+
+    if (len + numSep >= sMaxLen) {
+        return zxerr_buffer_too_small;
+    }
+
+    size_t pos = dec_point;
+
+    while (pos > 3) {
+        pos -= 3;
+        CHECK_ZXERR(inplace_insert_char(s, sMaxLen, pos, separator));
+    }
+
+    return zxerr_ok;
+}
+
+zxerr_t formatICP(char *out, uint16_t outLen, uint64_t value) {
+    MEMZERO(out, outLen);
+
+    fpuint64_to_str(out, outLen, value, COIN_AMOUNT_DECIMAL_PLACES);
+    number_inplace_trimming(out, COIN_AMOUNT_DECIMAL_NON_TRIMMED_PLACES);
+    CHECK_ZXERR(number_inplace_thousands(out, outLen, COIN_AMOUNT_THOUSAND_SEPARATOR));
+
+    return zxerr_ok;
+}

app/src/formatting.h

@@ -0,0 +1,32 @@
+/*******************************************************************************
+*   (c) 2021 Zondax GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+********************************************************************************/
+#pragma once
+#include "stdint.h"
+#include "parser.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+zxerr_t inplace_insert_char(char *s, uint16_t sMaxLen, uint16_t pos, char separator);
+
+zxerr_t number_inplace_thousands(char *s, uint16_t sMaxLen, char separator);
+
+zxerr_t formatICP(char *out, uint16_t outLen, uint64_t value);
+
+#ifdef __cplusplus
+}
+#endif