1  // Copyright (c) 2017-present The Bitcoin Core developers
  2  // Distributed under the MIT software license, see the accompanying
  3  // file COPYING or http://www.opensource.org/licenses/mit-license.php.
  4  
  5  #ifndef BITCOIN_WALLET_WALLETUTIL_H
  6  #define BITCOIN_WALLET_WALLETUTIL_H
  7  
  8  #include <script/descriptor.h>
  9  #include <util/fs.h>
 10  
 11  #include <vector>
 12  
 13  namespace wallet {
 14  
 15  enum WalletFlags : uint64_t {
 16      // wallet flags in the upper section (> 1 << 31) will lead to not opening the wallet if flag is unknown
 17      // unknown wallet flags in the lower section <= (1 << 31) will be tolerated
 18  
 19      // will categorize coins as clean (not reused) and dirty (reused), and handle
 20      // them with privacy considerations in mind
 21      WALLET_FLAG_AVOID_REUSE = (1ULL << 0),
 22  
 23      // Indicates that the metadata has already been upgraded to contain key origins
 24      WALLET_FLAG_KEY_ORIGIN_METADATA = (1ULL << 1),
 25  
 26      // Indicates that the descriptor cache has been upgraded to cache last hardened xpubs
 27      WALLET_FLAG_LAST_HARDENED_XPUB_CACHED = (1ULL << 2),
 28  
 29      // will enforce the rule that the wallet can't contain any private keys (only watch-only/pubkeys)
 30      WALLET_FLAG_DISABLE_PRIVATE_KEYS = (1ULL << 32),
 31  
 32      //! Flag set when a wallet contains no HD seed and no private keys, scripts,
 33      //! addresses, and other watch only things, and is therefore "blank."
 34      //!
 35      //! The main function this flag serves is to distinguish a blank wallet from
 36      //! a newly created wallet when the wallet database is loaded, to avoid
 37      //! initialization that should only happen on first run.
 38      //!
 39      //! A secondary function of this flag, which applies to descriptor wallets
 40      //! only, is to serve as an ongoing indication that descriptors in the
 41      //! wallet should be created manually, and that the wallet should not
 42      //! generate automatically generate new descriptors if it is later
 43      //! encrypted. To support this behavior, descriptor wallets unlike legacy
 44      //! wallets do not automatically unset the BLANK flag when things are
 45      //! imported.
 46      //!
 47      //! This flag is also a mandatory flag to prevent previous versions of
 48      //! bitcoin from opening the wallet, thinking it was newly created, and
 49      //! then improperly reinitializing it.
 50      WALLET_FLAG_BLANK_WALLET = (1ULL << 33),
 51  
 52      //! Indicate that this wallet supports DescriptorScriptPubKeyMan
 53      WALLET_FLAG_DESCRIPTORS = (1ULL << 34),
 54  
 55      //! Indicates that the wallet needs an external signer
 56      WALLET_FLAG_EXTERNAL_SIGNER = (1ULL << 35),
 57  };
 58  
 59  //! Get the path of the wallet directory.
 60  fs::path GetWalletDir();
 61  
 62  /** Descriptor with some wallet metadata */
 63  class WalletDescriptor
 64  {
 65  public:
 66      std::shared_ptr<Descriptor> descriptor;
 67      uint256 id; // Descriptor ID (calculated once at descriptor initialization/deserialization)
 68      uint64_t creation_time = 0;
 69      int32_t range_start = 0; // First item in range; start of range, inclusive, i.e. [range_start, range_end). This never changes.
 70      int32_t range_end = 0; // Item after the last; end of range, exclusive, i.e. [range_start, range_end). This will increment with each TopUp()
 71      int32_t next_index = 0; // Position of the next item to generate
 72      DescriptorCache cache;
 73  
 74      void DeserializeDescriptor(const std::string& str)
 75      {
 76          std::string error;
 77          FlatSigningProvider keys;
 78          auto descs = Parse(str, keys, error, true);
 79          if (descs.empty()) {
 80              throw std::ios_base::failure("Invalid descriptor: " + error);
 81          }
 82          if (descs.size() > 1) {
 83              throw std::ios_base::failure("Can't load a multipath descriptor from databases");
 84          }
 85          descriptor = std::move(descs.at(0));
 86          id = DescriptorID(*descriptor);
 87      }
 88  
 89      SERIALIZE_METHODS(WalletDescriptor, obj)
 90      {
 91          std::string descriptor_str;
 92          SER_WRITE(obj, descriptor_str = obj.descriptor->ToString());
 93          READWRITE(descriptor_str, obj.creation_time, obj.next_index, obj.range_start, obj.range_end);
 94          SER_READ(obj, obj.DeserializeDescriptor(descriptor_str));
 95      }
 96  
 97      WalletDescriptor() = default;
 98      WalletDescriptor(std::shared_ptr<Descriptor> descriptor, uint64_t creation_time, int32_t range_start, int32_t range_end, int32_t next_index) : descriptor(descriptor), id(DescriptorID(*descriptor)), creation_time(creation_time), range_start(range_start), range_end(range_end), next_index(next_index) { }
 99  };
100  
101  WalletDescriptor GenerateWalletDescriptor(const CExtPubKey& master_key, const OutputType& output_type, bool internal);
102  } // namespace wallet
103  
104  #endif // BITCOIN_WALLET_WALLETUTIL_H