Code cleanup.

Author: agrojean-ledger

README.md

@@ -259,4 +259,4 @@ You can also simply open an issue with the tag `enhancement`.
 4. Push to the Branch (`git push origin feature/my-feature`)
 5. Open a Pull Request
 
-Please try to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+Please try to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

proto_gen.sh

@@ -64,7 +64,7 @@ cat > value.options << 'EOF'
 * anonymous_oneof:true
 # Handle recursive Value fields with pointers to break cycles
 com.daml.ledger.api.v2.RecordField.value type:FT_POINTER
-com.daml.ledger.api.v2.List.elements type:FT_POINTER  
+com.daml.ledger.api.v2.List.elements type:FT_POINTER
 com.daml.ledger.api.v2.Optional.value type:FT_POINTER
 com.daml.ledger.api.v2.Variant.value type:FT_POINTER
 com.daml.ledger.api.v2.TextMap.Entry.value type:FT_POINTER
@@ -111,7 +111,7 @@ cat > interactive_submission_service.options << 'EOF'
 * anonymous_oneof:true
 com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse.prepared_transaction_hash max_size: 32
 com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse.hashing_details type:FT_POINTER
-com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed.node_id type:FT_STATIC 
+com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed.node_id type:FT_STATIC
 com.daml.ledger.api.v2.interactive.DamlTransaction.version type:FT_POINTER
 com.daml.ledger.api.v2.interactive.DamlTransaction.roots type:FT_POINTER
 com.daml.ledger.api.v2.interactive.DamlTransaction.roots type:FT_POINTER
@@ -140,29 +140,29 @@ generate_nanopb_code() {
   # Extract the base name for the options file
   local base_name=$(basename "$proto_file" .proto)
   local options_file="${base_name}.options"
-  
+
   # Check if specific options file exists, otherwise use value.options for Value-related protos
   if [ ! -f "$options_file" ] && [[ "$proto_file" == *"value.proto"* ]]; then
     options_file="value.options"
   fi
 
   # Build the protoc command
   local protoc_cmd="$PROTOC --nanopb_out=$OUTPUT_DIR"
-  
+
   # Add options file if it exists
   if [ -f "$options_file" ]; then
     protoc_cmd="$protoc_cmd --nanopb_opt=-f$options_file"
   fi
-  
+
   # Add common options to handle recursion and static allocation
   protoc_cmd="$protoc_cmd --nanopb_opt=-T"
   protoc_cmd="$protoc_cmd --nanopb_opt=-s\"max_size:1024\""
-  
+
   # Add extra options if provided
   if [ -n "$extra_opts" ]; then
     protoc_cmd="$protoc_cmd $extra_opts"
   fi
-  
+
   # Add include paths
   protoc_cmd="$protoc_cmd -I$include_paths -I. --plugin=protoc-gen-nanopb=$NANOPB_GENERATOR $proto_file"
   py_protoc_cmd="$PROTOC -I$include_paths -I. --python_out=tests --pyi_out=tests $proto_file"

src/handler/sign_tx.c

@@ -108,13 +108,7 @@ int handler_sign_tx(buffer_t *cdata, uint8_t chunk, bool more) {
 
             PRINTF("Hash: %.*H\n", sizeof(G_context.tx_info.m_hash), G_context.tx_info.m_hash);
 
-            return io_send_sw(SW_OK);
-            // Example to trig a blind-sign flow
-            // if (strcmp((char *) G_context.tx_info.transaction.memo, "Blind-sign") == 0) {
-            //     return ui_display_blind_signed_transaction();
-            // } else {
-            //     return ui_display_transaction();
-            // }
+            return ui_display_blind_signed_transaction();
         }
     }
     return 0;

src/transaction/hash.c

