davide
d1088c036e
get_target(): replace hardcoded Bitcoin constants (CHUNK_SIZE, 14-day timespan, module-level MAX_TARGET) with per-chain values from constants.net. Handle POW_GENESIS_BITS so that chains whose genesis nBits differs from target_to_bits(MAX_TARGET) return the correct initial difficulty for period 0. Map checkpoint indices correctly when adj_interval != CHUNK_SIZE. verify_chunk(): add a separate code path for chains where the retarget interval is shorter than CHUNK_SIZE (e.g. BTCP: 120 vs 2016). In this case multiple retargets can occur within a single chunk; because the headers are not yet on disk during verification, reading via read_header() would raise MissingHeader and reject the entire chunk. Fix by reading from the in-memory data buffer via a local helper _read_hdr(), and tracking current_target across period boundaries inline. can_connect(), chainwork_of_header_at_height(): use adj_interval instead of CHUNK_SIZE when computing the difficulty-period index so that BTCP's 120-block retarget windows are respected
Electrum - Lightweight Bitcoin client
Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python (>= 3.10)
Homepage: https://electrum.org/
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
$ ELECTRUM_ECC_DONT_COMPILE=1 python3 -m pip install --user ".[gui,crypto]"
Not pure-python dependencies
Qt GUI
If you want to use the Qt interface, install the Qt dependencies:
$ sudo apt-get install python3-pyqt6
libsecp256k1
For elliptic curve operations, libsecp256k1 is a required dependency.
If you "pip install" Electrum, by default libsecp will get compiled locally,
as part of the electrum-ecc dependency. This can be opted-out of,
by setting the ELECTRUM_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
cryptography
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
hardware-wallet support
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 gettext
$ ./contrib/locale/build_locale.sh electrum/locale/locale electrum/locale/locale
Finally, to start Electrum:
$ ./run_electrum
Run tests
Run unit tests with pytest:
$ pytest tests -v
(can be parallelized with -n auto option, using pytest-xdist plugin)
To run a single file, specify it directly like this:
$ pytest tests/test_bitcoin.py -v
Creating Binaries
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 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.
Please improve translations on Crowdin.