DRAFT: WSL-Ubuntu-Android Build Guide

[D33r-Gee]

This is an updated version of PR #351
It has been rebased and the WSL Ubuntu Android install guide has been added to build-android.md
Let me know if there are any issues

[D33r-Gee]

Rebased main, deleted WSL_APK_INSTALL.md and modified build-android.md so the wsl guide can be found there. Let me know if there's anything that needs to be updated @jarolrod

[hebasto]

Please add PR description, update PR title, fix linter issues and clean commit history.

[D33r-Gee]

Please add PR description, update PR title, fix linter issues and clean commit history.

Took care of the above.
Re: clean commit history, please let me know if that's the way to do it or if you'd prefer a different approach?

[pablomartin4btc]

Concept ACK

I'll try to validate the instructions following them and checking the built is correct. Is this exclusive to WSL or can be done on Ubuntu 22.04.

Re: clean commit history, please let me know if that's the way to do it or if you'd prefer a different approach?

I think there's no need to have so many commits, you could squash them all into only one.

Also, perhaps you need to rebase?

[D33r-Gee]

Thanks @pablomartin4btc for Concept Ack this PR I will squash the commits and rebase early next week as I'm traveling for the holiday.

…

On Wed, Nov 22, 2023, 20:33 pablomartin4btc ***@***.***> wrote: ***@***.**** commented on this pull request. Concept ACK I'll try to validate the instructions following them and checking the built is correct. Is this exclusive to WSL or can be done on Ubuntu 22.04. Re: clean commit history, please let me know if that's the way to do it or if you'd prefer a different approach? I think there's no need to have so many commits, you could squash them all into only one. Also, perhaps you need to rebase? — Reply to this email directly, view it on GitHub <#366 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2P6LNZVG3DCPSXE4EDXAPLYFZHQJAVCNFSM6AAAAAA4VFKKCSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONBVGI3DAMBXGI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[D33r-Gee]

Is this exclusive to WSL or can be done on Ubuntu 22.04.

It should work with Ubuntu 22.04 proper.

Squashed the commits and rebased with main

Thanks again for reviewing @pablomartin4btc

[pablomartin4btc]

ACK a4bf253

Sorry, I think the 2nd commit ("Merge branch..." 9ca8bb2) is not necessary, only 1 commit.

I'll try to follow the guide at some point next week and give a deeper review. Thanks for working on this!

[D33r-Gee]

thanks @pablomartin4btc, for taking a look... squashed it down to 1 commit.

I'll try to follow the guide at some point next week and give a deeper review.

Sounds great!

Thanks for working on this!

with pleasure

[hebasto]

@D33r-Gee

The diff looks too big (956 files) for a build guide, doesn't it?

[D33r-Gee]

The diff looks too big (956 files) for a build guide, doesn't it?

@hebasto, yes thanks for pointing it out. I didn't do proper house cleaning when synching my fork. It should be resolved now.

[pablomartin4btc]

tACK till Step 4 included

I'll continue and finish it before the end of the next week. Looking forward to have this working and play with it.

[pablomartin4btc]

tACK till Step 6 included, only 1 step left to finish...

I have some minor nits that I'll write them out when I complete the guide entirely.

[pablomartin4btc]

tACK 4523a0f

I've finished the entire guide, sorry it took me a while cos I've checked different devices and had to learn to use the tools.

