Improve build docs and optimize Dockerfile for Android and Linux builds #2016

sethforprivacy · 2025-02-10T11:40:07Z

Our docs are quite... varied in quality and detail, so I've done my best to clean them up.

In addition, I've worked to optimize @MrCyjaneK's Dockerfile for building Cake Wallet and Monero.com from source for Android and Linux in an attempt to drastically simplify the process, especially for less technical users.

This PR:

Shifts all build docs into docs/builds
Optimizes and moves the build Dockerfile from scripts/linux to the root of the project
Overhauls Android and Linux guides to use the above Docker image to make builds far easier
Fixes a few minor build issues that @MrCyjaneK found.
Resolves Building CakeWallet Android App 4.4.0 failed with haven_wallet errors, Missing cw_haven realted build instructions? #337

sethforprivacy · 2025-02-10T19:55:00Z

I think this is all ready for review!

I've tested Android and Linux builds with the new Docker image across three different hosts (a mix of x64 and arm64) and have worked with @MrCyjaneK to iron out the issues.

Please double check the other guides, but I have made sure not to edit the core steps, instead focusing on syntax and formatting.

sethforprivacy · 2025-02-10T20:18:08Z

NOTE: The output example for Linux is incorrect (shows Android right now) but I will update that when my latest Linux build completes and I can copy-paste it out :)

sethforprivacy · 2025-02-11T02:00:27Z

NOTE: The output example for Linux is incorrect (shows Android right now) but I will update that when my latest Linux build completes and I can copy-paste it out :)

Resolved in 9e19496.

xrviv · 2025-02-11T09:35:51Z

Seth, I found 1 possible problem with the Dockerfile:

Does the two == work on your end?

Anyway, I got past that -

The currrent flow is:

docker run --rm -it
-v "$(pwd)":/app
ghcr.io/cake-tech/cake_wallet:main-linux
bash
cd app
git clone https://github.com/cake-tech/cake_wallet.git
cd cake_wallet/
git checkout v4.23.0
git submodule update --init --recursive
./configure_cake_wallet.sh android
keytool -genkeypair
-alias myKeyAlias
-keyalg RSA
-keysize 2048
-validity 10000
-keystore /app/cake_wallet/my-release-key.jks
flutter pub get
flutter build appbundle --release

At this stage I get:

Got dependencies!
2 packages are discontinued.
Dependencies are affected by security advisories:
  [^0]: https://github.com/advisories/GHSA-3hpf-ff72-j67p
81 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.

You are applying Flutter's main Gradle plugin imperatively using the apply script method, which is deprecated and will be removed in a future release. Migrate to applying Gradle plugins with the declarative plugins block: https://flutter.dev/to/flutter-gradle-plugin-apply


FAILURE: Build failed with an exception.

* Where:
Build file '/app/cake_wallet/android/app/build.gradle' line: 71

* What went wrong:
A problem occurred evaluating project ':app'.
> path may not be null or empty string. path='null'

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.

BUILD FAILED in 1s
Running Gradle task 'bundleRelease'...                           1,464ms
Gradle task bundleRelease failed with exit code 1

I had to move the release key around. but then I encountered another problem.

At this stage. I suppose I have to look at the new instructions and build from there.

docs/builds/ANDROID.md

docs/builds/MACOS.md

MrCyjaneK · 2025-02-11T10:25:40Z

@xrviv Current working flow is documented here: https://github.com/sethforprivacy/cake_wallet/blob/build-docs/docs/builds/ANDROID.md#building-cake-wallet-or-monerocom

Dockerfile builds just fine on my end. Can you provide us details at which point of the documentation it resulted in an error and what that error was?

sethforprivacy · 2025-02-11T10:38:51Z

@xrviv Current working flow is documented here: https://github.com/sethforprivacy/cake_wallet/blob/build-docs/docs/builds/ANDROID.md#building-cake-wallet-or-monerocom

Dockerfile builds just fine on my end. Can you provide us details at which point of the documentation it resulted in an error and what that error was?

Same for me, following the new instructions the image builds properly on multiple machines and runs properly as well.

Co-authored-by: cyan <[email protected]>

