feat(android): Add Android builds to CI

.github/workflows/zxc-build-library.yaml

@@ -75,6 +75,12 @@ jobs:
       - name: Ensure Binary Cache Path Exists
         run: mkdir -p "${{ github.workspace }}/b/vcpkg_cache"
 
+      - name: CMake Android Build
+        if: github.event.pull_request.merged == true
+        run : |
+          docker build -t ubuntu-jammy-hedera-sdk-cpp-android-build . --build-arg BRANCH_NAME=${{ github.base_ref }}
+          docker cp $(docker create ubuntu-jammy-hedera-sdk-cpp-android-build:latest):/hedera-sdk-cpp/package .
+
       - name: Install CMake & Ninja
         uses: lukka/get-cmake@v3.27.7
 

CMakeLists.txt

@@ -4,7 +4,7 @@ project(hedera-sdk-cpp VERSION 0.1.0 DESCRIPTION "Hedera SDK C++" LANGUAGES CXX)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-set(CMAKE_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}/${CMAKE_BUILD_TYPE}/${CMAKE_HOST_SYSTEM_NAME}/${CMAKE_HOST_SYSTEM_PROCESSOR})
+set(CMAKE_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}/${CMAKE_BUILD_TYPE}/${CMAKE_SYSTEM_NAME}/${CMAKE_SYSTEM_PROCESSOR})
 
 set(Protobuf_USE_STATIC_LIBS ON)
 
@@ -20,7 +20,7 @@ find_package(upb CONFIG REQUIRED)
 find_package(Threads REQUIRED)
 find_package(nlohmann_json CONFIG REQUIRED)
 find_package(CURL CONFIG REQUIRED)
-find_package(EXPAT CONFIG REQUIRED)
+find_package(spdlog CONFIG REQUIRED)
 
 include(FetchContent)
 include(SystemLibraries.cmake)

CMakePresets.json

@@ -36,6 +36,45 @@
         }
       }
     },
+    {
+      "name": "vcpkg-android-base",
+      "hidden": true,
+      "displayName": "Android VCPkg Base Build",
+      "description": "Configured via the Android NDK toolchain",
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "installDir": "${sourceDir}/package",
+      "generator": "Ninja Multi-Config",
+      "cacheVariables": {
+        "ANDROID_ABI": {
+          "type": "STRING",
+          "value": "arm64-v8a"
+        },
+        "ANDROID_PLATFORM": {
+          "type": "STRING",
+          "value": "21"
+        },
+        "CMAKE_SYSTEM_NAME": {
+          "type": "STRING",
+          "value": "Android"
+        },
+        "CMAKE_SYSTEM_PROCESSOR": {
+          "type": "STRING",
+          "value": "aarch64"
+        },
+        "CMAKE_SYSTEM_VERSION": {
+          "type": "STRING",
+          "value": "34"
+        },
+        "CMAKE_TOOLCHAIN_FILE": {
+          "type": "FILEPATH",
+          "value": "${sourceDir}/vcpkg/scripts/buildsystems/vcpkg.cmake"
+        },
+        "VCPKG_CHAINLOAD_TOOLCHAIN_FILE": {
+          "type": "FILEPATH",
+          "value": "/android-ndk-r25c/build/cmake/android.toolchain.cmake"
+        }
+      }
+    },
     {
       "name": "linux-x64-release",
       "inherits": ["vcpkg-base"],
@@ -147,6 +186,34 @@
           "value": "Debug"
         }
       }
