jtm12sv/electrumsv

A desktop wallet for Bitcoin SV

ElectrumSV - Lightweight Bitcoin SV client

Licence: MIT Licence
Maintainers: Neil Booth, Roger Taylor
Project Lead: Roger Taylor
Language: Python (>=3.6)
Homepage: https://electrumsv.io/

Getting started

ElectrumSV 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 ElectrumSV from its root directory (called Electrum), without installing it on your system; all the python dependencies are included in the 'packages' directory. To run ElectrumSV from its root directory, just do:

./electrum-sv

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

pip3 install .

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

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

Development version

Check out the code from Github:

git clone https://github.com/ElectrumSV/ElectrumSV
cd ElectrumSV

Run install (this should install dependencies):

pip3 install .

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

Running unit tests:

py -3 -m unittest discover electrumsv/tests

Running pylint:

pylint --rcfile=.pylintrc electrumsv

Creating Binaries

To create binaries, create the 'packages/' directory:

./contrib/make_packages

This directory contains the python dependencies used by ElectrumSV.

The make_packages command may fail with some Ubuntu-packaged versions of pip ("can't combine user with prefix."). To solve this, it is necessary to upgrade your pip to the official version:

pip install pip --user

Linux (source with packages)

Run the following to create the release tarball under dist/:

./setup.py sdist

Mac OS X / macOS

See contrib/osx/.

Windows

See contrib/build-wine/.