MrCyjaneK · 2025-02-11T14:23:13Z

All looks good to me, let me just spin up a macos VM to verify that iOS and macOS docs work and there are no other edge cases

MrCyjaneK · 2025-02-11T16:35:11Z

For iOS and macOS there is a requirement for extra step after installing XCode.app

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -runFirstLaunch

and app_config.sh and build_monero_all.sh need to swap places on iOS/macOS, as app_config.sh requires monero_c dylib to be already built.

brew needs extra dependencies: automake ccache go libtool pkgconfig

we also need to call ./build_mwebd.sh after build_monero_all.sh on iOS

after generate_new_secrets.dart we also need to run

dart run tool/generate_localization.dart

In addition, build failed with xcode 15.3 on macOS 14.0 -> I have tested again on Xcode 16.2 and macOS 15.3.1, so we should use these values in the docs

I have followed iOS docs. but I am fairly certain that fixes should be made to both macos and iOS docs,

ios build failed, I'll make a patch to fix it in a bit - it is a known issue with mwebd

ios also needs softwareupdate --install-rosetta (well flutter, so macOS probably also needs it)

sethforprivacy · 2025-02-11T16:42:16Z

For iOS and macOS there is a requirement for extra step after installing XCode.app
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -runFirstLaunch
and app_config.sh and build_monero_all.sh need to swap places on iOS/macOS, as app_config.sh requires monero_c dylib to be already built.

brew needs extra dependencies: automake ccache go libtool pkgconfig

we also need to call ./build_mwebd.sh after build_monero_all.sh on iOS

after generate_new_secrets.dart we also need to run

dart run tool/generate_localization.dart

In addition, build failed with xcode 15.3 on macOS 14.0 -> I have tested again on Xcode 16.2 and macOS 15.3.1, so we should use these values in the docs

I have followed iOS docs. but I am fairly certain that fixes should be made to both macos and iOS docs,

ios build failed, I'll make a patch to fix it in a bit - it is a known issue with mwebd

ios also needs softwareupdate --install-rosetta (well flutter, so macOS probably also needs it)

Adding all now, please review the upcoming commit to be sure I understood it all properly.

sethforprivacy · 2025-02-11T16:50:27Z

For iOS and macOS there is a requirement for extra step after installing XCode.app
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -runFirstLaunch
and app_config.sh and build_monero_all.sh need to swap places on iOS/macOS, as app_config.sh requires monero_c dylib to be already built.

brew needs extra dependencies: automake ccache go libtool pkgconfig

we also need to call ./build_mwebd.sh after build_monero_all.sh on iOS

after generate_new_secrets.dart we also need to run

dart run tool/generate_localization.dart

In addition, build failed with xcode 15.3 on macOS 14.0 -> I have tested again on Xcode 16.2 and macOS 15.3.1, so we should use these values in the docs

I have followed iOS docs. but I am fairly certain that fixes should be made to both macos and iOS docs,

ios build failed, I'll make a patch to fix it in a bit - it is a known issue with mwebd

ios also needs softwareupdate --install-rosetta (well flutter, so macOS probably also needs it)

Changes made in 30ebcf6.

docs/builds/IOS.md

docs/builds/MACOS.md

docs/builds/IOS.md

MrCyjaneK · 2025-02-11T22:17:10Z

docs/builds/WINDOWS.md

+Then install `Desktop development with C++` packages via Visual Studio 2022, or Visual Studio Build Tools 2022 including:
+
+- `C++ Build Tools core features`
+- `C++ 2022 Redistributable Update`
+- `C++ core desktop features`
+- `MVC v143 - VS 2022 C++ x64/x86 build tools`
+- `C++ CMake tools for Windows`
+- `Testing tools core features - Build Tools`
+- `C++ AddressSanitizer`


Suggested change

Then install `Desktop development with C++` packages via Visual Studio 2022, or Visual Studio Build Tools 2022 including:

- `C++ Build Tools core features`

- `C++ 2022 Redistributable Update`

- `C++ core desktop features`

- `MVC v143 - VS 2022 C++ x64/x86 build tools`

- `C++ CMake tools for Windows`

