Electrum Bitcoin Wallet
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
ThomasV d7beb109b8 lnworker: separate add_peer from _open_channel_coroutine 5 days ago
.github follow-up prev commit: use less space 6 years ago
contrib remove the kivy gui 4 weeks ago
electrum lnworker: separate add_peer from _open_channel_coroutine 5 days ago
pubkeys Extended the expiration date of my gpg pubkey 10 months ago
.cirrus.yml follow-up prev 3 weeks ago
.dockerignore Add Cirrus CI (#7431) 2 years ago
.editorconfig Add .editorconfig file 1 year ago
.gitattributes add .gitattributes file for end-of-line normalisation 11 months ago
.gitignore build: fix repro builds where host userid != 1000 6 months ago
.gitmodules remove the kivy gui 4 weeks ago
AUTHORS Fix Revealer Qt layout (#8587) 3 weeks ago
LICENCE Relicensing 8 years ago
MANIFEST.in build: include AppStream metainfo.xml in tarballs 2 months ago
README.md README: refer to `libsecp256k1-dev` instead of `libsecp256k1-0` 5 months ago
RELEASE-NOTES release notes: add links to security disclosures 2 weeks ago
SECURITY.md SECURITY.md: make email addrs more bot-resistant 5 months ago
electrum-env electrum-env script: don't pull in "pip install --user" pkgs 2 years ago
electrum.desktop remove PATH manipulation from .desktop file (#8309) 5 months ago
org.electrum.electrum.metainfo.xml Add an AppStream metainfo.xml file 8 months ago
run_electrum Add unlock command to CLI (stores wallet password in memory) 1 week ago
setup.cfg build: don't allow setuptools to sneakily install build-time deps 3 years ago
setup.py remove the kivy gui 4 weeks ago
tox.ini tox.ini: allow running tox from local dev env 7 months ago


Electrum - Lightweight Bitcoin client

Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python (>= 3.8)
Homepage: https://electrum.org/

Build Status Test coverage statistics Help translate Electrum online

Getting started

(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 here is a TL;DR:

$ sudo apt-get install libsecp256k1-dev
$ 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-dev

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 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.

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/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 tests

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

Creating Binaries


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.