src/validationinterface.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2015 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://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 class CBlock;
  13 class CBlockIndex;
  14 struct CBlockLocator;
  15 class CBlockIndex;
  16 class CConnman;
  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
  32 class CValidationInterface {
  33 protected:
  34     virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) {}
  35     virtual void SyncTransaction(const CTransaction &tx, const CBlockIndex *pindex, int posInBlock) {}
  36     virtual void SetBestChain(const CBlockLocator &locator) {}
  37     virtual void UpdatedTransaction(const uint256 &hash) {}
  38     virtual void Inventory(const uint256 &hash) {}
  39     virtual void ResendWalletTransactions(int64_t nBestBlockTime, CConnman* connman) {}
  40     virtual void BlockChecked(const CBlock&, const CValidationState&) {}
  41     virtual void GetScriptForMining(boost::shared_ptr<CReserveScript>&) {};
  42     virtual void ResetRequestCount(const uint256 &hash) {};
  43     friend void ::RegisterValidationInterface(CValidationInterface*);
  44     friend void ::UnregisterValidationInterface(CValidationInterface*);
  45     friend void ::UnregisterAllValidationInterfaces();
  46 };
  47
  48 struct CMainSignals {
  49     /** Notifies listeners of updated block chain tip */
  50     boost::signals2::signal<void (const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)> UpdatedBlockTip;
  51     /** A posInBlock value for SyncTransaction which indicates the transaction was conflicted, disconnected, or not in a block */
  52     static const int SYNC_TRANSACTION_NOT_IN_BLOCK = -1;
  53     /** Notifies listeners of updated transaction data (transaction, and optionally the block it is found in. */
  54     boost::signals2::signal<void (const CTransaction &, const CBlockIndex *pindex, int posInBlock)> SyncTransaction;
  55     /** Notifies listeners of an updated transaction without new data (for now: a coinbase potentially becoming visible). */
  56     boost::signals2::signal<void (const uint256 &)> UpdatedTransaction;
  57     /** Notifies listeners of a new active block chain. */
  58     boost::signals2::signal<void (const CBlockLocator &)> SetBestChain;
  59     /** Notifies listeners about an inventory item being seen on the network. */
  60     boost::signals2::signal<void (const uint256 &)> Inventory;
  61     /** Tells listeners to broadcast their data. */
  62     boost::signals2::signal<void (int64_t nBestBlockTime, CConnman* connman)> Broadcast;
  63     /** Notifies listeners of a block validation result */
  64     boost::signals2::signal<void (const CBlock&, const CValidationState&)> BlockChecked;
  65     /** Notifies listeners that a key for mining is required (coinbase) */
  66     boost::signals2::signal<void (boost::shared_ptr<CReserveScript>&)> ScriptForMining;
  67     /** Notifies listeners that a block has been successfully mined */
  68     boost::signals2::signal<void (const uint256 &)> BlockFound;
  69 };
  70
  71 CMainSignals& GetMainSignals();
  72
  73 #endif // BITCOIN_VALIDATIONINTERFACE_H