Skip to content

Commit 9b60d7c

Browse files
committed
Break ChannelManager docs into sections
ChannelManager docs aren't very approachable as they consist of a large wall of texts without much direction. As a first step of improvement, add sections to help delineate the existing text and make it easier to scan.
1 parent beef584 commit 9b60d7c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1115,6 +1115,8 @@ where
11151115
/// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
11161116
/// to individual Channels.
11171117
///
1118+
/// # Persistence
1119+
///
11181120
/// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
11191121
/// all peers during write/read (though does not modify this instance, only the instance being
11201122
/// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
@@ -1134,12 +1136,16 @@ where
11341136
/// tells you the last block hash which was connected. You should get the best block tip before using the manager.
11351137
/// See [`chain::Listen`] and [`chain::Confirm`] for more details.
11361138
///
1139+
/// # `ChannelUpdate` Messages
1140+
///
11371141
/// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
11381142
/// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
11391143
/// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
11401144
/// offline for a full minute. In order to track this, you must call
11411145
/// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
11421146
///
1147+
/// # DoS Mitigation
1148+
///
11431149
/// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
11441150
/// inbound channels without confirmed funding transactions. This may result in nodes which we do
11451151
/// not have a channel with being unable to connect to us or open new channels with us if we have
@@ -1149,6 +1155,8 @@ where
11491155
/// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
11501156
/// never limited. Please ensure you limit the count of such channels yourself.
11511157
///
1158+
/// # Type Aliases
1159+
///
11521160
/// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
11531161
/// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
11541162
/// essentially you should default to using a [`SimpleRefChannelManager`], and use a

0 commit comments

Comments
 (0)