fuzz coverage

Coverage Report

Created: 2025-06-01 19:34

/Users/eugenesiegel/btc/bitcoin/src/wallet/interfaces.cpp
Line
Count
Source (jump to first uncovered line)
1
// Copyright (c) 2018-2022 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.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/types.h>
27
#include <wallet/load.h>
28
#include <wallet/receive.h>
29
#include <wallet/rpc/wallet.h>
30
#include <wallet/spend.h>
31
#include <wallet/wallet.h>
32
33
#include <memory>
34
#include <string>
35
#include <utility>
36
#include <vector>
37
38
using common::PSBTError;
39
using interfaces::Chain;
40
using interfaces::FoundBlock;
41
using interfaces::Handler;
42
using interfaces::MakeSignalHandler;
43
using interfaces::Wallet;
44
using interfaces::WalletAddress;
45
using interfaces::WalletBalances;
46
using interfaces::WalletLoader;
47
using interfaces::WalletMigrationResult;
48
using interfaces::WalletOrderForm;
49
using interfaces::WalletTx;
50
using interfaces::WalletTxOut;
51
using interfaces::WalletTxStatus;
52
using interfaces::WalletValueMap;
53
54
namespace wallet {
55
// All members of the classes in this namespace are intentionally public, as the
56
// classes themselves are private.
57
namespace {
58
//! Construct wallet tx struct.
59
WalletTx MakeWalletTx(CWallet& wallet, const CWalletTx& wtx)
60
0
{
61
0
    LOCK(wallet.cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
62
0
    WalletTx result;
63
0
    result.tx = wtx.tx;
64
0
    result.txin_is_mine.reserve(wtx.tx->vin.size());
65
0
    for (const auto& txin : wtx.tx->vin) {
66
0
        result.txin_is_mine.emplace_back(InputIsMine(wallet, txin));
67
0
    }
68
0
    result.txout_is_mine.reserve(wtx.tx->vout.size());
69
0
    result.txout_address.reserve(wtx.tx->vout.size());
70
0
    result.txout_address_is_mine.reserve(wtx.tx->vout.size());
71
0
    for (const auto& txout : wtx.tx->vout) {
72
0
        result.txout_is_mine.emplace_back(wallet.IsMine(txout));
73
0
        result.txout_is_change.push_back(OutputIsChange(wallet, txout));
74
0
        result.txout_address.emplace_back();
75
0
        result.txout_address_is_mine.emplace_back(ExtractDestination(txout.scriptPubKey, result.txout_address.back()) ?
76
0
                                                      wallet.IsMine(result.txout_address.back()) :
77
0
                                                      ISMINE_NO);
78
0
    }
79
0
    result.credit = CachedTxGetCredit(wallet, wtx, ISMINE_ALL);
80
0
    result.debit = CachedTxGetDebit(wallet, wtx, ISMINE_ALL);
81
0
    result.change = CachedTxGetChange(wallet, wtx);
82
0
    result.time = wtx.GetTxTime();
83
0
    result.value_map = wtx.mapValue;
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);
Line
Count
Source
142
0
#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
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
0
    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->IsCrypted(); }
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);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
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);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
176
0
        return m_wallet->IsMine(dest) & ISMINE_SPENDABLE;
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
        isminetype* is_mine,
189
        AddressPurpose* purpose) override
190
0
    {
191
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
192
0
        const auto& entry = m_wallet->FindAddressBookEntry(dest, /*allow_change=*/false);
193
0
        if (!entry) return false; // addr not found
194
0
        if (name) {
195
0
            *name = entry->GetLabel();
196
0
        }
197
0
        std::optional<isminetype> dest_is_mine;
198
0
        if (is_mine || purpose) {
199
0
            dest_is_mine = m_wallet->IsMine(dest);
200
0
        }
201
0
        if (is_mine) {
202
0
            *is_mine = *dest_is_mine;
203
0
        }
204
0
        if (purpose) {
205
            // In very old wallets, address purpose may not be recorded so we derive it from IsMine
206
0
            *purpose = entry->purpose.value_or(*dest_is_mine ? AddressPurpose::RECEIVE : AddressPurpose::SEND);
207
0
        }
208
0
        return true;
209
0
    }
