 |
Bitcoin Core
23.99.0
P2P Digital Currency
|
Go to the documentation of this file.
5 #ifndef BITCOIN_INTERFACES_CHAIN_H
6 #define BITCOIN_INTERFACES_CHAIN_H
125 virtual std::optional<int>
getHeight() = 0;
164 const FoundBlock& ancestor_out={}) = 0;
170 const FoundBlock& ancestor_out={},
171 const FoundBlock& block1_out={},
172 const FoundBlock& block2_out={}) = 0;
177 virtual void findCoins(std::map<COutPoint, Coin>& coins) = 0;
186 virtual bool hasBlocks(
const uint256& block_hash,
int min_height = 0, std::optional<int> max_height = {}) = 0;
203 std::string& err_string) = 0;
211 virtual void getPackageLimits(
unsigned int& limit_ancestor_count,
unsigned int& limit_descendant_count) = 0;
247 virtual void initMessage(
const std::string& message) = 0;
256 virtual void showProgress(
const std::string& title,
int progress,
bool resume_possible) = 0;
272 virtual std::unique_ptr<Handler>
handleNotifications(std::shared_ptr<Notifications> notifications) = 0;
286 virtual void rpcRunLater(
const std::string&
name, std::function<
void()> fn, int64_t seconds) = 0;
295 virtual std::vector<util::SettingsValue>
getSettingsList(
const std::string& arg) = 0;
333 virtual bool verify() = 0;
336 virtual bool load() = 0;
342 virtual void flush() = 0;
345 virtual void stop() = 0;
356 #endif // BITCOIN_INTERFACES_CHAIN_H
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
virtual bool findAncestorByHash(const uint256 &block_hash, const uint256 &ancestor_hash, const FoundBlock &ancestor_out={})=0
Return whether block descends from a specified ancestor, and optionally return ancestor information.
virtual void registerRpcs()=0
Register rpcs.
Simple class for background tasks that should be run periodically or once "after a while".
virtual double guessVerificationProgress(const uint256 &block_hash)=0
Estimate fraction of total transactions verified if blocks up to the specified block hash are verifie...
virtual void blockDisconnected(const BlockInfo &block)
virtual int rpcSerializationFlags()=0
Current RPC serialization flags.
FoundBlock & data(CBlock &data)
Read block data from disk.
virtual void findCoins(std::map< COutPoint, Coin > &coins)=0
Look up unspent output information.
virtual void transactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
FoundBlock & mtpTime(int64_t &mtp_time)
virtual bool hasAssumedValidChain()=0
Return true if an assumed-valid chain is in use.
RBFTransactionState
The rbf state of unconfirmed transactions.
virtual bool isInitialBlockDownload()=0
Check if in IBD.
FoundBlock & nextBlock(const FoundBlock &next_block)
Return next block in the active chain if current block is in the active chain.
virtual void chainStateFlushed(const CBlockLocator &locator)
NodeContext struct containing references to chain state and connection state.
virtual std::unique_ptr< Handler > handleNotifications(std::shared_ptr< Notifications > notifications)=0
Register handler for notifications.
virtual std::vector< util::SettingsValue > getSettingsList(const std::string &arg)=0
Get list of settings values.
virtual bool hasDescendantsInMempool(const uint256 &txid)=0
Check if transaction has descendants in mempool.
virtual void flush()=0
Save state to disk.
const FoundBlock * m_next_block
virtual std::optional< int > getHeight()=0
Get current chain height, not including genesis block (returns 0 if chain only contains genesis block...
virtual node::NodeContext * context()
Get internal node context.
virtual bool findBlock(const uint256 &hash, const FoundBlock &block={})=0
Return whether node has the block and optionally return block metadata or contents.
const CBlockUndo * undo_data
virtual void start(CScheduler &scheduler)=0
Start client execution and provide a scheduler.
std::shared_ptr< const CTransaction > CTransactionRef
virtual bool findAncestorByHeight(const uint256 &block_hash, int ancestor_height, const FoundBlock &ancestor_out={})=0
Find ancestor of block at specified height and optionally return ancestor information.
virtual util::SettingsValue getRwSetting(const std::string &name)=0
Return <datadir>/settings.json setting value.
Fee rate in satoshis per kilovirtualbyte: CAmount / kvB.
FoundBlock & time(int64_t &time)
virtual void getPackageLimits(unsigned int &limit_ancestor_count, unsigned int &limit_descendant_count)=0
Get the node's package limits.
The basic transaction that is broadcasted on the network and contained in blocks.
virtual CFeeRate relayIncrementalFee()=0
Relay incremental fee setting (-incrementalrelayfee), reflecting cost of relay.
virtual CBlockLocator getActiveChainLocator(const uint256 &block_hash)=0
Return a locator that refers to a block in the active chain.
virtual bool isReadyToBroadcast()=0
Check if the node is ready to broadcast transactions.
virtual bool havePruned()=0
Check if any block has been pruned.
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
virtual void updatedBlockTip()
virtual bool load()=0
Load saved state.
virtual uint256 getBlockHash(int height)=0
Get block hash. Height must be valid or this function will abort.
virtual CFeeRate mempoolMinFee()=0
Mempool minimum fee.
FoundBlock & maxTime(int64_t &max_time)
virtual void waitForNotificationsIfTipChanged(const uint256 &old_tip)=0
Wait for pending notifications to be processed unless block hash points to the current chain tip.
virtual std::optional< int > findLocatorFork(const CBlockLocator &locator)=0
Return height of the highest block on chain in common with the locator, which will either be the orig...
int64_t CAmount
Amount in satoshis (Can be negative)
virtual CFeeRate relayMinFee()=0
Relay current minimum fee (from -minrelaytxfee and -incrementalrelayfee settings).
virtual bool shutdownRequested()=0
Check if shutdown requested.
const uint256 * prev_hash
virtual bool broadcastTransaction(const CTransactionRef &tx, const CAmount &max_tx_fee, bool relay, std::string &err_string)=0
Transaction is added to memory pool, if the transaction fee is below the amount specified by max_tx_f...
virtual bool updateRwSetting(const std::string &name, const util::SettingsValue &value, bool write=true)=0
Write a setting to <datadir>/settings.json.
Helper for findBlock to selectively return pieces of block data.
virtual void rpcRunLater(const std::string &name, std::function< void()> fn, int64_t seconds)=0
Run function after given number of seconds. Cancel any previous calls with same name.
virtual RBFTransactionState isRBFOptIn(const CTransaction &tx)=0
Check if transaction is RBF opt in.
virtual bool findCommonAncestor(const uint256 &block_hash1, const uint256 &block_hash2, const FoundBlock &ancestor_out={}, const FoundBlock &block1_out={}, const FoundBlock &block2_out={})=0
Find most recent common ancestor between two blocks and optionally return block information.
virtual bool rpcEnableDeprecated(const std::string &method)=0
Check if deprecated RPC is enabled.
virtual void transactionAddedToMempool(const CTransactionRef &tx, uint64_t mempool_sequence)
virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, FeeCalculation *calc=nullptr)=0
Estimate smart fee.
FoundBlock & height(int &height)
virtual void initWarning(const bilingual_str &message)=0
Send init warning.
Hash/height pair to help track and identify blocks.
Interface to let node manage chain clients (wallets, or maybe tools for monitoring and analysis in th...
virtual bool isInMempool(const uint256 &txid)=0
Check if transaction is in mempool.
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
virtual CFeeRate relayDustFee()=0
Relay dust fee setting (-dustrelayfee), reflecting lowest rate it's economical to spend.
virtual void initMessage(const std::string &message)=0
Send init message.
virtual util::SettingsValue getSetting(const std::string &arg)=0
Get settings value.
virtual void stop()=0
Shut down client.
virtual void getTransactionAncestry(const uint256 &txid, size_t &ancestors, size_t &descendants, size_t *ancestorsize=nullptr, CAmount *ancestorfees=nullptr)=0
Calculate mempool ancestor and descendant counts for the given transaction.
virtual bool checkChainLimits(const CTransactionRef &tx)=0
Check if transaction will pass the mempool's chain limits.
virtual bool verify()=0
Check for errors before loading.
virtual void blockConnected(const BlockInfo &block)
FoundBlock & hash(uint256 &hash)
FoundBlock & locator(CBlockLocator &locator)
Return locator if block is in the active chain.
virtual bool haveBlockOnDisk(int height)=0
Check that the block is available on disk (i.e.
CBlockLocator * m_locator
virtual void initError(const bilingual_str &message)=0
Send init error.
Block data sent with blockConnected, blockDisconnected notifications.
BlockInfo(const uint256 &hash LIFETIMEBOUND)
virtual CBlockLocator getTipLocator()=0
Get locator for the current chain tip.
virtual void requestMempoolTransactions(Notifications ¬ifications)=0
Synchronously send transactionAddedToMempool notifications about all current mempool transactions to ...
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
virtual void showProgress(const std::string &title, int progress, bool resume_possible)=0
Send progress indicator.
FoundBlock & inActiveChain(bool &in_active_chain)
Return whether block is in the active (most-work) chain.
virtual unsigned int estimateMaxBlocks()=0
Fee estimator max target.
virtual std::unique_ptr< Handler > handleRpc(const CRPCCommand &command)=0
Register handler for RPC.
virtual void setMockTime(int64_t time)=0
Set mock time.
Undo information for a CBlock.
virtual bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height, const FoundBlock &block={})=0
Find first block in the chain with timestamp >= the given time and height >= than the given height,...
virtual bool hasBlocks(const uint256 &block_hash, int min_height=0, std::optional< int > max_height={})=0
Return true if data is available for all blocks in the specified range of blocks.