Skip to content

Commit 75d47df

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 d2242f6 commit 75d47df

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
@@ -957,6 +957,8 @@ where
957957
/// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
958958
/// to individual Channels.
959959
///
960+
/// # Persistence
961+
///
960962
/// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
961963
/// all peers during write/read (though does not modify this instance, only the instance being
962964
/// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
@@ -976,12 +978,16 @@ where
976978
/// tells you the last block hash which was connected. You should get the best block tip before using the manager.
977979
/// See [`chain::Listen`] and [`chain::Confirm`] for more details.
978980
///
981+
/// # `ChannelUpdate` Messages
982+
///
979983
/// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
980984
/// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
981985
/// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
982986
/// offline for a full minute. In order to track this, you must call
983987
/// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
984988
///
989+
/// # DoS Mitigation
990+
///
985991
/// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
986992
/// inbound channels without confirmed funding transactions. This may result in nodes which we do
987993
/// not have a channel with being unable to connect to us or open new channels with us if we have
@@ -991,6 +997,8 @@ where
991997
/// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
992998
/// never limited. Please ensure you limit the count of such channels yourself.
993999
///
1000+
/// # Type Aliases
1001+
///
9941002
/// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
9951003
/// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
9961004
/// essentially you should default to using a [`SimpleRefChannelManager`], and use a

0 commit comments

Comments
 (0)