Issue 18: add send-review PSBT copy export flow

Author: johnny9

doc/test-automation-selectors.md

@@ -22,7 +22,7 @@ It supports the parity backlog Definition of Done (`DefinitionOfDone.md`) requir
 ## Current Examples
 
 - Receive flow: `receiveAmountInput`, `receiveLabelInput`, `receiveContactSelectButton`, `receiveContactsPopup`, `receiveContactsSearchInput`, `receiveContactRow`, `receiveContactSelectFirstActionButton`, `receiveContactUseButton`, `receiveCreateAddressButton`, `receiveCopySelectedUriButton`, `receiveQrImage`
-- Send flow: `sendAddressInput`, `sendOpenContactsButton`, `sendContactsPopup`, `sendContactsSearchInput`, `sendContactLabelInput`, `sendContactAddressInput`, `sendContactSaveButton`, `sendContactDeleteButton`, `sendContactUseButton`, `sendContinueButton`, `sendResultPopup`
+- Send flow: `sendAddressInput`, `sendOpenContactsButton`, `sendContactsPopup`, `sendContactsSearchInput`, `sendContactLabelInput`, `sendContactAddressInput`, `sendContactSaveButton`, `sendContactDeleteButton`, `sendContactUseButton`, `sendContinueButton`, `sendReviewCopyPsbtButton`, `sendReviewPsbtStatusText`, `multipleSendReviewCopyPsbtButton`, `multipleSendReviewPsbtStatusText`, `sendResultPopup`
 - Wallet tabs/pages: `walletSendPage`, `walletRequestPaymentPage`, `activityListView`, `activityOpenFirstRowActionButton`, `activityOpenRowAddressInput`, `activityOpenRowByAddressActionButton`, `activityDetailsPage`, `activityDetailsBackButton`
 - Activity RBF actions: `activityDetailsBumpButton`, `activityDetailsBumpPopup`, `activityDetailsBumpPreviewButton`, `activityDetailsBumpConfirmPopup`, `activityDetailsBumpConfirmButton`, `activityDetailsBumpDisabledReasonText`, `activityDetailsCancelButton`, `activityDetailsCancelPopup`, `activityDetailsCancelConfirmButton`, `activityDetailsRbfStatusText`, `activityDetailsReplacementTxidText`
 - Onboarding storage flow: `onboardingStorageAmountDetailedSettingsButton`, `storageSettingsPruneTargetInput`, `storageLocationDefaultOption`

qml/models/psbtoperationsadapter.cpp

@@ -4,9 +4,11 @@
 
 #include <qml/models/psbtoperationsadapter.h>
 
+#include <common/messages.h>
 #include <psbt.h>
 #include <streams.h>
 #include <util/strencodings.h>
+#include <util/translation.h>
 
 #include <QObject>
 
@@ -30,6 +32,12 @@ PsbtDecodeResult DecodeRawPayload(const std::vector<unsigned char>& payload)
     result.psbt = std::move(psbt);
     return result;
 }
+
+QString BuildFillPsbtError(const common::PSBTError error)
+{
+    return QObject::tr("Failed to create unsigned PSBT: %1")
+        .arg(QString::fromStdString(common::PSBTErrorString(error).translated));
+}
 } // namespace
 
 PsbtDecodeResult PsbtOperationsAdapter::DecodeClipboardBase64(const QString& base64_text)
@@ -94,6 +102,36 @@ PsbtDecodeResult PsbtOperationsAdapter::DecodeFilePayload(const QByteArray& payl
     return DecodeRawPayload(decode_payload);
 }
 
