Coverage Report

Created: 2026-07-23 20:35

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/wallet/interfaces.cpp
Line
Count
Source
1
// Copyright (c) 2018-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5
#include <interfaces/wallet.h>
6
7
#include <common/args.h>
8
#include <consensus/amount.h>
9
#include <interfaces/chain.h>
10
#include <interfaces/handler.h>
11
#include <node/types.h>
12
#include <policy/fees/block_policy_estimator.h>
13
#include <primitives/transaction.h>
14
#include <rpc/server.h>
15
#include <scheduler.h>
16
#include <support/allocators/secure.h>
17
#include <sync.h>
18
#include <uint256.h>
19
#include <util/check.h>
20
#include <util/translation.h>
21
#include <util/ui_change_type.h>
22
#include <wallet/coincontrol.h>
23
#include <wallet/context.h>
24
#include <wallet/feebumper.h>
25
#include <wallet/fees.h>
26
#include <wallet/load.h>
27
#include <wallet/receive.h>
28
#include <wallet/rpc/wallet.h>
29
#include <wallet/spend.h>
30
#include <wallet/wallet.h>
31
32
#include <memory>
33
#include <string>
34
#include <utility>
35
#include <vector>
36
37
using common::PSBTError;
38
using interfaces::Chain;
39
using interfaces::FoundBlock;
40
using interfaces::Handler;
41
using interfaces::MakeSignalHandler;
42
using interfaces::Wallet;
43
using interfaces::WalletAddress;
44
using interfaces::WalletBalances;
45
using interfaces::WalletLoader;
46
using interfaces::WalletMigrationResult;
47
using interfaces::WalletTx;
48
using interfaces::WalletTxOut;
49
using interfaces::WalletTxStatus;
50
51
namespace wallet {
52
// All members of the classes in this namespace are intentionally public, as the
53
// classes themselves are private.
54
namespace {
55
//! Construct wallet tx struct.
56
WalletTx MakeWalletTx(CWallet& wallet, const CWalletTx& wtx)
57
0
{
58
0
    LOCK(wallet.cs_wallet);
59
0
    WalletTx result;
60
0
    result.tx = wtx.tx;
61
0
    result.txin_is_mine.reserve(wtx.tx->vin.size());
62
0
    for (const auto& txin : wtx.tx->vin) {
63
0
        result.txin_is_mine.emplace_back(InputIsMine(wallet, txin));
64
0
    }
65
0
    result.txout_is_mine.reserve(wtx.tx->vout.size());
66
0
    result.txout_address.reserve(wtx.tx->vout.size());
67
0
    result.txout_address_is_mine.reserve(wtx.tx->vout.size());
68
0
    for (const auto& txout : wtx.tx->vout) {
69
0
        result.txout_is_mine.emplace_back(wallet.IsMine(txout));
70
0
        result.txout_is_change.push_back(OutputIsChange(wallet, txout));
71
0
        result.txout_address.emplace_back();
72
0
        result.txout_address_is_mine.emplace_back(ExtractDestination(txout.scriptPubKey, result.txout_address.back()) ?
73
0
                                                      wallet.IsMine(result.txout_address.back()) :
74
0
                                                      false);
75
0
    }
76
0
    result.credit = CachedTxGetCredit(wallet, wtx, /*avoid_reuse=*/true);
77
0
    result.debit = CachedTxGetDebit(wallet, wtx, /*avoid_reuse=*/true);
78
0
    result.change = CachedTxGetChange(wallet, wtx);
79
0
    result.time = wtx.GetTxTime();
80
0
    result.from = wtx.m_from;
81
0
    result.message = wtx.m_message;
82
0
    result.comment = wtx.m_comment;
83
0
    result.comment_to = wtx.m_comment_to;
84
0
    result.is_coinbase = wtx.IsCoinBase();
85
0
    return result;
86
0
}
87
88
//! Construct wallet tx status struct.
89
WalletTxStatus MakeWalletTxStatus(const CWallet& wallet, const CWalletTx& wtx)
90
    EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
91
0
{
92
0
    AssertLockHeld(wallet.cs_wallet);
93
94
0
    WalletTxStatus result;
95
0
    result.block_height =
96
0
        wtx.state<TxStateConfirmed>() ? wtx.state<TxStateConfirmed>()->confirmed_block_height :
97
0
        wtx.state<TxStateBlockConflicted>() ? wtx.state<TxStateBlockConflicted>()->conflicting_block_height :
98
0
        std::numeric_limits<int>::max();
99
0
    result.blocks_to_maturity = wallet.GetTxBlocksToMaturity(wtx);
100
0
    result.depth_in_main_chain = wallet.GetTxDepthInMainChain(wtx);
101
0
    result.time_received = wtx.nTimeReceived;
102
0
    result.lock_time = wtx.tx->nLockTime;
103
0
    result.is_trusted = CachedTxIsTrusted(wallet, wtx);
104
0
    result.is_abandoned = wtx.isAbandoned();
105
0
    result.is_coinbase = wtx.IsCoinBase();
106
0
    result.is_in_main_chain = wtx.isConfirmed();
107
0
    return result;
108
0
}
109
110
//! Construct wallet TxOut struct.
111
WalletTxOut MakeWalletTxOut(const CWallet& wallet,
112
    const CWalletTx& wtx,
113
    int n,
114
    int depth) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
115
0
{
116
0
    WalletTxOut result;
117
0
    result.txout = wtx.tx->vout[n];
118
0
    result.time = wtx.GetTxTime();
119
0
    result.depth_in_main_chain = depth;
120
0
    result.is_spent = wallet.IsSpent(COutPoint(wtx.GetHash(), n));
121
0
    return result;
122
0
}
123
124
WalletTxOut MakeWalletTxOut(const CWallet& wallet,
125
    const COutput& output) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
126
0
{
127
0
    WalletTxOut result;
128
0
    result.txout = output.txout;
129
0
    result.time = output.time;
130
0
    result.depth_in_main_chain = output.depth;
131
0
    result.is_spent = wallet.IsSpent(output.outpoint);
132
0
    return result;
133
0
}
134
135
class WalletImpl : public Wallet
136
{
137
public:
138
1
    explicit WalletImpl(WalletContext& context, const std::shared_ptr<CWallet>& wallet) : m_context(context), m_wallet(wallet) {}
139
140
    bool encryptWallet(const SecureString& wallet_passphrase) override
141
0
    {
142
0
        return m_wallet->EncryptWallet(wallet_passphrase);
143
0
    }
144
0
    bool isCrypted() override { return m_wallet->HasEncryptionKeys(); }
145
0
    bool lock() override { return m_wallet->Lock(); }
146
0
    bool unlock(const SecureString& wallet_passphrase) override { return m_wallet->Unlock(wallet_passphrase); }
147
0
    bool isLocked() override { return m_wallet->IsLocked(); }
148
    bool changeWalletPassphrase(const SecureString& old_wallet_passphrase,
149
        const SecureString& new_wallet_passphrase) override
150
0
    {
151
0
        return m_wallet->ChangeWalletPassphrase(old_wallet_passphrase, new_wallet_passphrase);
152
0
    }
153
0
    void abortRescan() override { m_wallet->AbortRescan(); }
154
0
    bool backupWallet(const std::string& filename) override { return m_wallet->BackupWallet(filename); }
155
0
    std::string getWalletName() override { return m_wallet->GetName(); }
156
    util::Result<CTxDestination> getNewDestination(const OutputType type, const std::string& label) override
157
0
    {
158
0
        LOCK(m_wallet->cs_wallet);
159
0
        return m_wallet->GetNewDestination(type, label);
160
0
    }
161
    bool getPubKey(const CScript& script, const CKeyID& address, CPubKey& pub_key) override
162
0
    {
163
0
        std::unique_ptr<SigningProvider> provider = m_wallet->GetSolvingProvider(script);
164
0
        if (provider) {
165
0
            return provider->GetPubKey(address, pub_key);
166
0
        }
167
0
        return false;
168
0
    }
169
    SigningResult signMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) override
170
0
    {
171
0
        return m_wallet->SignMessage(message, pkhash, str_sig);
172
0
    }
173
    bool isSpendable(const CTxDestination& dest) override
174
0
    {
175
0
        LOCK(m_wallet->cs_wallet);
176
0
        return m_wallet->IsMine(dest);
177
0
    }
178
    bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<AddressPurpose>& purpose) override
179
0
    {
180
0
        return m_wallet->SetAddressBook(dest, name, purpose);
181
0
    }
182
    bool delAddressBook(const CTxDestination& dest) override
183
0
    {
184
0
        return m_wallet->DelAddressBook(dest);
185
0
    }
186
    bool getAddress(const CTxDestination& dest,
187
        std::string* name,
188
        AddressPurpose* purpose) override
189
0
    {
190
0
        LOCK(m_wallet->cs_wallet);
191
0
        const auto& entry = m_wallet->FindAddressBookEntry(dest, /*allow_change=*/false);
192
0
        if (!entry) return false; // addr not found
193
0
        if (name) {
194
0
            *name = entry->GetLabel();
195
0
        }
196
0
        if (purpose) {
197
            // In very old wallets, address purpose may not be recorded so we derive it from IsMine
198
0
            *purpose = entry->purpose.value_or(m_wallet->IsMine(dest) ? AddressPurpose::RECEIVE : AddressPurpose::SEND);
199
0
        }
200
0
        return true;
201
0
    }
202
    std::vector<WalletAddress> getAddresses() override
203
0
    {
204
0
        LOCK(m_wallet->cs_wallet);
205
0
        std::vector<WalletAddress> result;
206
0
        m_wallet->ForEachAddrBookEntry([&](const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose>& purpose) EXCLUSIVE_LOCKS_REQUIRED(m_wallet->cs_wallet) {
207
0
            if (is_change) return;
208
0
            bool is_mine = m_wallet->IsMine(dest);
209
            // In very old wallets, address purpose may not be recorded so we derive it from IsMine
210
0
            result.emplace_back(dest, is_mine, purpose.value_or(is_mine ? AddressPurpose::RECEIVE : AddressPurpose::SEND), label);
211
0
        });
212
0
        return result;
213
0
    }
214
0
    std::vector<std::string> getAddressReceiveRequests() override {
215
0
        LOCK(m_wallet->cs_wallet);
216
0
        return m_wallet->GetAddressReceiveRequests();
217
0
    }
218
0
    bool setAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& value) override {
219
        // Note: The setAddressReceiveRequest interface used by the GUI to store
220
        // receive requests is a little awkward and could be improved in the
221
        // future:
222
        //
223
        // - The same method is used to save requests and erase them, but
224
        //   having separate methods could be clearer and prevent bugs.
225
        //
226
        // - Request ids are passed as strings even though they are generated as
227
        //   integers.
228
        //
229
        // - Multiple requests can be stored for the same address, but it might
230
        //   be better to only allow one request or only keep the current one.
231
0
        LOCK(m_wallet->cs_wallet);
232
0
        WalletBatch batch{m_wallet->GetDatabase()};
233
0
        return value.empty() ? m_wallet->EraseAddressReceiveRequest(batch, dest, id)
234
0
                             : m_wallet->SetAddressReceiveRequest(batch, dest, id, value);
235
0
    }
