gui: Refactor AddressType from ReceiveCoinsDialog

Extract and refactor ui->addressType combo content filling into GUIUtil,
having the translated descriptions in one place and allowing other Qt widget
containers to easily create similar combo boxes with customizable tooltips
per item and default selected item, both specified by the caller.

Author: pablomartin4btc

src/qt/guiutil.cpp

@@ -37,6 +37,7 @@
 #include <QAbstractItemView>
 #include <QApplication>
 #include <QClipboard>
+#include <QComboBox>
 #include <QDateTime>
 #include <QDesktopServices>
 #include <QDialog>
@@ -87,6 +88,14 @@ using namespace std::chrono_literals;
 
 namespace GUIUtil {
 
+std::map<OutputType, OutputTypeInfo> outputTypeDescriptionsMap(){
+    return {
+        {OutputType::LEGACY, {QObject::tr("Base58 (Legacy)"), false}},
+        {OutputType::P2SH_SEGWIT, {QObject::tr("Base58 (P2SH-SegWit)"), false}},
+        {OutputType::BECH32, {QObject::tr("Bech32 (SegWit)"), false}},
+        {OutputType::BECH32M, {QObject::tr("Bech32m (Taproot)"), true}}};
+}
+
 QString dateTimeStr(const QDateTime &date)
 {
     return QLocale::system().toString(date.date(), QLocale::ShortFormat) + QString(" ") + date.toString("hh:mm");
@@ -1008,6 +1017,33 @@ void ShowModalDialogAsynchronously(QDialog* dialog)
     dialog->show();
 }
 
+void AddItemsToAddressTypeCombo(QComboBox* addressType, bool taprootEnabled, const std::map<OutputType, QString>& outputTypeTooltipsMap, std::optional<OutputType> defaultType)
+{
+    auto add_address_type = [&](OutputType type, QString description) {
+        const auto index{addressType->count()};
+        // getting the tooltip (provided by the caller) that will be displayed on the item in the combo
+        QString tooltip{};
+        auto it{outputTypeTooltipsMap.find(type)};
+        // if can't find it no tooltip will be displayed
+        if (it != outputTypeTooltipsMap.end()) tooltip = it->second;
+        addressType->addItem(description, static_cast<int>(type));
+        addressType->setItemData(index, tooltip, Qt::ToolTipRole);
+        // setting default selected value for the combo if it has been passed
+        if (defaultType.has_value() && defaultType.value() == type) addressType->setCurrentIndex(index);
+    };
+
+    // Adding all output types defined in the map to the combo
+    for (const auto& pair : outputTypeDescriptionsMap()) {
+        OutputType type{pair.first};
+        OutputTypeInfo typeInfo{pair.second};
+        // if it requires taproot check it with arg taprootEnabled
+        // eg call from receivecoindialog.cpp
+        if ((!typeInfo.requiresTaprootEnabled) || (typeInfo.requiresTaprootEnabled == taprootEnabled)) {
+            add_address_type(type, typeInfo.description);
+        }
+    }
+}
+
 QString WalletDisplayName(const QString& name)
 {
     return name.isEmpty() ? "[" + QObject::tr("default wallet") + "]" : name;
@@ -1017,4 +1053,32 @@ QString WalletDisplayName(const std::string& name)
 {
     return WalletDisplayName(QString::fromStdString(name));
 }
+
+void AddItemsToAddressTypeCombo(QComboBox* addressType, bool taprootEnabled, const std::map<OutputType, QString>& outputTypeTooltipsMap, std::optional<OutputType> defaultType)
+{
+    auto add_address_type = [&](OutputType type, QString description) {
+        const auto index{addressType->count()};
+        // getting the tooltip (provided by the caller) that will be displayed on the item in the combo
+        QString tooltip{};
+        auto it{outputTypeTooltipsMap.find(type)};
+        // if can't find it no tooltip will be displayed
+        if (it != outputTypeTooltipsMap.end()) tooltip = it->second;
+        addressType->addItem(description, static_cast<int>(type));
+        addressType->setItemData(index, tooltip, Qt::ToolTipRole);
+        // setting default selected value for the combo if it has been passed
+        if (defaultType.has_value() && defaultType.value() == type) addressType->setCurrentIndex(index);
+    };
+
+    // Adding all output types defined in the map to the combo
+    for (const auto& pair : outputTypeDescriptionsMap()) {
+        OutputType type{pair.first};
+        OutputTypeInfo typeInfo{pair.second};
+        // if it requires taproot check it with arg taprootEnabled
+        // eg call from receivecoindialog.cpp
+        if ((!typeInfo.requiresTaprootEnabled) || (typeInfo.requiresTaprootEnabled == taprootEnabled)) {
+            add_address_type(type, typeInfo.description);
+        }
+    }
+}
+
 } // namespace GUIUtil

src/qt/guiutil.h

@@ -8,6 +8,7 @@
 #include <consensus/amount.h>
 #include <net.h>
 #include <netaddress.h>
+#include <outputtype.h>
 #include <util/check.h>
 #include <util/fs.h>
 
@@ -40,6 +41,7 @@ QT_BEGIN_NAMESPACE
 class QAbstractButton;
 class QAbstractItemView;
 class QAction;
+class QComboBox;
 class QDateTime;
 class QDialog;
 class QFont;
@@ -439,6 +441,13 @@ namespace GUIUtil
     QString WalletDisplayName(const std::string& name);
     QString WalletDisplayName(const QString& name);
 
+    struct OutputTypeInfo {
+        const QString description;
+        const bool requiresTaprootEnabled;
+    };
+    std::map<OutputType, OutputTypeInfo> outputTypeDescriptionsMap();
+
+    void AddItemsToAddressTypeCombo(QComboBox* addressType, bool taprootEnabled, const std::map<OutputType, QString>& outputTypeTooltipsMap, std::optional<OutputType> defaultType = std::nullopt);
 } // namespace GUIUtil
 
 #endif // BITCOIN_QT_GUIUTIL_H

