Bitcoin Core 29.99.0
P2P Digital Currency
walletload_tests.cpp
Go to the documentation of this file.
1// Copyright (c) 2022 The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or https://www.opensource.org/licenses/mit-license.php.
4
5#include <wallet/test/util.h>
6#include <wallet/wallet.h>
7#include <test/util/logging.h>
9
10#include <boost/test/unit_test.hpp>
11
12namespace wallet {
13
14BOOST_AUTO_TEST_SUITE(walletload_tests)
15
16class DummyDescriptor final : public Descriptor {
17private:
18 std::string desc;
19public:
20 explicit DummyDescriptor(const std::string& descriptor) : desc(descriptor) {};
21 ~DummyDescriptor() = default;
22
23 std::string ToString(bool compat_format) const override { return desc; }
24 std::optional<OutputType> GetOutputType() const override { return OutputType::UNKNOWN; }
25
26 bool IsRange() const override { return false; }
27 bool IsSolvable() const override { return false; }
28 bool IsSingleType() const override { return true; }
29 bool ToPrivateString(const SigningProvider& provider, std::string& out) const override { return false; }
30 bool ToNormalizedString(const SigningProvider& provider, std::string& out, const DescriptorCache* cache = nullptr) const override { return false; }
31 bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const override { return false; };
32 bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const override { return false; }
33 void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const override {}
34 std::optional<int64_t> ScriptSize() const override { return {}; }
35 std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
36 std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
37 void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override {}
38};
39
40BOOST_FIXTURE_TEST_CASE(wallet_load_descriptors, TestingSetup)
41{
42 std::unique_ptr<WalletDatabase> database = CreateMockableWalletDatabase();
43 {
44 // Write unknown active descriptor
45 WalletBatch batch(*database);
46 std::string unknown_desc = "trx(tpubD6NzVbkrYhZ4Y4S7m6Y5s9GD8FqEMBy56AGphZXuagajudVZEnYyBahZMgHNCTJc2at82YX6s8JiL1Lohu5A3v1Ur76qguNH4QVQ7qYrBQx/86'/1'/0'/0/*)#8pn8tzdt";
47 WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(unknown_desc), 0, 0, 0, 0);
48 BOOST_CHECK(batch.WriteDescriptor(uint256(), wallet_descriptor));
49 BOOST_CHECK(batch.WriteActiveScriptPubKeyMan(static_cast<uint8_t>(OutputType::UNKNOWN), uint256(), false));
50 }
51
52 {
53 // Now try to load the wallet and verify the error.
54 const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
56 }
57
58 // Test 2
59 // Now write a valid descriptor with an invalid ID.
60 // As the software produces another ID for the descriptor, the loading process must be aborted.
62
63 // Verify the error
64 bool found = false;
65 DebugLogHelper logHelper("The descriptor ID calculated by the wallet differs from the one in DB", [&](const std::string* s) {
66 found = true;
67 return false;
68 });
69
70 {
71 // Write valid descriptor with invalid ID
72 WalletBatch batch(*database);
73 std::string desc = "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu";
74 WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(desc), 0, 0, 0, 0);
75 BOOST_CHECK(batch.WriteDescriptor(uint256::ONE, wallet_descriptor));
76 }
77
78 {
79 // Now try to load the wallet and verify the error.
80 const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
82 BOOST_CHECK(found); // The error must be logged
83 }
84}
85
87} // namespace wallet
node::NodeContext m_node
Definition: bitcoin-gui.cpp:42
Cache for single descriptor's derived extended pubkeys.
Definition: descriptor.h:19
An interface to be implemented by keystores that support signing.
256-bit opaque blob.
Definition: uint256.h:196
static const uint256 ONE
Definition: uint256.h:205
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:300
bool IsSolvable() const override
Whether this descriptor has all information about signing ignoring lack of private keys.
std::string ToString(bool compat_format) const override
Convert the descriptor back to a string, undoing parsing.
void GetPubKeys(std::set< CPubKey > &pubkeys, std::set< CExtPubKey > &ext_pubs) const override
Return all (extended) public keys for this descriptor, including any from subdescriptors.
bool ToNormalizedString(const SigningProvider &provider, std::string &out, const DescriptorCache *cache=nullptr) const override
Convert the descriptor to a normalized string.
void ExpandPrivate(int pos, const SigningProvider &provider, FlatSigningProvider &out) const override
Expand the private key for a descriptor at a specified position, if possible.
bool ToPrivateString(const SigningProvider &provider, std::string &out) const override
Convert the descriptor to a private string.
bool Expand(int pos, const SigningProvider &provider, std::vector< CScript > &output_scripts, FlatSigningProvider &out, DescriptorCache *write_cache=nullptr) const override
Expand a descriptor at a specified position.
std::optional< int64_t > MaxSatisfactionWeight(bool) const override
Get the maximum size of a satisfaction for this descriptor, in weight units.
bool ExpandFromCache(int pos, const DescriptorCache &read_cache, std::vector< CScript > &output_scripts, FlatSigningProvider &out) const override
Expand a descriptor at a specified position using cached expansion data.
bool IsRange() const override
Whether the expansion of this descriptor depends on the position.
std::optional< OutputType > GetOutputType() const override
bool IsSingleType() const override
Whether this descriptor will return one scriptPubKey or multiple (aka is or is not combo)
std::optional< int64_t > MaxSatisfactionElems() const override
Get the maximum size number of stack elements for satisfying this descriptor.
std::optional< int64_t > ScriptSize() const override
Get the size of the scriptPubKey for this descriptor.
DummyDescriptor(const std::string &descriptor)
Access to the wallet database.
Definition: walletdb.h:189
bool WriteDescriptor(const uint256 &desc_id, const WalletDescriptor &descriptor)
Definition: walletdb.cpp:238
bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256 &id, bool internal)
Definition: walletdb.cpp:206
Descriptor with some wallet metadata.
Definition: walletutil.h:85
BOOST_AUTO_TEST_SUITE_END()
BOOST_FIXTURE_TEST_CASE(wallet_coinsresult_test, BasicTestingSetup)
std::unique_ptr< WalletDatabase > CreateMockableWalletDatabase(MockableData records)
Definition: util.cpp:187
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18
#define BOOST_CHECK(expr)
Definition: object.cpp:17
Interface for parsed descriptor objects.
Definition: descriptor.h:98
Testing setup that configures a complete environment.
Definition: setup_common.h:121
std::unique_ptr< interfaces::Chain > chain
Definition: context.h:76