236
    util::Result<void> displayAddress(const CTxDestination& dest) override
237
0
    {
238
0
        LOCK(m_wallet->cs_wallet);
239
0
        return m_wallet->DisplayAddress(dest);
240
0
    }
241
    bool lockCoin(const COutPoint& output, const bool write_to_db) override
242
0
    {
243
0
        LOCK(m_wallet->cs_wallet);
244
0
        return m_wallet->LockCoin(output, write_to_db);
245
0
    }
246
    bool unlockCoin(const COutPoint& output) override
247
0
    {
248
0
        LOCK(m_wallet->cs_wallet);
249
0
        return m_wallet->UnlockCoin(output);
250
0
    }
251
    bool isLockedCoin(const COutPoint& output) override
252
0
    {
253
0
        LOCK(m_wallet->cs_wallet);
254
0
        return m_wallet->IsLockedCoin(output);
255
0
    }
256
    void listLockedCoins(std::vector<COutPoint>& outputs) override
257
0
    {
258
0
        LOCK(m_wallet->cs_wallet);
259
0
        return m_wallet->ListLockedCoins(outputs);
260
0
    }
261
    util::Result<wallet::CreatedTransactionResult> createTransaction(const std::vector<CRecipient>& recipients,
262
        const CCoinControl& coin_control,
263
        bool sign,
264
        std::optional<unsigned int> change_pos) override
