Merge pull request #565 from LedgerHQ/cev/B2CA-1558_Port-Flex

B2CA-1558: Port Ethereum on Flex

.clang-format

@@ -1,7 +1,6 @@
 ---
 BasedOnStyle: Google
 IndentWidth: 4
----
 Language: Cpp
 ColumnLimit: 100
 PointerAlignment: Right
@@ -12,7 +11,6 @@ SortIncludes: false
 SpaceAfterCStyleCast: true
 AllowShortCaseLabelsOnASingleLine: false
 AllowAllArgumentsOnNextLine: false
-AllowAllParametersOfDeclarationOnNextLine: false
 AllowShortBlocksOnASingleLine: Never
 AllowShortFunctionsOnASingleLine: None
 BinPackArguments: false

.github/workflows/codespell.yml

@@ -1,4 +1,4 @@
-name: Misspelings CI
+name: Misspellings CI
 
 on:
   workflow_dispatch:

.mdl.rb

@@ -0,0 +1,11 @@
+# Style file for mdl
+# https://github.com/markdownlint/markdownlint/blob/main/docs/creating_styles.md
+
+# Include all rules
+all
+
+# Disable specific rules
+#exclude_rule 'MD012'
+
+# Update rules configuration
+rule 'MD013', :line_length => 120

.mdlrc

@@ -0,0 +1,14 @@
+# markdownlint config file
+
+# Use custom style file
+style "#{File.dirname(__FILE__)}/.mdl.rb"
+
+# MD002 - First header in file should be a top level header
+# MD005 - Inconsistent indentation for list items at the same level
+# MD007 - Unordered list indentation
+# MD014 - Dollar signs used before commands without showing output
+# MD024 - Multiple headers with the same content
+# MD029 - Ordered list item prefix
+# MD033 - Inline HTML
+# MD041 - First line in file should be a top level header
+rules "~MD002,~MD005,~MD007,~MD014,~MD024,~MD029,~MD033,~MD041"

.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+# To install hooks, run:
+# pre-commit install --hook-type pre-commit
+# pre-commit install --hook-type commit-msg
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-case-conflict
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args: ['--ignore-words-list', 'ontop,shft,hte', '--skip', 'makefile_conf/chain/*,tests/ragger/eip712_input_files/*']
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v12.0.1
+    hooks:
+      - id: clang-format
+        types_or: [c]
+
+  - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
+    rev: v1.6.27.13
+    hooks:
+      - id: actionlint
+        types_or: [yaml]
+        args: [-shellcheck='' -pyflakes='']
+
+  - repo: https://github.com/markdownlint/markdownlint
+    rev: v0.12.0
+    hooks:
+      - id: markdownlint
+        types_or: [markdown]
+
+  - repo: https://github.com/PyCQA/pylint
+    rev: v2.16.2
+    hooks:
+      - id: pylint
+        types: [python]
+        args: ['--jobs=0', '--rcfile=tests/ragger/setup.cfg']
+        files: '^tests/ragger/.*$'

CHANGELOG.md

@@ -124,7 +124,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
-- EIP-191 improvements, now lets the user see the entire message one chunk at a time (255 characters for LNX & LNS+, 99 for LNS)
+- EIP-191 improvements, now lets the user see the entire message one chunk at a time
+  (255 characters for LNX & LNS+, 99 for LNS)
 
 ### Fixed
 
@@ -145,7 +146,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
-- EIP-191 signatures now show (up to 99 characters on LNS and 255 on LNX & LNS+) the actual data contained in the message (clear-signing)
+- EIP-191 signatures now show (up to 99 characters on LNS and 255 on LNX & LNS+) the actual data
+  contained in the message (clear-signing)
 
 ### Fixed
 