+    },
+    {
+      "name": "android-arm64-debug",
+      "inherits": ["vcpkg-android-base"],
+      "cacheVariables": {
+        "VCPKG_TARGET_TRIPLET": {
+          "type": "STRING",
+          "value": "arm64-android"
+        },
+        "CMAKE_BUILD_TYPE": {
+          "type": "STRING",
+          "value": "Debug"
+        }
+      }
+    },
+    {
+      "name": "android-arm64-release",
+      "inherits": ["vcpkg-android-base"],
+      "cacheVariables": {
+        "VCPKG_TARGET_TRIPLET": {
+          "type": "STRING",
+          "value": "arm64-android"
+        },
+        "CMAKE_BUILD_TYPE": {
+          "type": "STRING",
+          "value": "Release"
+        }
+      }
     }
   ],
   "buildPresets": [
@@ -213,9 +280,24 @@
       "description": "Build MSVC Configurations",
       "configuration": "Debug",
       "targets": ["install"]
+    },
+    {
+      "name": "android-arm64-debug",
+      "configurePreset": "android-arm64-debug",
+      "displayName": "Build ninja-multi-vcpkg",
+      "description": "Build ninja-multi-vcpkg Configurations",
+      "configuration": "Debug",
+      "targets": ["install"]
+    },
+    {
+      "name": "android-arm64-release",
+      "configurePreset": "android-arm64-release",
+      "displayName": "Build ninja-multi-vcpkg",
+      "description": "Build ninja-multi-vcpkg Configurations",
+      "configuration": "Release",
+      "targets": ["install"]
     }
   ],
   "testPresets": [
-
   ]
 }

Dockerfile

@@ -0,0 +1,123 @@
+FROM ubuntu:jammy
+
+ENV DEBIAN_FRONTEND noninteractive
+ARG BRANCH_NAME
+
+RUN \
+  apt-get update && \
+  apt-get -y upgrade
+
+RUN \
+  apt-get -y --no-install-recommends install \
+    build-essential \
+    ca-certificates \
+    cmake \
+    curl \
+    git \
+    libc6-dbg \
+    libgtest-dev \
+    linux-libc-dev \
+    ninja-build \
+    pkg-config \
+    python3 \
+    tar \
+    unzip \
+    vim \
+    wget \
+    zip
+
+# Download the Android NDK.
+RUN \
+  wget https://dl.google.com/android/repository/android-ndk-r25c-linux.zip && \
+  unzip android-ndk-r25c-linux.zip && \
+  rm android-ndk-r25c-linux.zip
+ENV ANDROID_NDK_HOME /android-ndk-r25c
+
+# This is needed by OpenSSL because for some reason it uses PATH to find the Android NDK compilers (and obviously
+# this will only work for linux-x86_64 images).
+ENV PATH $ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH
+
+# Clone the repository.
+RUN git clone https://github.com/hashgraph/hedera-sdk-cpp.git
+
+# Change the working directory to that of the cloned repository.
+WORKDIR /hedera-sdk-cpp
+
+# Checkout the working branch.
+RUN git checkout origin/$BRANCH_NAME
+
+# Update the submodule.
+RUN git submodule update --init
+
+# Build
+RUN cmake --preset android-arm64-release
+RUN cmake --preset android-arm64-debug
+RUN cmake --build --preset android-arm64-release
+RUN cmake --build --preset android-arm64-debug
+
+# TODO:
+# The steps below are steps needed to test the Android library executables. Currently, the Android emulator is unable to
+# run in a linux-x86_64 environment because it is built for arm64. If there is interest in testing the Android library
+# in CI, this issue of where to run the Android emulator will need to be figured out (must be in an arm64 environment,
+# arm64 docker container has been tested but doesn't work). The steps here should be the general workflow of how to get
+# the emulator up and running and the test executables ran.
+
+# Download Android SDK
+#WORKDIR /
+#RUN \
+#  mkdir android-sdk && \
+#  cd android-sdk && \
+#  wget https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip && \
+#  unzip commandlinetools-linux-11076708_latest.zip && \
+#  rm commandlinetools-linux-11076708_latest.zip && \
+#  # For some reason the SDK download doesn't put the cmdline-tools in a 'latest' folder even though its required by the
+#  # sdkmanager, so some directory rearranging is required here.
+#  mkdir latest && \
+#  mv cmdline-tools/* latest && \
+#  mv latest cmdline-tools
+
+# Add environment variables to help run tools.
+#ENV ANDROID_HOME /android-sdk
+#ENV PATH $ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/emulator:$ANDROID_HOME/platform-tools:$ANDROID_HOME
+#/build-tools/29.0.2:$PATH
+
+# Download an Android platform on which to test.
+#RUN yes | sdkmanager --licenses
+#RUN sdkmanager --update
+#RUN sdkmanager \
+#    "emulator" \
+#    "platforms;android-21" \
+#    "platform-tools" \
+#    "system-images;android-21;default;arm64-v8a" \
+#    "build-tools;29.0.2"
+#RUN echo | avdmanager create avd --name test-avd --package "system-images;android-21;default;arm64-v8a"
+#RUN emulator -avd test-avd -no-audio -no-window
+
+# TODO:
+# The steps below are remnants of the effort that was put into making the examples Android APKs. This has since been
+# abandoned, but if this is looked at again then here are some remnants of that work to pick up.
+
+# RUN apt-get -y --no-install-recommends install openjdk-17-jdk
+# ENV JAVA_HOME /usr/lib/jvm/java-17-openjdk-amd64
+
+#WORKDIR /hedera-sdk-cpp/src/sdk/examples/CreateAccountExample
+#RUN mkdir -p build/gen build/obj build/apk/lib/arm64-v8a build/apk/assets
+#RUN aapt package -f -m -J build/gen -S res -M AndroidManifest.xml -I $ANDROID_HOME/platforms/android-21/android.jar
+#RUN javac -bootclasspath $JAVA_HOME/jre/lib/rt.jar -classpath $ANDROID_HOME/platforms/android-21/android.jar -d \
+#    build/obj build/gen/com/hedera/hashgraph/sdk/cpp/examples/R.java \
+#    src/main/java/com/hedera/hashgraph/sdk/cpp/examples/CreateAccountExample.java -source 1.7 -target 1.7
+#RUN dx --dex --output=build/apk/classes.dex build/obj
+#RUN cp \
+#    /hedera-sdk-cpp/build/android-arm64-release/src/sdk/examples/Release/libhedera-sdk-cpp-create-account-example.so \
+#    build/apk/lib/arm64-v8a/
+#RUN cp -r /hedera-sdk-cpp/addressbook build/apk/assets
+#RUN cp -r /hedera-sdk-cpp/config build/apk/assets
+#RUN aapt package -f -M AndroidManifest.xml -S res -I $ANDROID_HOME/platforms/android-21/android.jar -F \
+#    build/hedera-sdk-cpp-create-account-example-apk.unsigned.apk build/apk
+#RUN zipalign -f -p 4 build/hedera-sdk-cpp-create-account-example-apk.unsigned.apk \
+#    build/hedera-sdk-cpp-create-account-example-apk.aligned.apk
+#RUN { echo testkey; echo testkey; echo; echo; echo; echo; echo; echo; echo y; } | keytool -genkeypair -keystore \
+#    keystore.jks -alias androidkey -validity 10000 -keyalg RSA -keysize 2048
+#RUN echo testkey | apksigner sign --ks keystore.jks --ks-key-alias androidkey --out \
+#    build/hedera-sdk-cpp-create-account-example-apk.apk build/hedera-sdk-cpp-create-account-example-apk.aligned.apk
+

