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