mirror of https://github.com/bitcoin/bitcoin
124 lines
4.9 KiB
C++
124 lines
4.9 KiB
C++
// Copyright (c) 2017-2021 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_WALLET_WALLETUTIL_H
|
|
#define BITCOIN_WALLET_WALLETUTIL_H
|
|
|
|
#include <script/descriptor.h>
|
|
#include <util/fs.h>
|
|
|
|
#include <vector>
|
|
|
|
namespace wallet {
|
|
/** (client) version numbers for particular wallet features */
|
|
enum WalletFeature
|
|
{
|
|
FEATURE_BASE = 10500, // the earliest version new wallets supports (only useful for getwalletinfo's clientversion output)
|
|
|
|
FEATURE_WALLETCRYPT = 40000, // wallet encryption
|
|
FEATURE_COMPRPUBKEY = 60000, // compressed public keys
|
|
|
|
FEATURE_HD = 130000, // Hierarchical key derivation after BIP32 (HD Wallet)
|
|
|
|
FEATURE_HD_SPLIT = 139900, // Wallet with HD chain split (change outputs will use m/0'/1'/k)
|
|
|
|
FEATURE_NO_DEFAULT_KEY = 159900, // Wallet without a default key written
|
|
|
|
FEATURE_PRE_SPLIT_KEYPOOL = 169900, // Upgraded to HD SPLIT and can have a pre-split keypool
|
|
|
|
FEATURE_LATEST = FEATURE_PRE_SPLIT_KEYPOOL
|
|
};
|
|
|
|
bool IsFeatureSupported(int wallet_version, int feature_version);
|
|
WalletFeature GetClosestWalletFeature(int version);
|
|
|
|
enum WalletFlags : uint64_t {
|
|
// wallet flags in the upper section (> 1 << 31) will lead to not opening the wallet if flag is unknown
|
|
// unknown wallet flags in the lower section <= (1 << 31) will be tolerated
|
|
|
|
// will categorize coins as clean (not reused) and dirty (reused), and handle
|
|
// them with privacy considerations in mind
|
|
WALLET_FLAG_AVOID_REUSE = (1ULL << 0),
|
|
|
|
// Indicates that the metadata has already been upgraded to contain key origins
|
|
WALLET_FLAG_KEY_ORIGIN_METADATA = (1ULL << 1),
|
|
|
|
// Indicates that the descriptor cache has been upgraded to cache last hardened xpubs
|
|
WALLET_FLAG_LAST_HARDENED_XPUB_CACHED = (1ULL << 2),
|
|
|
|
// will enforce the rule that the wallet can't contain any private keys (only watch-only/pubkeys)
|
|
WALLET_FLAG_DISABLE_PRIVATE_KEYS = (1ULL << 32),
|
|
|
|
//! Flag set when a wallet contains no HD seed and no private keys, scripts,
|
|
//! addresses, and other watch only things, and is therefore "blank."
|
|
//!
|
|
//! The only function this flag serves is to distinguish a blank wallet from
|
|
//! a newly created wallet when the wallet database is loaded, to avoid
|
|
//! initialization that should only happen on first run.
|
|
//!
|
|
//! This flag is also a mandatory flag to prevent previous versions of
|
|
//! bitcoin from opening the wallet, thinking it was newly created, and
|
|
//! then improperly reinitializing it.
|
|
WALLET_FLAG_BLANK_WALLET = (1ULL << 33),
|
|
|
|
//! Indicate that this wallet supports DescriptorScriptPubKeyMan
|
|
WALLET_FLAG_DESCRIPTORS = (1ULL << 34),
|
|
|
|
//! Indicates that the wallet needs an external signer
|
|
WALLET_FLAG_EXTERNAL_SIGNER = (1ULL << 35),
|
|
};
|
|
|
|
//! Get the path of the wallet directory.
|
|
fs::path GetWalletDir();
|
|
|
|
/** Descriptor with some wallet metadata */
|
|
class WalletDescriptor
|
|
{
|
|
public:
|
|
std::shared_ptr<Descriptor> descriptor;
|
|
uint64_t creation_time = 0;
|
|
int32_t range_start = 0; // First item in range; start of range, inclusive, i.e. [range_start, range_end). This never changes.
|
|
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()
|
|
int32_t next_index = 0; // Position of the next item to generate
|
|
DescriptorCache cache;
|
|
|
|
void DeserializeDescriptor(const std::string& str)
|
|
{
|
|
std::string error;
|
|
FlatSigningProvider keys;
|
|
descriptor = Parse(str, keys, error, true);
|
|
if (!descriptor) {
|
|
throw std::ios_base::failure("Invalid descriptor: " + error);
|
|
}
|
|
}
|
|
|
|
SERIALIZE_METHODS(WalletDescriptor, obj)
|
|
{
|
|
std::string descriptor_str;
|
|
SER_WRITE(obj, descriptor_str = obj.descriptor->ToString());
|
|
READWRITE(descriptor_str, obj.creation_time, obj.next_index, obj.range_start, obj.range_end);
|
|
SER_READ(obj, obj.DeserializeDescriptor(descriptor_str));
|
|
}
|
|
|
|
WalletDescriptor() {}
|
|
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) {}
|
|
};
|
|
|
|
class CWallet;
|
|
class DescriptorScriptPubKeyMan;
|
|
|
|
/** struct containing information needed for migrating legacy wallets to descriptor wallets */
|
|
struct MigrationData
|
|
{
|
|
CExtKey master_key;
|
|
std::vector<std::pair<std::string, int64_t>> watch_descs;
|
|
std::vector<std::pair<std::string, int64_t>> solvable_descs;
|
|
std::vector<std::unique_ptr<DescriptorScriptPubKeyMan>> desc_spkms;
|
|
std::shared_ptr<CWallet> watchonly_wallet{nullptr};
|
|
std::shared_ptr<CWallet> solvable_wallet{nullptr};
|
|
};
|
|
} // namespace wallet
|
|
|
|
#endif // BITCOIN_WALLET_WALLETUTIL_H
|