Repository files navigation

Licence: MIT LicenceAuthor: Thomas VoegtlinLanguage: Python (>= 3.8)Homepage: https://electrum.org/

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

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 hereis a TL;DR:

$ sudo apt-get install libsecp256k1-dev$ ELECTRUM_ECC_DONT_COMPILE=1 python3 -m pip install --user ".[gui,crypto]"

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

$ sudo apt-get install python3-pyqt6

For elliptic curve operations,libsecp256k1is a required dependency.

If you "pip install" Electrum, by default libsecp will get compiled locally,as part of theelectrum-ecc dependency. This can be opted-out of,by setting theELECTRUM_ECC_DONT_COMPILE=1 environment variable.For the compilation to work, besides a C compiler, you need at least:

$ sudo apt-get install automake libtool

If you opt out of the compilation, you need to provide libsecp in another way, e.g.:

$ sudo apt-get install libsecp256k1-dev

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 runElectrum from its root directory without installing it on yoursystem; 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 byElectrum instead of using the 'packages' directory.It will also place an executable namedelectrum in~/.local/bin,so make sure that is on yourPATH variable.

(For OS-specific instructions, seehere for Windows,andfor macOS)

Check out the code from GitHub:

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

Run install (this should install dependencies):

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

Create translations (optional):

$ sudo apt-get install python3-requests gettext qttools5-dev-tools$ ./contrib/pull_locale

Finally, to start Electrum:

$ ./run_electrum

Run unit tests withpytest:

$ pytest tests -v

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

$ pytest tests/test_bitcoin.py -v

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

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

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