bitcoin/src/qt
Ava Chow 011a895a82
Merge bitcoin/bitcoin#29015: kernel: Streamline util library
c7376babd1 doc: Clarify distinction between util and common libraries in libraries.md (Ryan Ofsky)
4f74c59334 util: Move util/string.h functions to util namespace (Ryan Ofsky)
4d05d3f3b4 util: add TransactionError includes and namespace declarations (Ryan Ofsky)
680eafdc74 util: move fees.h and error.h to common/messages.h (Ryan Ofsky)
02e62c6c9a common: Add PSBTError enum (Ryan Ofsky)
0d44c44ae3 util: move error.h TransactionError enum to node/types.h (Ryan Ofsky)
9bcce2608d util: move spanparsing.h to script/parsing.h (Ryan Ofsky)
6dd2ad4792 util: move spanparsing.h Split functions to string.h (Ryan Ofsky)
23cc8ddff4 util: move HexStr and HexDigit from util to crypto (TheCharlatan)
6861f954f8 util: move util/message to common/signmessage (Ryan Ofsky)
cc5f29fbea build: move memory_cleanse from util to crypto (Ryan Ofsky)
5b9309420c build: move chainparamsbase from util to common (Ryan Ofsky)
ffa27af24d test: Add check-deps.sh script to check for unexpected library dependencies (Ryan Ofsky)

Pull request description:

  Remove `fees.h`, `errors.h`, and `spanparsing.h` from the util library. Specifically:

  - Move `Split` functions from `util/spanparsing.h` to `util/string.h`, using `util` namespace for clarity.
  - Move remaining spanparsing functions to `script/parsing.h` since they are used for descriptor and miniscript parsing.
  - Combine `util/fees.h` and `util/errors.h` into `common/messages.h` so there is a place for simple functions that generate user messages to live, and these functions are not part of the util library.

  Motivation for this change is that the util library is a dependency of the kernel, and we should remove functionality from util that shouldn't be called by kernel code or kernel applications. These changes should also improve code organization and make functions easier to discover. Some of these same moves are (or were) part of #28690, but did not help with code organization, or made it worse, so it is better to move them and clean them up in the same PR so code only has to change one time.

ACKs for top commit:
  achow101:
    ACK c7376babd1
  TheCharlatan:
    Re-ACK c7376babd1
  hebasto:
    re-ACK c7376babd1.

