elements/src/qt
MacroFake 316afb1eca
Merge bitcoin/bitcoin#25218: refactor: introduce generic 'Result' class and connect it to CreateTransaction and GetNewDestination
111ea3ab71 wallet: refactor GetNewDestination, use BResult (furszy)
22351725bc send: refactor CreateTransaction flow to return a BResult<CTransactionRef> (furszy)
198fcca162 wallet: refactor, include 'FeeCalculation' inside 'CreatedTransactionResult' (furszy)
7a45c33d1f Introduce generic 'Result' class (furszy)

Pull request description:

  Based on a common function signature pattern that we have all around the sources:
  ```cpp
  bool doSomething(arg1, arg2, arg3, arg4, &result_obj, &error_string) {
      // do something...
      if (error) {
          error_string = "something bad happened";
          return false;
      }

      result = goodResult;
      return true;
  }
  ```

  Introduced a generic class `BResult` that encapsulate the function boolean result, the result object (in case of having it) and, in case of failure, the string error reason.

  Obtaining in this way cleaner function signatures and removing boilerplate code:

  ```cpp
  BResult<Obj> doSomething(arg1, arg2, arg3, arg4) {
      // do something...
      if (error) return "something bad happened";

      return goodResult;
  }
  ```

  Same cleanup applies equally to the function callers' side as well. There is no longer need to add the error string and the result object declarations before calling the function:

  Before:
  ```cpp
  Obj result_obj;
  std::string error_string;
  if (!doSomething(arg1, arg2, arg3, arg4, result_obj, error_string)) {
      LogPrintf("Error: %s", error_string);
  }
  return result_obj;
  ```

  Now:
  ```cpp
  BResult<Obj> op_res = doSomething(arg1, arg2, arg3, arg4);
  if (!op_res) {
      LogPrintf("Error: %s", op_res.GetError());
  }
  return op_res.GetObjResult();
  ```

  ### Initial Implementation:

  Have connected this new concept to two different flows for now:

  1) The `CreateTransaction` flow. --> 7ba2b87c
  2) The `GetNewDestination` flow. --> bcee0912

  Happy note: even when introduced a new class into the sources, the amount of lines removed is almost equal to added ones :).

  Extra note: this work is an extended version (and a decoupling) of the work that is inside #24845 (which does not contain the `GetNewDestination` changes nor the inclusion of the `FeeCalculation` field inside `CreatedTransactionResult`).

ACKs for top commit:
  achow101:
    ACK 111ea3ab71
  w0xlt:
    reACK https://github.com/bitcoin/bitcoin/pull/25218/commits/111ea3ab711414236f8678566a7884d48619b2d8
  theStack:
    re-ACK 111ea3ab71
  MarcoFalke:
    review ACK 111ea3ab71 🎏

