Electrum-FLO; FLO thin client
Outdated firmware error messages were originally raised from create_client, which would mean that a client for an outdated device would not be created. This had a number of undesirable outcomes due to "client does not exist" being conflated with "no device is connected". Instead, we raise in setup_client (which prevents creating new wallets with outdated devices, BUT shows them in device list), and python-trezor also raises on most calls (which gives us an error message when opening wallet and/or trying to do basically anything with it). This is still suboptimal - i.e., there's currently no way for Electrum to claim higher version requirement than the underlying python-trezor, and so minimum_firmware property is pretty much useless ATM. |
||
|---|---|---|
| .github | ||
| contrib | ||
| electrum | ||
| icons | ||
| pubkeys | ||
| snap | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| AUTHORS | ||
| electrum-env | ||
| electrum.desktop | ||
| electrum.icns | ||
| icons.qrc | ||
| LICENCE | ||
| MANIFEST.in | ||
| README.rst | ||
| RELEASE-NOTES | ||
| run_electrum | ||
| setup.py | ||
| tox.ini | ||
Electrum - Lightweight Bitcoin client
=====================================
::
Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python (>= 3.6)
Homepage: https://electrum.org/
.. image:: https://travis-ci.org/spesmilo/electrum.svg?branch=master
:target: https://travis-ci.org/spesmilo/electrum
:alt: Build Status
.. image:: https://coveralls.io/repos/github/spesmilo/electrum/badge.svg?branch=master
:target: https://coveralls.io/github/spesmilo/electrum?branch=master
:alt: Test coverage statistics
.. image:: https://d322cqt584bo4o.cloudfront.net/electrum/localized.svg
:target: https://crowdin.com/project/electrum
:alt: Help translate Electrum online
Getting started
===============
Electrum 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 from its root directory without installing it on your
system; all the python dependencies are included in the 'packages'
directory. To run Electrum from its root directory, just do::
./run_electrum
You can also install Electrum on your system, by running this command::
sudo apt-get install python3-setuptools
python3 -m pip install .[fast]
This will download and install the Python dependencies used by
Electrum 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. Read the next section, "Development
Version".
Development version
===================
Check out the code from GitHub::
git clone git://github.com/spesmilo/electrum.git
cd electrum
Run install (this should install dependencies)::
python3 -m pip 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 electrum/gui/qt/icons_rc.py
Compile the protobuf description file::
sudo apt-get install protobuf-compiler
protoc --proto_path=electrum --python_out=electrum electrum/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.
Mac OS X / macOS
--------
See `contrib/osx/`.
Windows
-------
See `contrib/build-wine/`.
Android
-------
See `electrum/gui/kivy/Readme.md` file.