Skip to content

Latest commit

 

History

History
171 lines (94 loc) · 5.68 KB

howto-build-android.md

File metadata and controls

171 lines (94 loc) · 5.68 KB
Raw

Building CakeWallet for Android

Requirements and Setup

The following are the system requirements to build CakeWallet for your Android device.

Ubuntu >= 20.04 
Android SDK 29 or higher (better to have the latest one 33)
Android NDK 17c
Flutter 3.10.x or earlier

Building CakeWallet on Android

These steps will help you configure and execute a build of CakeWallet from its source code.

1. Installing Package Dependencies

CakeWallet cannot be built without the following packages installed on your build system.

  • curl

  • unzip

  • automake

  • build-essential

  • file

  • pkg-config

  • git

  • python

  • libtool

  • libtinfo5

  • cmake

  • openjdk-8-jre-headless

  • clang

You may easily install them on your build system with the following command:

$ sudo apt-get install -y curl unzip automake build-essential file pkg-config git python libtool libtinfo5 cmake openjdk-8-jre-headless clang

2. Installing Android Studio and Android toolchain

You may download and install the latest version of Android Studio here. After installing, start Android Studio, and go through the "Setup Wizard." This installs the latest Android SDK, Android SDK Command-line Tools, and Android SDK Build-Tools, which are required by CakeWallet. Be sure you are installing SDK version 28 or later when stepping through the wizard

3. Installing Flutter

Need to install flutter with version 3.7.x. For this please check section Install Flutter manually.

4. Verify Installations

Verify that the Android toolchain, Flutter, and Android Studio have been correctly installed on your system with the following command:

$ flutter doctor

The output of this command will appear like this, indicating successful installations. If there are problems with your installation, they must be corrected before proceeding.

Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 3.10.x, on Linux, locale en_US.UTF-8)
[✓] Android toolchain - develop for Android devices (Android SDK version 29 or higher)
[✓] Android Studio (version 4.0 or higher)

5. Generate a secure keystore for Android

$ keytool -genkey -v -keystore $HOME/key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias key

You will be prompted to create two passwords. First you will be prompted for the "store password", followed by a "key password" towards the end of the creation process. TAKE NOTE OF THESE PASSWORDS! You will need them in later steps.

6. Acquiring the CakeWallet Source Code

Create the directory that will be use to store the CakeWallet source...

$ sudo mkdir -p /opt/android
$ sudo chown $USER /opt/android
$ cd /opt/android

..and download the source code into that directory.

$ git clone https://github.com/cake-tech/cake_wallet.git --branch main

Proceed into the source code before proceeding with the next steps:

$ cd cake_wallet/scripts/android/

7. Installing Android NDK

$ ./install_ndk.sh

8. Execute Build & Setup Commands for CakeWallet

We need to generate project settings like app name, app icon, package name, etc. For this need to setup environment variables and configure project files.

Please pick what app you want to build: cakewallet or monero.com.

$ source ./app_env.sh <cakewallet OR monero.com> (it should be like $ source ./app_env.sh cakewallet or $ source ./app_env.sh monero.com)

Then run configuration script for setup app name, app icon and etc:

$ ./app_config.sh

Build the Monero libraries and their dependencies:

$ ./build_all.sh

Now the dependencies need to be copied into the CakeWallet project with this command:

$ ./copy_monero_deps.sh

It is now time to change back to the base directory of the CakeWallet source code:

$ cd ../../

Install Flutter package dependencies with this command:

$ flutter pub get

Your CakeWallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

$ flutter packages pub run tool/generate_new_secrets.dart

Next, we must generate key properties based on the secure keystore you generated for Android (in step 5). MODIFY THE FOLLOWING COMMAND with the "store password" and "key password" you assigned when creating your keystore (in step 5).

$ flutter packages pub run tool/generate_android_key_properties.dart keyAlias=key storeFile=$HOME/key.jks storePassword=<store password> keyPassword=<key password>

REMINDER: The above command will not succeed unless you replaced the storePassword and keyPassword variables with the correct passwords for your keystore.

Then we need to generate localization files.

$ flutter packages pub run tool/generate_localization.dart

Lastly, we will generate mobx models for the project.

Generate mobx models for cw_core:

cd cw_core && flutter pub get && flutter packages pub run build_runner build --delete-conflicting-outputs && cd ..

Generate mobx models for cw_monero:

cd cw_monero && flutter pub get && flutter packages pub run build_runner build --delete-conflicting-outputs && cd ..

Generate mobx models for cw_bitcoin:

cd cw_bitcoin && flutter pub get && flutter packages pub run build_runner build --delete-conflicting-outputs && cd ..

Generate mobx models for cw_haven:

cd cw_haven && flutter pub get && flutter packages pub run build_runner build --delete-conflicting-outputs && cd ..

Finally build mobx models for the app:

$ flutter packages pub run build_runner build --delete-conflicting-outputs

9. Build!

$ flutter build apk --release

Copyright (c) 2022 Cake Technologies LLC.