From 7c1db56d3903fe4dfe97c693601ef554f4330f14 Mon Sep 17 00:00:00 2001 From: Carla Kirk-Cohen Date: Tue, 8 Oct 2024 09:17:47 -0400 Subject: [PATCH] arch: update diagram to reflect changes to KeysInterface KeysInterface was split into EntropySource, SignerProvider and NodeSigner in #1930. --- ARCH.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/ARCH.md b/ARCH.md index bd5fc1bd3..e5527d242 100644 --- a/ARCH.md +++ b/ARCH.md @@ -18,9 +18,9 @@ monitoring for liveness of peers, routing messages to `ChannelManager` and `P2PG instances directly, and receiving messages from them via the `EventsProvider` interface. These structs communicate with each other using a public API, so that you can easily add -a proxy in between for special handling. Further, APIs for key generation, transaction -broadcasting, block fetching, and fee estimation must be implemented and the data -provided by you, the user. +a proxy in between for special handling. Further, APIs for key generation, entropy source, +transaction broadcasting, block fetching, and fee estimation must be implemented and the +data provided by you, the user. The library does not rely on the presence of a runtime environment outside of access to heap, atomic integers, and basic Mutex primitives. This means the library will never @@ -31,28 +31,30 @@ block time for current time knowledge. At a high level, some of the common interfaces fit together as follows: - ``` - - ----------------- - | KeysInterface | -------------- - ----------------- | UserConfig | - -------------------- ^ -------------- - ------| MessageSendEvent | | ^ ---------------- - / -------------------- | | | FeeEstimator | <----------------------- - | (as MessageSendEventsProvider) | | ---------------- \ - | ^ | | ^ ------------------------ | - | \ | | / ---------> | BroadcasterInterface | | - | \ | | / / ------------------------ | - | \ | | / / ^ | - | (as ------------------ ---------------- | | - | ChannelMessageHandler)-> | ChannelManager | ----> | chain::Watch | | | - v / ------------------ ---------------- | | ---------------- / (as EventsProvider) ^ | | -| PeerManager |- \ | | | ---------------- \ | (is-a) | | - | -------------- \ _---------------- / / - | | UtxoLookup | \ / | ChainMonitor |--------------- + ------------------ -------------- + | SignerProvider | | NodeSigner | + ------------------ -------------- + ----------------- ^ ^ -------------- + | EntropySource | <---- \ / ----> | UserConfig | + ----------------- \ | | / -------------- + | | | | + -------------------- | | | | ---------------- + ------| MessageSendEvent | | | | | | FeeEstimator | <---------------- + / -------------------- | | | | ---------------- \ + | (as MessageSendEventsProvider) | | | | ^ | + | ^ | | | | / ----------------------- | + | \ | | | | / ----> | BroadcasterInterface | | + | \ | | | | / / ----------------------- | + | \ | | | | / / ^ | + | (as ------------------ ---------------- | | + | ChannelMessageHandler)-> | ChannelManager | ----> | chain::Watch | | | + v / ------------------ ---------------- | | +--------------- / (as EventsProvider) ^ | | +| PeerManager |- \ | | | +--------------- \ | (is-a) / | + | -------------- \ _---------------- / + | | UtxoLookup | \ / | ChainMonitor |------------ | -------------- \ / ---------------- | ^ \ / | (as RoutingMessageHandler) | v v -- 2.39.5