Merge pull request #935 from LedgerHQ/cev/B2CA-2477_formatters

B2CA-2477: Add new formatters

Author: cedelavergne-ledger

.github/workflows/unit_tests.yml

@@ -0,0 +1,18 @@
+name: Unit testing with Codecov coverage checking
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+
+jobs:
+  job_unit_test:
+    name: Call Ledger unit_test
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_unit_tests.yml@v1
+    secrets: inherit
+    with:
+      test_directory: tests/unit
+      additional_packages: pkg-config libbsd-dev

client/src/ledger_app_clients/ethereum/gcs.py

@@ -99,6 +99,7 @@ class ParamType(IntEnum):
     TRUSTED_NAME = 0x08
     CALLDATA = 0x09
     TOKEN = 0x0a
+    NETWORK = 0x0b
 
 
 class TypeFamily(IntEnum):
@@ -219,6 +220,7 @@ class ContainerPath(IntEnum):
     FROM = 0x00
     TO = 0x01
     VALUE = 0x02
+    CHAIN_ID = 0x03
 
 
 class Value(TlvSerializable):
@@ -544,27 +546,63 @@ def serialize(self) -> bytes:
         return payload
 
 
+class ParamNetwork(FieldParam):
+    version: int
+    value: Value
+
+    def __init__(self, version: int, value: Value):
+        self.type = ParamType.NETWORK
+        self.version = version
+        self.value = value
+
+    def serialize(self) -> bytes:
+        payload = bytearray()
+        payload += self.serialize_field(0x00, self.version)
+        payload += self.serialize_field(0x01, self.value.serialize())
+        return payload
+
+
 class FieldTag(IntEnum):
     VERSION = 0x00
     NAME = 0x01
     PARAM_TYPE = 0x02
     PARAM = 0x03
 
 
+class VisibleType(IntEnum):
+    ALWAYS = 0x00
+    MUST_BE = 0x01
+    IF_NOT_IN = 0x02
+
+
 class Field(TlvSerializable):
     version: int
     name: str
     param: FieldParam
+    visible: Optional[VisibleType]
+    constraints: Optional[list[bytes]]
 
-    def __init__(self, version: int, name: str, param: FieldParam):
+    def __init__(self,
+                 version: int,
+                 name: str,
+                 param: FieldParam,
+                 visible: Optional[VisibleType] = None,
+                 constraints: Optional[list[bytes]] = None):
         self.version = version
         self.name = name
         self.param = param
+        self.visible = visible
+        self.constraints = constraints
 
     def serialize(self) -> bytes:
         payload = bytearray()
         payload += self.serialize_field(FieldTag.VERSION, self.version)
         payload += self.serialize_field(FieldTag.NAME, self.name)
         payload += self.serialize_field(FieldTag.PARAM_TYPE, self.param.type)
         payload += self.serialize_field(FieldTag.PARAM, self.param.serialize())
+        if self.visible is not None:
+            payload += self.serialize_field(0x04, self.visible)
+        if self.constraints is not None:
+            for constraint in self.constraints:
+                payload += self.serialize_field(0x05, constraint)
         return payload

doc/tlv_structs.md

@@ -64,12 +64,21 @@
 It contains no signature since the signed TRANSACTION_INFO struct already has a hash of all the FIELD
 structs, which attests of the authenticity, order and completeness of all FIELD structs.
 
-| Name       | Tag  | Payload type | Description                | Optional | Source / value                                             |
-|------------|------|--------------|----------------------------|----------|------------------------------------------------------------|
-| VERSION    | 0x00 | uint8        | struct version             |          | constant: `0x0`                                            |
-| NAME       | 0x01 | char[]       | field display name (ASCII) |          | `$.display.formats.<format id>.fields.[<field id>].label`  |
-| PARAM_TYPE | 0x02 | uint8        | `ParamType`                |          | `$.display.formats.<format id>.fields.[<field id>].params` |
-| PARAM      | 0x03 | PARAM_*      |                            |          | `$.display.formats.<format id>.fields.[<field id>].params` |
+| Name       | Tag  | Payload type | Description                         | Optional | Source / value                                              |
+|------------|------|--------------|-------------------------------------|----------|-------------------------------------------------------------|
+| VERSION    | 0x00 | uint8        | struct version                      |          | constant: `0x0`                                             |
+| NAME       | 0x01 | char[]       | field display name (ASCII)          |          | `$.display.formats.<format id>.fields.[<field id>].label`   |
+| PARAM_TYPE | 0x02 | uint8        | `ParamType`                         |          | `$.display.formats.<format id>.fields.[<field id>].params`  |
+| PARAM      | 0x03 | PARAM_*      |                                     |          | `$.display.formats.<format id>.fields.[<field id>].params`  |
+| VISIBLE    | 0x04 | uint8        | `VisibleType` visibility condition  | x        | `$.display.formats.<format id>.fields.[<field id>].visible` |
+| CONSTRAINT | 0x05 | uint8[]      | constraint value (raw bytes)        | x        | `$.display.formats.<format id>.fields.[<field id>].visible` |
+
+> __Notes__:
+>
+> - `VISIBLE` defaults to `ALWAYS` (0x00) if not present
+> - `VISIBLE` can be present only once and should be served before any `CONSTRAINT`
+> - `CONSTRAINT` is only present when `VISIBLE` is `MUST_BE` or `IF_NOT_IN`
+> - `CONSTRAINT` tag can appear multiple times for multiple allowed/excluded values (OR semantics). The limit is 5 constraints.
 
 with `ParamType` enum defined as:
 