I tried first with an old tablet (HUAWEI m3 lite 10") with Android 7.0 (API level #24) but the Bitcoin core app crashes due to some missing qt library (checked with adb logcat I needed to install "Ministro II" but it didn't fix it... I'll try later to build a qt bundle from Android Studio and send it to the device).

Secondly I've tried on these (friends and family - 😄 🙏) phones:

Google Pixel 6 (Android 14 - API Level 34)

Samsung A20 (Android 9 - API Level 28)

HUAWEI Y9 (Android 9 - API Level 28)

Finally, I've re-built it for my old smart watch...

HUAWEI watch 2 (32 bits, Android 8.0.0, API Level 26)

I've noticed some issues regarding the user experience, layout, etc., on the different platforms/ devices related to QML itself so I'll leave that out of this PR which approach is only the WSL - Ubuntu Android Build Guide.

I think I'd leave this guide open to use both WSL and Ubuntu itself so I'm not sure you need to but in case you do, you can also install usbipd there on Ubuntu.

[pablomartin4btc]

e.g.:

ANDROID_SDK=/home/ubunpolk/Android/Sdk ANDROID_NDK=/home/ubunpolk/Android/Sdk/ndk/26.1.10909125 make -C depends HOST=armv7a-linux-android ANDROID_API_LEVEL=26 ANDROID_TOOLCHAIN_BIN=/home/ubunpolk/Android/Sdk/ndk/26.1.10909125/toolchains/llvm/prebuilt/linux-x86_64/bin CC=/home/ubunpolk/Android/Sdk/ndk/26.1.10909125/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi26-clang CXX=/home/ubunpolk/Android/Sdk/ndk/26.1.10909125/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi26-clang++

[D33r-Gee]

At the top of this document the example given is:
ANDROID_SDK=/home/user/Android/Sdk ANDROID_NDK=/home/user/Android/Sdk/ndk-bundle make HOST=aarch64-linux-android ANDROID_API_LEVEL=28 ANDROID_TOOLCHAIN_BIN=/home/user/Android/Sdk/ndk-bundle/toolchains/llvm/prebuilt/linux-x86_64/bin

in your example, what do the `CC=...` and `CXX=...` add in terms building the proper depends?

[pablomartin4btc]

I think it forces to build depends with the proper clang version for the required Android API Level.

[D33r-Gee]

ah got it... ok so will leave the the extra CC= and CXX= from example to minimize confusion, however if you feel strongly about having them let me know?

[pablomartin4btc]

I prefer to use them in all make calls to ensure the Android API Level for the particular architecture (arm64-v8a, armeabi-v7a, etc), but perhaps it's not required or I'm over-using them, maybe @hebasto can shed some light here.

[D33r-Gee]

Hi @pablomartin4btc ,

Thanks so much for going through the whole guide and testing it on different devices,,, amazing!

I've finished the entire guide, sorry it took me a while cos I've checked different devices and had to learn to use the tools.

No worries, happy you got through and thanks for suggesting improvements!

I will look them over, test them then update the commit in the coming days...

[D33r-Gee]

@pablomartin4btc , thanks for your reviews and suggestions I've implemented them here 8e20109
Let me know your thoughts and/or if there's anything I missed?

[pablomartin4btc]

nit:

Suggested change

	Now, you can build the APKs using the guide found [here](https://github.com/bitcoin-core/gui-qml/blob/main/doc/build-android.md).
	Now, you need to build the dependencies for the specific Android API Level, for which you can follow the guide found [here](https://github.com/bitcoin-core/gui-qml/blob/main/doc/build-android.md).

Maybe that guide above needs to be updated as it shows an example for "a default build with no disabled dependencies", and could display the make -C depends suggested previously. And later below you also specify run make && make apk from src/qt as on the build-android guide.

In my opinion, I'd be more clear on the sub-steps here in Step 7 in order to build the APK and transfer/ install it to the device (including for each the other commands to make it work as the qlogging.cpp update, paths, etc):

1. build dependencies
2. configure with proper host
3. make
4. make apk
5. adb install

[D33r-Gee]

Great idea on the having sub-steps

[D33r-Gee]

new commit 7687e2c

Added your suggestions @pablomartin4btc

[pablomartin4btc]

tACK 7687e2c

Tested on Ubuntu 22.04 (non-WSL), so I think we can use this guide for both, perhaps you need to identify and separate the steps specifically for WSL (including usage of usbip, which is not required for non-WSL) and that's all I can say, it worked fine for me.

[pablomartin4btc]

I think we can use this guide for both, perhaps you need to identify and separate the steps specifically for WSL (including usage of usbip, which is not required for non-WSL) and that's all I can say, it worked fine for me.

Sorry, what I mentioned above perhaps can be done on a follow-up, apologies if you started doing that already 🙏.

[D33r-Gee]

Sorry, what I mentioned above perhaps can be done on a follow-up, apologies if you started doing that already 🙏.

No worries... Apologies for the late response was focused on the AssumeUTXO integration

I think we can use this guide for both...

That's a great idea, once I implement your latest suggestions perhaps it can be merged and we can open a new PR detailing both OSes or we can keep collaborating on this one till we feel it's ready to be merged...

@pablomartin4btc thoughts?

[D33r-Gee]

updated and rebased 5b7da4a

Thanks @pablomartin4btc for testing and the suggestions

[pablomartin4btc]

re ACK 5b7da4a

perhaps it can be merged and we can open a new PR detailing both OSes or we can keep collaborating on this one till we feel it's ready to be merged...

IMO this PR can be merge as it is, and we can open a new one to incorporate Ubuntu
with some tweaks.

[hebasto]

Building for Android is currently broken in the Bitcoin Core master branch. This is the main reason why there have not been syncing to the master branch recently.

I suggest to draft / postpone this PR until CMake + Qt6 are landed to the master branch.

[D33r-Gee]

I suggest to draft / postpone this PR until CMake + Qt6 are landed to the master branch.

Ah great to know... yes setting this PR to draft then