Rebase on ledgerhq/app-tezos-new

.clang-format

@@ -5,7 +5,7 @@ IndentWidth:      4
 ColumnLimit:      78
 UseTab:           Never
 IndentCaseLabels: false
-InsertBraces:     false
+InsertBraces:     true
 PointerAlignment: Right
 
 AlwaysBreakAfterReturnType: TopLevelDefinitions
@@ -36,4 +36,5 @@ AlignArrayOfStructures: Left
 SortIncludes: Never
 SpaceAfterCStyleCast: false
 AllowShortEnumsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: Never
 ...

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+# Checklist
+<!-- Put an `x` in each box when you have completed the items. -->
+- [ ] App update process has been followed <!-- See comment below -->
+- [ ] Target branch is `develop` <!-- unless you have a very good reason -->
+- [ ] Application version has been bumped <!-- required if your changes are to be deployed -->
+
+<!-- Make sure you followed the process described in https://developers.ledger.com/docs/device-app/deliver/maintenance before opening your Pull Request.
+Don't hesitate to contact us directly on Discord if you have any questions ! https://developers.ledger.com/discord -->

README.md

@@ -175,43 +175,36 @@ re-run the test normally afterwards, to ensure the snapshots have been set corre
 
 #### Preparation
 
-First, start a container for running individual tests:
+First start the app in a terminal using following command:
 
 ```sh
-docker run --rm -it --entrypoint /bin/bash -v $(pwd):/app --network host \
-  ledger-app-tezos-integration-tests
-
-cd /app/tests/integration/stax
-export PORT=5000
-
-git config --global --add safe.directory /app
-. ../app_vars.sh
+make app_stax_dbg.tgz
+TARGET=stax ./scripts/run_app.sh
 ```
+You should be able to see the stax display on your screen.
 
-Before running the test, start the app in a separate container (as each test will quit the app):
+Open a new terminal for running tests, run following commands to setup test environment
 
 ```sh
-make app_stax_dbg.tgz
-
-TARGET=stax ./scripts/run_app.sh
+$ docker exec -it ledger-app-tezos-integration-tests bash;
+<docker>$ export PORT=5000
+<docker>$ . tests/integration/app_vars.sh
 ```
 
-You can view/interact with the app using a vnc client on port `41000`.
-
 #### Running
 
-You can run an individual test from the test container. You should see the app progress on the vnc viewer.
+You can run an individual test from the test container. You should see the app progress on the display.
 
 ```sh
-./<test_name>.py
+./tests/integration/stax/<test_name>.py
 ```
 
 #### Setting goldimages
 
 You can reset/set goldimages using the following:
 
 ```sh
-GOLDEN=1 ./<test_name>.py
+GOLDEN=1 ./tests/integration/stax/<test_name>.py
 ```
 
 If you are resetting goldimages for multiple tests, you can also use `export NOQUIT=1` to keep the app
