Electrum-FEC - Lightweight Ferrite client

Ferrite lightweight wallet based on Electrum-LTC and Electrum codebase.

Community group links

Ferrite Core	r/Ferritecoin	Discord	Twitter

Build guide

# You will need Docker -
sudo snap install docker

git clone https://github.com/koh-gt/electrum-fec
sudo chmod +x -R electrum-fec

# Linux
cd electrum-fec/contrib/build-linux/appimage
./build.sh

# Windows
sudo apt-get install -y upx
cd electrum-fec/contrib/build-wine
./build.sh

# Android (Incomplete)
cd electrum-fec/contrib/android
## ARM 64-bit
./build.sh qml arm64-v8a release-unsigned
## x86 Android
./build.sh qml x86 release-unsigned
## Legacy Android
./build.sh qml arm64-v8a release-unsigned

Common distutils error - Python
sudo apt install python3-distutils-extra

Licence: MIT Licence
Author: Thomas Voegtlin
Port Maintainer: Pooler
Language: Python (>= 3.8)

Getting started

(If you've come here looking to simply run Electrum-FEC, you may download it here.)

Electrum-FEC 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 install python3-pip
$ sudo apt-get install libsecp256k1-0
$ python3 -m pip install --user ".[gui,crypto]"
$ sudo apt-get install python3-pyqt5  # Not pure python - If you want to use the Qt interface, install the Qt dependencies

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

For fast blockchain verification, scrypt is required. Install from your package manager (or from pip):

$ sudo apt-get install python3-scrypt

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

$ ./run_electrum

You can also install Electrum-FEC 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-FEC instead of using the 'packages' directory. It will also place an executable named electrum-fec in ~/.local/bin, so make sure that is on your PATH variable.

Development version (git clone)

(For OS-specific instructions, see here for Windows, and for macOS)

Check out the code from GitHub:

$ git clone https://github.com/pooler/electrum-fec.git
$ cd electrum-fec
$ git submodule update --init

Run install (this should install dependencies):

$ python3 -m pip install --user -e .

Create translations (optional):

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

Finally, to start Electrum-FEC:

$ ./run_electrum

Run tests

Run unit tests with pytest:

$ pytest electrum_fec/tests -v

To run a single file, specify it directly like this:

$ pytest electrum_fec/tests/test_bitcoin.py -v

Creating Binaries

• Linux (tarball)
• Linux (AppImage)
• macOS
• Windows
• Android

Contributing

Any help testing the software, reporting or fixing bugs, reviewing pull requests and recent changes, writing tests, or helping with outstanding issues is very welcome. Implementing new features, or improving/refactoring the codebase, is of course also welcome, but to avoid wasted effort, especially for larger changes, we encourage discussing these on the issue tracker first.