265
0
    {
266
0
        LOCK(m_wallet->cs_wallet);
267
0
        return CreateTransaction(*m_wallet, recipients, change_pos, coin_control, sign);
268
0
    }
269
    void commitTransaction(CTransactionRef tx, const std::vector<std::string>& messages) override
270
0
    {
271
0
        LOCK(m_wallet->cs_wallet);
272
0
        m_wallet->CommitTransaction(std::move(tx), /*replaces_txid=*/std::nullopt, /*comment=*/std::nullopt, /*comment_to=*/std::nullopt, messages);
273
0
    }
274
0
    bool transactionCanBeAbandoned(const Txid& txid) override { return m_wallet->TransactionCanBeAbandoned(txid); }
275
    bool abandonTransaction(const Txid& txid) override
276
0
    {
277
0
        LOCK(m_wallet->cs_wallet);
278
0
        return m_wallet->AbandonTransaction(txid);
279
0
    }
280
    bool transactionCanBeBumped(const Txid& txid) override
281
0
    {
282
0
        return feebumper::TransactionCanBeBumped(*m_wallet.get(), txid);
283
0
    }
284
    bool createBumpTransaction(const Txid& txid,
285
        const CCoinControl& coin_control,
286
        std::vector<bilingual_str>& errors,
287
        CAmount& old_fee,
288
        CAmount& new_fee,
289
        CMutableTransaction& mtx) override