+PsbtCreateResult PsbtOperationsAdapter::CreateUnsignedPsbt(PsbtFillBackend& backend, const CTransactionRef& tx)
+{
+    if (!tx) {
+        return {
+            false,
+            QObject::tr("No transaction is available to export."),
+            QString{},
+            std::nullopt,
+        };
+    }
+
+    PartiallySignedTransaction psbt{CMutableTransaction{*tx}};
+    bool complete{false};
+    const auto maybe_error = backend.fillUnsigned(psbt, complete);
+    if (maybe_error.has_value()) {
+        return {
+            false,
+            BuildFillPsbtError(*maybe_error),
+            QString{},
+            std::nullopt,
+        };
+    }
+
+    PsbtCreateResult result;
+    result.success = true;
+    result.psbt = psbt;
+    result.base64 = EncodeBase64(psbt);
+    return result;
+}
+
 QString PsbtOperationsAdapter::EncodeBase64(const PartiallySignedTransaction& psbt)
 {
     DataStream stream{};

qml/models/psbtoperationsadapter.h

@@ -5,6 +5,8 @@
 #ifndef BITCOIN_QML_MODELS_PSBTOPERATIONSADAPTER_H
 #define BITCOIN_QML_MODELS_PSBTOPERATIONSADAPTER_H
 
+#include <common/types.h>
+#include <primitives/transaction.h>
 #include <psbt.h>
 
 #include <optional>
@@ -19,13 +21,28 @@ struct PsbtDecodeResult {
     std::optional<PartiallySignedTransaction> psbt;
 };
 
+struct PsbtCreateResult {
+    bool success{false};
+    QString message;
+    QString base64;
+    std::optional<PartiallySignedTransaction> psbt;
+};
+
+class PsbtFillBackend
+{
+public:
+    virtual ~PsbtFillBackend() = default;
+    virtual std::optional<common::PSBTError> fillUnsigned(PartiallySignedTransaction& psbt, bool& complete) = 0;
+};
+
 class PsbtOperationsAdapter
 {
 public:
     static constexpr qint64 MAX_PSBT_FILE_SIZE_BYTES{100 * 1024 * 1024};
 
     static PsbtDecodeResult DecodeClipboardBase64(const QString& base64_text);
     static PsbtDecodeResult DecodeFilePayload(const QByteArray& payload, qint64 file_size_bytes = -1);
+    static PsbtCreateResult CreateUnsignedPsbt(PsbtFillBackend& backend, const CTransactionRef& tx);
 
     static QString EncodeBase64(const PartiallySignedTransaction& psbt);
     static QByteArray EncodeRaw(const PartiallySignedTransaction& psbt);

qml/models/walletqmlmodel.cpp

@@ -7,6 +7,7 @@
 
 #include <qml/models/activitylistmodel.h>
 #include <qml/models/paymentrequest.h>
+#include <qml/models/psbtoperationsadapter.h>
 #include <qml/models/sendrecipient.h>
 #include <qml/models/sendrecipientslistmodel.h>
 #include <qml/models/transactionrbfadapter.h>
@@ -97,6 +98,28 @@ class WalletTransactionRbfBackend final : public TransactionRbfBackend
     interfaces::Wallet& m_wallet;
 };
 
+class WalletPsbtFillBackend final : public PsbtFillBackend
+{
+public:
+    explicit WalletPsbtFillBackend(interfaces::Wallet& wallet)
+        : m_wallet(wallet)
+    {
+    }
+
+    std::optional<common::PSBTError> fillUnsigned(PartiallySignedTransaction& psbt, bool& complete) override
+    {
+        return m_wallet.fillPSBT(std::nullopt,
+                                 /*sign=*/false,
+                                 /*bip32derivs=*/true,
+                                 /*n_signed=*/nullptr,
+                                 psbt,
+                                 complete);
+    }
+
+private:
+    interfaces::Wallet& m_wallet;
+};
+
 QVariantMap BuildRbfResultMap(const TransactionRbfActionResult& result)
 {
     QVariantMap payload;
@@ -506,6 +529,32 @@ bool WalletQmlModel::prepareTransaction()
     return true;
 }
 
+QVariantMap WalletQmlModel::createUnsignedPsbt()
+{
+    QVariantMap payload;
+    if (!m_wallet) {
+        payload[QStringLiteral("success")] = false;
+        payload[QStringLiteral("message")] = tr("No wallet is loaded.");
+        return payload;
+    }
+
+    if (!m_current_transaction || !m_current_transaction->getWtx()) {
+        payload[QStringLiteral("success")] = false;
+        payload[QStringLiteral("message")] = tr("No transaction is available to export.");
+        return payload;
+    }
+
+    WalletPsbtFillBackend backend(*m_wallet);
+    const PsbtCreateResult result = PsbtOperationsAdapter::CreateUnsignedPsbt(backend, m_current_transaction->getWtx());
+
+    payload[QStringLiteral("success")] = result.success;
+    payload[QStringLiteral("message")] = result.success
+        ? tr("PSBT copied to clipboard.")
+        : result.message;
+    payload[QStringLiteral("psbtBase64")] = result.base64;
+    return payload;
+}
+
 void WalletQmlModel::sendTransaction()
 {
     if (!m_wallet || !m_current_transaction) {

qml/models/walletqmlmodel.h

@@ -66,6 +66,7 @@ class WalletQmlModel : public QObject, public WalletBalanceProvider
     ReceiveRequestHistoryModel* receiveRequests() const { return m_receive_requests; }
     WalletQmlModelTransaction* currentTransaction() const { return m_current_transaction; }
     Q_INVOKABLE bool prepareTransaction();
+    Q_INVOKABLE QVariantMap createUnsignedPsbt();
     Q_INVOKABLE void sendTransaction();
     Q_INVOKABLE QString newAddress(QString label);
     bool isEncrypted() const;

qml/pages/wallet/MultipleSendReview.qml

@@ -17,6 +17,8 @@ Page {
 
     property WalletQmlModel wallet: walletController.selectedWallet
     property WalletQmlModelTransaction transaction: walletController.selectedWallet.currentTransaction
+    property string psbtStatusMessage: ""
+    property bool psbtStatusSuccess: true
 
     signal finished()
     signal back()
@@ -149,6 +151,34 @@ Page {
                 color: Theme.color.neutral3
             }
 
+            OutlineButton {
+                objectName: "multipleSendReviewCopyPsbtButton"
+                Layout.fillWidth: true
+                text: qsTr("Copy PSBT")
+                onClicked: {
+                    if (!root.wallet || !root.wallet.createUnsignedPsbt) {
+                        return
+                    }
+
+                    const result = root.wallet.createUnsignedPsbt()
+                    root.psbtStatusSuccess = !!result.success
+                    root.psbtStatusMessage = result.message || ""
+                    if (result.success && result.psbtBase64) {
+                        Clipboard.setText(result.psbtBase64)
+                    }
+                }
+            }
+
+            CoreText {
+                objectName: "multipleSendReviewPsbtStatusText"
+                Layout.fillWidth: true
+                visible: root.psbtStatusMessage.length > 0
+                text: root.psbtStatusMessage
+                color: root.psbtStatusSuccess ? Theme.color.green : Theme.color.red
+                font.pixelSize: 14
+                wrapMode: Text.WordWrap
+            }
+
             ContinueButton {
                 id: confirmationButton
                 objectName: "multipleSendConfirmButton"

qml/pages/wallet/SendReview.qml

@@ -17,6 +17,8 @@ Page {
 
     property WalletQmlModel wallet: walletController.selectedWallet
     property WalletQmlModelTransaction transaction: walletController.selectedWallet.currentTransaction
+    property string psbtStatusMessage: ""
+    property bool psbtStatusSuccess: true
 
     signal finished()
     signal back()
@@ -137,6 +139,34 @@ Page {
                 }
             }
 
+            OutlineButton {
+                objectName: "sendReviewCopyPsbtButton"
+                Layout.fillWidth: true
+                text: qsTr("Copy PSBT")
+                onClicked: {
+                    if (!root.wallet || !root.wallet.createUnsignedPsbt) {
+                        return
+                    }
+
+                    const result = root.wallet.createUnsignedPsbt()
+                    root.psbtStatusSuccess = !!result.success
+                    root.psbtStatusMessage = result.message || ""
+                    if (result.success && result.psbtBase64) {
+                        Clipboard.setText(result.psbtBase64)
+                    }
+                }
+            }
+
+            CoreText {
+                objectName: "sendReviewPsbtStatusText"
+                Layout.fillWidth: true
+                visible: root.psbtStatusMessage.length > 0
+                text: root.psbtStatusMessage
+                color: root.psbtStatusSuccess ? Theme.color.green : Theme.color.red
+                font.pixelSize: 14
+                wrapMode: Text.WordWrap
+            }
+
             ContinueButton {
                 id: confimationButton
                 objectName: "sendConfirmButton"

test/qml/qml_tests_main.cpp

@@ -975,6 +975,7 @@ class MockWalletQmlModel : public QObject
     Q_PROPERTY(bool prepareTransactionResult MEMBER m_prepare_transaction_result NOTIFY prepareTransactionResultChanged)
     Q_PROPERTY(int prepareTransactionCalls READ prepareTransactionCalls NOTIFY prepareTransactionCallsChanged)
     Q_PROPERTY(int sendTransactionCalls READ sendTransactionCalls NOTIFY sendTransactionCallsChanged)
+    Q_PROPERTY(int createUnsignedPsbtCalls READ createUnsignedPsbtCalls NOTIFY createUnsignedPsbtCallsChanged)
 
 public:
     QString m_name{QStringLiteral("testwallet")};
@@ -991,6 +992,9 @@ class MockWalletQmlModel : public QObject
     qint64 m_custom_fee_rate_sat_per_kvb{1000};
     QString m_last_prepare_error;
     bool m_prepare_transaction_result{true};
+    bool m_create_unsigned_psbt_success{true};
+    QString m_create_unsigned_psbt_message{QStringLiteral("PSBT copied to clipboard.")};
+    QString m_create_unsigned_psbt_base64{QStringLiteral("cHNidP8BAHECAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/////AaCGAQAAAAAAIgAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAR8AAAAAAAEfAAAAAA==")};
     const QString m_default_rbf_eligible_txid{QStringLiteral("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")};
     QString m_rbf_eligible_txid{m_default_rbf_eligible_txid};
     QString m_prepared_rbf_txid;
@@ -1004,6 +1008,7 @@ class MockWalletQmlModel : public QObject
     QObject* receiveRequests() const { return m_receive_requests; }
     int prepareTransactionCalls() const { return m_prepare_transaction_calls; }
     int sendTransactionCalls() const { return m_send_transaction_calls; }
+    int createUnsignedPsbtCalls() const { return m_create_unsigned_psbt_calls; }
     void setActivityListModel(QObject* model) { m_activity_list_model = model; }
     void setAddressBookModel(QObject* model) { m_address_book_model = model; }
     void setRecipients(QObject* model) { m_recipients = model; }
@@ -1025,6 +1030,25 @@ class MockWalletQmlModel : public QObject
         Q_EMIT sendTransactionCallsChanged();
     }
 
+    Q_INVOKABLE QVariantMap createUnsignedPsbt()
+    {
+        ++m_create_unsigned_psbt_calls;
+        Q_EMIT createUnsignedPsbtCallsChanged();
+
+        QVariantMap result;
+        result.insert(QStringLiteral("success"), m_create_unsigned_psbt_success);
+        result.insert(QStringLiteral("message"), m_create_unsigned_psbt_message);
+        result.insert(QStringLiteral("psbtBase64"), m_create_unsigned_psbt_success ? m_create_unsigned_psbt_base64 : QString{});
+        return result;
+    }
+
+    Q_INVOKABLE void setCreateUnsignedPsbtResult(const bool success, const QString& message, const QString& base64 = QString{})
+    {
+        m_create_unsigned_psbt_success = success;
+        m_create_unsigned_psbt_message = message;
+        m_create_unsigned_psbt_base64 = base64;
+    }
+
     Q_INVOKABLE QString getAddressLabel(const QString& address) const
     {
         auto* address_book = qobject_cast<MockAddressBookModel*>(m_address_book_model);
@@ -1183,10 +1207,12 @@ class MockWalletQmlModel : public QObject
     void prepareTransactionResultChanged();
     void prepareTransactionCallsChanged();
     void sendTransactionCallsChanged();
+    void createUnsignedPsbtCallsChanged();
 
 private:
     int m_prepare_transaction_calls{0};
     int m_send_transaction_calls{0};
+    int m_create_unsigned_psbt_calls{0};
 };
 
 class MockWalletQmlModelTransaction : public QObject

test/qml/tst_multiplesendreview.qml

@@ -4,6 +4,7 @@
 
 import QtQuick 2.15
 import QtTest 1.2
+import org.bitcoincore.qt 1.0
 import "../../qml/pages/wallet"
 
 TestCase {
@@ -33,6 +34,8 @@ TestCase {
         compare(page.objectName, "walletMultipleSendReviewPage")
         verify(findChild(page, "multipleSendReviewBackButton") !== null)
         verify(findChild(page, "multipleSendInputsList") !== null)
+        verify(findChild(page, "multipleSendReviewCopyPsbtButton") !== null)
+        verify(findChild(page, "multipleSendReviewPsbtStatusText") !== null)
         verify(findChild(page, "multipleSendConfirmButton") !== null)
     }
 
@@ -52,6 +55,28 @@ TestCase {
         tryCompare(list, "count", 1)
     }
 
+    function test_multipleSendReview_copy_psbt_copies_base64_and_shows_status() {
+        Clipboard.setText("")
+        testWalletModel.setCreateUnsignedPsbtResult(true,
+                                                    "PSBT copied to clipboard.",
+                                                    "cHNidP8BAHECAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/////AaCGAQAAAAAAIgAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAR8AAAAAAAEfAAAAAA==")
+
+        const page = createTemporaryObject(multipleSendReviewComponent, this)
+        verify(page !== null)
+
+        const copyButton = findChild(page, "multipleSendReviewCopyPsbtButton")
+        const statusText = findChild(page, "multipleSendReviewPsbtStatusText")
+        verify(copyButton !== null)
+        verify(statusText !== null)
+
+        const callsBefore = testWalletModel.createUnsignedPsbtCalls
+        copyButton.clicked()
+
+        compare(testWalletModel.createUnsignedPsbtCalls, callsBefore + 1)
+        compare(statusText.text, "PSBT copied to clipboard.")
+        compare(Clipboard.text, "cHNidP8BAHECAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/////AaCGAQAAAAAAIgAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAR8AAAAAAAEfAAAAAA==")
+    }
+
     function test_multipleSendReview_back_and_confirm_signals() {
         const page = createTemporaryObject(multipleSendReviewComponent, this)
         verify(page !== null)