chore: Update gh actions workflows

Author: pro-utkarshM

.github/workflows/auto-tag-versions.yml

@@ -22,3 +22,4 @@ jobs:
         VERSION=$(cat version.txt | grep firmware | cut -f 2-2 -d '=' | awk -F ':' '{ print 0+$1 "." 0+$2 "." $3*2**8 + $4 }')
         echo $VERSION
         curl   -X POST   -H "Accept: application/vnd.github+json"   -H "Authorization: Bearer ${AUTH_TOKEN}"  -H "X-GitHub-Api-Version: 2022-11-28"   https://api.github.com/repos/${REPOSITORY}/git/refs   -d '{"ref":"refs/tags/v'${VERSION}'","sha":"'${COMMIT}'"}'
+        echo "Tag v${VERSION} created successfully."

.github/workflows/build.yml

@@ -15,10 +15,12 @@ jobs:
       matrix:
         firmware: [Main]
         target: [Release]
+        coin_support: ["BTC_ONLY", "MULTI_COIN"]
     uses: ./.github/workflows/containerized-build.yml
     with:
       firmware: ${{ matrix.firmware }}
       target: ${{ matrix.target }}
+      coin_support_variant: ${{ matrix.coin_support }}
     secrets: inherit
   create-release:
     needs: build-firmwares
@@ -49,4 +51,4 @@ jobs:
         run: |
           content_type=$(file -b --mime-type Main-Release-outputs/Cypherock-Main.bin)
           curl   -X POST   -H "Content-Type: ${content_type}"   -H "Accept: application/vnd.github+json"   -H "Authorization: Bearer ${auth_token}"  -H "X-GitHub-Api-Version: 2022-11-28"   ${upload_url}?name=Cypherock-Main.bin  --data-binary @Main-Release-outputs/Cypherock-Main.bin
-          curl   -X POST   -H "Content-Type: ${content_type}"   -H "Accept: application/vnd.github+json"   -H "Authorization: Bearer ${auth_token}"  -H "X-GitHub-Api-Version: 2022-11-28"   ${upload_url}?name=version.txt  --data-binary @version.txt
+          curl   -X POST   -H "Content-Type: ${content_type}"   -H "Accept: application/vnd.github+json"   -H "Authorization: Bearer ${auth_token}"  -H "X-GitHub-Api-Version: 2022-11-28"   ${upload_url}?name=version.txt  --data-binary @version.txt

.github/workflows/ci-tests.yml

@@ -198,3 +198,4 @@ jobs:
           cat test_results.txt
           # Unity prints "OK" if all tests pass, "FAIL" if tests fail; return 1 to indicate failure
           if [ ! "$(tail -n 1 test_results.txt)" = "OK" ]; then exit 1; fi
+          

.github/workflows/containerized-build.yml

@@ -9,30 +9,81 @@ on:
       target:
         required: true
         type: string
+      coin_support_variant:
+        required: true
+        type: string
+  workflow_dispatch:
+    inputs:
+      firmware:
+        required: true
+        type: string
+        default: 'Main'
+      target:
+        required: true
+        type: string
+        default: 'Release'
+      coin_support_variant:
+        required: true
+        type: string
+        default: 'MULTI_COIN'
 
 jobs:
   build:
     runs-on: ubuntu-latest
     container:
       image: cypherock/x1-firmware-builder:v0.0.0
+
     steps:
-    - name: Build Firmware (${{ inputs.firmware }} - ${{ inputs.target }})
+    - name: Set VERSION_TAG
+      id: set_version_tag
       run: |
         if [[ "${{ github.ref_type }}" == "tag" ]]; then
-          export VERSION_TAG=$(echo "${{ github.ref }}" | cut -f 3- -d '/')
+          echo "VERSION_TAG=$(echo "${{ github.ref }}" | cut -f 3- -d '/')" >> $GITHUB_OUTPUT
         elif [[ "${{ github.ref_type }}" == "branch" ]]; then
-          export VERSION_TAG=$(echo "${{ github.ref }}" | cut -f 3- -d '/')
+          echo "VERSION_TAG=$(echo "${{ github.ref }}" | cut -f 3- -d '/')" >> $GITHUB_OUTPUT
         else
-          # reftype is repository; use default branch
-          export VERSION_TAG=main
+          echo "VERSION_TAG=main" >> $GITHUB_OUTPUT
         fi
