mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 15:02:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3351 from carlaKC/arch-update-keys-interface

Browse source 
docs/trivial: update diagram to reflect changes to KeysInterface
This commit is contained in:
Matt Corallo 2024-10-08 15:30:56 +00:00 • committed by GitHub
commit e4ec9176c5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
ARCH.md
View file

@ -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