210
    std::vector<WalletAddress> getAddresses() override
211
0
    {
212
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
213
0
        std::vector<WalletAddress> result;
214
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) {
215
0
            if (is_change) return;
216
0
            isminetype is_mine = m_wallet->IsMine(dest);
217
            // In very old wallets, address purpose may not be recorded so we derive it from IsMine
218
0
            result.emplace_back(dest, is_mine, purpose.value_or(is_mine ? AddressPurpose::RECEIVE : AddressPurpose::SEND), label);
219
0
        });
220
0
        return result;
221
0
    }
222
0
    std::vector<std::string> getAddressReceiveRequests() override {
223
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
224
0
        return m_wallet->GetAddressReceiveRequests();
225
0
    }
226
0
    bool setAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& value) override {
227
        // Note: The setAddressReceiveRequest interface used by the GUI to store
228
        // receive requests is a little awkward and could be improved in the
229
        // future:
230
        //
231
        // - The same method is used to save requests and erase them, but
232
        //   having separate methods could be clearer and prevent bugs.
233
        //
234
        // - Request ids are passed as strings even though they are generated as
235
        //   integers.
236
        //
237
        // - Multiple requests can be stored for the same address, but it might
238
        //   be better to only allow one request or only keep the current one.
239
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
240
0
        WalletBatch batch{m_wallet->GetDatabase()};
241
0
        return value.empty() ? m_wallet->EraseAddressReceiveRequest(batch, dest, id)
242
0
                             : m_wallet->SetAddressReceiveRequest(batch, dest, id, value);
243
0
    }
244
    util::Result<void> displayAddress(const CTxDestination& dest) override
245
0
    {
246
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
247
0
        return m_wallet->DisplayAddress(dest);
248
0
    }
249
    bool lockCoin(const COutPoint& output, const bool write_to_db) override
250
0
    {
251
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
252
0
        std::unique_ptr<WalletBatch> batch = write_to_db ? std::make_unique<WalletBatch>(m_wallet->GetDatabase()) : nullptr;
253
0
        return m_wallet->LockCoin(output, batch.get());
254
0
    }
255
    bool unlockCoin(const COutPoint& output) override
256
0
    {
257
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
258
0
        std::unique_ptr<WalletBatch> batch = std::make_unique<WalletBatch>(m_wallet->GetDatabase());
259
0
        return m_wallet->UnlockCoin(output, batch.get());
260
0
    }
261
    bool isLockedCoin(const COutPoint& output) override
262
0
    {
263
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
264
0
        return m_wallet->IsLockedCoin(output);
265
0
    }
266
    void listLockedCoins(std::vector<COutPoint>& outputs) override
267
0
    {
268
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
269
0
        return m_wallet->ListLockedCoins(outputs);
270
0
    }
271
    util::Result<CTransactionRef> createTransaction(const std::vector<CRecipient>& recipients,
272
        const CCoinControl& coin_control,
273
        bool sign,
274
        int& change_pos,
275
        CAmount& fee) override
276
0
    {
277
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
278
0
        auto res = CreateTransaction(*m_wallet, recipients, change_pos == -1 ? std::nullopt : std::make_optional(change_pos),
279
0
                                     coin_control, sign);
280
0
        if (!res) return util::Error{util::ErrorString(res)};
281
0
        const auto& txr = *res;
282
0
        fee = txr.fee;
283
0
        change_pos = txr.change_pos ? int(*txr.change_pos) : -1;
284
285
0
        return txr.tx;
286
0
    }
287
    void commitTransaction(CTransactionRef tx,
288
        WalletValueMap value_map,
289
        WalletOrderForm order_form) override
290
0
    {
291
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
292
0
        m_wallet->CommitTransaction(std::move(tx), std::move(value_map), std::move(order_form));
293
0
    }