-        git clone --branch ${VERSION_TAG} --depth 1 https://github.com/${{ github.repository }}.git --recurse-submodules
-        mkdir build && cd x1_wallet_firmware && mkdir build && cd build
-        cmake -DCMAKE_BUILD_TYPE="${{ inputs.target }}" -DFIRMWARE_TYPE="${{ inputs.firmware }}" -DCMAKE_BUILD_PLATFORM="Device" -G "Ninja" ..
-        ninja && cd ../..
-        cp x1_wallet_firmware/build/Cypherock-*.* ./build/
-    - name: Archive Build Artifacts
+
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ steps.set_version_tag.outputs.VERSION_TAG }}
+        submodules: recursive
+
+    - name: Build Firmware (${{ inputs.firmware }} - ${{ inputs.target }} - ${{ inputs.coin_support_variant }})
+      run: |
+        cd x1_wallet_firmware
+
+        BTC_ONLY_FLAG="OFF"
+        if [[ "${{ inputs.coin_support_variant }}" == "BTC_ONLY" ]]; then
+          BTC_ONLY_FLAG="ON"
+        fi
+
+        BUILD_DIR="build_${{ inputs.coin_support_variant }}"
+        mkdir -p "${BUILD_DIR}"
+
+        cmake -B "${BUILD_DIR}" \
+              -DDEV_SWITCH=OFF \
+              -DUNIT_TESTS_SWITCH:BOOL=OFF \
+              -DBTC_ONLY:BOOL="${BTC_ONLY_FLAG}" \
+              -DSIGN_BINARY=OFF \
+              -DCMAKE_BUILD_TYPE:STRING="${{ inputs.target }}" \
+              -DFIRMWARE_TYPE="${{ inputs.firmware }}" \
+              -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=OFF \
+              -DCMAKE_BUILD_PLATFORM:STRING="Device" \
+              -G "Ninja" .
+
+        ninja -C "${BUILD_DIR}"
+        
+        cd .. 
+
+        mkdir -p build
+
+        cp x1_wallet_firmware/"${BUILD_DIR}"/Cypherock-*.* ./build/
+
+    - name: Archive Build Artifacts (${{ inputs.coin_support_variant }})
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ inputs.firmware }}-${{ inputs.target }}-outputs
-        path: build
+        name: ${{ inputs.firmware }}-${{ inputs.target }}-${{ inputs.coin_support_variant }}-outputs
+        path: build

.github/workflows/publish-docs.yml

@@ -26,4 +26,4 @@ jobs:
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-      run: aws s3 cp ./doxygen/html s3://docs-x1.cypherock.com --recursive
+      run: aws s3 cp ./doxygen/html s3://docs-x1.cypherock.com --recursive

.github/workflows/version-check.yml

@@ -24,4 +24,4 @@ jobs:
         version0=$(git show ${SHA_BASE}:version.txt | grep firmware | cut -f 2-2 -d '=' | awk -F ':' '{ print $1*2**24 + $2*2**16 + $3*2**8 + $4 }')
         version1=$(git show ${SHA_HEAD}:version.txt | grep firmware | cut -f 2-2 -d '=' | awk -F ':' '{ print $1*2**24 + $2*2**16 + $3*2**8 + $4 }')
         echo $version0:$version1
-        if [[ $version0 > $version1 ]]; then echo -e "Version downgrade detected\nfrom $version0 to $version1\n"; exit 1; fi
+        if [[ $version0 > $version1 ]]; then echo -e "Version downgrade detected\nfrom $version0 to $version1\n"; exit 1; fi

utilities/build.sh

@@ -1,49 +1,58 @@
 #!/usr/bin/env bash
 
+# Function to display usage information
 usage() {
-	echo -e "USAGE: $0 [-c] [-u] [-f <main|initial>] [-p <device|simulator>] [-t <dev|debug|release|unit_tests>]"
+	echo -e "USAGE: $0 [-c] [-u] [-b] [-f <main|initial>] [-p <device|simulator>] [-t <dev|debug|release|unit_tests>]"
 	echo -e "Parameters are optional and assumes 'main debug device' if not provided"
 	echo -e "\n\n -c \t Performs a forced clean before invoking build"
 	echo -e "\n\n -u \t Generate unsigned binary"
+    echo -e "\n\n -b \t Build BTC-only firmware"
 	echo -e "\n\n -f \t Sets the preferred firmware to build. Can be main or initial"
 	echo -e "\n\n -p \t Provides the preferred platform to build for. Can be simulator or device"
 	echo -e "\n\n -t \t Tells the build type that should be generate. Can be a valid build type."
 	echo -e "\t    \t For example release, debug, dev, unit_tests"
 	exit 1
 }
 
+# Function to validate the firmware name
 validate_name() {
 	if ! [[ "$ACTIVE_TYPE" =~ ^(Main|Initial)$ ]]; then
 		echo -e "Incorrect firmware ($ACTIVE_TYPE) selected for build\n"
 		usage
 	fi
 }
 
