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);
207 bool SetAddressBookName(const CBitcoinAddress& address, const std::string& strName);
209 bool DelAddressBookName(const CBitcoinAddress& address);
211 void UpdatedTransaction(const uint256 &hashTx)
213 CRITICAL_BLOCK(cs_wallet)
214 vWalletUpdated.push_back(hashTx);
217 void PrintWallet(const CBlock& block);
219 void Inventory(const uint256 &hash)
221 CRITICAL_BLOCK(cs_wallet)
223 std::map<uint256, int>::iterator mi = mapRequestCount.find(hash);
224 if (mi != mapRequestCount.end())
231 return setKeyPool.size();
234 bool GetTransaction(const uint256 &hashTx, CWalletTx& wtx);
236 bool SetDefaultKey(const std::vector<unsigned char> &vchPubKey);
238 // signify that a particular wallet feature is now used. this may change nWalletVersion and nWalletMaxVersion if those are lower
239 bool SetMinVersion(enum WalletFeature, CWalletDB* pwalletdbIn = NULL, bool fExplicit = false);
241 // change which version we're allowed to upgrade to (note that this does not immediately imply upgrading to that format)
242 bool SetMaxVersion(int nVersion);
244 // get the current wallet format (the oldest client version guaranteed to understand this wallet)
245 int GetVersion() { return nWalletVersion; }
248 /** A key allocated from the key pool. */
254 std::vector<unsigned char> vchPubKey;
256 CReserveKey(CWallet* pwalletIn)
269 std::vector<unsigned char> GetReservedKey();
274 /** A transaction with a bunch of additional info that only the owner cares about.
275 * It includes any unrecorded transactions needed to link it back to the block chain.
277 class CWalletTx : public CMerkleTx
280 const CWallet* pwallet;
283 std::vector<CMerkleTx> vtxPrev;
284 std::map<std::string, std::string> mapValue;
285 std::vector<std::pair<std::string, std::string> > vOrderForm;
286 unsigned int fTimeReceivedIsTxTime;
287 unsigned int nTimeReceived; // time received by this node
289 std::string strFromAccount;
290 std::vector<char> vfSpent; // which outputs are already spent
293 mutable char fDebitCached;
294 mutable char fCreditCached;
295 mutable char fAvailableCreditCached;
296 mutable char fChangeCached;
297 mutable int64 nDebitCached;
298 mutable int64 nCreditCached;
299 mutable int64 nAvailableCreditCached;
300 mutable int64 nChangeCached;
302 // memory only UI hints
303 mutable unsigned int nTimeDisplayed;
304 mutable int nLinesDisplayed;
305 mutable char fConfirmedDisplayed;
312 CWalletTx(const CWallet* pwalletIn)
317 CWalletTx(const CWallet* pwalletIn, const CMerkleTx& txIn) : CMerkleTx(txIn)
322 CWalletTx(const CWallet* pwalletIn, const CTransaction& txIn) : CMerkleTx(txIn)
327 void Init(const CWallet* pwalletIn)
333 fTimeReceivedIsTxTime = false;
336 strFromAccount.clear();
338 fDebitCached = false;
339 fCreditCached = false;
340 fAvailableCreditCached = false;
341 fChangeCached = false;
344 nAvailableCreditCached = 0;
348 fConfirmedDisplayed = false;
353 CWalletTx* pthis = const_cast<CWalletTx*>(this);
360 pthis->mapValue["fromaccount"] = pthis->strFromAccount;
363 BOOST_FOREACH(char f, vfSpent)
365 str += (f ? '1' : '0');
369 pthis->mapValue["spent"] = str;
372 nSerSize += SerReadWrite(s, *(CMerkleTx*)this, nType, nVersion,ser_action);
375 READWRITE(vOrderForm);
376 READWRITE(fTimeReceivedIsTxTime);
377 READWRITE(nTimeReceived);
383 pthis->strFromAccount = pthis->mapValue["fromaccount"];
385 if (mapValue.count("spent"))
386 BOOST_FOREACH(char c, pthis->mapValue["spent"])
387 pthis->vfSpent.push_back(c != '0');
389 pthis->vfSpent.assign(vout.size(), fSpent);
392 pthis->mapValue.erase("fromaccount");
393 pthis->mapValue.erase("version");
394 pthis->mapValue.erase("spent");
397 // marks certain txout's as spent
398 // returns true if any update took place
399 bool UpdateSpent(const std::vector<char>& vfNewSpent)
401 bool fReturn = false;
402 for (unsigned int i = 0; i < vfNewSpent.size(); i++)
404 if (i == vfSpent.size())
407 if (vfNewSpent[i] && !vfSpent[i])
411 fAvailableCreditCached = false;
417 // make sure balances are recalculated
420 fCreditCached = false;
421 fAvailableCreditCached = false;
422 fDebitCached = false;
423 fChangeCached = false;
426 void BindWallet(CWallet *pwalletIn)
432 void MarkSpent(unsigned int nOut)
434 if (nOut >= vout.size())
435 throw std::runtime_error("CWalletTx::MarkSpent() : nOut out of range");
436 vfSpent.resize(vout.size());
439 vfSpent[nOut] = true;
440 fAvailableCreditCached = false;
444 bool IsSpent(unsigned int nOut) const
446 if (nOut >= vout.size())
447 throw std::runtime_error("CWalletTx::IsSpent() : nOut out of range");
448 if (nOut >= vfSpent.size())
450 return (!!vfSpent[nOut]);
453 int64 GetDebit() const
459 nDebitCached = pwallet->GetDebit(*this);
464 int64 GetCredit(bool fUseCache=true) const
466 // Must wait until coinbase is safely deep enough in the chain before valuing it
467 if (IsCoinBase() && GetBlocksToMaturity() > 0)
470 // GetBalance can assume transactions in mapWallet won't change
471 if (fUseCache && fCreditCached)
472 return nCreditCached;
473 nCreditCached = pwallet->GetCredit(*this);
474 fCreditCached = true;
475 return nCreditCached;
478 int64 GetAvailableCredit(bool fUseCache=true) const
480 // Must wait until coinbase is safely deep enough in the chain before valuing it
481 if (IsCoinBase() && GetBlocksToMaturity() > 0)
484 if (fUseCache && fAvailableCreditCached)
485 return nAvailableCreditCached;
488 for (unsigned int i = 0; i < vout.size(); i++)
492 const CTxOut &txout = vout[i];
493 nCredit += pwallet->GetCredit(txout);
494 if (!MoneyRange(nCredit))
495 throw std::runtime_error("CWalletTx::GetAvailableCredit() : value out of range");
499 nAvailableCreditCached = nCredit;
500 fAvailableCreditCached = true;
505 int64 GetChange() const
508 return nChangeCached;
509 nChangeCached = pwallet->GetChange(*this);
510 fChangeCached = true;
511 return nChangeCached;
514 void GetAmounts(int64& nGeneratedImmature, int64& nGeneratedMature, std::list<std::pair<CBitcoinAddress, int64> >& listReceived,
515 std::list<std::pair<CBitcoinAddress, int64> >& listSent, int64& nFee, std::string& strSentAccount) const;
517 void GetAccountAmounts(const std::string& strAccount, int64& nGenerated, int64& nReceived,
518 int64& nSent, int64& nFee) const;
520 bool IsFromMe() const
522 return (GetDebit() > 0);
525 bool IsConfirmed() const
527 // Quick answer in most cases
530 if (GetDepthInMainChain() >= 1)
532 if (!IsFromMe()) // using wtx's cached debit
535 // If no confirmations but it's from us, we can still
536 // consider it confirmed if all dependencies are confirmed
537 std::map<uint256, const CMerkleTx*> mapPrev;
538 std::vector<const CMerkleTx*> vWorkQueue;
539 vWorkQueue.reserve(vtxPrev.size()+1);
540 vWorkQueue.push_back(this);
541 for (unsigned int i = 0; i < vWorkQueue.size(); i++)
543 const CMerkleTx* ptx = vWorkQueue[i];
547 if (ptx->GetDepthInMainChain() >= 1)
549 if (!pwallet->IsFromMe(*ptx))
554 BOOST_FOREACH(const CMerkleTx& tx, vtxPrev)
555 mapPrev[tx.GetHash()] = &tx;
558 BOOST_FOREACH(const CTxIn& txin, ptx->vin)
560 if (!mapPrev.count(txin.prevout.hash))
562 vWorkQueue.push_back(mapPrev[txin.prevout.hash]);
570 int64 GetTxTime() const;
571 int GetRequestCount() const;
573 void AddSupportingTransactions(CTxDB& txdb);
575 bool AcceptWalletTransaction(CTxDB& txdb, bool fCheckInputs=true);
576 bool AcceptWalletTransaction();
578 void RelayWalletTransaction(CTxDB& txdb);
579 void RelayWalletTransaction();
583 /** Private key that includes an expiration date in case it never gets used. */
590 std::string strComment;
591 //// todo: add something to note what created it (user, getnewaddress, change)
592 //// maybe should have a map<string, string> property map
594 CWalletKey(int64 nExpires=0)
596 nTimeCreated = (nExpires ? GetTime() : 0);
597 nTimeExpires = nExpires;
602 if (!(nType & SER_GETHASH))
604 READWRITE(vchPrivKey);
605 READWRITE(nTimeCreated);
606 READWRITE(nTimeExpires);
607 READWRITE(strComment);
616 /** Account information.
617 * Stored in wallet with key "acc"+string account name.
622 std::vector<unsigned char> vchPubKey;
636 if (!(nType & SER_GETHASH))
638 READWRITE(vchPubKey);
644 /** Internal transfers.
645 * Database key is acentry<account><counter>.
647 class CAccountingEntry
650 std::string strAccount;
653 std::string strOtherAccount;
654 std::string strComment;
666 strOtherAccount.clear();
672 if (!(nType & SER_GETHASH))
674 // Note: strAccount is serialized as part of the key, not here.
675 READWRITE(nCreditDebit);
677 READWRITE(strOtherAccount);
678 READWRITE(strComment);
682 bool GetWalletFile(CWallet* pwallet, std::string &strWalletFileOut);