src/qt/receivecoinsdialog.cpp

@@ -86,19 +86,15 @@ void ReceiveCoinsDialog::setModel(WalletModel *_model)
             &QItemSelectionModel::selectionChanged, this,
             &ReceiveCoinsDialog::recentRequestsView_selectionChanged);
 
+        /** Tooltip for each address type that will be displayed on the combo*/
+        std::map<OutputType, QString> addressTypeTooltipMap{
+            {OutputType::LEGACY, QObject::tr("Not recommended due to higher fees and less protection against typos.")},
+            {OutputType::P2SH_SEGWIT, QObject::tr("Generates an address compatible with older wallets.")},
+            {OutputType::BECH32, QObject::tr("Generates a native segwit address (BIP-173). Some old wallets don't support it.")},
+            {OutputType::BECH32M, QObject::tr("Bech32m (BIP-350) is an upgrade to Bech32, wallet support is still limited.")}};
+
         // Populate address type dropdown and select default
-        auto add_address_type = [&](OutputType type, const QString& text, const QString& tooltip) {
-            const auto index = ui->addressType->count();
-            ui->addressType->addItem(text, (int) type);
-            ui->addressType->setItemData(index, tooltip, Qt::ToolTipRole);
-            if (model->wallet().getDefaultAddressType() == type) ui->addressType->setCurrentIndex(index);
-        };
-        add_address_type(OutputType::LEGACY, tr("Base58 (Legacy)"), tr("Not recommended due to higher fees and less protection against typos."));
-        add_address_type(OutputType::P2SH_SEGWIT, tr("Base58 (P2SH-SegWit)"), tr("Generates an address compatible with older wallets."));
-        add_address_type(OutputType::BECH32, tr("Bech32 (SegWit)"), tr("Generates a native segwit address (BIP-173). Some old wallets don't support it."));
-        if (model->wallet().taprootEnabled()) {
-            add_address_type(OutputType::BECH32M, tr("Bech32m (Taproot)"), tr("Bech32m (BIP-350) is an upgrade to Bech32, wallet support is still limited."));
-        }
+        GUIUtil::AddItemsToAddressTypeCombo(ui->addressType, model->wallet().taprootEnabled(), addressTypeTooltipMap, model->wallet().getDefaultAddressType());
 
         // Set the button to be enabled or disabled based on whether the wallet can give out new addresses.
         ui->receiveButton->setEnabled(model->wallet().canGetAddresses());