@@ -86,6 +95,15 @@ with `ParamType` enum defined as:
 | TRUSTED_NAME | 0x08  |
 | CALLDATA     | 0x09  |
 | TOKEN        | 0x0a  |
+| NETWORK      | 0x0b  |
+
+with `VisibleType` enum defined as:
+
+| Name      | Value | Description                                                                                |
+|-----------|-------|--------------------------------------------------------------------------------------------|
+| ALWAYS    | 0x00  | Field is always displayed (default)                                                        |
+| MUST_BE   | 0x01  | Field not displayed but must match one of the constraint values, otherwise tx is rejected  |
+| IF_NOT_IN | 0x02  | Field is displayed only if value is NOT in the constraint list                             |
 
 ### PARAM_RAW
 
@@ -212,6 +230,20 @@ and `TrustedNameSource` enum defined as:
 
 This struct can contain `NATIVE_CURRENCY` multiple times for multiple addresses.
 
+### PARAM_NETWORK
+
+| Name    | Tag  | Payload type | Description                 | Optional | Source / value                                           |
+|---------|------|--------------|-----------------------------|----------|----------------------------------------------------------|
+| VERSION | 0x00 | uint8        | struct version              |          | constant: `0x0`                                          |
+| VALUE   | 0x01 | VALUE        | reference to chain ID value |          | `$.display.formats.<format id>.fields.[<field id>].path` |
+
+The device looks up the network name from the chain ID using:
+
+1. Dynamic networks
+2. Built-in networks
+
+If the network is not found, the device falls back to displaying the raw chain ID.
+
 ### VALUE
 
 | Name           | Tag  | Payload type    | Description                             | Optional | Source / value                                            |
@@ -238,26 +270,14 @@ with `TypeFamily` enum defined as:
 
 and `ContainerPath` enum defined as:
 
-| Name  | Value |
-|-------|-------|
-| FROM  | 0x00  |
-| TO    | 0x01  |
-| VALUE | 0x02  |
-
-The TLV payload must include exactly one of `DATA_PATH`, `CONTAINER_PATH` or `CONSTANT`.
-
-with `TypeFamily` enum defined as:
+| Name     | Value |
+|----------|-------|
+| FROM     | 0x00  |
+| TO       | 0x01  |
+| VALUE    | 0x02  |
+| CHAIN_ID | 0x03  |
 
-| Name    | Value |
-|---------|-------|
-| UINT    | 0x01  |
-| INT     | 0x02  |
-| UFIXED  | 0x03  |
-| FIXED   | 0x04  |
-| ADDRESS | 0x05  |
-| BOOL    | 0x06  |
-| BYTES   | 0x07  |
-| STRING  | 0x08  |
+> __Note__: The TLV payload must include exactly one of `DATA_PATH`, `CONTAINER_PATH` or `CONSTANT`.
 
 ### DATA_PATH
 

src/features/generic_tx_parser/cmd_field.c

@@ -17,9 +17,13 @@ static bool handle_tlv_payload(const uint8_t *payload, uint16_t size) {
     ctx.field = &field;
     parsing_ret = tlv_parse(payload, size, (f_tlv_data_handler) &handle_field_struct, &ctx);
     hashing_ret = cx_hash_no_throw(get_fields_hash_ctx(), 0, payload, size, NULL, 0) == CX_OK;
-    if (!parsing_ret || !hashing_ret) return false;
+    if (!parsing_ret || !hashing_ret) {
+        cleanup_field_constraints(&field);
+        return false;
+    }
     if (!verify_field_struct(&ctx)) {
         PRINTF("Error: could not verify the field struct!\n");
+        cleanup_field_constraints(&field);
         return false;
     }
     if (!format_field(&field)) {