src/validationinterface.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2014 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or https://www.opensource.org/licenses/mit-license.php .
   5
   6 #ifndef BITCOIN_VALIDATIONINTERFACE_H
   7 #define BITCOIN_VALIDATIONINTERFACE_H
   8
   9 #include <boost/signals2/signal.hpp>
  10 #include <boost/shared_ptr.hpp>
  11
  12 #include "zcash/IncrementalMerkleTree.hpp"
  13
  14 class CBlock;
  15 class CBlockIndex;
  16 struct CBlockLocator;
  17 class CReserveScript;
  18 class CTransaction;
  19 class CValidationInterface;
  20 class CValidationState;
  21 class uint256;
  22
  23 // These functions dispatch to one or all registered wallets
  24
  25 /** Register a wallet to receive updates from core */
  26 void RegisterValidationInterface(CValidationInterface* pwalletIn);
  27 /** Unregister a wallet from core */
  28 void UnregisterValidationInterface(CValidationInterface* pwalletIn);
  29 /** Unregister all wallets from core */
  30 void UnregisterAllValidationInterfaces();
  31 /** Push an updated transaction to all registered wallets */
  32 void SyncWithWallets(const CTransaction& tx, const CBlock* pblock = NULL);
  33 /** Erase a transaction from all registered wallets */
  34 void EraseFromWallets(const uint256 &hash);
  35 /** Rescan all registered wallets */
  36 void RescanWallets();
  37
  38 class CValidationInterface {
  39 protected:
  40     virtual void UpdatedBlockTip(const CBlockIndex *pindex) {}
  41     virtual void SyncTransaction(const CTransaction &tx, const CBlock *pblock) {}
  42     virtual void EraseFromWallet(const uint256 &hash) {}
  43     virtual void RescanWallet() {}
  44     virtual void ChainTip(const CBlockIndex *pindex, const CBlock *pblock, SproutMerkleTree sproutTree, SaplingMerkleTree saplingTree, bool added) {}
  45     virtual void SetBestChain(const CBlockLocator &locator) {}
  46     virtual void UpdatedTransaction(const uint256 &hash) {}
  47     virtual void Inventory(const uint256 &hash) {}
  48     virtual void ResendWalletTransactions(int64_t nBestBlockTime) {}
  49     virtual void BlockChecked(const CBlock&, const CValidationState&) {}
  50     virtual void GetScriptForMining(boost::shared_ptr<CReserveScript>&) {};
  51     virtual void ResetRequestCount(const uint256 &hash) {};
  52     friend void ::RegisterValidationInterface(CValidationInterface*);
  53     friend void ::UnregisterValidationInterface(CValidationInterface*);
  54     friend void ::UnregisterAllValidationInterfaces();
  55 };
  56
  57 struct CMainSignals {
  58     /** Notifies listeners of updated block chain tip */
  59     boost::signals2::signal<void (const CBlockIndex *)> UpdatedBlockTip;
  60     /** Notifies listeners of updated transaction data (transaction, and optionally the block it is found in. */
  61     boost::signals2::signal<void (const CTransaction &, const CBlock *)> SyncTransaction;
  62     /** Notifies listeners of an erased transaction. */
  63     boost::signals2::signal<void (const uint256 &)> EraseTransaction;
  64     /** Notifies listeners of the need to rescan the wallet. */
  65     boost::signals2::signal<void ()> RescanWallet;
  66     /** Notifies listeners of an updated transaction without new data (for now: a coinbase potentially becoming visible). */
  67     boost::signals2::signal<void (const uint256 &)> UpdatedTransaction;
  68     /** Notifies listeners of a change to the tip of the active block chain. */
  69     boost::signals2::signal<void (const CBlockIndex *, const CBlock *, SproutMerkleTree, SaplingMerkleTree, bool)> ChainTip;
  70     /** Notifies listeners of a new active block chain. */
  71     boost::signals2::signal<void (const CBlockLocator &)> SetBestChain;
  72     /** Notifies listeners about an inventory item being seen on the network. */
  73     boost::signals2::signal<void (const uint256 &)> Inventory;
  74     /** Tells listeners to broadcast their data. */
  75     boost::signals2::signal<void (int64_t nBestBlockTime)> Broadcast;
  76     /** Notifies listeners of a block validation result */
  77     boost::signals2::signal<void (const CBlock&, const CValidationState&)> BlockChecked;
  78     /** Notifies listeners that a key for mining is required (coinbase) */
  79     boost::signals2::signal<void (boost::shared_ptr<CReserveScript>&)> ScriptForMining;
  80     /** Notifies listeners that a block has been successfully mined */
  81     boost::signals2::signal<void (const uint256 &)> BlockFound;
  82 };
  83
  84 CMainSignals& GetMainSignals();
  85
  86 #endif // BITCOIN_VALIDATIONINTERFACE_H