Bitcoin Core  21.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) { 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 false; }
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 size_t KeypoolCountExternalKeys() const { return 0; }
220  virtual unsigned int GetKeyPoolSize() const { return 0; }
221 
222  virtual int64_t GetTimeFirstKey() const { return 0; }
223 
224  virtual std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const { return nullptr; }
225 
226  virtual std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const { return nullptr; }
227 
231  virtual bool CanProvide(const CScript& script, SignatureData& sigdata) { return false; }
232 
234  virtual bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const { return false; }
236  virtual SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const { return SigningResult::SIGNING_FAILED; };
238  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; }
239 
240  virtual uint256 GetID() const { return uint256(); }
241 
242  virtual void SetInternal(bool internal) {}
243 
245  template<typename... Params>
246  void WalletLogPrintf(std::string fmt, Params... parameters) const {
247  LogPrintf(("%s " + fmt).c_str(), m_storage.GetDisplayName(), parameters...);
248  };
249 
251  boost::signals2::signal<void (bool fHaveWatchOnly)> NotifyWatchonlyChanged;
252 
254  boost::signals2::signal<void ()> NotifyCanGetAddressesChanged;
255 };
256 
258 {
259 private:
261  bool fDecryptionThoroughlyChecked = true;
262 
263  using WatchOnlySet = std::set<CScript>;
264  using WatchKeyMap = std::map<CKeyID, CPubKey>;
265 
266  WalletBatch *encrypted_batch GUARDED_BY(cs_KeyStore) = nullptr;
267 
268  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
269 
270  CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
271  WatchOnlySet setWatchOnly GUARDED_BY(cs_KeyStore);
272  WatchKeyMap mapWatchKeys GUARDED_BY(cs_KeyStore);
273 
274  int64_t nTimeFirstKey GUARDED_BY(cs_KeyStore) = 0;
275 
276  bool AddKeyPubKeyInner(const CKey& key, const CPubKey &pubkey);
277  bool AddCryptedKeyInner(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
278 
288  bool AddWatchOnly(const CScript& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
289  bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
290  bool AddWatchOnlyInMem(const CScript &dest);
292  bool AddWatchOnlyWithDB(WalletBatch &batch, const CScript& dest, int64_t create_time) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
293 
295  bool AddKeyPubKeyWithDB(WalletBatch &batch,const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
296 
297  void AddKeypoolPubkeyWithDB(const CPubKey& pubkey, const bool internal, WalletBatch& batch);
298 
300  bool AddCScriptWithDB(WalletBatch& batch, const CScript& script);
301 
303  bool AddKeyOriginWithDB(WalletBatch& batch, const CPubKey& pubkey, const KeyOriginInfo& info);
304 
305  /* the HD chain data model (external chain counters) */
307  std::unordered_map<CKeyID, CHDChain, SaltedSipHasher> m_inactive_hd_chains;
308 
309  /* HD derive new child key (on internal or external chain) */
310  void DeriveNewChildKey(WalletBatch& batch, CKeyMetadata& metadata, CKey& secret, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
311 
312  std::set<int64_t> setInternalKeyPool GUARDED_BY(cs_KeyStore);
313  std::set<int64_t> setExternalKeyPool GUARDED_BY(cs_KeyStore);
314  std::set<int64_t> set_pre_split_keypool GUARDED_BY(cs_KeyStore);
315  int64_t m_max_keypool_index GUARDED_BY(cs_KeyStore) = 0;
316  std::map<CKeyID, int64_t> m_pool_key_to_index;
317  // Tracks keypool indexes to CKeyIDs of keys that have been taken out of the keypool but may be returned to it
318  std::map<int64_t, CKeyID> m_index_to_reserved_key;
319 
321  bool GetKeyFromPool(CPubKey &key, const OutputType type, bool internal = false);
322 
337  bool ReserveKeyFromKeyPool(int64_t& nIndex, CKeyPool& keypool, bool fRequestedInternal);
338 
349  bool TopUpInactiveHDChain(const CKeyID seed_id, int64_t index, bool internal);
350 
351 public:
353 
354  bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) override;
355  isminetype IsMine(const CScript& script) const override;
356 
357  bool CheckDecryptionKey(const CKeyingMaterial& master_key, bool accept_no_keys = false) override;
358  bool Encrypt(const CKeyingMaterial& master_key, WalletBatch* batch) override;
359 
360  bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) override;
361  void KeepDestination(int64_t index, const OutputType& type) override;
362  void ReturnDestination(int64_t index, bool internal, const CTxDestination&) override;
363 
364  bool TopUp(unsigned int size = 0) override;
365 
366  void MarkUnusedAddresses(const CScript& script) override;
367 
369  void UpgradeKeyMetadata();
370 
371  bool IsHDEnabled() const override;
372 
373  bool SetupGeneration(bool force = false) override;
374 
375  bool Upgrade(int prev_version, int new_version, bilingual_str& error) override;
376 
377  bool HavePrivateKeys() const override;
378 
379  void RewriteDB() override;
380 
381  int64_t GetOldestKeyPoolTime() const override;
382  size_t KeypoolCountExternalKeys() const override;
383  unsigned int GetKeyPoolSize() const override;
384 
385  int64_t GetTimeFirstKey() const override;
386 
387  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
388 
389  bool CanGetAddresses(bool internal = false) const override;
390 
391  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
392 
393  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
394 
395  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
396  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
397  TransactionError FillPSBT(PartiallySignedTransaction& psbt, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
398 
399  uint256 GetID() const override;
400 
401  void SetInternal(bool internal) override;
402 
403  // Map from Key ID to key metadata.
404  std::map<CKeyID, CKeyMetadata> mapKeyMetadata GUARDED_BY(cs_KeyStore);
405 
406  // Map from Script ID to key metadata (for watch-only keys).
407  std::map<CScriptID, CKeyMetadata> m_script_metadata GUARDED_BY(cs_KeyStore);
408 
410  bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
412  bool LoadKey(const CKey& key, const CPubKey &pubkey);
414  bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
416  bool LoadCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret, bool checksum_valid);
417  void UpdateTimeFirstKey(int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
419  bool LoadCScript(const CScript& redeemScript);
421  void LoadKeyMetadata(const CKeyID& keyID, const CKeyMetadata &metadata);
422  void LoadScriptMetadata(const CScriptID& script_id, const CKeyMetadata &metadata);
424  CPubKey GenerateNewKey(WalletBatch& batch, CHDChain& hd_chain, bool internal = false) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
425 
426  /* Set the HD chain model (chain child index counters) and writes it to the database */
427  void AddHDChain(const CHDChain& chain);
429  void LoadHDChain(const CHDChain& chain);
430  const CHDChain& GetHDChain() const { return m_hd_chain; }
431  void AddInactiveHDChain(const CHDChain& chain);
432 
434  bool LoadWatchOnly(const CScript &dest);
436  bool HaveWatchOnly(const CScript &dest) const;
438  bool HaveWatchOnly() const;
440  bool RemoveWatchOnly(const CScript &dest);
441  bool AddWatchOnly(const CScript& dest, int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
442 
444  bool GetWatchPubKey(const CKeyID &address, CPubKey &pubkey_out) const;
445 
446  /* SigningProvider overrides */
447  bool HaveKey(const CKeyID &address) const override;
448  bool GetKey(const CKeyID &address, CKey& keyOut) const override;
449  bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
450  bool AddCScript(const CScript& redeemScript) override;
451  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
452 
454  void LoadKeyPool(int64_t nIndex, const CKeyPool &keypool);
455  bool NewKeyPool();
456  void MarkPreSplitKeys() EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
457 
458  bool ImportScripts(const std::set<CScript> scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
459  bool ImportPrivKeys(const std::map<CKeyID, CKey>& privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
460  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);
461  bool ImportScriptPubKeys(const std::set<CScript>& script_pub_keys, const bool have_solving_data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
462 
463  /* Returns true if the wallet can generate new keys */
464  bool CanGenerateKeys() const;
465 
466  /* Generates a new HD seed (will not be activated) */
467  CPubKey GenerateNewSeed();
468 
469  /* Derives a new HD seed (will not be activated) */
470  CPubKey DeriveNewSeed(const CKey& key);
471 
472  /* Set the current HD seed (will reset the chain child index counters)
473  Sets the seed's version based on the current wallet version (so the
474  caller must ensure the current wallet version is correct before calling
475  this function). */
476  void SetHDSeed(const CPubKey& key);
477 
484  void LearnRelatedScripts(const CPubKey& key, OutputType);
485 
490  void LearnAllRelatedScripts(const CPubKey& key);
491 
495  void MarkReserveKeysAsUsed(int64_t keypool_id) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore);
496  const std::map<CKeyID, int64_t>& GetAllReserveKeys() const { return m_pool_key_to_index; }
497 
498  std::set<CKeyID> GetKeys() const override;
499 };
500 
503 {
504 private:
506 public:
507  explicit LegacySigningProvider(const LegacyScriptPubKeyMan& spk_man) : m_spk_man(spk_man) {}
508 
509  bool GetCScript(const CScriptID &scriptid, CScript& script) const override { return m_spk_man.GetCScript(scriptid, script); }
510  bool HaveCScript(const CScriptID &scriptid) const override { return m_spk_man.HaveCScript(scriptid); }
511  bool GetPubKey(const CKeyID &address, CPubKey& pubkey) const override { return m_spk_man.GetPubKey(address, pubkey); }
512  bool GetKey(const CKeyID &address, CKey& key) const override { return false; }
513  bool HaveKey(const CKeyID &address) const override { return false; }
514  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override { return m_spk_man.GetKeyOrigin(keyid, info); }
515 };
516 
518 {
519 private:
520  WalletDescriptor m_wallet_descriptor GUARDED_BY(cs_desc_man);
521 
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  bool m_internal = false;
532 
533  KeyMap m_map_keys GUARDED_BY(cs_desc_man);
534  CryptedKeyMap m_map_crypted_keys GUARDED_BY(cs_desc_man);
535 
537  bool m_decryption_thoroughly_checked = false;
538 
539  bool AddDescriptorKeyWithDB(WalletBatch& batch, const CKey& key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
540 
541  KeyMap GetKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
542 
543  // Fetch the SigningProvider for the given script and optionally include private keys
544  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CScript& script, bool include_private = false) const;
545  // Fetch the SigningProvider for the given pubkey and always include private keys. This should only be called by signing code.
546  std::unique_ptr<FlatSigningProvider> GetSigningProvider(const CPubKey& pubkey) const;
547  // Fetch the SigningProvider for a given index and optionally include private keys. Called by the above functions.
548  std::unique_ptr<FlatSigningProvider> GetSigningProvider(int32_t index, bool include_private = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
549 
550 public:
552  : ScriptPubKeyMan(storage),
553  m_wallet_descriptor(descriptor)
554  {}
555  DescriptorScriptPubKeyMan(WalletStorage& storage, bool internal)
556  : ScriptPubKeyMan(storage),
557  m_internal(internal)
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) 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);
583 
584  bool HavePrivateKeys() const override;
585 
586  int64_t GetOldestKeyPoolTime() const override;
587  size_t KeypoolCountExternalKeys() const override;
588  unsigned int GetKeyPoolSize() const override;
589 
590  int64_t GetTimeFirstKey() const override;
591 
592  std::unique_ptr<CKeyMetadata> GetMetadata(const CTxDestination& dest) const override;
593 
594  bool CanGetAddresses(bool internal = false) const override;
595 
596  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const override;
597 
598  bool CanProvide(const CScript& script, SignatureData& sigdata) override;
599 
600  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, std::string>& input_errors) const override;
601  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const override;
602  TransactionError FillPSBT(PartiallySignedTransaction& psbt, int sighash_type = 1 /* SIGHASH_ALL */, bool sign = true, bool bip32derivs = false, int* n_signed = nullptr) const override;
603 
604  uint256 GetID() const override;
605 
606  void SetInternal(bool internal) override;
607 
608  void SetCache(const DescriptorCache& cache);
609 
610  bool AddKey(const CKeyID& key_id, const CKey& key);
611  bool AddCryptedKey(const CKeyID& key_id, const CPubKey& pubkey, const std::vector<unsigned char>& crypted_key);
612 
613  bool HasWalletDescriptor(const WalletDescriptor& desc) const;
614  void AddDescriptorKey(const CKey& key, const CPubKey &pubkey);
615  void WriteDescriptor();
616 
617  const WalletDescriptor GetWalletDescriptor() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man);
618  const std::vector<CScript> GetScriptPubKeys() const;
619 };
620 
621 #endif // BITCOIN_WALLET_SCRIPTPUBKEYMAN_H
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
std::unordered_map< CKeyID, CHDChain, SaltedSipHasher > m_inactive_hd_chains
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
virtual void SetMinVersion(enum WalletFeature, WalletBatch *=nullptr)=0
bool HaveKey(const SigningProvider &wallet, const CKey &key)
Checks if a CKey is in the given CWallet compressed or otherwise.
Definition: rpcwallet.cpp:80
std::set< CScript > WatchOnlySet
DescriptorScriptPubKeyMan(WalletStorage &storage, bool internal)
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
A version of CTransaction with the PSBT format.
Definition: psbt.h:390
std::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown > CTxDestination
A txout script template with a specific destination.
Definition: standard.h:212
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
Watch-only address added.
virtual WalletDatabase & GetDatabase() const =0
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:176
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 bool Upgrade(int prev_version, int new_version, bilingual_str &error)
Upgrades the wallet to the specified version.
virtual ~WalletStorage()=default
static const unsigned int DEFAULT_KEYPOOL_SIZE
Default for -keypool.
virtual bool IsHDEnabled() const
An encapsulated public key.
Definition: pubkey.h:31
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:69
virtual bool HavePrivateKeys() const
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:26
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:124
CPubKey vchPubKey
The public key.
virtual bool CanSupportFeature(enum WalletFeature) const =0
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
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:404
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:21
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:38
A reference to a CScript: the Hash160 of its serialization (see script.h)
Definition: standard.h:86
virtual bool HasEncryptionKeys() const =0
A mutable version of CTransaction.
Definition: transaction.h:344
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
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.
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:52
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.
An instance of this class represents one database.
Definition: db.h:104