HederaApi.cmake

@@ -16,10 +16,10 @@ else ()
     set(hapi_SOURCE_DIR ${HAPI_LOCAL_LIBRARY_PATH})
 endif ()
 
-set(HAPI_ROOT_DIR ${hapi_SOURCE_DIR}/${CMAKE_HOST_SYSTEM_NAME}/${CMAKE_HOST_SYSTEM_PROCESSOR})
+set(HAPI_ROOT_DIR ${hapi_SOURCE_DIR}/${CMAKE_SYSTEM_NAME}/${CMAKE_SYSTEM_PROCESSOR})
 
 if (NOT EXISTS ${HAPI_ROOT_DIR})
-    set(HAPI_ROOT_DIR ${hapi_SOURCE_DIR}/${CMAKE_BUILD_TYPE}/${CMAKE_HOST_SYSTEM_NAME}/${CMAKE_HOST_SYSTEM_PROCESSOR})
+    set(HAPI_ROOT_DIR ${hapi_SOURCE_DIR}/${CMAKE_BUILD_TYPE}/${CMAKE_SYSTEM_NAME}/${CMAKE_SYSTEM_PROCESSOR})
 
     if (NOT EXISTS ${HAPI_ROOT_DIR})
         message(FATAL_ERROR "Failed to the HAPI_ROOT_DIR at `${HAPI_ROOT_DIR}`")

