Bitcoin Core  0.20.99
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 <wallet/crypter.h>
15 #include <wallet/ismine.h>
16 #include <wallet/walletdb.h>
17 #include <wallet/walletutil.h>
18 
19 #include <boost/signals2/signal.hpp>
20 
21 #include <unordered_map>
22 
23 enum class OutputType;
24 struct bilingual_str;
25 
26 // Wallet storage things that ScriptPubKeyMans need in order to be able to store things to the wallet database.
27 // It provides access to things that are part of the entire wallet and not specific to a ScriptPubKeyMan such as
28 // wallet flags, wallet version, encryption keys, encryption status, and the database itself. This allows a
29 // ScriptPubKeyMan to have callbacks into CWallet without causing a circular dependency.
30 // WalletStorage should be the same for all ScriptPubKeyMans of a wallet.
32 {
33 public:
34  virtual ~WalletStorage() = default;
35  virtual const std::string GetDisplayName() const = 0;
36  virtual WalletDatabase& GetDatabase() = 0;
37  virtual bool IsWalletFlagSet(uint64_t) const = 0;
38  virtual void UnsetBlankWalletFlag(WalletBatch&) = 0;
39  virtual bool CanSupportFeature(enum WalletFeature) const = 0;
40  virtual void SetMinVersion(enum WalletFeature, WalletBatch* = nullptr, bool = false) = 0;
41  virtual const CKeyingMaterial& GetEncryptionKey() const = 0;
42  virtual bool HasEncryptionKeys() const = 0;
43  virtual bool IsLocked() const = 0;
44 };
45 
47 static const unsigned int DEFAULT_KEYPOOL_SIZE = 1000;
48 
49 std::vector<CKeyID> GetAffectedKeys(const CScript& spk, const SigningProvider& provider);
50 
100 class CKeyPool
101 {
102 public:
104  int64_t nTime;
108  bool fInternal;
111 
112  CKeyPool();
113  CKeyPool(const CPubKey& vchPubKeyIn, bool internalIn);
114 
115  template<typename Stream>
116  void Serialize(Stream& s) const
117  {
118  int nVersion = s.GetVersion();
119  if (!(s.GetType() & SER_GETHASH)) {
120  s << nVersion;
121  }
122  s << nTime << vchPubKey << fInternal << m_pre_split;
123  }
124 
125  template<typename Stream>
126  void Unserialize(Stream& s)
127  {
128  int nVersion = s.GetVersion();
129  if (!(s.GetType() & SER_GETHASH)) {
130  s >> nVersion;
131  }
132  s >> nTime >> vchPubKey;
133  try {
134  s >> fInternal;
135  } catch (std::ios_base::failure&) {
136  /* flag as external address if we can't read the internal boolean
137  (this will be the case for any wallet before the HD chain split version) */
138  fInternal = false;
139  }
140  try {
141  s >> m_pre_split;
142  } catch (std::ios_base::failure&) {
143  /* flag as postsplit address if we can't read the m_pre_split boolean
144  (this will be the case for any wallet that upgrades to HD chain split) */
145  m_pre_split = false;
146  }
147  }
148 };
149 
151 {
152 public:
154 
155  size_t operator()(const CKeyID& id) const
156  {
157  return id.GetUint64(0);
158  }
159 };
160 
161 /*
162  * A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet.
163  * It contains the scripts and keys related to the scriptPubKeys it manages.
164  * A ScriptPubKeyMan will be able to give out scriptPubKeys to be used, as well as marking
165  * when a scriptPubKey has been used. It also handles when and how to store a scriptPubKey
166  * and its related scripts and keys, including encryption.
167  */
169 {
170 protected:
172 
173 public:
174  ScriptPubKeyMan(WalletStorage& storage) : m_storage(storage) {}
175  virtual ~ScriptPubKeyMan() {};
176  virtual bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) { return false; }
177  virtual isminetype IsMine(const CScript& script) const { return ISMINE_NO; }
178 
180  virtual bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) { return false; }
181  virtual bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) { return false; }
182 
183  virtual bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) { return false; }
184  virtual void KeepDestination(int64_t index, const OutputType& type) {}
185  virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) {}
186 
191  virtual bool TopUp(unsigned int size = 0) { return false; }
192 
194  virtual void MarkUnusedAddresses(const CScript& script) {}
195 
200  virtual bool SetupGeneration(bool force = false) { return false; }
201 
202  /* Returns true if HD is enabled */
203  virtual bool IsHDEnabled() const { return false; }
204 
205  /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
206  virtual bool CanGetAddresses(bool internal = false) const { return false; }
207 
209  virtual bool Upgrade(int prev_version, bilingual_str& error) { return false; }
210 
211  virtual bool HavePrivateKeys() const { return false; }
212 
214  virtual void RewriteDB() {}
215 
216  virtual int64_t GetOldestKeyPoolTime() const { return GetTime(); }
217 
218  virtual size_t KeypoolCountExternalKeys() const { return 0; }
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, 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 
241  virtual void SetInternal(bool internal) {}
242 
244  template<typename... Params>
245  void WalletLogPrintf(std::string fmt, Params... parameters) const {
246  LogPrintf(("%s " + fmt).c_str(), m_storage.GetDisplayName(), parameters...);
247  };
248 
250  boost::signals2::signal<void (bool fHaveWatchOnly)> NotifyWatchonlyChanged;
251 
253  boost::signals2::signal<void ()> NotifyCanGetAddressesChanged;
254 };
255 
257 {
258 private:
260  bool fDecryptionThoroughlyChecked = true;
261 
262  using WatchOnlySet = std::set<CScript>;
263  using WatchKeyMap = std::map<CKeyID, CPubKey>;
264 
265  WalletBatch *encrypted_batch GUARDED_BY(cs_KeyStore) = nullptr;
266 
267  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
268 
269  CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
270  WatchOnlySet setWatchOnly GUARDED_BY(cs_KeyStore);
271  WatchKeyMap mapWatchKeys GUARDED_BY(cs_KeyStore);
272 
273  int64_t nTimeFirstKey GUARDED_BY(cs_KeyStore) = 0;
274 
275  bool AddKeyPubKeyInner(const CKey& key, const CPubKey &pubkey);
276  bool AddCryptedKeyInner(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
277 
287  bool AddWatchOnly(const CScript& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
288  bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
289  bool AddWatchOnlyInMem(const CScript &dest);
291  bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript& dest, int64_t create_time) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
292 
294  bool AddKeyPubKeyWithDB(WalletBatch &batch,const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
295 
296  void AddKeypoolPubkeyWithDB(const CPubKey& pubkey, const bool internal, WalletBatch& batch);
297 
299  bool AddCScriptWithDB(WalletBatch& batch, const CScript& script);
300 
302  bool AddKeyOriginWithDB(WalletBatch& batch, const CPubKey& pubkey, const KeyOriginInfo& info);
303 
304  /* the HD chain data model (external chain counters) */
306  std::unordered_map<CKeyID, CHDChain, KeyIDHasher> m_inactive_hd_chains;
307 
308  /* HD derive new child key (on internal or external chain) */
309  void DeriveNewChildKey(WalletBatch& batch, CKeyMetadata& metadata, CKey& secret, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
310 
311  std::set<int64_t> setInternalKeyPool GUARDED_BY(cs_KeyStore);
312  std::set<int64_t> setExternalKeyPool GUARDED_BY(cs_KeyStore);
313  std::set<int64_t> set_pre_split_keypool GUARDED_BY(cs_KeyStore);
314  int64_t m_max_keypool_index GUARDED_BY(cs_KeyStore) = 0;
315  std::map<CKeyID, int64_t> m_pool_key_to_index;
316  // Tracks keypool indexes to CKeyIDs of keys that have been taken out of the keypool but may be returned to it
317  std::map<int64_t, CKeyID> m_index_to_reserved_key;
318 
320  bool GetKeyFromPool(CPubKey &key, const OutputType type, bool internal = false);
321 
336  bool ReserveKeyFromKeyPool(int64_t& nIndex, CKeyPool& keypool, bool fRequestedInternal);
337 
348  bool TopUpInactiveHDChain(const CKeyID seed_id, int64_t index, bool internal);
349 
350 public:
352 
353  bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) override;
354  isminetype IsMine(const CScript& script) const override;
355 
356  bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) override;
357  bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
358 
359  bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) override;
360  void KeepDestination(int64_t index, const OutputType& type) override;
361  void ReturnDestination(int64_t index, bool internal, const CTxDestination&) override;
362 
363  bool TopUp(unsigned int size = 0) override;
364 
365  void MarkUnusedAddresses(const CScript& script) override;
366 
368  void UpgradeKeyMetadata();
369 
370  bool IsHDEnabled() const override;
371 
372  bool SetupGeneration(bool force = false) override;
373 
374  bool Upgrade(int prev_version, bilingual_str& error) override;
375 
376  bool HavePrivateKeys() const override;
377 
378  void RewriteDB() override;
379 
380  int64_t GetOldestKeyPoolTime() const override;
381  size_t KeypoolCountExternalKeys() const override;
382  unsigned int GetKeyPoolSize() const override;
383 
384  int64_t GetTimeFirstKey() const override;
385 
386  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
387 
388  bool CanGetAddresses(bool internal = false) const override;
389 
390  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
391 
392  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
393 
394  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
395  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
396  TransactionError FillPSBT(PartiallySignedTransaction& psbt, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
397 
398  uint256 GetID() const override;
399 
400  void SetInternal(bool internal) override;
401 
402  // Map from Key ID to key metadata.
403  std::map<CKeyID, CKeyMetadata> mapKeyMetadata GUARDED_BY(cs_KeyStore);
404 
405  // Map from Script ID to key metadata (for watch-only keys).
406  std::map<CScriptID, CKeyMetadata> m_script_metadata GUARDED_BY(cs_KeyStore);
407 
409  bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
411  bool LoadKey(const CKey& key, const CPubKey &pubkey);
413  bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
415  bool LoadCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret, bool checksum_valid);
416  void UpdateTimeFirstKey(int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
418  bool LoadCScript(const CScript& redeemScript);
420  void LoadKeyMetadata(const CKeyID& keyID, const CKeyMetadata &metadata);
421  void LoadScriptMetadata(const CScriptID& script_id, const CKeyMetadata &metadata);
423  CPubKey GenerateNewKey(WalletBatch& batch, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
424 
425  /* Set the HD chain model (chain child index counters) */
426  void SetHDChain(const CHDChain& chain, bool memonly);
427  const CHDChain& GetHDChain() const { return m_hd_chain; }
428  void AddInactiveHDChain(const CHDChain& chain);
429 
431  bool LoadWatchOnly(const CScript &dest);
433  bool HaveWatchOnly(const CScript &dest) const;
435  bool HaveWatchOnly() const;
437  bool RemoveWatchOnly(const CScript &dest);
438  bool AddWatchOnly(const CScript& dest, int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
439 
441  bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const;
442 
443  /* SigningProvider overrides */
444  bool HaveKey(const CKeyID &address) const override;
445  bool GetKey(const CKeyID &address, CKey& keyOut) const override;
446  bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
447  bool AddCScript(const CScript& redeemScript) override;
448  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
449 
451  void LoadKeyPool(int64_t nIndex, const CKeyPool &keypool);
452  bool NewKeyPool();
453  void MarkPreSplitKeys() EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
454 
455  bool ImportScripts(const std::set<CScript> scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
456  bool ImportPrivKeys(const std::map<CKeyID, CKey>& privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
457  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);
458  bool ImportScriptPubKeys(const std::set<CScript>& script_pub_keys, const bool have_solving_data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
459 
460  /* Returns true if the wallet can generate new keys */
461  bool CanGenerateKeys() const;
462 
463  /* Generates a new HD seed (will not be activated) */
464  CPubKey GenerateNewSeed();
465 
466  /* Derives a new HD seed (will not be activated) */
467  CPubKey DeriveNewSeed(const CKey& key);
468 
469  /* Set the current HD seed (will reset the chain child index counters)
470  Sets the seed's version based on the current wallet version (so the
471  caller must ensure the current wallet version is correct before calling
472  this function). */
473  void SetHDSeed(const CPubKey& key);
474 
481  void LearnRelatedScripts(const CPubKey& key, OutputType);
482 
487  void LearnAllRelatedScripts(const CPubKey& key);
488 
492  void MarkReserveKeysAsUsed(int64_t keypool_id) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
493  const std::map<CKeyID, int64_t>& GetAllReserveKeys() const { return m_pool_key_to_index; }
494 
495  std::set<CKeyID> GetKeys() const override;
496 };
497 
500 {
501 private:
503 public:
504  LegacySigningProvider(const LegacyScriptPubKeyMan& spk_man) : m_spk_man(spk_man) {}
505 
506  bool GetCScript(const CScriptID &scriptid, CScript& script) const override { return m_spk_man.GetCScript(scriptid, script); }
507  bool HaveCScript(const CScriptID &scriptid) const override { return m_spk_man.HaveCScript(scriptid); }
508  bool GetPubKey(const CKeyID &address, CPubKey& pubkey) const override { return m_spk_man.GetPubKey(address, pubkey); }
509  bool GetKey(const CKeyID &address, CKey& key) const override { return false; }
510  bool HaveKey(const CKeyID &address) const override { return false; }
511  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override { return m_spk_man.GetKeyOrigin(keyid, info); }
512 };
513 
515 {
516 private:
517  WalletDescriptor m_wallet_descriptor GUARDED_BY(cs_desc_man);
518 
519  using ScriptPubKeyMap = std::map<CScript, int32_t>; // Map of scripts to descriptor range index
520  using PubKeyMap = std::map<CPubKey, int32_t>; // Map of pubkeys involved in scripts to descriptor range index
521  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
522  using KeyMap = std::map<CKeyID, CKey>;
523 
524  ScriptPubKeyMap m_map_script_pub_keys GUARDED_BY(cs_desc_man);
525  PubKeyMap m_map_pubkeys GUARDED_BY(cs_desc_man);
526  int32_t m_max_cached_index = -1;
527 
528  bool m_internal = false;
529 
530  KeyMap m_map_keys GUARDED_BY(cs_desc_man);
531  CryptedKeyMap m_map_crypted_keys GUARDED_BY(cs_desc_man);
532 
534  bool m_decryption_thoroughly_checked = false;
535 
536  bool AddDescriptorKeyWithDB(WalletBatch& batch, const CKey& key, const CPubKey &pubkey);
537 
538  KeyMap GetKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
539 
540  // Fetch the SigningProvider for the given script and optionally include private keys
541  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CScript& script, bool include_private = false) const;
542  // Fetch the SigningProvider for the given pubkey and always include private keys. This should only be called by signing code.
543  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CPubKey& pubkey) const;
544  // Fetch the SigningProvider for a given index and optionally include private keys. Called by the above functions.
545  std::unique_ptr<FlatSigningProvider> GetSigningProvider(int32_t index, bool include_private = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
546 
547 public:
549  : ScriptPubKeyMan(storage),
550  m_wallet_descriptor(descriptor)
551  {}
552  DescriptorScriptPubKeyMan(WalletStorage& storage, bool internal)
553  : ScriptPubKeyMan(storage),
554  m_internal(internal)
555  {}
556 
558 
559  bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) override;
560  isminetype IsMine(const CScript& script) const override;
561 
562  bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) override;
563  bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
564 
565  bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) override;
566  void ReturnDestination(int64_t index, bool internal, const CTxDestination& addr) override;
567 
568  // Tops up the descriptor cache and m_map_script_pub_keys. The cache is stored in the wallet file
569  // and is used to expand the descriptor in GetNewDestination. DescriptorScriptPubKeyMan relies
570  // more on ephemeral data than LegacyScriptPubKeyMan. For wallets using unhardened derivation
571  // (with or without private keys), the "keypool" is a single xpub.
572  bool TopUp(unsigned int size = 0) override;
573 
574  void MarkUnusedAddresses(const CScript& script) override;
575 
576  bool IsHDEnabled() const override;
577 
579  bool SetupDescriptorGeneration(const CExtKey& master_key, OutputType addr_type);
580 
581  bool HavePrivateKeys() const override;
582 
583  int64_t GetOldestKeyPoolTime() const override;
584  size_t KeypoolCountExternalKeys() const override;
585  unsigned int GetKeyPoolSize() const override;
586 
587  int64_t GetTimeFirstKey() const override;
588 
589  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
590 
591  bool CanGetAddresses(bool internal = false) const override;
592 
593  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
594 
595  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
596 
597  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
598  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
599  TransactionError FillPSBT(PartiallySignedTransaction& psbt, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
600 
601  uint256 GetID() const override;
602 
603  void SetInternal(bool internal) override;
604 
605  void SetCache(const DescriptorCache& cache);
606 
607  bool AddKey(const CKeyID& key_id, const CKey& key);
608  bool AddCryptedKey(const CKeyID& key_id, const CPubKey& pubkey, const std::vector<unsigned char>& crypted_key);
609 
610  bool HasWalletDescriptor(const WalletDescriptor& desc) const;
611  void AddDescriptorKey(const CKey& key, const CPubKey &pubkey);
612  void WriteDescriptor();
613 
614  const WalletDescriptor GetWalletDescriptor() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
615  const std::vector<CScript> GetScriptPubKeys() const;
616 };
617 
618 #endif // BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
std::unordered_map< CKeyID, CHDChain, KeyIDHasher > m_inactive_hd_chains
virtual bool Upgrade(int prev_version, bilingual_str &error)
Upgrades the wallet to the specified version.
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.
const LegacyScriptPubKeyMan & m_spk_man
size_t operator()(const CKeyID &id) const
virtual const CKeyingMaterial & GetEncryptionKey() const =0
bool GetCScript(const CScriptID &scriptid, CScript &script) const override
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
virtual void UnsetBlankWalletFlag(WalletBatch &)=0
virtual bool GetCScript(const CScriptID &hash, CScript &redeemScriptOut) const override
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
virtual const std::string GetDisplayName() const =0
A UTXO entry.
Definition: coins.h:30
Bilingual messages:
Definition: translation.h:16
virtual ~ScriptPubKeyMan()
SigningResult
Definition: message.h:42
Definition: key.h:144
bool GetPubKey(const CKeyID &address, CPubKey &pubkey) const override
virtual size_t KeypoolCountExternalKeys() const
bool HaveKey(const SigningProvider &wallet, const CKey &key)
Checks if a CKey is in the given CWallet compressed or otherwise.
Definition: rpcwallet.cpp:79
std::set< CScript > WatchOnlySet
DescriptorScriptPubKeyMan(WalletStorage &storage, bool internal)
An instance of this class represents one database.
Definition: bdb.h:99
std::vector< unsigned char, secure_allocator< unsigned char > > CKeyingMaterial
Definition: crypter.h:61
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
Keypool has new keys.
virtual void RewriteDB()
The action to do when the DB needs rewrite.
static void LogPrintf(const char *fmt, const Args &... args)
Definition: logging.h:166
bool GetKey(const CKeyID &address, CKey &key) const override
bool HaveKey(const CKeyID &address) const override
virtual WalletDatabase & GetDatabase()=0
A version of CTransaction with the PSBT format.
Definition: psbt.h:390
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
Watch-only address added.
virtual bool IsWalletFlagSet(uint64_t) const =0
virtual int64_t GetTimeFirstKey() const
OutputType
Definition: outputtype.h:17
void Unserialize(Stream &s)
WalletFeature
(client) version numbers for particular wallet features
Definition: walletutil.h:14
const std::map< CKeyID, int64_t > & GetAllReserveKeys() const
virtual unsigned int GetKeyPoolSize() const
Access to the wallet database.
Definition: walletdb.h:180
void WalletLogPrintf(std::string fmt, Params... parameters) const
Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.
virtual void KeepDestination(int64_t index, const OutputType &type)
virtual bool CanProvide(const CScript &script, SignatureData &sigdata)
Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that...
int64_t nTime
The time at which the key was generated. Set in AddKeypoolPubKeyWithDB.
static void AddKey(CWallet &wallet, const CKey &key)
virtual uint256 GetID() const
ScriptPubKeyMan(WalletStorage &storage)
virtual ~WalletStorage()=default
static const unsigned int DEFAULT_KEYPOOL_SIZE
Default for -keypool.
virtual bool IsHDEnabled() const
An encapsulated public key.
Definition: pubkey.h:30
std::map< CKeyID, CPubKey > WatchKeyMap
Fillable signing provider that keeps keys in an address->secret map.
virtual void MarkUnusedAddresses(const CScript &script)
Mark unused addresses as being used.
Wraps a LegacyScriptPubKeyMan so that it can be returned in a new unique_ptr.
LegacySigningProvider(const LegacyScriptPubKeyMan &spk_man)
std::map< CScript, int32_t > ScriptPubKeyMap
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...
bool m_pre_split
Whether this key was generated for a keypool before the wallet was upgraded to HD-split.
isminetype
IsMine() return codes.
Definition: ismine.h:18
Descriptor with some wallet metadata.
Definition: walletutil.h:91
virtual bool HavePrivateKeys() const
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:18
virtual bool IsLocked() const =0
void Serialize(Stream &s) const
virtual TransactionError FillPSBT(PartiallySignedTransaction &psbt, 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.
virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination &addr)
256-bit opaque blob.
Definition: uint256.h:120
CPubKey vchPubKey
The public key.
virtual bool CanSupportFeature(enum WalletFeature) const =0
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:53
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
virtual std::unique_ptr< CKeyMetadata > GetMetadata(const CTxDestination &dest) const
An interface to be implemented by keystores that support signing.
virtual bool TopUp(unsigned int size=0)
Fills internal address pool.
const CChainParams & Params()
Return the currently selected parameters.
Cache for single descriptor&#39;s derived extended pubkeys.
Definition: descriptor.h:19
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:390
std::map< CPubKey, int32_t > PubKeyMap
static bool GetPubKey(const SigningProvider &provider, const SignatureData &sigdata, const CKeyID &address, CPubKey &pubkey)
Definition: sign.cpp:52
bool HaveCScript(const CScriptID &scriptid) const override
virtual SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const
Sign a message with the given script.
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:20
virtual bool Encrypt(const CKeyingMaterial &master_key, WalletBatch *batch)
virtual void SetInternal(bool internal)
TransactionError
Definition: error.h:22
virtual bool HaveCScript(const CScriptID &hash) const override
virtual isminetype IsMine(const CScript &script) const
#define GUARDED_BY(x)
Definition: threadsafety.h:40
A reference to a CScript: the Hash160 of its serialization (see script.h)
Definition: standard.h:85
virtual bool HasEncryptionKeys() const =0
A mutable version of CTransaction.
Definition: transaction.h:345
virtual int64_t GetOldestKeyPoolTime() const
std::map< CKeyID, CKey > KeyMap
An encapsulated private key.
Definition: key.h:27
virtual bool GetReservedDestination(const OutputType type, bool internal, CTxDestination &address, int64_t &index, CKeyPool &keypool)
WalletStorage & m_storage
boost::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown > CTxDestination
A txout script template with a specific destination.
Definition: standard.h:209
virtual bool GetNewDestination(const OutputType type, CTxDestination &dest, std::string &error)
int64_t GetTime()
Return system time (or mocked time, if set)
Definition: time.cpp:23
virtual bool SetupGeneration(bool force=false)
Sets up the key generation stuff, i.e.
virtual void SetMinVersion(enum WalletFeature, WalletBatch *=nullptr, bool=false)=0
bool GetPubKey(const CKeyID &address, CPubKey &vchPubKeyOut) const override
virtual std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const
bool error(const char *fmt, const Args &... args)
Definition: system.h:49
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.
bool fInternal
Whether this keypool entry is in the internal keypool (for change outputs)
virtual bool CanGetAddresses(bool internal=false) const
std::vector< CKeyID > GetAffectedKeys(const CScript &spk, const SigningProvider &provider)
A key from a CWallet&#39;s keypool.