added more comments

Author: SWvheerden

src/ln/channel.rs

@@ -444,7 +444,6 @@ impl Channel {
 	}
 
 	/// Returns a minimum channel reserve value **they** need to maintain
-	///
 	/// Guaranteed to return a value no larger than channel_value_satoshis
 	fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
 		let (q, _) = channel_value_satoshis.overflowing_div(100);

src/util/configurations.rs

@@ -7,14 +7,14 @@
 /// It wraps the ChannelHandshakeLimits struct and ChannelConfig struct into a single one for channel manager.
 #[derive(Clone, Debug)]
 pub struct UserConfig{
-	/// optional user specified channel limits
+	/// optional user specified channel limits, this hold information regarding handshakes of channels.
 	pub channel_limits : ChannelHandshakeLimits,
-	/// channel specific options
+	/// channel specific options and settings egis channel announced or not
 	pub channel_options : ChannelConfig,
 }
 
 impl UserConfig {
-	///default constructor, calls ChannelOptions and ChannelLimits constructors
+	///default constructor, calls default ChannelOptions and default ChannelLimits constructors
     pub fn new() -> Self{
         UserConfig {
             channel_limits : ChannelHandshakeLimits::new(),
@@ -24,33 +24,36 @@ impl UserConfig {
 }
 
 /// This struct contains all the optional channel limits. If these limits are breached the new channel will be denied
-/// If the user wants to check a value, the value needs to be filled in, as by default they are not checked
+/// If the user wants to check a value, the value needs to be filled in, as by default most are not checked
 #[derive(Copy, Clone, Debug)]
 pub struct ChannelHandshakeLimits{
-	/// minimum allowed satishis when funding a channel.
+	/// minimum allowed satoshis when a channel is funded, this is supplied by the sender.
 	pub min_funding_satoshis :u64,
-	/// maximum allowed min HTLC that will be accepted.
+	/// maximum allowed smallest HTLC that will be accepted by us.
 	pub max_htlc_minimum_msat : u64,
-	/// min allowed cap on outstanding HTLC, used to limit exposure.
+	/// min allowed cap on outstanding HTLC. This is used to limit exposure to HTLCs.
 	pub min_max_htlc_value_in_flight_msat : u64,
-	/// max allowed satoshis that may be used as a direct payment.
+	/// max allowed satoshis that may be used as a direct payment by the peer.
 	pub max_channel_reserve_satoshis : u64,
 	/// min allowed max outstanding HTLC that can be offered.
 	pub min_max_accepted_htlcs : u16,
 	/// min allowed threshold below which outputs should not be generated.
+	/// These outputs are either commitment or HTLC transactions.
+	/// HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
+	/// This reflects the reality that tiny outputs are not considered standard transactions and will not propagate through the Bitcoin network
 	pub min_dust_limit_satoshis : u64,
 	/// max allowed threshold above which outputs should not be generated. Bolt 2 mentions channel_reserve_satoshis as upper limit, but this can be a lower limit
 	pub max_dust_limit_satoshis : u64,
-	///minimum depth to a number of blocks that is considered reasonable to avoid double-spending of the funding transaction
+	/// minimum depth to a number of blocks that is considered reasonable to avoid double-spending of the funding transaction
 	pub minimum_depth : u32,
-	///do we force the incoming channel to match our announced channel preference
+	/// do we force the incoming channel to match our announced channel preference
 	pub force_announced_channel_preference : bool,
 }
 
 impl ChannelHandshakeLimits {
 //creating max and min possible values because if they are not set, means we should not check them.
 ///default constructor creates limits so that they are not tested for
-/// min_dust_limit_satoshis is set to the network default of 546
+///min_dust_limit_satoshis is set to the network default of 546
 	pub fn new() -> Self{
 		ChannelHandshakeLimits {
 			min_funding_satoshis : 0,
@@ -69,15 +72,17 @@ impl ChannelHandshakeLimits {
 /// This struct contains all the custom channel options.
 #[derive(Copy, Clone, Debug)]
 pub struct ChannelConfig{
-	/// Amount (in millionths of a satoshi) channel will charge per transferred satoshi.
+	/// Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
+	/// This must be updated as the channel updates and can change in runtime.
 	pub fee_proportional_millionths : u32,
 	//TODO enforce non-mutability when config can change at runtime
-	///Is this channel an announced channel, cannot change after channel creation
+	///Is this channel publicly announced channel or not.
+	///This cannot change after channel creation.
 	pub announced_channel : bool,
 }
 impl ChannelConfig {
-	/// creating a struct with values.
-	/// fee_proportional_millionths should be changed afterwords
+	/// creating a struct with default values.
+	/// fee_proportional_millionths should be changed and updated afterwords
 	pub fn new() -> Self{
 		ChannelConfig {
 			fee_proportional_millionths : 0,