Tree-SHA512: 5bcef16c1255463b1b69270548711e7ff78ca0dd34e300b95e3ca1ce52ceb34f83d9ddb2839e83800ba36b200de30396e504bbb04fa02c6d0c24a16d06ae523d
2024-06-12 17:12:54 -04:00
..
forms Merge bitcoin-core/gui#788: debugwindow: update session ID tooltip 2024-05-11 19:13:34 +01:00
locale qt: 27.0 translations update 2024-03-04 10:02:26 +00:00
res scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
test scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
addressbookpage.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
addressbookpage.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
addresstablemodel.cpp refactor: Drop util::Result operator= 2024-04-25 16:08:24 -04:00
addresstablemodel.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
askpassphrasedialog.cpp Merge bitcoin-core/gui#722: wallet: Allow user to navigate options while encrypting at creation 2024-05-15 18:41:15 +01:00
askpassphrasedialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
bantablemodel.cpp gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bantablemodel.h gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bitcoin.cpp util: Move util/string.h functions to util namespace 2024-05-16 10:16:08 -05:00
bitcoin.h scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
bitcoin.qrc
bitcoin_locale.qrc qt: 27.0 translations update 2024-03-04 10:02:26 +00:00
bitcoinaddressvalidator.cpp
bitcoinaddressvalidator.h
bitcoinamountfield.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
bitcoinamountfield.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
bitcoingui.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
bitcoingui.h scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
bitcoinstrings.cpp qt: Update translation source file for v27.0 string freeze 2024-02-13 11:11:52 +00:00
bitcoinunits.cpp qt, refactor: Remove default cases for scoped enum 2022-02-22 13:50:30 -08:00
bitcoinunits.h qt, refactor: Remove BitcoinUnits::valid function 2022-02-22 13:50:30 -08:00
clientmodel.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
clientmodel.h refactor: gui, simplify boost signals disconnection 2024-02-29 14:40:01 -03:00
coincontroldialog.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
coincontroldialog.h qt: remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-03 18:06:48 +02:00
coincontroltreewidget.cpp
coincontroltreewidget.h
createwalletdialog.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
createwalletdialog.h gui: remove legacy wallet creation 2023-10-06 17:20:54 -03:00
csvmodelwriter.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
csvmodelwriter.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
editaddressdialog.cpp wallet: Replace use of purpose strings with an enum 2023-04-11 15:55:31 -04:00
editaddressdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
guiconstants.h Merge bitcoin-core/gui#553: Change address / amount error background 2024-02-07 18:03:11 +00:00
guiutil.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
guiutil.h [net processing] Move nTimeOffset to net_processing 2024-04-10 16:15:46 +02:00
initexecutor.cpp refactor: Extract util/exception from util/system 2023-03-13 17:09:47 +01:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
intro.h GUI/Intro: Never change the prune checkbox after the user has touched it 2023-06-29 23:24:39 +00:00
macdockiconhandler.h
macdockiconhandler.mm
macnotificationhandler.h
macnotificationhandler.mm
macos_appnap.h
macos_appnap.mm
main.cpp refactor: Remove hooking code for urlDecode 2024-04-24 23:23:38 +02:00
Makefile
modaloverlay.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
modaloverlay.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
networkstyle.cpp scripted-diff: Remove unused chainparamsbase includes 2023-05-09 15:49:19 +02:00
networkstyle.h refactor: Replace string chain name constants with ChainTypes 2023-05-09 15:49:14 +02:00
notificator.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
notificator.h scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
openuridialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
openuridialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
optionsdialog.cpp Merge bitcoin-core/gui#813: Don't permit port in proxy IP option 2024-05-11 19:34:12 +01:00
optionsdialog.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
optionsmodel.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
optionsmodel.h GUI: OptionsDialog: Replace verbose two-option font selector with simple combobox with Custom... choice 2023-07-21 17:47:17 +00:00
overviewpage.cpp GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
overviewpage.h GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
paymentserver.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
paymentserver.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
peertablemodel.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablemodel.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablesortproxy.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
peertablesortproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.cpp clang-tidy: Add performance-no-automatic-move check 2022-12-27 15:25:51 +00:00
platformstyle.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
psbtoperationsdialog.cpp util: add TransactionError includes and namespace declarations 2024-05-16 10:16:08 -05:00
psbtoperationsdialog.h qt, refactor: Drop superfluous type conversions 2023-10-23 15:06:29 +01:00
qrimagewidget.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
qrimagewidget.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvalidatedlineedit.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvalidatedlineedit.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvaluecombobox.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvaluecombobox.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
README.md
receivecoinsdialog.cpp GUI: Support translating address type dropdown entries 2023-03-31 12:21:11 +01:00
receivecoinsdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
receiverequestdialog.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
receiverequestdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
recentrequeststablemodel.cpp util: Move util/string.h functions to util namespace 2024-05-16 10:16:08 -05:00
recentrequeststablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
rpcconsole.cpp util: Move util/string.h functions to util namespace 2024-05-16 10:16:08 -05:00
rpcconsole.h scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
sendcoinsdialog.cpp util: add TransactionError includes and namespace declarations 2024-05-16 10:16:08 -05:00
sendcoinsdialog.h Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
sendcoinsentry.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
sendcoinsentry.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
sendcoinsrecipient.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
signverifymessagedialog.cpp util: move util/message to common/signmessage 2024-05-16 11:16:08 -04:00
signverifymessagedialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
splashscreen.cpp scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes 2024-05-01 08:33:04 +02:00
splashscreen.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
trafficgraphwidget.cpp clang-tidy: Add performance-type-promotion-in-math-fn check 2023-03-26 20:18:03 +01:00
trafficgraphwidget.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
transactiondesc.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
transactiondesc.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactiondescdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactiondescdialog.h
transactionfilterproxy.cpp Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionfilterproxy.h Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionoverviewwidget.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionoverviewwidget.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionrecord.cpp Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactionrecord.h Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactiontablemodel.cpp doc: fix typos 2023-11-07 10:21:51 +09:00
transactiontablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
transactionview.cpp gui: fix crash on selecting "Mask values" in transaction view 2023-10-31 00:27:26 +01:00
transactionview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
utilitydialog.cpp Merge bitcoin/bitcoin#29658: Bugfix: GUI: Help messages already have a trailing newline, so don't add an extra one 2024-05-12 14:21:21 +01:00
utilitydialog.h
walletcontroller.cpp util: Move util/string.h functions to util namespace 2024-05-16 10:16:08 -05:00
walletcontroller.h Merge bitcoin-core/gui#738: Add menu option to migrate a wallet 2023-09-20 22:32:31 +01:00
walletframe.cpp refactor: Move fs.* to util/fs.* 2023-03-23 12:55:18 +01:00
walletframe.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodel.cpp util: add TransactionError includes and namespace declarations 2024-05-16 10:16:08 -05:00
walletmodel.h wallet: return and display signer error 2024-04-16 17:47:43 +02:00
walletmodeltransaction.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
walletmodeltransaction.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
walletview.cpp refactor: Avoid implicit-integer-sign-change in processNewTransaction 2024-03-21 19:40:55 +01:00
walletview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
winshutdownmonitor.cpp refactor: Remove call to StartShutdown from qt 2023-12-04 15:39:15 -04:00
winshutdownmonitor.h qt: Avoid non-self-contained Windows header 2024-01-25 10:26:26 +00:00

