1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2011 The Bitcoin developers
3 // Copyright (c) 2011-2012 The PPCoin developers
4 // Distributed under the MIT/X11 software license, see the accompanying
5 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
6 #ifndef BITCOIN_WALLET_H
7 #define BITCOIN_WALLET_H
13 extern bool fWalletUnlockStakeOnly;
19 // A CWallet is an extension of a keystore, which also maintains a set of
20 // transactions and balances, and provides the ability to create new
22 class CWallet : public CCryptoKeyStore
25 bool SelectCoinsMinConf(int64 nTargetValue, unsigned int nSpendTime, int nConfMine, int nConfTheirs, std::set<std::pair<const CWalletTx*,unsigned int> >& setCoinsRet, int64& nValueRet) const;
26 bool SelectCoins(int64 nTargetValue, unsigned int nSpendTime, std::set<std::pair<const CWalletTx*,unsigned int> >& setCoinsRet, int64& nValueRet) const;
28 CWalletDB *pwalletdbEncryption;
31 mutable CCriticalSection cs_wallet;
34 std::string strWalletFile;
36 std::set<int64> setKeyPool;
38 typedef std::map<unsigned int, CMasterKey> MasterKeyMap;
39 MasterKeyMap mapMasterKeys;
40 unsigned int nMasterKeyMaxID;
46 pwalletdbEncryption = NULL;
48 CWallet(std::string strWalletFileIn)
50 strWalletFile = strWalletFileIn;
53 pwalletdbEncryption = NULL;
56 std::map<uint256, CWalletTx> mapWallet;
57 std::vector<uint256> vWalletUpdated;
59 std::map<uint256, int> mapRequestCount;
61 std::map<CBitcoinAddress, std::string> mapAddressBook;
63 std::vector<unsigned char> vchDefaultKey;
65 // keystore implementation
66 // Adds a key to the store, and saves it to disk.
67 bool AddKey(const CKey& key);
68 // Adds a key to the store, without saving it to disk (used by LoadWallet)
69 bool LoadKey(const CKey& key) { return CCryptoKeyStore::AddKey(key); }
71 // Adds an encrypted key to the store, and saves it to disk.
72 bool AddCryptedKey(const std::vector<unsigned char> &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
73 // Adds an encrypted key to the store, without saving it to disk (used by LoadWallet)
74 bool LoadCryptedKey(const std::vector<unsigned char> &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret) { return CCryptoKeyStore::AddCryptedKey(vchPubKey, vchCryptedSecret); }
76 bool Unlock(const SecureString& strWalletPassphrase);
77 bool ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase);
78 bool EncryptWallet(const SecureString& strWalletPassphrase);
80 bool AddToWallet(const CWalletTx& wtxIn);
81 bool AddToWalletIfInvolvingMe(const CTransaction& tx, const CBlock* pblock, bool fUpdate = false);
82 bool EraseFromWallet(uint256 hash);
83 void WalletUpdateSpent(const CTransaction& prevout);
84 int ScanForWalletTransactions(CBlockIndex* pindexStart, bool fUpdate = false);
85 void ReacceptWalletTransactions();
86 void ResendWalletTransactions();
87 int64 GetBalance() const;
88 int64 GetUnconfirmedBalance() const;
89 int64 GetStake() const;
90 bool CreateTransaction(const std::vector<std::pair<CScript, int64> >& vecSend, CWalletTx& wtxNew, CReserveKey& reservekey, int64& nFeeRet);
91 bool CreateTransaction(CScript scriptPubKey, int64 nValue, CWalletTx& wtxNew, CReserveKey& reservekey, int64& nFeeRet);
92 bool CreateCoinStake(CScript scriptPubKey, CTransaction& txNew);
93 bool CommitTransaction(CWalletTx& wtxNew, CReserveKey& reservekey);
94 bool BroadcastTransaction(CWalletTx& wtxNew);
95 std::string SendMoney(CScript scriptPubKey, int64 nValue, CWalletTx& wtxNew, bool fAskFee=false);
96 std::string SendMoneyToBitcoinAddress(const CBitcoinAddress& address, int64 nValue, CWalletTx& wtxNew, bool fAskFee=false);
100 void ReserveKeyFromKeyPool(int64& nIndex, CKeyPool& keypool);
101 void KeepKey(int64 nIndex);
102 void ReturnKey(int64 nIndex);
103 bool GetKeyFromPool(std::vector<unsigned char> &key, bool fAllowReuse=true);
104 int64 GetOldestKeyPoolTime();
106 bool IsMine(const CTxIn& txin) const;
107 int64 GetDebit(const CTxIn& txin) const;
108 bool IsMine(const CTxOut& txout) const
110 return ::IsMine(*this, txout.scriptPubKey);
112 int64 GetCredit(const CTxOut& txout) const
114 if (!MoneyRange(txout.nValue))
115 throw std::runtime_error("CWallet::GetCredit() : value out of range");
116 return (IsMine(txout) ? txout.nValue : 0);
118 bool IsChange(const CTxOut& txout) const
120 CBitcoinAddress address;
121 if (ExtractAddress(txout.scriptPubKey, this, address))
122 CRITICAL_BLOCK(cs_wallet)
123 if (!mapAddressBook.count(address))
127 int64 GetChange(const CTxOut& txout) const
129 if (!MoneyRange(txout.nValue))
130 throw std::runtime_error("CWallet::GetChange() : value out of range");
131 return (IsChange(txout) ? txout.nValue : 0);
133 bool IsMine(const CTransaction& tx) const
135 BOOST_FOREACH(const CTxOut& txout, tx.vout)
140 bool IsFromMe(const CTransaction& tx) const
142 return (GetDebit(tx) > 0);
144 int64 GetDebit(const CTransaction& tx) const
147 BOOST_FOREACH(const CTxIn& txin, tx.vin)
149 nDebit += GetDebit(txin);
150 if (!MoneyRange(nDebit))
151 throw std::runtime_error("CWallet::GetDebit() : value out of range");
155 int64 GetCredit(const CTransaction& tx) const
158 BOOST_FOREACH(const CTxOut& txout, tx.vout)
160 nCredit += GetCredit(txout);
161 if (!MoneyRange(nCredit))
162 throw std::runtime_error("CWallet::GetCredit() : value out of range");
166 int64 GetChange(const CTransaction& tx) const
169 BOOST_FOREACH(const CTxOut& txout, tx.vout)
171 nChange += GetChange(txout);
172 if (!MoneyRange(nChange))
173 throw std::runtime_error("CWallet::GetChange() : value out of range");
177 void SetBestChain(const CBlockLocator& loc)
179 CWalletDB walletdb(strWalletFile);
180 walletdb.WriteBestBlock(loc);
183 int LoadWallet(bool& fFirstRunRet);
184 // bool BackupWallet(const std::string& strDest);
186 bool SetAddressBookName(const CBitcoinAddress& address, const std::string& strName);
188 bool DelAddressBookName(const CBitcoinAddress& address);
190 void UpdatedTransaction(const uint256 &hashTx)
192 CRITICAL_BLOCK(cs_wallet)
193 vWalletUpdated.push_back(hashTx);
196 void PrintWallet(const CBlock& block);
198 void Inventory(const uint256 &hash)
200 CRITICAL_BLOCK(cs_wallet)
202 std::map<uint256, int>::iterator mi = mapRequestCount.find(hash);
203 if (mi != mapRequestCount.end())
210 return setKeyPool.size();
213 bool GetTransaction(const uint256 &hashTx, CWalletTx& wtx);
215 bool SetDefaultKey(const std::vector<unsigned char> &vchPubKey);
217 bool CheckSpentCoins(int& nMismatchSpent, int64& nBalanceInQuestion);
218 void FixSpentCoins(int& nMismatchSpent, int64& nBalanceInQuestion);
219 void DisableTransaction(const CTransaction &tx);
228 std::vector<unsigned char> vchPubKey;
230 CReserveKey(CWallet* pwalletIn)
243 std::vector<unsigned char> GetReservedKey();
249 // A transaction with a bunch of additional info that only the owner cares
250 // about. It includes any unrecorded transactions needed to link it back
251 // to the block chain.
253 class CWalletTx : public CMerkleTx
256 const CWallet* pwallet;
258 std::vector<CMerkleTx> vtxPrev;
259 std::map<std::string, std::string> mapValue;
260 std::vector<std::pair<std::string, std::string> > vOrderForm;
261 unsigned int fTimeReceivedIsTxTime;
262 unsigned int nTimeReceived; // time received by this node
264 std::string strFromAccount;
265 std::vector<char> vfSpent; // which outputs are already spent
268 mutable char fDebitCached;
269 mutable char fCreditCached;
270 mutable char fAvailableCreditCached;
271 mutable char fChangeCached;
272 mutable int64 nDebitCached;
273 mutable int64 nCreditCached;
274 mutable int64 nAvailableCreditCached;
275 mutable int64 nChangeCached;
277 // memory only UI hints
278 mutable unsigned int nTimeDisplayed;
279 mutable int nLinesDisplayed;
280 mutable char fConfirmedDisplayed;
287 CWalletTx(const CWallet* pwalletIn)
292 CWalletTx(const CWallet* pwalletIn, const CMerkleTx& txIn) : CMerkleTx(txIn)
297 CWalletTx(const CWallet* pwalletIn, const CTransaction& txIn) : CMerkleTx(txIn)
302 void Init(const CWallet* pwalletIn)
308 fTimeReceivedIsTxTime = false;
311 strFromAccount.clear();
313 fDebitCached = false;
314 fCreditCached = false;
315 fAvailableCreditCached = false;
316 fChangeCached = false;
319 nAvailableCreditCached = 0;
323 fConfirmedDisplayed = false;
328 CWalletTx* pthis = const_cast<CWalletTx*>(this);
335 pthis->mapValue["fromaccount"] = pthis->strFromAccount;
338 BOOST_FOREACH(char f, vfSpent)
340 str += (f ? '1' : '0');
344 pthis->mapValue["spent"] = str;
347 nSerSize += SerReadWrite(s, *(CMerkleTx*)this, nType, nVersion,ser_action);
350 READWRITE(vOrderForm);
351 READWRITE(fTimeReceivedIsTxTime);
352 READWRITE(nTimeReceived);
358 pthis->strFromAccount = pthis->mapValue["fromaccount"];
360 if (mapValue.count("spent"))
361 BOOST_FOREACH(char c, pthis->mapValue["spent"])
362 pthis->vfSpent.push_back(c != '0');
364 pthis->vfSpent.assign(vout.size(), fSpent);
367 pthis->mapValue.erase("fromaccount");
368 pthis->mapValue.erase("version");
369 pthis->mapValue.erase("spent");
372 // marks certain txout's as spent
373 // returns true if any update took place
374 bool UpdateSpent(const std::vector<char>& vfNewSpent)
376 bool fReturn = false;
377 for (int i=0; i < vfNewSpent.size(); i++)
379 if (i == vfSpent.size())
382 if (vfNewSpent[i] && !vfSpent[i])
386 fAvailableCreditCached = false;
392 // make sure balances are recalculated
395 fCreditCached = false;
396 fAvailableCreditCached = false;
397 fDebitCached = false;
398 fChangeCached = false;
401 void MarkSpent(unsigned int nOut)
403 if (nOut >= vout.size())
404 throw std::runtime_error("CWalletTx::MarkSpent() : nOut out of range");
405 vfSpent.resize(vout.size());
408 vfSpent[nOut] = true;
409 fAvailableCreditCached = false;
413 void MarkUnspent(unsigned int nOut)
415 if (nOut >= vout.size())
416 throw std::runtime_error("CWalletTx::MarkUnspent() : nOut out of range");
417 vfSpent.resize(vout.size());
420 vfSpent[nOut] = false;
421 fAvailableCreditCached = false;
425 bool IsSpent(unsigned int nOut) const
427 if (nOut >= vout.size())
428 throw std::runtime_error("CWalletTx::IsSpent() : nOut out of range");
429 if (nOut >= vfSpent.size())
431 return (!!vfSpent[nOut]);
434 int64 GetDebit() const
440 nDebitCached = pwallet->GetDebit(*this);
445 int64 GetCredit(bool fUseCache=true) const
447 // Must wait until coinbase is safely deep enough in the chain before valuing it
448 if ((IsCoinBase() || IsCoinStake()) && GetBlocksToMaturity() > 0)
451 // GetBalance can assume transactions in mapWallet won't change
452 if (fUseCache && fCreditCached)
453 return nCreditCached;
454 nCreditCached = pwallet->GetCredit(*this);
455 fCreditCached = true;
456 return nCreditCached;
459 int64 GetAvailableCredit(bool fUseCache=true) const
461 // Must wait until coinbase is safely deep enough in the chain before valuing it
462 if ((IsCoinBase() || IsCoinStake()) && GetBlocksToMaturity() > 0)
465 if (fUseCache && fAvailableCreditCached)
466 return nAvailableCreditCached;
469 for (int i = 0; i < vout.size(); i++)
473 const CTxOut &txout = vout[i];
474 nCredit += pwallet->GetCredit(txout);
475 if (!MoneyRange(nCredit))
476 throw std::runtime_error("CWalletTx::GetAvailableCredit() : value out of range");
480 nAvailableCreditCached = nCredit;
481 fAvailableCreditCached = true;
486 int64 GetChange() const
489 return nChangeCached;
490 nChangeCached = pwallet->GetChange(*this);
491 fChangeCached = true;
492 return nChangeCached;
495 void GetAmounts(int64& nGeneratedImmature, int64& nGeneratedMature, std::list<std::pair<CBitcoinAddress, int64> >& listReceived,
496 std::list<std::pair<CBitcoinAddress, int64> >& listSent, int64& nFee, std::string& strSentAccount) const;
498 void GetAccountAmounts(const std::string& strAccount, int64& nGenerated, int64& nReceived,
499 int64& nSent, int64& nFee) const;
501 bool IsFromMe() const
503 return (GetDebit() > 0);
506 bool IsConfirmed() const
508 // Quick answer in most cases
511 if (GetDepthInMainChain() >= 1)
513 if (!IsFromMe()) // using wtx's cached debit
516 // If no confirmations but it's from us, we can still
517 // consider it confirmed if all dependencies are confirmed
518 std::map<uint256, const CMerkleTx*> mapPrev;
519 std::vector<const CMerkleTx*> vWorkQueue;
520 vWorkQueue.reserve(vtxPrev.size()+1);
521 vWorkQueue.push_back(this);
522 for (int i = 0; i < vWorkQueue.size(); i++)
524 const CMerkleTx* ptx = vWorkQueue[i];
528 if (ptx->GetDepthInMainChain() >= 1)
530 if (!pwallet->IsFromMe(*ptx))
534 BOOST_FOREACH(const CMerkleTx& tx, vtxPrev)
535 mapPrev[tx.GetHash()] = &tx;
537 BOOST_FOREACH(const CTxIn& txin, ptx->vin)
539 if (!mapPrev.count(txin.prevout.hash))
541 vWorkQueue.push_back(mapPrev[txin.prevout.hash]);
549 int64 GetTxTime() const;
550 int GetRequestCount() const;
552 void AddSupportingTransactions(CTxDB& txdb);
554 bool AcceptWalletTransaction(CTxDB& txdb, bool fCheckInputs=true);
555 bool AcceptWalletTransaction();
557 void RelayWalletTransaction(CTxDB& txdb);
558 void RelayWalletTransaction();
563 // Private key that includes an expiration date in case it never gets used.
571 std::string strComment;
572 //// todo: add something to note what created it (user, getnewaddress, change)
573 //// maybe should have a map<string, string> property map
575 CWalletKey(int64 nExpires=0)
577 nTimeCreated = (nExpires ? GetTime() : 0);
578 nTimeExpires = nExpires;
583 if (!(nType & SER_GETHASH))
585 READWRITE(vchPrivKey);
586 READWRITE(nTimeCreated);
587 READWRITE(nTimeExpires);
588 READWRITE(strComment);
598 // Account information.
599 // Stored in wallet with key "acc"+string account name
604 std::vector<unsigned char> vchPubKey;
618 if (!(nType & SER_GETHASH))
620 READWRITE(vchPubKey);
627 // Internal transfers.
628 // Database key is acentry<account><counter>
630 class CAccountingEntry
633 std::string strAccount;
636 std::string strOtherAccount;
637 std::string strComment;
649 strOtherAccount.clear();
655 if (!(nType & SER_GETHASH))
657 // Note: strAccount is serialized as part of the key, not here.
658 READWRITE(nCreditDebit);
660 READWRITE(strOtherAccount);
661 READWRITE(strComment);
665 bool GetWalletFile(CWallet* pwallet, std::string &strWalletFileOut);