290
0
    {
291
0
        std::vector<CTxOut> outputs; // just an empty list of new recipients for now
292
0
        return feebumper::CreateRateBumpTransaction(*m_wallet.get(), txid, coin_control, errors, old_fee, new_fee, mtx, /* require_mine= */ true, outputs) == feebumper::Result::OK;
293
0
    }
294
0
    bool signBumpTransaction(CMutableTransaction& mtx) override { return feebumper::SignTransaction(*m_wallet.get(), mtx); }
295
    bool commitBumpTransaction(const Txid& txid,
296
        CMutableTransaction&& mtx,
297
        std::vector<bilingual_str>& errors,
298
        Txid& bumped_txid) override
299
0
    {
300
0
        return feebumper::CommitTransaction(*m_wallet.get(), txid, std::move(mtx), errors, bumped_txid) ==
301
0
               feebumper::Result::OK;
302
0
    }
303
    CTransactionRef getTx(const Txid& txid) override
304
0
    {
305
0
        LOCK(m_wallet->cs_wallet);
306
0
        auto mi = m_wallet->mapWallet.find(txid);
307
0
        if (mi != m_wallet->mapWallet.end()) {
308
0
            return mi->second.tx;
309
0
        }
310
0
        return {};
311
0
    }
312
    WalletTx getWalletTx(const Txid& txid) override
313
0
    {
314
0
        LOCK(m_wallet->cs_wallet);
315
0
        auto mi = m_wallet->mapWallet.find(txid);
316
0
        if (mi != m_wallet->mapWallet.end()) {
317
0
            return MakeWalletTx(*m_wallet, mi->second);
318
0
        }
319
0
        return {};
320
0
    }
321
    std::set<WalletTx> getWalletTxs() override
322
0
    {
323
0
        LOCK(m_wallet->cs_wallet);
324
0
        std::set<WalletTx> result;
325
0
        for (const auto& entry : m_wallet->mapWallet) {
326
0
            result.emplace(MakeWalletTx(*m_wallet, entry.second));
327
0
        }
328
0
        return result;
329
0
    }
330
    bool tryGetTxStatus(const Txid& txid,
331
        interfaces::WalletTxStatus& tx_status,
332
        int& num_blocks,
333
        int64_t& block_time) override
