Bitcoin ABC  0.22.13
P2P Digital Currency
txindex.h
Go to the documentation of this file.
1 // Copyright (c) 2017-2018 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 #include <txdb.h>
10 
11 #include <memory>
12 
18 class TxIndex final : public BaseIndex {
19 protected:
20  class DB;
21 
22 private:
23  const std::unique_ptr<DB> m_db;
24 
25 protected:
27  bool Init() override;
28 
29  bool WriteBlock(const CBlock &block, const CBlockIndex *pindex) override;
30 
31  BaseIndex::DB &GetDB() const override;
32 
33  const char *GetName() const override { return "txindex"; }
34 
35 public:
37  explicit TxIndex(size_t n_cache_size, bool f_memory = false,
38  bool f_wipe = false);
39 
40  // Destructor is declared because this class contains a unique_ptr to an
41  // incomplete type.
42  virtual ~TxIndex() override;
43 
51  bool FindTx(const TxId &txid, BlockHash &block_hash,
52  CTransactionRef &tx) const;
53 };
54 
56 extern std::unique_ptr<TxIndex> g_txindex;
57 
58 #endif // BITCOIN_INDEX_TXINDEX_H
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:336
bool WriteBlock(const CBlock &block, const CBlockIndex *pindex) override
Write update index entries for a newly connected block.
Definition: txindex.cpp:251
Definition: block.h:62
const char * GetName() const override
Get the name of the index for display in logs.
Definition: txindex.h:33
const std::unique_ptr< DB > m_db
Definition: txindex.h:20
bool Init() override
Override base class init to migrate from old database.
Definition: txindex.cpp:238
Access to the txindex database (indexes/txindex/)
Definition: txindex.cpp:54
bool FindTx(const TxId &txid, BlockHash &block_hash, CTransactionRef &tx) const
Look up a transaction by identifier.
Definition: txindex.cpp:272
Base class for indices of blockchain data.
Definition: base.h:21
BaseIndex::DB & GetDB() const override
Definition: txindex.cpp:268
TxIndex(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:233
virtual ~TxIndex() override
Definition: txindex.cpp:236
A BlockHash is a unqiue identifier for a block.
Definition: blockhash.h:13
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
Definition: txindex.cpp:21
The block chain is a tree shaped structure starting with the genesis block at the root...
Definition: blockindex.h:23
A TxId is the identifier of a transaction.
Definition: txid.h:14
TxIndex is used to look up transactions included in the blockchain by ID.
Definition: txindex.h:18