Electrum - Lightweight Vertcoin client =====================================

Electrum-VTC is a rebase of upstream Electrum and pulls in updates regularly.

Donate VTC to support this work: VertionJAZJ7ZMauEdXaagRb4XP7cw6FXV

Windows Data Directory

• %APPDATA%\Electrum-VTC

Linux/macOS Data Directory

• ~/.electrum-vtc

If you would like hardware wallet support, see this.

Electrum binaries are often flagged by various anti-virus software. There is nothing we can do about it, so please stop reporting that to us. Anti-virus software uses heuristics in order to determine if a program is malware, and that often results in false positives. If you trust the developers of the project, you can verify the GPG signature of Electrum binaries, and safely ignore any anti-virus warnings. If you do not trust the developers of the project, you should build the binaries yourself, or run the software from source. Finally, if you are really concerned about malware, you should not use an operating system that relies on anti-virus software.

Old versions of Windows might need to install the KB2999226 Windows update.

Running from source ================ Electrum 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:

git submodule update --init
cd contrib/vertcoinhash-python
python3 setup.py install
cd ../..
./contrib/make_verthash-dat.sh
python3 -m pip install --user ".[gui,crypto]"
./run_electrum

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.

If you downloaded the official package (tar.gz), you can run Electrum from its root directory without installing it on your system; all the pure 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-pip
python3 -m pip install --user .

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

Check out the code from GitHub:

git clone https://github.com/vertcoin-project/electrum electrum-vtc
cd electrum-vtc
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:

./run_electrum

Run unit tests with `pytest`:

pytest electrum/tests -v

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

pytest electrum/tests/test_bitcoin.py -v

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

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

See contrib/osx/README.md.

See contrib/build-wine/README.md.

See contrib/android/Readme.md.

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 or IRC first.

Besides GitHub, most communication about Electrum development happens on IRC, in the #electrum channel on Libera Chat. The easiest way to participate on IRC is with the web client, web.libera.chat.