Skip to content

Commit 5a9afc9

Browse files
committed
f Improve docs
1 parent 6dd9fa5 commit 5a9afc9

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/config.rs

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ pub struct Config {
117117
/// `option_anchors_zero_fee_htlc_tx` channel type. If set to `None`, new channels will be
118118
/// negotiated with the legacy `option_static_remotekey` channel type.
119119
///
120-
/// **Note:** Please note that if set to `None` *after* some Anchor channels have already been
120+
/// **Note:** If set to `None` *after* some Anchor channels have already been
121121
/// opened, no dedicated emergency on-chain reserve will be maintained for these channels,
122122
/// which can be dangerous if only insufficient funds are available at the time of channel
123123
/// closure. We *will* however still try to get the Anchor spending transactions confirmed
@@ -152,11 +152,13 @@ impl Default for Config {
152152
/// opening. This required to estimate what fee rate would be sufficient to still have the
153153
/// closing transactions be spendable on-chain (i.e., not be considered dust). This legacy
154154
/// design of pre-anchor channels proved inadequate in the unpredictable, often turbulent, fee
155-
/// markets we experience today. In contrast, Anchor channels allow to determine an adequate
156-
/// fee rate *at the time of channel closure*, making them much more robust in the face of fee
157-
/// spikes. In turn, they require to maintain a reserve of on-chain funds to be able to get the
158-
/// channel closure transactions confirmed on-chain, at least if the channel counterparty can't
159-
/// be trusted to do this for us.
155+
/// markets we experience today.
156+
///
157+
/// In contrast, Anchor channels allow to determine an adequate fee
158+
/// rate *at the time of channel closure*, making them much more robust in the face of fee spikes.
159+
/// In turn, they require to maintain a reserve of on-chain funds to have the channel closure
160+
/// transactions confirmed on-chain, at least if the channel counterparty can't be trusted to do
161+
/// this for us.
160162
///
161163
/// See [BOLT 3] for more technical details on Anchor channels.
162164
///
@@ -172,7 +174,7 @@ impl Default for Config {
172174
/// [BOLT 3]: https://github.com/lightning/bolts/blob/master/03-transactions.md#htlc-timeout-and-htlc-success-transactions
173175
#[derive(Debug, Clone)]
174176
pub struct AnchorChannelsConfig {
175-
/// A list of peers which we trust to get the required channel closing transactions confirmed
177+
/// A list of peers that we trust to get the required channel closing transactions confirmed
176178
/// on-chain.
177179
///
178180
/// Channels with these peers won't count towards the retained on-chain reserve and we won't
@@ -185,8 +187,8 @@ pub struct AnchorChannelsConfig {
185187
/// corresponding HTLCs time out.
186188
pub trusted_peers_no_reserve: Vec<PublicKey>,
187189
/// The amount of satoshis we keep as an emergency reserve in our on-chain wallet in order to
188-
/// be able to get the required Anchor output spending and HTLC transactions confirmed when the
189-
/// channel is closed.
190+
/// have the required Anchor output spending and HTLC transactions confirmed when the channel
191+
/// is closed.
190192
///
191193
/// **Note:** Depending on the fee market at the time of closure, this reserve amount might or
192194
/// might not suffice to successfully spend the Anchor output and have the HTLC transactions

0 commit comments

Comments
 (0)