@@ -593,7 +593,7 @@ static void hash_transaction(const DamlTransaction *tx, uint8_t out[32]) {
 static void encode_input_contract(ByteWriter *bw, const InputContract *c) {
     encode_int64(bw, c->created_at);
 
-    // Encode contract create node in seprate buffer and calculate its hash
+    // Encode contract create node in separate buffer and calculate its hash
     uint8_t *scratch = app_mem_alloc(MAX_ENCODED_NODE_LEN);
     LEDGER_ASSERT(scratch != NULL, "Failed to allocate scratch buf for node id");
 

src/transaction/hash.h

@@ -7,4 +7,4 @@ typedef com_daml_ledger_api_v2_interactive_PreparedTransaction PreparedTransacti
 
 int prepared_transaction_hash(const PreparedTransaction *pt, uint8_t out[32]);
 
-#endif  // HASH_H
+#endif  // HASH_H

src/ui/menu.h

@@ -4,8 +4,3 @@
  * Show main menu (ready screen, version, about, quit).
  */
 void ui_menu_main(void);
-
-/**
- * Show about submenu (copyright, date).
- */
-void ui_menu_about(void);

src/ui/menu_nbgl.c

@@ -40,116 +40,19 @@ void app_quit(void) {
 static const char* const INFO_TYPES[SETTING_INFO_NB] = {"Version", "Developer"};
 static const char* const INFO_CONTENTS[SETTING_INFO_NB] = {APPVERSION, "Ledger"};
 
-// settings switches definitions
-enum { DUMMY_SWITCH_1_TOKEN = FIRST_USER_TOKEN, DUMMY_SWITCH_2_TOKEN };
-enum { DUMMY_SWITCH_1_ID = 0, DUMMY_SWITCH_2_ID, SETTINGS_SWITCHES_NB };
-
-static nbgl_contentSwitch_t switches[SETTINGS_SWITCHES_NB] = {0};
-
 static const nbgl_contentInfoList_t infoList = {
     .nbInfos = SETTING_INFO_NB,
     .infoTypes = INFO_TYPES,
     .infoContents = INFO_CONTENTS,
 };
 
-static uint8_t initSettingPage;
-static void review_warning_choice(bool confirm);
-static void controls_callback(int token, uint8_t index, int page);
-
-// settings menu definition
-#define SETTING_CONTENTS_NB 1
-static const nbgl_content_t contents[SETTING_CONTENTS_NB] = {
-    {.type = SWITCHES_LIST,
-     .content.switchesList.nbSwitches = SETTINGS_SWITCHES_NB,
-     .content.switchesList.switches = switches,
-     .contentActionCallback = controls_callback}};
-
-static const nbgl_genericContents_t settingContents = {.callbackCallNeeded = false,
-                                                       .contentsList = contents,
-                                                       .nbContents = SETTING_CONTENTS_NB};
-
-// callback for setting warning choice
-static void review_warning_choice(bool confirm) {
-    uint8_t switch_value;
-    if (confirm) {
-        // toggle the switch value
-        switch_value = !N_storage.dummy2_allowed;
-        switches[DUMMY_SWITCH_2_ID].initState = (nbgl_state_t) switch_value;
-        // store the new setting value in NVM
-        nvm_write((void*) &N_storage.dummy2_allowed, &switch_value, 1);
-    }
-
-    // Reset setting menu to the right page
-    nbgl_useCaseHomeAndSettings(APPNAME,
-                                &ICON_APP_HOME,
-                                NULL,
-                                initSettingPage,
-                                &settingContents,
-                                &infoList,
-                                NULL,
-                                app_quit);
-}
-
-static void controls_callback(int token, uint8_t index, int page) {
-    UNUSED(index);
-
-    initSettingPage = page;
-
-    uint8_t switch_value;
-    if (token == DUMMY_SWITCH_1_TOKEN) {
-        // Dummy 1 switch touched
-        // toggle the switch value
-        switch_value = !N_storage.dummy1_allowed;
-        switches[DUMMY_SWITCH_1_ID].initState = (nbgl_state_t) switch_value;
-        // store the new setting value in NVM
-        nvm_write((void*) &N_storage.dummy1_allowed, &switch_value, 1);
-    } else if (token == DUMMY_SWITCH_2_TOKEN) {
-        // Dummy 2 switch touched
-
-        // in this example we display a warning when the user wants
-        // to activate the dummy 2 setting
-        if (!N_storage.dummy2_allowed) {
-            // Display the warning message and ask the user to confirm
-            nbgl_useCaseChoice(&ICON_APP_WARNING,
-                               "Dummy 2",
-                               "Are you sure to\nallow dummy 2\nin transactions?",
-                               "I understand, confirm",
-                               "Cancel",
-                               review_warning_choice);
-        } else {
-            // toggle the switch value
-            switch_value = !N_storage.dummy2_allowed;
-            switches[DUMMY_SWITCH_2_ID].initState = (nbgl_state_t) switch_value;
-            // store the new setting value in NVM
-            nvm_write((void*) &N_storage.dummy2_allowed, &switch_value, 1);
-        }
-    }
-}
-
 // home page definition
 void ui_menu_main(void) {
-    // Initialize switches data
-    switches[DUMMY_SWITCH_1_ID].initState = (nbgl_state_t) N_storage.dummy1_allowed;
-    switches[DUMMY_SWITCH_1_ID].text = "Dummy 1";
-    switches[DUMMY_SWITCH_1_ID].subText = "Allow dummy 1\nin transactions";
-    switches[DUMMY_SWITCH_1_ID].token = DUMMY_SWITCH_1_TOKEN;
-#ifdef HAVE_PIEZO_SOUND
-    switches[DUMMY_SWITCH_1_ID].tuneId = TUNE_TAP_CASUAL;
-#endif
-
-    switches[DUMMY_SWITCH_2_ID].initState = (nbgl_state_t) N_storage.dummy2_allowed;
-    switches[DUMMY_SWITCH_2_ID].text = "Dummy 2";
-    switches[DUMMY_SWITCH_2_ID].subText = "Allow dummy 2\nin transactions";
-    switches[DUMMY_SWITCH_2_ID].token = DUMMY_SWITCH_2_TOKEN;
-#ifdef HAVE_PIEZO_SOUND
-    switches[DUMMY_SWITCH_2_ID].tuneId = TUNE_TAP_CASUAL;
-#endif
-
     nbgl_useCaseHomeAndSettings(APPNAME,
                                 &ICON_APP_HOME,
                                 NULL,
                                 INIT_HOME_PAGE,
-                                &settingContents,
+                                NULL,
                                 &infoList,
                                 NULL,
                                 app_quit);

tests/application_client/boilerplate_command_sender.py

@@ -108,7 +108,7 @@ def sign_tx(self, path: str, transaction: bytes) -> Generator[None, None, None]:
                               data=pack_derivation_path(path))
         messages = split_message(transaction, MAX_APDU_LEN)
         idx: int = P1.P1_START + 1
-        
+
         print(f"Sending {len(messages)} chunks of transaction data")
 
         for msg in messages[:-1]:

tests/application_client/boilerplate_transaction.py

@@ -2,9 +2,11 @@
 from io import BytesIO
 from typing import Union
 
-from .boilerplate_utils import read, read_uint, read_varint, write_varint, UINT64_MAX
 from google.protobuf.json_format import Parse
-from com.daml.ledger.api.v2.interactive import interactive_submission_service_pb2
+# pylint: disable=no-name-in-module, import-error
+from com.daml.ledger.api.v2.interactive.interactive_submission_service_pb2 import PrepareSubmissionResponse # type: ignore
+
+from .boilerplate_utils import read, read_uint, read_varint, write_varint, UINT64_MAX
 
 # from proto.message_pb2 import SimpleInt
 
@@ -54,12 +56,11 @@ def from_bytes(cls, hexa: Union[bytes, BytesIO]):
         return cls(nonce=nonce, to=to, value=value, memo=memo)
 
     @classmethod
-    def serialize_from_json(self, json_file: str) -> bytes:
-        with open(json_file, "r") as file:
+    def serialize_from_json(cls, json_file: str) -> bytes:
+        with open(json_file, "r", encoding="utf-8") as file:
             data = json.load(file)
-            
-        prepared_tx = interactive_submission_service_pb2.PrepareSubmissionResponse()
+
+        prepared_tx = PrepareSubmissionResponse()
         Parse(json.dumps(data), prepared_tx)
-    
-        return prepared_tx.SerializeToString()
 
+        return prepared_tx.SerializeToString()

tests/test_sign_cmd.py

@@ -1,35 +1,43 @@
-import pytest
 from ragger.backend.interface import BackendInterface
-from ragger.error import ExceptionRAPDU
-from ragger.navigator.navigation_scenario import NavigateWithScenario
+# from ragger.error import ExceptionRAPDU
+# from ragger.navigator.navigation_scenario import NavigateWithScenario
 
 from application_client.boilerplate_transaction import Transaction
-from application_client.boilerplate_command_sender import BoilerplateCommandSender, Errors
-from application_client.boilerplate_response_unpacker import unpack_get_public_key_response, unpack_sign_tx_response
-from utils import check_signature_validity
+from application_client.boilerplate_command_sender import (
+    BoilerplateCommandSender,
+    # Errors,
+)
+# from application_client.boilerplate_response_unpacker import (
+#     unpack_get_public_key_response,
+#     unpack_sign_tx_response,
+# )
+# from utils import check_signature_validity
+
 
 # In this test se send to the device a transaction to sign and validate it on screen
 # This test is mostly the same as the previous one but with different values.
 # In particular the long memo will force the transaction to be sent in multiple chunks
-def test_sign_tx_long_tx(backend: BackendInterface, scenario_navigator: NavigateWithScenario) -> None:
+def test_sign_tx_long_tx(
+    backend: BackendInterface,  # , scenario_navigator: NavigateWithScenario
+) -> None:
     # Use the app interface instead of raw interface
     client = BoilerplateCommandSender(backend)
     path: str = "m/44'/1'/0'/0/0"
 
     # rapdu = client.get_public_key(path=path)
     # _, public_key, _, _ = unpack_get_public_key_response(rapdu.data)
-    
-    serialized_tx = Transaction.serialize_from_json("tests/tx_examples/external_sign_ping.json")
-    
+
+    serialized_tx = Transaction.serialize_from_json(
+        "tests/tx_examples/external_sign_ping.json"
+    )
+
     print(f"Serialized transaction length: {len(serialized_tx)} bytes")
-    
+
     # client.sign_tx(path=path, transaction=serialized_tx)
 
-    with client.sign_tx(path=path, transaction=serialized_tx) as response:
+    with client.sign_tx(path=path, transaction=serialized_tx):
         print("Transaction sent")
-    #     if response.status != 0x9000:
-    #         raise ExceptionRAPDU(f"Unexpected status code: {response.status}")
-    # #     scenario_navigator.review_approve()
+        # scenario_navigator.review_approve()
 
     # response = client.get_async_response().data
     # _, der_sig, _ = unpack_sign_tx_response(response)