334
0
    {
335
0
        TRY_LOCK(m_wallet->cs_wallet, locked_wallet);
336
0
        if (!locked_wallet) {
337
0
            return false;
338
0
        }
339
0
        auto mi = m_wallet->mapWallet.find(txid);
340
0
        if (mi == m_wallet->mapWallet.end()) {
341
0
            return false;
342
0
        }
343
0
        num_blocks = m_wallet->GetLastBlockHeight();
344
0
        block_time = -1;
345
0
        CHECK_NONFATAL(m_wallet->chain().findBlock(m_wallet->GetLastBlockHash(), FoundBlock().time(block_time)));
346
0
        tx_status = MakeWalletTxStatus(*m_wallet, mi->second);
347
0
        return true;
348
0
    }
349
    WalletTx getWalletTxDetails(const Txid& txid,
350
        WalletTxStatus& tx_status,
351
        std::vector<std::string>& messages,
352
        std::vector<std::string>& payment_requests,
353
        bool& in_mempool,
354
        int& num_blocks) override
355
0
    {
356
0
        LOCK(m_wallet->cs_wallet);
357
0
        auto mi = m_wallet->mapWallet.find(txid);
358
0
        if (mi != m_wallet->mapWallet.end()) {
359
0
            num_blocks = m_wallet->GetLastBlockHeight();
360
0
            in_mempool = mi->second.InMempool();
361
0
            messages = mi->second.m_messages;
362
0
            payment_requests = mi->second.m_payment_requests;
363
0
            tx_status = MakeWalletTxStatus(*m_wallet, mi->second);
364
0
            return MakeWalletTx(*m_wallet, mi->second);
365
0
        }
366
0
        return {};
367
0
    }
368
    std::optional<PSBTError> fillPSBT(const common::PSBTFillOptions& options,
369
        size_t* n_signed,
370
        PartiallySignedTransaction& psbtx,
371
        bool& complete) override
372
0
    {
373
0
        return m_wallet->FillPSBT(psbtx, options, complete, n_signed);
374
0
    }
375
    WalletBalances getBalances() override
376
0
    {
377
0
        const auto bal = GetBalance(*m_wallet);
378
0
        WalletBalances result;
379
0
        result.balance = bal.m_mine_trusted;
380
0
        result.unconfirmed_balance = bal.m_mine_untrusted_pending;
381
0
        result.immature_balance = bal.m_mine_immature;
382
0
        result.used_balance = bal.m_mine_used;
383
0
        result.nonmempool_balance = bal.m_mine_nonmempool;
384
0
        return result;
385
0
    }
386
    bool tryGetBalances(WalletBalances& balances, uint256& block_hash) override
387
0
    {
388
0
        TRY_LOCK(m_wallet->cs_wallet, locked_wallet);
389
0
        if (!locked_wallet) {
390
0
            return false;
391
0
        }
392
0
        block_hash = m_wallet->GetLastBlockHash();
393
0
        balances = getBalances();
394
0
        return true;
395
0
    }
396
0
    CAmount getBalance() override { return GetBalance(*m_wallet).m_mine_trusted; }
397
    CAmount getAvailableBalance(const CCoinControl& coin_control) override
398
0
    {
399
0
        LOCK(m_wallet->cs_wallet);
400
0
        CAmount total_amount = 0;
401
        // Fetch selected coins total amount
402
0
        if (coin_control.HasSelected()) {
403
0
            FastRandomContext rng{};
404
0
            CoinSelectionParams params(rng);
405
            // Note: for now, swallow any error.
406
0
            if (auto res = FetchSelectedInputs(*m_wallet, coin_control, params)) {
407
0
                total_amount += res->GetTotalAmount();
408
0
            }
409
0
        }
410
411
        // And fetch the wallet available coins
412
0
        if (coin_control.m_allow_other_inputs) {
413
0
            total_amount += AvailableCoins(*m_wallet, &coin_control).GetTotalAmount();
414
0
        }
415
416
0
        return total_amount;
417
0
    }
418
    bool txinIsMine(const CTxIn& txin) override
419
0
    {
420
0
        LOCK(m_wallet->cs_wallet);
421
0
        return InputIsMine(*m_wallet, txin);
422
0
    }
423
    bool txoutIsMine(const CTxOut& txout) override
424
0
    {
425
0
        LOCK(m_wallet->cs_wallet);
426
0
        return m_wallet->IsMine(txout);
427
0
    }
428
    CAmount getDebit(const CTxIn& txin) override
429
0
    {
430
0
        LOCK(m_wallet->cs_wallet);
431
0
        return m_wallet->GetDebit(txin);
432
0
    }
