repo_id
stringlengths
0
42
file_path
stringlengths
15
97
content
stringlengths
2
2.41M
__index_level_0__
int64
0
0
bitcoin/src
bitcoin/src/policy/settings.cpp
// Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include <policy/settings.h> #include <policy/policy.h> unsigned int nBytesPerSigOp = DEFAULT_BYTES_PER_SIGOP;
0
bitcoin/src
bitcoin/src/policy/feerate.h
// Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_POLICY_FEERATE_H #define BITCOIN_POLICY_FEERATE_H #include <consensus/amount.h> #include <serialize.h> #include <cstdint> #include <string> #include <type_traits> const std::string CURRENCY_UNIT = "BTC"; // One formatted unit const std::string CURRENCY_ATOM = "sat"; // One indivisible minimum value unit /* Used to determine type of fee estimation requested */ enum class FeeEstimateMode { UNSET, //!< Use default settings based on other criteria ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates BTC_KVB, //!< Use BTC/kvB fee rate unit SAT_VB, //!< Use sat/vB fee rate unit }; /** * Fee rate in satoshis per kilovirtualbyte: CAmount / kvB */ class CFeeRate { private: /** Fee rate in sat/kvB (satoshis per 1000 virtualbytes) */ CAmount nSatoshisPerK; public: /** Fee rate of 0 satoshis per kvB */ CFeeRate() : nSatoshisPerK(0) { } template<typename I> explicit CFeeRate(const I _nSatoshisPerK): nSatoshisPerK(_nSatoshisPerK) { // We've previously had bugs creep in from silent double->int conversion... static_assert(std::is_integral<I>::value, "CFeeRate should be used without floats"); } /** * Construct a fee rate from a fee in satoshis and a vsize in vB. * * param@[in] nFeePaid The fee paid by a transaction, in satoshis * param@[in] num_bytes The vsize of a transaction, in vbytes */ CFeeRate(const CAmount& nFeePaid, uint32_t num_bytes); /** * Return the fee in satoshis for the given vsize in vbytes. * If the calculated fee would have fractional satoshis, then the * returned fee will always be rounded up to the nearest satoshi. */ CAmount GetFee(uint32_t num_bytes) const; /** * Return the fee in satoshis for a vsize of 1000 vbytes */ CAmount GetFeePerK() const { return nSatoshisPerK; } friend bool operator<(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK < b.nSatoshisPerK; } friend bool operator>(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK > b.nSatoshisPerK; } friend bool operator==(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK == b.nSatoshisPerK; } friend bool operator<=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK <= b.nSatoshisPerK; } friend bool operator>=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK >= b.nSatoshisPerK; } friend bool operator!=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK != b.nSatoshisPerK; } CFeeRate& operator+=(const CFeeRate& a) { nSatoshisPerK += a.nSatoshisPerK; return *this; } std::string ToString(const FeeEstimateMode& fee_estimate_mode = FeeEstimateMode::BTC_KVB) const; friend CFeeRate operator*(const CFeeRate& f, int a) { return CFeeRate(a * f.nSatoshisPerK); } friend CFeeRate operator*(int a, const CFeeRate& f) { return CFeeRate(a * f.nSatoshisPerK); } SERIALIZE_METHODS(CFeeRate, obj) { READWRITE(obj.nSatoshisPerK); } }; #endif // BITCOIN_POLICY_FEERATE_H
0
bitcoin/src
bitcoin/src/interfaces/chain.h
// Copyright (c) 2018-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_CHAIN_H #define BITCOIN_INTERFACES_CHAIN_H #include <blockfilter.h> #include <common/settings.h> #include <primitives/transaction.h> // For CTransactionRef #include <util/result.h> #include <functional> #include <memory> #include <optional> #include <stddef.h> #include <stdint.h> #include <string> #include <vector> class ArgsManager; class CBlock; class CBlockUndo; class CFeeRate; class CRPCCommand; class CScheduler; class Coin; class uint256; enum class MemPoolRemovalReason; enum class RBFTransactionState; enum class ChainstateRole; struct bilingual_str; struct CBlockLocator; struct FeeCalculation; namespace node { struct NodeContext; } // namespace node namespace interfaces { class Handler; class Wallet; //! Hash/height pair to help track and identify blocks. struct BlockKey { uint256 hash; int height = -1; }; //! Helper for findBlock to selectively return pieces of block data. If block is //! found, data will be returned by setting specified output variables. If block //! is not found, output variables will keep their previous values. class FoundBlock { public: FoundBlock& hash(uint256& hash) { m_hash = &hash; return *this; } FoundBlock& height(int& height) { m_height = &height; return *this; } FoundBlock& time(int64_t& time) { m_time = &time; return *this; } FoundBlock& maxTime(int64_t& max_time) { m_max_time = &max_time; return *this; } FoundBlock& mtpTime(int64_t& mtp_time) { m_mtp_time = &mtp_time; return *this; } //! Return whether block is in the active (most-work) chain. FoundBlock& inActiveChain(bool& in_active_chain) { m_in_active_chain = &in_active_chain; return *this; } //! Return locator if block is in the active chain. FoundBlock& locator(CBlockLocator& locator) { m_locator = &locator; return *this; } //! Return next block in the active chain if current block is in the active chain. FoundBlock& nextBlock(const FoundBlock& next_block) { m_next_block = &next_block; return *this; } //! Read block data from disk. If the block exists but doesn't have data //! (for example due to pruning), the CBlock variable will be set to null. FoundBlock& data(CBlock& data) { m_data = &data; return *this; } uint256* m_hash = nullptr; int* m_height = nullptr; int64_t* m_time = nullptr; int64_t* m_max_time = nullptr; int64_t* m_mtp_time = nullptr; bool* m_in_active_chain = nullptr; CBlockLocator* m_locator = nullptr; const FoundBlock* m_next_block = nullptr; CBlock* m_data = nullptr; mutable bool found = false; }; //! Block data sent with blockConnected, blockDisconnected notifications. struct BlockInfo { const uint256& hash; const uint256* prev_hash = nullptr; int height = -1; int file_number = -1; unsigned data_pos = 0; const CBlock* data = nullptr; const CBlockUndo* undo_data = nullptr; // The maximum time in the chain up to and including this block. // A timestamp that can only move forward. unsigned int chain_time_max{0}; BlockInfo(const uint256& hash LIFETIMEBOUND) : hash(hash) {} }; //! Interface giving clients (wallet processes, maybe other analysis tools in //! the future) ability to access to the chain state, receive notifications, //! estimate fees, and submit transactions. //! //! TODO: Current chain methods are too low level, exposing too much of the //! internal workings of the bitcoin node, and not being very convenient to use. //! Chain methods should be cleaned up and simplified over time. Examples: //! //! * The initMessages() and showProgress() methods which the wallet uses to send //! notifications to the GUI should go away when GUI and wallet can directly //! communicate with each other without going through the node //! (https://github.com/bitcoin/bitcoin/pull/15288#discussion_r253321096). //! //! * The handleRpc, registerRpcs, rpcEnableDeprecated methods and other RPC //! methods can go away if wallets listen for HTTP requests on their own //! ports instead of registering to handle requests on the node HTTP port. //! //! * Move fee estimation queries to an asynchronous interface and let the //! wallet cache it, fee estimation being driven by node mempool, wallet //! should be the consumer. //! //! * `guessVerificationProgress` and similar methods can go away if rescan //! logic moves out of the wallet, and the wallet just requests scans from the //! node (https://github.com/bitcoin/bitcoin/issues/11756) class Chain { public: virtual ~Chain() {} //! Get current chain height, not including genesis block (returns 0 if //! chain only contains genesis block, nullopt if chain does not contain //! any blocks) virtual std::optional<int> getHeight() = 0; //! Get block hash. Height must be valid or this function will abort. virtual uint256 getBlockHash(int height) = 0; //! Check that the block is available on disk (i.e. has not been //! pruned), and contains transactions. virtual bool haveBlockOnDisk(int height) = 0; //! Get locator for the current chain tip. virtual CBlockLocator getTipLocator() = 0; //! Return a locator that refers to a block in the active chain. //! If specified block is not in the active chain, return locator for the latest ancestor that is in the chain. virtual CBlockLocator getActiveChainLocator(const uint256& block_hash) = 0; //! Return height of the highest block on chain in common with the locator, //! which will either be the original block used to create the locator, //! or one of its ancestors. virtual std::optional<int> findLocatorFork(const CBlockLocator& locator) = 0; //! Returns whether a block filter index is available. virtual bool hasBlockFilterIndex(BlockFilterType filter_type) = 0; //! Returns whether any of the elements match the block via a BIP 157 block filter //! or std::nullopt if the block filter for this block couldn't be found. virtual std::optional<bool> blockFilterMatchesAny(BlockFilterType filter_type, const uint256& block_hash, const GCSFilter::ElementSet& filter_set) = 0; //! Return whether node has the block and optionally return block metadata //! or contents. virtual bool findBlock(const uint256& hash, const FoundBlock& block={}) = 0; //! Find first block in the chain with timestamp >= the given time //! and height >= than the given height, return false if there is no block //! with a high enough timestamp and height. Optionally return block //! information. virtual bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height, const FoundBlock& block={}) = 0; //! Find ancestor of block at specified height and optionally return //! ancestor information. virtual bool findAncestorByHeight(const uint256& block_hash, int ancestor_height, const FoundBlock& ancestor_out={}) = 0; //! Return whether block descends from a specified ancestor, and //! optionally return ancestor information. virtual bool findAncestorByHash(const uint256& block_hash, const uint256& ancestor_hash, const FoundBlock& ancestor_out={}) = 0; //! Find most recent common ancestor between two blocks and optionally //! return block information. virtual bool findCommonAncestor(const uint256& block_hash1, const uint256& block_hash2, const FoundBlock& ancestor_out={}, const FoundBlock& block1_out={}, const FoundBlock& block2_out={}) = 0; //! Look up unspent output information. Returns coins in the mempool and in //! the current chain UTXO set. Iterates through all the keys in the map and //! populates the values. virtual void findCoins(std::map<COutPoint, Coin>& coins) = 0; //! Estimate fraction of total transactions verified if blocks up to //! the specified block hash are verified. virtual double guessVerificationProgress(const uint256& block_hash) = 0; //! Return true if data is available for all blocks in the specified range //! of blocks. This checks all blocks that are ancestors of block_hash in //! the height range from min_height to max_height, inclusive. virtual bool hasBlocks(const uint256& block_hash, int min_height = 0, std::optional<int> max_height = {}) = 0; //! Check if transaction is RBF opt in. virtual RBFTransactionState isRBFOptIn(const CTransaction& tx) = 0; //! Check if transaction is in mempool. virtual bool isInMempool(const uint256& txid) = 0; //! Check if transaction has descendants in mempool. virtual bool hasDescendantsInMempool(const uint256& txid) = 0; //! Transaction is added to memory pool, if the transaction fee is below the //! amount specified by max_tx_fee, and broadcast to all peers if relay is set to true. //! Return false if the transaction could not be added due to the fee or for another reason. virtual bool broadcastTransaction(const CTransactionRef& tx, const CAmount& max_tx_fee, bool relay, std::string& err_string) = 0; //! Calculate mempool ancestor and descendant counts for the given transaction. virtual void getTransactionAncestry(const uint256& txid, size_t& ancestors, size_t& descendants, size_t* ancestorsize = nullptr, CAmount* ancestorfees = nullptr) = 0; //! For each outpoint, calculate the fee-bumping cost to spend this outpoint at the specified // feerate, including bumping its ancestors. For example, if the target feerate is 10sat/vbyte // and this outpoint refers to a mempool transaction at 3sat/vbyte, the bump fee includes the // cost to bump the mempool transaction to 10sat/vbyte (i.e. 7 * mempooltx.vsize). If that // transaction also has, say, an unconfirmed parent with a feerate of 1sat/vbyte, the bump fee // includes the cost to bump the parent (i.e. 9 * parentmempooltx.vsize). // // If the outpoint comes from an unconfirmed transaction that is already above the target // feerate or bumped by its descendant(s) already, it does not need to be bumped. Its bump fee // is 0. Likewise, if any of the transaction's ancestors are already bumped by a transaction // in our mempool, they are not included in the transaction's bump fee. // // Also supported is bump-fee calculation in the case of replacements. If an outpoint // conflicts with another transaction in the mempool, it is assumed that the goal is to replace // that transaction. As such, the calculation will exclude the to-be-replaced transaction, but // will include the fee-bumping cost. If bump fees of descendants of the to-be-replaced // transaction are requested, the value will be 0. Fee-related RBF rules are not included as // they are logically distinct. // // Any outpoints that are otherwise unavailable from the mempool (e.g. UTXOs from confirmed // transactions or transactions not yet broadcast by the wallet) are given a bump fee of 0. // // If multiple outpoints come from the same transaction (which would be very rare because // it means that one transaction has multiple change outputs or paid the same wallet using multiple // outputs in the same transaction) or have shared ancestry, the bump fees are calculated // independently, i.e. as if only one of them is spent. This may result in double-fee-bumping. This // caveat can be rectified per use of the sister-function CalculateCombinedBumpFee(…). virtual std::map<COutPoint, CAmount> calculateIndividualBumpFees(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) = 0; //! Calculate the combined bump fee for an input set per the same strategy // as in CalculateIndividualBumpFees(…). // Unlike CalculateIndividualBumpFees(…), this does not return individual // bump fees per outpoint, but a single bump fee for the shared ancestry. // The combined bump fee may be used to correct overestimation due to // shared ancestry by multiple UTXOs after coin selection. virtual std::optional<CAmount> calculateCombinedBumpFee(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) = 0; //! Get the node's package limits. //! Currently only returns the ancestor and descendant count limits, but could be enhanced to //! return more policy settings. virtual void getPackageLimits(unsigned int& limit_ancestor_count, unsigned int& limit_descendant_count) = 0; //! Check if transaction will pass the mempool's chain limits. virtual util::Result<void> checkChainLimits(const CTransactionRef& tx) = 0; //! Estimate smart fee. virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, FeeCalculation* calc = nullptr) = 0; //! Fee estimator max target. virtual unsigned int estimateMaxBlocks() = 0; //! Mempool minimum fee. virtual CFeeRate mempoolMinFee() = 0; //! Relay current minimum fee (from -minrelaytxfee and -incrementalrelayfee settings). virtual CFeeRate relayMinFee() = 0; //! Relay incremental fee setting (-incrementalrelayfee), reflecting cost of relay. virtual CFeeRate relayIncrementalFee() = 0; //! Relay dust fee setting (-dustrelayfee), reflecting lowest rate it's economical to spend. virtual CFeeRate relayDustFee() = 0; //! Check if any block has been pruned. virtual bool havePruned() = 0; //! Check if the node is ready to broadcast transactions. virtual bool isReadyToBroadcast() = 0; //! Check if in IBD. virtual bool isInitialBlockDownload() = 0; //! Check if shutdown requested. virtual bool shutdownRequested() = 0; //! Send init message. virtual void initMessage(const std::string& message) = 0; //! Send init warning. virtual void initWarning(const bilingual_str& message) = 0; //! Send init error. virtual void initError(const bilingual_str& message) = 0; //! Send progress indicator. virtual void showProgress(const std::string& title, int progress, bool resume_possible) = 0; //! Chain notifications. class Notifications { public: virtual ~Notifications() {} virtual void transactionAddedToMempool(const CTransactionRef& tx) {} virtual void transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason) {} virtual void blockConnected(ChainstateRole role, const BlockInfo& block) {} virtual void blockDisconnected(const BlockInfo& block) {} virtual void updatedBlockTip() {} virtual void chainStateFlushed(ChainstateRole role, const CBlockLocator& locator) {} }; //! Register handler for notifications. virtual std::unique_ptr<Handler> handleNotifications(std::shared_ptr<Notifications> notifications) = 0; //! Wait for pending notifications to be processed unless block hash points to the current //! chain tip. virtual void waitForNotificationsIfTipChanged(const uint256& old_tip) = 0; //! Register handler for RPC. Command is not copied, so reference //! needs to remain valid until Handler is disconnected. virtual std::unique_ptr<Handler> handleRpc(const CRPCCommand& command) = 0; //! Check if deprecated RPC is enabled. virtual bool rpcEnableDeprecated(const std::string& method) = 0; //! Run function after given number of seconds. Cancel any previous calls with same name. virtual void rpcRunLater(const std::string& name, std::function<void()> fn, int64_t seconds) = 0; //! Current RPC serialization flags. virtual bool rpcSerializationWithoutWitness() = 0; //! Get settings value. virtual common::SettingsValue getSetting(const std::string& arg) = 0; //! Get list of settings values. virtual std::vector<common::SettingsValue> getSettingsList(const std::string& arg) = 0; //! Return <datadir>/settings.json setting value. virtual common::SettingsValue getRwSetting(const std::string& name) = 0; //! Write a setting to <datadir>/settings.json. Optionally just update the //! setting in memory and do not write the file. virtual bool updateRwSetting(const std::string& name, const common::SettingsValue& value, bool write=true) = 0; //! Synchronously send transactionAddedToMempool notifications about all //! current mempool transactions to the specified handler and return after //! the last one is sent. These notifications aren't coordinated with async //! notifications sent by handleNotifications, so out of date async //! notifications from handleNotifications can arrive during and after //! synchronous notifications from requestMempoolTransactions. Clients need //! to be prepared to handle this by ignoring notifications about unknown //! removed transactions and already added new transactions. virtual void requestMempoolTransactions(Notifications& notifications) = 0; //! Return true if an assumed-valid chain is in use. virtual bool hasAssumedValidChain() = 0; //! Get internal node context. Useful for testing, but not //! accessible across processes. virtual node::NodeContext* context() { return nullptr; } }; //! Interface to let node manage chain clients (wallets, or maybe tools for //! monitoring and analysis in the future). class ChainClient { public: virtual ~ChainClient() {} //! Register rpcs. virtual void registerRpcs() = 0; //! Check for errors before loading. virtual bool verify() = 0; //! Load saved state. virtual bool load() = 0; //! Start client execution and provide a scheduler. virtual void start(CScheduler& scheduler) = 0; //! Save state to disk. virtual void flush() = 0; //! Shut down client. virtual void stop() = 0; //! Set mock time. virtual void setMockTime(int64_t time) = 0; //! Mock the scheduler to fast forward in time. virtual void schedulerMockForward(std::chrono::seconds delta_seconds) = 0; }; //! Return implementation of Chain interface. std::unique_ptr<Chain> MakeChain(node::NodeContext& node); } // namespace interfaces #endif // BITCOIN_INTERFACES_CHAIN_H
0
bitcoin/src
bitcoin/src/interfaces/ipc.h
// Copyright (c) 2021 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_IPC_H #define BITCOIN_INTERFACES_IPC_H #include <functional> #include <memory> #include <typeindex> namespace ipc { struct Context; } // namespace ipc namespace interfaces { class Init; //! Interface providing access to interprocess-communication (IPC) //! functionality. The IPC implementation is responsible for establishing //! connections between a controlling process and a process being controlled. //! When a connection is established, the process being controlled returns an //! interfaces::Init pointer to the controlling process, which the controlling //! process can use to get access to other interfaces and functionality. //! //! When spawning a new process, the steps are: //! //! 1. The controlling process calls interfaces::Ipc::spawnProcess(), which //! calls ipc::Process::spawn(), which spawns a new process and returns a //! socketpair file descriptor for communicating with it. //! interfaces::Ipc::spawnProcess() then calls ipc::Protocol::connect() //! passing the socketpair descriptor, which returns a local proxy //! interfaces::Init implementation calling remote interfaces::Init methods. //! 2. The spawned process calls interfaces::Ipc::startSpawnProcess(), which //! calls ipc::Process::checkSpawned() to read command line arguments and //! determine whether it is a spawned process and what socketpair file //! descriptor it should use. It then calls ipc::Protocol::serve() to handle //! incoming requests from the socketpair and invoke interfaces::Init //! interface methods, and exit when the socket is closed. //! 3. The controlling process calls local proxy interfaces::Init object methods //! to make other proxy objects calling other remote interfaces. It can also //! destroy the initial interfaces::Init object to close the connection and //! shut down the spawned process. class Ipc { public: virtual ~Ipc() = default; //! Spawn a child process returning pointer to its Init interface. virtual std::unique_ptr<Init> spawnProcess(const char* exe_name) = 0; //! If this is a spawned process, block and handle requests from the parent //! process by forwarding them to this process's Init interface, then return //! true. If this is not a spawned child process, return false. virtual bool startSpawnedProcess(int argc, char* argv[], int& exit_status) = 0; //! Add cleanup callback to remote interface that will run when the //! interface is deleted. template<typename Interface> void addCleanup(Interface& iface, std::function<void()> cleanup) { addCleanup(typeid(Interface), &iface, std::move(cleanup)); } //! IPC context struct accessor (see struct definition for more description). virtual ipc::Context& context() = 0; protected: //! Internal implementation of public addCleanup method (above) as a //! type-erased virtual function, since template functions can't be virtual. virtual void addCleanup(std::type_index type, void* iface, std::function<void()> cleanup) = 0; }; //! Return implementation of Ipc interface. std::unique_ptr<Ipc> MakeIpc(const char* exe_name, const char* process_argv0, Init& init); } // namespace interfaces #endif // BITCOIN_INTERFACES_IPC_H
0
bitcoin/src
bitcoin/src/interfaces/echo.h
// Copyright (c) 2021 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_ECHO_H #define BITCOIN_INTERFACES_ECHO_H #include <memory> #include <string> namespace interfaces { //! Simple string echoing interface for testing. class Echo { public: virtual ~Echo() {} //! Echo provided string. virtual std::string echo(const std::string& echo) = 0; }; //! Return implementation of Echo interface. std::unique_ptr<Echo> MakeEcho(); } // namespace interfaces #endif // BITCOIN_INTERFACES_ECHO_H
0
bitcoin/src
bitcoin/src/interfaces/node.h
// Copyright (c) 2018-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_NODE_H #define BITCOIN_INTERFACES_NODE_H #include <common/settings.h> #include <consensus/amount.h> // For CAmount #include <net.h> // For NodeId #include <net_types.h> // For banmap_t #include <netaddress.h> // For Network #include <netbase.h> // For ConnectionDirection #include <support/allocators/secure.h> // For SecureString #include <util/translation.h> #include <functional> #include <memory> #include <stddef.h> #include <stdint.h> #include <string> #include <tuple> #include <vector> class BanMan; class CFeeRate; class CNodeStats; class Coin; class RPCTimerInterface; class UniValue; class Proxy; enum class SynchronizationState; enum class TransactionError; struct CNodeStateStats; struct bilingual_str; namespace node { struct NodeContext; } // namespace node namespace wallet { class CCoinControl; } // namespace wallet namespace interfaces { class Handler; class WalletLoader; struct BlockTip; //! Block and header tip information struct BlockAndHeaderTipInfo { int block_height; int64_t block_time; int header_height; int64_t header_time; double verification_progress; }; //! External signer interface used by the GUI. class ExternalSigner { public: virtual ~ExternalSigner() {}; //! Get signer display name virtual std::string getName() = 0; }; //! Top-level interface for a bitcoin node (bitcoind process). class Node { public: virtual ~Node() {} //! Init logging. virtual void initLogging() = 0; //! Init parameter interaction. virtual void initParameterInteraction() = 0; //! Get warnings. virtual bilingual_str getWarnings() = 0; //! Get exit status. virtual int getExitStatus() = 0; // Get log flags. virtual uint32_t getLogCategories() = 0; //! Initialize app dependencies. virtual bool baseInitialize() = 0; //! Start node. virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo* tip_info = nullptr) = 0; //! Stop node. virtual void appShutdown() = 0; //! Start shutdown. virtual void startShutdown() = 0; //! Return whether shutdown was requested. virtual bool shutdownRequested() = 0; //! Return whether a particular setting in <datadir>/settings.json is or //! would be ignored because it is also specified in the command line. virtual bool isSettingIgnored(const std::string& name) = 0; //! Return setting value from <datadir>/settings.json or bitcoin.conf. virtual common::SettingsValue getPersistentSetting(const std::string& name) = 0; //! Update a setting in <datadir>/settings.json. virtual void updateRwSetting(const std::string& name, const common::SettingsValue& value) = 0; //! Force a setting value to be applied, overriding any other configuration //! source, but not being persisted. virtual void forceSetting(const std::string& name, const common::SettingsValue& value) = 0; //! Clear all settings in <datadir>/settings.json and store a backup of //! previous settings in <datadir>/settings.json.bak. virtual void resetSettings() = 0; //! Map port. virtual void mapPort(bool use_upnp, bool use_natpmp) = 0; //! Get proxy. virtual bool getProxy(Network net, Proxy& proxy_info) = 0; //! Get number of connections. virtual size_t getNodeCount(ConnectionDirection flags) = 0; //! Get stats for connected nodes. using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>; virtual bool getNodesStats(NodesStats& stats) = 0; //! Get ban map entries. virtual bool getBanned(banmap_t& banmap) = 0; //! Ban node. virtual bool ban(const CNetAddr& net_addr, int64_t ban_time_offset) = 0; //! Unban node. virtual bool unban(const CSubNet& ip) = 0; //! Disconnect node by address. virtual bool disconnectByAddress(const CNetAddr& net_addr) = 0; //! Disconnect node by id. virtual bool disconnectById(NodeId id) = 0; //! Return list of external signers (attached devices which can sign transactions). virtual std::vector<std::unique_ptr<ExternalSigner>> listExternalSigners() = 0; //! Get total bytes recv. virtual int64_t getTotalBytesRecv() = 0; //! Get total bytes sent. virtual int64_t getTotalBytesSent() = 0; //! Get mempool size. virtual size_t getMempoolSize() = 0; //! Get mempool dynamic usage. virtual size_t getMempoolDynamicUsage() = 0; //! Get header tip height and time. virtual bool getHeaderTip(int& height, int64_t& block_time) = 0; //! Get num blocks. virtual int getNumBlocks() = 0; //! Get best block hash. virtual uint256 getBestBlockHash() = 0; //! Get last block time. virtual int64_t getLastBlockTime() = 0; //! Get verification progress. virtual double getVerificationProgress() = 0; //! Is initial block download. virtual bool isInitialBlockDownload() = 0; //! Is loading blocks. virtual bool isLoadingBlocks() = 0; //! Set network active. virtual void setNetworkActive(bool active) = 0; //! Get network active. virtual bool getNetworkActive() = 0; //! Get dust relay fee. virtual CFeeRate getDustRelayFee() = 0; //! Execute rpc command. virtual UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) = 0; //! List rpc commands. virtual std::vector<std::string> listRpcCommands() = 0; //! Set RPC timer interface if unset. virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0; //! Unset RPC timer interface. virtual void rpcUnsetTimerInterface(RPCTimerInterface* iface) = 0; //! Get unspent output associated with a transaction. virtual std::optional<Coin> getUnspentOutput(const COutPoint& output) = 0; //! Broadcast transaction. virtual TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) = 0; //! Get wallet loader. virtual WalletLoader& walletLoader() = 0; //! Register handler for init messages. using InitMessageFn = std::function<void(const std::string& message)>; virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0; //! Register handler for message box messages. using MessageBoxFn = std::function<bool(const bilingual_str& message, const std::string& caption, unsigned int style)>; virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0; //! Register handler for question messages. using QuestionFn = std::function<bool(const bilingual_str& message, const std::string& non_interactive_message, const std::string& caption, unsigned int style)>; virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0; //! Register handler for progress messages. using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>; virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0; //! Register handler for wallet loader constructed messages. using InitWalletFn = std::function<void()>; virtual std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) = 0; //! Register handler for number of connections changed messages. using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>; virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0; //! Register handler for network active messages. using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>; virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0; //! Register handler for notify alert messages. using NotifyAlertChangedFn = std::function<void()>; virtual std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0; //! Register handler for ban list messages. using BannedListChangedFn = std::function<void()>; virtual std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) = 0; //! Register handler for block tip messages. using NotifyBlockTipFn = std::function<void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)>; virtual std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) = 0; //! Register handler for header tip messages. using NotifyHeaderTipFn = std::function<void(SynchronizationState, interfaces::BlockTip tip, bool presync)>; virtual std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0; //! Get and set internal node context. Useful for testing, but not //! accessible across processes. virtual node::NodeContext* context() { return nullptr; } virtual void setContext(node::NodeContext* context) { } }; //! Return implementation of Node interface. std::unique_ptr<Node> MakeNode(node::NodeContext& context); //! Block tip (could be a header or not, depends on the subscribed signal). struct BlockTip { int block_height; int64_t block_time; uint256 block_hash; }; } // namespace interfaces #endif // BITCOIN_INTERFACES_NODE_H
0
bitcoin/src
bitcoin/src/interfaces/README.md
# Internal c++ interfaces The following interfaces are defined here: * [`Chain`](chain.h) β€” used by wallet to access blockchain and mempool state. Added in [#14437](https://github.com/bitcoin/bitcoin/pull/14437), [#14711](https://github.com/bitcoin/bitcoin/pull/14711), [#15288](https://github.com/bitcoin/bitcoin/pull/15288), and [#10973](https://github.com/bitcoin/bitcoin/pull/10973). * [`ChainClient`](chain.h) β€” used by node to start & stop `Chain` clients. Added in [#14437](https://github.com/bitcoin/bitcoin/pull/14437). * [`Node`](node.h) β€” used by GUI to start & stop bitcoin node. Added in [#10244](https://github.com/bitcoin/bitcoin/pull/10244). * [`Wallet`](wallet.h) β€” used by GUI to access wallets. Added in [#10244](https://github.com/bitcoin/bitcoin/pull/10244). * [`Handler`](handler.h) β€” returned by `handleEvent` methods on interfaces above and used to manage lifetimes of event handlers. * [`Init`](init.h) β€” used by multiprocess code to access interfaces above on startup. Added in [#19160](https://github.com/bitcoin/bitcoin/pull/19160). * [`Ipc`](ipc.h) β€” used by multiprocess code to access `Init` interface across processes. Added in [#19160](https://github.com/bitcoin/bitcoin/pull/19160). The interfaces above define boundaries between major components of bitcoin code (node, wallet, and gui), making it possible for them to run in [different processes](../../doc/multiprocess.md), and be tested, developed, and understood independently. These interfaces are not currently designed to be stable or to be used externally.
0
bitcoin/src
bitcoin/src/interfaces/wallet.h
// Copyright (c) 2018-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_WALLET_H #define BITCOIN_INTERFACES_WALLET_H #include <addresstype.h> #include <consensus/amount.h> #include <interfaces/chain.h> #include <pubkey.h> #include <script/script.h> #include <support/allocators/secure.h> #include <util/fs.h> #include <util/message.h> #include <util/result.h> #include <util/ui_change_type.h> #include <cstdint> #include <functional> #include <map> #include <memory> #include <string> #include <tuple> #include <type_traits> #include <utility> #include <vector> class CFeeRate; class CKey; enum class FeeReason; enum class OutputType; enum class TransactionError; struct PartiallySignedTransaction; struct bilingual_str; namespace wallet { class CCoinControl; class CWallet; enum class AddressPurpose; enum isminetype : unsigned int; struct CRecipient; struct WalletContext; using isminefilter = std::underlying_type<isminetype>::type; } // namespace wallet namespace interfaces { class Handler; struct WalletAddress; struct WalletBalances; struct WalletTx; struct WalletTxOut; struct WalletTxStatus; struct WalletMigrationResult; using WalletOrderForm = std::vector<std::pair<std::string, std::string>>; using WalletValueMap = std::map<std::string, std::string>; //! Interface for accessing a wallet. class Wallet { public: virtual ~Wallet() {} //! Encrypt wallet. virtual bool encryptWallet(const SecureString& wallet_passphrase) = 0; //! Return whether wallet is encrypted. virtual bool isCrypted() = 0; //! Lock wallet. virtual bool lock() = 0; //! Unlock wallet. virtual bool unlock(const SecureString& wallet_passphrase) = 0; //! Return whether wallet is locked. virtual bool isLocked() = 0; //! Change wallet passphrase. virtual bool changeWalletPassphrase(const SecureString& old_wallet_passphrase, const SecureString& new_wallet_passphrase) = 0; //! Abort a rescan. virtual void abortRescan() = 0; //! Back up wallet. virtual bool backupWallet(const std::string& filename) = 0; //! Get wallet name. virtual std::string getWalletName() = 0; // Get a new address. virtual util::Result<CTxDestination> getNewDestination(const OutputType type, const std::string& label) = 0; //! Get public key. virtual bool getPubKey(const CScript& script, const CKeyID& address, CPubKey& pub_key) = 0; //! Sign message virtual SigningResult signMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) = 0; //! Return whether wallet has private key. virtual bool isSpendable(const CTxDestination& dest) = 0; //! Return whether wallet has watch only keys. virtual bool haveWatchOnly() = 0; //! Add or update address. virtual bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<wallet::AddressPurpose>& purpose) = 0; // Remove address. virtual bool delAddressBook(const CTxDestination& dest) = 0; //! Look up address in wallet, return whether exists. virtual bool getAddress(const CTxDestination& dest, std::string* name, wallet::isminetype* is_mine, wallet::AddressPurpose* purpose) = 0; //! Get wallet address list. virtual std::vector<WalletAddress> getAddresses() = 0; //! Get receive requests. virtual std::vector<std::string> getAddressReceiveRequests() = 0; //! Save or remove receive request. virtual bool setAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& value) = 0; //! Display address on external signer virtual bool displayAddress(const CTxDestination& dest) = 0; //! Lock coin. virtual bool lockCoin(const COutPoint& output, const bool write_to_db) = 0; //! Unlock coin. virtual bool unlockCoin(const COutPoint& output) = 0; //! Return whether coin is locked. virtual bool isLockedCoin(const COutPoint& output) = 0; //! List locked coins. virtual void listLockedCoins(std::vector<COutPoint>& outputs) = 0; //! Create transaction. virtual util::Result<CTransactionRef> createTransaction(const std::vector<wallet::CRecipient>& recipients, const wallet::CCoinControl& coin_control, bool sign, int& change_pos, CAmount& fee) = 0; //! Commit transaction. virtual void commitTransaction(CTransactionRef tx, WalletValueMap value_map, WalletOrderForm order_form) = 0; //! Return whether transaction can be abandoned. virtual bool transactionCanBeAbandoned(const uint256& txid) = 0; //! Abandon transaction. virtual bool abandonTransaction(const uint256& txid) = 0; //! Return whether transaction can be bumped. virtual bool transactionCanBeBumped(const uint256& txid) = 0; //! Create bump transaction. virtual bool createBumpTransaction(const uint256& txid, const wallet::CCoinControl& coin_control, std::vector<bilingual_str>& errors, CAmount& old_fee, CAmount& new_fee, CMutableTransaction& mtx) = 0; //! Sign bump transaction. virtual bool signBumpTransaction(CMutableTransaction& mtx) = 0; //! Commit bump transaction. virtual bool commitBumpTransaction(const uint256& txid, CMutableTransaction&& mtx, std::vector<bilingual_str>& errors, uint256& bumped_txid) = 0; //! Get a transaction. virtual CTransactionRef getTx(const uint256& txid) = 0; //! Get transaction information. virtual WalletTx getWalletTx(const uint256& txid) = 0; //! Get list of all wallet transactions. virtual std::set<WalletTx> getWalletTxs() = 0; //! Try to get updated status for a particular transaction, if possible without blocking. virtual bool tryGetTxStatus(const uint256& txid, WalletTxStatus& tx_status, int& num_blocks, int64_t& block_time) = 0; //! Get transaction details. virtual WalletTx getWalletTxDetails(const uint256& txid, WalletTxStatus& tx_status, WalletOrderForm& order_form, bool& in_mempool, int& num_blocks) = 0; //! Fill PSBT. virtual TransactionError fillPSBT(int sighash_type, bool sign, bool bip32derivs, size_t* n_signed, PartiallySignedTransaction& psbtx, bool& complete) = 0; //! Get balances. virtual WalletBalances getBalances() = 0; //! Get balances if possible without blocking. virtual bool tryGetBalances(WalletBalances& balances, uint256& block_hash) = 0; //! Get balance. virtual CAmount getBalance() = 0; //! Get available balance. virtual CAmount getAvailableBalance(const wallet::CCoinControl& coin_control) = 0; //! Return whether transaction input belongs to wallet. virtual wallet::isminetype txinIsMine(const CTxIn& txin) = 0; //! Return whether transaction output belongs to wallet. virtual wallet::isminetype txoutIsMine(const CTxOut& txout) = 0; //! Return debit amount if transaction input belongs to wallet. virtual CAmount getDebit(const CTxIn& txin, wallet::isminefilter filter) = 0; //! Return credit amount if transaction input belongs to wallet. virtual CAmount getCredit(const CTxOut& txout, wallet::isminefilter filter) = 0; //! Return AvailableCoins + LockedCoins grouped by wallet address. //! (put change in one group with wallet address) using CoinsList = std::map<CTxDestination, std::vector<std::tuple<COutPoint, WalletTxOut>>>; virtual CoinsList listCoins() = 0; //! Return wallet transaction output information. virtual std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) = 0; //! Get required fee. virtual CAmount getRequiredFee(unsigned int tx_bytes) = 0; //! Get minimum fee. virtual CAmount getMinimumFee(unsigned int tx_bytes, const wallet::CCoinControl& coin_control, int* returned_target, FeeReason* reason) = 0; //! Get tx confirm target. virtual unsigned int getConfirmTarget() = 0; // Return whether HD enabled. virtual bool hdEnabled() = 0; // Return whether the wallet is blank. virtual bool canGetAddresses() = 0; // Return whether private keys enabled. virtual bool privateKeysDisabled() = 0; // Return whether the wallet contains a Taproot scriptPubKeyMan virtual bool taprootEnabled() = 0; // Return whether wallet uses an external signer. virtual bool hasExternalSigner() = 0; // Get default address type. virtual OutputType getDefaultAddressType() = 0; //! Get max tx fee. virtual CAmount getDefaultMaxTxFee() = 0; // Remove wallet. virtual void remove() = 0; //! Return whether is a legacy wallet virtual bool isLegacy() = 0; //! Register handler for unload message. using UnloadFn = std::function<void()>; virtual std::unique_ptr<Handler> handleUnload(UnloadFn fn) = 0; //! Register handler for show progress messages. using ShowProgressFn = std::function<void(const std::string& title, int progress)>; virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0; //! Register handler for status changed messages. using StatusChangedFn = std::function<void()>; virtual std::unique_ptr<Handler> handleStatusChanged(StatusChangedFn fn) = 0; //! Register handler for address book changed messages. using AddressBookChangedFn = std::function<void(const CTxDestination& address, const std::string& label, bool is_mine, wallet::AddressPurpose purpose, ChangeType status)>; virtual std::unique_ptr<Handler> handleAddressBookChanged(AddressBookChangedFn fn) = 0; //! Register handler for transaction changed messages. using TransactionChangedFn = std::function<void(const uint256& txid, ChangeType status)>; virtual std::unique_ptr<Handler> handleTransactionChanged(TransactionChangedFn fn) = 0; //! Register handler for watchonly changed messages. using WatchOnlyChangedFn = std::function<void(bool have_watch_only)>; virtual std::unique_ptr<Handler> handleWatchOnlyChanged(WatchOnlyChangedFn fn) = 0; //! Register handler for keypool changed messages. using CanGetAddressesChangedFn = std::function<void()>; virtual std::unique_ptr<Handler> handleCanGetAddressesChanged(CanGetAddressesChangedFn fn) = 0; //! Return pointer to internal wallet class, useful for testing. virtual wallet::CWallet* wallet() { return nullptr; } }; //! Wallet chain client that in addition to having chain client methods for //! starting up, shutting down, and registering RPCs, also has additional //! methods (called by the GUI) to load and create wallets. class WalletLoader : public ChainClient { public: //! Create new wallet. virtual util::Result<std::unique_ptr<Wallet>> createWallet(const std::string& name, const SecureString& passphrase, uint64_t wallet_creation_flags, std::vector<bilingual_str>& warnings) = 0; //! Load existing wallet. virtual util::Result<std::unique_ptr<Wallet>> loadWallet(const std::string& name, std::vector<bilingual_str>& warnings) = 0; //! Return default wallet directory. virtual std::string getWalletDir() = 0; //! Restore backup wallet virtual util::Result<std::unique_ptr<Wallet>> restoreWallet(const fs::path& backup_file, const std::string& wallet_name, std::vector<bilingual_str>& warnings) = 0; //! Migrate a wallet virtual util::Result<WalletMigrationResult> migrateWallet(const std::string& name, const SecureString& passphrase) = 0; //! Return available wallets in wallet directory. virtual std::vector<std::string> listWalletDir() = 0; //! Return interfaces for accessing wallets (if any). virtual std::vector<std::unique_ptr<Wallet>> getWallets() = 0; //! Register handler for load wallet messages. This callback is triggered by //! createWallet and loadWallet above, and also triggered when wallets are //! loaded at startup or by RPC. using LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>; virtual std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) = 0; //! Return pointer to internal context, useful for testing. virtual wallet::WalletContext* context() { return nullptr; } }; //! Information about one wallet address. struct WalletAddress { CTxDestination dest; wallet::isminetype is_mine; wallet::AddressPurpose purpose; std::string name; WalletAddress(CTxDestination dest, wallet::isminetype is_mine, wallet::AddressPurpose purpose, std::string name) : dest(std::move(dest)), is_mine(is_mine), purpose(std::move(purpose)), name(std::move(name)) { } }; //! Collection of wallet balances. struct WalletBalances { CAmount balance = 0; CAmount unconfirmed_balance = 0; CAmount immature_balance = 0; bool have_watch_only = false; CAmount watch_only_balance = 0; CAmount unconfirmed_watch_only_balance = 0; CAmount immature_watch_only_balance = 0; bool balanceChanged(const WalletBalances& prev) const { return balance != prev.balance || unconfirmed_balance != prev.unconfirmed_balance || immature_balance != prev.immature_balance || watch_only_balance != prev.watch_only_balance || unconfirmed_watch_only_balance != prev.unconfirmed_watch_only_balance || immature_watch_only_balance != prev.immature_watch_only_balance; } }; // Wallet transaction information. struct WalletTx { CTransactionRef tx; std::vector<wallet::isminetype> txin_is_mine; std::vector<wallet::isminetype> txout_is_mine; std::vector<bool> txout_is_change; std::vector<CTxDestination> txout_address; std::vector<wallet::isminetype> txout_address_is_mine; CAmount credit; CAmount debit; CAmount change; int64_t time; std::map<std::string, std::string> value_map; bool is_coinbase; bool operator<(const WalletTx& a) const { return tx->GetHash() < a.tx->GetHash(); } }; //! Updated transaction status. struct WalletTxStatus { int block_height; int blocks_to_maturity; int depth_in_main_chain; unsigned int time_received; uint32_t lock_time; bool is_trusted; bool is_abandoned; bool is_coinbase; bool is_in_main_chain; }; //! Wallet transaction output. struct WalletTxOut { CTxOut txout; int64_t time; int depth_in_main_chain = -1; bool is_spent = false; }; //! Migrated wallet info struct WalletMigrationResult { std::unique_ptr<Wallet> wallet; std::optional<std::string> watchonly_wallet_name; std::optional<std::string> solvables_wallet_name; fs::path backup_path; }; //! Return implementation of Wallet interface. This function is defined in //! dummywallet.cpp and throws if the wallet component is not compiled. std::unique_ptr<Wallet> MakeWallet(wallet::WalletContext& context, const std::shared_ptr<wallet::CWallet>& wallet); //! Return implementation of ChainClient interface for a wallet loader. This //! function will be undefined in builds where ENABLE_WALLET is false. std::unique_ptr<WalletLoader> MakeWalletLoader(Chain& chain, ArgsManager& args); } // namespace interfaces #endif // BITCOIN_INTERFACES_WALLET_H
0
bitcoin/src
bitcoin/src/interfaces/handler.h
// Copyright (c) 2018-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_HANDLER_H #define BITCOIN_INTERFACES_HANDLER_H #include <functional> #include <memory> namespace boost { namespace signals2 { class connection; } // namespace signals2 } // namespace boost namespace interfaces { //! Generic interface for managing an event handler or callback function //! registered with another interface. Has a single disconnect method to cancel //! the registration and prevent any future notifications. class Handler { public: virtual ~Handler() {} //! Disconnect the handler. virtual void disconnect() = 0; }; //! Return handler wrapping a boost signal connection. std::unique_ptr<Handler> MakeSignalHandler(boost::signals2::connection connection); //! Return handler wrapping a cleanup function. std::unique_ptr<Handler> MakeCleanupHandler(std::function<void()> cleanup); } // namespace interfaces #endif // BITCOIN_INTERFACES_HANDLER_H
0
bitcoin/src
bitcoin/src/interfaces/init.h
// Copyright (c) 2021-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_INTERFACES_INIT_H #define BITCOIN_INTERFACES_INIT_H #include <interfaces/chain.h> #include <interfaces/echo.h> #include <interfaces/node.h> #include <interfaces/wallet.h> #include <memory> namespace node { struct NodeContext; } // namespace node namespace interfaces { class Ipc; //! Initial interface created when a process is first started, and used to give //! and get access to other interfaces (Node, Chain, Wallet, etc). //! //! There is a different Init interface implementation for each process //! (bitcoin-gui, bitcoin-node, bitcoin-wallet, bitcoind, bitcoin-qt) and each //! implementation can implement the make methods for interfaces it supports. //! The default make methods all return null. class Init { public: virtual ~Init() = default; virtual std::unique_ptr<Node> makeNode() { return nullptr; } virtual std::unique_ptr<Chain> makeChain() { return nullptr; } virtual std::unique_ptr<WalletLoader> makeWalletLoader(Chain& chain) { return nullptr; } virtual std::unique_ptr<Echo> makeEcho() { return nullptr; } virtual Ipc* ipc() { return nullptr; } }; //! Return implementation of Init interface for the node process. If the argv //! indicates that this is a child process spawned to handle requests from a //! parent process, this blocks and handles requests, then returns null and a //! status code to exit with. If this returns non-null, the caller can start up //! normally and use the Init object to spawn and connect to other processes //! while it is running. std::unique_ptr<Init> MakeNodeInit(node::NodeContext& node, int argc, char* argv[], int& exit_status); //! Return implementation of Init interface for the wallet process. std::unique_ptr<Init> MakeWalletInit(int argc, char* argv[], int& exit_status); //! Return implementation of Init interface for the gui process. std::unique_ptr<Init> MakeGuiInit(int argc, char* argv[]); } // namespace interfaces #endif // BITCOIN_INTERFACES_INIT_H
0