Branch data Line data Source code
1 : : // Copyright (c) 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 : : #include <index/txospenderindex.h>
6 : :
7 : : #include <common/args.h>
8 : : #include <crypto/siphash.h>
9 : : #include <dbwrapper.h>
10 : : #include <flatfile.h>
11 : : #include <index/base.h>
12 : : #include <index/disktxpos.h>
13 : : #include <interfaces/chain.h>
14 : : #include <logging.h>
15 : : #include <node/blockstorage.h>
16 : : #include <primitives/block.h>
17 : : #include <primitives/transaction.h>
18 : : #include <random.h>
19 : : #include <serialize.h>
20 : : #include <streams.h>
21 : : #include <tinyformat.h>
22 : : #include <uint256.h>
23 : : #include <util/fs.h>
24 : : #include <validation.h>
25 : :
26 : : #include <cstddef>
27 : : #include <cstdio>
28 : : #include <exception>
29 : : #include <ios>
30 : : #include <span>
31 : : #include <string>
32 : : #include <utility>
33 : : #include <vector>
34 : :
35 : : /* The database is used to find the spending transaction of a given utxo.
36 : : * For every input of every transaction it stores a key that is a pair(siphash(input outpoint), transaction location on disk) and a zero-byte value.
37 : : * To find the spending transaction of an outpoint, we perform a range query on siphash(outpoint), and for each returned key load the transaction
38 : : * and return it if it does spend the provided outpoint.
39 : : */
40 : :
41 : : // LevelDB key prefix. We only have one key for now but it will make it easier to add others if needed.
42 : : constexpr uint8_t DB_TXOSPENDERINDEX{'s'};
43 : :
44 : : std::unique_ptr<TxoSpenderIndex> g_txospenderindex;
45 : :
46 : : struct DBKey {
47 : : uint64_t hash;
48 : : CDiskTxPos pos;
49 : :
50 : 0 : explicit DBKey(const uint64_t& hash_in, const CDiskTxPos& pos_in) : hash(hash_in), pos(pos_in) {}
51 : :
52 : 0 : SERIALIZE_METHODS(DBKey, obj)
53 : : {
54 : 0 : uint8_t prefix{DB_TXOSPENDERINDEX};
55 : 0 : READWRITE(prefix);
56 [ # # ]: 0 : if (prefix != DB_TXOSPENDERINDEX) {
57 [ # # ]: 0 : throw std::ios_base::failure("Invalid format for spender index DB key");
58 : : }
59 : 0 : READWRITE(obj.hash);
60 : 0 : READWRITE(obj.pos);
61 : 0 : }
62 : : };
63 : :
64 : 0 : TxoSpenderIndex::TxoSpenderIndex(std::unique_ptr<interfaces::Chain> chain, size_t n_cache_size, bool f_memory, bool f_wipe)
65 [ # # # # : 0 : : BaseIndex(std::move(chain), "txospenderindex", "txospenderidx"), m_db{std::make_unique<DB>(gArgs.GetDataDirNet() / "indexes" / "txospenderindex" / "db", n_cache_size, f_memory, f_wipe)}
# # # # #
# # # #
# ]
66 : : {
67 [ # # # # ]: 0 : if (!m_db->Read("siphash_key", m_siphash_key)) {
68 : 0 : FastRandomContext rng(false);
69 [ # # ]: 0 : m_siphash_key = {rng.rand64(), rng.rand64()};
70 [ # # ]: 0 : m_db->Write("siphash_key", m_siphash_key, /*fSync=*/ true);
71 : 0 : }
72 : 0 : }
73 : :
74 : 0 : interfaces::Chain::NotifyOptions TxoSpenderIndex::CustomOptions()
75 : : {
76 : 0 : interfaces::Chain::NotifyOptions options;
77 : 0 : options.disconnect_data = true;
78 : 0 : return options;
79 : : }
80 : :
81 : 0 : static uint64_t CreateKeyPrefix(std::pair<uint64_t, uint64_t> siphash_key, const COutPoint& vout)
82 : : {
83 : 0 : return PresaltedSipHasher(siphash_key.first, siphash_key.second)(vout.hash.ToUint256(), vout.n);
84 : : }
85 : :
86 : 0 : static DBKey CreateKey(std::pair<uint64_t, uint64_t> siphash_key, const COutPoint& vout, const CDiskTxPos& pos)
87 : : {
88 : 0 : return DBKey(CreateKeyPrefix(siphash_key, vout), pos);
89 : : }
90 : :
91 : 0 : void TxoSpenderIndex::WriteSpenderInfos(const std::vector<std::pair<COutPoint, CDiskTxPos>>& items)
92 : : {
93 : 0 : CDBBatch batch(*m_db);
94 [ # # ]: 0 : for (const auto& [outpoint, pos] : items) {
95 : 0 : DBKey key(CreateKey(m_siphash_key, outpoint, pos));
96 : : // The key encodes the spent outpoint hash and disk position. The value is only a marker.
97 : : // Older entries may contain serialized empty strings; FindSpender() reads only keys.
98 [ # # ]: 0 : batch.Write(key, std::span<const std::byte>{});
99 : : }
100 [ # # ]: 0 : m_db->WriteBatch(batch);
101 : 0 : }
102 : :
103 : :
104 : 0 : void TxoSpenderIndex::EraseSpenderInfos(const std::vector<std::pair<COutPoint, CDiskTxPos>>& items)
105 : : {
106 : 0 : CDBBatch batch(*m_db);
107 [ # # ]: 0 : for (const auto& [outpoint, pos] : items) {
108 [ # # ]: 0 : batch.Erase(CreateKey(m_siphash_key, outpoint, pos));
109 : : }
110 [ # # ]: 0 : m_db->WriteBatch(batch);
111 : 0 : }
112 : :
113 : 0 : static std::vector<std::pair<COutPoint, CDiskTxPos>> BuildSpenderPositions(const interfaces::BlockInfo& block)
114 : : {
115 : 0 : std::vector<std::pair<COutPoint, CDiskTxPos>> items;
116 [ # # # # ]: 0 : items.reserve(block.data->vtx.size());
117 : :
118 [ # # # # ]: 0 : CDiskTxPos pos({block.file_number, block.data_pos}, GetSizeOfCompactSize(block.data->vtx.size()));
119 [ # # ]: 0 : for (const auto& tx : block.data->vtx) {
120 [ # # ]: 0 : if (!tx->IsCoinBase()) {
121 [ # # ]: 0 : for (const auto& input : tx->vin) {
122 [ # # ]: 0 : items.emplace_back(input.prevout, pos);
123 : : }
124 : : }
125 : 0 : pos.nTxOffset += ::GetSerializeSize(TX_WITH_WITNESS(*tx));
126 : : }
127 : :
128 : 0 : return items;
129 : 0 : }
130 : :
131 : :
132 : 0 : bool TxoSpenderIndex::CustomAppend(const interfaces::BlockInfo& block)
133 : : {
134 [ # # ]: 0 : WriteSpenderInfos(BuildSpenderPositions(block));
135 : 0 : return true;
136 : : }
137 : :
138 : 0 : bool TxoSpenderIndex::CustomRemove(const interfaces::BlockInfo& block)
139 : : {
140 [ # # ]: 0 : EraseSpenderInfos(BuildSpenderPositions(block));
141 : 0 : return true;
142 : : }
143 : :
144 : 0 : util::Expected<TxoSpender, std::string> TxoSpenderIndex::ReadTransaction(const CDiskTxPos& tx_pos) const
145 : : {
146 : 0 : AutoFile file{m_chainstate->m_blockman.OpenBlockFile(tx_pos, /*fReadOnly=*/true)};
147 [ # # ]: 0 : if (file.IsNull()) {
148 [ # # ]: 0 : return util::Unexpected("cannot open block");
149 : : }
150 : 0 : CBlockHeader header;
151 : 0 : TxoSpender spender;
152 : 0 : try {
153 [ # # ]: 0 : file >> header;
154 [ # # ]: 0 : file.seek(tx_pos.nTxOffset, SEEK_CUR);
155 [ # # ]: 0 : file >> TX_WITH_WITNESS(spender.tx);
156 [ # # ]: 0 : spender.block_hash = header.GetHash();
157 : 0 : return spender;
158 [ - - ]: 0 : } catch (const std::exception& e) {
159 [ - - ]: 0 : return util::Unexpected(e.what());
160 : 0 : }
161 : 0 : }
162 : :
163 : 0 : util::Expected<std::optional<TxoSpender>, std::string> TxoSpenderIndex::FindSpender(const COutPoint& txo) const
164 : : {
165 : 0 : const uint64_t prefix{CreateKeyPrefix(m_siphash_key, txo)};
166 [ # # ]: 0 : std::unique_ptr<CDBIterator> it(m_db->NewIterator());
167 : 0 : DBKey key(prefix, CDiskTxPos());
168 : :
169 : : // find all keys that start with the outpoint hash, load the transaction at the location specified in the key
170 : : // and return it if it does spend the provided outpoint
171 [ # # # # : 0 : for (it->Seek(std::pair{DB_TXOSPENDERINDEX, prefix}); it->Valid() && it->GetKey(key) && key.hash == prefix; it->Next()) {
# # # # #
# # # ]
172 [ # # # # ]: 0 : if (const auto spender{ReadTransaction(key.pos)}) {
173 [ # # ]: 0 : for (const auto& input : spender->tx->vin) {
174 [ # # ]: 0 : if (input.prevout == txo) {
175 : 0 : return std::optional{*spender};
176 : : }
177 : : }
178 : : } else {
179 [ # # ]: 0 : LogError("Deserialize or I/O error - %s", spender.error());
180 [ # # # # ]: 0 : return util::Unexpected{strprintf("IO error finding spending tx for outpoint %s:%d.", txo.hash.GetHex(), txo.n)};
181 [ # # ]: 0 : }
182 : : }
183 : 0 : return util::Expected<std::optional<TxoSpender>, std::string>(std::nullopt);
184 : 0 : }
185 : :
186 : 0 : BaseIndex::DB& TxoSpenderIndex::GetDB() const { return *m_db; }
|