433
    CAmount getCredit(const CTxOut& txout) override
434
0
    {
435
0
        LOCK(m_wallet->cs_wallet);
436
0
        return OutputGetCredit(*m_wallet, txout);
437
0
    }
438
    CoinsList listCoins() override
439
0
    {
440
0
        LOCK(m_wallet->cs_wallet);
441
0
        CoinsList result;
442
0
        for (const auto& entry : ListCoins(*m_wallet)) {
443
0
            auto& group = result[entry.first];
444
0
            for (const auto& coin : entry.second) {
445
0
                group.emplace_back(coin.outpoint,
446
0
                    MakeWalletTxOut(*m_wallet, coin));
447
0
            }
448
0
        }
449
0
        return result;
450
0
    }
451
    std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) override
452
0
    {
453
0
        LOCK(m_wallet->cs_wallet);
454
0
        std::vector<WalletTxOut> result;
455
0
        result.reserve(outputs.size());
456
0
        for (const auto& output : outputs) {
457
0
            result.emplace_back();
458
0
            auto it = m_wallet->mapWallet.find(output.hash);
459
0
            if (it != m_wallet->mapWallet.end()) {
460
0
                int depth = m_wallet->GetTxDepthInMainChain(it->second);
461
0
                if (depth >= 0) {
462
0
                    result.back() = MakeWalletTxOut(*m_wallet, it->second, output.n, depth);
463
0
                }
464
0
            }
465
0
        }
466
0
        return result;
467
0
    }
468
0
    CAmount getRequiredFee(unsigned int tx_bytes) override { return GetRequiredFee(*m_wallet, tx_bytes); }
469
    CAmount getMinimumFee(unsigned int tx_bytes,
470
        const CCoinControl& coin_control,
471
        int* returned_target,
472
        FeeReason* reason) override
473
0
    {
474
0
        FeeCalculation fee_calc;
475
0
        CAmount result;
476
0
        result = GetMinimumFee(*m_wallet, tx_bytes, coin_control, &fee_calc);
477
0
        if (returned_target) *returned_target = fee_calc.returnedTarget;
478
0
        if (reason) *reason = fee_calc.reason;
479
0
        return result;
480
0
    }
481
0
    unsigned int getConfirmTarget() override { return m_wallet->m_confirm_target; }
482
0
    bool hdEnabled() override { return m_wallet->IsHDEnabled(); }
483
0
    bool canGetAddresses() override { return m_wallet->CanGetAddresses(); }
484
0
    bool hasExternalSigner() override { return m_wallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER); }
485
0
    bool privateKeysDisabled() override { return m_wallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS); }
486
0
    bool taprootEnabled() override {
487
0
        auto spk_man = m_wallet->GetScriptPubKeyMan(OutputType::BECH32M, /*internal=*/false);
488
0
        return spk_man != nullptr;
489
0
    }
490
0
    OutputType getDefaultAddressType() override { return m_wallet->m_default_address_type; }
491
0
    CAmount getDefaultMaxTxFee() override { return m_wallet->m_default_max_tx_fee; }
492
    void remove() override
493
0
    {
494
0
        RemoveWallet(m_context, m_wallet, /*load_on_start=*/false);
495
0
    }
496
    std::unique_ptr<Handler> handleUnload(UnloadFn fn) override
497
0
    {
498
0
        return MakeSignalHandler(m_wallet->NotifyUnload.connect(fn));
499
0
    }
500
    std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) override
501
0
    {
502
0
        return MakeSignalHandler(m_wallet->ShowProgress.connect(fn));
503
0
    }
504
    std::unique_ptr<Handler> handleStatusChanged(StatusChangedFn fn) override
505
0
    {
506
0
        return MakeSignalHandler(m_wallet->NotifyStatusChanged.connect([fn](CWallet*) { fn(); }));
507
0
    }
508
    std::unique_ptr<Handler> handleAddressBookChanged(AddressBookChangedFn fn) override
509
0
    {
510
0
        return MakeSignalHandler(m_wallet->NotifyAddressBookChanged.connect(
511
0
            [fn](const CTxDestination& address, const std::string& label, bool is_mine,
512
0
                 AddressPurpose purpose, ChangeType status) { fn(address, label, is_mine, purpose, status); }));
513
0
    }