294
0
    bool transactionCanBeAbandoned(const uint256& txid) override { return m_wallet->TransactionCanBeAbandoned(txid); }
295
    bool abandonTransaction(const uint256& txid) override
296
0
    {
297
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
298
0
        return m_wallet->AbandonTransaction(txid);
299
0
    }
300
    bool transactionCanBeBumped(const uint256& txid) override
301
0
    {
302
0
        return feebumper::TransactionCanBeBumped(*m_wallet.get(), txid);
303
0
    }
304
    bool createBumpTransaction(const uint256& txid,
305
        const CCoinControl& coin_control,
306
        std::vector<bilingual_str>& errors,
307
        CAmount& old_fee,
308
        CAmount& new_fee,
309
        CMutableTransaction& mtx) override
310
0
    {
311
0
        std::vector<CTxOut> outputs; // just an empty list of new recipients for now
312
0
        return feebumper::CreateRateBumpTransaction(*m_wallet.get(), txid, coin_control, errors, old_fee, new_fee, mtx, /* require_mine= */ true, outputs) == feebumper::Result::OK;
313
0
    }
314
0
    bool signBumpTransaction(CMutableTransaction& mtx) override { return feebumper::SignTransaction(*m_wallet.get(), mtx); }
315
    bool commitBumpTransaction(const uint256& txid,
316
        CMutableTransaction&& mtx,
317
        std::vector<bilingual_str>& errors,
318
        uint256& bumped_txid) override
319
0
    {
320
0
        return feebumper::CommitTransaction(*m_wallet.get(), txid, std::move(mtx), errors, bumped_txid) ==
321
0
               feebumper::Result::OK;
322
0
    }
323
    CTransactionRef getTx(const uint256& txid) override
324
0
    {
325
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
326
0
        auto mi = m_wallet->mapWallet.find(txid);
327
0
        if (mi != m_wallet->mapWallet.end()) {
328
0
            return mi->second.tx;
329
0
        }
330
0
        return {};
331
0
    }
332
    WalletTx getWalletTx(const uint256& txid) override
333
0
    {
334
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
335
0
        auto mi = m_wallet->mapWallet.find(txid);
336
0
        if (mi != m_wallet->mapWallet.end()) {
337
0
            return MakeWalletTx(*m_wallet, mi->second);
338
0
        }
339
0
        return {};
340
0
    }
341
    std::set<WalletTx> getWalletTxs() override
342
0
    {
343
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
344
0
        std::set<WalletTx> result;
345
0
        for (const auto& entry : m_wallet->mapWallet) {
346
0
            result.emplace(MakeWalletTx(*m_wallet, entry.second));
347
0
        }
348
0
        return result;
349
0
    }
350
    bool tryGetTxStatus(const uint256& txid,
351
        interfaces::WalletTxStatus& tx_status,
352
        int& num_blocks,
353
        int64_t& block_time) override
