Bitcoin Core  22.99.0
P2P Digital Currency
walletutil.h
Go to the documentation of this file.
1 // Copyright (c) 2017-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_WALLETUTIL_H
6 #define BITCOIN_WALLET_WALLETUTIL_H
7 
8 #include <fs.h>
9 #include <script/descriptor.h>
10 
11 #include <vector>
12 
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 
30 };
31 
32 bool IsFeatureSupported(int wallet_version, int feature_version);
34 
35 enum WalletFlags : uint64_t {
36  // wallet flags in the upper section (> 1 << 31) will lead to not opening the wallet if flag is unknown
37  // unknown wallet flags in the lower section <= (1 << 31) will be tolerated
38 
39  // will categorize coins as clean (not reused) and dirty (reused), and handle
40  // them with privacy considerations in mind
41  WALLET_FLAG_AVOID_REUSE = (1ULL << 0),
42 
43  // Indicates that the metadata has already been upgraded to contain key origins
45 
46  // Indicates that the descriptor cache has been upgraded to cache last hardened xpubs
48 
49  // will enforce the rule that the wallet can't contain any private keys (only watch-only/pubkeys)
51 
62  WALLET_FLAG_BLANK_WALLET = (1ULL << 33),
63 
65  WALLET_FLAG_DESCRIPTORS = (1ULL << 34),
66 
69 };
70 
72 fs::path GetWalletDir();
73 
76 {
77 public:
78  std::shared_ptr<Descriptor> descriptor;
79  uint64_t creation_time = 0;
80  int32_t range_start = 0; // First item in range; start of range, inclusive, i.e. [range_start, range_end). This never changes.
81  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()
82  int32_t next_index = 0; // Position of the next item to generate
84 
85  void DeserializeDescriptor(const std::string& str)
86  {
87  std::string error;
89  descriptor = Parse(str, keys, error, true);
90  if (!descriptor) {
91  throw std::ios_base::failure("Invalid descriptor: " + error);
92  }
93  }
94 
96  {
97  std::string descriptor_str;
98  SER_WRITE(obj, descriptor_str = obj.descriptor->ToString());
99  READWRITE(descriptor_str, obj.creation_time, obj.next_index, obj.range_start, obj.range_end);
100  SER_READ(obj, obj.DeserializeDescriptor(descriptor_str));
101  }
102 
105 };
106 
107 #endif // BITCOIN_WALLET_WALLETUTIL_H
Parse
std::unique_ptr< Descriptor > Parse(const std::string &descriptor, FlatSigningProvider &out, std::string &error, bool require_checksum)
Parse a descriptor string.
Definition: descriptor.cpp:1399
FEATURE_HD_SPLIT
@ FEATURE_HD_SPLIT
Definition: walletutil.h:23
FEATURE_NO_DEFAULT_KEY
@ FEATURE_NO_DEFAULT_KEY
Definition: walletutil.h:25
fs.h
WalletFlags
WalletFlags
Definition: walletutil.h:35
WalletDescriptor::WalletDescriptor
WalletDescriptor(std::shared_ptr< Descriptor > descriptor, uint64_t creation_time, int32_t range_start, int32_t range_end, int32_t next_index)
Definition: walletutil.h:104
FEATURE_HD
@ FEATURE_HD
Definition: walletutil.h:21
FEATURE_BASE
@ FEATURE_BASE
Definition: walletutil.h:16
IsFeatureSupported
bool IsFeatureSupported(int wallet_version, int feature_version)
Definition: walletutil.cpp:32
WALLET_FLAG_EXTERNAL_SIGNER
@ WALLET_FLAG_EXTERNAL_SIGNER
Indicates that the wallet needs an external signer.
Definition: walletutil.h:68
WalletDescriptor::next_index
int32_t next_index
Definition: walletutil.h:82
WalletDescriptor::WalletDescriptor
WalletDescriptor()
Definition: walletutil.h:103
FEATURE_WALLETCRYPT
@ FEATURE_WALLETCRYPT
Definition: walletutil.h:18
GetClosestWalletFeature
WalletFeature GetClosestWalletFeature(int version)
Definition: walletutil.cpp:37
FEATURE_PRE_SPLIT_KEYPOOL
@ FEATURE_PRE_SPLIT_KEYPOOL
Definition: walletutil.h:27
WalletDescriptor::DeserializeDescriptor
void DeserializeDescriptor(const std::string &str)
Definition: walletutil.h:85
WALLET_FLAG_AVOID_REUSE
@ WALLET_FLAG_AVOID_REUSE
Definition: walletutil.h:41
FEATURE_COMPRPUBKEY
@ FEATURE_COMPRPUBKEY
Definition: walletutil.h:19
GetWalletDir
fs::path GetWalletDir()
Get the path of the wallet directory.
Definition: walletutil.cpp:10
READWRITE
#define READWRITE(...)
Definition: serialize.h:147
WALLET_FLAG_BLANK_WALLET
@ WALLET_FLAG_BLANK_WALLET
Flag set when a wallet contains no HD seed and no private keys, scripts, addresses,...
Definition: walletutil.h:62
DescriptorCache
Cache for single descriptor's derived extended pubkeys.
Definition: descriptor.h:19
WALLET_FLAG_DISABLE_PRIVATE_KEYS
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
Definition: walletutil.h:50
WalletDescriptor::cache
DescriptorCache cache
Definition: walletutil.h:83
WalletDescriptor::creation_time
uint64_t creation_time
Definition: walletutil.h:79
FEATURE_LATEST
@ FEATURE_LATEST
Definition: walletutil.h:29
WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
@ WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
Definition: walletutil.h:47
WalletDescriptor::range_end
int32_t range_end
Definition: walletutil.h:81
WalletDescriptor::range_start
int32_t range_start
Definition: walletutil.h:80
SER_WRITE
#define SER_WRITE(obj, code)
Definition: serialize.h:150
WalletDescriptor
Descriptor with some wallet metadata.
Definition: walletutil.h:75
WalletFeature
WalletFeature
(client) version numbers for particular wallet features
Definition: walletutil.h:14
error
bool error(const char *fmt, const Args &... args)
Definition: system.h:49
SER_READ
#define SER_READ(obj, code)
Definition: serialize.h:149
WalletDescriptor::descriptor
std::shared_ptr< Descriptor > descriptor
Definition: walletutil.h:78
WALLET_FLAG_KEY_ORIGIN_METADATA
@ WALLET_FLAG_KEY_ORIGIN_METADATA
Definition: walletutil.h:44
WalletDescriptor::SERIALIZE_METHODS
SERIALIZE_METHODS(WalletDescriptor, obj)
Definition: walletutil.h:95
WALLET_FLAG_DESCRIPTORS
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:65
FlatSigningProvider
Definition: signingprovider.h:49
descriptor.h