@@ -256,7 +258,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- When blind signing is disabled in settings, and a transaction with smart conract interactions is sent to the app, a new warning screen pops to let the user know that the setting must be enabled to sign this kind of transactions.
+- When blind signing is disabled in settings, and a transaction with smart conract interactions is sent to the app,
+  a new warning screen pops to let the user know that the setting must be enabled to sign this kind of transactions.
 
 ## [1.9.4](https://github.com/ledgerhq/app-ethereum/compare/1.9.3...1.9.4) - 2021-9-14
 

Makefile

@@ -44,7 +44,7 @@ APPVERSION = $(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)-dev
 
 # Application source files
 APP_SOURCE_PATH += src src_features src_plugins
-ifeq ($(TARGET_NAME),TARGET_STAX)
+ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_STAX TARGET_FLEX))
     APP_SOURCE_PATH += src_nbgl
 else
     APP_SOURCE_PATH += src_bagl
@@ -55,7 +55,7 @@ APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/crypto_helpers.c
 APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/format.c
 INCLUDES_PATH += ${BOLOS_SDK}/lib_standard_app
 
-ifeq ($(TARGET_NAME),TARGET_STAX)
+ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_STAX TARGET_FLEX))
 NETWORK_ICONS_FILE = $(GEN_SRC_DIR)/net_icons.gen.c
 NETWORK_ICONS_DIR = $(shell dirname "$(NETWORK_ICONS_FILE)")
 
@@ -71,12 +71,13 @@ ICON_NANOS = icons/nanos_app_chain_$(CHAIN_ID).gif
 ICON_NANOX = icons/nanox_app_chain_$(CHAIN_ID).gif
 ICON_NANOSP = icons/nanox_app_chain_$(CHAIN_ID).gif
 ICON_STAX = icons/stax_app_chain_$(CHAIN_ID).gif
+ICON_FLEX = icons/flex_app_chain_$(CHAIN_ID).gif
 
 #prepare hsm generation
-ifeq ($(TARGET_NAME),TARGET_STAX)
-    DEFINES += ICONGLYPH=C_stax_chain_$(CHAIN_ID)_64px
-    DEFINES += ICONBITMAP=C_stax_chain_$(CHAIN_ID)_64px_bitmap
-    DEFINES += ICONGLYPH_SMALL=C_stax_chain_$(CHAIN_ID)
+ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_STAX TARGET_FLEX))
+    DEFINES += ICONGLYPH=C_chain_$(CHAIN_ID)_64px
+    DEFINES += ICONBITMAP=C_chain_$(CHAIN_ID)_64px_bitmap
+    DEFINES += ICONGLYPH_SMALL=C_chain_$(CHAIN_ID)
 endif
 
 

README.md

@@ -263,9 +263,11 @@ to compile and run them.
 
 ## Contributing
 
-Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+Contributions are what makes the open source community such an amazing place to learn, inspire, and create.
+Any contributions you make are **greatly appreciated**.
 
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag `enhancement`.
+If you have a suggestion that would make this better, please fork the repo and create a pull request.
+You can also simply open an issue with the tag `enhancement`.
 
 1. Fork the Project
 2. Create your Feature Branch (`git checkout -b feature/my-feature`)

client/src/ledger_app_clients/ethereum/client.py