354
0
    {
355
0
        TRY_LOCK(m_wallet->cs_wallet, locked_wallet);
Line
Count
Source
261
0
#define TRY_LOCK(cs, name) UniqueLock name(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__, true)
356
0
        if (!locked_wallet) {
357
0
            return false;
358
0
        }
359
0
        auto mi = m_wallet->mapWallet.find(txid);
360
0
        if (mi == m_wallet->mapWallet.end()) {
361
0
            return false;
362
0
        }
363
0
        num_blocks = m_wallet->GetLastBlockHeight();
364
0
        block_time = -1;
365
0
        CHECK_NONFATAL(m_wallet->chain().findBlock(m_wallet->GetLastBlockHash(), FoundBlock().time(block_time)));
Line
Count
Source
103
0
    inline_check_non_fatal(condition, __FILE__, __LINE__, __func__, #condition)
366
0
        tx_status = MakeWalletTxStatus(*m_wallet, mi->second);
367
0
        return true;
368
0
    }
369
    WalletTx getWalletTxDetails(const uint256& txid,
370
        WalletTxStatus& tx_status,
371
        WalletOrderForm& order_form,
372
        bool& in_mempool,
373
        int& num_blocks) override
374
0
    {
375
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
376
0
        auto mi = m_wallet->mapWallet.find(txid);
377
0
        if (mi != m_wallet->mapWallet.end()) {
378
0
            num_blocks = m_wallet->GetLastBlockHeight();
379
0
            in_mempool = mi->second.InMempool();
380
0
            order_form = mi->second.vOrderForm;
381
0
            tx_status = MakeWalletTxStatus(*m_wallet, mi->second);
382
0
            return MakeWalletTx(*m_wallet, mi->second);
383
0
        }
384
0
        return {};
385
0
    }
386
    std::optional<PSBTError> fillPSBT(int sighash_type,
387
        bool sign,
388
        bool bip32derivs,
389
        size_t* n_signed,
390
        PartiallySignedTransaction& psbtx,
391
        bool& complete) override
392
0
    {
393
0
        return m_wallet->FillPSBT(psbtx, complete, sighash_type, sign, bip32derivs, n_signed);
394
0
    }
395
    WalletBalances getBalances() override
396
0
    {
397
0
        const auto bal = GetBalance(*m_wallet);
398
0
        WalletBalances result;
399
0
        result.balance = bal.m_mine_trusted;
400
0
        result.unconfirmed_balance = bal.m_mine_untrusted_pending;
401
0
        result.immature_balance = bal.m_mine_immature;
402
0
        result.have_watch_only = false;
403
0
        return result;
404
0
    }
405
    bool tryGetBalances(WalletBalances& balances, uint256& block_hash) override
406
0
    {
407
0
        TRY_LOCK(m_wallet->cs_wallet, locked_wallet);
Line
Count
Source
261
0
#define TRY_LOCK(cs, name) UniqueLock name(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__, true)
408
0
        if (!locked_wallet) {
409
0
            return false;
410
0
        }
411
0
        block_hash = m_wallet->GetLastBlockHash();
412
0
        balances = getBalances();
413
0
        return true;
414
0
    }
415
0
    CAmount getBalance() override { return GetBalance(*m_wallet).m_mine_trusted; }
416
    CAmount getAvailableBalance(const CCoinControl& coin_control) override
417
0
    {
418
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
419
0
        CAmount total_amount = 0;
420
        // Fetch selected coins total amount
421
0
        if (coin_control.HasSelected()) {
422
0
            FastRandomContext rng{};
423
0
            CoinSelectionParams params(rng);
424
            // Note: for now, swallow any error.
425
0
            if (auto res = FetchSelectedInputs(*m_wallet, coin_control, params)) {
426
0
                total_amount += res->total_amount;
427
0
            }
428
0
        }
429
430
        // And fetch the wallet available coins
431
0
        if (coin_control.m_allow_other_inputs) {
432
0
            total_amount += AvailableCoins(*m_wallet, &coin_control).GetTotalAmount();
433
0
        }
434
435
0
        return total_amount;
436
0
    }
437
    isminetype txinIsMine(const CTxIn& txin) override
438
0
    {
439
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
440
0
        return InputIsMine(*m_wallet, txin);
441
0
    }
442
    isminetype txoutIsMine(const CTxOut& txout) override
443
0
    {
444
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
445
0
        return m_wallet->IsMine(txout);
446
0
    }
447
    CAmount getDebit(const CTxIn& txin, isminefilter filter) override
448
0
    {
449
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
450
0
        return m_wallet->GetDebit(txin, filter);
451
0
    }
452
    CAmount getCredit(const CTxOut& txout, isminefilter filter) override
453
0
    {
454
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
455
0
        return OutputGetCredit(*m_wallet, txout, filter);
456
0
    }
457
    CoinsList listCoins() override
458
0
    {
459
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
460
0
        CoinsList result;
461
0
        for (const auto& entry : ListCoins(*m_wallet)) {
462
0
            auto& group = result[entry.first];
463
0
            for (const auto& coin : entry.second) {
464
0
                group.emplace_back(coin.outpoint,
465
0
                    MakeWalletTxOut(*m_wallet, coin));
466
0
            }
467
0
        }
468
0
        return result;
469
0
    }
470
    std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) override