@@ -263,3 +256,12 @@ You can run :
 ./scripts/test_swap.sh update $DEVICE
 ```
 to perform all snapshot update steps based on your current Tezos repository.
+
+## Contributing
+
+The version of the app must be updated after every change. Following files need to be updated
+with a new version
+1. app/Makefile
+2. tests/integration/app_vars.sh
+3. tests/integration/nano/utils/app.py
+4. the snapshots (nano and stax)

app/Makefile

@@ -43,7 +43,7 @@ APPNAME = "Tezos Wallet"
 # Application version
 APPVERSION_M=3
 APPVERSION_N=0
-APPVERSION_P=2
+APPVERSION_P=3
 APPVERSION=$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)
 
 # COMMIT
@@ -135,10 +135,6 @@ CFLAGS   += -Wwrite-strings
 ########################################
 # See SDK `include/appflags.h` for the purpose of each permission
 #HAVE_APPLICATION_FLAG_DERIVE_MASTER = 1
-ifneq ($(TARGET_NAME), TARGET_NANOS)
-HAVE_APPLICATION_FLAG_GLOBAL_PIN = 1
-HAVE_APPLICATION_FLAG_BOLOS_SETTINGS = 1
-endif
 HAVE_APPLICATION_FLAG_LIBRARY = 1
 
 ########################################

app/src/apdu.c

@@ -1,7 +1,5 @@
 /* Tezos Ledger application - Some common primitives and some command handlers
 
-   TODO: split this file (apdu primitives and apdu handlers)
-
    Copyright 2023 Nomadic Labs <[email protected]>
    Copyright 2023 Trilitech <[email protected]>
 

app/src/apdu.h

@@ -1,7 +1,5 @@
 /* Tezos Ledger application - Some common primitives and some command handlers
 
-   TODO: split this file (apdu primitives and apdu handlers)
-
    Copyright 2023 Nomadic Labs <[email protected]>
 
    With code excerpts from:
@@ -82,11 +80,25 @@
  *
  */
 
-typedef void(tz_handler)(command_t *);
+typedef void(tz_handler)(command_t *cmd);
 typedef tz_handler *tz_handler_t;
 
-tz_handler handle_unimplemented;
-tz_handler handle_apdu_version;
-tz_handler handle_apdu_git;
+tz_handler handle_unimplemented;  /// handler for unknown commands
+tz_handler handle_apdu_version;   /// handle version enquiry apdu
+tz_handler handle_apdu_git;       /// handle git commit enquiry apdu
+/**
+ * @brief Function to handle apdu request for public key. The public key is
+ * derived only once and stored in the RAM, in order to avoid repeated
+ * derivation calculations. This function can be called with or without
+ * prompt.
+ *
+ */
 tz_handler handle_apdu_get_public_key;
+/**
+ * @brief Parse the received command and prompt user for appropriate action.
+ * Triggers blindsigning and/or expert mode workflows based on transaction
+ * involved. Stream based parser helps decode arbitararily large transaction,
+ * screen by screen.
+ *
+ */
 tz_handler handle_apdu_sign;

app/src/apdu_pubkey.c

@@ -35,8 +35,9 @@
 
 static void provide_pubkey(void);
 static void prompt_address(void);
-static void format_pkh(cx_ecfp_public_key_t *, char *, size_t);
-static void stream_cb(tz_ui_cb_type_t);
+static void format_pkh(cx_ecfp_public_key_t *pubkey, char *buffer,
+                       size_t len);
+static void stream_cb(tz_ui_cb_type_t cb_type);
 
 static void
 provide_pubkey(void)
@@ -171,13 +172,13 @@ handle_apdu_get_public_key(command_t *cmd)
     TZ_PREAMBLE(("cmd=%p", cmd));
 
     TZ_ASSERT(EXC_UNEXPECTED_STATE,
-              global.step == ST_IDLE || global.step == ST_SWAP_SIGN);
+              (global.step == ST_IDLE) || (global.step == ST_SWAP_SIGN));
     TZ_ASSERT(EXC_WRONG_PARAM, cmd->p1 == 0);
 
     // do not expose pks without prompt through U2F (permissionless legacy
     // comm in browser)
     TZ_ASSERT(EXC_HID_REQUIRED,
-              prompt || G_io_apdu_media != IO_APDU_MEDIA_U2F);
+              prompt || (G_io_apdu_media != IO_APDU_MEDIA_U2F));
 
     global.path_with_curve.derivation_type = cmd->p2;
     TZ_ASSERT(EXC_WRONG_PARAM,
@@ -190,10 +191,11 @@ handle_apdu_get_public_key(command_t *cmd)
     TZ_LIB_CHECK(derive_pk(&global.keys.pubkey,
                            global.path_with_curve.derivation_type,
                            &global.path_with_curve.bip32_path));
-    if (prompt)
+    if (prompt) {
         prompt_address();
-    else
+    } else {
         provide_pubkey();
+    }
 
     TZ_POSTAMBLE;
 }