+# Function to validate the build platform
 validate_platform() {
 	if ! [[ "$BUILD_PLATFORM" =~ ^(Device|Simulator)$ ]]; then
 		echo -e "Incorrect platform ($BUILD_PLATFORM) selected for build\n"
 		usage
 	fi
 }
 
+# Function to validate the build type
 validate_type() {
 	if ! [[ "$BUILD_TYPE" =~ ^(Debug|Release|Dev|Unit_tests)$ ]]; then
 		echo -e "Incorrect type ($BUILD_TYPE) selected for build\n"
 		usage
 	fi
 }
 
+# --- Script Defaults ---
 ACTIVE_ROOT_DIR=$(pwd)
 ACTIVE_TYPE=Main
 BUILD_TYPE=Debug
 BUILD_PLATFORM=Device
 UNIT_TESTS=OFF
 DEV=OFF
 SIGN_BINARY=ON
+BTC_ONLY=OFF # Default to multi-coin build
 
-while getopts 'cf:p:t:u' flag; do
+# --- Parse Command Line Arguments ---
+while getopts 'cbuf:p:t:' flag; do
 	case "${flag}" in
 	c) clean_flag="true" ;;
+    b) BTC_ONLY=ON ;;
 	f) ACTIVE_TYPE=$(echo "${OPTARG}" | awk '{print toupper(substr($0, 1, 1)) tolower(substr($0, 2))}') ;;
 	p) BUILD_PLATFORM=$(echo "${OPTARG}" | awk '{print toupper(substr($0, 1, 1)) tolower(substr($0, 2))}') ;;
 	t) BUILD_TYPE=$(echo "${OPTARG}" | awk '{print toupper(substr($0, 1, 1)) tolower(substr($0, 2))}') ;;
@@ -52,6 +61,7 @@ while getopts 'cf:p:t:u' flag; do
 	esac
 done
 
+# --- Validate Inputs ---
 shift "$((OPTIND - 1))"
 validate_name
 validate_platform
@@ -61,6 +71,7 @@ if [ $# -gt 0 ]; then
 	usage
 fi
 
+# --- Set Build-specific Variables ---
 case $BUILD_TYPE in
 Dev)
 	DEV=ON
@@ -74,17 +85,26 @@ Unit_tests)
 	;;
 esac
 
+# --- Prepare Build Directory ---
+BUILD_DIR_SUFFIX=""
+if [ "${BTC_ONLY}" = "ON" ]; then
+    BUILD_DIR_SUFFIX="_BTC"
+fi
+
+BUILD_DIR="build/${ACTIVE_TYPE}${BUILD_DIR_SUFFIX}"
+
 cd "${ACTIVE_ROOT_DIR}" || exit
-mkdir -p "build/${ACTIVE_TYPE}"
-cd "build/${ACTIVE_TYPE}" || exit
+mkdir -p "${BUILD_DIR}"
+cd "${BUILD_DIR}" || exit
 
-# remove previous cmake configuration to ensure we are building with
+# Remove previous cmake configuration to ensure we are building with
 # currently requested build configuration; it is important to delete
 # the existing cmake configuration
 if [ -f "CMakeCache.txt" ]; then
 	rm "CMakeCache.txt"
 fi
 
+# --- Find Build Tools ---
 # Detect if any one (cmake or mingw32-cmake) exists
 CMAKE=$(which cmake)
 if [ "${CMAKE}" = "" ]; then
@@ -115,12 +135,15 @@ if [ "${BUILD_TOOL}" = "" ]; then
 	exit 1
 fi
 
+# --- Run Build ---
 if [[ "${clean_flag}" = "true" ]]; then
 	rm -rf "${ACTIVE_ROOT_DIR}/generated/proto"
 fi
 
+# Configure the project with CMake
 "${CMAKE}" -DDEV_SWITCH=${DEV} \
 	-DUNIT_TESTS_SWITCH:BOOL="${UNIT_TESTS}" \
+    -DBTC_ONLY:BOOL="${BTC_ONLY}" \
 	-DSIGN_BINARY:BOOL="${SIGN_BINARY}" \
 	-DCMAKE_BUILD_TYPE:STRING="${BUILD_TYPE}" \
 	-DFIRMWARE_TYPE="${ACTIVE_TYPE}" \
@@ -131,6 +154,7 @@ fi
 # exit if configuration failed with errors
 if [ ! $? -eq 0 ]; then exit 1; fi
 
+# Clean and build the project
 if [[ "${clean_flag}" = "true" ]]; then
 	"${BUILD_TOOL}" clean
 fi