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 license.txt or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef BITCOIN_WALLET_H
6 #define BITCOIN_WALLET_H
17 /** (client) version numbers for particular wallet features */
20 FEATURE_BASE = 10500, // the earliest version new wallets supports (only useful for getinfo's clientversion output)
22 FEATURE_WALLETCRYPT = 40000, // wallet encryption
23 FEATURE_COMPRPUBKEY = 60000, // compressed public keys
25 FEATURE_LATEST = 60000
28 /** A CWallet is an extension of a keystore, which also maintains a set of transactions and balances,
29 * and provides the ability to create new transactions.
31 class CWallet : public CCryptoKeyStore
34 bool SelectCoinsMinConf(int64 nTargetValue, int nConfMine, int nConfTheirs, std::set<std::pair<const CWalletTx*,unsigned int> >& setCoinsRet, int64& nValueRet) const;
35 bool SelectCoins(int64 nTargetValue, std::set<std::pair<const CWalletTx*,unsigned int> >& setCoinsRet, int64& nValueRet) const;
37 CWalletDB *pwalletdbEncryption;
39 // the current wallet version: clients below this version are not able to load the wallet
42 // the maxmimum wallet format version: memory-only variable that specifies to what version this wallet may be upgraded
43 int nWalletMaxVersion;
46 mutable CCriticalSection cs_wallet;
49 std::string strWalletFile;
51 std::set<int64> setKeyPool;
54 typedef std::map<unsigned int, CMasterKey> MasterKeyMap;
55 MasterKeyMap mapMasterKeys;
56 unsigned int nMasterKeyMaxID;
60 nWalletVersion = FEATURE_BASE;
61 nWalletMaxVersion = FEATURE_BASE;
64 pwalletdbEncryption = NULL;
66 CWallet(std::string strWalletFileIn)
68 nWalletVersion = FEATURE_BASE;
69 nWalletMaxVersion = FEATURE_BASE;
70 strWalletFile = strWalletFileIn;
73 pwalletdbEncryption = NULL;
76 std::map<uint256, CWalletTx> mapWallet;
77 std::vector<uint256> vWalletUpdated;
79 std::map<uint256, int> mapRequestCount;
81 std::map<CBitcoinAddress, std::string> mapAddressBook;
83 std::vector<unsigned char> vchDefaultKey;
85 // check whether we are allowed to upgrade (or already support) to the named feature
86 bool CanSupportFeature(enum WalletFeature wf) { return nWalletMaxVersion >= wf; }
88 // keystore implementation
90 std::vector<unsigned char> GenerateNewKey();
91 // Adds a key to the store, and saves it to disk.
92 bool AddKey(const CKey& key);
93 // Adds a key to the store, without saving it to disk (used by LoadWallet)
94 bool LoadKey(const CKey& key) { return CCryptoKeyStore::AddKey(key); }
96 bool LoadMinVersion(int nVersion) { nWalletVersion = nVersion; nWalletMaxVersion = std::max(nWalletMaxVersion, nVersion); return true; }
98 // Adds an encrypted key to the store, and saves it to disk.
99 bool AddCryptedKey(const std::vector<unsigned char> &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
100 // Adds an encrypted key to the store, without saving it to disk (used by LoadWallet)
101 bool LoadCryptedKey(const std::vector<unsigned char> &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret) { SetMinVersion(FEATURE_WALLETCRYPT); return CCryptoKeyStore::AddCryptedKey(vchPubKey, vchCryptedSecret); }
102 bool AddCScript(const CScript& redeemScript);
103 bool LoadCScript(const CScript& redeemScript) { return CCryptoKeyStore::AddCScript(redeemScript); }
105 bool Unlock(const SecureString& strWalletPassphrase);
106 bool ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase);
107 bool EncryptWallet(const SecureString& strWalletPassphrase);
110 bool AddToWallet(const CWalletTx& wtxIn);
111 bool AddToWalletIfInvolvingMe(const CTransaction& tx, const CBlock* pblock, bool fUpdate = false, bool fFindBlock = false);
112 bool EraseFromWallet(uint256 hash);
113 void WalletUpdateSpent(const CTransaction& prevout);
114 int ScanForWalletTransactions(CBlockIndex* pindexStart, bool fUpdate = false);
115 int ScanForWalletTransaction(const uint256& hashTx);
116 void ReacceptWalletTransactions();
117 void ResendWalletTransactions();
118 int64 GetBalance() const;
119 int64 GetUnconfirmedBalance() const;
120 bool CreateTransaction(const std::vector<std::pair<CScript, int64> >& vecSend, CWalletTx& wtxNew, CReserveKey& reservekey, int64& nFeeRet);
121 bool CreateTransaction(CScript scriptPubKey, int64 nValue, CWalletTx& wtxNew, CReserveKey& reservekey, int64& nFeeRet);
122 bool CommitTransaction(CWalletTx& wtxNew, CReserveKey& reservekey);
123 std::string SendMoney(CScript scriptPubKey, int64 nValue, CWalletTx& wtxNew, bool fAskFee=false);
124 std::string SendMoneyToBitcoinAddress(const CBitcoinAddress& address, int64 nValue, CWalletTx& wtxNew, bool fAskFee=false);
128 int64 AddReserveKey(const CKeyPool& keypool);
129 void ReserveKeyFromKeyPool(int64& nIndex, CKeyPool& keypool);
130 void KeepKey(int64 nIndex);
131 void ReturnKey(int64 nIndex);
132 bool GetKeyFromPool(std::vector<unsigned char> &key, bool fAllowReuse=true);
133 int64 GetOldestKeyPoolTime();
134 void GetAllReserveAddresses(std::set<CBitcoinAddress>& setAddress);
136 bool IsMine(const CTxIn& txin) const;
137 int64 GetDebit(const CTxIn& txin) const;
138 bool IsMine(const CTxOut& txout) const
140 return ::IsMine(*this, txout.scriptPubKey);
142 int64 GetCredit(const CTxOut& txout) const
144 if (!MoneyRange(txout.nValue))
145 throw std::runtime_error("CWallet::GetCredit() : value out of range");
146 return (IsMine(txout) ? txout.nValue : 0);
148 bool IsChange(const CTxOut& txout) const;
149 int64 GetChange(const CTxOut& txout) const
151 if (!MoneyRange(txout.nValue))
152 throw std::runtime_error("CWallet::GetChange() : value out of range");
153 return (IsChange(txout) ? txout.nValue : 0);
155 bool IsMine(const CTransaction& tx) const
157 BOOST_FOREACH(const CTxOut& txout, tx.vout)
162 bool IsFromMe(const CTransaction& tx) const
164 return (GetDebit(tx) > 0);
166 int64 GetDebit(const CTransaction& tx) const
169 BOOST_FOREACH(const CTxIn& txin, tx.vin)
171 nDebit += GetDebit(txin);
172 if (!MoneyRange(nDebit))
173 throw std::runtime_error("CWallet::GetDebit() : value out of range");
177 int64 GetCredit(const CTransaction& tx) const
180 BOOST_FOREACH(const CTxOut& txout, tx.vout)
182 nCredit += GetCredit(txout);
183 if (!MoneyRange(nCredit))
184 throw std::runtime_error("CWallet::GetCredit() : value out of range");
188 int64 GetChange(const CTransaction& tx) const
191 BOOST_FOREACH(const CTxOut& txout, tx.vout)
193 nChange += GetChange(txout);
194 if (!MoneyRange(nChange))
195 throw std::runtime_error("CWallet::GetChange() : value out of range");
199 void SetBestChain(const CBlockLocator& loc)
201 CWalletDB walletdb(strWalletFile);
202 walletdb.WriteBestBlock(loc);
205 int LoadWallet(bool& fFirstRunRet);
206 // bool BackupWallet(const std::string& strDest);
208 bool SetAddressBookName(const CBitcoinAddress& address, const std::string& strName);
210 bool DelAddressBookName(const CBitcoinAddress& address);
212 void UpdatedTransaction(const uint256 &hashTx)
216 vWalletUpdated.push_back(hashTx);
220 void PrintWallet(const CBlock& block);
222 void Inventory(const uint256 &hash)
226 std::map<uint256, int>::iterator mi = mapRequestCount.find(hash);
227 if (mi != mapRequestCount.end())
234 return setKeyPool.size();
237 bool GetTransaction(const uint256 &hashTx, CWalletTx& wtx);
239 bool SetDefaultKey(const std::vector<unsigned char> &vchPubKey);
241 // signify that a particular wallet feature is now used. this may change nWalletVersion and nWalletMaxVersion if those are lower
242 bool SetMinVersion(enum WalletFeature, CWalletDB* pwalletdbIn = NULL, bool fExplicit = false);
244 // change which version we're allowed to upgrade to (note that this does not immediately imply upgrading to that format)
245 bool SetMaxVersion(int nVersion);
247 // get the current wallet format (the oldest client version guaranteed to understand this wallet)
248 int GetVersion() { return nWalletVersion; }
251 /** A key allocated from the key pool. */
257 std::vector<unsigned char> vchPubKey;
259 CReserveKey(CWallet* pwalletIn)
272 std::vector<unsigned char> GetReservedKey();
277 /** A transaction with a bunch of additional info that only the owner cares about.
278 * It includes any unrecorded transactions needed to link it back to the block chain.
280 class CWalletTx : public CMerkleTx
283 const CWallet* pwallet;
286 std::vector<CMerkleTx> vtxPrev;
287 std::map<std::string, std::string> mapValue;
288 std::vector<std::pair<std::string, std::string> > vOrderForm;
289 unsigned int fTimeReceivedIsTxTime;
290 unsigned int nTimeReceived; // time received by this node
292 std::string strFromAccount;
293 std::vector<char> vfSpent; // which outputs are already spent
296 mutable char fDebitCached;
297 mutable char fCreditCached;
298 mutable char fAvailableCreditCached;
299 mutable char fChangeCached;
300 mutable int64 nDebitCached;
301 mutable int64 nCreditCached;
302 mutable int64 nAvailableCreditCached;
303 mutable int64 nChangeCached;
305 // memory only UI hints
306 mutable unsigned int nTimeDisplayed;
307 mutable int nLinesDisplayed;
308 mutable char fConfirmedDisplayed;
315 CWalletTx(const CWallet* pwalletIn)
320 CWalletTx(const CWallet* pwalletIn, const CMerkleTx& txIn) : CMerkleTx(txIn)
325 CWalletTx(const CWallet* pwalletIn, const CTransaction& txIn) : CMerkleTx(txIn)
330 void Init(const CWallet* pwalletIn)
336 fTimeReceivedIsTxTime = false;
339 strFromAccount.clear();
341 fDebitCached = false;
342 fCreditCached = false;
343 fAvailableCreditCached = false;
344 fChangeCached = false;
347 nAvailableCreditCached = 0;
351 fConfirmedDisplayed = false;
356 CWalletTx* pthis = const_cast<CWalletTx*>(this);
363 pthis->mapValue["fromaccount"] = pthis->strFromAccount;
366 BOOST_FOREACH(char f, vfSpent)
368 str += (f ? '1' : '0');
372 pthis->mapValue["spent"] = str;
375 nSerSize += SerReadWrite(s, *(CMerkleTx*)this, nType, nVersion,ser_action);
378 READWRITE(vOrderForm);
379 READWRITE(fTimeReceivedIsTxTime);
380 READWRITE(nTimeReceived);
386 pthis->strFromAccount = pthis->mapValue["fromaccount"];
388 if (mapValue.count("spent"))
389 BOOST_FOREACH(char c, pthis->mapValue["spent"])
390 pthis->vfSpent.push_back(c != '0');
392 pthis->vfSpent.assign(vout.size(), fSpent);
395 pthis->mapValue.erase("fromaccount");
396 pthis->mapValue.erase("version");
397 pthis->mapValue.erase("spent");
400 // marks certain txout's as spent
401 // returns true if any update took place
402 bool UpdateSpent(const std::vector<char>& vfNewSpent)
404 bool fReturn = false;
405 for (int i=0; i < vfNewSpent.size(); i++)
407 if (i == vfSpent.size())
410 if (vfNewSpent[i] && !vfSpent[i])
414 fAvailableCreditCached = false;
420 // make sure balances are recalculated
423 fCreditCached = false;
424 fAvailableCreditCached = false;
425 fDebitCached = false;
426 fChangeCached = false;
429 void BindWallet(CWallet *pwalletIn)
435 void MarkSpent(unsigned int nOut)
437 if (nOut >= vout.size())
438 throw std::runtime_error("CWalletTx::MarkSpent() : nOut out of range");
439 vfSpent.resize(vout.size());
442 vfSpent[nOut] = true;
443 fAvailableCreditCached = false;
447 bool IsSpent(unsigned int nOut) const
449 if (nOut >= vout.size())
450 throw std::runtime_error("CWalletTx::IsSpent() : nOut out of range");
451 if (nOut >= vfSpent.size())
453 return (!!vfSpent[nOut]);
456 int64 GetDebit() const
462 nDebitCached = pwallet->GetDebit(*this);
467 int64 GetCredit(bool fUseCache=true) const
469 // Must wait until coinbase is safely deep enough in the chain before valuing it
470 if (IsCoinBase() && GetBlocksToMaturity() > 0)
473 // GetBalance can assume transactions in mapWallet won't change
474 if (fUseCache && fCreditCached)
475 return nCreditCached;
476 nCreditCached = pwallet->GetCredit(*this);
477 fCreditCached = true;
478 return nCreditCached;
481 int64 GetAvailableCredit(bool fUseCache=true) const
483 // Must wait until coinbase is safely deep enough in the chain before valuing it
484 if (IsCoinBase() && GetBlocksToMaturity() > 0)
487 if (fUseCache && fAvailableCreditCached)
488 return nAvailableCreditCached;
491 for (int i = 0; i < vout.size(); i++)
495 const CTxOut &txout = vout[i];
496 nCredit += pwallet->GetCredit(txout);
497 if (!MoneyRange(nCredit))
498 throw std::runtime_error("CWalletTx::GetAvailableCredit() : value out of range");
502 nAvailableCreditCached = nCredit;
503 fAvailableCreditCached = true;
508 int64 GetChange() const
511 return nChangeCached;
512 nChangeCached = pwallet->GetChange(*this);
513 fChangeCached = true;
514 return nChangeCached;
517 void GetAmounts(int64& nGeneratedImmature, int64& nGeneratedMature, std::list<std::pair<CBitcoinAddress, int64> >& listReceived,
518 std::list<std::pair<CBitcoinAddress, int64> >& listSent, int64& nFee, std::string& strSentAccount) const;
520 void GetAccountAmounts(const std::string& strAccount, int64& nGenerated, int64& nReceived,
521 int64& nSent, int64& nFee) const;
523 bool IsFromMe() const
525 return (GetDebit() > 0);
528 bool IsConfirmed() const
530 // Quick answer in most cases
533 if (GetDepthInMainChain() >= 1)
535 if (!IsFromMe()) // using wtx's cached debit
538 // If no confirmations but it's from us, we can still
539 // consider it confirmed if all dependencies are confirmed
540 std::map<uint256, const CMerkleTx*> mapPrev;
541 std::vector<const CMerkleTx*> vWorkQueue;
542 vWorkQueue.reserve(vtxPrev.size()+1);
543 vWorkQueue.push_back(this);
544 for (int i = 0; i < vWorkQueue.size(); i++)
546 const CMerkleTx* ptx = vWorkQueue[i];
550 if (ptx->GetDepthInMainChain() >= 1)
552 if (!pwallet->IsFromMe(*ptx))
557 BOOST_FOREACH(const CMerkleTx& tx, vtxPrev)
558 mapPrev[tx.GetHash()] = &tx;
561 BOOST_FOREACH(const CTxIn& txin, ptx->vin)
563 if (!mapPrev.count(txin.prevout.hash))
565 vWorkQueue.push_back(mapPrev[txin.prevout.hash]);
573 int64 GetTxTime() const;
574 int GetRequestCount() const;
576 void AddSupportingTransactions(CTxDB& txdb);
578 bool AcceptWalletTransaction(CTxDB& txdb, bool fCheckInputs=true);
579 bool AcceptWalletTransaction();
581 void RelayWalletTransaction(CTxDB& txdb);
582 void RelayWalletTransaction();
586 /** Private key that includes an expiration date in case it never gets used. */
593 std::string strComment;
594 //// todo: add something to note what created it (user, getnewaddress, change)
595 //// maybe should have a map<string, string> property map
597 CWalletKey(int64 nExpires=0)
599 nTimeCreated = (nExpires ? GetTime() : 0);
600 nTimeExpires = nExpires;
605 if (!(nType & SER_GETHASH))
607 READWRITE(vchPrivKey);
608 READWRITE(nTimeCreated);
609 READWRITE(nTimeExpires);
610 READWRITE(strComment);
619 /** Account information.
620 * Stored in wallet with key "acc"+string account name.
625 std::vector<unsigned char> vchPubKey;
639 if (!(nType & SER_GETHASH))
641 READWRITE(vchPubKey);
647 /** Internal transfers.
648 * Database key is acentry<account><counter>.
650 class CAccountingEntry
653 std::string strAccount;
656 std::string strOtherAccount;
657 std::string strComment;
669 strOtherAccount.clear();
675 if (!(nType & SER_GETHASH))
677 // Note: strAccount is serialized as part of the key, not here.
678 READWRITE(nCreditDebit);
680 READWRITE(strOtherAccount);
681 READWRITE(strComment);
685 bool GetWalletFile(CWallet* pwallet, std::string &strWalletFileOut);