Branch data Line data Source code
1 : : // Copyright (c) 2019-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #ifndef BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
6 : : #define BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
7 : :
8 : : #include <addresstype.h>
9 : : #include <common/messages.h>
10 : : #include <common/signmessage.h>
11 : : #include <common/types.h>
12 : : #include <musig.h>
13 : : #include <node/types.h>
14 : : #include <psbt.h>
15 : : #include <script/descriptor.h>
16 : : #include <script/script.h>
17 : : #include <script/signingprovider.h>
18 : : #include <util/btcsignals.h>
19 : : #include <util/hasher.h>
20 : : #include <util/log.h>
21 : : #include <util/result.h>
22 : : #include <util/time.h>
23 : : #include <wallet/crypter.h>
24 : : #include <wallet/types.h>
25 : : #include <wallet/walletdb.h>
26 : : #include <wallet/walletutil.h>
27 : :
28 : : #include <functional>
29 : : #include <optional>
30 : : #include <unordered_map>
31 : : #include <unordered_set>
32 : :
33 : : enum class OutputType;
34 : :
35 : : namespace wallet {
36 : : struct MigrationData;
37 : : class ScriptPubKeyMan;
38 : :
39 : : // Wallet storage things that ScriptPubKeyMans need in order to be able to store things to the wallet database.
40 : : // It provides access to things that are part of the entire wallet and not specific to a ScriptPubKeyMan such as
41 : : // wallet flags, wallet version, encryption keys, encryption status, and the database itself. This allows a
42 : : // ScriptPubKeyMan to have callbacks into CWallet without causing a circular dependency.
43 : : // WalletStorage should be the same for all ScriptPubKeyMans of a wallet.
44 [ + - ]: 15784 : class WalletStorage
45 : : {
46 : : public:
47 : 15784 : virtual ~WalletStorage() = default;
48 : : virtual std::string LogName() const = 0;
49 : : virtual WalletDatabase& GetDatabase() const = 0;
50 : : virtual bool IsWalletFlagSet(uint64_t) const = 0;
51 : : virtual void UnsetBlankWalletFlag(WalletBatch&) = 0;
52 : : //! Pass the encryption key to cb().
53 : : virtual bool WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const = 0;
54 : : virtual bool HasEncryptionKeys() const = 0;
55 : : virtual bool IsLocked() const = 0;
56 : : //! Callback function for after TopUp completes containing any scripts that were added by a SPKMan
57 : : virtual void TopUpCallback(const std::set<CScript>&, ScriptPubKeyMan*) = 0;
58 : : };
59 : :
60 : : //! Constant representing an unknown spkm creation time
61 : : inline constexpr int64_t UNKNOWN_TIME = std::numeric_limits<int64_t>::max();
62 : :
63 : : //! Default for -keypool
64 : : inline constexpr unsigned int DEFAULT_KEYPOOL_SIZE = 1000;
65 : :
66 : 1770 : struct WalletDestination
67 : : {
68 : : CTxDestination dest;
69 : : std::optional<bool> internal;
70 : : };
71 : :
72 : : /*
73 : : * A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet.
74 : : * It contains the scripts and keys related to the scriptPubKeys it manages.
75 : : * A ScriptPubKeyMan will be able to give out scriptPubKeys to be used, as well as marking
76 : : * when a scriptPubKey has been used. It also handles when and how to store a scriptPubKey
77 : : * and its related scripts and keys, including encryption.
78 : : */
79 : : class ScriptPubKeyMan
80 : : {
81 : : protected:
82 : : WalletStorage& m_storage;
83 : :
84 : : public:
85 : 35125 : explicit ScriptPubKeyMan(WalletStorage& storage) : m_storage(storage) {}
86 : 35125 : virtual ~ScriptPubKeyMan() = default;
87 [ # # ]: 0 : virtual util::Result<CTxDestination> GetNewDestination(const OutputType type) { return util::Error{Untranslated("Not supported")}; }
88 : 0 : virtual bool IsMine(const CScript& script) const { return false; }
89 : :
90 : : //! Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the keys handled by it.
91 : 0 : virtual bool CheckDecryptionKey(const CKeyingMaterial& master_key) { return false; }
92 : 0 : virtual bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) { return false; }
93 : :
94 [ # # ]: 0 : virtual util::Result<CTxDestination> GetReservedDestination(const OutputType type, bool internal, int64_t& index) { return util::Error{Untranslated("Not supported")}; }
95 : 59721 : virtual void KeepDestination(int64_t index, const OutputType& type) {}
96 : 0 : virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) {}
97 : :
98 : : /** Fills internal address pool. Use within ScriptPubKeyMan implementations should be used sparingly and only
99 : : * when something from the address pool is removed, excluding GetNewDestination and GetReservedDestination.
100 : : * External wallet code is primarily responsible for topping up prior to fetching new addresses
101 : : */
102 : 0 : virtual bool TopUp(unsigned int size = 0) { return false; }
103 : :
104 : : /** Mark unused addresses as being used
105 : : * Affects all keys up to and including the one determined by provided script.
106 : : *
107 : : * @param script determines the last key to mark as used
108 : : *
109 : : * @return All of the addresses affected
110 : : */
111 : 0 : virtual std::vector<WalletDestination> MarkUnusedAddresses(const CScript& script) { return {}; }
112 : :
113 : : /* Returns true if HD is enabled */
114 : 0 : virtual bool IsHDEnabled() const { return false; }
115 : :
116 : : /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
117 : 0 : virtual bool CanGetAddresses(bool internal = false) const { return false; }
118 : :
119 : 0 : virtual bool HavePrivateKeys() const { return false; }
120 : 0 : virtual bool HaveCryptedKeys() const { return false; }
121 : :
122 : 0 : virtual unsigned int GetKeyPoolSize() const { return 0; }
123 : :
124 : 1533 : virtual int64_t GetTimeFirstKey() const { return 0; }
125 : :
126 : 0 : virtual std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const { return nullptr; }
127 : :
128 : 0 : virtual std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const { return nullptr; }
129 : :
130 : : /** Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that, combined with
131 : : * sigdata, can produce solving data.
132 : : */
133 : 0 : virtual bool CanProvide(const CScript& script, SignatureData& sigdata) { return false; }
134 : :
135 : : /** Creates new signatures and adds them to the transaction. Returns whether all inputs were signed */
136 : 0 : virtual bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const { return false; }
137 : : /** Sign a message with the given script */
138 : 0 : virtual SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const { return SigningResult::SIGNING_FAILED; };
139 : : /** Adds script and derivation path information to a PSBT, and optionally signs it. */
140 : 0 : virtual std::optional<common::PSBTError> FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, const common::PSBTFillOptions& options, int* n_signed = nullptr) const { return common::PSBTError::UNSUPPORTED; }
141 : :
142 : 0 : virtual uint256 GetID() const { return uint256(); }
143 : :
144 : : /** Returns a set of all the scriptPubKeys that this ScriptPubKeyMan watches */
145 : 0 : virtual std::unordered_set<CScript, SaltedSipHasher> GetScriptPubKeys() const { return {}; };
146 : :
147 : : /** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */
148 : : template <typename... Params>
149 : 885 : void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const
150 : : {
151 [ + - + - ]: 885 : LogInfo("[%s] %s", m_storage.LogName(), tfm::format(wallet_fmt, params...));
152 : 885 : };
153 : :
154 : : /** Keypool has new keys */
155 : : btcsignals::signal<void ()> NotifyCanGetAddressesChanged;
156 : :
157 : : /** Birth time changed */
158 : : btcsignals::signal<void (const ScriptPubKeyMan* spkm, int64_t new_birth_time)> NotifyFirstKeyTimeChanged;
159 : : };
160 : :
161 : : /** Output types associated with LegacyDataSPKM. */
162 : : inline const std::unordered_set<OutputType> LEGACY_OUTPUT_TYPES {
163 : : OutputType::LEGACY,
164 : : OutputType::P2SH_SEGWIT,
165 : : OutputType::BECH32,
166 : : };
167 : :
168 : : using KeyMap = std::map<CKeyID, CKey>;
169 : : using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
170 : :
171 : : // Manages the minimum data needed to load and migrate a legacy wallet.
172 : : class LegacyDataSPKM : public ScriptPubKeyMan, public FillableSigningProvider
173 : : {
174 : : private:
175 : : using WatchOnlySet = std::set<CScript>;
176 : : using WatchKeyMap = std::map<CKeyID, CPubKey>;
177 : :
178 : : CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
179 : : WatchOnlySet setWatchOnly GUARDED_BY(cs_KeyStore);
180 : : WatchKeyMap mapWatchKeys GUARDED_BY(cs_KeyStore);
181 : :
182 : : /* the HD chain data model (external chain counters) */
183 : : CHDChain m_hd_chain;
184 : : std::unordered_map<CKeyID, CHDChain, SaltedSipHasher> m_inactive_hd_chains;
185 : :
186 : : //! keeps track of whether Unlock has run a thorough check before
187 : : bool fDecryptionThoroughlyChecked = true;
188 : :
189 : : bool AddWatchOnlyInMem(const CScript &dest);
190 : : virtual bool AddKeyPubKeyInner(const CKey& key, const CPubKey &pubkey);
191 : : bool AddCryptedKeyInner(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
192 : :
193 : : // Helper function to retrieve a conservative superset of all output scripts that may be relevant to this LegacyDataSPKM.
194 : : // It may include scripts that are invalid or not actually watched by this LegacyDataSPKM.
195 : : // Used only in migration.
196 : : std::unordered_set<CScript, SaltedSipHasher> GetCandidateScriptPubKeys() const;
197 : :
198 : : bool IsMine(const CScript& script) const override;
199 : : bool CanProvide(const CScript& script, SignatureData& sigdata) override;
200 : : public:
201 : : using ScriptPubKeyMan::ScriptPubKeyMan;
202 : :
203 : : // Map from Key ID to key metadata.
204 : : std::map<CKeyID, CKeyMetadata> mapKeyMetadata GUARDED_BY(cs_KeyStore);
205 : :
206 : : // Map from Script ID to key metadata (for watch-only keys).
207 : : std::map<CScriptID, CKeyMetadata> m_script_metadata GUARDED_BY(cs_KeyStore);
208 : :
209 : : // ScriptPubKeyMan overrides
210 : : bool CheckDecryptionKey(const CKeyingMaterial& master_key) override;
211 : : std::unordered_set<CScript, SaltedSipHasher> GetScriptPubKeys() const override;
212 : : std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
213 : 1533 : uint256 GetID() const override { return uint256::ONE; }
214 : :
215 : : // FillableSigningProvider overrides
216 : : bool HaveKey(const CKeyID &address) const override;
217 : : bool GetKey(const CKeyID &address, CKey& keyOut) const override;
218 : : bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
219 : : bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
220 : :
221 : : //! Load metadata (used by LoadWallet)
222 : : virtual void LoadKeyMetadata(const CKeyID& keyID, const CKeyMetadata &metadata);
223 : : virtual void LoadScriptMetadata(const CScriptID& script_id, const CKeyMetadata &metadata);
224 : :
225 : : //! Adds a watch-only address to the store, without saving it to disk (used by LoadWallet)
226 : : bool LoadWatchOnly(const CScript &dest);
227 : : //! Returns whether the watch-only script is in the wallet
228 : : bool HaveWatchOnly(const CScript &dest) const;
229 : : //! Adds a key to the store, without saving it to disk (used by LoadWallet)
230 : : bool LoadKey(const CKey& key, const CPubKey &pubkey);
231 : : //! Adds an encrypted key to the store, without saving it to disk (used by LoadWallet)
232 : : bool LoadCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret, bool checksum_valid);
233 : : //! Adds a CScript to the store
234 : : bool LoadCScript(const CScript& redeemScript);
235 : : //! Load a HD chain model (used by LoadWallet)
236 : : void LoadHDChain(const CHDChain& chain);
237 : : void AddInactiveHDChain(const CHDChain& chain);
238 : : const CHDChain& GetHDChain() const { return m_hd_chain; }
239 : :
240 : : //! Fetches a pubkey from mapWatchKeys if it exists there
241 : : bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const;
242 : :
243 : : /**
244 : : * Retrieves scripts that were imported by bugs into the legacy spkm and are
245 : : * simply invalid, such as a sh(sh(pkh())) script, or not watched.
246 : : */
247 : : std::unordered_set<CScript, SaltedSipHasher> GetNotMineScriptPubKeys() const;
248 : :
249 : : /** Get the DescriptorScriptPubKeyMans (with private keys) that have the same scriptPubKeys as this LegacyDataSPKM.
250 : : * Does not modify this LegacyDataSPKM. */
251 : : std::optional<MigrationData> MigrateToDescriptor();
252 : : /** Delete the legacy wallet records from disk. */
253 : : bool DeleteRecordsWithDB(WalletBatch& batch);
254 : : };
255 : :
256 : : /** SigningProvider wrapper for LegacyDataSPKM that does not provide private keys. */
257 : : class LegacySigningProvider : public SigningProvider
258 : : {
259 : : private:
260 : : const LegacyDataSPKM& m_spk_man;
261 : : public:
262 : 16709 : explicit LegacySigningProvider(const LegacyDataSPKM& spk_man) : m_spk_man(spk_man) {}
263 : :
264 : 15305 : bool GetCScript(const CScriptID &scriptid, CScript& script) const override { return m_spk_man.GetCScript(scriptid, script); }
265 : 0 : bool HaveCScript(const CScriptID &scriptid) const override { return m_spk_man.HaveCScript(scriptid); }
266 : 2134 : bool GetPubKey(const CKeyID &address, CPubKey& pubkey) const override { return m_spk_man.GetPubKey(address, pubkey); }
267 : 0 : bool GetKey(const CKeyID &address, CKey& key) const override { return false; }
268 : 0 : bool HaveKey(const CKeyID &address) const override { return false; }
269 : 101175 : bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override { return m_spk_man.GetKeyOrigin(keyid, info); }
270 : : };
271 : :
272 : : class DescriptorScriptPubKeyMan : public ScriptPubKeyMan
273 : : {
274 : : private:
275 : : using ScriptPubKeyMap = std::map<CScript, int32_t>; // Map of scripts to descriptor range index
276 : : using PubKeyMap = std::map<CPubKey, int32_t>; // Map of pubkeys involved in scripts to descriptor range index
277 : :
278 : : ScriptPubKeyMap m_map_script_pub_keys GUARDED_BY(cs_desc_man);
279 : : PubKeyMap m_map_pubkeys GUARDED_BY(cs_desc_man);
280 : : int32_t m_max_cached_index = -1;
281 : :
282 : : KeyMap m_map_keys GUARDED_BY(cs_desc_man);
283 : : CryptedKeyMap m_map_crypted_keys GUARDED_BY(cs_desc_man);
284 : :
285 : : //! keeps track of whether Unlock has run a thorough check before
286 : : bool m_decryption_thoroughly_checked = false;
287 : :
288 : : //! Number of pre-generated keys/scripts (part of the look-ahead process, used to detect payments)
289 : : int64_t m_keypool_size GUARDED_BY(cs_desc_man){DEFAULT_KEYPOOL_SIZE};
290 : :
291 : : /** Map of a session id to MuSig2 secnonce
292 : : *
293 : : * Stores MuSig2 secnonces while the MuSig2 signing session is still ongoing.
294 : : * Note that these secnonces must not be reused. In order to avoid being tricked into
295 : : * reusing a nonce, this map is held only in memory and must not be written to disk.
296 : : * The side effect is that signing sessions cannot persist across restarts, but this
297 : : * must be done in order to prevent nonce reuse.
298 : : *
299 : : * The session id is an arbitrary value set by the signer in order for the signing logic
300 : : * to find ongoing signing sessions, see MuSig2SessionID.
301 : : */
302 : : mutable std::map<uint256, MuSig2SecNonce> m_musig2_secnonces;
303 : :
304 : : //! Create a new DescriptorScriptPubKeyMan from an existing descriptor (i.e. from an import)
305 : 33592 : DescriptorScriptPubKeyMan(WalletStorage& storage, WalletDescriptor& descriptor, int64_t keypool_size)
306 : 33592 : : ScriptPubKeyMan(storage),
307 [ + - ]: 33592 : m_keypool_size(keypool_size),
308 [ + - ]: 33592 : m_wallet_descriptor(descriptor)
309 : 33592 : {}
310 : :
311 : : bool AddDescriptorKeyWithDB(WalletBatch& batch, const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
312 : :
313 : : KeyMap GetKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
314 : :
315 : : // Cached FlatSigningProviders to avoid regenerating them each time they are needed.
316 : : mutable std::map<int32_t, FlatSigningProvider> m_map_signing_providers;
317 : : // Fetch the SigningProvider for the given script and optionally include private keys
318 : : std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CScript& script, bool include_private = false) const;
319 : : // Fetch the SigningProvider for a given index and optionally include private keys. Called by the above functions.
320 : : std::unique_ptr<FlatSigningProvider> GetSigningProvider(int32_t index, bool include_private = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
321 : :
322 : : void Load();
323 : :
324 : : void AddDescriptorKey(const CKey& key, const CPubKey &pubkey);
325 : : void UpdateWithSigningProvider(WalletBatch& batch, const FlatSigningProvider& signing_provider) EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
326 : :
327 : : //! Setup descriptors based on the given CExtKey
328 : : void SetupDescriptorGeneration(WalletBatch& batch, const CExtKey& master_key, OutputType addr_type, bool internal);
329 : :
330 : : protected:
331 : : //! Create a DescriptorScriptPubKeyMan from existing data (i.e. during loading)
332 : : DescriptorScriptPubKeyMan(WalletStorage& storage, WalletDescriptor& descriptor, int64_t keypool_size, const KeyMap& keys, const CryptedKeyMap& ckeys);
333 : :
334 : 0 : DescriptorScriptPubKeyMan(WalletStorage& storage, int64_t keypool_size)
335 : 0 : : ScriptPubKeyMan(storage),
336 : 0 : m_keypool_size(keypool_size)
337 : 0 : {}
338 : :
339 : : WalletDescriptor m_wallet_descriptor GUARDED_BY(cs_desc_man);
340 : :
341 : : //! Same as 'TopUp' but designed for use within a batch transaction context
342 : : bool TopUpWithDB(WalletBatch& batch, unsigned int size = 0);
343 : :
344 : : public:
345 : : static std::unique_ptr<DescriptorScriptPubKeyMan> LoadFromStorage(WalletStorage& storage, WalletDescriptor& descriptor, int64_t keypool_size, const KeyMap& keys, const CryptedKeyMap& ckeys);
346 : : static std::unique_ptr<DescriptorScriptPubKeyMan> CreateFromImport(WalletStorage& storage, WalletDescriptor& descriptor, int64_t keypool_size, const FlatSigningProvider& provider);
347 : : static std::unique_ptr<DescriptorScriptPubKeyMan> CreateFromMigration(WalletStorage& storage, WalletBatch& batch, WalletDescriptor& descriptor, int64_t keypool_size, const FlatSigningProvider& provider);
348 : : static std::unique_ptr<DescriptorScriptPubKeyMan> GenerateNewSingleSig(WalletStorage& storage, WalletBatch& batch, int64_t keypool_size, const CExtKey& master_key, OutputType addr_type, bool internal);
349 : :
350 : : mutable RecursiveMutex cs_desc_man;
351 : :
352 : : util::Result<CTxDestination> GetNewDestination(OutputType type) override;
353 : : bool IsMine(const CScript& script) const override;
354 : :
355 : : bool CheckDecryptionKey(const CKeyingMaterial& master_key) override;
356 : : bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
357 : :
358 : : util::Result<CTxDestination> GetReservedDestination(OutputType type, bool internal, int64_t& index) override;
359 : : void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) override;
360 : :
361 : : // Tops up the descriptor cache and m_map_script_pub_keys. The cache is stored in the wallet file
362 : : // and is used to expand the descriptor in GetNewDestination. Descriptor wallets rely more on
363 : : // ephemeral data than legacy wallets. For wallets using unhardened derivation
364 : : // (with or without private keys), the "keypool" is a single xpub.
365 : : bool TopUp(unsigned int size = 0) override;
366 : :
367 : : std::vector<WalletDestination> MarkUnusedAddresses(const CScript& script) override;
368 : :
369 : : bool IsHDEnabled() const override;
370 : :
371 : : bool HavePrivateKeys() const override;
372 : : bool HasPrivKey(const CKeyID& keyid) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
373 : : //! Retrieve the particular key if it is available. Returns nullopt if the key is not in the wallet, or if the wallet is locked.
374 : : std::optional<CKey> GetKey(const CKeyID& keyid) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
375 : : bool HaveCryptedKeys() const override;
376 : :
377 : : unsigned int GetKeyPoolSize() const override;
378 : :
379 : : int64_t GetTimeFirstKey() const override;
380 : :
381 : : std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
382 : :
383 : : bool CanGetAddresses(bool internal = false) const override;
384 : :
385 : : std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
386 : :
387 : : bool CanProvide(const CScript& script, SignatureData& sigdata) override;
388 : :
389 : : // Fetch the SigningProvider for the given pubkey and always include private keys. This should only be called by signing code.
390 : : std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CPubKey& pubkey) const;
391 : :
392 : : bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const override;
393 : : SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
394 : : std::optional<common::PSBTError> FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, const common::PSBTFillOptions& options, int* n_signed = nullptr) const override;
395 : :
396 : : uint256 GetID() const override;
397 : :
398 : : bool HasWalletDescriptor(const WalletDescriptor& desc) const;
399 : : util::Result<void> UpdateWalletDescriptor(WalletDescriptor& descriptor, const FlatSigningProvider& provider);
400 : : bool CanUpdateToWalletDescriptor(const WalletDescriptor& descriptor, std::string& error);
401 : : void WriteDescriptor();
402 : :
403 : : WalletDescriptor GetWalletDescriptor() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
404 : : std::unordered_set<CScript, SaltedSipHasher> GetScriptPubKeys() const override;
405 : : std::unordered_set<CScript, SaltedSipHasher> GetScriptPubKeys(int32_t minimum_index) const;
406 : : int32_t GetEndRange() const;
407 : :
408 : : [[nodiscard]] bool GetDescriptorString(std::string& out, bool priv) const;
409 : :
410 : : void UpgradeDescriptorCache();
411 : : };
412 : :
413 : : /** struct containing information needed for migrating legacy wallets to descriptor wallets */
414 : : struct MigrationData
415 : : {
416 : : CExtKey master_key;
417 : : std::vector<std::pair<std::string, int64_t>> watch_descs;
418 : : std::vector<std::pair<std::string, int64_t>> solvable_descs;
419 : : std::vector<std::unique_ptr<DescriptorScriptPubKeyMan>> desc_spkms;
420 : : std::shared_ptr<CWallet> watchonly_wallet{nullptr};
421 : : std::shared_ptr<CWallet> solvable_wallet{nullptr};
422 : : };
423 : :
424 : : } // namespace wallet
425 : :
426 : : #endif // BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
|
