* Rename synchronous_get to synchronous_send This makes it more inline with the method 'send' of which synchronous_send is the, well, synchronous version. * Move protocol strings from scripts to network This is again a small step in the right direction. The network module is going to accumulate more and more of these simple methods. Once everything is moved into that module, that module is going to be split. Note that I've left the scripts which use scripts/util.py alone. I suspect the same functionality can be reached when using just lib/network.py and that scripts/util.py is obsolete. * Remove protocol string from verifier and websocket Websocket still has some references, that'll take more work to remove. Once the network module has been split this should be easy. I took the liberty to rename a variable to better show what it is. * Remove protocol strings from remainder The naming scheme I'm following for the newly introduced methods in the network module is: 'blockchain.<subject>.<action>' -> def <action>_(for|to)_<subject> * Move explicit protocol calls closer to each other This makes it easier to keep track of the methods which are due to be extracted. * Remove `send` when using `get_transaction` This is the final step to formalize (the informal) interface of the network module. A chance of note is changed interface for async/sync calls. It is no longer required to use the `synchronous_send` call. Merely NOT passing a callback makes the call synchronous. I feel this makes the API more intuitive to work with and easier to replace with a different network module. * Remove send from get_merkle_for_transaction The pattern which emerged for calling the lambda yielded an slight refactor. I'm not happy with the name for the `__invoke` method. * Remove explict send from websockets * Remove explicit send from scripts * Remove explicit send from wallet * Remove explicit sync_send from commands, scripts * Remove optional timeout parameter This parameter doesn't seem to be used a lot and removing it makes the remaining calls easier. Potentionally a contentious choice! * Rename `broadcast` to `broadcast_transaction` Doing so makes the method name consistent with the other ElectrumX protocol method names. * Remove synchronous_send Now every method is intuitive in what it does, no special handling required. The `broadcast_transaction` method is weird. I've opted not to change the return type b/c I found it hard to know what the exact consequences are. But ideally this method should just works as all the other ElectrumX related messages. On the other hand this shows nicely how you _can_ do something differnt quite easy. * Rename the awkwardly name `__invoke` method The new name reflects what it does. * Process the result of linter feedback I've used flake8-diff (and ignored a couple of line length warnings). * Rename tx_response to on_tx_response This fell through the cracks when this branch was rebased. * subscript_to_scripthash should be get_balance An oversight while refactoring. * Add missing return statement Without this statement the transaction would have been broadcasted twice. * Pass list of tuples to send not single tuple * Add @staticmethod decorator * Fix argument to be an array |
||
---|---|---|
.. | ||
data | ||
nfc_scanner | ||
theming/light | ||
tools | ||
uix | ||
__init__.py | ||
i18n.py | ||
main.kv | ||
main_window.py | ||
Makefile | ||
Readme.md |
Kivy GUI
The Kivy GUI is used with Electrum on Android devices. To generate an APK file, follow these instructions.
1. Preliminaries
Make sure the current user can write /opt
(e.g. sudo chown username: /opt
).
We assume that you already got Electrum to run from source on this machine,
hence have e.g. git
, python3-pip
and python3-setuptools
.
2. Install kivy
Install kivy for python3 as described here. So for example:
sudo add-apt-repository ppa:kivy-team/kivy
sudo apt-get install python3-kivy
3. Install python-for-android (p4a)
p4a is used to package Electrum, Python, SDL and a bootstrap Java app into an APK file. We patched p4a to add some functionality we need for Electrum. Until those changes are merged into p4a, you need to merge them locally (into the master branch):
3.1 kivy/python-for-android#1217
Something like this should work:
cd /opt
git clone https://github.com/kivy/python-for-android
cd python-for-android
git remote add agilewalker https://github.com/agilewalker/python-for-android
git fetch --all
git checkout 93759f36ba45c7bbe0456a4b3e6788622924cbac
git merge a2fb5ecbc09c4847adbcfd03c6b1ca62b3d09b8d
4. Install buildozer
4.1 Buildozer is a frontend to p4a. Luckily we don't need to patch it:
cd /opt
git clone https://github.com/kivy/buildozer
cd buildozer
sudo python3 setup.py install
4.2 Install additional dependencies:
sudo apt-get install python-pip
and the ones listed here.
You will also need
python3 -m pip install colorama appdirs sh jinja2
4.3 Download the Crystax NDK manually.
Extract into /opt/crystax-ndk-10.3.2
5. Create the UI Atlas
In the gui/kivy
directory of Electrum, run make theming
.
6. Download Electrum dependencies
sudo contrib/make_packages
7. Try building the APK and fail
contrib/make_apk
During this build attempt, buildozer downloaded some tools, e.g. those needed in the next step.
8. Update the Android SDK build tools
Method 1: Using the GUI
Start the Android SDK manager in GUI mode:
~/.buildozer/android/platform/android-sdk-20/tools/android
Check the latest SDK available and install it ("Android SDK Tools" and "Android SDK Platform-tools"). Close the SDK manager. Repeat until there is no newer version.
Reopen the SDK manager, and install the latest build tools ("Android SDK Build-tools"), 27.0.3 at the time of writing.
Install "Android Support Repository" from the SDK manager (under "Extras").
Method 2: Using the command line:
Repeat the following command until there is nothing to install:
~/.buildozer/android/platform/android-sdk-20/tools/android update sdk -u -t tools,platform-tools
Install Build Tools, android API 19 and Android Support Library:
~/.buildozer/android/platform/android-sdk-20/tools/android update sdk -u -t build-tools-27.0.3,android-19,extra-android-m2repository
9. Set apk version
Create a file contrib/versions.py
with contents similar to:
version_apk = '3.1.999'
This will be the version of the Android app.
10. Build the APK
contrib/make_apk
FAQ
Why do I get errors like package me.dm7.barcodescanner.zxing does not exist
while compiling?
Update your Android build tools to version 27 like described above.
Why do I get errors like (use -source 7 or higher to enable multi-catch statement)
while compiling?
Make sure that your p4a installation includes commit a3cc78a6d1a107cd3b6bd28db8b80f89e3ecddd2. Also make sure you have recent SDK tools and platform-tools
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}