Bitcoin Core  27.99.0
P2P Digital Currency
wallet_tests.cpp
Go to the documentation of this file.
1 // Copyright (c) 2012-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 <wallet/wallet.h>
6 
7 #include <future>
8 #include <memory>
9 #include <stdint.h>
10 #include <vector>
11 
12 #include <addresstype.h>
13 #include <interfaces/chain.h>
14 #include <key_io.h>
15 #include <node/blockstorage.h>
16 #include <policy/policy.h>
17 #include <rpc/server.h>
18 #include <script/solver.h>
19 #include <test/util/logging.h>
20 #include <test/util/random.h>
21 #include <test/util/setup_common.h>
22 #include <util/translation.h>
23 #include <validation.h>
24 #include <validationinterface.h>
25 #include <wallet/coincontrol.h>
26 #include <wallet/context.h>
27 #include <wallet/receive.h>
28 #include <wallet/spend.h>
29 #include <wallet/test/util.h>
31 
32 #include <boost/test/unit_test.hpp>
33 #include <univalue.h>
34 
36 
37 namespace wallet {
41 
42 // Ensure that fee levels defined in the wallet are at least as high
43 // as the default levels for node policy.
44 static_assert(DEFAULT_TRANSACTION_MINFEE >= DEFAULT_MIN_RELAY_TX_FEE, "wallet minimum fee is smaller than default relay fee");
45 static_assert(WALLET_INCREMENTAL_RELAY_FEE >= DEFAULT_INCREMENTAL_RELAY_FEE, "wallet incremental fee is smaller than default incremental relay fee");
46 
47 BOOST_FIXTURE_TEST_SUITE(wallet_tests, WalletTestingSetup)
48 
49 static CMutableTransaction TestSimpleSpend(const CTransaction& from, uint32_t index, const CKey& key, const CScript& pubkey)
50 {
52  mtx.vout.emplace_back(from.vout[index].nValue - DEFAULT_TRANSACTION_MAXFEE, pubkey);
53  mtx.vin.push_back({CTxIn{from.GetHash(), index}});
54  FillableSigningProvider keystore;
55  keystore.AddKey(key);
56  std::map<COutPoint, Coin> coins;
57  coins[mtx.vin[0].prevout].out = from.vout[index];
58  std::map<int, bilingual_str> input_errors;
59  BOOST_CHECK(SignTransaction(mtx, &keystore, coins, SIGHASH_ALL, input_errors));
60  return mtx;
61 }
62 
63 static void AddKey(CWallet& wallet, const CKey& key)
64 {
65  LOCK(wallet.cs_wallet);
66  FlatSigningProvider provider;
67  std::string error;
68  std::unique_ptr<Descriptor> desc = Parse("combo(" + EncodeSecret(key) + ")", provider, error, /* require_checksum=*/ false);
69  assert(desc);
70  WalletDescriptor w_desc(std::move(desc), 0, 0, 1, 1);
71  if (!wallet.AddWalletDescriptor(w_desc, provider, "", false)) assert(false);
72 }
73 
74 BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions, TestChain100Setup)
75 {
76  // Cap last block file size, and mine new block in a new block file.
77  CBlockIndex* oldTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
78  WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
79  CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
80  CBlockIndex* newTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
81 
82  // Verify ScanForWalletTransactions fails to read an unknown start block.
83  {
85  {
86  LOCK(wallet.cs_wallet);
87  LOCK(Assert(m_node.chainman)->GetMutex());
88  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
89  wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
90  }
91  AddKey(wallet, coinbaseKey);
92  WalletRescanReserver reserver(wallet);
93  reserver.reserve();
94  CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/{}, /*start_height=*/0, /*max_height=*/{}, reserver, /*fUpdate=*/false, /*save_progress=*/false);
99  BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
100  }
101 
102  // Verify ScanForWalletTransactions picks up transactions in both the old
103  // and new block files.
104  {
106  {
107  LOCK(wallet.cs_wallet);
108  LOCK(Assert(m_node.chainman)->GetMutex());
109  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
110  wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
111  }
112  AddKey(wallet, coinbaseKey);
113  WalletRescanReserver reserver(wallet);
114  std::chrono::steady_clock::time_point fake_time;
115  reserver.setNow([&] { fake_time += 60s; return fake_time; });
116  reserver.reserve();
117 
118  {
119  CBlockLocator locator;
120  BOOST_CHECK(!WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));
121  BOOST_CHECK(locator.IsNull());
122  }
123 
124  CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*fUpdate=*/false, /*save_progress=*/true);
127  BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
128  BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
129  BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 100 * COIN);
130 
131  {
132  CBlockLocator locator;
133  BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));
134  BOOST_CHECK(!locator.IsNull());
135  }
136  }
137 
138  // Prune the older block file.
139  int file_number;
140  {
141  LOCK(cs_main);
142  file_number = oldTip->GetBlockPos().nFile;
143  Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
144  }
145  m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});
146 
147  // Verify ScanForWalletTransactions only picks transactions in the new block
148  // file.
149  {
151  {
152  LOCK(wallet.cs_wallet);
153  LOCK(Assert(m_node.chainman)->GetMutex());
154  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
155  wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
156  }
157  AddKey(wallet, coinbaseKey);
158  WalletRescanReserver reserver(wallet);
159  reserver.reserve();
160  CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*fUpdate=*/false, /*save_progress=*/false);
163  BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
164  BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
165  BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 50 * COIN);
166  }
167 
168  // Prune the remaining block file.
169  {
170  LOCK(cs_main);
171  file_number = newTip->GetBlockPos().nFile;
172  Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
173  }
174  m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});
175 
176  // Verify ScanForWalletTransactions scans no blocks.
177  {
179  {
180  LOCK(wallet.cs_wallet);
181  LOCK(Assert(m_node.chainman)->GetMutex());
182  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
183  wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
184  }
185  AddKey(wallet, coinbaseKey);
186  WalletRescanReserver reserver(wallet);
187  reserver.reserve();
188  CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*fUpdate=*/false, /*save_progress=*/false);
190  BOOST_CHECK_EQUAL(result.last_failed_block, newTip->GetBlockHash());
193  BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
194  }
195 }
196 
198 {
199  // Cap last block file size, and mine new block in a new block file.
200  CBlockIndex* oldTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
201  WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
202  CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
203  CBlockIndex* newTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
204 
205  // Prune the older block file.
206  int file_number;
207  {
208  LOCK(cs_main);
209  file_number = oldTip->GetBlockPos().nFile;
210  Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
211  }
212  m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});
213 
214  // Verify importmulti RPC returns failure for a key whose creation time is
215  // before the missing block, and success for a key whose creation time is
216  // after.
217  {
218  const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
219  wallet->SetupLegacyScriptPubKeyMan();
220  WITH_LOCK(wallet->cs_wallet, wallet->SetLastBlockProcessed(newTip->nHeight, newTip->GetBlockHash()));
221  WalletContext context;
222  context.args = &m_args;
223  AddWallet(context, wallet);
224  UniValue keys;
225  keys.setArray();
226  UniValue key;
227  key.setObject();
228  key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(coinbaseKey.GetPubKey())));
229  key.pushKV("timestamp", 0);
230  key.pushKV("internal", UniValue(true));
231  keys.push_back(key);
232  key.clear();
233  key.setObject();
234  CKey futureKey = GenerateRandomKey();
235  key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(futureKey.GetPubKey())));
236  key.pushKV("timestamp", newTip->GetBlockTimeMax() + TIMESTAMP_WINDOW + 1);
237  key.pushKV("internal", UniValue(true));
238  keys.push_back(std::move(key));
239  JSONRPCRequest request;
240  request.context = &context;
241  request.params.setArray();
242  request.params.push_back(std::move(keys));
243 
244  UniValue response = importmulti().HandleRequest(request);
245  BOOST_CHECK_EQUAL(response.write(),
246  strprintf("[{\"success\":false,\"error\":{\"code\":-1,\"message\":\"Rescan failed for key with creation "
247  "timestamp %d. There was an error reading a block from time %d, which is after or within %d "
248  "seconds of key creation, and could contain transactions pertaining to the key. As a result, "
249  "transactions and coins using this key may not appear in the wallet. This error could be caused "
250  "by pruning or data corruption (see bitcoind log for details) and could be dealt with by "
251  "downloading and rescanning the relevant blocks (see -reindex option and rescanblockchain "
252  "RPC).\"}},{\"success\":true}]",
253  0, oldTip->GetBlockTimeMax(), TIMESTAMP_WINDOW));
254  RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
255  }
256 }
257 
258 // Verify importwallet RPC starts rescan at earliest block with timestamp
259 // greater or equal than key birthday. Previously there was a bug where
260 // importwallet RPC would start the scan at the latest block with timestamp less
261 // than or equal to key birthday.
263 {
264  // Create two blocks with same timestamp to verify that importwallet rescan
265  // will pick up both blocks, not just the first.
266  const int64_t BLOCK_TIME = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip()->GetBlockTimeMax() + 5);
267  SetMockTime(BLOCK_TIME);
268  m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
269  m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
270 
271  // Set key birthday to block time increased by the timestamp window, so
272  // rescan will start at the block time.
273  const int64_t KEY_TIME = BLOCK_TIME + TIMESTAMP_WINDOW;
274  SetMockTime(KEY_TIME);
275  m_coinbase_txns.emplace_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
276 
277  std::string backup_file = fs::PathToString(m_args.GetDataDirNet() / "wallet.backup");
278 
279  // Import key into wallet and call dumpwallet to create backup file.
280  {
281  WalletContext context;
282  context.args = &m_args;
283  const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
284  {
285  auto spk_man = wallet->GetOrCreateLegacyScriptPubKeyMan();
286  LOCK2(wallet->cs_wallet, spk_man->cs_KeyStore);
287  spk_man->mapKeyMetadata[coinbaseKey.GetPubKey().GetID()].nCreateTime = KEY_TIME;
288  spk_man->AddKeyPubKey(coinbaseKey, coinbaseKey.GetPubKey());
289 
290  AddWallet(context, wallet);
291  LOCK(Assert(m_node.chainman)->GetMutex());
292  wallet->SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
293  }
294  JSONRPCRequest request;
295  request.context = &context;
296  request.params.setArray();
297  request.params.push_back(backup_file);
298 
300  RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
301  }
302 
303  // Call importwallet RPC and verify all blocks with timestamps >= BLOCK_TIME
304  // were scanned, and no prior blocks were scanned.
305  {
306  const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
307  LOCK(wallet->cs_wallet);
308  wallet->SetupLegacyScriptPubKeyMan();
309 
310  WalletContext context;
311  context.args = &m_args;
312  JSONRPCRequest request;
313  request.context = &context;
314  request.params.setArray();
315  request.params.push_back(backup_file);
316  AddWallet(context, wallet);
317  LOCK(Assert(m_node.chainman)->GetMutex());
318  wallet->SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
320  RemoveWallet(context, wallet, /* load_on_start= */ std::nullopt);
321 
322  BOOST_CHECK_EQUAL(wallet->mapWallet.size(), 3U);
323  BOOST_CHECK_EQUAL(m_coinbase_txns.size(), 103U);
324  for (size_t i = 0; i < m_coinbase_txns.size(); ++i) {
325  bool found = wallet->GetWalletTx(m_coinbase_txns[i]->GetHash());
326  bool expected = i >= 100;
327  BOOST_CHECK_EQUAL(found, expected);
328  }
329  }
330 }
331 
332 // Check that GetImmatureCredit() returns a newly calculated value instead of
333 // the cached value after a MarkDirty() call.
334 //
335 // This is a regression test written to verify a bugfix for the immature credit
336 // function. Similar tests probably should be written for the other credit and
337 // debit functions.
338 BOOST_FIXTURE_TEST_CASE(coin_mark_dirty_immature_credit, TestChain100Setup)
339 {
341 
342  LOCK(wallet.cs_wallet);
343  LOCK(Assert(m_node.chainman)->GetMutex());
344  CWalletTx wtx{m_coinbase_txns.back(), TxStateConfirmed{m_node.chainman->ActiveChain().Tip()->GetBlockHash(), m_node.chainman->ActiveChain().Height(), /*index=*/0}};
345  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
346  wallet.SetupDescriptorScriptPubKeyMans();
347 
348  wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
349 
350  // Call GetImmatureCredit() once before adding the key to the wallet to
351  // cache the current immature credit amount, which is 0.
353 
354  // Invalidate the cached value, add the key, and make sure a new immature
355  // credit amount is calculated.
356  wtx.MarkDirty();
357  AddKey(wallet, coinbaseKey);
359 }
360 
361 static int64_t AddTx(ChainstateManager& chainman, CWallet& wallet, uint32_t lockTime, int64_t mockTime, int64_t blockTime)
362 {
364  TxState state = TxStateInactive{};
365  tx.nLockTime = lockTime;
366  SetMockTime(mockTime);
367  CBlockIndex* block = nullptr;
368  if (blockTime > 0) {
369  LOCK(cs_main);
370  auto inserted = chainman.BlockIndex().emplace(std::piecewise_construct, std::make_tuple(GetRandHash()), std::make_tuple());
371  assert(inserted.second);
372  const uint256& hash = inserted.first->first;
373  block = &inserted.first->second;
374  block->nTime = blockTime;
375  block->phashBlock = &hash;
376  state = TxStateConfirmed{hash, block->nHeight, /*index=*/0};
377  }
378  return wallet.AddToWallet(MakeTransactionRef(tx), state, [&](CWalletTx& wtx, bool /* new_tx */) {
379  // Assign wtx.m_state to simplify test and avoid the need to simulate
380  // reorg events. Without this, AddToWallet asserts false when the same
381  // transaction is confirmed in different blocks.
382  wtx.m_state = state;
383  return true;
384  })->nTimeSmart;
385 }
386 
387 // Simple test to verify assignment of CWalletTx::nSmartTime value. Could be
388 // expanded to cover more corner cases of smart time logic.
389 BOOST_AUTO_TEST_CASE(ComputeTimeSmart)
390 {
391  // New transaction should use clock time if lower than block time.
392  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 1, 100, 120), 100);
393 
394  // Test that updating existing transaction does not change smart time.
395  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 1, 200, 220), 100);
396 
397  // New transaction should use clock time if there's no block time.
398  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 2, 300, 0), 300);
399 
400  // New transaction should use block time if lower than clock time.
401  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 3, 420, 400), 400);
402 
403  // New transaction should use latest entry time if higher than
404  // min(block time, clock time).
405  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 4, 500, 390), 400);
406 
407  // If there are future entries, new transaction should use time of the
408  // newest entry that is no more than 300 seconds ahead of the clock time.
409  BOOST_CHECK_EQUAL(AddTx(*m_node.chainman, m_wallet, 5, 50, 600), 300);
410 }
411 
412 void TestLoadWallet(const std::string& name, DatabaseFormat format, std::function<void(std::shared_ptr<CWallet>)> f)
413 {
415  auto chain{interfaces::MakeChain(node)};
416  DatabaseOptions options;
417  options.require_format = format;
418  DatabaseStatus status;
419  bilingual_str error;
420  std::vector<bilingual_str> warnings;
421  auto database{MakeWalletDatabase(name, options, status, error)};
422  auto wallet{std::make_shared<CWallet>(chain.get(), "", std::move(database))};
424  WITH_LOCK(wallet->cs_wallet, f(wallet));
425 }
426 
428 {
430  const std::string name{strprintf("receive-requests-%i", format)};
431  TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {
432  BOOST_CHECK(!wallet->IsAddressPreviouslySpent(PKHash()));
433  WalletBatch batch{wallet->GetDatabase()};
434  BOOST_CHECK(batch.WriteAddressPreviouslySpent(PKHash(), true));
435  BOOST_CHECK(batch.WriteAddressPreviouslySpent(ScriptHash(), true));
436  BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "0", "val_rr00"));
437  BOOST_CHECK(wallet->EraseAddressReceiveRequest(batch, PKHash(), "0"));
438  BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "1", "val_rr10"));
439  BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, PKHash(), "1", "val_rr11"));
440  BOOST_CHECK(wallet->SetAddressReceiveRequest(batch, ScriptHash(), "2", "val_rr20"));
441  });
442  TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {
443  BOOST_CHECK(wallet->IsAddressPreviouslySpent(PKHash()));
444  BOOST_CHECK(wallet->IsAddressPreviouslySpent(ScriptHash()));
445  auto requests = wallet->GetAddressReceiveRequests();
446  auto erequests = {"val_rr11", "val_rr20"};
447  BOOST_CHECK_EQUAL_COLLECTIONS(requests.begin(), requests.end(), std::begin(erequests), std::end(erequests));
448  RunWithinTxn(wallet->GetDatabase(), /*process_desc*/"test", [](WalletBatch& batch){
449  BOOST_CHECK(batch.WriteAddressPreviouslySpent(PKHash(), false));
450  BOOST_CHECK(batch.EraseAddressData(ScriptHash()));
451  return true;
452  });
453  });
454  TestLoadWallet(name, format, [](std::shared_ptr<CWallet> wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet->cs_wallet) {
455  BOOST_CHECK(!wallet->IsAddressPreviouslySpent(PKHash()));
456  BOOST_CHECK(!wallet->IsAddressPreviouslySpent(ScriptHash()));
457  auto requests = wallet->GetAddressReceiveRequests();
458  auto erequests = {"val_rr11"};
459  BOOST_CHECK_EQUAL_COLLECTIONS(requests.begin(), requests.end(), std::begin(erequests), std::end(erequests));
460  });
461  }
462 }
463 
464 // Test some watch-only LegacyScriptPubKeyMan methods by the procedure of loading (LoadWatchOnly),
465 // checking (HaveWatchOnly), getting (GetWatchPubKey) and removing (RemoveWatchOnly) a
466 // given PubKey, resp. its corresponding P2PK Script. Results of the impact on
467 // the address -> PubKey map is dependent on whether the PubKey is a point on the curve
468 static void TestWatchOnlyPubKey(LegacyScriptPubKeyMan* spk_man, const CPubKey& add_pubkey)
469 {
470  CScript p2pk = GetScriptForRawPubKey(add_pubkey);
471  CKeyID add_address = add_pubkey.GetID();
472  CPubKey found_pubkey;
473  LOCK(spk_man->cs_KeyStore);
474 
475  // all Scripts (i.e. also all PubKeys) are added to the general watch-only set
476  BOOST_CHECK(!spk_man->HaveWatchOnly(p2pk));
477  spk_man->LoadWatchOnly(p2pk);
478  BOOST_CHECK(spk_man->HaveWatchOnly(p2pk));
479 
480  // only PubKeys on the curve shall be added to the watch-only address -> PubKey map
481  bool is_pubkey_fully_valid = add_pubkey.IsFullyValid();
482  if (is_pubkey_fully_valid) {
483  BOOST_CHECK(spk_man->GetWatchPubKey(add_address, found_pubkey));
484  BOOST_CHECK(found_pubkey == add_pubkey);
485  } else {
486  BOOST_CHECK(!spk_man->GetWatchPubKey(add_address, found_pubkey));
487  BOOST_CHECK(found_pubkey == CPubKey()); // passed key is unchanged
488  }
489 
490  spk_man->RemoveWatchOnly(p2pk);
491  BOOST_CHECK(!spk_man->HaveWatchOnly(p2pk));
492 
493  if (is_pubkey_fully_valid) {
494  BOOST_CHECK(!spk_man->GetWatchPubKey(add_address, found_pubkey));
495  BOOST_CHECK(found_pubkey == add_pubkey); // passed key is unchanged
496  }
497 }
498 
499 // Cryptographically invalidate a PubKey whilst keeping length and first byte
500 static void PollutePubKey(CPubKey& pubkey)
501 {
502  assert(pubkey.size() >= 1);
503  std::vector<unsigned char> pubkey_raw;
504  pubkey_raw.push_back(pubkey[0]);
505  pubkey_raw.insert(pubkey_raw.end(), pubkey.size() - 1, 0);
506  pubkey = CPubKey(pubkey_raw);
507  assert(!pubkey.IsFullyValid());
508  assert(pubkey.IsValid());
509 }
510 
511 // Test watch-only logic for PubKeys
512 BOOST_AUTO_TEST_CASE(WatchOnlyPubKeys)
513 {
514  CKey key;
515  CPubKey pubkey;
516  LegacyScriptPubKeyMan* spk_man = m_wallet.GetOrCreateLegacyScriptPubKeyMan();
517 
518  BOOST_CHECK(!spk_man->HaveWatchOnly());
519 
520  // uncompressed valid PubKey
521  key.MakeNewKey(false);
522  pubkey = key.GetPubKey();
523  assert(!pubkey.IsCompressed());
524  TestWatchOnlyPubKey(spk_man, pubkey);
525 
526  // uncompressed cryptographically invalid PubKey
527  PollutePubKey(pubkey);
528  TestWatchOnlyPubKey(spk_man, pubkey);
529 
530  // compressed valid PubKey
531  key.MakeNewKey(true);
532  pubkey = key.GetPubKey();
533  assert(pubkey.IsCompressed());
534  TestWatchOnlyPubKey(spk_man, pubkey);
535 
536  // compressed cryptographically invalid PubKey
537  PollutePubKey(pubkey);
538  TestWatchOnlyPubKey(spk_man, pubkey);
539 
540  // invalid empty PubKey
541  pubkey = CPubKey();
542  TestWatchOnlyPubKey(spk_man, pubkey);
543 }
544 
546 {
547 public:
549  {
550  CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
551  wallet = CreateSyncedWallet(*m_node.chain, WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain()), coinbaseKey);
552  }
553 
555  {
556  wallet.reset();
557  }
558 
560  {
561  CTransactionRef tx;
562  CCoinControl dummy;
563  {
564  auto res = CreateTransaction(*wallet, {recipient}, /*change_pos=*/std::nullopt, dummy);
565  BOOST_CHECK(res);
566  tx = res->tx;
567  }
568  wallet->CommitTransaction(tx, {}, {});
569  CMutableTransaction blocktx;
570  {
571  LOCK(wallet->cs_wallet);
572  blocktx = CMutableTransaction(*wallet->mapWallet.at(tx->GetHash()).tx);
573  }
574  CreateAndProcessBlock({CMutableTransaction(blocktx)}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
575 
576  LOCK(wallet->cs_wallet);
577  LOCK(Assert(m_node.chainman)->GetMutex());
578  wallet->SetLastBlockProcessed(wallet->GetLastBlockHeight() + 1, m_node.chainman->ActiveChain().Tip()->GetBlockHash());
579  auto it = wallet->mapWallet.find(tx->GetHash());
580  BOOST_CHECK(it != wallet->mapWallet.end());
581  it->second.m_state = TxStateConfirmed{m_node.chainman->ActiveChain().Tip()->GetBlockHash(), m_node.chainman->ActiveChain().Height(), /*index=*/1};
582  return it->second;
583  }
584 
585  std::unique_ptr<CWallet> wallet;
586 };
587 
589 {
590  std::string coinbaseAddress = coinbaseKey.GetPubKey().GetID().ToString();
591 
592  // Confirm ListCoins initially returns 1 coin grouped under coinbaseKey
593  // address.
594  std::map<CTxDestination, std::vector<COutput>> list;
595  {
596  LOCK(wallet->cs_wallet);
597  list = ListCoins(*wallet);
598  }
599  BOOST_CHECK_EQUAL(list.size(), 1U);
600  BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
601  BOOST_CHECK_EQUAL(list.begin()->second.size(), 1U);
602 
603  // Check initial balance from one mature coinbase transaction.
604  BOOST_CHECK_EQUAL(50 * COIN, WITH_LOCK(wallet->cs_wallet, return AvailableCoins(*wallet).GetTotalAmount()));
605 
606  // Add a transaction creating a change address, and confirm ListCoins still
607  // returns the coin associated with the change address underneath the
608  // coinbaseKey pubkey, even though the change address has a different
609  // pubkey.
610  AddTx(CRecipient{PubKeyDestination{{}}, 1 * COIN, /*subtract_fee=*/false});
611  {
612  LOCK(wallet->cs_wallet);
613  list = ListCoins(*wallet);
614  }
615  BOOST_CHECK_EQUAL(list.size(), 1U);
616  BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
617  BOOST_CHECK_EQUAL(list.begin()->second.size(), 2U);
618 
619  // Lock both coins. Confirm number of available coins drops to 0.
620  {
621  LOCK(wallet->cs_wallet);
623  }
624  for (const auto& group : list) {
625  for (const auto& coin : group.second) {
626  LOCK(wallet->cs_wallet);
627  wallet->LockCoin(coin.outpoint);
628  }
629  }
630  {
631  LOCK(wallet->cs_wallet);
633  }
634  // Confirm ListCoins still returns same result as before, despite coins
635  // being locked.
636  {
637  LOCK(wallet->cs_wallet);
638  list = ListCoins(*wallet);
639  }
640  BOOST_CHECK_EQUAL(list.size(), 1U);
641  BOOST_CHECK_EQUAL(std::get<PKHash>(list.begin()->first).ToString(), coinbaseAddress);
642  BOOST_CHECK_EQUAL(list.begin()->second.size(), 2U);
643 }
644 
645 void TestCoinsResult(ListCoinsTest& context, OutputType out_type, CAmount amount,
646  std::map<OutputType, size_t>& expected_coins_sizes)
647 {
648  LOCK(context.wallet->cs_wallet);
649  util::Result<CTxDestination> dest = Assert(context.wallet->GetNewDestination(out_type, ""));
650  CWalletTx& wtx = context.AddTx(CRecipient{*dest, amount, /*fSubtractFeeFromAmount=*/true});
651  CoinFilterParams filter;
652  filter.skip_locked = false;
653  CoinsResult available_coins = AvailableCoins(*context.wallet, nullptr, std::nullopt, filter);
654  // Lock outputs so they are not spent in follow-up transactions
655  for (uint32_t i = 0; i < wtx.tx->vout.size(); i++) context.wallet->LockCoin({wtx.GetHash(), i});
656  for (const auto& [type, size] : expected_coins_sizes) BOOST_CHECK_EQUAL(size, available_coins.coins[type].size());
657 }
658 
659 BOOST_FIXTURE_TEST_CASE(BasicOutputTypesTest, ListCoinsTest)
660 {
661  std::map<OutputType, size_t> expected_coins_sizes;
662  for (const auto& out_type : OUTPUT_TYPES) { expected_coins_sizes[out_type] = 0U; }
663 
664  // Verify our wallet has one usable coinbase UTXO before starting
665  // This UTXO is a P2PK, so it should show up in the Other bucket
666  expected_coins_sizes[OutputType::UNKNOWN] = 1U;
667  CoinsResult available_coins = WITH_LOCK(wallet->cs_wallet, return AvailableCoins(*wallet));
668  BOOST_CHECK_EQUAL(available_coins.Size(), expected_coins_sizes[OutputType::UNKNOWN]);
669  BOOST_CHECK_EQUAL(available_coins.coins[OutputType::UNKNOWN].size(), expected_coins_sizes[OutputType::UNKNOWN]);
670 
671  // We will create a self transfer for each of the OutputTypes and
672  // verify it is put in the correct bucket after running GetAvailablecoins
673  //
674  // For each OutputType, We expect 2 UTXOs in our wallet following the self transfer:
675  // 1. One UTXO as the recipient
676  // 2. One UTXO from the change, due to payment address matching logic
677 
678  for (const auto& out_type : OUTPUT_TYPES) {
679  if (out_type == OutputType::UNKNOWN) continue;
680  expected_coins_sizes[out_type] = 2U;
681  TestCoinsResult(*this, out_type, 1 * COIN, expected_coins_sizes);
682  }
683 }
684 
686 {
687  {
688  const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
689  wallet->SetupLegacyScriptPubKeyMan();
690  wallet->SetMinVersion(FEATURE_LATEST);
692  BOOST_CHECK(!wallet->TopUpKeyPool(1000));
693  BOOST_CHECK(!wallet->GetNewDestination(OutputType::BECH32, ""));
694  }
695  {
696  const std::shared_ptr<CWallet> wallet = std::make_shared<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
697  LOCK(wallet->cs_wallet);
698  wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
699  wallet->SetMinVersion(FEATURE_LATEST);
701  BOOST_CHECK(!wallet->GetNewDestination(OutputType::BECH32, ""));
702  }
703 }
704 
705 // Explicit calculation which is used to test the wallet constant
706 // We get the same virtual size due to rounding(weight/4) for both use_max_sig values
707 static size_t CalculateNestedKeyhashInputSize(bool use_max_sig)
708 {
709  // Generate ephemeral valid pubkey
710  CKey key = GenerateRandomKey();
711  CPubKey pubkey = key.GetPubKey();
712 
713  // Generate pubkey hash
714  uint160 key_hash(Hash160(pubkey));
715 
716  // Create inner-script to enter into keystore. Key hash can't be 0...
717  CScript inner_script = CScript() << OP_0 << std::vector<unsigned char>(key_hash.begin(), key_hash.end());
718 
719  // Create outer P2SH script for the output
720  uint160 script_id(Hash160(inner_script));
721  CScript script_pubkey = CScript() << OP_HASH160 << std::vector<unsigned char>(script_id.begin(), script_id.end()) << OP_EQUAL;
722 
723  // Add inner-script to key store and key to watchonly
724  FillableSigningProvider keystore;
725  keystore.AddCScript(inner_script);
726  keystore.AddKeyPubKey(key, pubkey);
727 
728  // Fill in dummy signatures for fee calculation.
729  SignatureData sig_data;
730 
731  if (!ProduceSignature(keystore, use_max_sig ? DUMMY_MAXIMUM_SIGNATURE_CREATOR : DUMMY_SIGNATURE_CREATOR, script_pubkey, sig_data)) {
732  // We're hand-feeding it correct arguments; shouldn't happen
733  assert(false);
734  }
735 
736  CTxIn tx_in;
737  UpdateInput(tx_in, sig_data);
738  return (size_t)GetVirtualTransactionInputSize(tx_in);
739 }
740 
742 {
745 }
746 
747 bool malformed_descriptor(std::ios_base::failure e)
748 {
749  std::string s(e.what());
750  return s.find("Missing checksum") != std::string::npos;
751 }
752 
754 {
755  std::vector<unsigned char> malformed_record;
756  VectorWriter vw{malformed_record, 0};
757  vw << std::string("notadescriptor");
758  vw << uint64_t{0};
759  vw << int32_t{0};
760  vw << int32_t{0};
761  vw << int32_t{1};
762 
763  SpanReader vr{malformed_record};
764  WalletDescriptor w_desc;
765  BOOST_CHECK_EXCEPTION(vr >> w_desc, std::ios_base::failure, malformed_descriptor);
766 }
767 
787 {
788  m_args.ForceSetArg("-unsafesqlitesync", "1");
789  // Create new wallet with known key and unload it.
790  WalletContext context;
791  context.args = &m_args;
792  context.chain = m_node.chain.get();
793  auto wallet = TestLoadWallet(context);
794  CKey key = GenerateRandomKey();
795  AddKey(*wallet, key);
796  TestUnloadWallet(std::move(wallet));
797 
798 
799  // Add log hook to detect AddToWallet events from rescans, blockConnected,
800  // and transactionAddedToMempool notifications
801  int addtx_count = 0;
802  DebugLogHelper addtx_counter("[default wallet] AddToWallet", [&](const std::string* s) {
803  if (s) ++addtx_count;
804  return false;
805  });
806 
807 
808  bool rescan_completed = false;
809  DebugLogHelper rescan_check("[default wallet] Rescan completed", [&](const std::string* s) {
810  if (s) rescan_completed = true;
811  return false;
812  });
813 
814 
815  // Block the queue to prevent the wallet receiving blockConnected and
816  // transactionAddedToMempool notifications, and create block and mempool
817  // transactions paying to the wallet
818  std::promise<void> promise;
819  m_node.validation_signals->CallFunctionInValidationInterfaceQueue([&promise] {
820  promise.get_future().wait();
821  });
822  std::string error;
823  m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
824  auto block_tx = TestSimpleSpend(*m_coinbase_txns[0], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
825  m_coinbase_txns.push_back(CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
826  auto mempool_tx = TestSimpleSpend(*m_coinbase_txns[1], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
827  BOOST_CHECK(m_node.chain->broadcastTransaction(MakeTransactionRef(mempool_tx), DEFAULT_TRANSACTION_MAXFEE, false, error));
828 
829 
830  // Reload wallet and make sure new transactions are detected despite events
831  // being blocked
832  // Loading will also ask for current mempool transactions
833  wallet = TestLoadWallet(context);
834  BOOST_CHECK(rescan_completed);
835  // AddToWallet events for block_tx and mempool_tx (x2)
836  BOOST_CHECK_EQUAL(addtx_count, 3);
837  {
838  LOCK(wallet->cs_wallet);
839  BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_tx.GetHash()), 1U);
840  BOOST_CHECK_EQUAL(wallet->mapWallet.count(mempool_tx.GetHash()), 1U);
841  }
842 
843 
844  // Unblock notification queue and make sure stale blockConnected and
845  // transactionAddedToMempool events are processed
846  promise.set_value();
847  m_node.validation_signals->SyncWithValidationInterfaceQueue();
848  // AddToWallet events for block_tx and mempool_tx events are counted a
849  // second time as the notification queue is processed
850  BOOST_CHECK_EQUAL(addtx_count, 5);
851 
852 
853  TestUnloadWallet(std::move(wallet));
854 
855 
856  // Load wallet again, this time creating new block and mempool transactions
857  // paying to the wallet as the wallet finishes loading and syncing the
858  // queue so the events have to be handled immediately. Releasing the wallet
859  // lock during the sync is a little artificial but is needed to avoid a
860  // deadlock during the sync and simulates a new block notification happening
861  // as soon as possible.
862  addtx_count = 0;
863  auto handler = HandleLoadWallet(context, [&](std::unique_ptr<interfaces::Wallet> wallet) {
864  BOOST_CHECK(rescan_completed);
865  m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
866  block_tx = TestSimpleSpend(*m_coinbase_txns[2], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
867  m_coinbase_txns.push_back(CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
868  mempool_tx = TestSimpleSpend(*m_coinbase_txns[3], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
869  BOOST_CHECK(m_node.chain->broadcastTransaction(MakeTransactionRef(mempool_tx), DEFAULT_TRANSACTION_MAXFEE, false, error));
870  m_node.validation_signals->SyncWithValidationInterfaceQueue();
871  });
872  wallet = TestLoadWallet(context);
873  // Since mempool transactions are requested at the end of loading, there will
874  // be 2 additional AddToWallet calls, one from the previous test, and a duplicate for mempool_tx
875  BOOST_CHECK_EQUAL(addtx_count, 2 + 2);
876  {
877  LOCK(wallet->cs_wallet);
878  BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_tx.GetHash()), 1U);
879  BOOST_CHECK_EQUAL(wallet->mapWallet.count(mempool_tx.GetHash()), 1U);
880  }
881 
882 
883  TestUnloadWallet(std::move(wallet));
884 }
885 
886 BOOST_FIXTURE_TEST_CASE(CreateWalletWithoutChain, BasicTestingSetup)
887 {
888  WalletContext context;
889  context.args = &m_args;
890  auto wallet = TestLoadWallet(context);
892  UnloadWallet(std::move(wallet));
893 }
894 
896 {
897  m_args.ForceSetArg("-unsafesqlitesync", "1");
898  WalletContext context;
899  context.args = &m_args;
900  context.chain = m_node.chain.get();
901  auto wallet = TestLoadWallet(context);
902  CKey key = GenerateRandomKey();
903  AddKey(*wallet, key);
904 
905  std::string error;
906  m_coinbase_txns.push_back(CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())).vtx[0]);
907  auto block_tx = TestSimpleSpend(*m_coinbase_txns[0], 0, coinbaseKey, GetScriptForRawPubKey(key.GetPubKey()));
908  CreateAndProcessBlock({block_tx}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
909 
910  m_node.validation_signals->SyncWithValidationInterfaceQueue();
911 
912  {
913  auto block_hash = block_tx.GetHash();
914  auto prev_tx = m_coinbase_txns[0];
915 
916  LOCK(wallet->cs_wallet);
917  BOOST_CHECK(wallet->HasWalletSpend(prev_tx));
918  BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_hash), 1u);
919 
920  std::vector<uint256> vHashIn{ block_hash };
921  BOOST_CHECK(wallet->RemoveTxs(vHashIn));
922 
923  BOOST_CHECK(!wallet->HasWalletSpend(prev_tx));
924  BOOST_CHECK_EQUAL(wallet->mapWallet.count(block_hash), 0u);
925  }
926 
927  TestUnloadWallet(std::move(wallet));
928 }
929 
934 BOOST_FIXTURE_TEST_CASE(wallet_sync_tx_invalid_state_test, TestingSetup)
935 {
937  {
938  LOCK(wallet.cs_wallet);
939  wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
940  wallet.SetupDescriptorScriptPubKeyMans();
941  }
942 
943  // Add tx to wallet
944  const auto op_dest{*Assert(wallet.GetNewDestination(OutputType::BECH32M, ""))};
945 
947  mtx.vout.emplace_back(COIN, GetScriptForDestination(op_dest));
948  mtx.vin.emplace_back(Txid::FromUint256(g_insecure_rand_ctx.rand256()), 0);
949  const auto& tx_id_to_spend = wallet.AddToWallet(MakeTransactionRef(mtx), TxStateInMempool{})->GetHash();
950 
951  {
952  // Cache and verify available balance for the wtx
953  LOCK(wallet.cs_wallet);
954  const CWalletTx* wtx_to_spend = wallet.GetWalletTx(tx_id_to_spend);
956  }
957 
958  // Now the good case:
959  // 1) Add a transaction that spends the previously created transaction
960  // 2) Verify that the available balance of this new tx and the old one is updated (prev tx is marked dirty)
961 
962  mtx.vin.clear();
963  mtx.vin.emplace_back(tx_id_to_spend, 0);
964  wallet.transactionAddedToMempool(MakeTransactionRef(mtx));
965  const auto good_tx_id{mtx.GetHash()};
966 
967  {
968  // Verify balance update for the new tx and the old one
969  LOCK(wallet.cs_wallet);
970  const CWalletTx* new_wtx = wallet.GetWalletTx(good_tx_id.ToUint256());
972 
973  // Now the old wtx
974  const CWalletTx* wtx_to_spend = wallet.GetWalletTx(tx_id_to_spend);
976  }
977 
978  // Now the bad case:
979  // 1) Make db always fail
980  // 2) Try to add a transaction that spends the previously created transaction and
981  // verify that we are not moving forward if the wallet cannot store it
983  mtx.vin.clear();
984  mtx.vin.emplace_back(good_tx_id, 0);
985  BOOST_CHECK_EXCEPTION(wallet.transactionAddedToMempool(MakeTransactionRef(mtx)),
986  std::runtime_error,
987  HasReason("DB error adding transaction to wallet, write failed"));
988 }
989 
991 } // namespace wallet
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
static constexpr CAmount COIN
The amount of satoshis in one BTC.
Definition: amount.h:15
node::NodeContext m_node
Definition: bitcoin-gui.cpp:37
static constexpr int64_t TIMESTAMP_WINDOW
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps...
Definition: chain.h:37
#define Assert(val)
Identity function.
Definition: check.h:77
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:141
uint32_t nTime
Definition: chain.h:190
uint256 GetBlockHash() const
Definition: chain.h:244
int64_t GetBlockTimeMax() const
Definition: chain.h:272
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:153
FlatFilePos GetBlockPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition: chain.h:209
const uint256 * phashBlock
pointer to the hash of the block, if any. Memory is owned by this CBlockIndex
Definition: chain.h:144
An encapsulated private key.
Definition: key.h:33
void MakeNewKey(bool fCompressed)
Generate a new private key using a cryptographic PRNG.
Definition: key.cpp:161
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:182
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:24
An encapsulated public key.
Definition: pubkey.h:34
bool IsCompressed() const
Check whether this is a compressed public key.
Definition: pubkey.h:204
CKeyID GetID() const
Get the KeyID of this public key (hash of its serialization)
Definition: pubkey.h:164
bool IsValid() const
Definition: pubkey.h:189
bool IsFullyValid() const
fully validate whether this is a valid public key (more expensive than IsValid())
Definition: pubkey.cpp:316
unsigned int size() const
Simple read-only vector-like interface to the pubkey data.
Definition: pubkey.h:112
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:414
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:296
An input of a transaction.
Definition: transaction.h:67
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:849
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:1088
uint256 rand256() noexcept
generate a random uint256.
Definition: random.cpp:662
Fillable signing provider that keeps keys in an address->secret map.
virtual bool AddKeyPubKey(const CKey &key, const CPubKey &pubkey)
virtual bool AddCScript(const CScript &redeemScript)
virtual bool AddKey(const CKey &key)
RecursiveMutex cs_KeyStore
BOOST_CHECK_EXCEPTION predicates to check the specific validation error.
Definition: setup_common.h:246
UniValue params
Definition: request.h:38
std::any context
Definition: request.h:43
UniValue HandleRequest(const JSONRPCRequest &request) const
Definition: util.cpp:613
Minimal stream for reading from an existing byte array by Span.
Definition: streams.h:101
void push_back(UniValue val)
Definition: univalue.cpp:104
void setArray()
Definition: univalue.cpp:92
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
void clear()
Definition: univalue.cpp:18
void setObject()
Definition: univalue.cpp:98
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
constexpr bool IsNull() const
Definition: uint256.h:42
constexpr unsigned char * end()
Definition: uint256.h:69
constexpr unsigned char * begin()
Definition: uint256.h:68
static transaction_identifier FromUint256(const uint256 &id)
160-bit opaque blob.
Definition: uint256.h:95
256-bit opaque blob.
Definition: uint256.h:106
Coin Control Features.
Definition: coincontrol.h:81
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:301
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:177
CTransactionRef tx
Definition: transaction.h:258
bool HaveWatchOnly(const CScript &dest) const
Returns whether the watch-only script is in the wallet.
bool LoadWatchOnly(const CScript &dest)
Adds a watch-only address to the store, without saving it to disk (used by LoadWallet)
bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const
Fetches a pubkey from mapWatchKeys if it exists there.
bool RemoveWatchOnly(const CScript &dest)
Remove a watch only script from the keystore.
std::unique_ptr< CWallet > wallet
CWalletTx & AddTx(CRecipient recipient)
Access to the wallet database.
Definition: walletdb.h:191
Descriptor with some wallet metadata.
Definition: walletutil.h:85
RAII object to check and reserve a wallet rescan.
Definition: wallet.h:1072
void setNow(NowFn now)
Definition: wallet.h:1102
bool reserve(bool with_passphrase=false)
Definition: wallet.h:1082
static UniValue Parse(std::string_view raw)
Parse string to UniValue or throw runtime_error if string contains invalid JSON.
Definition: client.cpp:318
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
BOOST_AUTO_TEST_SUITE_END()
uint160 Hash160(const T1 &in1)
Compute the 160-bit hash an object.
Definition: hash.h:92
@ SIGHASH_ALL
Definition: interpreter.h:30
CKey GenerateRandomKey(bool compressed) noexcept
Definition: key.cpp:366
std::string EncodeSecret(const CKey &key)
Definition: key_io.cpp:227
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
Definition: interfaces.cpp:836
Definition: init.h:25
static const unsigned int MAX_BLOCKFILE_SIZE
The maximum size of a blk?????.dat file (since 0.8)
Definition: blockstorage.h:74
void format(std::ostream &out, const char *fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1060
static constexpr size_t DUMMY_NESTED_P2WPKH_INPUT_SIZE
Pre-calculated constants for input size estimation in virtual size
Definition: wallet.h:144
void UnloadWallet(std::shared_ptr< CWallet > &&wallet)
Explicitly unload and delete the wallet.
Definition: wallet.cpp:237
static CMutableTransaction TestSimpleSpend(const CTransaction &from, uint32_t index, const CKey &key, const CScript &pubkey)
CAmount CachedTxGetAvailableCredit(const CWallet &wallet, const CWalletTx &wtx, const isminefilter &filter)
Definition: receive.cpp:159
Balance GetBalance(const CWallet &wallet, const int min_depth, bool avoid_reuse)
Definition: receive.cpp:293
void TestLoadWallet(const std::string &name, DatabaseFormat format, std::function< void(std::shared_ptr< CWallet >)> f)
util::Result< CreatedTransactionResult > CreateTransaction(CWallet &wallet, const std::vector< CRecipient > &vecSend, std::optional< unsigned int > change_pos, const CCoinControl &coin_control, bool sign)
Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also cr...
Definition: spend.cpp:1333
static void PollutePubKey(CPubKey &pubkey)
constexpr CAmount DEFAULT_TRANSACTION_MAXFEE
-maxtxfee default
Definition: wallet.h:138
RPCHelpMan importwallet()
Definition: backup.cpp:487
static bool RunWithinTxn(WalletBatch &batch, std::string_view process_desc, const std::function< bool(WalletBatch &)> &func)
Definition: walletdb.cpp:1236
std::variant< TxStateConfirmed, TxStateInMempool, TxStateBlockConflicted, TxStateInactive, TxStateUnrecognized > TxState
All possible CWalletTx states.
Definition: transaction.h:78
BOOST_FIXTURE_TEST_CASE(wallet_coinsresult_test, BasicTestingSetup)
RPCHelpMan importmulti()
Definition: backup.cpp:1235
std::shared_ptr< CWallet > TestLoadWallet(std::unique_ptr< WalletDatabase > database, WalletContext &context, uint64_t create_flags)
Definition: util.cpp:49
DatabaseFormat
Definition: db.h:183
static const DatabaseFormat DATABASE_FORMATS[]
Definition: util.h:28
std::unique_ptr< interfaces::Handler > HandleLoadWallet(WalletContext &context, LoadWalletFn load_wallet)
Definition: wallet.cpp:198
std::unique_ptr< CWallet > CreateSyncedWallet(interfaces::Chain &chain, CChain &cchain, const CKey &key)
Definition: util.cpp:20
static const CAmount DEFAULT_TRANSACTION_MINFEE
-mintxfee default
Definition: wallet.h:111
BOOST_AUTO_TEST_CASE(WatchOnlyPubKeys)
void TestUnloadWallet(std::shared_ptr< CWallet > &&wallet)
Definition: util.cpp:72
static void AddTx(CWallet &wallet)
std::unique_ptr< WalletDatabase > MakeWalletDatabase(const std::string &name, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error_string)
Definition: wallet.cpp:2926
MockableDatabase & GetMockableDatabase(CWallet &wallet)
Definition: util.cpp:190
static int64_t AddTx(ChainstateManager &chainman, CWallet &wallet, uint32_t lockTime, int64_t mockTime, int64_t blockTime)
RPCHelpMan dumpwallet()
Definition: backup.cpp:682
std::map< CTxDestination, std::vector< COutput > > ListCoins(const CWallet &wallet)
Return list of available coins and locked coins grouped by non-change output address.
Definition: spend.cpp:495
std::unique_ptr< WalletDatabase > CreateMockableWalletDatabase(MockableData records)
Definition: util.cpp:185
static void TestWatchOnlyPubKey(LegacyScriptPubKeyMan *spk_man, const CPubKey &add_pubkey)
@ ISMINE_SPENDABLE
Definition: types.h:43
CoinsResult AvailableCoinsListUnspent(const CWallet &wallet, const CCoinControl *coinControl, CoinFilterParams params)
Wrapper function for AvailableCoins which skips the feerate and CoinFilterParams::only_spendable para...
Definition: spend.cpp:469
static void AddKey(CWallet &wallet, const CKey &key)
bool AddWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet)
Definition: wallet.cpp:138
static const CAmount WALLET_INCREMENTAL_RELAY_FEE
minimum recommended increment for replacement txs
Definition: wallet.h:125
@ FEATURE_LATEST
Definition: walletutil.h:30
BOOST_FIXTURE_TEST_CASE(wallet_sync_tx_invalid_state_test, TestingSetup)
Checks a wallet invalid state where the inputs (prev-txs) of a new arriving transaction are not marke...
CAmount CachedTxGetImmatureCredit(const CWallet &wallet, const CWalletTx &wtx, const isminefilter &filter)
Definition: receive.cpp:148
bool malformed_descriptor(std::ios_base::failure e)
std::shared_ptr< CWallet > CreateWallet(WalletContext &context, const std::string &name, std::optional< bool > load_on_start, DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:371
void TestCoinsResult(ListCoinsTest &context, OutputType out_type, CAmount amount, std::map< OutputType, size_t > &expected_coins_sizes)
BOOST_AUTO_TEST_CASE(bnb_search_test)
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:74
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
Definition: walletutil.h:51
static size_t CalculateNestedKeyhashInputSize(bool use_max_sig)
DatabaseStatus
Definition: db.h:204
bool RemoveWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet, std::optional< bool > load_on_start, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:150
std::shared_ptr< CWallet > wallet
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18
#define BOOST_CHECK(expr)
Definition: object.cpp:17
OutputType
Definition: outputtype.h:17
static constexpr auto OUTPUT_TYPES
Definition: outputtype.h:25
int64_t GetVirtualTransactionInputSize(const CTxIn &txin, int64_t nSigOpCost, unsigned int bytes_per_sigop)
Definition: policy.cpp:305
static constexpr unsigned int DEFAULT_INCREMENTAL_RELAY_FEE
Default for -incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or rep...
Definition: policy.h:35
static constexpr unsigned int DEFAULT_MIN_RELAY_TX_FEE
Default for -minrelaytxfee, minimum relay fee for transactions.
Definition: policy.h:57
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:424
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
uint256 GetRandHash() noexcept
Definition: random.cpp:648
void SignTransaction(CMutableTransaction &mtx, const SigningProvider *keystore, const std::map< COutPoint, Coin > &coins, const UniValue &hashType, UniValue &result)
Sign a transaction with the given keystore and previous transactions.
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:1006
const char * name
Definition: rest.cpp:48
@ OP_EQUAL
Definition: script.h:145
bool ProduceSignature(const SigningProvider &provider, const BaseSignatureCreator &creator, const CScript &fromPubKey, SignatureData &sigdata)
Produce a script signature using a generic signature creator.
Definition: sign.cpp:499
void UpdateInput(CTxIn &input, const SignatureData &data)
Definition: sign.cpp:672
const BaseSignatureCreator & DUMMY_MAXIMUM_SIGNATURE_CREATOR
A signature creator that just produces 72-byte empty signatures.
Definition: sign.cpp:763
const BaseSignatureCreator & DUMMY_SIGNATURE_CREATOR
A signature creator that just produces 71-byte empty signatures.
Definition: sign.cpp:762
CScript GetScriptForRawPubKey(const CPubKey &pubKey)
Generate a P2PK script for the given pubkey.
Definition: solver.cpp:209
Basic testing setup.
Definition: setup_common.h:54
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:124
bool IsNull() const
Definition: block.h:152
A mutable version of CTransaction.
Definition: transaction.h:378
std::vector< CTxOut > vout
Definition: transaction.h:380
Txid GetHash() const
Compute the hash of this CMutableTransaction.
Definition: transaction.cpp:69
std::vector< CTxIn > vin
Definition: transaction.h:379
int nFile
Definition: flatfile.h:16
Testing fixture that pre-creates a 100-block REGTEST-mode block chain.
Definition: setup_common.h:106
Testing setup that configures a complete environment.
Definition: setup_common.h:85
Bilingual messages:
Definition: translation.h:18
NodeContext struct containing references to chain state and connection state.
Definition: context.h:53
std::unique_ptr< ValidationSignals > validation_signals
Issues calls about blocks and transactions.
Definition: context.h:82
std::unique_ptr< ChainstateManager > chainman
Definition: context.h:67
std::unique_ptr< interfaces::Chain > chain
Definition: context.h:71
std::optional< int > last_scanned_height
Definition: wallet.h:623
uint256 last_scanned_block
Hash and height of most recent block that was successfully scanned.
Definition: wallet.h:622
uint256 last_failed_block
Height of the most recent block that could not be scanned due to read errors or pruning.
Definition: wallet.h:629
enum wallet::CWallet::ScanResult::@18 status
COutputs available for spending, stored by OutputType.
Definition: spend.h:40
size_t Size() const
The following methods are provided so that CoinsResult can mimic a vector, i.e., methods can work wit...
Definition: spend.cpp:183
std::map< OutputType, std::vector< COutput > > coins
Definition: spend.h:41
std::optional< DatabaseFormat > require_format
Definition: db.h:193
State of transaction confirmed in a block.
Definition: transaction.h:31
State of transaction added to mempool.
Definition: transaction.h:41
State of transaction not confirmed or conflicting with a known block and not in the mempool.
Definition: transaction.h:58
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:36
interfaces::Chain * chain
Definition: context.h:37
ArgsManager * args
Definition: context.h:39
#define LOCK2(cs1, cs2)
Definition: sync.h:258
#define LOCK(cs)
Definition: sync.h:257
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:301
FastRandomContext g_insecure_rand_ctx
This global and the helpers that use it are not thread-safe.
Definition: random.cpp:14
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:32
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1162
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
assert(!tx.IsCoinBase())
std::shared_ptr< CWallet > m_wallet
Definition: interfaces.cpp:562
static void AvailableCoins(benchmark::Bench &bench, const std::vector< OutputType > &output_type)