Electrum; Bitcoin thin client
Pull request Compare This branch is 655 commits ahead, 1408 commits behind spesmilo:master.
Permalink
Failed to load latest commit information.
contrib http -> https in github URLs. This is to please the venerable SomberN… Sep 24, 2018
gui [macOS] Fixed 2 UI issued for macOS in the External Plugin window int… Sep 24, 2018
icons Updated Trezor plugin to trezor>=0.9.0 (#550) Feb 12, 2018
ios [iOS] Add native AES support + Whitespace fixups in .py files. (#861) Sep 21, 2018
lib Bigfix for plugins.py exception catcher throwing an exception Sep 26, 2018
plugins remove pbkdf2 dependency, use stdlib instead Jul 18, 2018
pubkeys Renamed github URL from fyookball/electrum -> Electron-Cash/Electron-… Sep 23, 2018
scripts Upgrade to protocol 1.4 Jul 21, 2018
snap changes to differentiate electron-cash from electrum Dec 2, 2017
.gitignore [macOS] Updated .gitignore to include .DS_Store as a file as well sin… Sep 23, 2018
.travis.yml Add new requirements file for binaries in contrib Feb 14, 2018
AUTHORS Add self to AUTHORS Nov 9, 2015
Info.plist changes to differentiate electron-cash from electrum Dec 2, 2017
LICENCE Relicensing Feb 24, 2016
MANIFEST.in Localization fixes Apr 19, 2018
README.rst http -> https in github URLs. This is to please the venerable SomberN… Sep 24, 2018
RELEASE-NOTES http -> https in github URLs. This is to please the venerable SomberN… Sep 24, 2018
electron-cash Dummy commit to test github bot Sep 25, 2018
electron-cash.conf.sample typo Dec 2, 2017
electron-cash.desktop Add testnet mode to .desktop file (#603) Mar 17, 2018
electron-env chmod +x electrum-env Feb 12, 2018
electron.icns Fixed Mac icons not having proper transparency Jan 15, 2018
icons.qrc Toggle tray icon for cashaddr Dec 10, 2017
org.electroncash.ElectronCash.appdata.xml Renamed github URL from fyookball/electrum -> Electron-Cash/Electron-… Sep 23, 2018
setup-release.py Minimum python version of 3.5.2 in all checks. Include Python version… May 29, 2018
setup.py remove pbkdf2 from setup.py Jul 22, 2018
tox.ini Let travis run the test using Python3 Aug 26, 2017

README.rst

Electron Cash - Lightweight Bitcoin Cash client

Licence: MIT Licence
Author: Jonald Fyookball
Language: Python
Homepage: https://electroncash.org/
Help translate Electron Cash online

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 https://github.com/Electron-Cash/Electron-Cash
cd Electron-Cash

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-requests gettext
./contrib/make_locale

For plugin development, see the plugin documentation.

Running unit tests:

pip install tox
tox

Tox will take care of building a faux installation environment, and ensure that the mapped import paths work correctly.

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

See contrib/build-osx/.

Windows

See contrib/build-wine/.

Android

See gui/kivy/Readme.txt file.

iOS

See ios/.