Skip to content
master
Switch branches/tags
Code
This branch is 93 commits ahead, 27 commits behind namecoin/electrum-nmc:master.
Contribute

Latest commit

 

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Electrum-CHI - Lightweight Xaya client

Licence: GNU GPLv3+ for Electrum-DOGE components; CC BY 4.0 for Namecoin logo, MIT Licence for all other components
Author: The Xaya developers; based on Electrum by Thomas Voegtlin, Electrum-DOGE by The Electrum-DOGE contributors and Electrum-NMC by the Namecoin developers
Language: Python (>= 3.6)
Homepage: https://www.xaya.io/ ; original Electrum Homepage at https://electrum.org/
Build Status Test coverage statistics Help translate Electrum online

Getting started

Electrum-CHI itself is pure Python, and so are most of the required dependencies, but not everything. The following sections describe how to run from source, but here is a TL;DR:

sudo apt-get install libsecp256k1-0
python3 -m pip install --user .[gui,crypto]

Not pure-python dependencies

If you want to use the Qt interface, install the Qt dependencies:

sudo apt-get install python3-pyqt5

For elliptic curve operations, libsecp256k1 is a required dependency:

sudo apt-get install libsecp256k1-0

Alternatively, when running from a cloned repository, a script is provided to build libsecp256k1 yourself:

sudo apt-get install automake libtool
./contrib/make_libsecp256k1.sh

Due to the need for fast symmetric ciphers, cryptography is required. Install from your package manager (or from pip):

sudo apt-get install python3-cryptography

If you would like hardware wallet support, see this.

Running from tar.gz

If you downloaded the official package (tar.gz), you can run Electrum-CHI from its root directory without installing it on your system; all the pure python dependencies are included in the 'packages' directory. To run Electrum-CHI from its root directory, just do:

./run_electrum_chi

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

sudo apt-get install python3-setuptools python3-pip
python3 -m pip install --user .

This will download and install the Python dependencies used by Electrum-CHI instead of using the 'packages' directory. It will also place an executable named electrum-chi in ~/.local/bin, so make sure that is on your PATH variable.

Development version (git clone)

Check out the code from GitHub:

git clone git://github.com/xaya/electrum-chi.git
cd electrum-chi
git submodule update --init

Run install (this should install dependencies):

python3 -m pip install --user -e .

Compile the Qt UI:

sudo apt-get install pyqt5-dev-tools
./contrib/make_qt_forms

Copy over the www root:

rm -rf electrum_nmc/electrum/www
cp -a electrum/www electrum_nmc/electrum/www

Create translations (optional):

sudo apt-get install python-requests gettext
./contrib/pull_locale

Finally, to start Electrum:

./run_electrum_chi

Creating Binaries

Linux (tarball)

See contrib/build-linux/sdist/README.md.

Linux (AppImage)

See contrib/build-linux/appimage/README.md.

Mac OS X / macOS

See contrib/osx/README.md.

Windows

See contrib/build-wine/README.md.

Android

See contrib/android/Readme.md.