- `Testing tools core features - Build Tools`

- `C++ AddressSanitizer`

Then install `Desktop development with C++` packages via [Visual Studio 2022](https://visualstudio.microsoft.com/downloads).

MrCyjaneK · 2025-02-11T22:25:45Z

docs/builds/WINDOWS.md

+
+```zsh
+sudo apt update 
+sudo apt build-essential cmake gcc-mingw-w64 g++-mingw-w64 autoconf libtool pkg-config


Suggested change

sudo apt build-essential cmake gcc-mingw-w64 g++-mingw-w64 autoconf libtool pkg-config

apt install -y build-essential pkg-config autoconf libtool ccache make cmake gcc g++ git curl lbzip2 gperf pigz gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64

I didn't test the build myself, these are copied over from monero_c mingw ci step

MrCyjaneK · 2025-02-11T22:27:31Z

docs/builds/WINDOWS.md

+Download the latest release tag of Cake Wallet and enter the source code directory:
+
+```zsh
+git clone https://github.com/cake-tech/cake_wallet.git --branch v4.23.0


Suggested change

git clone https://github.com/cake-tech/cake_wallet.git --branch v4.23.0

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

MrCyjaneK · 2025-02-11T22:27:39Z

docs/builds/WINDOWS.md

+cd cake_wallet
+```
+
+NOTE: Replace `v4.23.0` with the latest release tag available at <https://github.com/cake-tech/cake_wallet/releases/latest>.


Suggested change

NOTE: Replace `v4.23.0` with the latest release tag available at <https://github.com/cake-tech/cake_wallet/releases/latest>.

NOTE: Replace `main` with the latest release tag available at <https://github.com/cake-tech/cake_wallet/releases/latest>.

MrCyjaneK · 2025-02-11T22:35:51Z

docs/builds/WINDOWS.md

Also there is a need to add the following details

C:\Program Files\Git\bin\ needs to be in $env:PATH, so user needs to go to start menu, search 'environment', edit environment variables, double click PATH, click new and type the path there, then reboot the computer

Also, for flutter to function user needs to open 'Run', type ms-settings:developers and turn on developer mode

Also, I have tested that on Windows 11, so we also may want to bump that

Aaaaaand we also need nugat.exe, so we can instruct people to download https://dist.nuget.org/win-x86-commandline/latest/nuget.exe into C:\Program Files\Nugat\nugat.exe (create the directory) and add it to PATH (same as with Git above)

MrCyjaneK · 2025-02-11T22:37:20Z

docs/builds/WINDOWS.md

+To configure the application, run the following:
+
+```zsh
+./cakewallet.sh


Suggested change

./cakewallet.sh

.\cakewallet.bat

MrCyjaneK · 2025-02-11T23:07:30Z

With my notes above I was able to build cake wallet, on Windows11 (arm - should also work in x64 CPU as well, especially because flutter does not support arm64 on 3.24.4)

sethforprivacy added 4 commits February 10, 2025 06:03

Update build docs and migrate Android builds to Docker

daee381

Update NDK and move steps directly into Dockerfile

2ae16e5

Fix NDK installation via script and Dockerfile

81a7e57

Merge branch 'main' into build-docs

8f3ccbb

sethforprivacy mentioned this pull request Feb 10, 2025

Building CakeWallet Android App 4.4.0 failed with haven_wallet errors, Missing cw_haven realted build instructions? #337

Closed

sethforprivacy added 2 commits February 10, 2025 07:36

Migrate to @MrCyjaneK's existing Dockerfile (with optimizations)

a30fd87

Add .dockerignore and migrate Dockerfile to root of project

d07c195

sethforprivacy force-pushed the build-docs branch from c14b0ba to d07c195 Compare February 10, 2025 14:11

sethforprivacy added 5 commits February 10, 2025 09:11

Revert .gitignore changes

9e17912

Update Android and Linux builds and resolve Linux build issue

5b83415

Fix git repo for Linux and Android build instructions

6d41302

Set branch to latest release in build docs

3fee421

Ensure flutter clean is run before building

8870779

sethforprivacy marked this pull request as ready for review February 10, 2025 19:53

sethforprivacy changed the title ~~Improve build docs and add Dockerfile for Android builds~~ Improve build docs and add Dockerfile for Android and Linux builds Feb 10, 2025

sethforprivacy changed the title ~~Improve build docs and add Dockerfile for Android and Linux builds~~ Improve build docs and optimize Dockerfile for Android and Linux builds Feb 10, 2025

Fix Linux completion example

9e19496

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

sethforprivacy and others added 5 commits February 11, 2025 05:41

Don't build Zano for Linux

1746ab0

Apply suggestions from code review

5284bdd

Co-authored-by: cyan <[email protected]>

Explicitly add automake package to Dockerfile

ed24a18

Merge branch 'main' into build-docs

98f7c0e

Improve logging on Android and Linux builds via Docker

98ce9c8

sethforprivacy requested a review from MrCyjaneK February 11, 2025 16:12

Improve Dockerfile comments and ordering

7f09251

Fix issues in macOS and iOS builds docs (thanks @MrCyjaneK)

30ebcf6

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

docs/builds/IOS.md Show resolved Hide resolved

Update docs/builds/IOS.md [skip ci]

1169503

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

docs/builds/IOS.md Outdated Show resolved Hide resolved

Update docs/builds/IOS.md [skip ci]

45b1d1d

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

docs/builds/MACOS.md Outdated Show resolved Hide resolved

Update docs/builds/MACOS.md [skip ci]

5f14d1d

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

docs/builds/IOS.md Outdated Show resolved Hide resolved

Update docs/builds/IOS.md [skip ci]

1bc3e26

MrCyjaneK reviewed Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve build docs and optimize Dockerfile for Android and Linux builds #2016

Improve build docs and optimize Dockerfile for Android and Linux builds #2016

sethforprivacy commented Feb 10, 2025 •

edited

Loading

sethforprivacy commented Feb 10, 2025

sethforprivacy commented Feb 10, 2025

sethforprivacy commented Feb 11, 2025

xrviv commented Feb 11, 2025 •

edited

Loading

MrCyjaneK commented Feb 11, 2025 •

edited

Loading

sethforprivacy commented Feb 11, 2025

MrCyjaneK commented Feb 11, 2025

MrCyjaneK commented Feb 11, 2025

sethforprivacy commented Feb 11, 2025

sethforprivacy commented Feb 11, 2025 •

edited

Loading

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK Feb 11, 2025

MrCyjaneK commented Feb 11, 2025 •

edited

Loading

	sudo apt build-essential cmake gcc-mingw-w64 g++-mingw-w64 autoconf libtool pkg-config
	apt install -y build-essential pkg-config autoconf libtool ccache make cmake gcc g++ git curl lbzip2 gperf pigz gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64

	NOTE: Replace `v4.23.0` with the latest release tag available at <https://github.com/cake-tech/cake_wallet/releases/latest>.
	NOTE: Replace `main` with the latest release tag available at <https://github.com/cake-tech/cake_wallet/releases/latest>.

Improve build docs and optimize Dockerfile for Android and Linux builds #2016

Are you sure you want to change the base?

Improve build docs and optimize Dockerfile for Android and Linux builds #2016

Conversation

sethforprivacy commented Feb 10, 2025 • edited Loading

sethforprivacy commented Feb 10, 2025

sethforprivacy commented Feb 10, 2025

sethforprivacy commented Feb 11, 2025

xrviv commented Feb 11, 2025 • edited Loading

MrCyjaneK commented Feb 11, 2025 • edited Loading

sethforprivacy commented Feb 11, 2025

MrCyjaneK commented Feb 11, 2025

MrCyjaneK commented Feb 11, 2025

sethforprivacy commented Feb 11, 2025

sethforprivacy commented Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MrCyjaneK commented Feb 11, 2025 • edited Loading

sethforprivacy commented Feb 10, 2025 •

edited

Loading

xrviv commented Feb 11, 2025 •

edited

Loading

MrCyjaneK commented Feb 11, 2025 •

edited

Loading

sethforprivacy commented Feb 11, 2025 •

edited

Loading

MrCyjaneK commented Feb 11, 2025 •

edited

Loading