471
0
    {
472
0
        LOCK(m_wallet->cs_wallet);
Line
Count
Source
257
0
#define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
Line
Count
Source
11
0
#define UNIQUE_NAME(name) PASTE2(name, __COUNTER__)
Line
Count
Source
9
0
#define PASTE2(x, y) PASTE(x, y)
Line
Count
Source
8
0
#define PASTE(x, y) x ## y
473
0
        std::vector<WalletTxOut> result;
474
0
        result.reserve(outputs.size());
475
0
        for (const auto& output : outputs) {
476
0
            result.emplace_back();
477
0
            auto it = m_wallet->mapWallet.find(output.hash);
478
0
            if (it != m_wallet->mapWallet.end()) {
479
0
                int depth = m_wallet->GetTxDepthInMainChain(it->second);
480
0
                if (depth >= 0) {
481
0
                    result.back() = MakeWalletTxOut(*m_wallet, it->second, output.n, depth);
482
0
                }
483
0
            }
484
0
        }
485
0
        return result;
486
0
    }
487
0
    CAmount getRequiredFee(unsigned int tx_bytes) override { return GetRequiredFee(*m_wallet, tx_bytes); }
488
    CAmount getMinimumFee(unsigned int tx_bytes,
489
        const CCoinControl& coin_control,
490
        int* returned_target,
491
        FeeReason* reason) override
492
0
    {
493
0
        FeeCalculation fee_calc;
494
0
        CAmount result;
495
0
        result = GetMinimumFee(*m_wallet, tx_bytes, coin_control, &fee_calc);
496
0
        if (returned_target) *returned_target = fee_calc.returnedTarget;
497
0
        if (reason) *reason = fee_calc.reason;
498
0
        return result;
499
0
    }
500
0
    unsigned int getConfirmTarget() override { return m_wallet->m_confirm_target; }
501
0
    bool hdEnabled() override { return m_wallet->IsHDEnabled(); }
502
0
    bool canGetAddresses() override { return m_wallet->CanGetAddresses(); }
503
0
    bool hasExternalSigner() override { return m_wallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER); }
504
0
    bool privateKeysDisabled() override { return m_wallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS); }
505
0
    bool taprootEnabled() override {
506
0
        auto spk_man = m_wallet->GetScriptPubKeyMan(OutputType::BECH32M, /*internal=*/false);
507
0
        return spk_man != nullptr;
508
0
    }
509
0
    OutputType getDefaultAddressType() override { return m_wallet->m_default_address_type; }
510
0
    CAmount getDefaultMaxTxFee() override { return m_wallet->m_default_max_tx_fee; }
511
    void remove() override
512
0
    {
513
0
        RemoveWallet(m_context, m_wallet, /*load_on_start=*/false);
514
0
    }
515
    std::unique_ptr<Handler> handleUnload(UnloadFn fn) override
516
0
    {
517
0
        return MakeSignalHandler(m_wallet->NotifyUnload.connect(fn));
518
0
    }
519
    std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) override
520
0
    {
521
0
        return MakeSignalHandler(m_wallet->ShowProgress.connect(fn));
522
0
    }
523
    std::unique_ptr<Handler> handleStatusChanged(StatusChangedFn fn) override
524
0
    {
525
0
        return MakeSignalHandler(m_wallet->NotifyStatusChanged.connect([fn](CWallet*) { fn(); }));
526
0
    }
527
    std::unique_ptr<Handler> handleAddressBookChanged(AddressBookChangedFn fn) override
528
0
    {
529
0
        return MakeSignalHandler(m_wallet->NotifyAddressBookChanged.connect(
530
0
            [fn](const CTxDestination& address, const std::string& label, bool is_mine,
531
0
                 AddressPurpose purpose, ChangeType status) { fn(address, label, is_mine, purpose, status); }));
532
0
    }
