Bitcoin Core  24.1.0
P2P Digital Currency
txindex.h
Go to the documentation of this file.
1 // Copyright (c) 2017-2021 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_INDEX_TXINDEX_H
6 #define BITCOIN_INDEX_TXINDEX_H
7 
8 #include <index/base.h>
9 
15 class TxIndex final : public BaseIndex
16 {
17 protected:
18  class DB;
19 
20 private:
21  const std::unique_ptr<DB> m_db;
22 
23  bool AllowPrune() const override { return false; }
24 
25 protected:
26  bool CustomAppend(const interfaces::BlockInfo& block) override;
27 
28  BaseIndex::DB& GetDB() const override;
29 
30 public:
32  explicit TxIndex(std::unique_ptr<interfaces::Chain> chain, size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
33 
34  // Destructor is declared because this class contains a unique_ptr to an incomplete type.
35  virtual ~TxIndex() override;
36 
43  bool FindTx(const uint256& tx_hash, uint256& block_hash, CTransactionRef& tx) const;
44 };
45 
47 extern std::unique_ptr<TxIndex> g_txindex;
48 
49 #endif // BITCOIN_INDEX_TXINDEX_H
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:414
bool AllowPrune() const override
Definition: txindex.h:23
const std::unique_ptr< DB > m_db
Definition: txindex.h:18
Access to the txindex database (indexes/txindex/)
Definition: txindex.cpp:20
The database stores a block locator of the chain the database is synced to so that the index can effi...
Definition: base.h:43
Block data sent with blockConnected, blockDisconnected notifications.
Definition: chain.h:81
Base class for indices of blockchain data.
Definition: base.h:33
bool FindTx(const uint256 &tx_hash, uint256 &block_hash, CTransactionRef &tx) const
Look up a transaction by hash.
Definition: txindex.cpp:75
BaseIndex::DB & GetDB() const override
Definition: txindex.cpp:73
virtual ~TxIndex() override
256-bit opaque blob.
Definition: uint256.h:119
bool CustomAppend(const interfaces::BlockInfo &block) override
Write update index entries for a newly connected block.
Definition: txindex.cpp:57
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
Definition: txindex.cpp:16
TxIndex(std::unique_ptr< interfaces::Chain > chain, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
Constructs the index, which becomes available to be queried.
Definition: txindex.cpp:51
TxIndex is used to look up transactions included in the blockchain by hash.
Definition: txindex.h:15