1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
12 #include <boost/version.hpp>
13 #include <boost/filesystem.hpp>
14 #include <boost/algorithm/string.hpp>
16 #include <boost/date_time/posix_time/posix_time.hpp>
17 #include <boost/lexical_cast.hpp>
18 #include <boost/variant/get.hpp>
19 #include <boost/algorithm/string.hpp>
22 using namespace boost;
25 static uint64 nAccountingEntryNumber = 0;
26 extern bool fWalletUnlockMintOnly;
32 bool CWalletDB::WriteName(const string& strAddress, const string& strName)
35 return Write(make_pair(string("name"), strAddress), strName);
38 bool CWalletDB::EraseName(const string& strAddress)
40 // This should only be used for sending addresses, never for receiving addresses,
41 // receiving addresses must always have an address book entry if they're not change return.
43 return Erase(make_pair(string("name"), strAddress));
46 bool CWalletDB::ReadAccount(const string& strAccount, CAccount& account)
49 return Read(make_pair(string("acc"), strAccount), account);
52 bool CWalletDB::WriteAccount(const string& strAccount, const CAccount& account)
54 return Write(make_pair(string("acc"), strAccount), account);
57 bool CWalletDB::WriteAccountingEntry(const uint64 nAccEntryNum, const CAccountingEntry& acentry)
59 return Write(boost::make_tuple(string("acentry"), acentry.strAccount, nAccEntryNum), acentry);
62 bool CWalletDB::WriteAccountingEntry(const CAccountingEntry& acentry)
64 return WriteAccountingEntry(++nAccountingEntryNumber, acentry);
67 int64 CWalletDB::GetAccountCreditDebit(const string& strAccount)
69 list<CAccountingEntry> entries;
70 ListAccountCreditDebit(strAccount, entries);
72 int64 nCreditDebit = 0;
73 BOOST_FOREACH (const CAccountingEntry& entry, entries)
74 nCreditDebit += entry.nCreditDebit;
79 void CWalletDB::ListAccountCreditDebit(const string& strAccount, list<CAccountingEntry>& entries)
81 bool fAllAccounts = (strAccount == "*");
83 Dbc* pcursor = GetCursor();
85 throw runtime_error("CWalletDB::ListAccountCreditDebit() : cannot create DB cursor");
86 unsigned int fFlags = DB_SET_RANGE;
90 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
91 if (fFlags == DB_SET_RANGE)
92 ssKey << boost::make_tuple(string("acentry"), (fAllAccounts? string("") : strAccount), uint64(0));
93 CDataStream ssValue(SER_DISK, CLIENT_VERSION);
94 int ret = ReadAtCursor(pcursor, ssKey, ssValue, fFlags);
96 if (ret == DB_NOTFOUND)
101 throw runtime_error("CWalletDB::ListAccountCreditDebit() : error scanning DB");
107 if (strType != "acentry")
109 CAccountingEntry acentry;
110 ssKey >> acentry.strAccount;
111 if (!fAllAccounts && acentry.strAccount != strAccount)
115 ssKey >> acentry.nEntryNo;
116 entries.push_back(acentry);
124 CWalletDB::ReorderTransactions(CWallet* pwallet)
126 LOCK(pwallet->cs_wallet);
127 // Old wallets didn't have any defined order for transactions
128 // Probably a bad idea to change the output of this
130 // First: get all CWalletTx and CAccountingEntry into a sorted-by-time multimap.
131 typedef pair<CWalletTx*, CAccountingEntry*> TxPair;
132 typedef multimap<int64, TxPair > TxItems;
135 for (map<uint256, CWalletTx>::iterator it = pwallet->mapWallet.begin(); it != pwallet->mapWallet.end(); ++it)
137 CWalletTx* wtx = &((*it).second);
138 txByTime.insert(make_pair(wtx->nTimeReceived, TxPair(wtx, (CAccountingEntry*)0)));
140 list<CAccountingEntry> acentries;
141 ListAccountCreditDebit("", acentries);
142 BOOST_FOREACH(CAccountingEntry& entry, acentries)
144 txByTime.insert(make_pair(entry.nTime, TxPair((CWalletTx*)0, &entry)));
147 int64& nOrderPosNext = pwallet->nOrderPosNext;
149 std::vector<int64> nOrderPosOffsets;
150 for (TxItems::iterator it = txByTime.begin(); it != txByTime.end(); ++it)
152 CWalletTx *const pwtx = (*it).second.first;
153 CAccountingEntry *const pacentry = (*it).second.second;
154 int64& nOrderPos = (pwtx != 0) ? pwtx->nOrderPos : pacentry->nOrderPos;
158 nOrderPos = nOrderPosNext++;
159 nOrderPosOffsets.push_back(nOrderPos);
162 // Have to write accounting regardless, since we don't keep it in memory
163 if (!WriteAccountingEntry(pacentry->nEntryNo, *pacentry))
168 int64 nOrderPosOff = 0;
169 BOOST_FOREACH(const int64& nOffsetStart, nOrderPosOffsets)
171 if (nOrderPos >= nOffsetStart)
174 nOrderPos += nOrderPosOff;
175 nOrderPosNext = std::max(nOrderPosNext, nOrderPos + 1);
180 // Since we're changing the order, write it back
183 if (!WriteTx(pwtx->GetHash(), *pwtx))
187 if (!WriteAccountingEntry(pacentry->nEntryNo, *pacentry))
195 class CWalletScanState {
199 unsigned int nKeyMeta;
203 vector<uint256> vWalletUpgrade;
206 nKeys = nCKeys = nKeyMeta = 0;
207 fIsEncrypted = false;
208 fAnyUnordered = false;
214 ReadKeyValue(CWallet* pwallet, CDataStream& ssKey, CDataStream& ssValue,
215 CWalletScanState &wss, string& strType, string& strErr)
219 // Taking advantage of the fact that pair serialization
220 // is just the two items serialized one after the other
222 if (strType == "name")
226 ssValue >> pwallet->mapAddressBook[CBitcoinAddress(strAddress).Get()];
228 else if (strType == "tx")
232 CWalletTx& wtx = pwallet->mapWallet[hash];
234 if (wtx.CheckTransaction() && (wtx.GetHash() == hash))
235 wtx.BindWallet(pwallet);
238 pwallet->mapWallet.erase(hash);
242 // Undo serialize changes in 31600
243 if (31404 <= wtx.fTimeReceivedIsTxTime && wtx.fTimeReceivedIsTxTime <= 31703)
245 if (!ssValue.empty())
249 ssValue >> fTmp >> fUnused >> wtx.strFromAccount;
250 strErr = strprintf("LoadWallet() upgrading tx ver=%d %d '%s' %s",
251 wtx.fTimeReceivedIsTxTime, fTmp, wtx.strFromAccount.c_str(), hash.ToString().c_str());
252 wtx.fTimeReceivedIsTxTime = fTmp;
256 strErr = strprintf("LoadWallet() repairing tx ver=%d %s", wtx.fTimeReceivedIsTxTime, hash.ToString().c_str());
257 wtx.fTimeReceivedIsTxTime = 0;
259 wss.vWalletUpgrade.push_back(hash);
262 if (wtx.nOrderPos == -1)
263 wss.fAnyUnordered = true;
266 //printf("LoadWallet %s\n", wtx.GetHash().ToString().c_str());
267 //printf(" %12"PRI64d" %s %s %s\n",
268 // wtx.vout[0].nValue,
269 // DateTimeStrFormat("%x %H:%M:%S", wtx.GetBlockTime()).c_str(),
270 // wtx.hashBlock.ToString().substr(0,20).c_str(),
271 // wtx.mapValue["message"].c_str());
273 else if (strType == "acentry")
279 if (nNumber > nAccountingEntryNumber)
280 nAccountingEntryNumber = nNumber;
282 if (!wss.fAnyUnordered)
284 CAccountingEntry acentry;
286 if (acentry.nOrderPos == -1)
287 wss.fAnyUnordered = true;
290 else if (strType == "key" || strType == "wkey")
292 vector<unsigned char> vchPubKey;
295 if (strType == "key")
300 key.SetPubKey(vchPubKey);
301 if (!key.SetPrivKey(pkey))
303 strErr = "Error reading wallet database: CPrivKey corrupt";
306 if (key.GetPubKey() != vchPubKey)
308 strErr = "Error reading wallet database: CPrivKey pubkey inconsistency";
313 strErr = "Error reading wallet database: invalid CPrivKey";
321 key.SetPubKey(vchPubKey);
322 if (!key.SetPrivKey(wkey.vchPrivKey))
324 strErr = "Error reading wallet database: CPrivKey corrupt";
327 if (key.GetPubKey() != vchPubKey)
329 strErr = "Error reading wallet database: CWalletKey pubkey inconsistency";
334 strErr = "Error reading wallet database: invalid CWalletKey";
338 if (!pwallet->LoadKey(key))
340 strErr = "Error reading wallet database: LoadKey failed";
344 else if (strType == "mkey")
348 CMasterKey kMasterKey;
349 ssValue >> kMasterKey;
350 if(pwallet->mapMasterKeys.count(nID) != 0)
352 strErr = strprintf("Error reading wallet database: duplicate CMasterKey id %u", nID);
355 pwallet->mapMasterKeys[nID] = kMasterKey;
356 if (pwallet->nMasterKeyMaxID < nID)
357 pwallet->nMasterKeyMaxID = nID;
359 else if (strType == "ckey")
362 vector<unsigned char> vchPubKey;
364 vector<unsigned char> vchPrivKey;
365 ssValue >> vchPrivKey;
366 if (!pwallet->LoadCryptedKey(vchPubKey, vchPrivKey))
368 strErr = "Error reading wallet database: LoadCryptedKey failed";
371 wss.fIsEncrypted = true;
373 else if (strType == "keymeta")
377 CKeyMetadata keyMeta;
381 pwallet->LoadKeyMetadata(vchPubKey, keyMeta);
383 // find earliest key creation time, as wallet birthday
384 if (!pwallet->nTimeFirstKey ||
385 (keyMeta.nCreateTime < pwallet->nTimeFirstKey))
386 pwallet->nTimeFirstKey = keyMeta.nCreateTime;
388 else if (strType == "defaultkey")
390 ssValue >> pwallet->vchDefaultKey;
392 else if (strType == "pool")
398 pwallet->setKeyPool.insert(nIndex);
400 // If no metadata exists yet, create a default with the pool key's
401 // creation time. Note that this may be overwritten by actually
402 // stored metadata for that key later, which is fine.
403 CKeyID keyid = keypool.vchPubKey.GetID();
404 if (pwallet->mapKeyMetadata.count(keyid) == 0)
405 pwallet->mapKeyMetadata[keyid] = CKeyMetadata(keypool.nTime);
408 else if (strType == "version")
410 ssValue >> wss.nFileVersion;
411 if (wss.nFileVersion == 10300)
412 wss.nFileVersion = 300;
414 else if (strType == "cscript")
420 if (!pwallet->LoadCScript(script))
422 strErr = "Error reading wallet database: LoadCScript failed";
426 else if (strType == "orderposnext")
428 ssValue >> pwallet->nOrderPosNext;
437 static bool IsKeyType(string strType)
439 return (strType== "key" || strType == "wkey" ||
440 strType == "mkey" || strType == "ckey");
443 DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
445 pwallet->vchDefaultKey = CPubKey();
446 CWalletScanState wss;
447 bool fNoncriticalErrors = false;
448 DBErrors result = DB_LOAD_OK;
451 LOCK(pwallet->cs_wallet);
453 if (Read((string)"minversion", nMinVersion))
455 if (nMinVersion > CLIENT_VERSION)
457 pwallet->LoadMinVersion(nMinVersion);
461 Dbc* pcursor = GetCursor();
464 printf("Error getting wallet database cursor\n");
471 CDataStream ssKey(SER_DISK, CLIENT_VERSION);
472 CDataStream ssValue(SER_DISK, CLIENT_VERSION);
473 int ret = ReadAtCursor(pcursor, ssKey, ssValue);
474 if (ret == DB_NOTFOUND)
478 printf("Error reading next record from wallet database\n");
482 // Try to be tolerant of single corrupt records:
483 string strType, strErr;
484 if (!ReadKeyValue(pwallet, ssKey, ssValue, wss, strType, strErr))
486 // losing keys is considered a catastrophic error, anything else
487 // we assume the user can live with:
488 if (IsKeyType(strType))
492 // Leave other errors alone, if we try to fix them we might make things worse.
493 fNoncriticalErrors = true; // ... but do warn the user there is something wrong.
495 // Rescan if there is a bad transaction record:
496 SoftSetBoolArg("-rescan", true);
500 printf("%s\n", strErr.c_str());
509 if (fNoncriticalErrors && result == DB_LOAD_OK)
510 result = DB_NONCRITICAL_ERROR;
512 // Any wallet corruption at all: skip any rewriting or
513 // upgrading, we don't want to make it worse.
514 if (result != DB_LOAD_OK)
517 printf("nFileVersion = %d\n", wss.nFileVersion);
519 printf("Keys: %u plaintext, %u encrypted, %u w/ metadata, %u total\n",
520 wss.nKeys, wss.nCKeys, wss.nKeyMeta, wss.nKeys + wss.nCKeys);
522 // nTimeFirstKey is only reliable if all keys have metadata
523 if ((wss.nKeys + wss.nCKeys) != wss.nKeyMeta)
524 pwallet->nTimeFirstKey = 1; // 0 would be considered 'no value'
527 BOOST_FOREACH(uint256 hash, wss.vWalletUpgrade)
528 WriteTx(hash, pwallet->mapWallet[hash]);
530 // Rewrite encrypted wallets of versions 0.4.0 and 0.5.0rc:
531 if (wss.fIsEncrypted && (wss.nFileVersion == 40000 || wss.nFileVersion == 50000))
532 return DB_NEED_REWRITE;
534 if (wss.nFileVersion < CLIENT_VERSION) // Update
535 WriteVersion(CLIENT_VERSION);
537 if (wss.fAnyUnordered)
538 result = ReorderTransactions(pwallet);
543 void ThreadFlushWalletDB(void* parg)
545 // Make this thread recognisable as the wallet flushing thread
546 RenameThread("bitcoin-wallet");
548 const string& strFile = ((const string*)parg)[0];
549 static bool fOneThread;
553 if (!GetBoolArg("-flushwallet", true))
556 unsigned int nLastSeen = nWalletDBUpdated;
557 unsigned int nLastFlushed = nWalletDBUpdated;
558 int64 nLastWalletUpdate = GetTime();
563 if (nLastSeen != nWalletDBUpdated)
565 nLastSeen = nWalletDBUpdated;
566 nLastWalletUpdate = GetTime();
569 if (nLastFlushed != nWalletDBUpdated && GetTime() - nLastWalletUpdate >= 2)
571 TRY_LOCK(bitdb.cs_db,lockDb);
574 // Don't do this if any databases are in use
576 map<string, int>::iterator mi = bitdb.mapFileUseCount.begin();
577 while (mi != bitdb.mapFileUseCount.end())
579 nRefCount += (*mi).second;
583 if (nRefCount == 0 && !fShutdown)
585 map<string, int>::iterator mi = bitdb.mapFileUseCount.find(strFile);
586 if (mi != bitdb.mapFileUseCount.end())
588 printf("Flushing wallet.dat\n");
589 nLastFlushed = nWalletDBUpdated;
590 int64 nStart = GetTimeMillis();
592 // Flush wallet.dat so it's self contained
593 bitdb.CloseDb(strFile);
594 bitdb.CheckpointLSN(strFile);
596 bitdb.mapFileUseCount.erase(mi++);
597 printf("Flushed wallet.dat %"PRI64d"ms\n", GetTimeMillis() - nStart);
605 bool BackupWallet(const CWallet& wallet, const string& strDest)
607 if (!wallet.fFileBacked)
613 if (!bitdb.mapFileUseCount.count(wallet.strWalletFile) || bitdb.mapFileUseCount[wallet.strWalletFile] == 0)
615 // Flush log data to the dat file
616 bitdb.CloseDb(wallet.strWalletFile);
617 bitdb.CheckpointLSN(wallet.strWalletFile);
618 bitdb.mapFileUseCount.erase(wallet.strWalletFile);
621 filesystem::path pathSrc = GetDataDir() / wallet.strWalletFile;
622 filesystem::path pathDest(strDest);
623 if (filesystem::is_directory(pathDest))
624 pathDest /= wallet.strWalletFile;
627 #if BOOST_VERSION >= 104000
628 filesystem::copy_file(pathSrc, pathDest, filesystem::copy_option::overwrite_if_exists);
630 filesystem::copy_file(pathSrc, pathDest);
632 printf("copied wallet.dat to %s\n", pathDest.string().c_str());
634 } catch(const filesystem::filesystem_error &e) {
635 printf("error copying wallet.dat to %s - %s\n", pathDest.string().c_str(), e.what());
645 bool DumpWallet(CWallet* pwallet, const string& strDest)
648 if (!pwallet->fFileBacked)
653 std::map<CKeyID, int64> mapKeyBirth;
654 std::set<CKeyID> setKeyPool;
655 pwallet->GetKeyBirthTimes(mapKeyBirth);
656 pwallet->GetAllReserveKeys(setKeyPool);
658 // sort time/key pairs
659 std::vector<std::pair<int64, CKeyID> > vKeyBirth;
660 for (std::map<CKeyID, int64>::const_iterator it = mapKeyBirth.begin(); it != mapKeyBirth.end(); it++) {
661 vKeyBirth.push_back(std::make_pair(it->second, it->first));
664 std::sort(vKeyBirth.begin(), vKeyBirth.end());
666 // open outputfile as a stream
668 file.open(strDest.c_str());
673 file << strprintf("# Wallet dump created by NovaCoin %s (%s)\n", CLIENT_BUILD.c_str(), CLIENT_DATE.c_str());
674 file << strprintf("# * Created on %s\n", EncodeDumpTime(GetTime()).c_str());
675 file << strprintf("# * Best block at time of backup was %i (%s),\n", nBestHeight, hashBestChain.ToString().c_str());
676 file << strprintf("# mined on %s\n", EncodeDumpTime(pindexBest->nTime).c_str());
678 for (std::vector<std::pair<int64, CKeyID> >::const_iterator it = vKeyBirth.begin(); it != vKeyBirth.end(); it++) {
679 const CKeyID &keyid = it->second;
680 std::string strTime = EncodeDumpTime(it->first);
681 std::string strAddr = CBitcoinAddress(keyid).ToString();
685 if (pwallet->GetKey(keyid, key)) {
686 if (pwallet->mapAddressBook.count(keyid)) {
687 CSecret secret = key.GetSecret(IsCompressed);
688 file << strprintf("%s %s label=%s # addr=%s\n",
689 CBitcoinSecret(secret, IsCompressed).ToString().c_str(),
691 EncodeDumpString(pwallet->mapAddressBook[keyid]).c_str(),
693 } else if (setKeyPool.count(keyid)) {
694 CSecret secret = key.GetSecret(IsCompressed);
695 file << strprintf("%s %s reserve=1 # addr=%s\n",
696 CBitcoinSecret(secret, IsCompressed).ToString().c_str(),
700 CSecret secret = key.GetSecret(IsCompressed);
701 file << strprintf("%s %s change=1 # addr=%s\n",
702 CBitcoinSecret(secret, IsCompressed).ToString().c_str(),
709 file << "# End of dump\n";
717 bool ImportWallet(CWallet *pwallet, const string& strLocation)
720 if (!pwallet->fFileBacked)
724 // open inputfile as stream
726 file.open(strLocation.c_str());
730 int64 nTimeBegin = pindexBest->nTime;
734 // read through input file checking and importing keys into wallet.
735 while (file.good()) {
737 std::getline(file, line);
738 if (line.empty() || line[0] == '#')
741 std::vector<std::string> vstr;
742 boost::split(vstr, line, boost::is_any_of(" "));
745 CBitcoinSecret vchSecret;
746 if (!vchSecret.SetString(vstr[0]))
751 CSecret secret = vchSecret.GetSecret(fCompressed);
752 key.SetSecret(secret, fCompressed);
753 CKeyID keyid = key.GetPubKey().GetID();
755 if (pwallet->HaveKey(keyid)) {
756 printf("Skipping import of %s (key already present)\n", CBitcoinAddress(keyid).ToString().c_str());
759 int64 nTime = DecodeDumpTime(vstr[1]);
760 std::string strLabel;
762 for (unsigned int nStr = 2; nStr < vstr.size(); nStr++) {
763 if (boost::algorithm::starts_with(vstr[nStr], "#"))
765 if (vstr[nStr] == "change=1")
767 if (vstr[nStr] == "reserve=1")
769 if (boost::algorithm::starts_with(vstr[nStr], "label=")) {
770 strLabel = DecodeDumpString(vstr[nStr].substr(6));
774 printf("Importing %s...\n", CBitcoinAddress(keyid).ToString().c_str());
775 if (!pwallet->AddKey(key)) {
779 pwallet->mapKeyMetadata[keyid].nCreateTime = nTime;
781 pwallet->SetAddressBookName(keyid, strLabel);
782 nTimeBegin = std::min(nTimeBegin, nTime);
786 // rescan block chain looking for coins from new keys
787 CBlockIndex *pindex = pindexBest;
788 while (pindex && pindex->pprev && pindex->nTime > nTimeBegin - 7200)
789 pindex = pindex->pprev;
791 printf("Rescanning last %i blocks\n", pindexBest->nHeight - pindex->nHeight + 1);
792 pwallet->ScanForWalletTransactions(pindex);
793 pwallet->ReacceptWalletTransactions();
794 pwallet->MarkDirty();
806 // Try to (very carefully!) recover wallet.dat if there is a problem.
808 bool CWalletDB::Recover(CDBEnv& dbenv, std::string filename, bool fOnlyKeys)
810 // Recovery procedure:
811 // move wallet.dat to wallet.timestamp.bak
812 // Call Salvage with fAggressive=true to
813 // get as much data as possible.
814 // Rewrite salvaged data to wallet.dat
815 // Set -rescan so any missing transactions will be
817 int64 now = GetTime();
818 std::string newFilename = strprintf("wallet.%"PRI64d".bak", now);
820 int result = dbenv.dbenv.dbrename(NULL, filename.c_str(), NULL,
821 newFilename.c_str(), DB_AUTO_COMMIT);
823 printf("Renamed %s to %s\n", filename.c_str(), newFilename.c_str());
826 printf("Failed to rename %s to %s\n", filename.c_str(), newFilename.c_str());
830 std::vector<CDBEnv::KeyValPair> salvagedData;
831 bool allOK = dbenv.Salvage(newFilename, true, salvagedData);
832 if (salvagedData.empty())
834 printf("Salvage(aggressive) found no records in %s.\n", newFilename.c_str());
837 printf("Salvage(aggressive) found %"PRIszu" records\n", salvagedData.size());
839 bool fSuccess = allOK;
840 Db* pdbCopy = new Db(&dbenv.dbenv, 0);
841 int ret = pdbCopy->open(NULL, // Txn pointer
842 filename.c_str(), // Filename
843 "main", // Logical db name
844 DB_BTREE, // Database type
849 printf("Cannot create database file %s\n", filename.c_str());
853 CWalletScanState wss;
855 DbTxn* ptxn = dbenv.TxnBegin();
856 BOOST_FOREACH(CDBEnv::KeyValPair& row, salvagedData)
860 CDataStream ssKey(row.first, SER_DISK, CLIENT_VERSION);
861 CDataStream ssValue(row.second, SER_DISK, CLIENT_VERSION);
862 string strType, strErr;
863 bool fReadOK = ReadKeyValue(&dummyWallet, ssKey, ssValue,
864 wss, strType, strErr);
865 if (!IsKeyType(strType))
869 printf("WARNING: CWalletDB::Recover skipping %s: %s\n", strType.c_str(), strErr.c_str());
873 Dbt datKey(&row.first[0], row.first.size());
874 Dbt datValue(&row.second[0], row.second.size());
875 int ret2 = pdbCopy->put(ptxn, &datKey, &datValue, DB_NOOVERWRITE);
886 bool CWalletDB::Recover(CDBEnv& dbenv, std::string filename)
888 return CWalletDB::Recover(dbenv, filename, false);