533
    std::unique_ptr<Handler> handleTransactionChanged(TransactionChangedFn fn) override
534
0
    {
535
0
        return MakeSignalHandler(m_wallet->NotifyTransactionChanged.connect(
536
0
            [fn](const uint256& txid, ChangeType status) { fn(txid, status); }));
537
0
    }
538
    std::unique_ptr<Handler> handleWatchOnlyChanged(WatchOnlyChangedFn fn) override
539
0
    {
540
0
        return MakeSignalHandler(m_wallet->NotifyWatchonlyChanged.connect(fn));
541
0
    }
542
    std::unique_ptr<Handler> handleCanGetAddressesChanged(CanGetAddressesChangedFn fn) override
543
0
    {
544
0
        return MakeSignalHandler(m_wallet->NotifyCanGetAddressesChanged.connect(fn));
545
0
    }
546
0
    CWallet* wallet() override { return m_wallet.get(); }
547
548
    WalletContext& m_context;
549
    std::shared_ptr<CWallet> m_wallet;
550
};
551
552
class WalletLoaderImpl : public WalletLoader
553
{
554
public:
555
    WalletLoaderImpl(Chain& chain, ArgsManager& args)
556
0
    {
557
0
        m_context.chain = &chain;
558
0
        m_context.args = &args;
559
0
    }
560
0
    ~WalletLoaderImpl() override { UnloadWallets(m_context); }
561
562
    //! ChainClient methods
563
    void registerRpcs() override
564
0
    {
565
0
        for (const CRPCCommand& command : GetWalletRPCCommands()) {
566
0
            m_rpc_commands.emplace_back(command.category, command.name, [this, &command](const JSONRPCRequest& request, UniValue& result, bool last_handler) {
567
0
                JSONRPCRequest wallet_request = request;
568
0
                wallet_request.context = &m_context;
569
0
                return command.actor(wallet_request, result, last_handler);
570
0
            }, command.argNames, command.unique_id);
571
0
            m_rpc_handlers.emplace_back(m_context.chain->handleRpc(m_rpc_commands.back()));
572
0
        }
573
0
    }
574
0
    bool verify() override { return VerifyWallets(m_context); }
575
0
    bool load() override { return LoadWallets(m_context); }
576
    void start(CScheduler& scheduler) override
577
0
    {
578
0
        m_context.scheduler = &scheduler;
579
0
        return StartWallets(m_context);
580
0
    }
581
0
    void flush() override {}
582
0
    void stop() override { return StopWallets(m_context); }
583
0
    void setMockTime(int64_t time) override { return SetMockTime(time); }
584
0
    void schedulerMockForward(std::chrono::seconds delta) override { Assert(m_context.scheduler)->MockForward(delta); }
Line
Count
Source
106
0
#define Assert(val) inline_assertion_check<true>(val, __FILE__, __LINE__, __func__, #val)
585
586
    //! WalletLoader methods
587
    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
588
0
    {
589
0
        DatabaseOptions options;
590
0
        DatabaseStatus status;
591
0
        ReadDatabaseArgs(*m_context.args, options);
592
0
        options.require_create = true;
593
0
        options.create_flags = wallet_creation_flags;
594
0
        options.create_passphrase = passphrase;
595
0
        bilingual_str error;
596
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, CreateWallet(m_context, name, /*load_on_start=*/true, options, status, error, warnings))};
597
0
        if (wallet) {
598
0
            return wallet;
599
0
        } else {
600
0
            return util::Error{error};
601
0
        }
602
0
    }
603
    util::Result<std::unique_ptr<Wallet>> loadWallet(const std::string& name, std::vector<bilingual_str>& warnings) override
604
0
    {
605
0
        DatabaseOptions options;
606
0
        DatabaseStatus status;
607
0
        ReadDatabaseArgs(*m_context.args, options);
608
0
        options.require_existing = true;
609
0
        bilingual_str error;
610
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, LoadWallet(m_context, name, /*load_on_start=*/true, options, status, error, warnings))};
611
0
        if (wallet) {
612
0
            return wallet;
613
0
        } else {
614
0
            return util::Error{error};
615
0
        }
