::
Licence: MIT Licence Author: Jonald Fyookball Language: Python Homepage: https://electroncash.org/
.. image:: https://d322cqt584bo4o.cloudfront.net/electron-cash/localized.svg :target: https://crowdin.com/project/electron-cash :alt: Help translate Electron Cash online
.. image:: https://img.shields.io/travis/simpleledger/Electron-Cash-SLP :target: https://travis-ci.org/github/simpleledger/Electron-Cash-SLP :alt: Travis CI
.. image:: https://img.shields.io/coveralls/github/simpleledger/Electron-Cash-SLP :target: https://coveralls.io/github/simpleledger/Electron-Cash-SLP :alt: Coveralls code coverage
Note: If running from source, Python 3.6 or above is required to run Electron Cash. If your system lacks Python 3.6,
you have other options, such as the AppImage / binary releases <https://github.com/simpleledger/Electron-Cash-SLP/releases/>
or running from source using pyenv
(see section Running from source on old Linux
below).
macOS: It is recommended that macOS users run the binary .dmg <https://github.com/simpleledger/Electron-Cash-SLP/releases/>
as that's simpler to use and has everything included. Otherwise, if you want to run from source, see section Running from source on macOS
below.
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 python3-pyqt5.qtsvg
If you downloaded the official package (tar.gz), you can run Electron Cash from its root directory (called Electron Cash), 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".
Check your python version >= 3.6, and install pyqt5, as instructed above in the
Getting started
section above or Running from source on old Linux
section below.
If you are on macOS, see the Running from source on macOS
_ section below.
Check out the code from Github::
git clone https://github.com/simpleledger/Electron-Cash-SLP
cd Electron-Cash-SLP
Run install (this should install dependencies)::
python3 setup.py install
or for Debian based systems ( tested on Debian v9 Stretch )::
sudo apt update
sudo apt install python3-dnspython python3-pyaes libsecp256k1-0 python3-protobuf python3-jsonrpclib-pelix python3-ecdsa python3-qrcode python3-pyqt5 python3-socks
Create translations (optional)::
sudo apt-get install python-requests gettext
./contrib/make_locale
For plugin development, see the plugin documentation <plugins/README.rst>
_.
Running unit tests (very optional, advanced users only)::
pip install tox
tox
Tox will take care of building a faux installation environment, and ensure that the mapped import paths work correctly.
If your Linux distribution has a different version of python 3 (such as python
3.5 in Debian 9), it is recommended to do a user dir install with
pyenv <https://github.com/pyenv/pyenv-installer>
_. This allows Electron
Cash to run completely independently of your system configuration.
pyenv <https://github.com/pyenv/pyenv-installer>
_ in your user
account. Follow the printed instructions about updating your environment
variables and .bashrc
, and restart your shell to ensure that they are
loaded.pyenv install 3.6.9
. This will download and compile that version of
python, storing it under .pyenv
in your home directory.cd
into the Electron Cash directory. Run pyenv local 3.6.9
which inserts
a file .python-version
into the current directory.pip install pyqt5
../electron-cash
. If you are using the git version,
then continue by following the Development version instructions above.You need to install either MacPorts <https://www.macports.org>
or HomeBrew <https://www.brew.sh>
. Follow the instructions on either site for installing (Xcode from Apple's developer site <https://developer.apple.com>
_ is required for either).
git clone https://github.com/simpleledger/Electron-Cash-SLP && cd Electron-Cash-SLP
brew install python3
or if using MacPorts: sudo port install python36
python3 -m pip install --user pyqt5
python3 -m pip install --user -r contrib/requirements/requirements.txt
./contrib/make_secp
.
This requires GNU tools and automake, install with brew: brew install coreutils automake
or if using MacPorts: sudo port install coreutils automake
./electron-cash
See contrib/build-linux/README.md <contrib/build-linux/README.md>
_.
See contrib/osx/ <contrib/osx/>
_.
See contrib/build-wine/ <contrib/build-wine/>
_.
See gui/kivy/Readme.txt <gui/kivy/Readme.txt>
_ file.
See ios/ <ios/>
_.