f321x
36e9f185d2
On master fw_fail_htlc is, especially on the CI, flaky. We mine 100 blocks, then wait fixed 5 seconds, then check if bob has failed back the htlcs to alice. However if the test runs slowly (CI) 5 seconds can be too short for bob to catch up to the new 100 mined blocks. Instead we should just use the wait_until_htlcs_settled helper function which polls Alice local_unsettled_sent with 30 sec timeout, allowing bob to take a bit longer (or be faster) than 5 s. ``` .***** test_fw_fail_htlc ****** initializing alice funding alice a101c8c4c22043ff42029bcab2f0bf6ce5482a60d656294cbec3a4df557e2687 initializing bob funding bob d323d572c54817116d185c91f15e449550c651eb4ed76891d3011e0a8eb4ef9a initializing carol funding carol bbf3503663876a4ae00f70c7e58ad49318e83d5cf99d6effe692e113d10910c2 mining 1 blocks starting daemon (PID 5559) /tmp/alice/regtest/wallets/default_wallet true starting daemon (PID 5577) /tmp/bob/regtest/wallets/default_wallet true starting daemon (PID 5595) /tmp/carol/regtest/wallets/default_wallet true alice and carol open channels with bob mining 3 blocks wait until alice sees channel open. wait until alice sees channel open.. wait until alice sees channel open... alice pays carol Daemon stopped mining 1 blocks mining 150 blocks wait until 99ad1d44b9054f5a85c2fb45e9a9b93eb13c785104ed0664be5cf866d79d38fc:2 is spent. ... wait until 99ad1d44b9054f5a85c2fb45e9a9b93eb13c785104ed0664be5cf866d79d38fc:2 is spent............................ mining 1 blocks mining 100 blocks alice htlc was not failed FDaemon stopped ```
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.