Tree-SHA512: 6d84d901a4cb923727067f25ff64542a40edd1ea84fdeac092312ac684c34e3688a52ac5eb012717d2b73f4cb742b9d78e458eb0e9cb9d6d72a916395be91f69
2022-07-12 13:56:48 +02:00
..
android qt: Drop no longer supported Android architecture 2022-06-04 11:42:26 +02:00
forms Merge bitcoin-core/gui#612: refactor: Drop unused QFrames in SendCoinsEntry 2022-06-21 12:17:30 +02:00
locale qt: Pre-branch translation updates for 23.x 2022-02-28 16:59:56 +01:00
res scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
test Merge bitcoin/bitcoin#25036: wallet: Save wallet scan progress 2022-07-12 08:02:22 +02:00
addressbookpage.cpp qt: Use QRegularExpression in AddressBookSortFilterProxyModel class 2022-05-21 17:44:57 +02:00
addressbookpage.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
addresstablemodel.cpp wallet: refactor GetNewDestination, use BResult 2022-07-08 11:18:35 -03:00
addresstablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
askpassphrasedialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
askpassphrasedialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bantablemodel.cpp refactor: use C++11 default initializers 2022-05-17 17:18:58 +01:00
bantablemodel.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
bitcoin.cpp qt6: Do not use deprecated high DPI attributes in Qt 6 2022-06-21 13:50:48 +02:00
bitcoin.h Migrate -dbcache setting from QSettings to settings.json 2022-05-26 11:05:10 -04:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: Pre-branch translation updates for 23.x 2022-02-28 16:59:56 +01:00
bitcoinaddressvalidator.cpp
bitcoinaddressvalidator.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoinamountfield.cpp Merge bitcoin-core/gui#579: Getting ready to Qt 6 (2/n). Remove QApplication::globalStrut() 2022-04-15 12:00:53 +02:00
bitcoinamountfield.h qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
bitcoingui.cpp Merge bitcoin-core/gui#471: Add Wallet Restore in the GUI 2022-07-10 20:43:54 +01:00
bitcoingui.h gui: Add Wallet Restore in the GUI 2022-06-27 10:00:18 -03:00
bitcoinstrings.cpp qt: English (source) translations update 2022-02-24 12:40:00 +01: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 qt, doc: Remove unneeded comments 2022-04-16 18:59:17 +02:00
clientmodel.h qt/clientmodel: thread safety annotation for m_cached_tip_mutex 2022-05-21 01:23:02 +10:00
coincontroldialog.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
coincontroldialog.h Add src/wallet/* code to wallet:: namespace 2022-01-06 22:14:16 -05:00
coincontroltreewidget.cpp
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
createwalletdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
csvmodelwriter.cpp
csvmodelwriter.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
editaddressdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
editaddressdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
guiconstants.h qt: Treat unconfirmed txs as unconfirmed 2022-01-14 11:24:58 +01:00
guiutil.cpp Merge bitcoin-core/gui#620: Replace QRegExp with QRegularExpression 2022-06-22 07:12:10 +02:00
guiutil.h qt: Add a function that extracts the suffix from a filter 2022-06-21 19:16:39 -03:00
initexecutor.cpp qt: Replace GUIUtil::ObjectInvoke() with QMetaObject::invokeMethod() 2022-04-16 19:18:25 +02:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp If -prune=0 is set, Uncheck Prune on Intro page 2022-06-15 12:24:08 -04:00
intro.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
macdockiconhandler.h
macdockiconhandler.mm qt: Replace objc_msgSend with native syntax 2019-08-31 12:25:34 +03:00
macnotificationhandler.h
macnotificationhandler.mm scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
macos_appnap.h
macos_appnap.mm
main.cpp compat: Consolidate mingw-w64 ASLR workaround for upstream libsecp changes 2022-06-11 14:55:13 +01:00
Makefile Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
modaloverlay.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
modaloverlay.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
networkstyle.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
networkstyle.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
notificator.cpp Merge bitcoin-core/gui#594: scripted-diff: replace deprecated Q_OS_MAC with Q_OS_MACOS 2022-05-20 11:44:29 +02:00
notificator.h scripted-diff: replace deprecated Q_OS_MAC with Q_OS_MACOS 2022-04-26 01:13:29 +01: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 qt: apply translator comments to reset options confirmation dialog 2022-06-29 20:02:02 -04:00
optionsdialog.h gui: reset options, notify user about the backup creation 2022-06-28 10:29:08 -03:00
optionsmodel.cpp Reset settings.json when GUI options are reset 2022-05-26 11:05:10 -04:00
optionsmodel.h Migrate -prune setting from QSettings to settings.json 2022-05-26 11:05:10 -04:00
overviewpage.cpp refactor: use C++11 default initializers 2022-05-17 17:18:58 +01:00
overviewpage.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
paymentserver.cpp scripted-diff: Avoid incompatibility with CMake AUTOUIC feature 2022-06-14 10:38:51 +02:00
paymentserver.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
peertablemodel.cpp refactor: use C++11 default initializers 2022-05-17 17:18:58 +01:00
peertablemodel.h gui: add Age column to peers tab 2022-03-16 04:54:52 -04:00
peertablesortproxy.cpp gui: add Age column to peers tab 2022-03-16 04:54:52 -04:00
peertablesortproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
psbtoperationsdialog.cpp qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
psbtoperationsdialog.h [gui] PSBT Operations Dialog (sign & broadcast) 2020-06-19 02:20:04 -07:00
qrimagewidget.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
qrimagewidget.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvalidatedlineedit.cpp Merge bitcoin-core/gui#404: Fix various edge case bugs in QValidatedLineEdit 2022-02-09 06:23:44 +02:00
qvalidatedlineedit.h Merge bitcoin-core/gui#404: Fix various edge case bugs in QValidatedLineEdit 2022-02-09 06:23:44 +02:00
qvaluecombobox.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
qvaluecombobox.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
README.md Improve gui/src/qt README.md 2021-01-28 14:03:21 -05:00
receivecoinsdialog.cpp Merge bitcoin-core/gui#516: Change 'Show' icon 2022-01-04 12:55:29 +02:00
receivecoinsdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
receiverequestdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
receiverequestdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
recentrequeststablemodel.cpp refactor: use C++11 default initializers 2022-05-17 17:18:58 +01:00
recentrequeststablemodel.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
rpcconsole.cpp qt: Remove unnecessary wallet includes from rpcconsole.cpp 2022-06-02 18:17:33 +02:00
rpcconsole.h Do not pass WalletModel* to queued connection 2022-04-21 14:04:56 +02:00
sendcoinsdialog.cpp scripted-diff: Avoid incompatibility with CMake AUTOUIC feature 2022-06-14 10:38:51 +02:00
sendcoinsdialog.h gui: restore Send for external signer 2022-03-16 10:28:39 +01:00
sendcoinsentry.cpp qt, refactor: Convert SendCoinsEntry to a sub-QWidget 2022-06-12 13:40:46 +02:00
sendcoinsentry.h qt, refactor: Convert SendCoinsEntry to a sub-QWidget 2022-06-12 13:40:46 +02:00
sendcoinsrecipient.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
signverifymessagedialog.cpp doc: Convert remaining comments to clang-tidy format 2022-04-06 15:37:07 +02:00
signverifymessagedialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
splashscreen.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
splashscreen.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
trafficgraphwidget.cpp qt,refactor: Use std::chrono in TrafficGraphWidget class 2022-01-18 20:03:50 +05:30
trafficgraphwidget.h qt,refactor: Use std::chrono in TrafficGraphWidget class 2022-01-18 20:03:50 +05:30
transactiondesc.cpp qt, refactor: add translator comments in TransactionDesc::FormatTxStatus() 2022-06-02 13:56:36 -03:00
transactiondesc.h Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
transactiondescdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactiondescdialog.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
transactionfilterproxy.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactionfilterproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactionoverviewwidget.cpp qt, refactor: Add transactionoverviewwidget.cpp source file 2022-06-14 16:55:22 +02:00
transactionoverviewwidget.h qt, refactor: Add transactionoverviewwidget.cpp source file 2022-06-14 16:55:22 +02:00
transactionrecord.cpp qt: Treat unconfirmed txs as unconfirmed 2022-01-14 11:24:58 +01:00
transactionrecord.h qt, refactor: Use member initializers in TransactionStatus 2022-04-13 12:24:37 -03:00
transactiontablemodel.cpp refactor: use C++11 default initializers 2022-05-17 17:18:58 +01:00
transactiontablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactionview.cpp scripted-diff: Avoid incompatibility with CMake AUTOUIC feature 2022-06-14 10:38:51 +02:00
transactionview.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
utilitydialog.cpp qt: Replace QRegExp with QRegularExpression 2022-06-21 19:19:18 -03:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp gui: Add Wallet Restore in the GUI 2022-06-27 10:00:18 -03:00
walletcontroller.h gui: Add Wallet Restore in the GUI 2022-06-27 10:00:18 -03:00
walletframe.cpp scripted-diff: Avoid incompatibility with CMake AUTOUIC feature 2022-06-14 10:38:51 +02:00
walletframe.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodel.cpp send: refactor CreateTransaction flow to return a BResult<CTransactionRef> 2022-07-08 11:18:35 -03:00
walletmodel.h Merge bitcoin-core/gui#608: wallet, refactor: Make WalletModel::sendCoins() return void 2022-06-12 13:33:55 +02:00
walletmodeltransaction.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodeltransaction.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletview.cpp scripted-diff: Avoid incompatibility with CMake AUTOUIC feature 2022-06-14 10:38:51 +02:00
walletview.h qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
winshutdownmonitor.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
winshutdownmonitor.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02: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