[update] Branch develop | Commit c65b20872034ac6208a6e1ed742a8d6c12d8eb4b

Author: ldg-github-ci

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Ethereum Plugin SDK changelog
+
+|          Icon        |            Impact             |
+|----------------------|-------------------------------|
+| :rotating_light:     | Breaks build                  |
+| :warning:            | Breaks compatibility with app |
+
+## [latest](/) - 2023/10/19
+
+### Changed
+
+* Now only uses *\_no\_throw* functions, SDK functions now return a boolean
+(keeps the guidelines enforcer happy)
+
+### Added
+
+* *main* & *dispatch\_call* functions are now part of the SDK and don't need to
+be implemented by each plugin :rotating_light:
+
+## [b9777e7](/../../commit/b9777e7) - 2023/05/16
+
+### Added
+
+* Stax support with information passed from plugin to app-ethereum (with caller app struct)
+
+## [a4b971f](/../../commit/a4b971f) - 2023/01/24
+
+### Changed
+
+* Removed end space in tickers :warning:
+
+## [81eb658](/../../commit/81eb658) - 2022/11/17
+
+### Added
+
+* *U2BE\_from\_parameter* & *U4BE\_from\_parameter* safe functions

README.md

@@ -13,7 +13,6 @@ Be careful, and weight your choices.
 
 If for some reasons you want to rebuild this SDK manually from [app-ethereum](https://github.com/LedgerHQ/app-ethereum) (reminder: it is rebuild automatically when building app-ethereum itself):
 
-```
-cd app-ethereum
-python3 ethereum-plugin-sdk/build_sdk.py
+```shell
+$> python3 tools/build_sdk.py
 ```

include/eth_internals.c

@@ -2,7 +2,7 @@
 
 #include "eth_internals.h"
 
-void getEthAddressStringFromBinary(uint8_t *address,
+bool getEthAddressStringFromBinary(uint8_t *address,
                                    char *out,
                                    cx_sha3_t *sha3Context,
                                    uint64_t chainId) {
@@ -22,7 +22,9 @@ void getEthAddressStringFromBinary(uint8_t *address,
             break;
     }
     if (eip1191) {
-        u64_to_string(chainId, (char *) locals_union.tmp, sizeof(locals_union.tmp));
+        if (!u64_to_string(chainId, (char *) locals_union.tmp, sizeof(locals_union.tmp))) {
+            return false;
+        }
         offset = strnlen((char *) locals_union.tmp, sizeof(locals_union.tmp));
         strlcat((char *) locals_union.tmp + offset, "0x", sizeof(locals_union.tmp) - offset);
         offset = strnlen((char *) locals_union.tmp, sizeof(locals_union.tmp));
@@ -32,13 +34,18 @@ void getEthAddressStringFromBinary(uint8_t *address,
         locals_union.tmp[offset + 2 * i] = HEXDIGITS[(digit >> 4) & 0x0f];
         locals_union.tmp[offset + 2 * i + 1] = HEXDIGITS[digit & 0x0f];
     }
-    cx_keccak_init(sha3Context, 256);
-    cx_hash((cx_hash_t *) sha3Context,
-            CX_LAST,
-            locals_union.tmp,
-            offset + 40,
-            locals_union.hashChecksum,
-            32);
+    if (cx_keccak_init_no_throw(sha3Context, 256) != CX_OK) {
+        return false;
+    }
+
+    if (cx_hash_no_throw((cx_hash_t *) sha3Context,
+                         CX_LAST,
+                         locals_union.tmp,
+                         offset + 40,
+                         locals_union.hashChecksum,
+                         32) != CX_OK) {
+        return false;
+    }
     for (i = 0; i < 40; i++) {
         uint8_t digit = address[i / 2];
         if ((i % 2) == 0) {
@@ -58,27 +65,47 @@ void getEthAddressStringFromBinary(uint8_t *address,
         }
     }
     out[40] = '\0';
+
+    return true;
 }
 
-void getEthAddressFromKey(cx_ecfp_public_key_t *publicKey, uint8_t *out, cx_sha3_t *sha3Context) {
+bool getEthAddressFromKey(cx_ecfp_public_key_t *publicKey, uint8_t *out, cx_sha3_t *sha3Context) {
     uint8_t hashAddress[INT256_LENGTH];
-    cx_keccak_init(sha3Context, 256);
-    cx_hash((cx_hash_t *) sha3Context, CX_LAST, publicKey->W + 1, 64, hashAddress, 32);
+
+    if (cx_keccak_init_no_throw(sha3Context, 256) != CX_OK) {
+        return false;
+    }
+
+    if (cx_hash_no_throw((cx_hash_t *) sha3Context,
+                         CX_LAST,
+                         publicKey->W + 1,
+                         64,
+                         hashAddress,
+                         32) != CX_OK) {
+        return false;
+    }
+
     memmove(out, hashAddress + 12, 20);
+    return true;
 }
 
-void getEthDisplayableAddress(uint8_t *in,
+bool getEthDisplayableAddress(uint8_t *in,
                               char *out,
                               size_t out_len,
                               cx_sha3_t *sha3,
                               uint64_t chainId) {
     if (out_len < 43) {
         strlcpy(out, "ERROR", out_len);
-        return;
+        return false;
     }
     out[0] = '0';
     out[1] = 'x';
-    getEthAddressStringFromBinary(in, out + 2, sha3, chainId);
+    if (!getEthAddressStringFromBinary(in, out + 2, sha3, chainId)) {
+        strlcpy(out, "ERROR", out_len);
+        return false;
+    }
+
+    return true;
 }
 
 bool adjustDecimals(const char *src,
@@ -191,7 +218,7 @@ bool uint256_to_decimal(const uint8_t *value, size_t value_len, char *out, size_
     return true;
 }
 
-void amountToString(const uint8_t *amount,
+bool amountToString(const uint8_t *amount,
                     uint8_t amount_size,
                     uint8_t decimals,
                     const char *ticker,
@@ -200,7 +227,7 @@ void amountToString(const uint8_t *amount,
     char tmp_buffer[100] = {0};
 
     if (uint256_to_decimal(amount, amount_size, tmp_buffer, sizeof(tmp_buffer)) == false) {
-        THROW(EXCEPTION_OVERFLOW);
+        return false;
     }
 
     uint8_t amount_len = strnlen(tmp_buffer, sizeof(tmp_buffer));
@@ -216,19 +243,20 @@ void amountToString(const uint8_t *amount,
                        out_buffer + ticker_len,
                        out_buffer_size - ticker_len - 1,
                        decimals) == false) {
-        THROW(EXCEPTION_OVERFLOW);
+        return false;
     }
 
     out_buffer[out_buffer_size - 1] = '\0';
+    return true;
 }
 
-void u64_to_string(uint64_t src, char *dst, uint8_t dst_size) {
+bool u64_to_string(uint64_t src, char *dst, uint8_t dst_size) {
     // Copy the numbers in ASCII format.
     uint8_t i = 0;
     do {
         // Checking `i + 1` to make sure we have enough space for '\0'.
         if (i + 1 >= dst_size) {
-            THROW(0x6502);
+            return false;
         }
         dst[i] = src % 10 + '0';
         src /= 10;
@@ -248,6 +276,7 @@ void u64_to_string(uint64_t src, char *dst, uint8_t dst_size) {
         i--;
         j++;
     }
+    return true;
 }
 
 void copy_address(uint8_t* dst, const uint8_t* parameter, uint8_t dst_size) {

include/eth_internals.h

@@ -8,6 +8,7 @@
 #include "cx.h"
 #ifdef HAVE_NBGL
 #include "nbgl_types.h"
+#include "glyphs.h"
 #endif
 
 #define MAX_TICKER_LEN 11  // 10 characters + '\0'
@@ -83,14 +84,14 @@ static __attribute__((no_instrument_function)) inline int allzeroes(const void *
 
 static const char HEXDIGITS[] = "0123456789abcdef";
 
-void getEthAddressStringFromBinary(uint8_t *address,
+bool getEthAddressStringFromBinary(uint8_t *address,
                                    char *out,
                                    cx_sha3_t *sha3Context,
                                    uint64_t chainId);
 
-void getEthAddressFromKey(cx_ecfp_public_key_t *publicKey, uint8_t *out, cx_sha3_t *sha3Context);
+bool getEthAddressFromKey(cx_ecfp_public_key_t *publicKey, uint8_t *out, cx_sha3_t *sha3Context);
 
-void getEthDisplayableAddress(uint8_t *in,
+bool getEthDisplayableAddress(uint8_t *in,
                               char *out,
                               size_t out_len,
                               cx_sha3_t *sha3,
@@ -104,14 +105,14 @@ bool adjustDecimals(const char *src,
 
 bool uint256_to_decimal(const uint8_t* value, size_t value_len, char* out, size_t out_len);
 
-void amountToString(const uint8_t* amount,
+bool amountToString(const uint8_t* amount,
                     uint8_t amount_len,
                     uint8_t decimals,
                     const char* ticker,
                     char* out_buffer,
                     size_t out_buffer_size);
 
-void u64_to_string(uint64_t src, char *dst, uint8_t dst_size);
+bool u64_to_string(uint64_t src, char *dst, uint8_t dst_size);
 
 void copy_address(uint8_t* dst, const uint8_t* parameter, uint8_t dst_size);
 

include/main.c

@@ -0,0 +1,125 @@
+/*****************************************************************************
+ *   Ledger Plugin SDK
+ *   (c) 2023 Ledger SAS
+ *
+ *  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 "eth_internals.h"
+#include "eth_plugin_interface.h"
+
+// Functions implemented by the plugin
+void handle_init_contract(ethPluginInitContract_t *parameters);
+void handle_provide_parameter(ethPluginProvideParameter_t *parameters);
+void handle_finalize(ethPluginFinalize_t *parameters);
+void handle_provide_token(ethPluginProvideInfo_t *parameters);
+void handle_query_contract_id(ethQueryContractID_t *parameters);
+void handle_query_contract_ui(ethQueryContractUI_t *parameters);
+
+// Calls the ethereum app.
+static void call_app_ethereum() {
+    unsigned int libcall_params[5];
+    libcall_params[0] = (unsigned int) "Ethereum";
+    libcall_params[1] = 0x100;
+    libcall_params[2] = RUN_APPLICATION;
+    libcall_params[3] = (unsigned int) NULL;
+#ifdef HAVE_NBGL
+    caller_app_t capp;
+    const char name[] = APPNAME;
+    nbgl_icon_details_t icon_details;
+    uint8_t bitmap[sizeof(ICONBITMAP)];
+
+    memcpy(&icon_details, &ICONGLYPH, sizeof(ICONGLYPH));
+    memcpy(&bitmap, &ICONBITMAP, sizeof(bitmap));
+    icon_details.bitmap = (const uint8_t *) bitmap;
+    capp.name = (const char *) name;
+    capp.icon = &icon_details;
+    libcall_params[4] = (unsigned int) &capp;
+#else
+    libcall_params[4] = (unsigned int) NULL;
+#endif
+    os_lib_call((unsigned int *) &libcall_params);
+}
+
+// Function to dispatch calls from the ethereum app.
+static void dispatch_call(int message, void *parameters) {
+    switch (message) {
+        case ETH_PLUGIN_INIT_CONTRACT:
+            handle_init_contract(parameters);
+            break;
+        case ETH_PLUGIN_PROVIDE_PARAMETER:
+            handle_provide_parameter(parameters);
+            break;
+        case ETH_PLUGIN_FINALIZE:
+            handle_finalize(parameters);
+            break;
+        case ETH_PLUGIN_PROVIDE_INFO:
+            handle_provide_token(parameters);
+            break;
+        case ETH_PLUGIN_QUERY_CONTRACT_ID:
+            handle_query_contract_id(parameters);
+            break;
+        case ETH_PLUGIN_QUERY_CONTRACT_UI:
+            handle_query_contract_ui(parameters);
+            break;
+        default:
+            PRINTF("Unhandled message %d\n", message);
+            break;
+    }
+}
+
+// Low-level main for plugins.
+__attribute__((section(".boot"))) int main(int arg0) {
+    // Exit critical section
+    __asm volatile("cpsie i");
+
+    os_boot();
+
+    BEGIN_TRY {
+        TRY {
+            // Check if plugin is called from the dashboard.
+            if (!arg0) {
+                // Called from dashboard, launch Ethereum app
+                call_app_ethereum();
+
+                // Will not get reached.
+                __builtin_unreachable();
+
+                os_sched_exit(-1);
+
+            } else {
+                // Not called from dashboard: called from the ethereum app!
+                const unsigned int *args = (unsigned int *) arg0;
+
+                // If `ETH_PLUGIN_CHECK_PRESENCE` is set, this means the caller is just trying to
+                // know whether this app exists or not. We can skip `paraswap_plugin_call`.
+                if (args[0] != ETH_PLUGIN_CHECK_PRESENCE) {
+                    dispatch_call(args[0], (void *) args[1]);
+                }
+            }
+
+            // Call `os_lib_end`, go back to the ethereum app.
+            os_lib_end();
+
+            // Will not get reached.
+            __builtin_unreachable();
+        }
+        CATCH_OTHER(e) {
+            PRINTF("Exiting following exception: %d\n", e);
+        }
+        FINALLY {
+            os_lib_end();
+        }
+    }
+    END_TRY;
+}

include/utils.c

@@ -0,0 +1,28 @@
+/*****************************************************************************
+ *   Ledger Plugin SDK
+ *   (c) 2023 Ledger SAS
+ *
+ *  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 "utils.h"
+
+bool find_selector(uint32_t selector, const uint32_t *array, size_t size, size_t *idx) {
+    for (size_t i = 0; i < size; ++i) {
+        if (selector == array[i]) {
+            if (idx != NULL) *idx = i;
+            return true;
+        }
+    }
+    return false;
+}