X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fconfig.rs;h=26c8da7543615777ec814a88adff9163b147ddd0;hb=593d8c4610f082441563d4906d64175a354b1cfc;hp=2f65e958f8b60d0f0a0f72d3cd3b7ca1b009085a;hpb=2eb93f466410ec2e6fd583b9c8c6f372a3b147e4;p=rust-lightning

diff --git a/lightning/src/util/config.rs b/lightning/src/util/config.rs
index 2f65e958..26c8da75 100644
--- a/lightning/src/util/config.rs
+++ b/lightning/src/util/config.rs
@@ -10,8 +10,8 @@
 //! Various user-configurable channel limits and settings which ChannelManager
 //! applies for you.
 
-use ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
-use ln::channelmanager::{BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
+use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
+use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
 
 /// Configuration we set when applicable.
 ///
@@ -126,6 +126,30 @@ pub struct ChannelHandshakeConfig {
 	///
 	/// [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
 	pub commit_upfront_shutdown_pubkey: bool,
+
+	/// The Proportion of the channel value to configure as counterparty's channel reserve,
+	/// i.e., `their_channel_reserve_satoshis` for both outbound and inbound channels.
+	///
+	/// `their_channel_reserve_satoshis` is the minimum balance that the other node has to maintain
+	/// on their side, at all times.
+	/// This ensures that if our counterparty broadcasts a revoked state, we can punish them by
+	/// claiming at least this value on chain.
+	///
+	/// Channel reserve values greater than 30% could be considered highly unreasonable, since that
+	/// amount can never be used for payments.
+	/// Also, if our selected channel reserve for counterparty and counterparty's selected
+	/// channel reserve for us sum up to equal or greater than channel value, channel negotiations
+	/// will fail.
+	///
+	/// Note: Versions of LDK earlier than v0.0.104 will fail to read channels with any channel reserve
+	/// other than the default value.
+	///
+	/// Default value: 1% of channel value, i.e., configured as 10,000 millionths.
+	/// Minimum value: If the calculated proportional value is less than 1000 sats, it will be treated
+	///                as 1000 sats instead, which is a safe implementation-specific lower bound.
+	/// Maximum value: 1,000,000, any values larger than 1 Million will be treated as 1 Million (or 100%)
+	///                instead, although channel negotiations will fail in that case.
+	pub their_channel_reserve_proportional_millionths: u32
 }
 
 impl Default for ChannelHandshakeConfig {
@@ -138,6 +162,7 @@ impl Default for ChannelHandshakeConfig {
 			negotiate_scid_privacy: false,
 			announced_channel: false,
 			commit_upfront_shutdown_pubkey: true,
+			their_channel_reserve_proportional_millionths: 10_000,
 		}
 	}
 }
@@ -249,7 +274,7 @@ impl Default for ChannelHandshakeLimits {
 
 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
 /// with our counterparty.
-#[derive(Copy, Clone, Debug, PartialEq)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct ChannelConfig {
 	/// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
 	/// over the channel.
@@ -300,6 +325,12 @@ pub struct ChannelConfig {
 	/// to such payments may be sustantial if there are many dust HTLCs present when the
 	/// channel is force-closed.
 	///
+	/// The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
+	/// channel negotiated throughout the channel open process, along with the fees required to have
+	/// a broadcastable HTLC spending transaction. When a channel supports anchor outputs
+	/// (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
+	/// account the HTLC transaction fee as it is zero.
+	///
 	/// This limit is applied for sent, forwarded, and received HTLCs and limits the total
 	/// exposure across all three types per-channel. Setting this too low may prevent the
 	/// sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
@@ -381,8 +412,8 @@ impl Default for LegacyChannelConfig {
 	}
 }
 
-impl ::util::ser::Writeable for LegacyChannelConfig {
-	fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
+impl crate::util::ser::Writeable for LegacyChannelConfig {
+	fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
 		write_tlv_fields!(writer, {
 			(0, self.options.forwarding_fee_proportional_millionths, required),
 			(1, self.options.max_dust_htlc_exposure_msat, (default_value, 5_000_000)),
@@ -396,8 +427,8 @@ impl ::util::ser::Writeable for LegacyChannelConfig {
 	}
 }
 
-impl ::util::ser::Readable for LegacyChannelConfig {
-	fn read<R: ::io::Read>(reader: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
+impl crate::util::ser::Readable for LegacyChannelConfig {
+	fn read<R: crate::io::Read>(reader: &mut R) -> Result<Self, crate::ln::msgs::DecodeError> {
 		let mut forwarding_fee_proportional_millionths = 0;
 		let mut max_dust_htlc_exposure_msat = 5_000_000;
 		let mut cltv_expiry_delta = 0;