514
    std::unique_ptr<Handler> handleTransactionChanged(TransactionChangedFn fn) override
515
0
    {
516
0
        return MakeSignalHandler(m_wallet->NotifyTransactionChanged.connect(
517
0
            [fn](const Txid& txid, ChangeType status) { fn(txid, status); }));
518
0
    }
519
    std::unique_ptr<Handler> handleCanGetAddressesChanged(CanGetAddressesChangedFn fn) override
520
0
    {
521
0
        return MakeSignalHandler(m_wallet->NotifyCanGetAddressesChanged.connect(fn));
522
0
    }
523
0
    CWallet* wallet() override { return m_wallet.get(); }
524
525
    WalletContext& m_context;
526
    std::shared_ptr<CWallet> m_wallet;
527
};
528
529
class WalletLoaderImpl : public WalletLoader
530
{
531
public:
532
    WalletLoaderImpl(Chain& chain, ArgsManager& args)
533
426
    {
534
426
        m_context.chain = &chain;
535
426
        m_context.args = &args;
536
426
    }
537
426
    ~WalletLoaderImpl() override { stop(); }
538
539
    //! ChainClient methods
540
    void registerRpcs() override
541
419
    {
542
24.3k
        for (const CRPCCommand& command : GetWalletRPCCommands()) {
543
24.3k
            m_rpc_commands.emplace_back(command.category, command.name, [this, &command](const JSONRPCRequest& request, UniValue& result, bool last_handler) {
544
23.3k
                JSONRPCRequest wallet_request = request;
545
23.3k
                wallet_request.context = &m_context;
546
23.3k
                return command.actor(wallet_request, result, last_handler);
547
23.3k
            }, command.argNames, command.unique_id);
548
24.3k
            m_rpc_commands.back().metadata_fn = command.metadata_fn;
549
24.3k
            m_rpc_handlers.emplace_back(m_context.chain->handleRpc(m_rpc_commands.back()));
550
24.3k
        }
551
419
    }
552
409
    bool verify() override { return VerifyWallets(m_context); }
553
351
    bool load() override { return LoadWallets(m_context); }
554
    void start(CScheduler& scheduler) override
555
348
    {
556
348
        m_context.scheduler = &scheduler;
557
348
        return StartWallets(m_context);
558
348
    }
559
828
    void stop() override { return UnloadWallets(m_context); }
560
164
    void setMockTime(int64_t time) override { return SetMockTime(time); }
561
7
    void schedulerMockForward(std::chrono::seconds delta) override { Assert(m_context.scheduler)->MockForward(delta); }
562
563
    //! WalletLoader methods
564
    util::Result<std::unique_ptr<Wallet>> createWallet(const std::string& name, const SecureString& passphrase, uint64_t wallet_creation_flags, std::vector<bilingual_str>& warnings) override
565
0
    {
566
0
        DatabaseOptions options;
567
0
        DatabaseStatus status;
568
0
        ReadDatabaseArgs(*m_context.args, options);
569
0
        options.require_create = true;
570
0
        options.create_flags = wallet_creation_flags;
571
0
        options.create_passphrase = passphrase;
572
0
        bilingual_str error;
573
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, CreateWallet(m_context, name, /*load_on_start=*/true, options, status, error, warnings))};
574
0
        if (wallet) {
575
0
            return wallet;
576
0
        } else {
577
0
            return util::Error{error};
578
0
        }
579
0
    }
580
    util::Result<std::unique_ptr<Wallet>> loadWallet(const std::string& name, std::vector<bilingual_str>& warnings) override
581
0
    {
582
0
        DatabaseOptions options;
583
0
        DatabaseStatus status;
584
0
        ReadDatabaseArgs(*m_context.args, options);
585
0
        options.require_existing = true;
586
0
        bilingual_str error;
587
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, LoadWallet(m_context, name, /*load_on_start=*/true, options, status, error, warnings))};
588
0
        if (wallet) {
589
0
            return wallet;
590
0
        } else {
591
0
            return util::Error{error};
592
0
        }
593
0
    }
