Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_WALLET_WALLETDB_H
7 : : #define BITCOIN_WALLET_WALLETDB_H
8 : :
9 : : #include <key.h>
10 : : #include <primitives/transaction.h>
11 : : #include <primitives/transaction_identifier.h>
12 : : #include <script/sign.h>
13 : : #include <wallet/db.h>
14 : : #include <wallet/walletutil.h>
15 : :
16 : : #include <cstdint>
17 : : #include <string>
18 : : #include <unordered_set>
19 : : #include <vector>
20 : :
21 : : class CScript;
22 : : class uint160;
23 : : class uint256;
24 : : struct CBlockLocator;
25 : :
26 : : namespace wallet {
27 : : class CMasterKey;
28 : : class CWallet;
29 : : class CWalletTx;
30 : : struct WalletContext;
31 : :
32 : : // Logs information about the database, including available engines, features, and other capabilities
33 : : void LogDBInfo();
34 : :
35 : : /**
36 : : * Overview of wallet database classes:
37 : : *
38 : : * - WalletBatch is an abstract modifier object for the wallet database, and encapsulates a database
39 : : * batch update as well as methods to act on the database. It should be agnostic to the database implementation.
40 : : */
41 : :
42 : : /** Error statuses for the wallet database.
43 : : * Values are in order of severity. When multiple errors occur, the most severe (highest value) will be returned.
44 : : */
45 : : enum class DBErrors : int
46 : : {
47 : : LOAD_OK = 0,
48 : : NEED_RESCAN = 1,
49 : : EXTERNAL_SIGNER_SUPPORT_REQUIRED = 3,
50 : : NONCRITICAL_ERROR = 4,
51 : : TOO_NEW = 5,
52 : : UNKNOWN_DESCRIPTOR = 6,
53 : : LOAD_FAIL = 7,
54 : : UNEXPECTED_LEGACY_ENTRY = 8,
55 : : LEGACY_WALLET = 9,
56 : : CORRUPT = 10,
57 : : };
58 : :
59 : : namespace DBKeys {
60 : : extern const std::string ACENTRY;
61 : : extern const std::string ACTIVEEXTERNALSPK;
62 : : extern const std::string ACTIVEINTERNALSPK;
63 : : extern const std::string BESTBLOCK;
64 : : extern const std::string BESTBLOCK_NOMERKLE;
65 : : extern const std::string CRYPTED_KEY;
66 : : extern const std::string CSCRIPT;
67 : : extern const std::string DEFAULTKEY;
68 : : extern const std::string DESTDATA;
69 : : extern const std::string FLAGS;
70 : : extern const std::string HDCHAIN;
71 : : extern const std::string KEY;
72 : : extern const std::string KEYMETA;
73 : : extern const std::string LOCKED_UTXO;
74 : : extern const std::string MASTER_KEY;
75 : : extern const std::string MINVERSION;
76 : : extern const std::string NAME;
77 : : extern const std::string OLD_KEY;
78 : : extern const std::string ORDERPOSNEXT;
79 : : extern const std::string POOL;
80 : : extern const std::string PURPOSE;
81 : : extern const std::string SETTINGS;
82 : : extern const std::string TX;
83 : : extern const std::string WTX_VARIANT;
84 : : extern const std::string VERSION;
85 : : extern const std::string WALLETDESCRIPTOR;
86 : : extern const std::string WALLETDESCRIPTORCKEY;
87 : : extern const std::string WALLETDESCRIPTORKEY;
88 : : extern const std::string WATCHMETA;
89 : : extern const std::string WATCHS;
90 : :
91 : : // Keys in this set pertain only to legacy wallets and are removed during migration to descriptors.
92 : : extern const std::unordered_set<std::string> LEGACY_TYPES;
93 : : } // namespace DBKeys
94 : :
95 : : /* simple HD chain data model */
96 : : class CHDChain
97 : : {
98 : : public:
99 : : uint32_t nExternalChainCounter;
100 : : uint32_t nInternalChainCounter;
101 : : CKeyID seed_id; //!< seed hash160
102 : : int64_t m_next_external_index{0}; // Next index in the keypool to be used. Memory only.
103 : : int64_t m_next_internal_index{0}; // Next index in the keypool to be used. Memory only.
104 : :
105 : : static constexpr int VERSION_HD_BASE{1};
106 : : static constexpr int VERSION_HD_CHAIN_SPLIT{2};
107 : : static constexpr int CURRENT_VERSION{VERSION_HD_CHAIN_SPLIT};
108 : : int nVersion;
109 : :
110 : 3525 : CHDChain() { SetNull(); }
111 : :
112 : 0 : SERIALIZE_METHODS(CHDChain, obj)
113 : : {
114 : 0 : READWRITE(obj.nVersion, obj.nExternalChainCounter, obj.seed_id);
115 [ # # ]: 0 : if (obj.nVersion >= VERSION_HD_CHAIN_SPLIT) {
116 : 0 : READWRITE(obj.nInternalChainCounter);
117 : : }
118 : 0 : }
119 : :
120 : 3525 : void SetNull()
121 : : {
122 : 3525 : nVersion = CHDChain::CURRENT_VERSION;
123 : 3525 : nExternalChainCounter = 0;
124 : 3525 : nInternalChainCounter = 0;
125 : 3525 : seed_id.SetNull();
126 : : }
127 : :
128 : : bool operator==(const CHDChain& chain) const
129 : : {
130 : : return seed_id == chain.seed_id;
131 : : }
132 : 1053 : bool operator<(const CHDChain& chain) const
133 : : {
134 : 1053 : return seed_id < chain.seed_id;
135 : : }
136 : : };
137 : :
138 : 130302 : class CKeyMetadata
139 : : {
140 : : public:
141 : : static constexpr int VERSION_BASIC{1};
142 : : static constexpr int VERSION_WITH_HDDATA{10};
143 : : static constexpr int VERSION_WITH_KEY_ORIGIN{12};
144 : : static constexpr int CURRENT_VERSION{VERSION_WITH_KEY_ORIGIN};
145 : : int nVersion;
146 : : int64_t nCreateTime; // 0 means unknown
147 : : std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility
148 : : CKeyID hd_seed_id; //id of the HD seed used to derive this key
149 : : KeyOriginInfo key_origin; // Key origin info with path and fingerprint
150 : : bool has_key_origin = false; //!< Whether the key_origin is useful
151 : :
152 : 130302 : CKeyMetadata()
153 : 130302 : {
154 : 130302 : SetNull();
155 : 130302 : }
156 : : explicit CKeyMetadata(int64_t nCreateTime_)
157 : : {
158 : : SetNull();
159 : : nCreateTime = nCreateTime_;
160 : : }
161 : :
162 : 0 : SERIALIZE_METHODS(CKeyMetadata, obj)
163 : : {
164 : 0 : READWRITE(obj.nVersion, obj.nCreateTime);
165 [ # # ][ # # ]: 0 : if (obj.nVersion >= VERSION_WITH_HDDATA) {
166 : 0 : READWRITE(obj.hdKeypath, obj.hd_seed_id);
167 : : }
168 [ # # ][ # # ]: 0 : if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)
169 : : {
170 : 0 : READWRITE(obj.key_origin);
171 : 0 : READWRITE(obj.has_key_origin);
172 : : }
173 : 0 : }
174 : :
175 : 130302 : void SetNull()
176 : : {
177 : 130302 : nVersion = CKeyMetadata::CURRENT_VERSION;
178 : 130302 : nCreateTime = 0;
179 : 130302 : hdKeypath.clear();
180 : 130302 : hd_seed_id.SetNull();
181 : 130302 : key_origin.clear();
182 : 130302 : has_key_origin = false;
183 : 130302 : }
184 : : };
185 : :
186 : 0 : struct DbTxnListener
187 : : {
188 : : std::function<void()> on_commit, on_abort;
189 : : };
190 : :
191 : : /** Access to the wallet database.
192 : : * Opens the database and provides read and write access to it. Each read and write is its own transaction.
193 : : * Multiple operation transactions can be started using TxnBegin() and committed using TxnCommit()
194 : : * Otherwise the transaction will be committed when the object goes out of scope.
195 : : * Optionally (on by default) it will flush to disk on close.
196 : : * Every 1000 writes will automatically trigger a flush to disk.
197 : : */
198 [ # # ]: 794615 : class WalletBatch
[ # # # # ]
[ - - - -
- - - - -
- - - -
- ]
[ - - + -
- - + - +
- - - -
- ]
199 : : {
200 : : private:
201 : : template <typename K, typename T>
202 : 1123078 : bool WriteIC(const K& key, const T& value, bool fOverwrite = true)
203 : : {
204 : 1123078 : if (!m_batch->Write(key, value, fOverwrite)) {
[ - + - +
- - - - -
- - - - -
- - + - -
+ + - - +
+ - - + +
- - + - -
- - + - -
+ + - - +
- - - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - - + +
- - + ]
205 : 0 : return false;
206 : : }
207 : : return true;
208 : : }
209 : :
210 : : template <typename K>
211 : 0 : bool EraseIC(const K& key)
212 : : {
213 [ # # ]: 0 : if (!m_batch->Erase(key)) {
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ]
214 : 0 : return false;
215 : : }
216 : : return true;
217 : : }
218 : :
219 : : public:
220 : 794615 : explicit WalletBatch(WalletDatabase &database) :
221 [ # # ][ # # : 794615 : m_batch(database.MakeBatch())
# # # # #
# ][ # # #
# # # #
# ]
[ + - + -
- - - - +
- + - - -
- - + - +
- + - + -
+ - + - +
- + - + -
- - ]
[ - - + -
+ - + - +
- - - + -
- - - - -
- - - - -
- - - - -
- - - - -
+ - - - -
- - - - -
- - - - +
- + - - -
- - - - -
- - - - -
- - - - -
- - - -
- ]
222 : : {
223 : 0 : }
224 : : WalletBatch(const WalletBatch&) = delete;
225 : : WalletBatch& operator=(const WalletBatch&) = delete;
226 : :
227 : : bool WriteName(const std::string& strAddress, const std::string& strName);
228 : : bool EraseName(const std::string& strAddress);
229 : :
230 : : bool WritePurpose(const std::string& strAddress, const std::string& purpose);
231 : : bool ErasePurpose(const std::string& strAddress);
232 : :
233 : : bool WriteTx(const CWalletTx& wtx);
234 : : bool EraseTx(Txid hash);
235 : : bool WriteWtxVariant(const Txid& txid, const CTransactionRef& tx);
236 : :
237 : : bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, bool overwrite);
238 : : bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);
239 : : bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);
240 : : bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);
241 : : bool EraseMasterKey(unsigned int id);
242 : :
243 : : bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);
244 : :
245 : : bool WriteBestBlock(const CBlockLocator& locator);
246 : : bool ReadBestBlock(CBlockLocator& locator);
247 : :
248 : : // Returns true if wallet stores encryption keys
249 : : bool IsEncrypted();
250 : :
251 : : bool WriteOrderPosNext(int64_t nOrderPosNext);
252 : :
253 : : bool WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey);
254 : : bool WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret);
255 : : bool WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor);
256 : : bool WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index);
257 : : bool WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
258 : : bool WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
259 : : bool WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache);
260 : :
261 : : bool WriteLockedUTXO(const COutPoint& output);
262 : : bool EraseLockedUTXO(const COutPoint& output);
263 : :
264 : : bool WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent);
265 : : bool WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request);
266 : : bool EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id);
267 : : bool EraseAddressData(const CTxDestination& dest);
268 : :
269 : : bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal);
270 : : bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal);
271 : :
272 : : DBErrors LoadWallet(CWallet* pwallet);
273 : :
274 : : /**
275 : : * Write the given `client_version` to m_batch, indicating the last version
276 : : * of client software to load this wallet.
277 : : *
278 : : * @param[in] client_version `CLIENT_VERSION` outside of test code.
279 : : * @return A bool indicating whether or not the write succeeded.
280 : : */
281 [ # # ]: 0 : bool WriteVersion(int client_version) { return m_batch->Write(DBKeys::VERSION, client_version); }
282 : :
283 : : //! Delete records of the given types
284 : : bool EraseRecords(const std::unordered_set<std::string>& types);
285 : :
286 : : bool WriteWalletFlags(uint64_t flags);
287 : : //! Begin a new transaction
288 : : bool TxnBegin();
289 : : //! Commit current transaction
290 : : bool TxnCommit();
291 : : //! Abort current transaction
292 : : bool TxnAbort();
293 : 0 : bool HasActiveTxn() { return m_batch->HasActiveTxn(); }
294 : :
295 : : //! Registers db txn callback functions
296 : : void RegisterTxnListener(const DbTxnListener& l);
297 : :
298 : : private:
299 : : std::unique_ptr<DatabaseBatch> m_batch;
300 : :
301 : : // External functions listening to the current db txn outcome.
302 : : // Listeners are cleared at the end of the transaction.
303 : : std::vector<DbTxnListener> m_txn_listeners;
304 : : };
305 : :
306 : : /**
307 : : * Executes the provided function 'func' within a database transaction context.
308 : : *
309 : : * This function ensures that all db modifications performed within 'func()' are
310 : : * atomically committed to the db at the end of the process. And, in case of a
311 : : * failure during execution, all performed changes are rolled back.
312 : : *
313 : : * @param database The db connection instance to perform the transaction on.
314 : : * @param process_desc A description of the process being executed, used for logging purposes in the event of a failure.
315 : : * @param func The function to be executed within the db txn context. It returns a boolean indicating whether to commit or roll back the txn.
316 : : * @return true if the db txn executed successfully, false otherwise.
317 : : */
318 : : bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func);
319 : :
320 : : bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
321 : : bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
322 : : bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
323 : : bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr);
324 : :
325 : : //! Returns true if there are any DBKeys::LEGACY_TYPES record in the wallet db
326 : : bool HasLegacyRecords(CWallet& wallet);
327 : : bool HasLegacyRecords(CWallet& wallet, DatabaseBatch& batch);
328 : : } // namespace wallet
329 : :
330 : : #endif // BITCOIN_WALLET_WALLETDB_H
|
