mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-14 11:26:09 -05:00

History

Sjors Provoost 83a9bef0e2 Add missing include for mining interface Needed for std::unique_ptr		2024-06-26 12:24:47 +02:00
..
chain.h	Merge bitcoin/bitcoin#28890 : rpc: Remove deprecated -rpcserialversion	2024-01-05 10:42:10 +00:00
echo.h	multiprocess: Add echoipc RPC method and test	2021-04-23 03:02:50 -05:00
handler.h	scripted-diff: Bump copyright headers	2022-12-24 23:49:50 +00:00
init.h	Introduce Mining interface	2024-06-18 18:47:51 +02:00
ipc.h	Add ipc::Context and ipc::capnp::Context structs	2021-06-10 09:58:45 -05:00
mining.h	Add missing include for mining interface	2024-06-26 12:24:47 +02:00
node.h	util: add TransactionError includes and namespace declarations	2024-05-16 10:16:08 -05:00
README.md	multiprocess: Add comments and documentation	2021-04-23 03:02:50 -05:00
wallet.h	util: add TransactionError includes and namespace declarations	2024-05-16 10:16:08 -05:00

README.md

Internal c++ interfaces

The following interfaces are defined here:

Chain — used by wallet to access blockchain and mempool state. Added in #14437, #14711, #15288, and #10973.
ChainClient — used by node to start & stop Chain clients. Added in #14437.
Node — used by GUI to start & stop bitcoin node. Added in #10244.
Wallet — used by GUI to access wallets. Added in #10244.
Handler — returned by handleEvent methods on interfaces above and used to manage lifetimes of event handlers.
Init — used by multiprocess code to access interfaces above on startup. Added in #19160.
Ipc — used by multiprocess code to access Init interface across processes. Added in #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, and be tested, developed, and understood independently. These interfaces are not currently designed to be stable or to be used externally.