Line data    Source code

       1             : // Copyright (c) 2017-2019 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 <fs.h>
       9             : #include <script/descriptor.h>
      10             : 
      11             : #include <vector>
      12             : 
      13             : /** (client) version numbers for particular wallet features */
      14             : enum WalletFeature
      15             : {
      16             :     FEATURE_BASE = 10500, // the earliest version new wallets supports (only useful for getwalletinfo's clientversion output)
      17             : 
      18             :     FEATURE_WALLETCRYPT = 40000, // wallet encryption
      19             :     FEATURE_COMPRPUBKEY = 60000, // compressed public keys
      20             : 
      21             :     FEATURE_HD = 130000, // Hierarchical key derivation after BIP32 (HD Wallet)
      22             : 
      23             :     FEATURE_HD_SPLIT = 139900, // Wallet with HD chain split (change outputs will use m/0'/1'/k)
      24             : 
      25             :     FEATURE_NO_DEFAULT_KEY = 159900, // Wallet without a default key written
      26             : 
      27             :     FEATURE_PRE_SPLIT_KEYPOOL = 169900, // Upgraded to HD SPLIT and can have a pre-split keypool
      28             : 
      29             :     FEATURE_LATEST = FEATURE_PRE_SPLIT_KEYPOOL
      30             : };
      31             : 
      32             : 
      33             : 
      34             : enum WalletFlags : uint64_t {
      35             :     // wallet flags in the upper section (> 1 << 31) will lead to not opening the wallet if flag is unknown
      36             :     // unknown wallet flags in the lower section <= (1 << 31) will be tolerated
      37             : 
      38             :     // will categorize coins as clean (not reused) and dirty (reused), and handle
      39             :     // them with privacy considerations in mind
      40             :     WALLET_FLAG_AVOID_REUSE = (1ULL << 0),
      41             : 
      42             :     // Indicates that the metadata has already been upgraded to contain key origins
      43             :     WALLET_FLAG_KEY_ORIGIN_METADATA = (1ULL << 1),
      44             : 
      45             :     // will enforce the rule that the wallet can't contain any private keys (only watch-only/pubkeys)
      46             :     WALLET_FLAG_DISABLE_PRIVATE_KEYS = (1ULL << 32),
      47             : 
      48             :     //! Flag set when a wallet contains no HD seed and no private keys, scripts,
      49             :     //! addresses, and other watch only things, and is therefore "blank."
      50             :     //!
      51             :     //! The only function this flag serves is to distinguish a blank wallet from
      52             :     //! a newly created wallet when the wallet database is loaded, to avoid
      53             :     //! initialization that should only happen on first run.
      54             :     //!
      55             :     //! This flag is also a mandatory flag to prevent previous versions of
      56             :     //! bitcoin from opening the wallet, thinking it was newly created, and
      57             :     //! then improperly reinitializing it.
      58             :     WALLET_FLAG_BLANK_WALLET = (1ULL << 33),
      59             : 
      60             :     //! Indicate that this wallet supports DescriptorScriptPubKeyMan
      61             :     WALLET_FLAG_DESCRIPTORS = (1ULL << 34),
      62             : };
      63             : 
      64             : //! Get the path of the wallet directory.
      65             : fs::path GetWalletDir();
      66             : 
      67             : //! Get wallets in wallet directory.
      68             : std::vector<fs::path> ListWalletDir();
      69             : 
      70             : /** Descriptor with some wallet metadata */
      71        3040 : class WalletDescriptor
      72             : {
      73             : public:
      74             :     std::shared_ptr<Descriptor> descriptor;
      75         432 :     uint64_t creation_time = 0;
      76         432 :     int32_t range_start = 0; // First item in range; start of range, inclusive, i.e. [range_start, range_end). This never changes.
      77         432 :     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()
      78         432 :     int32_t next_index = 0; // Position of the next item to generate
      79             :     DescriptorCache cache;
      80             : 
      81         228 :     void DeserializeDescriptor(const std::string& str)
      82             :     {
      83         228 :         std::string error;
      84         228 :         FlatSigningProvider keys;
      85         228 :         descriptor = Parse(str, keys, error, true);
      86         228 :         if (!descriptor) {
      87           1 :             throw std::ios_base::failure("Invalid descriptor: " + error);
      88             :         }
      89         228 :     }
      90             : 
      91       24573 :     SERIALIZE_METHODS(WalletDescriptor, obj)
      92             :     {
      93        8191 :         std::string descriptor_str;
      94       16154 :         SER_WRITE(obj, descriptor_str = obj.descriptor->ToString());
      95        8191 :         READWRITE(descriptor_str, obj.creation_time, obj.next_index, obj.range_start, obj.range_end);
      96        8419 :         SER_READ(obj, obj.DeserializeDescriptor(descriptor_str));
      97        8191 :     }
      98             : 
      99         864 :     WalletDescriptor() {}
     100         592 :     WalletDescriptor(std::shared_ptr<Descriptor> descriptor, uint64_t creation_time, int32_t range_start, int32_t range_end, int32_t next_index) : descriptor(descriptor), creation_time(creation_time), range_start(range_start), range_end(range_end), next_index(next_index) {}
     101             : };
     102             : 
     103             : #endif // BITCOIN_WALLET_WALLETUTIL_H