Skip to content

docs/trivial: update diagram to reflect changes to KeysInterface #3351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Oct 8, 2024
Merged

docs/trivial: update diagram to reflect changes to KeysInterface #3351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 26 additions & 24 deletions ARCH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down