594
    util::Result<std::unique_ptr<Wallet>> restoreWallet(const fs::path& backup_file, const std::string& wallet_name, std::vector<bilingual_str>& warnings, bool load_after_restore) override
595
0
    {
596
0
        DatabaseStatus status;
597
0
        bilingual_str error;
598
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, RestoreWallet(m_context, backup_file, wallet_name, /*load_on_start=*/true, status, error, warnings, load_after_restore))};
599
0
        if (!error.empty()) {
600
0
            return util::Error{error};
601
0
        }
602
0
        return wallet;
603
0
    }
604
    util::Result<WalletMigrationResult> migrateWallet(const std::string& name, const SecureString& passphrase) override
605
0
    {
606
0
        auto res = wallet::MigrateLegacyToDescriptor(name, passphrase, m_context);
607
0
        if (!res) return util::Error{util::ErrorString(res)};
608
0
        WalletMigrationResult out{
609
0
            .wallet = MakeWallet(m_context, res->wallet),
610
0
            .watchonly_wallet_name = res->watchonly_wallet_name,
611
0
            .solvables_wallet_name = res->solvables_wallet_name,
612
0
            .backup_path = res->backup_path,
613
0
        };
614
0
        return out;
615
0
    }
616
    bool isEncrypted(const std::string& wallet_name) override
617
0
    {
618
0
        auto wallets{GetWallets(m_context)};
619
0
        auto it = std::find_if(wallets.begin(), wallets.end(), [&](std::shared_ptr<CWallet> w){ return w->GetName() == wallet_name; });
620
0
        if (it != wallets.end()) return (*it)->HasEncryptionKeys();
621
622
        // Unloaded wallet, read db
623
0
        DatabaseOptions options;
624
0
        options.require_existing = true;
625
0
        DatabaseStatus status;
626
0
        bilingual_str error;
627
0
        auto db = MakeWalletDatabase(wallet_name, options, status, error);
628
0
        if (!db && status == wallet::DatabaseStatus::FAILED_LEGACY_DISABLED) {
629
0
            options.require_format = wallet::DatabaseFormat::BERKELEY_RO;
630
0
            db = MakeWalletDatabase(wallet_name, options, status, error);
631
0
        }
632
0
        if (!db) return false;
633
0
        return WalletBatch(*db).IsEncrypted();
634
0
    }
635
    std::string getWalletDir() override
636
0
    {
637
0
        return fs::PathToString(GetWalletDir());
638
0
    }
639
    std::vector<std::pair<std::string, std::string>> listWalletDir() override
640
0
    {
641
0
        std::vector<std::pair<std::string, std::string>> paths;
642
0
        for (auto& [path, format] : ListDatabases(GetWalletDir())) {
643
0
            paths.emplace_back(fs::PathToString(path), format);
644
0
        }
645
0
        return paths;
646
0
    }
647
    std::vector<std::unique_ptr<Wallet>> getWallets() override
648
0
    {
649
0
        std::vector<std::unique_ptr<Wallet>> wallets;
650
0
        for (const auto& wallet : GetWallets(m_context)) {
651
0
            wallets.emplace_back(MakeWallet(m_context, wallet));
652
0
        }
653
0
        return wallets;
654
0
    }
655
    std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) override
656
0
    {
657
0
        return HandleLoadWallet(m_context, std::move(fn));
658
0
    }
659
0
    WalletContext* context() override  { return &m_context; }
660
661
    WalletContext m_context;
662
    const std::vector<std::string> m_wallet_filenames;
663
    std::vector<std::unique_ptr<Handler>> m_rpc_handlers;
664
    std::list<CRPCCommand> m_rpc_commands;
665
};
666
} // namespace
667
} // namespace wallet
668
669
namespace interfaces {
670
1
std::unique_ptr<Wallet> MakeWallet(wallet::WalletContext& context, const std::shared_ptr<wallet::CWallet>& wallet) { return wallet ? std::make_unique<wallet::WalletImpl>(context, wallet) : nullptr; }
671
672
std::unique_ptr<WalletLoader> MakeWalletLoader(Chain& chain, ArgsManager& args)
673
426
{
674
426
    return std::make_unique<wallet::WalletLoaderImpl>(chain, args);
675
426
}
676
} // namespace interfaces