Require any Router also implements MessageRouter
[rust-lightning] / lightning / src / util / config.rs
index 267774481b4b98df545112c5f7468721ebb90de6..13284113d2ca03469166bf959ba6607d66aaef4c 100644 (file)
@@ -438,20 +438,20 @@ pub struct ChannelConfig {
        /// funder/initiator.
        ///
        /// When we are the funder, because we have to pay the channel closing fee, we bound the
-       /// acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
+       /// acceptable fee by our [`ChannelCloseMinimum`] and [`NonAnchorChannelFee`] fees, with the upper bound increased by
        /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
-       /// [`Normal`] feerate during normal operation, this value represents the additional fee we're
+       /// [`NonAnchorChannelFee`] feerate during normal operation, this value represents the additional fee we're
        /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
        /// funds.
        ///
        /// When we are not the funder, we require the closing transaction fee pay at least our
-       /// [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
+       /// [`ChannelCloseMinimum`] fee estimate, but allow our counterparty to pay as much fee as they like.
        /// Thus, this value is ignored when we are not the funder.
        ///
        /// Default value: 1000 satoshis.
        ///
-       /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
-       /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
+       /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
+       /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
        pub force_close_avoidance_max_fee_satoshis: u64,
        /// If set, allows this channel's counterparty to skim an additional fee off this node's inbound
        /// HTLCs. Useful for liquidity providers to offload on-chain channel costs to end users.
@@ -462,8 +462,9 @@ pub struct ChannelConfig {
        /// - The counterparty will get an [`HTLCIntercepted`] event upon payment forward, and call
        ///   [`forward_intercepted_htlc`] with less than the amount provided in
        ///   [`HTLCIntercepted::expected_outbound_amount_msat`]. The difference between the expected and
-       ///   actual forward amounts is their fee.
-       // TODO: link to LSP JIT channel invoice generation spec when it's merged
+       ///   actual forward amounts is their fee. See
+       ///   <https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS2#flow-lsp-trusts-client-model>
+       ///   for how this feature may be used in the LSP use case.
        ///
        /// # Note
        /// It's important for payee wallet software to verify that [`PaymentClaimable::amount_msat`] is