This directory contains the source code for the Bitcoin Core graphical user interface (GUI). It uses the Qt cross-platform framework.

The current precise version for Qt 5 is specified in qt.mk.

Compile and run

See build instructions: Unix, macOS, Windows, FreeBSD, NetBSD, OpenBSD

When following your systems build instructions, make sure to install the Qt dependencies.

To run:

./src/qt/bitcoin-qt

Files and Directories

forms/

  • A directory that contains Designer UI files. These files specify the characteristics of form elements in XML. Qt UI files can be edited with Qt Creator or using any text editor.

locale/

  • Contains translations. They are periodically updated and an effort is made to support as many languages as possible. The process of contributing translations is described in doc/translation_process.md.

res/

  • Contains graphical resources used to enhance the UI experience.

test/

  • Functional tests used to ensure proper functionality of the GUI. Significant changes to the GUI code normally require new or updated tests.

bitcoingui.(h/cpp)

  • Represents the main window of the Bitcoin UI.

*model.(h/cpp)

  • The model. When it has a corresponding controller, it generally inherits from QAbstractTableModel. Models that are used by controllers as helpers inherit from other Qt classes like QValidator.
  • ClientModel is used by the main application bitcoingui and several models like peertablemodel.

*page.(h/cpp)

  • A controller. :NAMEpage.cpp generally includes :NAMEmodel.h and forms/:NAME.page.ui with a similar :NAME.

*dialog.(h/cpp)

  • Various dialogs, e.g. to open a URL. Inherit from QDialog.

paymentserver.(h/cpp)

  • (Deprecated) Used to process BIP21 payment URI requests. Also handles URI-based application switching (e.g. when following a bitcoin:... link from a browser).

walletview.(h/cpp)

  • Represents the view to a single wallet.

Other .h/cpp files

  • UI elements like BitcoinAmountField, which inherit from QWidget.
  • bitcoinstrings.cpp: automatically generated
  • bitcoinunits.(h/cpp): BTC / mBTC / etc. handling
  • callback.h
  • guiconstants.h: UI colors, app name, etc.
  • guiutil.h: several helper functions
  • macdockiconhandler.(h/mm): macOS dock icon handler
  • macnotificationhandler.(h/mm): display notifications in macOS

Contribute

See CONTRIBUTING.md for general guidelines.

Note: Do not change local/bitcoin_en.ts. It is updated automatically.

Using Qt Creator as an IDE

Qt Creator is a powerful tool which packages a UI designer tool (Qt Designer) and a C++ IDE into one application. This is especially useful if you want to change the UI layout.

Download Qt Creator

On Unix and macOS, Qt Creator can be installed through your package manager. Alternatively, you can download a binary from the Qt Website.

Note: If installing from a binary grabbed from the Qt Website: During the installation process, uncheck everything except for Qt Creator.

macOS
brew install qt-creator
Ubuntu & Debian
sudo apt-get install qtcreator

Setup Qt Creator

  1. Make sure you've installed all dependencies specified in your systems build instructions
  2. Follow the compile instructions for your system, run ./configure with the --enable-debug flag
  3. Start Qt Creator. At the start page, do: New -> Import Project -> Import Existing Project
  4. Enter bitcoin-qt as the Project Name and enter the absolute path to src/qt as Location
  5. Check over the file selection, you may need to select the forms directory (necessary if you intend to edit *.ui files)
  6. Confirm the Summary page
  7. In the Projects tab, select Manage Kits...

macOS

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "Clang (x86 64bit in /usr/bin)"
  • Under Debuggers: select "LLDB" as debugger (you might need to set the path to your LLDB installation)

Ubuntu & Debian

Note: Some of these options may already be set

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "GCC (x86 64bit in /usr/bin)"
  • Under Debuggers: select "GDB" as debugger
  1. While in the Projects tab, ensure that you have the bitcoin-qt executable specified under Run
  • If the executable is not specified: click "Choose...", navigate to src/qt, and select bitcoin-qt
  1. You're all set! Start developing, building, and debugging the Bitcoin Core GUI