Refactor/core framework

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
     - name: Download artifacts
-      uses: actions/download-artifact@master
+      uses: actions/download-artifact@v3
       with:
         path: ./
     - name: Publish a release

.github/workflows/ci-tests.yml

@@ -118,14 +118,25 @@ jobs:
         path: arm-gcc
         key: arm-gcc
 
+    - name: Restore proto-tools
+      id: cache-proto-tools
+      uses: actions/cache@v3
+      with:
+        path: proto-tools
+        key: proto-tools
+
     - name: Install target dependencies
       if: matrix.platform == 'device'
       env:
         CACHED: ${{ steps.cache-arm-gcc.outputs.cache-hit }}
+        PROTO_CACHED: ${{ steps.cache-proto-tools.outputs.cache-hit }}
       run: |
         if [ ! "${CACHED}" = "true" ]; then
           bash ./utilities/ci/setup-arm-gcc.sh;
         fi
+        if [ ! "${PROTO_CACHED}" = "true" ]; then
+          bash ./utilities/ci/setup-protoc.sh;
+        fi
         pip install -r utilities/script/requirements.txt
 
     - name: Install simulator dependencies
@@ -139,7 +150,8 @@ jobs:
         if [ ! "${CACHED}" = "true" ]; then
           bash ./utilities/ci/setup-build-tools.sh;
         fi
-        PATH="$PATH:$(pwd)/build-tools:$(pwd)/arm-gcc/bin"
+        pip install -r vendor/nanopb/extra/requirements.txt
+        PATH="$PATH:$(pwd)/build-tools:$(pwd)/arm-gcc/bin:$(pwd)/proto-tools/bin"
         ./utilities/build.sh -f ${{ matrix.firmware }} -t ${{ matrix.target }} -p ${{ matrix.platform }}
 
   run-unit-tests:
@@ -176,6 +188,7 @@ jobs:
           bash ./utilities/ci/setup-build-tools.sh;
         fi
         PATH="$PATH:$(pwd)/build-tools"
+        pip install -r vendor/nanopb/extra/requirements.txt
         # Ignore any non-zero exits from simulator run using '|| true'
         bash ./utilities/run_unit_tests.sh -f ${{ matrix.firmware }} -p ${{ matrix.platform }} > test_results.txt || true
         cat test_results.txt

.gitignore

@@ -6,13 +6,13 @@ Debug
 !/.vscode/c_cpp_properties.json
 !/.vscode/launch.json
 !/.vscode/tasks.json
-cmake-build-debug*
-cmake-build-release*
-cmake-build-dev*
+cmake-build-*
 .idea
 *.ioc
 *.bak
 *.launch
 html
 .DS_Store
-private_key*.?
+private_key*.?
+*.pb.*
+generated

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "stm32-hal"]
 	path = stm32-hal
 	url = ../x1_wallet_hal_stm32
+[submodule "cypherock-common"]
+	path = common/cypherock-common
+	url = ../cypherock-common
+[submodule "nanopb"]
+	path = vendor/nanopb
+	url = ../nanopb

.vscode/settings.json

