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