dgruzd/electrum

Electrum; Bitcoin thin client

Electron Cash - Lightweight Bitcoin Cash client

Licence: MIT Licence
Author: Jonald Fyookball
Language: Python
Homepage: https://electroncash.org/

Getting started

Electron Cash is a pure python application forked from Electrum. If you want to use the Qt interface, install the Qt dependencies:

sudo apt-get install python3-pyqt5

If you downloaded the official package (tar.gz), you can run Electron Cash from its root directory (called Electrum), without installing it on your system; all the python dependencies are included in the 'packages' directory. To run Electron Cash from its root directory, just do:

./electron-cash

You can also install Electron Cash on your system, by running this command:

sudo apt-get install python3-setuptools
python3 setup.py install

This will download and install the Python dependencies used by Electron Cash, instead of using the 'packages' directory.

If you cloned the git repository, you need to compile extra files before you can run Electron Cash. Read the next section, "Development Version".

Development version

Check out the code from Github:

git clone git://github.com/fyookball/electrum.git
cd electrum

Run install (this should install dependencies):

python3 setup.py install

Compile the icons file for Qt:

sudo apt-get install pyqt5-dev-tools
pyrcc5 icons.qrc -o gui/qt/icons_rc.py

Compile the protobuf description file:

sudo apt-get install protobuf-compiler
protoc --proto_path=lib/ --python_out=lib/ lib/paymentrequest.proto

Create translations (optional):

sudo apt-get install python-pycurl gettext
./contrib/make_locale

Creating Binaries

To create binaries, create the 'packages' directory:

./contrib/make_packages

This directory contains the python dependencies used by Electron Cash.

Mac OS X / macOS

Do all the stuff listed under 'Development Version' and 'Creating Binaries' above, and in addition:

ln -s contrib/packages packages

python setup-release.py py2app

Now, you'll have a dist/Electron-Cash.app, but it won't quite work. You need to do some crazy magic to get python to see the files properly:

(cd dist/Electron-Cash.app/Contents/Resources/lib && for z in *.zip; do mv $z z.zip && mkdir $z &&  cd $z && unzip -v ../z.zip && rm -f ../z.zip && mv electroncash_plugins plugins.bak && ln -s ../python3.*/plugins electroncash_plugins && cd .. && rm -f z.zip)

Next, you'll try and run it but it will complain that it can't find the 'cocoa' plugin. You have to copy everything from:

/opt/local/libexec/qt5/plugins

Into a directory called 'qt_plugins' as such:

dist/Electron-Cash.app/Contents/Resoureces/qt_plugins

and then use install_name_tool on each .dylib file to rewrite hard-coded lib names to @rpath/../Frameworks/.

If you know what this means, great! If not, google it (or give up)!

And finally, optionally create a .dmg...

hdiutil create -fs HFS+ -volname "Electron-Cash" -srcfolder dist/Electron-Cash.app dist/electron-cash-VERSION-macosx.dmg

Windows

See contrib/build-wine/README file.

Android

See gui/kivy/Readme.txt file.