bitcoin/src/qt
MarcoFalke c5966a87d1
Merge #18192: Bugfix: Wallet: Safely deal with change in the address book
b5795a7886 Wallet: Add warning comments and assert to CWallet::DelAddressBook (Luke Dashjr)
6d2905f57a Wallet: Avoid unnecessary/redundant m_address_book lookups (Luke Dashjr)
c751d886f4 Wallet: Avoid treating change-in-the-addressbook as non-change everywhere (Luke Dashjr)
8e64b8c84b Wallet: New FindAddressBookEntry method to filter out change entries (and skip ->second everywhere) (Luke Dashjr)
65b6bdc2b1 Wallet: Add CAddressBookData::IsChange which returns true iff label has never been set (Luke Dashjr)
144b2f85da Wallet: Require usage of new CAddressBookData::setLabel to change label (Luke Dashjr)
b86cd155f6 scripted-diff: Wallet: Rename mapAddressBook to m_address_book (Luke Dashjr)

Pull request description:

  In many places, our code assumes that presence in the address book indicates a non-change key, and absence of an entry in mapAddressBook indicates change.

  This no longer holds true after #13756 (first released in 0.19) since it added a "used" DestData populated even for change addresses. Only avoid-reuse wallets should be affected by this issue.

  Thankfully, populating DestData does not write a label to the database, so we can retroactively fix this (so long as the user didn't see the change address and manually assign it a real label).

  Fixing it is accomplished by:

  * Adding a new bool to CAddressBookData to track if the label has ever been assigned, either by loading one from the database, or by assigning one at runtime.
  * `CAddressBookData::IsChange` and `CWallet::FindAddressBookEntry` are new methods to assist in excluding change from code that doesn't expect to see them.
  * For safety in merging, `CAddressBookData::name` has been made read-only (the actual data is stored in `m_label`, a new private member, and can be changed only with `setLabel` which updates the `m_change` flag), and `mapAddressBook` has been renamed to `m_address_book` (to force old code to be rebased to compile).

  A final commit also does some minor optimisation, avoiding redundant lookups in `m_address_book` when we already have a pointer to the `CAddressBookData`.

ACKs for top commit:
  ryanofsky:
    Code review ACK b5795a7886. Pretty clever and nicely implemented fix!
  jonatack:
    ACK b5795a7886 nice improvements -- code review, built/ran tests rebased on current master ff53433fe4 and tested manually with rpc/cli
  jnewbery:
    Good fix. utACK b5795a788.

Tree-SHA512: 40525185a0bcc1723f602243c269499ec86ecb298fecb5ef24d626bbdd5e3efece86cdb1084ad7eebf7eeaf251db4a6e056bcd25bc8457b417fcbb53d032ebf0
2020-04-07 03:51:18 +08:00
..
forms gui: avoid QT Designer/Form Editor re-formatting 2020-03-24 14:04:16 +01:00
locale qt: Translations update pre-branch 2020-04-01 12:49:15 +02:00
res scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
test scripted-diff: Wallet: Rename mapAddressBook to m_address_book 2020-04-02 16:00:28 +00:00
addressbookpage.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
addressbookpage.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
addresstablemodel.cpp Wallet: Avoid treating change-in-the-addressbook as non-change everywhere 2020-04-02 16:25:17 +00:00
addresstablemodel.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
askpassphrasedialog.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
askpassphrasedialog.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
bantablemodel.cpp gui: Drop BanTableModel dependency to ClientModel 2020-01-31 08:18:27 +00:00
bantablemodel.h gui: Drop BanTableModel dependency to ClientModel 2020-01-31 08:18:27 +00:00
bitcoin.cpp Revert "refactor: Simplify connection syntax" 2020-01-19 09:37:34 +02:00
bitcoin.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
bitcoin.qrc qt: Remove menu icons 2019-08-15 13:05:10 +02:00
bitcoin_locale.qrc qt: Translations update pre-branch 2020-04-01 12:49:15 +02:00
bitcoinaddressvalidator.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
bitcoinaddressvalidator.h
bitcoinamountfield.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
bitcoinamountfield.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
bitcoingui.cpp refactor: Get rid of Wallet::IsWalletFlagSet method 2020-03-19 15:26:04 -05:00
bitcoingui.h Revert "refactor: Remove never used default parameter" 2020-01-19 09:38:51 +02:00
bitcoinstrings.cpp qt: Periodical translations update 2020-03-16 10:51:11 +01:00
bitcoinunits.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
bitcoinunits.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
clientmodel.cpp gui: Throttle GUI update pace when -reindex 2020-02-12 23:51:41 +02:00
clientmodel.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
coincontroldialog.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
coincontroldialog.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
coincontroltreewidget.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
coincontroltreewidget.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
createwalletdialog.cpp gui: rename encrypt(), blank(), and askPasshprase() 2019-09-09 10:56:38 +02:00
createwalletdialog.h gui: rename encrypt(), blank(), and askPasshprase() 2019-09-09 10:56:38 +02:00
csvmodelwriter.cpp Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
csvmodelwriter.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
editaddressdialog.cpp Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
editaddressdialog.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
guiconstants.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
guiutil.cpp refactor: Convert ping wait time from double to int64_t 2020-03-04 13:45:29 -05:00
guiutil.h refactor: Convert ping wait time from double to int64_t 2020-03-04 13:45:29 -05:00
intro.cpp Merge #17453: gui: Fix intro dialog labels when the prune button is toggled 2020-01-27 18:15:45 +01:00
intro.h gui: Make Intro consistent with prune checkbox 2020-01-14 19:14:14 +02:00
macdockiconhandler.h Remove obj_c for macOS Dock icon menu 2018-11-04 02:42:18 +02:00
macdockiconhandler.mm qt: Replace objc_msgSend with native syntax 2019-08-31 12:25:34 +03:00
macnotificationhandler.h convert C-style (void) parameter lists to C++ style () 2018-09-13 10:36:41 -07:00
macnotificationhandler.mm scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
macos_appnap.h macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
macos_appnap.mm macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
main.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
Makefile
modaloverlay.cpp GUI: Use PACKAGE_NAME in modal overlay 2020-01-14 18:14:10 +00:00
modaloverlay.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
networkstyle.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
networkstyle.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
notificator.cpp Remove misplaced Q_UNUSED and others enhancements 2018-12-20 01:06:37 +02:00
notificator.h Remove misplaced Q_UNUSED and others enhancements 2018-12-20 01:06:37 +02:00
openuridialog.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
openuridialog.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
optionsdialog.cpp net: Avoid using C-style NUL-terminated strings as arguments in the netbase interface 2020-01-08 12:35:59 +00:00
optionsdialog.h Merge #13248: [gui] Make proxy icon from statusbar clickable 2018-08-20 13:40:11 +02:00
optionsmodel.cpp Replace std::to_string with locale-independent alternative 2020-03-14 12:23:01 -07:00
optionsmodel.h Merge #17453: gui: Fix intro dialog labels when the prune button is toggled 2020-01-27 18:15:45 +01:00
overviewpage.cpp refactor: Get rid of Wallet::IsWalletFlagSet method 2020-03-19 15:26:04 -05:00
overviewpage.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
paymentserver.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
paymentserver.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
peertablemodel.cpp refactor: Convert min ping time from double to int64_t 2020-03-04 13:44:57 -05:00
peertablemodel.h gui: Drop PeerTableModel dependency to ClientModel 2020-02-03 14:48:40 +00:00
platformstyle.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
platformstyle.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
qrimagewidget.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
qrimagewidget.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
qvalidatedlineedit.cpp Replace remaining 0 with nullptr in Qt code 2019-01-13 03:25:14 -08:00
qvalidatedlineedit.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
qvaluecombobox.cpp qt: Use new Qt5 connect syntax 2018-08-21 09:43:54 +01:00
qvaluecombobox.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
README.md Remove BIP70 Support 2019-10-24 16:01:43 -04:00
receivecoinsdialog.cpp refactor: Get rid of Wallet::IsWalletFlagSet method 2020-03-19 15:26:04 -05:00
receivecoinsdialog.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
receiverequestdialog.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
receiverequestdialog.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
recentrequeststablemodel.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
recentrequeststablemodel.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
rpcconsole.cpp gui: display Mapped AS in peers info window 2020-03-24 14:04:14 +01:00
rpcconsole.h gui: Make RPCConsole::TabTypes an enum class 2019-10-15 13:46:34 +01:00
sendcoinsdialog.cpp refactor: Change createWallet, fillPSBT argument order 2020-03-19 15:26:04 -05:00
sendcoinsdialog.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
sendcoinsentry.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
sendcoinsentry.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
sendcoinsrecipient.h refactor: Move SendCoinsRecipient in own header 2019-11-19 17:05:35 +02:00
signverifymessagedialog.cpp Move direct calls to MessageSign into new SignMessage functions in CWallet and ScriptPubKeyMan 2020-03-09 11:16:20 -04:00
signverifymessagedialog.h
splashscreen.cpp qt: Fix deprecated QCharRef usage 2020-02-09 18:59:14 +02:00
splashscreen.h Cleanup SplashScreen class 2018-12-02 01:26:28 +02:00
trafficgraphwidget.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
trafficgraphwidget.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
transactiondesc.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
transactiondesc.h Remove unused adjustedTime parameter 2018-10-28 09:04:10 +02:00
transactiondescdialog.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
transactiondescdialog.h scripted-diff: Bump copyright of files changed in 2020 2020-01-15 02:18:00 +07:00
transactionfilterproxy.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
transactionfilterproxy.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
transactionrecord.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
transactionrecord.h Don't label transactions "Open" while catching up 2019-01-03 00:10:24 +02:00
transactiontablemodel.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
transactiontablemodel.h Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
transactionview.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
transactionview.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
utilitydialog.cpp gui: Drop ShutdownWindow dependency to BitcoinGUI 2020-01-31 11:49:51 +00:00
utilitydialog.h gui: Drop ShutdownWindow dependency to BitcoinGUI 2020-01-31 11:49:51 +00:00
walletcontroller.cpp gui: Delete progress dialog instead of hidding it 2020-03-31 14:23:43 +01:00
walletcontroller.h gui: Delete progress dialog instead of hidding it 2020-03-31 14:23:43 +01:00
walletframe.cpp Qt: pass clientmodel changes from walletframe to walletviews 2020-02-07 18:40:38 +01:00
walletframe.h gui: Fix duplicate wallet showing up 2019-10-26 14:55:31 +01:00
walletmodel.cpp Merge #18160: gui: Avoid Wallet::GetBalance in WalletModel::pollBalanceChanged 2020-03-31 14:23:30 +02:00
walletmodel.h refactor: Get rid of Wallet::IsWalletFlagSet method 2020-03-19 15:26:04 -05:00
walletmodeltransaction.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
walletmodeltransaction.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
walletview.cpp gui: Remove WalletView and BitcoinGUI circular dependency 2020-01-30 11:38:06 +00:00
walletview.h gui: Fix unintialized WalletView::progressDialog 2020-02-03 20:05:04 +00:00
winshutdownmonitor.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
winshutdownmonitor.h Update copyright headers to 2018 2018-07-27 07:15:02 -04:00

This directory contains the BitcoinQT graphical user interface (GUI). It uses the cross-platform framework Qt.

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

Compile and run

See build instructions (macOS, Windows, Unix, etc).

To run:

./src/qt/bitcoin-qt

Files and directories

forms

Contains Designer UI files. They are created with Qt Creator, but can be edited using any text editor.

locale

Contains translations. They are periodically updated. The process is described here.

res

Resources such as the icon.

test

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)

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. Specifically for Qt:

Using Qt Creator as IDE

You can use Qt Creator as an IDE. This is especially useful if you want to change the UI layout.

Download and install the community edition of Qt Creator. Uncheck everything except Qt Creator during the installation process.

Instructions for macOS:

  1. Make sure you installed everything through Homebrew mentioned in the macOS build instructions
  2. Use ./configure with the --enable-debug flag
  3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
  4. Enter "bitcoin-qt" as project name, enter src/qt as location
  5. Leave the file selection as it is
  6. Confirm the "summary page"
  7. In the "Projects" tab select "Manage Kits..."
  8. Select the default "Desktop" kit and select "Clang (x86 64bit in /usr/bin)" as compiler
  9. Select LLDB as debugger (you might need to set the path to your installation)
  10. Start debugging with Qt Creator (you might need to the executable to "bitcoin-qt" under "Run", which is where you can also add command line arguments)