No description, website, or topics provided.
Branch: master
Clone or download
Latest commit cec82ad Dec 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
contrib fix setup script Dec 1, 2018
gui
icons Fix icons Oct 29, 2018
lib Version++ Dec 22, 2018
plugins
pubkeys
scripts litecoin -> shield Aug 2, 2018
snap litecoin -> shield Aug 2, 2018
.gitignore LTC -> XSH Jul 30, 2018
.gitmodules Fix strings 2, add credits, update links Aug 5, 2018
.travis.yml LTC -> XSH Jul 30, 2018
AUTHORS Fix strings 2, add credits, update links Aug 5, 2018
Info.plist litecoin -> shield Aug 2, 2018
LICENCE Relicensing Feb 24, 2016
MANIFEST.in LTC -> XSH Jul 30, 2018
README.rst
RELEASE-NOTES version 3.2.2 Jul 2, 2018
electrum-env LTC -> XSH Jul 30, 2018
electrum-xsh litecoin -> shield Aug 2, 2018
electrum-xsh.conf.sample
electrum-xsh.desktop litecoin -> shield Aug 2, 2018
electrum.icns Update icons Aug 5, 2018
icons.qrc Add montserrat font Aug 3, 2018
setup.py Add hash deps for easy fast install Nov 11, 2018
tox.ini Revert "Disable broken tests" (continue in test branch) Nov 15, 2018

README.rst

Electrum-XSH - Lightweight SHIELD client

Electrum-XSH is a port of Electrum, the Bitcoin wallet, to SHIELD.

Licence: MIT Licence
Original Author: Thomas Voegtlin
Port Maintainer: Pooler
Port to SHIELD: The SHIELD Team
Language: Python
Homepage: https://shieldx.sh/

Getting started

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

./electrum-xsh

You can also install Electrum-XSH on your system, by running this command:

sudo apt-get install python3-setuptools
pip3 install .[fast]

This will download and install the Python dependencies used by Electrum-XSH, instead of using the 'packages' directory. The 'fast' extra contains some optional dependencies that we think are often useful but they are not strictly needed.

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

Development version

Check out the code from GitHub:

git clone <git link>
cd electrum-xsh

Run install (this should install dependencies):

pip3 install .[fast]

Render the SVG icons to PNGs (optional):

for i in lock unlock confirmed status_lagging status_disconnected status_connected_proxy status_connected status_waiting preferences; do convert -background none icons/$i.svg icons/$i.png; done

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

Creating Binaries

To create binaries, create the 'packages' directory:

./contrib/make_packages

This directory contains the python dependencies used by Electrum-XSH.

Mac OS X / macOS

See contrib/build-osx/.

Windows

See contrib/build-wine/.

Android

See gui/kivy/Readme.txt file.