8559d1eb72
maybe fixes https://github.com/spesmilo/electrum/issues/7640 Looks like by default pip is ignoring the locally available setuptools and wheel, and downloading the latest ones from the internet at build time... https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/?highlight=no-build-isolation#disabling-build-isolation https://stackoverflow.com/a/62889268 > When making build requirements available, pip does so in an isolated environment. That is, pip does not install those requirements into the user’s site-packages, but rather installs them in a temporary directory which it adds to the user’s sys.path for the duration of the build. This ensures that build requirements are handled independently of the user’s runtime environment. For example, a project that needs a recent version of setuptools to build can still be installed, even if the user has an older version installed (and without silently replacing that version). > > In certain cases, projects (or redistributors) may have workflows that explicitly manage the build environment. For such workflows, build isolation can be problematic. If this is the case, pip provides a --no-build-isolation flag to disable build isolation. Users supplying this flag are responsible for ensuring the build environment is managed appropriately (including ensuring that all required build dependencies are installed). If only it were that easy! If we add the "--no-build-isolation" flag, it becomes our responsibility to install *all* build time deps, hence we now have "requirements-build-makepackages.txt".
Kivy GUI
The Kivy GUI is used with Electrum on Android devices. To generate an APK file, follow these instructions.
Android binary with Docker
✓ These binaries should be reproducible, meaning you should be able to generate binaries that match the official releases.
This assumes an Ubuntu (x86_64) host, but it should not be too hard to adapt to another similar system.
-
Install Docker
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - $ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" $ sudo apt-get update $ sudo apt-get install -y docker-ce -
Build binaries
$ ./build.shIf you want reproducibility, try instead e.g.:
$ ELECBUILD_COMMIT=HEAD ELECBUILD_NOCACHE=1 ./build.sh release-unsignedNote:
build.shtakes an optional parameter which can berelease,release-unsigned, ordebug(default). -
The generated binary is in
./dist.
Verifying reproducibility and comparing against official binary
Every user can verify that the official binary was created from the source code in this repository.
- Build your own binary as described above.
Make sure you don't build in
debugmode (which is the default!), instead use either ofreleaseorrelease-unsigned. If you build inreleasemode, the apk will be signed, which requires a keystore that you need to create manually (see source ofmake_apkfor an example). - Note that the binaries are not going to be byte-for-byte identical, as the official
release is signed by a keystore that only the project maintainers have.
You can use the
apkdiff.pypython script (written by the Signal developers) to compare the two binaries.This should output$ python3 contrib/android/apkdiff.py Electrum_apk_that_you_built.apk Electrum_apk_official_release.apkAPKs match!.
FAQ
I changed something but I don't see any differences on the phone. What did I do wrong?
You probably need to clear the cache: rm -rf .buildozer/android/platform/build-*/{build,dists}
How do I deploy on connected phone for quick testing?
Assuming adb is installed:
$ adb -d install -r dist/Electrum-*-arm64-v8a-debug.apk
$ adb shell monkey -p org.electrum.electrum 1
How do I get an interactive shell inside docker?
$ sudo docker run -it --rm \
-v $PWD:/home/user/wspace/electrum \
-v $PWD/.buildozer/.gradle:/home/user/.gradle \
--workdir /home/user/wspace/electrum \
electrum-android-builder-img
How do I get more verbose logs for the build?
See log_level in buildozer.spec
How can I see logs at runtime?
This should work OK for most scenarios:
adb logcat | grep python
Better grep but fragile because of cut:
adb logcat | grep -F "`adb shell ps | grep org.electrum.electrum | cut -c14-19`"
Kivy can be run directly on Linux Desktop. How?
Install Kivy.
Build atlas: (cd contrib/android/; make theming)
Run electrum with the -g switch: electrum -g kivy
debug vs release build
If you just follow the instructions above, you will build the apk
in debug mode. The most notable difference is that the apk will be
signed using a debug keystore. If you are planning to upload
what you build to e.g. the Play Store, you should create your own
keystore, back it up safely, and run ./contrib/make_apk release.
See e.g. kivy wiki and android dev docs.
Access datadir on Android from desktop (e.g. to copy wallet file)
Note that this only works for debug builds! Otherwise the security model of Android does not let you access the internal storage of an app without root. (See this)
$ adb shell
$ run-as org.electrum.electrum ls /data/data/org.electrum.electrum/files/data
$ run-as org.electrum.electrum cp /data/data/org.electrum.electrum/files/data/wallets/my_wallet /sdcard/some_path/my_wallet
How to investigate diff between binaries if reproducibility fails?
cd dist/
unzip Electrum-*.apk1 -d apk1
mkdir apk1/assets/private_mp3/
tar -xzvf apk1/assets/private.mp3 --directory apk1/assets/private_mp3/
unzip Electrum-*.apk2 -d apk2
mkdir apk2/assets/private_mp3/
tar -xzvf apk2/assets/private.mp3 --directory apk2/assets/private_mp3/
sudo chown --recursive "$(id -u -n)" apk1/ apk2/
chmod -R +Xr apk1/ apk2/
$(cd apk1; find -type f -exec sha256sum '{}' \; > ./../sha256sum1)
$(cd apk2; find -type f -exec sha256sum '{}' \; > ./../sha256sum2)
diff sha256sum1 sha256sum2 > d
cat d