v31.1-roots.1 · Commit 6: [PATCH 06/17] feat(wallet): preserve Roots signing and spend controls on v31

src/interfaces/wallet.h

Before: src/interfaces/wallet.h · After: src/interfaces/wallet.h

File metadata

index bba9e058cc017ea72026751ddba7fca56e56bf0d..9a73dfae206fdc315e21e433d5f74dcad420e150 100644

Download original patch · Release notes

Diff rows 1–123 of 123. Line numbers refer to the original before/after files.

+ Added− RemovedUnmarked lines are context.

Scroll the code area horizontally to read long lines. Before is on the left; after is on the right. Unified view fits narrow screens more easily.

src/interfaces/wallet.h CHANGED Viewed

@@ -9,6 +9,7 @@
 #include <common/signmessage.h>
 #include <consensus/amount.h>
 #include <interfaces/chain.h>
 #include <primitives/transaction_identifier.h>
 #include <pubkey.h>
 #include <script/script.h>
@@ -17,6 +18,7 @@
 #include <util/result.h>
 #include <util/ui_change_type.h>
 #include <cstdint>
 #include <functional>
 #include <map>
@@ -27,7 +29,6 @@
 #include <utility>
 #include <vector>
-class CFeeRate;
 class CKey;
 enum class FeeReason;
 enum class OutputType;
@@ -58,6 +59,42 @@ struct WalletTxOut;
 struct WalletTxStatus;
 struct WalletMigrationResult;
 using WalletOrderForm = std::vector<std::pair<std::string, std::string>>;
 using WalletValueMap = std::map<std::string, std::string>;
@@ -107,6 +144,13 @@ public:
     //! Return whether wallet has private key.
     virtual bool isSpendable(const CTxDestination& dest) = 0;
     //! Add or update address.
     virtual bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<wallet::AddressPurpose>& purpose) = 0;
@@ -239,7 +283,8 @@ public:
     virtual CoinsList listCoins() = 0;
     //! Return wallet transaction output information.
-    virtual std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) = 0;
     //! Get required fee.
     virtual CAmount getRequiredFee(unsigned int tx_bytes) = 0;
@@ -253,6 +298,9 @@ public:
     //! Get tx confirm target.
     virtual unsigned int getConfirmTarget() = 0;
     // Return whether HD enabled.
     virtual bool hdEnabled() = 0;
@@ -413,10 +461,29 @@ struct WalletTxStatus
 //! Wallet transaction output.
 struct WalletTxOut
 {
     CTxOut txout;
     int64_t time;
     int depth_in_main_chain = -1;
     bool is_spent = false;
 };
 //! Migrated wallet info

 #include <common/signmessage.h>
 #include <consensus/amount.h>
 #include <interfaces/chain.h>
+#include <policy/feerate.h>
 #include <primitives/transaction_identifier.h>
 #include <pubkey.h>
 #include <script/script.h>
 #include <util/result.h>
 #include <util/ui_change_type.h>
+#include <atomic>
 #include <cstdint>
 #include <functional>
 #include <map>
 #include <utility>
 #include <vector>
 class CKey;
 enum class FeeReason;
 enum class OutputType;
 struct WalletTxStatus;
 struct WalletMigrationResult;
+//! Shared authorization for an asynchronous sweep. Cancellation and the final
+//! transition into broadcast are mutually exclusive, so a successful cancel
+//! guarantees that broadcast cannot start afterwards.
+class SweepAuthorization
+{
+public:
+    bool Cancel()
+    {
+        State expected{State::ACTIVE};
+        if (m_state.compare_exchange_strong(expected, State::CANCELLED)) return true;
+        return expected == State::CANCELLED;
+    }
+    bool IsCancelled() const { return m_state.load() == State::CANCELLED; }
+    bool BeginBroadcast()
+    {
+        State expected{State::ACTIVE};
+        return m_state.compare_exchange_strong(expected, State::BROADCAST_STARTED);
+    }
+    bool BroadcastStarted() const { return m_state.load() == State::BROADCAST_STARTED; }
+private:
+    enum class State : uint8_t { ACTIVE, CANCELLED, BROADCAST_STARTED };
+    std::atomic<State> m_state{State::ACTIVE};
+};
+//! Result of a transient-private-key sweep. The supplied key is never retained
+//! by this interface or by the wallet.
+struct WalletSweepResult {
+    CTransactionRef tx;
+    CAmount amount{0};
+    CAmount fee{0};
+    size_t inputs{0};
+    int64_t vsize{0};
+    bool broadcast{false};
+};
 using WalletOrderForm = std::vector<std::pair<std::string, std::string>>;
 using WalletValueMap = std::map<std::string, std::string>;
     //! Return whether wallet has private key.
     virtual bool isSpendable(const CTxDestination& dest) = 0;
+    //! Sweep one transient private key to a destination controlled by this wallet.
+    virtual util::Result<WalletSweepResult> sweepPrivateKey(const SecureString& private_key,
+                                                             const CTxDestination& destination,
+                                                             bool broadcast,
+                                                             const std::optional<Txid>& expected_txid,
+                                                             const std::shared_ptr<SweepAuthorization>& authorization) = 0;
     //! Add or update address.
     virtual bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<wallet::AddressPurpose>& purpose) = 0;
     virtual CoinsList listCoins() = 0;
     //! Return wallet transaction output information.
+    virtual std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs,
+                                               const std::optional<CFeeRate>& feerate = std::nullopt) = 0;
     //! Get required fee.
     virtual CAmount getRequiredFee(unsigned int tx_bytes) = 0;
     //! Get tx confirm target.
     virtual unsigned int getConfirmTarget() = 0;
+    //! Return whether new transactions signal replace-by-fee by default.
+    virtual bool getDefaultRbf() = 0;
     // Return whether HD enabled.
     virtual bool hdEnabled() = 0;
 //! Wallet transaction output.
 struct WalletTxOut
 {
+    //! Outpoint identifying this output in the wallet.
+    COutPoint outpoint;
     CTxOut txout;
+    //! Wallet's smart transaction time for this output.
     int64_t time;
     int depth_in_main_chain = -1;
     bool is_spent = false;
+    //! Wallet-owned facts used to present coin-control choices.
+    int input_bytes = -1;
+    std::optional<CAmount> effective_value;
+    CAmount ancestor_bump_fees{0};
+    //! Native wallet ownership/selection status; does not guarantee complete signing.
+    bool is_spendable = false;
+    bool is_watch_only = false;
+    bool is_solvable = false;
+    bool is_safe = false;
+    bool is_locked = false;
+    bool is_reused = false;
+    bool is_immature = false;
+    bool is_change = false;
+    CTxDestination address;
+    CTxDestination grouping_address;
+    std::string label;
 };
 //! Migrated wallet info