src/sdk/examples/CMakeLists.txt

@@ -106,28 +106,6 @@ add_executable(${UPDATE_ACCOUNT_PUBLIC_KEY_EXAMPLE_NAME} UpdateAccountPublicKeyE
 add_executable(${VALIDATE_CHECKSUM_EXAMPLE_NAME} ValidateChecksumExample.cc)
 add_executable(${ZERO_TOKEN_OPERATIONS_EXAMPLE_NAME} ZeroTokenOperationsExample.cc)
 
-file(COPY ${PROJECT_SOURCE_DIR}/addressbook/mainnet.pb
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-file(COPY ${PROJECT_SOURCE_DIR}/addressbook/previewnet.pb
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-file(COPY ${PROJECT_SOURCE_DIR}/addressbook/testnet.pb
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-
-file(COPY ${PROJECT_SOURCE_DIR}/config/hello_world.json
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-file(COPY ${PROJECT_SOURCE_DIR}/config/local_node.json
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-file(COPY ${PROJECT_SOURCE_DIR}/config/stateful.json
-        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-
-file(COPY precompile-example DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-
-# Install gRPC's roots.pem file for Windows with the examples so that it can be easily referenced.
-if (WIN32)
-    file(COPY ${PROJECT_SOURCE_DIR}/vcpkg/packages/grpc_x64-windows/share/grpc/roots.pem
-            DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
-endif ()
-
 target_link_libraries(${ACCOUNT_ALIAS_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${ACCOUNT_ALLOWANCE_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${ACCOUNT_ALLOWANCE_SERIALIZED_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
@@ -138,7 +116,7 @@ target_link_libraries(${CONSENSUS_PUB_SUB_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${CONSENSUS_PUB_SUB_CHUNKED_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${CONSENSUS_PUB_SUB_WITH_SUBMIT_KEY_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${CONSTRUCT_CLIENT_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
-target_link_libraries(${CREATE_ACCOUNT_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
+target_link_libraries(${CREATE_ACCOUNT_EXAMPLE_NAME} PRIVATE ${PROJECT_NAME})
 target_link_libraries(${CREATE_FILE_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${CREATE_ACCOUNT_THRESHOLD_KEY_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${CREATE_SIMPLE_CONTRACT_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
@@ -178,55 +156,26 @@ target_link_libraries(${UPDATE_ACCOUNT_PUBLIC_KEY_EXAMPLE_NAME} PUBLIC ${PROJECT
 target_link_libraries(${VALIDATE_CHECKSUM_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 target_link_libraries(${ZERO_TOKEN_OPERATIONS_EXAMPLE_NAME} PUBLIC ${PROJECT_NAME})
 
-install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE} DESTINATION examples FILES_MATCHING PATTERN *)
+file(COPY ${PROJECT_SOURCE_DIR}/addressbook/mainnet.pb
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+file(COPY ${PROJECT_SOURCE_DIR}/addressbook/previewnet.pb
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+file(COPY ${PROJECT_SOURCE_DIR}/addressbook/testnet.pb
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+
+file(COPY ${PROJECT_SOURCE_DIR}/config/hello_world.json
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+file(COPY ${PROJECT_SOURCE_DIR}/config/local_node.json
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+file(COPY ${PROJECT_SOURCE_DIR}/config/stateful.json
+        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+
+file(COPY precompile-example DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+
+# Install gRPC's roots.pem file for Windows with the examples so that it can be easily referenced.
+if (WIN32)
+    file(COPY ${PROJECT_SOURCE_DIR}/vcpkg/packages/grpc_x64-windows/share/grpc/roots.pem
+            DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+endif ()
 
-install(TARGETS
-        ${ACCOUNT_ALIAS_EXAMPLE_NAME}
-        ${ACCOUNT_ALLOWANCE_EXAMPLE_NAME}
-        ${ACCOUNT_CREATE_WITH_HTS_EXAMPLE_NAME}
-        ${ACCOUNT_CREATION_WAYS_EXAMPLE_NAME}
-        ${AUTO_CREATE_ACCOUNT_TRANSFER_TRANSACTION_EXAMPLE_NAME}
-        ${CONSENSUS_PUB_SUB_EXAMPLE_NAME}
-        ${CONSENSUS_PUB_SUB_CHUNKED_EXAMPLE_NAME}
-        ${CONSENSUS_PUB_SUB_WITH_SUBMIT_KEY_EXAMPLE_NAME}
-        ${CONSTRUCT_CLIENT_EXAMPLE_NAME}
-        ${CREATE_ACCOUNT_EXAMPLE_NAME}
-        ${CREATE_FILE_EXAMPLE_NAME}
-        ${CREATE_ACCOUNT_THRESHOLD_KEY_EXAMPLE_NAME}
-        ${CREATE_SIMPLE_CONTRACT_EXAMPLE_NAME}
-        ${CREATE_STATEFUL_CONTRACT_EXAMPLE_NAME}
-        ${CREATE_TOPIC_EXAMPLE_NAME}
-        ${CONTRACT_NONCES_EXAMPLE_NAME}
-        ${CUSTOM_FEES_EXAMPLE_NAME}
-        ${DELETE_ACCOUNT_EXAMPLE_NAME}
-        ${DELETE_FILE_EXAMPLE_NAME}
-        ${EXEMPT_CUSTOM_FEES_EXAMPLE_NAME}
-        ${FILE_APPEND_CHUNKED_EXAMPLE_NAME}
-        ${GENERATE_KEY_EXAMPLE_NAME}
-        ${GENERATE_PRIVATE_KEY_FROM_MNEMONIC_EXAMPLE_NAME}
-        ${GET_ACCOUNT_BALANCE_EXAMPLE_NAME}
-        ${GET_ACCOUNT_INFO_EXAMPLE_NAME}
-        ${GET_ADDRESS_BOOK_EXAMPLE_NAME}
-        ${GET_EXCHANGE_RATES_EXAMPLE_NAME}
-        ${GET_FILE_CONTENTS_EXAMPLE_NAME}
-        ${MULTI_APP_TRANSFER_EXAMPLE_NAME}
-        ${MULTI_SIG_OFFLINE_EXAMPLE_NAME}
-        ${NFT_ADD_REMOVE_ALLOWANCES_EXAMPLE_NAME}
-        ${PRNG_EXAMPLE_NAME}
-        ${SCHEDULE_EXAMPLE_NAME}
-        ${SCHEDULE_IDENTICAL_TRANSACTION_EXAMPLE_NAME}
-        ${SCHEDULE_MULTI_SIG_TRANSACTION_EXAMPLE_NAME}
-        ${SCHEDULE_TRANSACTION_MULTI_SIG_TRANSACTION_EXAMPLE_NAME}
-        ${SCHEDULE_TRANSFER_EXAMPLE_NAME}
-        ${SIGN_TRANSACTION_EXAMPLE_NAME}
-        ${SOLIDITY_PRECOMPILE_EXAMPLE_NAME}
-        ${STAKING_EXAMPLE_NAME}
-        ${STAKING_WITH_UPDATE_EXAMPLE_NAME}
-        ${TOPIC_WITH_ADMIN_KEY_EXAMPLE_NAME}
-        ${TRANSFER_CRYPTO_EXAMPLE_NAME}
-        ${TRANSFER_TOKENS_EXAMPLE_NAME}
-        ${TRANSFER_USING_EVM_ADDRESS_EXAMPLE_NAME}
-        ${UPDATE_ACCOUNT_PUBLIC_KEY_EXAMPLE_NAME}
-        ${VALIDATE_CHECKSUM_EXAMPLE_NAME}
-        ${ZERO_TOKEN_OPERATIONS_EXAMPLE_NAME}
-        RUNTIME DESTINATION examples)
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}/ DESTINATION examples FILES_MATCHING PATTERN *)

src/sdk/examples/CreateAccountExample.cc

@@ -32,6 +32,7 @@ using namespace Hedera;
 int main(int argc, char** argv)
 {
   dotenv::init();
+
   const AccountId operatorAccountId = AccountId::fromString(std::getenv("OPERATOR_ID"));
   const std::shared_ptr<PrivateKey> operatorPrivateKey = ED25519PrivateKey::fromString(std::getenv("OPERATOR_KEY"));