X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=ARCH.md;h=bd5fc1bd3164a5ce749ade66c19bb55f6fd74700;hb=bdbb177469c137b958b7dde4f306e1c81b2e7f63;hp=b7276669a504ef3bfdd083cb82c9984676c2745b;hpb=6662e959c8443fd74c76c2908cfb0c78ec4f906a;p=rust-lightning diff --git a/ARCH.md b/ARCH.md index b7276669..bd5fc1bd 100644 --- a/ARCH.md +++ b/ARCH.md @@ -11,10 +11,10 @@ receive `ChannelMonitorUpdate`s from `ChannelManager` and persist them to disk b channel steps forward. There are two additional important structures that you may use either on the same device -as the `ChannelManager` or on a separate one. `NetGraphMsgHandler` handles receiving channel -and node announcements, which are then used to calculate routes by `get_route` for sending payments. -`PeerManager` handles the authenticated and encrypted communication protocol, -monitoring for liveness of peers, routing messages to `ChannelManager` and `NetGraphMsgHandler` +as the `ChannelManager` or on a separate one. `P2PGossipSync` handles receiving channel +and node announcements, which are then used to calculate routes by `find_route` for sending +payments. `PeerManager` handles the authenticated and encrypted communication protocol, +monitoring for liveness of peers, routing messages to `ChannelManager` and `P2PGossipSync` 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 @@ -37,26 +37,26 @@ At a high level, some of the common interfaces fit together as follows: ----------------- | KeysInterface | -------------- ----------------- | UserConfig | - -------------------- | -------------- - /------| MessageSendEvent | | | ---------------- - | -------------------- | | | FeeEstimator | <----------------------- + -------------------- ^ -------------- + ------| MessageSendEvent | | ^ ---------------- + / -------------------- | | | FeeEstimator | <----------------------- | (as MessageSendEventsProvider) | | ---------------- \ - | ^ | | / ------------------------ | + | ^ | | ^ ------------------------ | | \ | | / ---------> | BroadcasterInterface | | | \ | | / / ------------------------ | - | \ v v v / ^ | + | \ | | / / ^ | | (as ------------------ ---------------- | | | ChannelMessageHandler)-> | ChannelManager | ----> | chain::Watch | | | v / ------------------ ---------------- | | --------------- / (as EventsProvider) ^ | | | PeerManager |- \ | | | --------------- \ | (is-a) | | - | ----------------- \ _---------------- / / - | | chain::Access | \ / | ChainMonitor |--------------- - | ----------------- \ / ---------------- - | | \ / -(as RoutingMessageHandler) v v - \ -------------------- --------- - -----------------> | NetGraphMsgHandler | | Event | - -------------------- --------- + | -------------- \ _---------------- / / + | | UtxoLookup | \ / | ChainMonitor |--------------- + | -------------- \ / ---------------- + | ^ \ / | +(as RoutingMessageHandler) | v v + \ ----------------- --------- ----------------- + -----------------> | P2PGossipSync | | Event | | chain::Filter | + ----------------- --------- ----------------- ```