src/wallet.h

   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
   8
   9 #include "bignum.h"
  10 #include "key.h"
  11 #include "script.h"
  12
  13 extern bool fWalletUnlockStakeOnly;
  14
  15 class CWalletTx;
  16 class CReserveKey;
  17 class CWalletDB;
  18
  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
  21 // transactions
  22 class CWallet : public CCryptoKeyStore
  23 {
  24 private:
  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;
  27
  28     CWalletDB *pwalletdbEncryption;
  29
  30 public:
  31     mutable CCriticalSection cs_wallet;
  32
  33     bool fFileBacked;
  34     std::string strWalletFile;
  35
  36     std::set<int64> setKeyPool;
  37
  38     typedef std::map<unsigned int, CMasterKey> MasterKeyMap;
  39     MasterKeyMap mapMasterKeys;
  40     unsigned int nMasterKeyMaxID;
  41
  42     CWallet()
  43     {
  44         fFileBacked = false;
  45         nMasterKeyMaxID = 0;
  46         pwalletdbEncryption = NULL;
  47     }
  48     CWallet(std::string strWalletFileIn)
  49     {
  50         strWalletFile = strWalletFileIn;
  51         fFileBacked = true;
  52         nMasterKeyMaxID = 0;
  53         pwalletdbEncryption = NULL;
  54     }
  55
  56     std::map<uint256, CWalletTx> mapWallet;
  57     std::vector<uint256> vWalletUpdated;
  58
  59     std::map<uint256, int> mapRequestCount;
  60
  61     std::map<CBitcoinAddress, std::string> mapAddressBook;
  62
  63     std::vector<unsigned char> vchDefaultKey;
  64
  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); }
  70
  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); }
  75
  76     bool Unlock(const SecureString& strWalletPassphrase);
  77     bool ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase);
  78     bool EncryptWallet(const SecureString& strWalletPassphrase);
  79
  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);
  97
  98     bool NewKeyPool();
  99     bool TopUpKeyPool();
 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();
 105
 106     bool IsMine(const CTxIn& txin) const;
 107     int64 GetDebit(const CTxIn& txin) const;
 108     bool IsMine(const CTxOut& txout) const
 109     {
 110         return ::IsMine(*this, txout.scriptPubKey);
 111     }
 112     int64 GetCredit(const CTxOut& txout) const
 113     {
 114         if (!MoneyRange(txout.nValue))
 115             throw std::runtime_error("CWallet::GetCredit() : value out of range");
 116         return (IsMine(txout) ? txout.nValue : 0);
 117     }
 118     bool IsChange(const CTxOut& txout) const
 119     {
 120         CBitcoinAddress address;
 121         if (ExtractAddress(txout.scriptPubKey, this, address))
 122             CRITICAL_BLOCK(cs_wallet)
 123                 if (!mapAddressBook.count(address))
 124                     return true;
 125         return false;
 126     }
 127     int64 GetChange(const CTxOut& txout) const
 128     {
 129         if (!MoneyRange(txout.nValue))
 130             throw std::runtime_error("CWallet::GetChange() : value out of range");
 131         return (IsChange(txout) ? txout.nValue : 0);
 132     }
 133     bool IsMine(const CTransaction& tx) const
 134     {
 135         BOOST_FOREACH(const CTxOut& txout, tx.vout)
 136             if (IsMine(txout))
 137                 return true;
 138         return false;
 139     }
 140     bool IsFromMe(const CTransaction& tx) const
 141     {
 142         return (GetDebit(tx) > 0);
 143     }
 144     int64 GetDebit(const CTransaction& tx) const
 145     {
 146         int64 nDebit = 0;
 147         BOOST_FOREACH(const CTxIn& txin, tx.vin)
 148         {
 149             nDebit += GetDebit(txin);
 150             if (!MoneyRange(nDebit))
 151                 throw std::runtime_error("CWallet::GetDebit() : value out of range");
 152         }
 153         return nDebit;
 154     }
 155     int64 GetCredit(const CTransaction& tx) const
 156     {
 157         int64 nCredit = 0;
 158         BOOST_FOREACH(const CTxOut& txout, tx.vout)
 159         {
 160             nCredit += GetCredit(txout);
 161             if (!MoneyRange(nCredit))
 162                 throw std::runtime_error("CWallet::GetCredit() : value out of range");
 163         }
 164         return nCredit;
 165     }
 166     int64 GetChange(const CTransaction& tx) const
 167     {
 168         int64 nChange = 0;
 169         BOOST_FOREACH(const CTxOut& txout, tx.vout)
 170         {
 171             nChange += GetChange(txout);
 172             if (!MoneyRange(nChange))
 173                 throw std::runtime_error("CWallet::GetChange() : value out of range");
 174         }
 175         return nChange;
 176     }
 177     void SetBestChain(const CBlockLocator& loc)
 178     {
 179         CWalletDB walletdb(strWalletFile);
 180         walletdb.WriteBestBlock(loc);
 181     }
 182
 183     int LoadWallet(bool& fFirstRunRet);
 184 //    bool BackupWallet(const std::string& strDest);
 185
 186     bool SetAddressBookName(const CBitcoinAddress& address, const std::string& strName);
 187
 188     bool DelAddressBookName(const CBitcoinAddress& address);
 189
 190     void UpdatedTransaction(const uint256 &hashTx)
 191     {
 192         CRITICAL_BLOCK(cs_wallet)
 193             vWalletUpdated.push_back(hashTx);
 194     }
 195
 196     void PrintWallet(const CBlock& block);
 197
 198     void Inventory(const uint256 &hash)
 199     {
 200         CRITICAL_BLOCK(cs_wallet)
 201         {
 202             std::map<uint256, int>::iterator mi = mapRequestCount.find(hash);
 203             if (mi != mapRequestCount.end())
 204                 (*mi).second++;
 205         }
 206     }
 207
 208     int GetKeyPoolSize()
 209     {
 210         return setKeyPool.size();
 211     }
 212
 213     bool GetTransaction(const uint256 &hashTx, CWalletTx& wtx);
 214
 215     bool SetDefaultKey(const std::vector<unsigned char> &vchPubKey);
 216
 217     bool CheckSpentCoins(int& nMismatchSpent, int64& nBalanceInQuestion);
 218 };
 219
 220
 221 class CReserveKey
 222 {
 223 protected:
 224     CWallet* pwallet;
 225     int64 nIndex;
 226     std::vector<unsigned char> vchPubKey;
 227 public:
 228     CReserveKey(CWallet* pwalletIn)
 229     {
 230         nIndex = -1;
 231         pwallet = pwalletIn;
 232     }
 233
 234     ~CReserveKey()
 235     {
 236         if (!fShutdown)
 237             ReturnKey();
 238     }
 239
 240     void ReturnKey();
 241     std::vector<unsigned char> GetReservedKey();
 242     void KeepKey();
 243 };
 244
 245
 246 //
 247 // A transaction with a bunch of additional info that only the owner cares
 248 // about.  It includes any unrecorded transactions needed to link it back
 249 // to the block chain.
 250 //
 251 class CWalletTx : public CMerkleTx
 252 {
 253 public:
 254     const CWallet* pwallet;
 255
 256     std::vector<CMerkleTx> vtxPrev;
 257     std::map<std::string, std::string> mapValue;
 258     std::vector<std::pair<std::string, std::string> > vOrderForm;
 259     unsigned int fTimeReceivedIsTxTime;
 260     unsigned int nTimeReceived;  // time received by this node
 261     char fFromMe;
 262     std::string strFromAccount;
 263     std::vector<char> vfSpent; // which outputs are already spent
 264
 265     // memory only
 266     mutable char fDebitCached;
 267     mutable char fCreditCached;
 268     mutable char fAvailableCreditCached;
 269     mutable char fChangeCached;
 270     mutable int64 nDebitCached;
 271     mutable int64 nCreditCached;
 272     mutable int64 nAvailableCreditCached;
 273     mutable int64 nChangeCached;
 274
 275     // memory only UI hints
 276     mutable unsigned int nTimeDisplayed;
 277     mutable int nLinesDisplayed;
 278     mutable char fConfirmedDisplayed;
 279
 280     CWalletTx()
 281     {
 282         Init(NULL);
 283     }
 284
 285     CWalletTx(const CWallet* pwalletIn)
 286     {
 287         Init(pwalletIn);
 288     }
 289
 290     CWalletTx(const CWallet* pwalletIn, const CMerkleTx& txIn) : CMerkleTx(txIn)
 291     {
 292         Init(pwalletIn);
 293     }
 294
 295     CWalletTx(const CWallet* pwalletIn, const CTransaction& txIn) : CMerkleTx(txIn)
 296     {
 297         Init(pwalletIn);
 298     }
 299
 300     void Init(const CWallet* pwalletIn)
 301     {
 302         pwallet = pwalletIn;
 303         vtxPrev.clear();
 304         mapValue.clear();
 305         vOrderForm.clear();
 306         fTimeReceivedIsTxTime = false;
 307         nTimeReceived = 0;
 308         fFromMe = false;
 309         strFromAccount.clear();
 310         vfSpent.clear();
 311         fDebitCached = false;
 312         fCreditCached = false;
 313         fAvailableCreditCached = false;
 314         fChangeCached = false;
 315         nDebitCached = 0;
 316         nCreditCached = 0;
 317         nAvailableCreditCached = 0;
 318         nChangeCached = 0;
 319         nTimeDisplayed = 0;
 320         nLinesDisplayed = 0;
 321         fConfirmedDisplayed = false;
 322     }
 323
 324     IMPLEMENT_SERIALIZE
 325     (
 326         CWalletTx* pthis = const_cast<CWalletTx*>(this);
 327         if (fRead)
 328             pthis->Init(NULL);
 329         char fSpent = false;
 330
 331         if (!fRead)
 332         {
 333             pthis->mapValue["fromaccount"] = pthis->strFromAccount;
 334
 335             std::string str;
 336             BOOST_FOREACH(char f, vfSpent)
 337             {
 338                 str += (f ? '1' : '0');
 339                 if (f)
 340                     fSpent = true;
 341             }
 342             pthis->mapValue["spent"] = str;
 343         }
 344
 345         nSerSize += SerReadWrite(s, *(CMerkleTx*)this, nType, nVersion,ser_action);
 346         READWRITE(vtxPrev);
 347         READWRITE(mapValue);
 348         READWRITE(vOrderForm);
 349         READWRITE(fTimeReceivedIsTxTime);
 350         READWRITE(nTimeReceived);
 351         READWRITE(fFromMe);
 352         READWRITE(fSpent);
 353
 354         if (fRead)
 355         {
 356             pthis->strFromAccount = pthis->mapValue["fromaccount"];
 357
 358             if (mapValue.count("spent"))
 359                 BOOST_FOREACH(char c, pthis->mapValue["spent"])
 360                     pthis->vfSpent.push_back(c != '0');
 361             else
 362                 pthis->vfSpent.assign(vout.size(), fSpent);
 363         }
 364
 365         pthis->mapValue.erase("fromaccount");
 366         pthis->mapValue.erase("version");
 367         pthis->mapValue.erase("spent");
 368     )
 369
 370     // marks certain txout's as spent
 371     // returns true if any update took place
 372     bool UpdateSpent(const std::vector<char>& vfNewSpent)
 373     {
 374         bool fReturn = false;
 375         for (int i=0; i < vfNewSpent.size(); i++)
 376         {
 377             if (i == vfSpent.size())
 378                 break;
 379
 380             if (vfNewSpent[i] && !vfSpent[i])
 381             {
 382                 vfSpent[i] = true;
 383                 fReturn = true;
 384                 fAvailableCreditCached = false;
 385             }
 386         }
 387         return fReturn;
 388     }
 389
 390     // make sure balances are recalculated
 391     void MarkDirty()
 392     {
 393         fCreditCached = false;
 394         fAvailableCreditCached = false;
 395         fDebitCached = false;
 396         fChangeCached = false;
 397     }
 398
 399     void MarkSpent(unsigned int nOut)
 400     {
 401         if (nOut >= vout.size())
 402             throw std::runtime_error("CWalletTx::MarkSpent() : nOut out of range");
 403         vfSpent.resize(vout.size());
 404         if (!vfSpent[nOut])
 405         {
 406             vfSpent[nOut] = true;
 407             fAvailableCreditCached = false;
 408         }
 409     }
 410
 411     bool IsSpent(unsigned int nOut) const
 412     {
 413         if (nOut >= vout.size())
 414             throw std::runtime_error("CWalletTx::IsSpent() : nOut out of range");
 415         if (nOut >= vfSpent.size())
 416             return false;
 417         return (!!vfSpent[nOut]);
 418     }
 419
 420     int64 GetDebit() const
 421     {
 422         if (vin.empty())
 423             return 0;
 424         if (fDebitCached)
 425             return nDebitCached;
 426         nDebitCached = pwallet->GetDebit(*this);
 427         fDebitCached = true;
 428         return nDebitCached;
 429     }
 430
 431     int64 GetCredit(bool fUseCache=true) const
 432     {
 433         // Must wait until coinbase is safely deep enough in the chain before valuing it
 434         if ((IsCoinBase() || IsCoinStake()) && GetBlocksToMaturity() > 0)
 435             return 0;
 436
 437         // GetBalance can assume transactions in mapWallet won't change
 438         if (fUseCache && fCreditCached)
 439             return nCreditCached;
 440         nCreditCached = pwallet->GetCredit(*this);
 441         fCreditCached = true;
 442         return nCreditCached;
 443     }
 444
 445     int64 GetAvailableCredit(bool fUseCache=true) const
 446     {
 447         // Must wait until coinbase is safely deep enough in the chain before valuing it
 448         if ((IsCoinBase() || IsCoinStake()) && GetBlocksToMaturity() > 0)
 449             return 0;
 450
 451         if (fUseCache && fAvailableCreditCached)
 452             return nAvailableCreditCached;
 453
 454         int64 nCredit = 0;
 455         for (int i = 0; i < vout.size(); i++)
 456         {
 457             if (!IsSpent(i))
 458             {
 459                 const CTxOut &txout = vout[i];
 460                 nCredit += pwallet->GetCredit(txout);
 461                 if (!MoneyRange(nCredit))
 462                     throw std::runtime_error("CWalletTx::GetAvailableCredit() : value out of range");
 463             }
 464         }
 465
 466         nAvailableCreditCached = nCredit;
 467         fAvailableCreditCached = true;
 468         return nCredit;
 469     }
 470
 471
 472     int64 GetChange() const
 473     {
 474         if (fChangeCached)
 475             return nChangeCached;
 476         nChangeCached = pwallet->GetChange(*this);
 477         fChangeCached = true;
 478         return nChangeCached;
 479     }
 480
 481     void GetAmounts(int64& nGeneratedImmature, int64& nGeneratedMature, std::list<std::pair<CBitcoinAddress, int64> >& listReceived,
 482                     std::list<std::pair<CBitcoinAddress, int64> >& listSent, int64& nFee, std::string& strSentAccount) const;
 483
 484     void GetAccountAmounts(const std::string& strAccount, int64& nGenerated, int64& nReceived,
 485                            int64& nSent, int64& nFee) const;
 486
 487     bool IsFromMe() const
 488     {
 489         return (GetDebit() > 0);
 490     }
 491
 492     bool IsConfirmed() const
 493     {
 494         // Quick answer in most cases
 495         if (!IsFinal())
 496             return false;
 497         if (GetDepthInMainChain() >= 1)
 498             return true;
 499         if (!IsFromMe()) // using wtx's cached debit
 500             return false;
 501
 502         // If no confirmations but it's from us, we can still
 503         // consider it confirmed if all dependencies are confirmed
 504         std::map<uint256, const CMerkleTx*> mapPrev;
 505         std::vector<const CMerkleTx*> vWorkQueue;
 506         vWorkQueue.reserve(vtxPrev.size()+1);
 507         vWorkQueue.push_back(this);
 508         for (int i = 0; i < vWorkQueue.size(); i++)
 509         {
 510             const CMerkleTx* ptx = vWorkQueue[i];
 511
 512             if (!ptx->IsFinal())
 513                 return false;
 514             if (ptx->GetDepthInMainChain() >= 1)
 515                 continue;
 516             if (!pwallet->IsFromMe(*ptx))
 517                 return false;
 518
 519             if (mapPrev.empty())
 520                 BOOST_FOREACH(const CMerkleTx& tx, vtxPrev)
 521                     mapPrev[tx.GetHash()] = &tx;
 522
 523             BOOST_FOREACH(const CTxIn& txin, ptx->vin)
 524             {
 525                 if (!mapPrev.count(txin.prevout.hash))
 526                     return false;
 527                 vWorkQueue.push_back(mapPrev[txin.prevout.hash]);
 528             }
 529         }
 530         return true;
 531     }
 532
 533     bool WriteToDisk();
 534
 535     int64 GetTxTime() const;
 536     int GetRequestCount() const;
 537
 538     void AddSupportingTransactions(CTxDB& txdb);
 539
 540     bool AcceptWalletTransaction(CTxDB& txdb, bool fCheckInputs=true);
 541     bool AcceptWalletTransaction();
 542
 543     void RelayWalletTransaction(CTxDB& txdb);
 544     void RelayWalletTransaction();
 545 };
 546
 547
 548 //
 549 // Private key that includes an expiration date in case it never gets used.
 550 //
 551 class CWalletKey
 552 {
 553 public:
 554     CPrivKey vchPrivKey;
 555     int64 nTimeCreated;
 556     int64 nTimeExpires;
 557     std::string strComment;
 558     //// todo: add something to note what created it (user, getnewaddress, change)
 559     ////   maybe should have a map<string, string> property map
 560
 561     CWalletKey(int64 nExpires=0)
 562     {
 563         nTimeCreated = (nExpires ? GetTime() : 0);
 564         nTimeExpires = nExpires;
 565     }
 566
 567     IMPLEMENT_SERIALIZE
 568     (
 569         if (!(nType & SER_GETHASH))
 570             READWRITE(nVersion);
 571         READWRITE(vchPrivKey);
 572         READWRITE(nTimeCreated);
 573         READWRITE(nTimeExpires);
 574         READWRITE(strComment);
 575     )
 576 };
 577
 578
 579
 580
 581
 582
 583 //
 584 // Account information.
 585 // Stored in wallet with key "acc"+string account name
 586 //
 587 class CAccount
 588 {
 589 public:
 590     std::vector<unsigned char> vchPubKey;
 591
 592     CAccount()
 593     {
 594         SetNull();
 595     }
 596
 597     void SetNull()
 598     {
 599         vchPubKey.clear();
 600     }
 601
 602     IMPLEMENT_SERIALIZE
 603     (
 604         if (!(nType & SER_GETHASH))
 605             READWRITE(nVersion);
 606         READWRITE(vchPubKey);
 607     )
 608 };
 609
 610
 611
 612 //
 613 // Internal transfers.
 614 // Database key is acentry<account><counter>
 615 //
 616 class CAccountingEntry
 617 {
 618 public:
 619     std::string strAccount;
 620     int64 nCreditDebit;
 621     int64 nTime;
 622     std::string strOtherAccount;
 623     std::string strComment;
 624
 625     CAccountingEntry()
 626     {
 627         SetNull();
 628     }
 629
 630     void SetNull()
 631     {
 632         nCreditDebit = 0;
 633         nTime = 0;
 634         strAccount.clear();
 635         strOtherAccount.clear();
 636         strComment.clear();
 637     }
 638
 639     IMPLEMENT_SERIALIZE
 640     (
 641         if (!(nType & SER_GETHASH))
 642             READWRITE(nVersion);
 643         // Note: strAccount is serialized as part of the key, not here.
 644         READWRITE(nCreditDebit);
 645         READWRITE(nTime);
 646         READWRITE(strOtherAccount);
 647         READWRITE(strComment);
 648     )
 649 };
 650
 651 bool GetWalletFile(CWallet* pwallet, std::string &strWalletFileOut);
 652
 653 #endif