Bitcoin Core  22.99.0
P2P Digital Currency
scriptpubkeyman.h
Go to the documentation of this file.
1 // Copyright (c) 2019-2020 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 <psbt.h>
9 #include <script/descriptor.h>
10 #include <script/signingprovider.h>
11 #include <script/standard.h>
12 #include <util/error.h>
13 #include <util/message.h>
14 #include <util/time.h>
15 #include <wallet/crypter.h>
16 #include <wallet/ismine.h>
17 #include <wallet/walletdb.h>
18 #include <wallet/walletutil.h>
19 
20 #include <boost/signals2/signal.hpp>
21 
22 #include <unordered_map>
23 
24 enum class OutputType;
25 struct bilingual_str;
26 
27 // Wallet storage things that ScriptPubKeyMans need in order to be able to store things to the wallet database.
28 // It provides access to things that are part of the entire wallet and not specific to a ScriptPubKeyMan such as
29 // wallet flags, wallet version, encryption keys, encryption status, and the database itself. This allows a
30 // ScriptPubKeyMan to have callbacks into CWallet without causing a circular dependency.
31 // WalletStorage should be the same for all ScriptPubKeyMans of a wallet.
33 {
34 public:
35  virtual ~WalletStorage() = default;
36  virtual const std::string GetDisplayName() const = 0;
37  virtual WalletDatabase& GetDatabase() const = 0;
38  virtual bool IsWalletFlagSet(uint64_t) const = 0;
39  virtual void UnsetBlankWalletFlag(WalletBatch&) = 0;
40  virtual bool CanSupportFeature(enum WalletFeature) const = 0;
41  virtual void SetMinVersion(enum WalletFeature, WalletBatch* = nullptr) = 0;
42  virtual const CKeyingMaterial& GetEncryptionKey() const = 0;
43  virtual bool HasEncryptionKeys() const = 0;
44  virtual bool IsLocked() const = 0;
45 };
46 
48 static const unsigned int DEFAULT_KEYPOOL_SIZE = 1000;
49 
50 std::vector<CKeyID> GetAffectedKeys(const CScript& spk, const SigningProvider& provider);
51 
101 class CKeyPool
102 {
103 public:
105  int64_t nTime;
109  bool fInternal;
112 
113  CKeyPool();
114  CKeyPool(const CPubKey& vchPubKeyIn, bool internalIn);
115 
116  template<typename Stream>
117  void Serialize(Stream& s) const
118  {
119  int nVersion = s.GetVersion();
120  if (!(s.GetType() & SER_GETHASH)) {
121  s << nVersion;
122  }
123  s << nTime << vchPubKey << fInternal << m_pre_split;
124  }
125 
126  template<typename Stream>
127  void Unserialize(Stream& s)
128  {
129  int nVersion = s.GetVersion();
130  if (!(s.GetType() & SER_GETHASH)) {
131  s >> nVersion;
132  }
133  s >> nTime >> vchPubKey;
134  try {
135  s >> fInternal;
136  } catch (std::ios_base::failure&) {
137  /* flag as external address if we can't read the internal boolean
138  (this will be the case for any wallet before the HD chain split version) */
139  fInternal = false;
140  }
141  try {
142  s >> m_pre_split;
143  } catch (std::ios_base::failure&) {
144  /* flag as postsplit address if we can't read the m_pre_split boolean
145  (this will be the case for any wallet that upgrades to HD chain split) */
146  m_pre_split = false;
147  }
148  }
149 };
150 
152 {
153 public:
155 
156  size_t operator()(const CKeyID& id) const
157  {
158  return id.GetUint64(0);
159  }
160 };
161 
162 /*
163  * A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet.
164  * It contains the scripts and keys related to the scriptPubKeys it manages.
165  * A ScriptPubKeyMan will be able to give out scriptPubKeys to be used, as well as marking
166  * when a scriptPubKey has been used. It also handles when and how to store a scriptPubKey
167  * and its related scripts and keys, including encryption.
168  */
170 {
171 protected:
173 
174 public:
175  explicit ScriptPubKeyMan(WalletStorage& storage) : m_storage(storage) {}
176  virtual ~ScriptPubKeyMan() {};
177  virtual bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) { return false; }
178  virtual isminetype IsMine(const CScript& script) const { return ISMINE_NO; }
179 
181  virtual bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) { return false; }
182  virtual bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) { return false; }
183 
184  virtual bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool, std::string& error) { return false; }
185  virtual void KeepDestination(int64_t index, const OutputType& type) {}
186  virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) {}
187 
192  virtual bool TopUp(unsigned int size = 0) { return false; }
193 
195  virtual void MarkUnusedAddresses(const CScript& script) {}
196 
201  virtual bool SetupGeneration(bool force = false) { return false; }
202 
203  /* Returns true if HD is enabled */
204  virtual bool IsHDEnabled() const { return false; }
205 
206  /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
207  virtual bool CanGetAddresses(bool internal = false) const { return false; }
208 
210  virtual bool Upgrade(int prev_version, int new_version, bilingual_str& error) { return true; }
211 
212  virtual bool HavePrivateKeys() const { return false; }
213 
215  virtual void RewriteDB() {}
216 
217  virtual int64_t GetOldestKeyPoolTime() const { return GetTime(); }
218 
219  virtual unsigned int GetKeyPoolSize() const { return 0; }
220 
221  virtual int64_t GetTimeFirstKey() const { return 0; }
222 
223  virtual std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const { return nullptr; }
224 
225  virtual std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const { return nullptr; }
226 
230  virtual bool CanProvide(const CScript& script, SignatureData& sigdata) { return false; }
231 
233  virtual bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const { return false; }
235  virtual SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const { return SigningResult::SIGNING_FAILED; };
237  virtual TransactionError FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const { return TransactionError::INVALID_PSBT; }
238 
239  virtual uint256 GetID() const { return uint256(); }
240 
242  template<typename... Params>
243  void WalletLogPrintf(std::string fmt, Params... parameters) const {
244  LogPrintf(("%s " + fmt).c_str(), m_storage.GetDisplayName(), parameters...);
245  };
246 
248  boost::signals2::signal<void (bool fHaveWatchOnly)> NotifyWatchonlyChanged;
249 
251  boost::signals2::signal<void ()> NotifyCanGetAddressesChanged;
252 };
253 
255 static const std::unordered_set<OutputType> LEGACY_OUTPUT_TYPES {
259 };
260 
262 {
263 private:
266 
267  using WatchOnlySet = std::set<CScript>;
268  using WatchKeyMap = std::map<CKeyID, CPubKey>;
269 
270  WalletBatch *encrypted_batch GUARDED_BY(cs_KeyStore) = nullptr;
271 
272  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
273 
274  CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
275  WatchOnlySet setWatchOnly GUARDED_BY(cs_KeyStore);
276  WatchKeyMap mapWatchKeys GUARDED_BY(cs_KeyStore);
277 
278  int64_t nTimeFirstKey GUARDED_BY(cs_KeyStore) = 0;
279 
280  bool AddKeyPubKeyInner(const CKey& key, const CPubKey &pubkey);
281  bool AddCryptedKeyInner(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
282 
294  bool AddWatchOnlyInMem(const CScript &dest);
296  bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript& dest, int64_t create_time) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
297 
299  bool AddKeyPubKeyWithDB(WalletBatch &batch,const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
300 
301  void AddKeypoolPubkeyWithDB(const CPubKey& pubkey, const bool internal, WalletBatch& batch);
302 
304  bool AddCScriptWithDB(WalletBatch& batch, const CScript& script);
305 
307  bool AddKeyOriginWithDB(WalletBatch& batch, const CPubKey& pubkey, const KeyOriginInfo& info);
308 
309  /* the HD chain data model (external chain counters) */
311  std::unordered_map<CKeyID, CHDChain, SaltedSipHasher> m_inactive_hd_chains;
312 
313  /* HD derive new child key (on internal or external chain) */
314  void DeriveNewChildKey(WalletBatch& batch, CKeyMetadata& metadata, CKey& secret, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
315 
316  std::set<int64_t> setInternalKeyPool GUARDED_BY(cs_KeyStore);
317  std::set<int64_t> setExternalKeyPool GUARDED_BY(cs_KeyStore);
318  std::set<int64_t> set_pre_split_keypool GUARDED_BY(cs_KeyStore);
319  int64_t m_max_keypool_index GUARDED_BY(cs_KeyStore) = 0;
320  std::map<CKeyID, int64_t> m_pool_key_to_index;
321  // Tracks keypool indexes to CKeyIDs of keys that have been taken out of the keypool but may be returned to it
322  std::map<int64_t, CKeyID> m_index_to_reserved_key;
323 
325  bool GetKeyFromPool(CPubKey &key, const OutputType type, bool internal = false);
326 
341  bool ReserveKeyFromKeyPool(int64_t& nIndex, CKeyPool& keypool, bool fRequestedInternal);
342 
353  bool TopUpInactiveHDChain(const CKeyID seed_id, int64_t index, bool internal);
354 
355 public:
357 
358  bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) override;
359  isminetype IsMine(const CScript& script) const override;
360 
361  bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) override;
362  bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
363 
364  bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool, std::string& error) override;
365  void KeepDestination(int64_t index, const OutputType& type) override;
366  void ReturnDestination(int64_t index, bool internal, const CTxDestination&) override;
367 
368  bool TopUp(unsigned int size = 0) override;
369 
370  void MarkUnusedAddresses(const CScript& script) override;
371 
373  void UpgradeKeyMetadata();
374 
375  bool IsHDEnabled() const override;
376 
377  bool SetupGeneration(bool force = false) override;
378 
379  bool Upgrade(int prev_version, int new_version, bilingual_str& error) override;
380 
381  bool HavePrivateKeys() const override;
382 
383  void RewriteDB() override;
384 
385  int64_t GetOldestKeyPoolTime() const override;
386  size_t KeypoolCountExternalKeys() const;
387  unsigned int GetKeyPoolSize() const override;
388 
389  int64_t GetTimeFirstKey() const override;
390 
391  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
392 
393  bool CanGetAddresses(bool internal = false) const override;
394 
395  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
396 
397  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
398 
399  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
400  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
401  TransactionError FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
402 
403  uint256 GetID() const override;
404 
405  // Map from Key ID to key metadata.
406  std::map<CKeyID, CKeyMetadata> mapKeyMetadata GUARDED_BY(cs_KeyStore);
407 
408  // Map from Script ID to key metadata (for watch-only keys).
409  std::map<CScriptID, CKeyMetadata> m_script_metadata GUARDED_BY(cs_KeyStore);
410 
412  bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
414  bool LoadKey(const CKey& key, const CPubKey &pubkey);
416  bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
418  bool LoadCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret, bool checksum_valid);
419  void UpdateTimeFirstKey(int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
421  bool LoadCScript(const CScript& redeemScript);
423  void LoadKeyMetadata(const CKeyID& keyID, const CKeyMetadata &metadata);
424  void LoadScriptMetadata(const CScriptID& script_id, const CKeyMetadata &metadata);
426  CPubKey GenerateNewKey(WalletBatch& batch, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
427 
428  /* Set the HD chain model (chain child index counters) and writes it to the database */
429  void AddHDChain(const CHDChain& chain);
431  void LoadHDChain(const CHDChain& chain);
432  const CHDChain& GetHDChain() const { return m_hd_chain; }
433  void AddInactiveHDChain(const CHDChain& chain);
434 
436  bool LoadWatchOnly(const CScript &dest);
438  bool HaveWatchOnly(const CScript &dest) const;
440  bool HaveWatchOnly() const;
442  bool RemoveWatchOnly(const CScript &dest);
443  bool AddWatchOnly(const CScript& dest, int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
444 
446  bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const;
447 
448  /* SigningProvider overrides */
449  bool HaveKey(const CKeyID &address) const override;
450  bool GetKey(const CKeyID &address, CKey& keyOut) const override;
451  bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
452  bool AddCScript(const CScript& redeemScript) override;
453  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
454 
456  void LoadKeyPool(int64_t nIndex, const CKeyPool &keypool);
457  bool NewKeyPool();
459 
460  bool ImportScripts(const std::set<CScript> scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
461  bool ImportPrivKeys(const std::map<CKeyID, CKey>& privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
462  bool ImportPubKeys(const std::vector<CKeyID>& ordered_pubkeys, const std::map<CKeyID, CPubKey>& pubkey_map, const std::map<CKeyID, std::pair<CPubKey, KeyOriginInfo>>& key_origins, const bool add_keypool, const bool internal, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
463  bool ImportScriptPubKeys(const std::set<CScript>& script_pub_keys, const bool have_solving_data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
464 
465  /* Returns true if the wallet can generate new keys */
466  bool CanGenerateKeys() const;
467 
468  /* Generates a new HD seed (will not be activated) */
470 
471  /* Derives a new HD seed (will not be activated) */
472  CPubKey DeriveNewSeed(const CKey& key);
473 
474  /* Set the current HD seed (will reset the chain child index counters)
475  Sets the seed's version based on the current wallet version (so the
476  caller must ensure the current wallet version is correct before calling
477  this function). */
478  void SetHDSeed(const CPubKey& key);
479 
486  void LearnRelatedScripts(const CPubKey& key, OutputType);
487 
492  void LearnAllRelatedScripts(const CPubKey& key);
493 
498  const std::map<CKeyID, int64_t>& GetAllReserveKeys() const { return m_pool_key_to_index; }
499 
500  std::set<CKeyID> GetKeys() const override;
501 };
502 
505 {
506 private:
508 public:
509  explicit LegacySigningProvider(const LegacyScriptPubKeyMan& spk_man) : m_spk_man(spk_man) {}
510 
511  bool GetCScript(const CScriptID &scriptid, CScript& script) const override { return m_spk_man.GetCScript(scriptid, script); }
512  bool HaveCScript(const CScriptID &scriptid) const override { return m_spk_man.HaveCScript(scriptid); }
513  bool GetPubKey(const CKeyID &address, CPubKey& pubkey) const override { return m_spk_man.GetPubKey(address, pubkey); }
514  bool GetKey(const CKeyID &address, CKey& key) const override { return false; }
515  bool HaveKey(const CKeyID &address) const override { return false; }
516  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override { return m_spk_man.GetKeyOrigin(keyid, info); }
517 };
518 
520 {
521 private:
522  using ScriptPubKeyMap = std::map<CScript, int32_t>; // Map of scripts to descriptor range index
523  using PubKeyMap = std::map<CPubKey, int32_t>; // Map of pubkeys involved in scripts to descriptor range index
524  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
525  using KeyMap = std::map<CKeyID, CKey>;
526 
527  ScriptPubKeyMap m_map_script_pub_keys GUARDED_BY(cs_desc_man);
528  PubKeyMap m_map_pubkeys GUARDED_BY(cs_desc_man);
529  int32_t m_max_cached_index = -1;
530 
531  KeyMap m_map_keys GUARDED_BY(cs_desc_man);
532  CryptedKeyMap m_map_crypted_keys GUARDED_BY(cs_desc_man);
533 
536 
537  bool AddDescriptorKeyWithDB(WalletBatch& batch, const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
538 
540 
541  // Fetch the SigningProvider for the given script and optionally include private keys
542  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CScript& script, bool include_private = false) const;
543  // Fetch the SigningProvider for the given pubkey and always include private keys. This should only be called by signing code.
544  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CPubKey& pubkey) const;
545  // Fetch the SigningProvider for a given index and optionally include private keys. Called by the above functions.
546  std::unique_ptr<FlatSigningProvider> GetSigningProvider(int32_t index, bool include_private = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
547 
548 protected:
549  WalletDescriptor m_wallet_descriptor GUARDED_BY(cs_desc_man);
550 
551 public:
553  : ScriptPubKeyMan(storage),
554  m_wallet_descriptor(descriptor)
555  {}
557  : ScriptPubKeyMan(storage)
558  {}
559 
561 
562  bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) override;
563  isminetype IsMine(const CScript& script) const override;
564 
565  bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) override;
566  bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
567 
568  bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool, std::string& error) override;
569  void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) override;
570 
571  // Tops up the descriptor cache and m_map_script_pub_keys. The cache is stored in the wallet file
572  // and is used to expand the descriptor in GetNewDestination. DescriptorScriptPubKeyMan relies
573  // more on ephemeral data than LegacyScriptPubKeyMan. For wallets using unhardened derivation
574  // (with or without private keys), the "keypool" is a single xpub.
575  bool TopUp(unsigned int size = 0) override;
576 
577  void MarkUnusedAddresses(const CScript& script) override;
578 
579  bool IsHDEnabled() const override;
580 
582  bool SetupDescriptorGeneration(const CExtKey& master_key, OutputType addr_type, bool internal);
583 
587  bool SetupDescriptor(std::unique_ptr<Descriptor>desc);
588 
589  bool HavePrivateKeys() const override;
590 
591  int64_t GetOldestKeyPoolTime() const override;
592  unsigned int GetKeyPoolSize() const override;
593 
594  int64_t GetTimeFirstKey() const override;
595 
596  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
597 
598  bool CanGetAddresses(bool internal = false) const override;
599 
600  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
601 
602  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
603 
604  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
605  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
606  TransactionError FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
607 
608  uint256 GetID() const override;
609 
610  void SetCache(const DescriptorCache& cache);
611 
612  bool AddKey(const CKeyID& key_id, const CKey& key);
613  bool AddCryptedKey(const CKeyID& key_id, const CPubKey& pubkey, const std::vector<unsigned char>& crypted_key);
614 
615  bool HasWalletDescriptor(const WalletDescriptor& desc) const;
616  void UpdateWalletDescriptor(WalletDescriptor& descriptor);
617  bool CanUpdateToWalletDescriptor(const WalletDescriptor& descriptor, std::string& error);
618  void AddDescriptorKey(const CKey& key, const CPubKey &pubkey);
619  void WriteDescriptor();
620 
622  const std::vector<CScript> GetScriptPubKeys() const;
623 
624  bool GetDescriptorString(std::string& out) const;
625 
626  void UpgradeDescriptorCache();
627 };
628 
629 #endif // BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
LegacyScriptPubKeyMan::TopUp
bool TopUp(unsigned int size=0) override
Fills internal address pool.
Definition: scriptpubkeyman.cpp:1247
DescriptorScriptPubKeyMan::CheckDecryptionKey
bool CheckDecryptionKey(const CKeyingMaterial &master_key, bool accept_no_keys=false) override
Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the ke...
Definition: scriptpubkeyman.cpp:1669
LegacyScriptPubKeyMan::KeepDestination
void KeepDestination(int64_t index, const OutputType &type) override
Definition: scriptpubkeyman.cpp:1309
DescriptorScriptPubKeyMan::SignMessage
SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const override
Sign a message with the given script.
Definition: scriptpubkeyman.cpp:2063
ScriptPubKeyMan::m_storage
WalletStorage & m_storage
Definition: scriptpubkeyman.h:172
LegacyScriptPubKeyMan::AddKeypoolPubkeyWithDB
void AddKeypoolPubkeyWithDB(const CPubKey &pubkey, const bool internal, WalletBatch &batch)
Definition: scriptpubkeyman.cpp:1293
crypter.h
LegacyScriptPubKeyMan::HavePrivateKeys
bool HavePrivateKeys() const override
Definition: scriptpubkeyman.cpp:500
LegacyScriptPubKeyMan::TopUpInactiveHDChain
bool TopUpInactiveHDChain(const CKeyID seed_id, int64_t index, bool internal)
Like TopUp() but adds keys for inactive HD chains.
Definition: scriptpubkeyman.cpp:320
DescriptorScriptPubKeyMan::GUARDED_BY
ScriptPubKeyMap m_map_script_pub_keys GUARDED_BY(cs_desc_man)
LegacySigningProvider::GetCScript
bool GetCScript(const CScriptID &scriptid, CScript &script) const override
Definition: scriptpubkeyman.h:511
LegacyScriptPubKeyMan::IsHDEnabled
bool IsHDEnabled() const override
Definition: scriptpubkeyman.cpp:437
LegacyScriptPubKeyMan::UpdateTimeFirstKey
void UpdateTimeFirstKey(int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Update wallet first key creation time.
Definition: scriptpubkeyman.cpp:691
OutputType
OutputType
Definition: outputtype.h:17
LegacySigningProvider::LegacySigningProvider
LegacySigningProvider(const LegacyScriptPubKeyMan &spk_man)
Definition: scriptpubkeyman.h:509
LegacyScriptPubKeyMan::GetWatchPubKey
bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const
Fetches a pubkey from mapWatchKeys if it exists there.
Definition: scriptpubkeyman.cpp:1007
DEFAULT_KEYPOOL_SIZE
static const unsigned int DEFAULT_KEYPOOL_SIZE
Default for -keypool.
Definition: scriptpubkeyman.h:48
LegacyScriptPubKeyMan::AddKeyPubKey
bool AddKeyPubKey(const CKey &key, const CPubKey &pubkey) override
Adds a key to the store, and saves it to disk.
Definition: scriptpubkeyman.cpp:708
LegacyScriptPubKeyMan::AddWatchOnly
bool AddWatchOnly(const CScript &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Private version of AddWatchOnly method which does not accept a timestamp, and which will reset the wa...
Definition: scriptpubkeyman.cpp:922
CKeyPool::Unserialize
void Unserialize(Stream &s)
Definition: scriptpubkeyman.h:127
ScriptPubKeyMan::RewriteDB
virtual void RewriteDB()
The action to do when the DB needs rewrite.
Definition: scriptpubkeyman.h:215
DescriptorScriptPubKeyMan::MarkUnusedAddresses
void MarkUnusedAddresses(const CScript &script) override
Mark unused addresses as being used.
Definition: scriptpubkeyman.cpp:1823
ScriptPubKeyMan::SignTransaction
virtual bool SignTransaction(CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, std::string > &input_errors) const
Creates new signatures and adds them to the transaction.
Definition: scriptpubkeyman.h:233
LegacyScriptPubKeyMan::MarkUnusedAddresses
void MarkUnusedAddresses(const CScript &script) override
Mark unused addresses as being used.
Definition: scriptpubkeyman.cpp:357
CKeyPool
A key from a CWallet's keypool.
Definition: scriptpubkeyman.h:101
LegacyScriptPubKeyMan::GetHDChain
const CHDChain & GetHDChain() const
Definition: scriptpubkeyman.h:432
DescriptorScriptPubKeyMan::SetupDescriptorGeneration
bool SetupDescriptorGeneration(const CExtKey &master_key, OutputType addr_type, bool internal)
Setup descriptors based on the given CExtkey.
Definition: scriptpubkeyman.cpp:1877
LegacyScriptPubKeyMan::GetKeyPoolSize
unsigned int GetKeyPoolSize() const override
Definition: scriptpubkeyman.cpp:555
LegacySigningProvider::GetKeyOrigin
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
Definition: scriptpubkeyman.h:516
DescriptorScriptPubKeyMan::DescriptorScriptPubKeyMan
DescriptorScriptPubKeyMan(WalletStorage &storage)
Definition: scriptpubkeyman.h:556
DescriptorScriptPubKeyMan::GetSolvingProvider
std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const override
Definition: scriptpubkeyman.cpp:2039
LegacyScriptPubKeyMan::AddCryptedKeyInner
bool AddCryptedKeyInner(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)
Definition: scriptpubkeyman.cpp:817
LegacyScriptPubKeyMan::m_index_to_reserved_key
std::map< int64_t, CKeyID > m_index_to_reserved_key
Definition: scriptpubkeyman.h:322
KeyIDHasher::operator()
size_t operator()(const CKeyID &id) const
Definition: scriptpubkeyman.h:156
LegacyScriptPubKeyMan::CanGetAddresses
bool CanGetAddresses(bool internal=false) const override
Definition: scriptpubkeyman.cpp:442
OutputType::LEGACY
@ LEGACY
LegacyScriptPubKeyMan::GUARDED_BY
WalletBatch *encrypted_batch GUARDED_BY(cs_KeyStore)
ScriptPubKeyMan::IsMine
virtual isminetype IsMine(const CScript &script) const
Definition: scriptpubkeyman.h:178
FillableSigningProvider
Fillable signing provider that keeps keys in an address->secret map.
Definition: signingprovider.h:67
LegacyScriptPubKeyMan::LoadKeyPool
void LoadKeyPool(int64_t nIndex, const CKeyPool &keypool)
Load a keypool entry.
Definition: scriptpubkeyman.cpp:1130
DescriptorScriptPubKeyMan::HasWalletDescriptor
bool HasWalletDescriptor(const WalletDescriptor &desc) const
Definition: scriptpubkeyman.cpp:2229
LegacyScriptPubKeyMan::LearnRelatedScripts
void LearnRelatedScripts(const CPubKey &key, OutputType)
Explicitly make the wallet learn the related scripts for outputs to the given key.
Definition: scriptpubkeyman.cpp:1412
DescriptorScriptPubKeyMan::SetupDescriptor
bool SetupDescriptor(std::unique_ptr< Descriptor >desc)
Provide a descriptor at setup time Returns false if already setup or setup fails, true if setup is su...
LegacyScriptPubKeyMan::WatchOnlySet
std::set< CScript > WatchOnlySet
Definition: scriptpubkeyman.h:267
bilingual_str
Bilingual messages:
Definition: translation.h:16
DescriptorScriptPubKeyMan::IsMine
isminetype IsMine(const CScript &script) const override
Definition: scriptpubkeyman.cpp:1660
CKeyingMaterial
std::vector< unsigned char, secure_allocator< unsigned char > > CKeyingMaterial
Definition: crypter.h:61
DescriptorScriptPubKeyMan::UpdateWalletDescriptor
void UpdateWalletDescriptor(WalletDescriptor &descriptor)
Definition: scriptpubkeyman.cpp:2300
WalletStorage::GetDisplayName
virtual const std::string GetDisplayName() const =0
LegacyScriptPubKeyMan::UpgradeKeyMetadata
void UpgradeKeyMetadata()
Upgrade stored CKeyMetadata objects to store key origin info as KeyOriginInfo.
Definition: scriptpubkeyman.cpp:389
LegacyScriptPubKeyMan::NewKeyPool
bool NewKeyPool()
Mark old keypool keys as used, and generate all new keys.
Definition: scriptpubkeyman.cpp:1213
LegacyScriptPubKeyMan::LoadKeyMetadata
void LoadKeyMetadata(const CKeyID &keyID, const CKeyMetadata &metadata)
Load metadata (used by LoadWallet)
Definition: scriptpubkeyman.cpp:770
DescriptorScriptPubKeyMan::IsHDEnabled
bool IsHDEnabled() const override
Definition: scriptpubkeyman.cpp:1951
SigningProvider
An interface to be implemented by keystores that support signing.
Definition: signingprovider.h:18
LegacyScriptPubKeyMan::GetTimeFirstKey
int64_t GetTimeFirstKey() const override
Definition: scriptpubkeyman.cpp:561
GetTime
int64_t GetTime()
DEPRECATED Use either GetTimeSeconds (not mockable) or GetTime<T> (mockable)
Definition: time.cpp:26
LegacyScriptPubKeyMan::Encrypt
bool Encrypt(const CKeyingMaterial &master_key, WalletBatch *batch) override
Definition: scriptpubkeyman.cpp:268
LegacyScriptPubKeyMan::GetKeyFromPool
bool GetKeyFromPool(CPubKey &key, const OutputType type, bool internal=false)
Fetches a key from the keypool.
Definition: scriptpubkeyman.cpp:1343
LegacyScriptPubKeyMan::SetHDSeed
void SetHDSeed(const CPubKey &key)
Definition: scriptpubkeyman.cpp:1194
AnnotatedMixin< std::recursive_mutex >
LegacyScriptPubKeyMan::FillPSBT
TransactionError FillPSBT(PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=1, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr) const override
Adds script and derivation path information to a PSBT, and optionally signs it.
Definition: scriptpubkeyman.cpp:613
KeyIDHasher::KeyIDHasher
KeyIDHasher()
Definition: scriptpubkeyman.h:154
LegacySigningProvider::GetKey
bool GetKey(const CKeyID &address, CKey &key) const override
Definition: scriptpubkeyman.h:514
ScriptPubKeyMan::KeepDestination
virtual void KeepDestination(int64_t index, const OutputType &type)
Definition: scriptpubkeyman.h:185
ScriptPubKeyMan::WalletLogPrintf
void WalletLogPrintf(std::string fmt, Params... parameters) const
Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.
Definition: scriptpubkeyman.h:243
DescriptorScriptPubKeyMan::UpgradeDescriptorCache
void UpgradeDescriptorCache()
Definition: scriptpubkeyman.cpp:2271
DescriptorScriptPubKeyMan::CanProvide
bool CanProvide(const CScript &script, SignatureData &sigdata) override
Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that,...
Definition: scriptpubkeyman.cpp:2044
WalletDatabase
An instance of this class represents one database.
Definition: db.h:103
LegacyScriptPubKeyMan::GetKeys
std::set< CKeyID > GetKeys() const override
Definition: scriptpubkeyman.cpp:1603
LegacyScriptPubKeyMan::m_pool_key_to_index
std::map< CKeyID, int64_t > m_pool_key_to_index
Definition: scriptpubkeyman.h:320
CKeyID
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:22
ScriptPubKeyMan::~ScriptPubKeyMan
virtual ~ScriptPubKeyMan()
Definition: scriptpubkeyman.h:176
DescriptorScriptPubKeyMan::PubKeyMap
std::map< CPubKey, int32_t > PubKeyMap
Definition: scriptpubkeyman.h:523
ScriptPubKeyMan::HavePrivateKeys
virtual bool HavePrivateKeys() const
Definition: scriptpubkeyman.h:212
LegacyScriptPubKeyMan
Definition: scriptpubkeyman.h:261
DescriptorScriptPubKeyMan::GetSigningProvider
std::unique_ptr< FlatSigningProvider > GetSigningProvider(const CScript &script, bool include_private=false) const
Definition: scriptpubkeyman.cpp:1993
CKeyPool::nTime
int64_t nTime
The time at which the key was generated. Set in AddKeypoolPubKeyWithDB.
Definition: scriptpubkeyman.h:105
ScriptPubKeyMan::CanProvide
virtual bool CanProvide(const CScript &script, SignatureData &sigdata)
Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that,...
Definition: scriptpubkeyman.h:230
DescriptorScriptPubKeyMan::KeyMap
std::map< CKeyID, CKey > KeyMap
Definition: scriptpubkeyman.h:525
LegacyScriptPubKeyMan::m_inactive_hd_chains
std::unordered_map< CKeyID, CHDChain, SaltedSipHasher > m_inactive_hd_chains
Definition: scriptpubkeyman.h:311
LegacyScriptPubKeyMan::LoadKey
bool LoadKey(const CKey &key, const CPubKey &pubkey)
Adds a key to the store, without saving it to disk (used by LoadWallet)
Definition: scriptpubkeyman.cpp:703
LegacyScriptPubKeyMan::GetKey
bool GetKey(const CKeyID &address, CKey &keyOut) const override
Definition: scriptpubkeyman.cpp:971
SigningResult
SigningResult
Definition: message.h:42
LegacyScriptPubKeyMan::ReturnDestination
void ReturnDestination(int64_t index, bool internal, const CTxDestination &) override
Definition: scriptpubkeyman.cpp:1323
LegacyScriptPubKeyMan::MarkPreSplitKeys
void MarkPreSplitKeys() EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1466
DescriptorScriptPubKeyMan::m_decryption_thoroughly_checked
bool m_decryption_thoroughly_checked
keeps track of whether Unlock has run a thorough check before
Definition: scriptpubkeyman.h:535
DescriptorScriptPubKeyMan::HavePrivateKeys
bool HavePrivateKeys() const override
Definition: scriptpubkeyman.cpp:1967
LegacyScriptPubKeyMan::Upgrade
bool Upgrade(int prev_version, int new_version, bilingual_str &error) override
Upgrades the wallet to the specified version.
Definition: scriptpubkeyman.cpp:459
LegacyScriptPubKeyMan::KeypoolCountExternalKeys
size_t KeypoolCountExternalKeys() const
Definition: scriptpubkeyman.cpp:549
LegacyScriptPubKeyMan::GetReservedDestination
bool GetReservedDestination(const OutputType type, bool internal, CTxDestination &address, int64_t &index, CKeyPool &keypool, std::string &error) override
Definition: scriptpubkeyman.cpp:298
KeyIDHasher
Definition: scriptpubkeyman.h:151
DescriptorScriptPubKeyMan
Definition: scriptpubkeyman.h:519
DescriptorScriptPubKeyMan::CanGetAddresses
bool CanGetAddresses(bool internal=false) const override
Definition: scriptpubkeyman.cpp:1957
signingprovider.h
ScriptPubKeyMan::GetReservedDestination
virtual bool GetReservedDestination(const OutputType type, bool internal, CTxDestination &address, int64_t &index, CKeyPool &keypool, std::string &error)
Definition: scriptpubkeyman.h:184
ismine.h
TransactionError
TransactionError
Definition: error.h:22
WalletStorage::GetDatabase
virtual WalletDatabase & GetDatabase() const =0
DescriptorScriptPubKeyMan::ReturnDestination
void ReturnDestination(int64_t index, bool internal, const CTxDestination &addr) override
Definition: scriptpubkeyman.cpp:1732
DescriptorScriptPubKeyMan::AddDescriptorKey
void AddDescriptorKey(const CKey &key, const CPubKey &pubkey)
Definition: scriptpubkeyman.cpp:1838
LegacyScriptPubKeyMan::LoadCScript
bool LoadCScript(const CScript &redeemScript)
Adds a CScript to the store.
Definition: scriptpubkeyman.cpp:755
walletutil.h
DescriptorScriptPubKeyMan::FillPSBT
TransactionError FillPSBT(PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=1, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr) const override
Adds script and derivation path information to a PSBT, and optionally signs it.
Definition: scriptpubkeyman.cpp:2081
ScriptPubKeyMan::FillPSBT
virtual TransactionError FillPSBT(PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=1, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr) const
Adds script and derivation path information to a PSBT, and optionally signs it.
Definition: scriptpubkeyman.h:237
WalletStorage
Definition: scriptpubkeyman.h:32
isminetype
isminetype
IsMine() return codes, which depend on ScriptPubKeyMan implementation.
Definition: ismine.h:38
CKeyPool::m_pre_split
bool m_pre_split
Whether this key was generated for a keypool before the wallet was upgraded to HD-split.
Definition: scriptpubkeyman.h:111
LegacyScriptPubKeyMan::LoadHDChain
void LoadHDChain(const CHDChain &chain)
Load a HD chain model (used by LoadWallet)
Definition: scriptpubkeyman.cpp:934
CTxDestination
std::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script template with a specific destination.
Definition: standard.h:157
ScriptPubKeyMan::GetKeyPoolSize
virtual unsigned int GetKeyPoolSize() const
Definition: scriptpubkeyman.h:219
SignatureData
Definition: sign.h:64
LegacyScriptPubKeyMan::AddKeyPubKeyInner
bool AddKeyPubKeyInner(const CKey &key, const CPubKey &pubkey)
Definition: scriptpubkeyman.cpp:784
LegacyScriptPubKeyMan::DeriveNewSeed
CPubKey DeriveNewSeed(const CKey &key)
Definition: scriptpubkeyman.cpp:1166
CExtKey
Definition: key.h:156
Coin
A UTXO entry.
Definition: coins.h:30
LegacyScriptPubKeyMan::GenerateNewSeed
CPubKey GenerateNewSeed()
Definition: scriptpubkeyman.cpp:1158
ScriptPubKeyMan::NotifyWatchonlyChanged
boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
Watch-only address added.
Definition: scriptpubkeyman.h:245
LegacySigningProvider::GetPubKey
bool GetPubKey(const CKeyID &address, CPubKey &pubkey) const override
Definition: scriptpubkeyman.h:513
LegacyScriptPubKeyMan::HaveKey
bool HaveKey(const CKeyID &address) const override
Definition: scriptpubkeyman.cpp:962
LegacyScriptPubKeyMan::DeriveNewChildKey
void DeriveNewChildKey(WalletBatch &batch, CKeyMetadata &metadata, CKey &secret, CHDChain &hd_chain, bool internal=false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1075
LegacyScriptPubKeyMan::GenerateNewKey
CPubKey GenerateNewKey(WalletBatch &batch, CHDChain &hd_chain, bool internal=false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Generate a new key.
Definition: scriptpubkeyman.cpp:1038
ScriptPubKeyMan::IsHDEnabled
virtual bool IsHDEnabled() const
Definition: scriptpubkeyman.h:204
message.h
LegacyScriptPubKeyMan::SetupGeneration
bool SetupGeneration(bool force=false) override
Sets up the key generation stuff, i.e.
Definition: scriptpubkeyman.cpp:424
ScriptPubKeyMan::MarkUnusedAddresses
virtual void MarkUnusedAddresses(const CScript &script)
Mark unused addresses as being used.
Definition: scriptpubkeyman.h:195
LegacyScriptPubKeyMan::GetNewDestination
bool GetNewDestination(const OutputType type, CTxDestination &dest, std::string &error) override
Definition: scriptpubkeyman.cpp:23
LegacySigningProvider::HaveKey
bool HaveKey(const CKeyID &address) const override
Definition: scriptpubkeyman.h:515
LegacyScriptPubKeyMan::RewriteDB
void RewriteDB() override
The action to do when the DB needs rewrite.
Definition: scriptpubkeyman.cpp:506
DescriptorScriptPubKeyMan::AddCryptedKey
bool AddCryptedKey(const CKeyID &key_id, const CPubKey &pubkey, const std::vector< unsigned char > &crypted_key)
Definition: scriptpubkeyman.cpp:2218
LegacyScriptPubKeyMan::m_hd_chain
CHDChain m_hd_chain
Definition: scriptpubkeyman.h:310
TransactionError::INVALID_PSBT
@ INVALID_PSBT
time.h
DescriptorScriptPubKeyMan::CryptedKeyMap
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
Definition: scriptpubkeyman.h:524
LegacyScriptPubKeyMan::CheckDecryptionKey
bool CheckDecryptionKey(const CKeyingMaterial &master_key, bool accept_no_keys=false) override
Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the ke...
Definition: scriptpubkeyman.cpp:228
LogPrintf
#define LogPrintf(...)
Definition: logging.h:184
standard.h
LegacyScriptPubKeyMan::SignMessage
SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const override
Sign a message with the given script.
Definition: scriptpubkeyman.cpp:600
FillableSigningProvider::HaveCScript
virtual bool HaveCScript(const CScriptID &hash) const override
Definition: signingprovider.cpp:163
WalletStorage::HasEncryptionKeys
virtual bool HasEncryptionKeys() const =0
CKeyPool::vchPubKey
CPubKey vchPubKey
The public key.
Definition: scriptpubkeyman.h:107
LegacySigningProvider::HaveCScript
bool HaveCScript(const CScriptID &scriptid) const override
Definition: scriptpubkeyman.h:512
error.h
LegacyScriptPubKeyMan::ImportPubKeys
bool ImportPubKeys(const std::vector< CKeyID > &ordered_pubkeys, const std::map< CKeyID, CPubKey > &pubkey_map, const std::map< CKeyID, std::pair< CPubKey, KeyOriginInfo >> &key_origins, const bool add_keypool, const bool internal, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1558
LegacyScriptPubKeyMan::GetOldestKeyPoolTime
int64_t GetOldestKeyPoolTime() const override
Definition: scriptpubkeyman.cpp:531
PrecomputedTransactionData
Definition: interpreter.h:150
LegacyScriptPubKeyMan::AddCScript
bool AddCScript(const CScript &redeemScript) override
Definition: scriptpubkeyman.cpp:1484
uint256
256-bit opaque blob.
Definition: uint256.h:124
ISMINE_NO
@ ISMINE_NO
Definition: ismine.h:40
LegacyScriptPubKeyMan::AddCScriptWithDB
bool AddCScriptWithDB(WalletBatch &batch, const CScript &script)
Adds a script to the store and saves it to disk.
Definition: scriptpubkeyman.cpp:1490
LegacyScriptPubKeyMan::WatchKeyMap
std::map< CKeyID, CPubKey > WatchKeyMap
Definition: scriptpubkeyman.h:268
LegacyScriptPubKeyMan::LearnAllRelatedScripts
void LearnAllRelatedScripts(const CPubKey &key)
Same as LearnRelatedScripts, but when the OutputType is not known (and could be anything).
Definition: scriptpubkeyman.cpp:1424
WalletStorage::UnsetBlankWalletFlag
virtual void UnsetBlankWalletFlag(WalletBatch &)=0
LegacyScriptPubKeyMan::CryptedKeyMap
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
Definition: scriptpubkeyman.h:272
ScriptPubKeyMan::GetID
virtual uint256 GetID() const
Definition: scriptpubkeyman.h:239
CScript
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:404
LegacyScriptPubKeyMan::IsMine
isminetype IsMine(const CScript &script) const override
Definition: scriptpubkeyman.cpp:214
DescriptorScriptPubKeyMan::GetOldestKeyPoolTime
int64_t GetOldestKeyPoolTime() const override
Definition: scriptpubkeyman.cpp:1973
LegacyScriptPubKeyMan::ImportPrivKeys
bool ImportPrivKeys(const std::map< CKeyID, CKey > &privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1535
WalletStorage::IsWalletFlagSet
virtual bool IsWalletFlagSet(uint64_t) const =0
ScriptPubKeyMan::ScriptPubKeyMan
ScriptPubKeyMan(WalletStorage &storage)
Definition: scriptpubkeyman.h:175
ScriptPubKeyMan::Upgrade
virtual bool Upgrade(int prev_version, int new_version, bilingual_str &error)
Upgrades the wallet to the specified version.
Definition: scriptpubkeyman.h:210
LegacyScriptPubKeyMan::GetAllReserveKeys
const std::map< CKeyID, int64_t > & GetAllReserveKeys() const
Definition: scriptpubkeyman.h:498
LegacyScriptPubKeyMan::GetID
uint256 GetID() const override
Definition: scriptpubkeyman.cpp:682
DescriptorCache
Cache for single descriptor's derived extended pubkeys.
Definition: descriptor.h:19
LEGACY_OUTPUT_TYPES
static const std::unordered_set< OutputType > LEGACY_OUTPUT_TYPES
OutputTypes supported by the LegacyScriptPubKeyMan.
Definition: scriptpubkeyman.h:255
CKeyPool::CKeyPool
CKeyPool()
Definition: wallet.cpp:2879
LegacyScriptPubKeyMan::LoadCryptedKey
bool LoadCryptedKey(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret, bool checksum_valid)
Adds an encrypted key to the store, without saving it to disk (used by LoadWallet)
Definition: scriptpubkeyman.cpp:807
LegacyScriptPubKeyMan::AddCryptedKey
bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)
Adds an encrypted key to the store, and saves it to disk.
Definition: scriptpubkeyman.cpp:827
OutputType::P2SH_SEGWIT
@ P2SH_SEGWIT
DescriptorScriptPubKeyMan::GetID
uint256 GetID() const override
Definition: scriptpubkeyman.cpp:2172
OutputType::BECH32
@ BECH32
PKHash
Definition: standard.h:79
DescriptorScriptPubKeyMan::GetReservedDestination
bool GetReservedDestination(const OutputType type, bool internal, CTxDestination &address, int64_t &index, CKeyPool &keypool, std::string &error) override
Definition: scriptpubkeyman.cpp:1724
DescriptorScriptPubKeyMan::AddDescriptorKeyWithDB
bool AddDescriptorKeyWithDB(WalletBatch &batch, const CKey &key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man)
Definition: scriptpubkeyman.cpp:1847
LegacyScriptPubKeyMan::LoadScriptMetadata
void LoadScriptMetadata(const CScriptID &script_id, const CKeyMetadata &metadata)
Definition: scriptpubkeyman.cpp:777
DescriptorScriptPubKeyMan::cs_desc_man
RecursiveMutex cs_desc_man
Definition: scriptpubkeyman.h:560
CPubKey
An encapsulated public key.
Definition: pubkey.h:32
LegacyScriptPubKeyMan::CanProvide
bool CanProvide(const CScript &script, SignatureData &sigdata) override
Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that,...
Definition: scriptpubkeyman.cpp:572
DescriptorScriptPubKeyMan::ScriptPubKeyMap
std::map< CScript, int32_t > ScriptPubKeyMap
Definition: scriptpubkeyman.h:522
LegacyScriptPubKeyMan::ImportScriptPubKeys
bool ImportScriptPubKeys(const std::set< CScript > &script_pub_keys, const bool have_solving_data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1590
ScriptPubKeyMan
Definition: scriptpubkeyman.h:169
LegacyScriptPubKeyMan::AddKeyOriginWithDB
bool AddKeyOriginWithDB(WalletBatch &batch, const CPubKey &pubkey, const KeyOriginInfo &info)
Add a KeyOriginInfo to the wallet.
Definition: scriptpubkeyman.cpp:1501
CKey
An encapsulated private key.
Definition: key.h:27
DescriptorScriptPubKeyMan::GetKeyPoolSize
unsigned int GetKeyPoolSize() const override
Definition: scriptpubkeyman.cpp:1981
DescriptorScriptPubKeyMan::GetMetadata
std::unique_ptr< CKeyMetadata > GetMetadata(const CTxDestination &dest) const override
Definition: scriptpubkeyman.cpp:2154
CHDChain
Definition: walletdb.h:85
ScriptPubKeyMan::Encrypt
virtual bool Encrypt(const CKeyingMaterial &master_key, WalletBatch *batch)
Definition: scriptpubkeyman.h:182
EXCLUSIVE_LOCKS_REQUIRED
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
DescriptorScriptPubKeyMan::GetWalletDescriptor
const WalletDescriptor GetWalletDescriptor() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man)
Definition: scriptpubkeyman.cpp:2244
DescriptorScriptPubKeyMan::TopUp
bool TopUp(unsigned int size=0) override
Fills internal address pool.
Definition: scriptpubkeyman.cpp:1760
LegacyScriptPubKeyMan::GetSolvingProvider
std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const override
Definition: scriptpubkeyman.cpp:567
PartiallySignedTransaction
A version of CTransaction with the PSBT format.
Definition: psbt.h:391
WalletStorage::~WalletStorage
virtual ~WalletStorage()=default
LegacyScriptPubKeyMan::LoadWatchOnly
bool LoadWatchOnly(const CScript &dest)
Adds a watch-only address to the store, without saving it to disk (used by LoadWallet)
Definition: scriptpubkeyman.cpp:885
WalletStorage::GetEncryptionKey
virtual const CKeyingMaterial & GetEncryptionKey() const =0
GetAffectedKeys
std::vector< CKeyID > GetAffectedKeys(const CScript &spk, const SigningProvider &provider)
Definition: scriptpubkeyman.cpp:1454
SigningResult::SIGNING_FAILED
@ SIGNING_FAILED
DescriptorScriptPubKeyMan::m_max_cached_index
int32_t m_max_cached_index
Definition: scriptpubkeyman.h:529
LegacyScriptPubKeyMan::GetPubKey
bool GetPubKey(const CKeyID &address, CPubKey &vchPubKeyOut) const override
Definition: scriptpubkeyman.cpp:1018
LegacyScriptPubKeyMan::RemoveWatchOnly
bool RemoveWatchOnly(const CScript &dest)
Remove a watch only script from the keystore.
Definition: scriptpubkeyman.cpp:864
ScriptPubKeyMan::TopUp
virtual bool TopUp(unsigned int size=0)
Fills internal address pool.
Definition: scriptpubkeyman.h:192
ScriptPubKeyMan::SetupGeneration
virtual bool SetupGeneration(bool force=false)
Sets up the key generation stuff, i.e.
Definition: scriptpubkeyman.h:201
Params
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:536
LegacySigningProvider::m_spk_man
const LegacyScriptPubKeyMan & m_spk_man
Definition: scriptpubkeyman.h:507
LegacyScriptPubKeyMan::HaveWatchOnly
bool HaveWatchOnly() const
Returns whether there are any watch-only things in the wallet.
Definition: scriptpubkeyman.cpp:851
ScriptPubKeyMan::GetOldestKeyPoolTime
virtual int64_t GetOldestKeyPoolTime() const
Definition: scriptpubkeyman.h:217
LegacyScriptPubKeyMan::ImportScripts
bool ImportScripts(const std::set< CScript > scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:1511
DescriptorScriptPubKeyMan::AddKey
bool AddKey(const CKeyID &key_id, const CKey &key)
Definition: scriptpubkeyman.cpp:2211
DescriptorScriptPubKeyMan::GetKeys
KeyMap GetKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man)
Definition: scriptpubkeyman.cpp:1743
CKeyPool::fInternal
bool fInternal
Whether this keypool entry is in the internal keypool (for change outputs)
Definition: scriptpubkeyman.h:109
ScriptPubKeyMan::GetSolvingProvider
virtual std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const
Definition: scriptpubkeyman.h:225
LegacyScriptPubKeyMan::MarkReserveKeysAsUsed
void MarkReserveKeysAsUsed(int64_t keypool_id) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Marks all keys in the keypool up to and including reserve_key as used.
Definition: scriptpubkeyman.cpp:1430
LegacyScriptPubKeyMan::AddHDChain
void AddHDChain(const CHDChain &chain)
Definition: scriptpubkeyman.cpp:940
FillableSigningProvider::GetCScript
virtual bool GetCScript(const CScriptID &hash, CScript &redeemScriptOut) const override
Definition: signingprovider.cpp:179
ScriptPubKeyMan::ReturnDestination
virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination &addr)
Definition: scriptpubkeyman.h:186
WalletDescriptor
Descriptor with some wallet metadata.
Definition: walletutil.h:75
ScriptPubKeyMan::GetNewDestination
virtual bool GetNewDestination(const OutputType type, CTxDestination &dest, std::string &error)
Definition: scriptpubkeyman.h:177
walletdb.h
WalletFeature
WalletFeature
(client) version numbers for particular wallet features
Definition: walletutil.h:14
DescriptorScriptPubKeyMan::WriteDescriptor
void WriteDescriptor()
Definition: scriptpubkeyman.cpp:2235
LegacyScriptPubKeyMan::GetKeyOrigin
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
Definition: scriptpubkeyman.cpp:988
COutPoint
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:26
LegacyScriptPubKeyMan::fDecryptionThoroughlyChecked
bool fDecryptionThoroughlyChecked
keeps track of whether Unlock has run a thorough check before
Definition: scriptpubkeyman.h:265
ScriptPubKeyMan::GetMetadata
virtual std::unique_ptr< CKeyMetadata > GetMetadata(const CTxDestination &dest) const
Definition: scriptpubkeyman.h:223
DescriptorScriptPubKeyMan::GetTimeFirstKey
int64_t GetTimeFirstKey() const override
Definition: scriptpubkeyman.cpp:1987
DescriptorScriptPubKeyMan::GetScriptPubKeys
const std::vector< CScript > GetScriptPubKeys() const
Definition: scriptpubkeyman.cpp:2249
FillableSigningProvider::cs_KeyStore
RecursiveMutex cs_KeyStore
Definition: signingprovider.h:125
error
bool error(const char *fmt, const Args &... args)
Definition: system.h:49
LegacyScriptPubKeyMan::AddWatchOnlyInMem
bool AddWatchOnlyInMem(const CScript &dest)
Definition: scriptpubkeyman.cpp:890
ScriptPubKeyMan::CheckDecryptionKey
virtual bool CheckDecryptionKey(const CKeyingMaterial &master_key, bool accept_no_keys=false)
Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the ke...
Definition: scriptpubkeyman.h:181
WalletStorage::IsLocked
virtual bool IsLocked() const =0
CMutableTransaction
A mutable version of CTransaction.
Definition: transaction.h:344
LegacyScriptPubKeyMan::AddInactiveHDChain
void AddInactiveHDChain(const CHDChain &chain)
Definition: scriptpubkeyman.cpp:955
LegacyScriptPubKeyMan::CanGenerateKeys
bool CanGenerateKeys() const
Definition: scriptpubkeyman.cpp:1151
DescriptorScriptPubKeyMan::SignTransaction
bool SignTransaction(CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, std::string > &input_errors) const override
Creates new signatures and adds them to the transaction.
Definition: scriptpubkeyman.cpp:2049
DescriptorScriptPubKeyMan::GetNewDestination
bool GetNewDestination(const OutputType type, CTxDestination &dest, std::string &error) override
Definition: scriptpubkeyman.cpp:1616
ScriptPubKeyMan::SignMessage
virtual SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const
Sign a message with the given script.
Definition: scriptpubkeyman.h:235
DescriptorScriptPubKeyMan::SetCache
void SetCache(const DescriptorCache &cache)
Definition: scriptpubkeyman.cpp:2181
CScriptID
A reference to a CScript: the Hash160 of its serialization (see script.h)
Definition: standard.h:25
DescriptorScriptPubKeyMan::Encrypt
bool Encrypt(const CKeyingMaterial &master_key, WalletBatch *batch) override
Definition: scriptpubkeyman.cpp:1701
ScriptPubKeyMan::NotifyCanGetAddressesChanged
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
Keypool has new keys.
Definition: scriptpubkeyman.h:251
CKeyPool::Serialize
void Serialize(Stream &s) const
Definition: scriptpubkeyman.h:117
WalletBatch
Access to the wallet database.
Definition: walletdb.h:176
LegacyScriptPubKeyMan::GetMetadata
std::unique_ptr< CKeyMetadata > GetMetadata(const CTxDestination &dest) const override
Definition: scriptpubkeyman.cpp:661
LegacyScriptPubKeyMan::ReserveKeyFromKeyPool
bool ReserveKeyFromKeyPool(int64_t &nIndex, CKeyPool &keypool, bool fRequestedInternal)
Reserves a key from the keypool and sets nIndex to its index.
Definition: scriptpubkeyman.cpp:1366
ScriptPubKeyMan::CanGetAddresses
virtual bool CanGetAddresses(bool internal=false) const
Definition: scriptpubkeyman.h:207
WalletStorage::SetMinVersion
virtual void SetMinVersion(enum WalletFeature, WalletBatch *=nullptr)=0
LegacySigningProvider
Wraps a LegacyScriptPubKeyMan so that it can be returned in a new unique_ptr.
Definition: scriptpubkeyman.h:504
SER_GETHASH
@ SER_GETHASH
Definition: serialize.h:140
CKeyMetadata
Definition: walletdb.h:121
LegacyScriptPubKeyMan::AddKeyPubKeyWithDB
bool AddKeyPubKeyWithDB(WalletBatch &batch, const CKey &key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Adds a key to the store, and saves it to disk.
Definition: scriptpubkeyman.cpp:715
WalletStorage::CanSupportFeature
virtual bool CanSupportFeature(enum WalletFeature) const =0
DescriptorScriptPubKeyMan::CanUpdateToWalletDescriptor
bool CanUpdateToWalletDescriptor(const WalletDescriptor &descriptor, std::string &error)
Definition: scriptpubkeyman.cpp:2314
DescriptorScriptPubKeyMan::GetDescriptorString
bool GetDescriptorString(std::string &out) const
Definition: scriptpubkeyman.cpp:2261
KeyOriginInfo
Definition: keyorigin.h:11
FlatSigningProvider
Definition: signingprovider.h:49
descriptor.h
ScriptPubKeyMan::GetTimeFirstKey
virtual int64_t GetTimeFirstKey() const
Definition: scriptpubkeyman.h:221
LegacyScriptPubKeyMan::AddWatchOnlyWithDB
bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
Definition: scriptpubkeyman.cpp:902
LegacyScriptPubKeyMan::SignTransaction
bool SignTransaction(CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, std::string > &input_errors) const override
Creates new signatures and adds them to the transaction.
Definition: scriptpubkeyman.cpp:595