Branch data Line data Source code
1 : : // Copyright (c) 2018-present 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_INTERFACES_CHAIN_H
6 : : #define BITCOIN_INTERFACES_CHAIN_H
7 : :
8 : : #include <blockfilter.h>
9 : : #include <common/settings.h>
10 : : #include <kernel/chain.h> // IWYU pragma: export
11 : : #include <node/types.h>
12 : : #include <primitives/transaction.h>
13 : : #include <util/expected.h>
14 : : #include <util/fees.h>
15 : : #include <util/result.h>
16 : :
17 : : #include <cstddef>
18 : : #include <cstdint>
19 : : #include <functional>
20 : : #include <map>
21 : : #include <memory>
22 : : #include <optional>
23 : : #include <string>
24 : : #include <vector>
25 : :
26 : : class ArgsManager;
27 : : class CBlock;
28 : : class CBlockUndo;
29 : : class CFeeRate;
30 : : class CRPCCommand;
31 : : class CScheduler;
32 : : class Coin;
33 : : class uint256;
34 : : enum class MemPoolRemovalReason;
35 : : enum class RBFTransactionState;
36 : : struct bilingual_str;
37 : : struct CBlockLocator;
38 : : namespace kernel {
39 : : struct ChainstateRole;
40 : : } // namespace kernel
41 : : namespace node {
42 : : struct NodeContext;
43 : : } // namespace node
44 : :
45 : : namespace interfaces {
46 : :
47 : : class Handler;
48 : : class Wallet;
49 : :
50 : : //! Helper for findBlock to selectively return pieces of block data. If block is
51 : : //! found, data will be returned by setting specified output variables. If block
52 : : //! is not found, output variables will keep their previous values.
53 : : class FoundBlock
54 : : {
55 : : public:
56 [ + - ][ - + : 42 : FoundBlock& hash(uint256& hash) { m_hash = &hash; return *this; }
- + - + ]
57 [ + - ][ - + : 9630 : FoundBlock& height(int& height) { m_height = &height; return *this; }
- + + - -
+ ]
58 [ - + ]: 21792 : FoundBlock& time(int64_t& time) { m_time = &time; return *this; }
59 [ - + ]: 15122 : FoundBlock& maxTime(int64_t& max_time) { m_max_time = &max_time; return *this; }
60 [ - + ]: 674 : FoundBlock& mtpTime(int64_t& mtp_time) { m_mtp_time = &mtp_time; return *this; }
61 : : //! Return whether block is in the active (most-work) chain.
62 : 89564 : FoundBlock& inActiveChain(bool& in_active_chain) { m_in_active_chain = &in_active_chain; return *this; }
63 : : //! Return locator if block is in the active chain.
64 [ + - ]: 16945 : FoundBlock& locator(CBlockLocator& locator) { m_locator = &locator; return *this; }
65 : : //! Return next block in the active chain if current block is in the active chain.
66 [ + - ]: 80667 : FoundBlock& nextBlock(const FoundBlock& next_block) { m_next_block = &next_block; return *this; }
[ - + - + ]
67 : : //! Read block data from disk. If the block exists but doesn't have data
68 : : //! (for example due to pruning), the CBlock variable will be set to null.
69 [ + + ]: 80128 : FoundBlock& data(CBlock& data) { m_data = &data; return *this; }
70 : :
71 : : uint256* m_hash = nullptr;
72 : : int* m_height = nullptr;
73 : : int64_t* m_time = nullptr;
74 : : int64_t* m_max_time = nullptr;
75 : : int64_t* m_mtp_time = nullptr;
76 : : bool* m_in_active_chain = nullptr;
77 : : CBlockLocator* m_locator = nullptr;
78 : : const FoundBlock* m_next_block = nullptr;
79 : : CBlock* m_data = nullptr;
80 : : mutable bool found = false;
81 : : };
82 : :
83 : : //! The action to be taken after updating a settings value.
84 : : //! WRITE indicates that the updated value must be written to disk,
85 : : //! while SKIP_WRITE indicates that the change will be kept in memory-only
86 : : //! without persisting it.
87 : : enum class SettingsAction {
88 : : WRITE,
89 : : SKIP_WRITE
90 : : };
91 : :
92 : : using SettingsUpdate = std::function<std::optional<interfaces::SettingsAction>(common::SettingsValue&)>;
93 : :
94 : : //! Interface giving clients (wallet processes, maybe other analysis tools in
95 : : //! the future) ability to access to the chain state, receive notifications,
96 : : //! estimate fees, and submit transactions.
97 : : //!
98 : : //! TODO: Current chain methods are too low level, exposing too much of the
99 : : //! internal workings of the bitcoin node, and not being very convenient to use.
100 : : //! Chain methods should be cleaned up and simplified over time. Examples:
101 : : //!
102 : : //! * The initMessages() and showProgress() methods which the wallet uses to send
103 : : //! notifications to the GUI should go away when GUI and wallet can directly
104 : : //! communicate with each other without going through the node
105 : : //! (https://github.com/bitcoin/bitcoin/pull/15288#discussion_r253321096).
106 : : //!
107 : : //! * The handleRpc, registerRpcs, rpcEnableDeprecated methods and other RPC
108 : : //! methods can go away if wallets listen for HTTP requests on their own
109 : : //! ports instead of registering to handle requests on the node HTTP port.
110 : : //!
111 : : //! * Move fee estimation queries to an asynchronous interface and let the
112 : : //! wallet cache it, fee estimation being driven by node mempool, wallet
113 : : //! should be the consumer.
114 : : //!
115 : : //! * `guessVerificationProgress` and similar methods can go away if rescan
116 : : //! logic moves out of the wallet, and the wallet just requests scans from the
117 : : //! node (https://github.com/bitcoin/bitcoin/issues/11756)
118 : 2132 : class Chain
119 : : {
120 : : public:
121 : : virtual ~Chain() = default;
122 : :
123 : : //! Get current chain height, not including genesis block (returns 0 if
124 : : //! chain only contains genesis block, nullopt if chain does not contain
125 : : //! any blocks)
126 : : virtual std::optional<int> getHeight() = 0;
127 : :
128 : : //! Get block hash. Height must be valid or this function will abort.
129 : : virtual uint256 getBlockHash(int height) = 0;
130 : :
131 : : //! Check that the block is available on disk (i.e. has not been
132 : : //! pruned), and contains transactions.
133 : : virtual bool haveBlockOnDisk(int height) = 0;
134 : :
135 : : //! Return height of the highest block on chain in common with the locator,
136 : : //! which will either be the original block used to create the locator,
137 : : //! or one of its ancestors.
138 : : virtual std::optional<int> findLocatorFork(const CBlockLocator& locator) = 0;
139 : :
140 : : //! Returns whether a block filter index is available.
141 : : virtual bool hasBlockFilterIndex(BlockFilterType filter_type) = 0;
142 : :
143 : : //! Returns whether any of the elements match the block via a BIP 157 block filter
144 : : //! or std::nullopt if the block filter for this block couldn't be found.
145 : : virtual std::optional<bool> blockFilterMatchesAny(BlockFilterType filter_type, const uint256& block_hash, const GCSFilter::ElementSet& filter_set) = 0;
146 : :
147 : : //! Return whether node has the block and optionally return block metadata
148 : : //! or contents.
149 : : virtual bool findBlock(const uint256& hash, const FoundBlock& block={}) = 0;
150 : :
151 : : //! Find first block in the chain with timestamp >= the given time
152 : : //! and height >= than the given height, return false if there is no block
153 : : //! with a high enough timestamp and height. Optionally return block
154 : : //! information.
155 : : virtual bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height, const FoundBlock& block={}) = 0;
156 : :
157 : : //! Find ancestor of block at specified height and optionally return
158 : : //! ancestor information.
159 : : virtual bool findAncestorByHeight(const uint256& block_hash, int ancestor_height, const FoundBlock& ancestor_out={}) = 0;
160 : :
161 : : //! Return whether block descends from a specified ancestor, and
162 : : //! optionally return ancestor information.
163 : : virtual bool findAncestorByHash(const uint256& block_hash,
164 : : const uint256& ancestor_hash,
165 : : const FoundBlock& ancestor_out={}) = 0;
166 : :
167 : : //! Find most recent common ancestor between two blocks and optionally
168 : : //! return block information.
169 : : virtual bool findCommonAncestor(const uint256& block_hash1,
170 : : const uint256& block_hash2,
171 : : const FoundBlock& ancestor_out={},
172 : : const FoundBlock& block1_out={},
173 : : const FoundBlock& block2_out={}) = 0;
174 : :
175 : : //! Look up unspent output information. Returns coins in the mempool and in
176 : : //! the current chain UTXO set. Iterates through all the keys in the map and
177 : : //! populates the values.
178 : : virtual void findCoins(std::map<COutPoint, Coin>& coins) = 0;
179 : :
180 : : //! Estimate fraction of total transactions verified if blocks up to
181 : : //! the specified block hash are verified.
182 : : virtual double guessVerificationProgress(const uint256& block_hash) = 0;
183 : :
184 : : //! Return true if data is available for all blocks in the specified range
185 : : //! of blocks. This checks all blocks that are ancestors of block_hash in
186 : : //! the height range from min_height to max_height, inclusive.
187 : : virtual bool hasBlocks(const uint256& block_hash, int min_height = 0, std::optional<int> max_height = {}) = 0;
188 : :
189 : : //! Check if transaction is RBF opt in.
190 : : virtual RBFTransactionState isRBFOptIn(const CTransaction& tx) = 0;
191 : :
192 : : //! Check if transaction is in mempool.
193 : : virtual bool isInMempool(const Txid& txid) = 0;
194 : :
195 : : //! Check if transaction has descendants in mempool.
196 : : virtual bool hasDescendantsInMempool(const Txid& txid) = 0;
197 : :
198 : : //! Process a local transaction, optionally adding it to the mempool and
199 : : //! optionally broadcasting it to the network.
200 : : //! @param[in] tx Transaction to process.
201 : : //! @param[in] max_tx_fee Don't add the transaction to the mempool or
202 : : //! broadcast it if its fee is higher than this.
203 : : //! @param[in] broadcast_method Whether to add the transaction to the
204 : : //! mempool and how/whether to broadcast it.
205 : : //! @param[out] err_string Set if an error occurs.
206 : : //! @return False if the transaction could not be added due to the fee or for another reason.
207 : : virtual bool broadcastTransaction(const CTransactionRef& tx,
208 : : const CAmount& max_tx_fee,
209 : : node::TxBroadcast broadcast_method,
210 : : std::string& err_string) = 0;
211 : :
212 : : //! Calculate mempool ancestor and cluster counts for the given transaction.
213 : : virtual void getTransactionAncestry(const Txid& txid, size_t& ancestors, size_t& cluster_count, size_t* ancestorsize = nullptr, CAmount* ancestorfees = nullptr) = 0;
214 : :
215 : : //! For each outpoint, calculate the fee-bumping cost to spend this outpoint at the specified
216 : : // feerate, including bumping its ancestors. For example, if the target feerate is 10sat/vbyte
217 : : // and this outpoint refers to a mempool transaction at 3sat/vbyte, the bump fee includes the
218 : : // cost to bump the mempool transaction to 10sat/vbyte (i.e. 7 * mempooltx.vsize). If that
219 : : // transaction also has, say, an unconfirmed parent with a feerate of 1sat/vbyte, the bump fee
220 : : // includes the cost to bump the parent (i.e. 9 * parentmempooltx.vsize).
221 : : //
222 : : // If the outpoint comes from an unconfirmed transaction that is already above the target
223 : : // feerate or bumped by its descendant(s) already, it does not need to be bumped. Its bump fee
224 : : // is 0. Likewise, if any of the transaction's ancestors are already bumped by a transaction
225 : : // in our mempool, they are not included in the transaction's bump fee.
226 : : //
227 : : // Also supported is bump-fee calculation in the case of replacements. If an outpoint
228 : : // conflicts with another transaction in the mempool, it is assumed that the goal is to replace
229 : : // that transaction. As such, the calculation will exclude the to-be-replaced transaction, but
230 : : // will include the fee-bumping cost. If bump fees of descendants of the to-be-replaced
231 : : // transaction are requested, the value will be 0. Fee-related RBF rules are not included as
232 : : // they are logically distinct.
233 : : //
234 : : // Any outpoints that are otherwise unavailable from the mempool (e.g. UTXOs from confirmed
235 : : // transactions or transactions not yet broadcast by the wallet) are given a bump fee of 0.
236 : : //
237 : : // If multiple outpoints come from the same transaction (which would be very rare because
238 : : // it means that one transaction has multiple change outputs or paid the same wallet using multiple
239 : : // outputs in the same transaction) or have shared ancestry, the bump fees are calculated
240 : : // independently, i.e. as if only one of them is spent. This may result in double-fee-bumping. This
241 : : // caveat can be rectified per use of the sister-function CalculateCombinedBumpFee(…).
242 : : virtual std::map<COutPoint, CAmount> calculateIndividualBumpFees(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) = 0;
243 : :
244 : : //! Calculate the combined bump fee for an input set per the same strategy
245 : : // as in CalculateIndividualBumpFees(…).
246 : : // Unlike CalculateIndividualBumpFees(…), this does not return individual
247 : : // bump fees per outpoint, but a single bump fee for the shared ancestry.
248 : : // The combined bump fee may be used to correct overestimation due to
249 : : // shared ancestry by multiple UTXOs after coin selection.
250 : : virtual std::optional<CAmount> calculateCombinedBumpFee(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) = 0;
251 : :
252 : : //! Get the node's package limits.
253 : : //! Currently only returns the ancestor and descendant count limits, but could be enhanced to
254 : : //! return more policy settings.
255 : : virtual void getPackageLimits(unsigned int& limit_ancestor_count, unsigned int& limit_descendant_count) = 0;
256 : :
257 : : //! Check if transaction will pass the mempool's chain limits.
258 : : virtual util::Result<void> checkChainLimits(const CTransactionRef& tx) = 0;
259 : :
260 : : //! Estimate a fee rate.
261 : : virtual util::Expected<FeeRateEstimation, FeeRateEstimationError> getFeeRateEstimate(int num_blocks, bool conservative) const = 0;
262 : :
263 : : //! Fee estimator max target.
264 : : virtual unsigned int maximumFeeEstimationTargetBlocks() const = 0;
265 : :
266 : : //! Mempool minimum fee.
267 : : virtual CFeeRate mempoolMinFee() = 0;
268 : :
269 : : //! Relay current minimum fee (from -minrelaytxfee and -incrementalrelayfee settings).
270 : : virtual CFeeRate relayMinFee() = 0;
271 : :
272 : : //! Relay incremental fee setting (-incrementalrelayfee), reflecting cost of relay.
273 : : virtual CFeeRate relayIncrementalFee() = 0;
274 : :
275 : : //! Relay dust fee setting (-dustrelayfee), reflecting lowest rate it's economical to spend.
276 : : virtual CFeeRate relayDustFee() = 0;
277 : :
278 : : //! Check if any block has been pruned.
279 : : virtual bool havePruned() = 0;
280 : :
281 : : //! Get the current prune height.
282 : : virtual std::optional<int> getPruneHeight() = 0;
283 : :
284 : : //! Check if the node is ready to broadcast transactions.
285 : : virtual bool isReadyToBroadcast() = 0;
286 : :
287 : : //! Check if in IBD.
288 : : virtual bool isInitialBlockDownload() = 0;
289 : :
290 : : //! Check if shutdown requested.
291 : : virtual bool shutdownRequested() = 0;
292 : :
293 : : //! Send init message.
294 : : virtual void initMessage(const std::string& message) = 0;
295 : :
296 : : //! Send init warning.
297 : : virtual void initWarning(const bilingual_str& message) = 0;
298 : :
299 : : //! Send init error.
300 : : virtual void initError(const bilingual_str& message) = 0;
301 : :
302 : : //! Send progress indicator.
303 : : virtual void showProgress(const std::string& title, int progress, bool resume_possible) = 0;
304 : :
305 : : //! Chain notifications.
306 [ + - ]: 1121 : class Notifications
307 : : {
308 : : public:
309 : 0 : virtual ~Notifications() = default;
310 : 0 : virtual void transactionAddedToMempool(const CTransactionRef& tx) {}
311 : 0 : virtual void transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason) {}
312 : 0 : virtual void blockConnected(const kernel::ChainstateRole& role, const BlockInfo& block) {}
313 : 0 : virtual void blockDisconnected(const BlockInfo& block) {}
314 : 0 : virtual void updatedBlockTip() {}
315 : 98 : virtual void chainStateFlushed(const kernel::ChainstateRole& role, const CBlockLocator& locator) {}
316 : : };
317 : :
318 : : //! Options specifying which chain notifications are required.
319 : : struct NotifyOptions
320 : : {
321 : : //! Include undo data with block connected notifications.
322 : : bool connect_undo_data = false;
323 : : //! Include block data with block disconnected notifications.
324 : : bool disconnect_data = false;
325 : : //! Include undo data with block disconnected notifications.
326 : : bool disconnect_undo_data = false;
327 : : };
328 : :
329 : : //! Register handler for notifications.
330 : : //! Some notifications are asynchronous and may still execute after the handler is disconnected.
331 : : //! Use waitForNotifications() after the handler is disconnected to ensure all pending notifications
332 : : //! have been processed.
333 : : virtual std::unique_ptr<Handler> handleNotifications(std::shared_ptr<Notifications> notifications) = 0;
334 : :
335 : : //! Wait for pending notifications to be processed unless block hash points to the current
336 : : //! chain tip.
337 : : virtual void waitForNotificationsIfTipChanged(const uint256& old_tip) = 0;
338 : :
339 : : //! Wait for all pending notifications up to this point to be processed
340 : : virtual void waitForNotifications() = 0;
341 : :
342 : : //! Register handler for RPC. Command is not copied, so reference
343 : : //! needs to remain valid until Handler is disconnected.
344 : : virtual std::unique_ptr<Handler> handleRpc(const CRPCCommand& command) = 0;
345 : :
346 : : //! Check if deprecated RPC is enabled.
347 : : virtual bool rpcEnableDeprecated(const std::string& method) = 0;
348 : :
349 : : //! Get settings value.
350 : : virtual common::SettingsValue getSetting(const std::string& arg) = 0;
351 : :
352 : : //! Get list of settings values.
353 : : virtual std::vector<common::SettingsValue> getSettingsList(const std::string& arg) = 0;
354 : :
355 : : //! Return <datadir>/settings.json setting value.
356 : : virtual common::SettingsValue getRwSetting(const std::string& name) = 0;
357 : :
358 : : //! Updates a setting in <datadir>/settings.json.
359 : : //! Null can be passed to erase the setting. There is intentionally no
360 : : //! support for writing null values to settings.json.
361 : : //! Depending on the action returned by the update function, this will either
362 : : //! update the setting in memory or write the updated settings to disk.
363 : : virtual bool updateRwSetting(const std::string& name, const SettingsUpdate& update_function) = 0;
364 : :
365 : : //! Replace a setting in <datadir>/settings.json with a new value.
366 : : //! Null can be passed to erase the setting.
367 : : //! This method provides a simpler alternative to updateRwSetting when
368 : : //! atomically reading and updating the setting is not required.
369 : : virtual bool overwriteRwSetting(const std::string& name, common::SettingsValue value, SettingsAction action = SettingsAction::WRITE) = 0;
370 : :
371 : : //! Delete a given setting in <datadir>/settings.json.
372 : : //! This method provides a simpler alternative to overwriteRwSetting when
373 : : //! erasing a setting, for ease of use and readability.
374 : : virtual bool deleteRwSettings(const std::string& name, SettingsAction action = SettingsAction::WRITE) = 0;
375 : :
376 : : //! Synchronously send transactionAddedToMempool notifications about all
377 : : //! current mempool transactions to the specified handler and return after
378 : : //! the last one is sent. These notifications aren't coordinated with async
379 : : //! notifications sent by handleNotifications, so out of date async
380 : : //! notifications from handleNotifications can arrive during and after
381 : : //! synchronous notifications from requestMempoolTransactions. Clients need
382 : : //! to be prepared to handle this by ignoring notifications about unknown
383 : : //! removed transactions and already added new transactions.
384 : : virtual void requestMempoolTransactions(Notifications& notifications) = 0;
385 : :
386 : : //! Return true if an assumed-valid snapshot is in use. Note that this
387 : : //! returns true even after the snapshot is validated, until the next node
388 : : //! restart.
389 : : virtual bool hasAssumedValidChain() = 0;
390 : :
391 : : //! Get internal node context. Useful for testing, but not
392 : : //! accessible across processes.
393 : 0 : virtual node::NodeContext* context() { return nullptr; }
394 : : };
395 : :
396 : : //! Interface to let node manage chain clients (wallets, or maybe tools for
397 : : //! monitoring and analysis in the future).
398 [ + - ]: 444 : class ChainClient
399 : : {
400 : : public:
401 : 444 : virtual ~ChainClient() = default;
402 : :
403 : : //! Register rpcs.
404 : : virtual void registerRpcs() = 0;
405 : :
406 : : //! Check for errors before loading.
407 : : virtual bool verify() = 0;
408 : :
409 : : //! Load saved state.
410 : : virtual bool load() = 0;
411 : :
412 : : //! Start client execution and provide a scheduler.
413 : : virtual void start(CScheduler& scheduler) = 0;
414 : :
415 : : //! Shut down client.
416 : : virtual void stop() = 0;
417 : :
418 : : //! Set mock time.
419 : : virtual void setMockTime(int64_t time) = 0;
420 : :
421 : : //! Mock the scheduler to fast forward in time.
422 : : virtual void schedulerMockForward(std::chrono::seconds delta_seconds) = 0;
423 : : };
424 : :
425 : : //! Return implementation of Chain interface.
426 : : std::unique_ptr<Chain> MakeChain(node::NodeContext& node);
427 : :
428 : : } // namespace interfaces
429 : :
430 : : #endif // BITCOIN_INTERFACES_CHAIN_H
|
