Bitcoin ABC  0.22.12
P2P Digital Currency
blockfilterindex.h
Go to the documentation of this file.
1 // Copyright (c) 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_BLOCKFILTERINDEX_H
6 #define BITCOIN_INDEX_BLOCKFILTERINDEX_H
7 
8 #include <blockfilter.h>
9 #include <chain.h>
10 #include <flatfile.h>
11 #include <index/base.h>
12 
14 static constexpr int CFCHECKPT_INTERVAL = 1000;
15 
17  size_t operator()(const uint256 &hash) const {
18  return ReadLE64(hash.begin());
19  }
20 };
21 
30 class BlockFilterIndex final : public BaseIndex {
31 private:
33  std::string m_name;
34  std::unique_ptr<BaseIndex::DB> m_db;
35 
37  std::unique_ptr<FlatFileSeq> m_filter_fileseq;
38 
39  bool ReadFilterFromDisk(const FlatFilePos &pos, BlockFilter &filter) const;
40  size_t WriteFilterToDisk(FlatFilePos &pos, const BlockFilter &filter);
41 
47  std::unordered_map<BlockHash, uint256, FilterHeaderHasher>
48  m_headers_cache GUARDED_BY(m_cs_headers_cache);
49 
50 protected:
51  bool Init() override;
52 
53  bool CommitInternal(CDBBatch &batch) override;
54 
55  bool WriteBlock(const CBlock &block, const CBlockIndex *pindex) override;
56 
57  bool Rewind(const CBlockIndex *current_tip,
58  const CBlockIndex *new_tip) override;
59 
60  BaseIndex::DB &GetDB() const override { return *m_db; }
61 
62  const char *GetName() const override { return m_name.c_str(); }
63 
64 public:
66  explicit BlockFilterIndex(BlockFilterType filter_type, size_t n_cache_size,
67  bool f_memory = false, bool f_wipe = false);
68 
69  BlockFilterType GetFilterType() const { return m_filter_type; }
70 
72  bool LookupFilter(const CBlockIndex *block_index,
73  BlockFilter &filter_out) const;
74 
76  bool LookupFilterHeader(const CBlockIndex *block_index,
77  uint256 &header_out);
78 
80  bool LookupFilterRange(int start_height, const CBlockIndex *stop_index,
81  std::vector<BlockFilter> &filters_out) const;
82 
84  bool LookupFilterHashRange(int start_height, const CBlockIndex *stop_index,
85  std::vector<uint256> &hashes_out) const;
86 };
87 
93 
95 void ForEachBlockFilterIndex(std::function<void(BlockFilterIndex &)> fn);
96 
102 bool InitBlockFilterIndex(BlockFilterType filter_type, size_t n_cache_size,
103  bool f_memory = false, bool f_wipe = false);
104 
110 bool DestroyBlockFilterIndex(BlockFilterType filter_type);
111 
114 
115 #endif // BITCOIN_INDEX_BLOCKFILTERINDEX_H
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
Batch of changes queued to be written to a CDBWrapper.
Definition: dbwrapper.h:48
void ForEachBlockFilterIndex(std::function< void(BlockFilterIndex &)> fn)
Iterate over all running block filter indexes, invoking fn on each.
Definition: block.h:62
std::unique_ptr< BaseIndex::DB > m_db
BlockFilterType
Definition: blockfilter.h:88
Base class for indices of blockchain data.
Definition: base.h:21
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:111
std::string m_name
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
uint8_t * begin()
Definition: uint256.h:76
BlockFilterType m_filter_type
static constexpr int CFCHECKPT_INTERVAL
Interval between compact filter checkpoints.
256-bit opaque blob.
Definition: uint256.h:120
bool InitBlockFilterIndex(BlockFilterType filter_type, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
Initialize a block filter index for the given type if one does not already exist. ...
The block chain is a tree shaped structure starting with the genesis block at the root...
Definition: blockindex.h:23
FlatFilePos m_next_filter_pos
bool DestroyBlockFilterIndex(BlockFilterType filter_type)
Destroy the block filter index with the given type.
BlockFilterType GetFilterType() const
size_t operator()(const uint256 &hash) const
BaseIndex::DB & GetDB() const override
#define GUARDED_BY(x)
Definition: threadsafety.h:45
std::unique_ptr< FlatFileSeq > m_filter_fileseq
static uint64_t ReadLE64(const uint8_t *ptr)
Definition: common.h:29
const char * GetName() const override
Get the name of the index for display in logs.