Inside Bitcoin

1// Copyright (c) 2022-present 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/common.h>
8#include <test/util/logging.h>
9#include <test/util/setup_common.h>
10
11#include <boost/test/unit_test.hpp>
12
13namespace wallet {
14
15BOOST_AUTO_TEST_SUITE(walletload_tests)
16
17class DummyDescriptor final : public Descriptor {
18private:
19    std::string desc;
20public:
21    explicit DummyDescriptor(const std::string& descriptor) : desc(descriptor) {};
22    ~DummyDescriptor() = default;
23
24    std::string ToString(bool compat_format) const override { return desc; }
25    std::string ToCanonicalString() const override { return desc; }
26    std::optional<OutputType> GetOutputType() const override { return OutputType::UNKNOWN; }
27
28    bool IsRange() const override { return true; }
29    bool IsSolvable() const override { return false; }
30    bool IsSingleType() const override { return true; }
31    bool HavePrivateKeys(const SigningProvider&) const override { return false; }
32    bool ToPrivateString(const SigningProvider& provider, std::string& out) const override { return false; }
33    bool ToNormalizedString(const SigningProvider& provider, std::string& out, const DescriptorCache* cache = nullptr) const override { return false; }
34    bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const override { return false; };
35    bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const override { return false; }
36    void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const override {}
37    std::optional<int64_t> ScriptSize() const override { return {}; }
38    std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
39    std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
40    void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override {}
41    bool HasScripts() const override { return true; }
42    std::vector<std::string> Warnings() const override { return {}; }
43    uint32_t GetMaxKeyExpr() const override { return 0; }
44    size_t GetKeyCount() const override { return 0; }
45    bool CanSelfExpand() const final { return false; }
46};
47
48BOOST_FIXTURE_TEST_CASE(wallet_load_descriptors, TestingSetup)
49{
50    bilingual_str _error;
51    std::vector<bilingual_str> _warnings;
52    std::unique_ptr<WalletDatabase> database = CreateMockableWalletDatabase();
53    {
54        // Write unknown active descriptor
55        WalletBatch batch(*database);
56        std::string unknown_desc = "trx(tpubD6NzVbkrYhZ4Y4S7m6Y5s9GD8FqEMBy56AGphZXuagajudVZEnYyBahZMgHNCTJc2at82YX6s8JiL1Lohu5A3v1Ur76qguNH4QVQ7qYrBQx/86'/1'/0'/0/*)#8pn8tzdt";
57        WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(unknown_desc), 0, 0, 0, 0);
58        BOOST_CHECK(batch.WriteDescriptor(uint256(), wallet_descriptor));
59        BOOST_CHECK(batch.WriteActiveScriptPubKeyMan(static_cast<uint8_t>(OutputType::UNKNOWN), uint256(), false));
60    }
61
62    {
63        // Now try to load the wallet and verify the error.
64        const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
65        BOOST_CHECK_EQUAL(wallet->PopulateWalletFromDB(_error, _warnings), DBErrors::UNKNOWN_DESCRIPTOR);
66    }
67
68    // Test 2
69    // Now write a valid descriptor with a different ID which must be accepted
70    database = CreateMockableWalletDatabase();
71
72    {
73        // Write valid descriptor with arbitrary ID
74        WalletBatch batch(*database);
75        std::string desc = "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu";
76        WalletDescriptor wallet_descriptor(std::make_shared<DummyDescriptor>(desc), 0, 0, 0, 0);
77        BOOST_CHECK(batch.WriteDescriptor(uint256::ONE, wallet_descriptor));
78    }
79
80    {
81        // Now try to load the wallet and verify the result.
82        const std::shared_ptr<CWallet> wallet(new CWallet(m_node.chain.get(), "", std::move(database)));
83        BOOST_CHECK_EQUAL(wallet->PopulateWalletFromDB(_error, _warnings), DBErrors::LOAD_OK);
84    }
85}
86
87BOOST_AUTO_TEST_SUITE_END()
88} // namespace wallet
89