04eccc2be5
77772e7a30undo "ui: Compile boost:signals2 only once" (MarcoFalke)fa45783d55mv btcsignals.h to src/util (MarcoFalke)fa4903db8arefactor: Make scoped_connection ctor explicit (MarcoFalke)fa1bc1fe51test: Check btcsignals determinism in thread_safety test case (MarcoFalke)fa86e5dba9refactor: Properly return from ThreadSafeQuestion signal (MarcoFalke)fa4badc0fdrefactor: Make ThreadSafeMessageBox signal void (MarcoFalke)faad9d6434refactor: Mark btcsignals operator [[nodiscard]] (MarcoFalke) Pull request description: Previously, the ThreadSafeQuestion signal was using `btcsignals::optional_last_value<bool>`. However, this only worked by accident: * Calling `CClientUIInterface::ThreadSafeQuestion` did not return an `std::optional<bool>`, but `value_or(false)`. This makes it hard for callers to differentiate between `nullopt` and `false`. * The return value was further influenced by the order in which the connections were done. The noui callbacks would always overwrite the return value with false. This makes the code overall brittle, and confusing. For example, the following patch that changes the order of connections would break the only and single place where the return value actually matters: ```diff diff --git a/src/qt/bitcoin.cpp b/src/qt/bitcoin.cpp index0b89c605b9..976549470e100644 --- a/src/qt/bitcoin.cpp +++ b/src/qt/bitcoin.cpp @@ -488,3 +488,2 @@ int GuiMain(int argc, char* argv[]) btcsignals::scoped_connection handler_message_box = ::uiInterface.ThreadSafeMessageBox_connect(noui_ThreadSafeMessageBox); - btcsignals::scoped_connection handler_question = ::uiInterface.ThreadSafeQuestion_connect(noui_ThreadSafeQuestion); btcsignals::scoped_connection handler_init_message = ::uiInterface.InitMessage_connect(noui_InitMessage); @@ -663,2 +662,3 @@ int GuiMain(int argc, char* argv[]) app.createWindow(networkStyle.data()); + btcsignals::scoped_connection handler_question = ::uiInterface.ThreadSafeQuestion_connect(noui_ThreadSafeQuestion); // Perform base initialization before spinning up initialization/shutdown thread ``` This can be tested by applying the patch and then calling: (May have to be started twice to trigger the question) ``` bitcoin-qt -regtest -datadir=/tmp -mocktime=123456789 ``` Before the changes in this commit (on current master), pressing `OK` would not have any effect and would abort the program. After the changes in this commit, pressing `OK` will correctly trigger a -reindex and leave the program running. So fix that by properly returning from the signal. Also, remove the then-unused `btcsignals::optional_last_value<T>` combiner. Also, other follow-ups from https://github.com/bitcoin/bitcoin/pull/34495#issuecomment-4212629857 ACKs for top commit: theuni: ACK77772e7a30hebasto: ACK77772e7a30, I have reviewed the code and it looks OK. Tested on Fedora 44. sedited: Nice, ACK77772e7a30Tree-SHA512: 0d9c83a3f34d98bf7a2d3b53ea122d5f5313566d77936d7c564cb613b8f5bbd0edc3955853d71dd555cf8a20c08b3d6fc30907351361720f4b0c5f8dbe8d6965
Bitcoin Core integration/staging tree
For an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/.
What is Bitcoin Core?
Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully validate blocks and transactions. It also includes a wallet and graphical user interface, which can be optionally built.
Further information about Bitcoin Core is available in the doc folder.
License
Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/license/MIT.
Development Process
The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be
completely stable. Tags are created
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.
The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.
Testing
Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.
Automated Testing
Developers are strongly encouraged to write unit tests for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled during the generation of the build system) with: ctest. Further details on running
and extending unit tests can be found in /src/test/README.md.
There are also regression and integration tests, written
in Python.
These tests can be run (if the test dependencies are installed) with: build/test/functional/test_runner.py
(assuming build is your build directory).
The CI (Continuous Integration) systems make sure that every pull request is tested on Windows, Linux, and macOS. The CI must pass on all commits before merge to avoid unrelated CI failures on new pull requests.
Manual Quality Assurance (QA) Testing
Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.
Translations
Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.
Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.
Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.