@@ -4,7 +4,8 @@
 
 {
     "cmake.configureSettings": {
-        "CMAKE_BUILD_PLATFORM":"Device"
+        "CMAKE_BUILD_PLATFORM":"Device",
+        "FIRMWARE_TYPE":"Main",
     },
     "files.associations": {
         "*.html": "html",

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.15.3)
+cmake_minimum_required(VERSION 3.19.0)
 set(CMAKE_MESSAGE_LOG_LEVEL debug)
 
 if("${CMAKE_BUILD_PLATFORM}" STREQUAL "Device")
@@ -15,12 +15,27 @@ endif()
 
 project(${PROJECT})
 
+# python is needed for compiling proto files using nanopb
+# also for generating & appending firmware signature headers
+find_package( Python3 REQUIRED COMPONENTS Interpreter )
+execute_process(COMMAND sh utilities/proto/generate-protob.sh WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY )
+
 # Populate version.c
 include(utilities/cmake/version.cmake)
 
+file(GLOB_RECURSE PROTO_SRCS "generated/proto/*.*")
+list(APPEND PROTO_SRCS "vendor/nanopb/pb_common.c" "vendor/nanopb/pb_decode.c" "vendor/nanopb/pb_encode.c" "vendor/nanopb/pb_common.h" "vendor/nanopb/pb_decode.h" "vendor/nanopb/pb_encode.h" "vendor/nanopb/pb.h")
+
 OPTION(DEV_SWITCH "Additional features/logs to aid developers" OFF)
 OPTION(UNIT_TESTS_SWITCH "Compile build for main firmware or unit tests" OFF)
 
+# Make static functions testable via unit-tests
+IF(UNIT_TESTS_SWITCH)
+    add_compile_definitions( STATIC= )
+ELSE()
+    add_compile_definitions( STATIC=static )
+ENDIF(UNIT_TESTS_SWITCH)
+
 if ("${CMAKE_BUILD_TYPE}" STREQUAL "Release")
     add_compile_definitions(FIRMWARE_HASH_CALC=1)
 else()
@@ -31,4 +46,11 @@ if("${CMAKE_BUILD_PLATFORM}" STREQUAL "Device")
     include(utilities/cmake/firmware/firmware.cmake)
 else()
     include(utilities/cmake/simulator/simulator.cmake)
-endif()
+endif()
+
+# Include nanopb source headers
+target_include_directories( ${EXECUTABLE} PRIVATE vendor/nanopb generated/proto )
+
+# Enable support for dynamically allocated fields in nanopb
+# Ref: vendor/nanopb/pb.h
+add_compile_definitions(PB_ENABLE_MALLOC=1 PB_NO_ERRMSG=1)

Dockerfile

@@ -2,13 +2,22 @@
 FROM alpine:3.14 as build-stage
 
 # Add dependencies
-RUN apk add --no-cache gcc-arm-none-eabi newlib-arm-none-eabi ninja cmake bash git python3 py-pip
+RUN apk add --no-cache gcc-arm-none-eabi newlib-arm-none-eabi ninja cmake bash git python3 py-pip protoc
+RUN apk add --no-cache g++
 
 # Copy files and create folders
 COPY . /home
 RUN mkdir -p /home/build/Debug /home/build/Release
 RUN mkdir -p /dist/Debug/plain /dist/Debug/dev /dist/Debug/debug /dist/Release/
-RUN pip3 install -r /home/utilities/script/requirements.txt
+RUN mkdir -p /pcache
+
+ENV PYTHONUNBUFFERED=1
+RUN apk add --update --no-cache python3 && ln -sf python3 /usr/bin/python
+RUN python3 -m ensurepip
+RUN pip3 install --no-cache-dir ecdsa==0.16.1
+RUN pip3 install --no-cache-dir wheel
+RUN pip3 install --no-cache-dir --upgrade pip setuptools
+RUN pip3 install --no-cache-dir protobuf grpcio-tools==1.47.0
 
 # Set working directory
 WORKDIR /home/build/Debug

README.md

@@ -15,7 +15,7 @@ The X1Wallet ships with a firmware to take the user through the device setup flo
 Website link for getting started with new device: [cypherock.com/gs](https://www.cypherock.com/get-started/)
 
 ## Functionality of X1Wallet
-After the device is setup ([steps to setup device](#device-setup-flow)), the X1Wallet is ready to use by the end-users. To use the functionality, the user must have access to the X1Wallet and CyCards; CySync is required for on-chain operations such as send operations and balance viewing.
+After the device is setup ([steps to setup device](#device-setup-flow)), the X1Wallet is ready to use by the end-users. To use the functionality, the user must have access to the X1Wallet and CyCards; cySync is required for on-chain operations such as send operations and balance viewing.
 
 ### List of features:
 #### 1. Create wallet (on CyCards)
@@ -43,18 +43,18 @@ A user or owner of X1Wallet has an option to view the critical information of th
 
 To view the word-list, a user needs to have one CyCard (and knowledge of PIN, if the wallet is PIN protected).
 
-#### 4. Import wallet to CySync (Desktop application)
-Since, the X1Wallet is a cold storage, it cannot directly interact with Blockchain on the internet to view the balances. To facilitate this, the desktop application, enables users to view their account balances and funds on their wallet/accounts. In order to enable the tracking of funds for any particular wallet (for a particular type of crypto), users have to sync their X1Wallet with CySync and then [enable coin support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application) of that particular cryptocurrency. To sync a wallet with CySync, user will trigger the request via CySync and confirm the request on the X1Wallet.
+#### 4. Import wallet to cySync (Desktop application)
+Since, the X1Wallet is a cold storage, it cannot directly interact with Blockchain on the internet to view the balances. To facilitate this, the desktop application, enables users to view their account balances and funds on their wallet/accounts. In order to enable the tracking of funds for any particular wallet (for a particular type of crypto), users have to sync their X1Wallet with cySync and then [enable coin support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application) of that particular cryptocurrency. To sync a wallet with cySync, user will trigger the request via cySync and confirm the request on the X1Wallet.
 
 ***NOTE: This process only sends the public information about the wallet. No private critical information leaves the X1Wallet.***
 
-#### 5. Enable coin support for a wallet on CySync (Desktop application)
-X1Wallet allows tracking a cryptocurrency balances linked to a users wallet. This is possible via CySync interface. To enable a coin tracking support, the user will require to have one CyCard with the wallet. To enable coin tracking support (make sure that the desired wallet is [synced with CySync](#4-import-wallet-to-cysync-desktop-application)), user will trigger the request via CySync and confirm the request on the X1Wallet.
+#### 5. Enable coin support for a wallet on cySync (Desktop application)
+X1Wallet allows tracking a cryptocurrency balances linked to a users wallet. This is possible via cySync interface. To enable a coin tracking support, the user will require to have one CyCard with the wallet. To enable coin tracking support (make sure that the desired wallet is [synced with cySync](#4-import-wallet-to-cysync-desktop-application)), user will trigger the request via cySync and confirm the request on the X1Wallet.
 
 ***NOTE: This process only sends the public information about the accounts for the selected crypto. No private critical information leaves the X1Wallet.***
 
 #### 6. Receive funds into wallet address present on CyCards
-To receive funds into their X1Wallet, first the user must have at least one active wallet on their X1Wallet device ([create a wallet](#1-create-wallet-on-cycards) if you do not have one). If you already have a wallet, then make sure to have access to one CyCard for receiving funds. Now make sure the [wallet is synced with CySync](#4-import-wallet-to-cysync-desktop-application) and [coin tracking support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application) is enabled for the preferred coin.
+To receive funds into their X1Wallet, first the user must have at least one active wallet on their X1Wallet device ([create a wallet](#1-create-wallet-on-cycards) if you do not have one). If you already have a wallet, then make sure to have access to one CyCard for receiving funds. Now make sure the [wallet is synced with cySync](#4-import-wallet-to-cysync-desktop-application) and [coin tracking support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application) is enabled for the preferred coin.
 
 Trigger the request to generate a receiving public address for your wallet. ***It is recommended to verify the address on the X1Wallet and never skip this step for security reasons.***
 
@@ -64,9 +64,9 @@ To enable transfer of funds from user's wallet to a different wallet, following
    - Access to one CyCard
    - Wallets with sufficient funds ([create a wallet](#1-create-wallet-on-cycards) if you do not have one and [receive funds](#6-receive-funds-into-wallet-address-present-on-cycards) before proceeding)
    - Knowledge of PIN in case of PIN protected wallets
-   - Wallet synced with CySync ([sync wallet with CySync](#4-import-wallet-to-cysync-desktop-application)) and coin tracking support enabled on CySync ([enabled coin tracking support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application))
+   - Wallet synced with cySync ([sync wallet with cySync](#4-import-wallet-to-cysync-desktop-application)) and coin tracking support enabled on cySync ([enabled coin tracking support](#5-enable-coin-support-for-a-wallet-on-cysync-desktop-application))
 
-The operation can be started from CySync and confirm the request on X1Wallet to continue. The user is expected to verify the transaction details such as receiver's address and amount being transferred along with a required fee used by the network for processing the transaction. If any descrepancy is observed by the user, the transaction should not be signed and cancelled immediately.
+The operation can be started from cySync and confirm the request on X1Wallet to continue. The user is expected to verify the transaction details such as receiver's address and amount being transferred along with a required fee used by the network for processing the transaction. If any descrepancy is observed by the user, the transaction should not be signed and cancelled immediately.
 
 ***NOTE: The transaction signing starts once the user has tapped the CyCard. It is recommended to not tap the CyCard if any descrepancy is observed by the user.***
 

apps/btc_family/btc/btc_app.c

@@ -0,0 +1,154 @@
+/**
+ * @file    btc_app.c
+ * @author  Cypherock X1 Team
+ * @brief   Bitcoin app configuration
+ * @copyright Copyright (c) 2023 HODL TECH PTE LTD
+ * <br/> You may obtain a copy of license at <a href="https://mitcc.org/"
+ *target=_blank>https://mitcc.org/</a>
+ *
+ ******************************************************************************
+ * @attention
+ *
+ * (c) Copyright 2023 by HODL TECH PTE LTD
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject
+ * to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ *
+ * "Commons Clause" License Condition v1.0
+ *
+ * The Software is provided to you by the Licensor under the License,
+ * as defined below, subject to the following condition.
+ *
+ * Without limiting other conditions in the License, the grant of
+ * rights under the License will not include, and the License does not
+ * grant to you, the right to Sell the Software.
+ *
+ * For purposes of the foregoing, "Sell" means practicing any or all
+ * of the rights granted to you under the License to provide to third
+ * parties, for a fee or other consideration (including without
+ * limitation fees for hosting or consulting/ support services related
+ * to the Software), a product or service whose value derives, entirely
+ * or substantially, from the functionality of the Software. Any license
+ * notice or attribution required by the License must also include
+ * this Commons Clause License Condition notice.
+ *
+ * Software: All X1Wallet associated files.
+ * License: MIT
+ * Licensor: HODL TECH PTE LTD
+ *
+ ******************************************************************************
+ */
+
+/*****************************************************************************
+ * INCLUDES
+ *****************************************************************************/
+
+#include "btc_app.h"
+
+#include "btc_helpers.h"
+#include "btc_main.h"
+
+/*****************************************************************************
+ * EXTERN VARIABLES
+ *****************************************************************************/
+
+/*****************************************************************************
+ * PRIVATE MACROS AND DEFINES
+ *****************************************************************************/
+
+/*****************************************************************************
+ * PRIVATE TYPEDEFS
+ *****************************************************************************/
+
+/*****************************************************************************
+ * STATIC FUNCTION PROTOTYPES
+ *****************************************************************************/
+
+/**
+ * @brief Check if the purpose index is supported by the Bitcoin app.
+ *
+ * @param purpose_index The purpose index to be checked
+ *
+ * @return bool Indicates if the provided purpose index is supported
+ * @retval true The provided purpose index is supported
+ * @retval false The provided purpose index is not supported
+ */
+static bool is_purpose_supported(uint32_t purpose_index);
+
+/*****************************************************************************
+ * STATIC VARIABLES
+ *****************************************************************************/
+
+// Secondary reference for aggregated coin info:
+// https://github.com/trezor/trezor-firmware/blob/f5983e7843f381423f30b8bc2ffc46e496775e5a/common/defs/bitcoin/bitcoin.json
+const btc_config_t btc_app = {
+    // coin specific data
+    .coin_type = COIN_BTC,
+    .p2pkh_addr_ver = 0x00,
+    .p2sh_addr_ver = 0x05,
+    .legacy_xpub_ver = 0x0488b21e,
+    .segwit_xpub_ver = 0x049d7cb2,
+    .nsegwit_xpub_ver = 0x04b24746,
+    .bech32_hrp = "bc",
+    .lunit_name = "BTC",
+    .name = "Bitcoin",
+
+    // Refer public issues:
+    // https://github.com/trezor/trezor-firmware/issues/1087
+    // https://github.com/trezor/trezor-firmware/issues/1192
+    .max_fee = 2000000,
+
+    // action handlers
+    .is_purpose_supported = is_purpose_supported,
+};
+
+static const cy_app_desc_t btc_app_desc = {.id = 2,
+                                           .version =
+                                               {
+                                                   .major = 1,
+                                                   .minor = 0,
+                                                   .patch = 0,
+                                               },
+                                           .app = btc_main,
+                                           .app_config = &btc_app};
+
+/*****************************************************************************
+ * GLOBAL VARIABLES
+ *****************************************************************************/
+
+/*****************************************************************************
+ * STATIC FUNCTIONS
+ *****************************************************************************/
+
+static bool is_purpose_supported(uint32_t purpose_index) {
+  if (PURPOSE_LEGACY != purpose_index && PURPOSE_SEGWIT != purpose_index &&
+      PURPOSE_NSEGWIT != purpose_index && PURPOSE_TAPROOT != purpose_index) {
+    return false;
+  }
+  return true;
+}
+
+/*****************************************************************************
+ * GLOBAL FUNCTIONS
+ *****************************************************************************/
+
+const cy_app_desc_t *get_btc_app_desc() {
+  return &btc_app_desc;
+}