616
0
    }
617
    util::Result<std::unique_ptr<Wallet>> restoreWallet(const fs::path& backup_file, const std::string& wallet_name, std::vector<bilingual_str>& warnings) override
618
0
    {
619
0
        DatabaseStatus status;
620
0
        bilingual_str error;
621
0
        std::unique_ptr<Wallet> wallet{MakeWallet(m_context, RestoreWallet(m_context, backup_file, wallet_name, /*load_on_start=*/true, status, error, warnings))};
622
0
        if (wallet) {
623
0
            return wallet;
624
0
        } else {
625
0
            return util::Error{error};
626
0
        }
627
0
    }
628
    util::Result<WalletMigrationResult> migrateWallet(const std::string& name, const SecureString& passphrase) override
629
0
    {
630
0
        auto res = wallet::MigrateLegacyToDescriptor(name, passphrase, m_context);
631
0
        if (!res) return util::Error{util::ErrorString(res)};
632
0
        WalletMigrationResult out{
633
0
            .wallet = MakeWallet(m_context, res->wallet),
634
0
            .watchonly_wallet_name = res->watchonly_wallet ? std::make_optional(res->watchonly_wallet->GetName()) : std::nullopt,
635
0
            .solvables_wallet_name = res->solvables_wallet ? std::make_optional(res->solvables_wallet->GetName()) : std::nullopt,
636
0
            .backup_path = res->backup_path,
637
0
        };
638
0
        return out;
639
0
    }
640
    bool isEncrypted(const std::string& wallet_name) override
641
0
    {
642
0
        auto wallets{GetWallets(m_context)};
643
0
        auto it = std::find_if(wallets.begin(), wallets.end(), [&](std::shared_ptr<CWallet> w){ return w->GetName() == wallet_name; });
644
0
        if (it != wallets.end()) return (*it)->IsCrypted();
645
646
        // Unloaded wallet, read db
647
0
        DatabaseOptions options;
648
0
        options.require_existing = true;
649
0
        DatabaseStatus status;
650
0
        bilingual_str error;
651
0
        auto db = MakeWalletDatabase(wallet_name, options, status, error);
652
0
        if (!db) return false;
653
0
        return WalletBatch(*db).IsEncrypted();
654
0
    }
655
    std::string getWalletDir() override
656
0
    {
657
0
        return fs::PathToString(GetWalletDir());
658
0
    }
659
    std::vector<std::pair<std::string, std::string>> listWalletDir() override
660
0
    {
661
0
        std::vector<std::pair<std::string, std::string>> paths;
662
0
        for (auto& [path, format] : ListDatabases(GetWalletDir())) {
663
0
            paths.emplace_back(fs::PathToString(path), format);
664
0
        }
665
0
        return paths;
666
0
    }
667
    std::vector<std::unique_ptr<Wallet>> getWallets() override
668
0
    {
669
0
        std::vector<std::unique_ptr<Wallet>> wallets;
670
0
        for (const auto& wallet : GetWallets(m_context)) {
671
0
            wallets.emplace_back(MakeWallet(m_context, wallet));
672
0
        }
673
0
        return wallets;
674
0
    }
675
    std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) override
676
0
    {
677
0
        return HandleLoadWallet(m_context, std::move(fn));
678
0
    }
679
0
    WalletContext* context() override  { return &m_context; }
680
681
    WalletContext m_context;
682
    const std::vector<std::string> m_wallet_filenames;
683
    std::vector<std::unique_ptr<Handler>> m_rpc_handlers;
684
    std::list<CRPCCommand> m_rpc_commands;
685
};
686
} // namespace
687
} // namespace wallet
688
689
namespace interfaces {
690
0
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; }
691
692
std::unique_ptr<WalletLoader> MakeWalletLoader(Chain& chain, ArgsManager& args)
693
0
{
694
0
    return std::make_unique<wallet::WalletLoaderImpl>(chain, args);
695
0
}
696
} // namespace interfaces