@@ -147,6 +147,14 @@ def get_eth2_public_addr(self,
         return self._exchange_async(self._cmd_builder.get_eth2_public_addr(display,
                                                                            bip32_path))
 
+    def perform_privacy_operation(self,
+                                  display: bool = True,
+                                  bip32_path: str = "m/44'/60'/0'/0/0",
+                                  pubkey: bytes = bytes()):
+        return self._exchange(self._cmd_builder.perform_privacy_operation(display,
+                                                                          bip32_path,
+                                                                          pubkey))
+
     def provide_domain_name(self, challenge: int, name: str, addr: bytes) -> RAPDU:
         payload = format_tlv(DomainNameTag.STRUCTURE_TYPE, 3)  # TrustedDomainName
         payload += format_tlv(DomainNameTag.STRUCTURE_VERSION, 1)

client/src/ledger_app_clients/ethereum/command_builder.py

@@ -17,6 +17,7 @@ class InsType(IntEnum):
     PROVIDE_ERC20_TOKEN_INFORMATION = 0x0a
     PROVIDE_NFT_INFORMATION = 0x14
     SET_PLUGIN = 0x16
+    PERFORM_PRIVACY_OPERATION = 0x18
     EIP712_SEND_STRUCT_DEF = 0x1a
     EIP712_SEND_STRUCT_IMPL = 0x1c
     EIP712_SEND_FILTERING = 0x1e
@@ -260,6 +261,16 @@ def get_eth2_public_addr(self,
                                0x00,
                                payload)
 
+    def perform_privacy_operation(self,
+                                  display: bool,
+                                  bip32_path: str,
+                                  pubkey: bytes) -> bytes:
+        payload = pack_derivation_path(bip32_path)
+        return self._serialize(InsType.PERFORM_PRIVACY_OPERATION,
+                               int(display),
+                               0x01 if pubkey else 0x00,
+                               payload + pubkey)
+
     def set_plugin(self,
                    type_: int,
                    version: int,

client/src/ledger_app_clients/ethereum/eip712/InputData.py

@@ -332,10 +332,7 @@ def next_timeout(_signum: int, _frame):
 
 
 def enable_autonext():
-    if app_client._client.firmware.device == 'stax':  # Stax Speculos is slow
-        delay = 1.5
-    else:
-        delay = 1/4
+    delay = 1/5
     signal.setitimer(signal.ITIMER_REAL, delay, delay)
 
 

client/src/ledger_app_clients/ethereum/settings.py

@@ -19,7 +19,7 @@ def get_device_settings(device: str) -> list[SettingID]:
             SettingID.DEBUG_DATA,
             SettingID.NONCE
         ]
-    if (device == "nanox") or (device == "nanosp") or (device == "stax"):
+    if device in ("nanox", "nanosp", "stax", "flex"):
         return [
             SettingID.BLIND_SIGNING,
             SettingID.DEBUG_DATA,
@@ -30,17 +30,28 @@ def get_device_settings(device: str) -> list[SettingID]:
     return []
 
 
-settings_per_page = 3
+def get_setting_per_page(device: str) -> int:
+    if device == "stax":
+        return 3
+    return 2
 
 
 def get_setting_position(device: str, setting: Union[NavInsID, SettingID]) -> tuple[int, int]:
-    screen_height = 672  # px
-    header_height = 85  # px
-    footer_height = 124  # px
+    settings_per_page = get_setting_per_page(device)
+    if device == "stax":
+        screen_height = 672  # px
+        header_height = 85  # px
+        footer_height = 132  # px
+        option_offset = 350  # px
+    else:
+        screen_height = 600  # px
+        header_height = 92  # px
+        footer_height = 97  # px
+        option_offset = 420  # px
     usable_height = screen_height - (header_height + footer_height)
     setting_height = usable_height // settings_per_page
     index_in_page = get_device_settings(device).index(SettingID(setting)) % settings_per_page
-    return 350, header_height + (setting_height * index_in_page) + (setting_height // 2)
+    return option_offset, header_height + (setting_height * index_in_page) + (setting_height // 2)
 
 
 def settings_toggle(fw: Firmware, nav: Navigator, to_toggle: list[SettingID]):
@@ -57,7 +68,7 @@ def settings_toggle(fw: Firmware, nav: Navigator, to_toggle: list[SettingID]):
         moves += [NavInsID.BOTH_CLICK]  # Back
     else:
         moves += [NavInsID.USE_CASE_HOME_SETTINGS]
-        moves += [NavInsID.USE_CASE_SETTINGS_NEXT]
+        settings_per_page = get_setting_per_page(fw.device)
         for setting in settings:
             setting_idx = settings.index(setting)
             if (setting_idx > 0) and (setting_idx % settings_per_page) == 0:

glyphs/chain_11155111_64px.gif

@@ -0,0 +1 @@
+chain_1_64px.gif

glyphs/chain_17000_64px.gif

@@ -0,0 +1 @@
+chain_1_64px.gif

ledger_app.toml

@@ -1,7 +1,7 @@
 [app]
 build_directory = "./"
 sdk = "C"
-devices = ["nanos", "nanox", "nanos+", "stax"]
+devices = ["nanos", "nanox", "nanos+", "stax", "flex"]
 
 [use_cases] # Coherent build options that make sense for your application
 debug = "DEBUG=1"

src/common_ui.h

@@ -13,6 +13,7 @@ void ui_display_public_key(const uint64_t *chain_id);
 void ui_sign_712_v0(void);
 void ui_confirm_selector(void);
 void ui_confirm_parameter(void);
+void app_quit(void);
 
 // EIP-191
 void ui_191_start(void);

src/uint_common.c

@@ -58,20 +58,3 @@ void reverseString(char *const str, uint32_t length) {
         str[j] = c;
     }
 }
-
-int bytes_to_string(char *out, size_t outl, const void *value, size_t len) {
-    if (outl <= 2) {
-        // Need at least '0x' and 1 digit
-        return -1;
-    }
-    if (strlcpy(out, "0x", outl) != 2) {
-        goto err;
-    }
-    if (format_hex(value, len, out + 2, outl - 2) < 0) {
-        goto err;
-    }
-    return 0;
-err:
-    *out = '\0';
-    return -1;
-}

src/uint_common.h

@@ -35,6 +35,4 @@ void read_u64_be(const uint8_t *const in, uint64_t *const out);
 uint64_t readUint64BE(const uint8_t *const buffer);
 void reverseString(char *const str, uint32_t length);
 
-int bytes_to_string(char *out, size_t outl, const void *value, size_t len);
-
 #endif  //_UINT_COMMON_H_

src_bagl/ui_flow_getEth2PublicKey.c

@@ -5,10 +5,10 @@
 #include "uint_common.h"
 
 void prepare_eth2_public_key() {
-    bytes_to_string(strings.tmp.tmp,
-                    sizeof(strings.tmp.tmp),
-                    tmpCtx.publicKeyContext.publicKey.W,
-                    48);
+    array_bytes_string(strings.tmp.tmp,
+                       sizeof(strings.tmp.tmp),
+                       tmpCtx.publicKeyContext.publicKey.W,
+                       48);
 }
 
 // clang-format off

src_bagl/ui_flow_signMessage.c

@@ -34,7 +34,7 @@ UX_STEP_NOCB(
     pnn,
     {
       &C_icon_certificate,
-      "Sign",
+      "Review",
       "message",
     });
 UX_STEP_NOCB(

src_bagl/ui_flow_signMessage712_v0.c

@@ -4,17 +4,17 @@
 #include "uint_common.h"
 
 void prepare_domain_hash_v0() {
-    bytes_to_string(strings.tmp.tmp,
-                    sizeof(strings.tmp.tmp),
-                    tmpCtx.messageSigningContext712.domainHash,
-                    KECCAK256_HASH_BYTESIZE);
+    array_bytes_string(strings.tmp.tmp,
+                       sizeof(strings.tmp.tmp),
+                       tmpCtx.messageSigningContext712.domainHash,
+                       KECCAK256_HASH_BYTESIZE);
 }
 
 void prepare_message_hash_v0() {
-    bytes_to_string(strings.tmp.tmp,
-                    sizeof(strings.tmp.tmp),
-                    tmpCtx.messageSigningContext712.messageHash,
-                    KECCAK256_HASH_BYTESIZE);
+    array_bytes_string(strings.tmp.tmp,
+                       sizeof(strings.tmp.tmp),
+                       tmpCtx.messageSigningContext712.messageHash,
+                       KECCAK256_HASH_BYTESIZE);
 }
 
 // clang-format off
@@ -23,7 +23,7 @@ UX_STEP_NOCB(
     pnn,
     {
       &C_icon_certificate,
-      "Sign",
+      "Review",
       "typed message",
     });
 UX_STEP_NOCB_INIT(