bitcoin/src/interfaces
Andrew Chow e83babe3b8 wallet: Replace use of purpose strings with an enum
Instead of storing and passing around fixed strings for the purpose of
an address, use an enum.

This also rationalizes the CAddressBookData struct, documenting all fields and
making them public, and simplifying the representation to avoid bugs like
https://github.com/bitcoin/bitcoin/pull/26761#discussion_r1134615114 and make
it not possible to invalid address data like change addresses with labels.

Co-authored-by: Ryan Ofsky <ryan@ofsky.org>
2023-04-11 15:55:31 -04:00
..
chain.h Merge bitcoin/bitcoin#26752: wallet: Remove mempool_sequence from interface methods 2023-01-04 17:53:58 +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 scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
ipc.h Add ipc::Context and ipc::capnp::Context structs 2021-06-10 09:58:45 -05:00
node.h Remove reindex special case from the progress bar label 2023-02-07 11:02:01 +01:00
README.md multiprocess: Add comments and documentation 2021-04-23 03:02:50 -05:00
wallet.h wallet: Replace use of purpose strings with an enum 2023-04-11 15:55:31 -04:00

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.